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

    Interface BootstrapOptions

    Options for bootstrapStandalone.

    The standalone-app entry point (main.ts) passes nothing beyond canvas, so every flag defaults to the standalone viewer behavior.

    Embedded callers typically construct LuxarApp directly and skip this function entirely. If they DO call it, they usually want patchConsole: false and warmCodecs: false to avoid touching shared host-page state.

    interface BootstrapOptions {
        canvas: HTMLCanvasElement;
        urlParams?: UrlParams;
        patchConsole?: boolean;
        warmCodecs?: boolean;
        validateConfig?: boolean;
    }
    Index
    canvas urlParams? patchConsole? warmCodecs? validateConfig?
    canvas: HTMLCanvasElement

    Canvas element to render into.

    urlParams?: UrlParams

    Parsed URL parameters. Defaults to readUrlParams() so the standalone app picks up ?src, ?theme, ?debug, etc. from window.location. Embedders pass their own (or {...}) to bypass URL parsing.

    patchConsole?: boolean

    Monkey-patch console.log/warn/error/info/debug so the debug console UI can replay messages later. Defaults to true. Embedders should set this to false unless they own the host page's console output.

    warmCodecs?: boolean

    Warm the blosc codec module cache. Defaults to true. Saves ~771ms on the first compressed-chunk decompress for the standalone app; embed use cases rarely need it (the codec loads on demand anyway).

    validateConfig?: boolean

    Run validateAndLog(config) at startup. Defaults to true. Off by default for embedders since the (immutable) config has already been validated at compile time.

    Settings
    Member Visibility

    On This Page
    Properties