Skip to main content

EllipseOverlayOptions

Options for a Ellipse 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


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


location?

optional location: number

Defaults to 0.5. See docs.

Inherited from

SimpleShapeOverlayOptions.location


paintStyle?

optional paintStyle: PaintStyle

Optional paint style to use.

Inherited from

SimpleShapeOverlayOptions.paintStyle


rx?

optional rx: number

Radius in X. Defaults to 8


ry?

optional ry: number

Radius in Y. Defaults to 5


visibility?

optional visibility: OverlayVisibility

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

Inherited from

SimpleShapeOverlayOptions.visibility