Interface LabelOverlayOptions

interface LabelOverlayOptions {
    attributes?: Record<string, string>;
    cssClass?: string;
    events?: Record<string, ((value: any, event?: any) => any)>;
    id?: string;
    label: string | Function;
    labelLocationAttribute?: string;
    location?: number;
    useHTMLElement?: boolean;
    visibility?: OverlayVisibility;
}

Hierarchy (view full)

Properties

attributes? cssClass? events? id? label labelLocationAttribute? location? useHTMLElement? visibility?

Properties

Optionalattributes

attributes?: Record<string, string>

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

OptionalcssClass

cssClass?: string

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

Optionalevents

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

Optional event handlers to attach to the overlay.

Optionalid

id?: string

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

label

label: string | Function

String, or a function returning a string, for the label.

OptionallabelLocationAttribute

labelLocationAttribute?: string

Optional name of the attribute that identifies this overlay's location on the path. Defaults to location.

Optionallocation

location?: number

Defaults to 0.5. See docs.

OptionaluseHTMLElement

useHTMLElement?: boolean

Whether or not to use an HTML element. Defaults to false (uses an SVG element)

Optionalvisibility

visibility?: OverlayVisibility

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

Settings

Member Visibility

On This Page

Properties
Version :