Interface ArrowOverlayOptions

interface ArrowOverlayOptions {
    attributes?: Record<string, string>;
    cssClass?: string;
    direction?: number;
    events?: Record<string, ((value, event?) => any)>;
    foldback?: number;
    id?: string;
    length?: number;
    location?: number;
    paintStyle?: PaintStyle;
    width?: number;
}

Hierarchy (view full)

Properties

attributes? cssClass? direction? events? foldback? id? length? location? paintStyle? width?

Properties

Optional attributes

attributes?: Record<string, string>

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

Optional cssClass

cssClass?: string

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

Optional direction

direction?: number

1 to point forwards (the default), -1 to point backwards.

Optional events

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

Optional event handlers to attach to the overlay.

Type declaration

    • (value, event?): any

    • Parameters

      • value: any
      • Optional event: any

      Returns any

Optional foldback

foldback?: number

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

Optional id

id?: string

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

Optional length

length?: number

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

Optional location

location?: number

Defaults to 0.5. See docs.

Optional paintStyle

paintStyle?: PaintStyle

Optional paint style to use for the arrow.

Optional width

width?: number

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

Settings

Member Visibility

Theme

On This Page

attributescssClassdirectioneventsfoldbackidlengthlocationpaintStylewidth