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

    Interface KioskPorts

    What applying kiosk mode needs from the app.

    interface KioskPorts {
        setKeyboardEnabled: (enabled: boolean) => void;
        setControlsEnabled?: (enabled: boolean) => void;
        hidePanels?: () => void;
        canvas?: EventTarget;
        reload?: () => void;
    }
    Index
    setKeyboardEnabled setControlsEnabled? hidePanels? canvas? reload?
    setKeyboardEnabled: (enabled: boolean) => void

    Enable or disable routed keyboard handling.

    setControlsEnabled?: (enabled: boolean) => void

    Enable or disable the CAMERA CONTROLS.

    Separate from setKeyboardEnabled, and necessarily so: that one reaches InputContextManager.setEnabled, whose entire effect is to drop keydown dispatch (context-manager.ts: if (!this.enabled && type === 'down')) — NOT pointer events, and not picking, which lives elsewhere. Orbit/fly controls listen on the canvas themselves, so disabling only the keyboard left the camera fully draggable under ?kiosk — measured at 46x the auto-rotate drift, so a visitor could still swing the view off the tour.

    hidePanels?: () => void

    Hide every panel and the rail.

    canvas?: EventTarget

    The canvas, for the watchdog's context listeners. Absent in tests.

    reload?: () => void

    Reload the page. Injected so a test never navigates.

    Settings
    Member Visibility

    On This Page
    Properties