Skip to main content
DotOverlayOptions
Options for a Dot overlay
NameTypeDescription
align?"center" | "flush"When the overlay is at position 1 or 0 (or is being used a source/target marker), this determines how the dot intersects the vertex. A value of 'flush', which is the default, means a point on the circumference of the dot touches the vertex boundary. A value of 'center' means the dot's center is on the vertex boundary.
attributes?Record<string,string>Optional custom attributes to write to the overlay's element.
cssClass?stringOptional CSS class(es) to add to the overlay's element.
direction?number1 to point forwards (the default), -1 to point backwards. Only taken into consideration in some overlay types.
events?Record<OverlayEvents,(value:any, event:any) => any>Optional event handlers to attach to the overlay.
hollow?booleanDefaults to false. When true, the arrow is stroked but not filled.
id?stringOptional ID for the overlay. Can be used to retrieve the overlay from a connection.
location?numberDefaults to 0.5. See docs.
paintStyle?PaintStyleOptional paint style to use.
radius?numberRadius of the dot. Defaults to 5.
visibility?OverlayVisibilityWhether the overlay is always visible, or only on hover. Defaults to OVERLAY_VISIBILITY_ALWAYS.