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

    Interface PointsMetadata

    Points node metadata from zarr .zattrs

    This interface defines all metadata stored with a Points node in the zarr archive. It enables type-safe access to point properties throughout the viewer.

    interface PointsMetadata {
        type: "points";
        n_points: number;
        ndim: number;
        max_radius?: number;
        has_colors?: boolean;
        has_scalars?: boolean;
        colormap?: string;
        scalar_data_range?: [number, number];
        has_radii?: boolean;
        has_sharpness?: boolean;
        has_spatial_index?: boolean;
        has_labels?: boolean;
        has_image_labels?: boolean;
        has_keys?: boolean;
        ordering?: OrderingMethodName;
        chunk_size?: number;
        ordering_dims?: number[];
        slice_dims?: number[];
        ordering_bits_per_dim?: number;
        transform?: number[];
        opacity?: number;
        absorption?: number;
        gamma?: number;
        intensity?: number;
        offset?: number;
        blending_mode?: BlendingModeName;
        layer?: boolean;
        extend_to_all?: string[];
        customLutBytes?: Uint8Array<ArrayBufferLike>;
        position_dtype?: string;
        color_dtype?: string;
        radius_dtype?: string;
        sharpness_dtype?: string;
    }
    Index
    type n_points ndim max_radius? has_colors? has_scalars? colormap? scalar_data_range? has_radii? has_sharpness? has_spatial_index? has_labels? has_image_labels? has_keys? ordering? chunk_size? ordering_dims? slice_dims? ordering_bits_per_dim? transform? opacity? absorption? gamma? intensity? offset? blending_mode? layer? extend_to_all? customLutBytes? position_dtype? color_dtype? radius_dtype? sharpness_dtype?
    type: "points"

    Node type identifier

    n_points: number

    Total point count

    ndim: number

    Position dimensionality

    max_radius?: number

    Maximum point radius in world units

    has_colors?: boolean

    Whether colors array is present

    has_scalars?: boolean

    Whether per-element scalar values are present (drives colormap).

    colormap?: string

    Colormap name applied to per-element scalars (e.g. 'viridis', 'plasma').

    scalar_data_range?: [number, number]

    [min, max] of the scalar data range used to remap into the colormap LUT.

    has_radii?: boolean

    Whether radii array is present

    has_sharpness?: boolean

    Whether sharpness array is present

    has_spatial_index?: boolean

    Whether spatial index exists

    has_labels?: boolean

    Whether per-element string labels exist (CSR-encoded, for hover tooltips)

    has_image_labels?: boolean

    Whether per-element image labels exist (CSR-encoded, for hover thumbnails)

    has_keys?: boolean

    Whether per-element stable string keys exist (CSR-encoded, for element actions)

    ordering?: OrderingMethodName

    Spatial ordering method

    chunk_size?: number

    Elements per chunk

    ordering_dims?: number[]

    Dimensions using space-filling curve ordering (spatial dims)

    slice_dims?: number[]

    Dimensions using lexicographic ordering (discrete/slice dims)

    ordering_bits_per_dim?: number

    Bits per dimension for space-filling curve encoding

    transform?: number[]

    4x4 transform matrix (column-major for THREE.js)

    opacity?: number

    Opacity multiplier

    absorption?: number

    Absorption coefficient κ (volumetric blending mode; identity 1.0)

    gamma?: number

    Gamma correction

    intensity?: number

    Intensity (linear color multiplier / gain)

    offset?: number

    Offset (additive brightness shift / black level subtraction)

    blending_mode?: BlendingModeName

    Blending mode

    layer?: boolean

    Whether this node is exposed as a layer in the Layers panel

    extend_to_all?: string[]

    List of dimension names to extend visibility across. Points with extend_to_all will be visible regardless of slice position in the specified dimensions (e.g., ['time'] makes points visible at all time values).

    customLutBytes?: Uint8Array<ArrayBufferLike>

    bytes loaded from the node's colormap_lut zarr array when colormap === 'custom'. Populated at scene-graph build time; runtime-only field, not authored at the zarr level.

    position_dtype?: string

    Position array dtype (for proper conversion)

    color_dtype?: string

    Color array dtype

    radius_dtype?: string

    Radius array dtype

    sharpness_dtype?: string

    Sharpness array dtype

    Settings
    Member Visibility

    On This Page
    Properties