Skip to main content

ArrowOverlayOptions

Options for an Arrow overlay.

Properties​

attributes?​

optional attributes: Record<string, string>

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

Inherited from​

SimpleShapeOverlayOptions.attributes

cssClass?​

optional cssClass: string

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

Inherited from​

SimpleShapeOverlayOptions.cssClass

direction?​

optional direction: number

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

Inherited from​

SimpleShapeOverlayOptions.direction

events?​

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

Optional event handlers to attach to the overlay.

Inherited from​

SimpleShapeOverlayOptions.events

foldback?​

optional foldback: number

How far, as a decimal, along the line from head to baseline to fold back into. Defaults to 0.623.

hollow?​

optional hollow: boolean

Defaults to false. When true, the arrow is stroked but not filled.

Inherited from​

SimpleShapeOverlayOptions.hollow

id?​

optional id: string

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

Inherited from​

SimpleShapeOverlayOptions.id

length?​

optional length: number

Length from the head to the baseline. Defaults to 20.

location?​

optional location: number

Defaults to 0.5. See docs.

Inherited from​

SimpleShapeOverlayOptions.location

maxZoom?​

optional maxZoom: number

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

Inherited from​

SimpleShapeOverlayOptions.maxZoom

minZoom?​

optional minZoom: number

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

Inherited from​

SimpleShapeOverlayOptions.minZoom

paintStyle?​

optional paintStyle: PaintStyle

Optional paint style to use.

Inherited from​

SimpleShapeOverlayOptions.paintStyle

visibility?​

optional visibility: OverlayVisibility

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

Inherited from​

SimpleShapeOverlayOptions.visibility

width?​

optional width: number

Width of the arrow's baseline. Defaults to 20.