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

    Interface DatasetBrowserConfig

    Construction options for DatasetBrowser — where to mount the panel and how to react to selection/close, plus the context needed to pick the initial directory and resolve relative paths.

    interface DatasetBrowserConfig {
        container: HTMLElement;
        onDatasetSelect: (fullUrl: string) => false | void | Promise<void>;
        onClose?: () => void;
        currentSrc?: string;
        origin?: string;
    }
    Index
    container onDatasetSelect onClose? currentSrc? origin?
    container: HTMLElement

    Host element the browser panel is appended into.

    onDatasetSelect: (fullUrl: string) => false | void | Promise<void>

    Callback when a dataset is selected. Receives the full URL (not just the path). May be sync or async; the browser does NOT wait for the returned Promise — it fires the callback, attaches a .catch (so an async load failure is logged + toasted rather than becoming an unhandled rejection), and closes immediately. Return false synchronously to keep the browser open without treating the selection as a failure.

    onClose?: () => void
    currentSrc?: string

    Currently loaded dataset URL, used to determine the initial directory.

    origin?: string

    Fallback origin for relative path resolution (defaults to window.location.origin).

    Settings
    Member Visibility

    On This Page
    Properties