Interface OverlayOptions

Base options for an overlay.

interface OverlayOptions {
    attributes?: Record<string, string>;
    cssClass?: string;
    events?: Record<string, ((value: any, event?: any) => any)>;
    id?: string;
    location?: number;
    visibility?: OverlayVisibility;
}

Hierarchy (view full)

Properties

attributes? cssClass? events? id? location? 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.

Optionallocation

location?: number

Defaults to 0.5. See docs.

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 :