Skip to main content
ArrowOverlayOptions
Options for an Arrow overlay.
NameTypeDescription
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.
foldback?numberHow far, as a decimal, along the line from head to baseline to fold back into. Defaults to 0.623.
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.
length?numberLength from the head to the baseline. Defaults to 20.
location?numberDefaults to 0.5. See docs.
paintStyle?PaintStyleOptional paint style to use.
visibility?OverlayVisibilityWhether the overlay is always visible, or only on hover. Defaults to OVERLAY_VISIBILITY_ALWAYS.
width?numberWidth of the arrow's baseline. Defaults to 20.