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

    Interface DimensionMetadata

    Metadata describing the properties and behavior of a single dimension.

    Each dimension in an nD dataset can have rich metadata that controls how it's displayed, navigated, and interpreted by the visualization system.

    This interface mirrors Python's luxar.core.Dimension class to ensure full compatibility with datasets generated by the Python encoder.

    DimensionMetadata

    interface DimensionMetadata {
        name: string;
        unit: string;
        scale: number;
        range?: [number, number];
        display?: boolean;
        discrete?: boolean;
        cyclic?: boolean;
        step?: number;
        spatial?: boolean;
        categories?: string[];
        description?: string;
    }
    Index
    name unit scale range? display? discrete? cyclic? step? spatial? categories? description?
    name: string

    Human-readable name for this dimension (e.g., "Time", "X", "Channel")

    unit: string

    Physical unit of measurement (e.g., "μm", "s", "nm")

    scale: number

    Scale factor for converting from array indices to real-world units

    range?: [number, number]

    Optional min/max bounds for this dimension in real-world units

    display?: boolean

    Whether this dimension should be displayed in the 3D scene by default

    discrete?: boolean

    Whether values in this dimension are discrete (integers) vs continuous

    cyclic?: boolean

    Whether dimension wraps around (for angles, periodic states)

    step?: number

    Step size for navigation in this dimension

    spatial?: boolean

    Whether points extend through this dimension (true for spatial dims)

    categories?: string[]

    Optional category labels for categorical dimensions

    description?: string

    Optional human-readable description for UI tooltips

    Settings
    Member Visibility

    On This Page
    Properties