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

    Interface ViewerConfigPorts

    The surface this dispatcher needs from the parent LuxarApp. Each field is optional because some panels are only built when their underlying data is present (scaleBar requires dimension metadata, overlays / layers require zarr overlay_groups / layer arrays, etc.).

    interface ViewerConfigPorts {
        showHelp: () => void;
        renderingControls: { show: () => void; hide: () => void };
        performanceMonitor: { show: () => void };
        inputHandler: { showDimensionSliders: () => void };
        scaleBar?: { show: () => void; hide: () => void };
        layersPanel?: { show: () => void; hide: () => void };
        overlayManager?: { show: () => void; hide: () => void };
        setTheme: (themeId: string) => void;
        setDimensionValue: (dim: number, value: number) => void;
        setDocumentTitle: (title: string) => void;
        startDimensionAnimation?: (
            dim: number,
            options: {
                targetFPS?: number;
                loopMode?: LoopMode;
                direction?: AnimationDirection;
                stepSize?: number;
            },
        ) => void;
        setDefaultLadderDepth?: (ladderDepth: number | "auto" | null) => void;
    }
    Index
    showHelp renderingControls performanceMonitor inputHandler scaleBar? layersPanel? overlayManager? setTheme setDimensionValue setDocumentTitle startDimensionAnimation? setDefaultLadderDepth?
    showHelp: () => void
    renderingControls: { show: () => void; hide: () => void }
    performanceMonitor: { show: () => void }
    inputHandler: { showDimensionSliders: () => void }
    scaleBar?: { show: () => void; hide: () => void }
    layersPanel?: { show: () => void; hide: () => void }
    overlayManager?: { show: () => void; hide: () => void }
    setTheme: (themeId: string) => void
    setDimensionValue: (dim: number, value: number) => void
    setDocumentTitle: (title: string) => void

    Set the browser tab title (document.title) from the scene's title.

    startDimensionAnimation?: (
        dim: number,
        options: {
            targetFPS?: number;
            loopMode?: LoopMode;
            direction?: AnimationDirection;
            stepSize?: number;
        },
    ) => void

    Start playback on one dimension. Optional for lightweight test ports.

    setDefaultLadderDepth?: (ladderDepth: number | "auto" | null) => void

    Set the scene's authored playback detail (viewer_config.playback_lod_depth) as the default for every dimension. Optional for lightweight test ports.

    Settings
    Member Visibility

    On This Page
    Properties