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

    Interface ShowDatasetBrowserPorts

    Open the dataset browser modal. Returns the new instance so the caller can track it on its own field; the helper never mutates orchestrator state directly. All side effects on the orchestrator (options.src update, datasetBrowser reset) flow through the supplied ports; the host-URL replacement belongs to the guarded switch itself (LuxarApp.switchDataset), so a programmatic switch writes it too.

    Caller is responsible for checking that no browser is already open before calling this function — re-opening would stack modals.

    interface ShowDatasetBrowserPorts {
        currentSrc: string | undefined;
        inputHandler: InputHandler;
        onSrcChange: (src: string) => void;
        isInitializing: () => boolean;
        isSwitchInFlight: () => boolean;
        loadDataset: (src: string) => Promise<void>;
        shortcutForAction: (actionId: string) => string | undefined;
        onClose: () => void;
    }
    Index
    currentSrc inputHandler onSrcChange isInitializing isSwitchInFlight loadDataset shortcutForAction onClose
    currentSrc: string | undefined
    inputHandler: InputHandler
    onSrcChange: (src: string) => void
    isInitializing: () => boolean

    True while the app is still completing its initial routing and wiring. Selections are refused before side effects or load dispatch in this state.

    isSwitchInFlight: () => boolean

    True while a guarded dataset switch is already in flight. Consulted before the onSrcChange side effect: the dispatch below will reject, and the src snapshot must not end up pointing at a dataset that never loaded.

    loadDataset: (src: string) => Promise<void>
    shortcutForAction: (actionId: string) => string | undefined
    onClose: () => void

    Settings
    Member Visibility

    On This Page
    Properties