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

    Interface EmbedderDimensions

    Snapshot of the dataset's nD dimension state returned by LuxarApp.getDimensions(). All array fields are CLONED copies of the scene-dims manager's internal state — an embedder may read them freely without mutating viewer internals; use setDimensionValue() to change a slice position.

    interface EmbedderDimensions {
        ndim: number;
        displayed: number[];
        currentStep: number[];
        metadata: DimensionMetadata[];
        ranges: [number, number][];
    }
    Index
    ndim displayed currentStep metadata ranges
    ndim: number

    Total dimensions in the dataset.

    displayed: number[]

    Indices currently shown on screen (length 1–3).

    currentStep: number[]

    Current slice position per dimension (length === ndim).

    metadata: DimensionMetadata[]

    Per-dimension metadata (name, unit, range, discrete, step, …).

    ranges: [number, number][]

    [min, max] navigable bounds per dimension.

    Settings
    Member Visibility

    On This Page
    Properties