Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Interface ElementPointerPayload

    Payload for the element-click / element-contextmenu embedder events.

    interface ElementPointerPayload {
        nodeName: string;
        elementIndex: number;
        hitNodeName: string;
        button: number;
        x: number;
        y: number;
        link: string | null;
    }
    Index
    nodeName elementIndex hitNodeName button x y link
    nodeName: string

    Reported layer path — outermost kind=partition wrapper if any.

    elementIndex: number

    Element index within the hit leaf.

    hitNodeName: string

    Scene node elementIndex is local to.

    button: number

    Which pointer button: 0 = primary, 2 = secondary.

    Reports the raw DOM value, so a macOS Ctrl+primary-click — the platform's secondary gesture — arrives as 0 on an element-contextmenu event. Switch on the event NAME, not on this, to tell the two gestures apart.

    x: number

    Viewport coordinates of the gesture, in CSS pixels.

    y: number
    link: string | null

    The URL the built-in handler resolved, or null when the element has none (or link opening is disabled). Reported so a host can mirror or override the behaviour without re-implementing template resolution.

    Settings
    Member Visibility

    On This Page
    Properties