OverlayOptions

Base options for an overlay.

Extends

• Record<string, any>

Extended by

• LabelOverlayOptions
• CustomOverlayOptions

Properties

attributes?

optional attributes: Record<string, string>

Optional custom attributes to write to the overlay's element.

---

cssClass?

optional cssClass: string

Optional CSS class(es) to add to the overlay's element.

---

direction?

optional direction: number

1 to point forwards (the default), -1 to point backwards. Only taken into consideration in some overlay types.

---

events?

optional events: Record<OverlayEvents, (value, event?) => any>

Optional event handlers to attach to the overlay.

---

id?

optional id: string

Optional ID for the overlay. Can be used to retrieve the overlay from a connection.

---

location?

optional location: number

Defaults to 0.5. See docs.

---

maxZoom?

optional maxZoom: number

Maximum zoom at which this overlay is visible. Defaults to Infinity. Null or a negative value disables this bound.

---

minZoom?

optional minZoom: number

Minimum zoom at which this overlay is visible. Defaults to 0. Null or a negative value disables this bound.

---

visibility?

optional visibility: OverlayVisibility

Whether the overlay is always visible, or only on hover. Defaults to OVERLAY_VISIBILITY_ALWAYS.