EllipseOverlayOptions
Options for a Ellipse overlay
Properties
attributes?
optionalattributes:Record<string,string>
Optional custom attributes to write to the overlay's element.
Inherited from
SimpleShapeOverlayOptions.attributes
cssClass?
optionalcssClass:string
Optional CSS class(es) to add to the overlay's element.
Inherited from
SimpleShapeOverlayOptions.cssClass
direction?
optionaldirection:number
1 to point forwards (the default), -1 to point backwards. Only taken into consideration in some overlay types.
Inherited from
SimpleShapeOverlayOptions.direction
events?
optionalevents:Record<OverlayEvents, (value,event?) =>any>
Optional event handlers to attach to the overlay.
Inherited from
SimpleShapeOverlayOptions.events
hollow?
optionalhollow:boolean
Defaults to false. When true, the arrow is stroked but not filled.
Inherited from
SimpleShapeOverlayOptions.hollow
id?
optionalid:string
Optional ID for the overlay. Can be used to retrieve the overlay from a connection.
Inherited from
SimpleShapeOverlayOptions.id
location?
optionallocation:number
Defaults to 0.5. See docs.
Inherited from
SimpleShapeOverlayOptions.location
maxZoom?
optionalmaxZoom: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?
optionalminZoom: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?
optionalpaintStyle:PaintStyle
Optional paint style to use.
Inherited from
SimpleShapeOverlayOptions.paintStyle
rx?
optionalrx:number
Radius in X. Defaults to 8
ry?
optionalry:number
Radius in Y. Defaults to 5
visibility?
optionalvisibility:OverlayVisibility
Whether the overlay is always visible, or only on hover. Defaults to OVERLAY_VISIBILITY_ALWAYS.
Inherited from
SimpleShapeOverlayOptions.visibility