Interface OverlayOptions

Base options for an overlay.

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

Hierarchy (view full)

Properties

attributes? cssClass? events? id? location?

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 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 id

id?: string

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

Optional location

location?: number

Defaults to 0.5. See docs.

Settings

Member Visibility

Theme

On This Page

attributescssClasseventsidlocation
Version :