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

    Class LabelLoader

    Index
    constructor
    arraysCache arraysInflight labelCache labelInflight decoder rootLoc channel
    getLabel hasLabels dispose loadArrays openArrays fetchLabel

    • Parameters

      • rootLoc: Location<Readable>
      • channel: "keys" | "labels" = 'labels'

        Which per-element string channel to read (issue #1917). 'labels' (default) reads label_offsets / label_bytes; 'keys' reads key_offsets / key_bytes. Both use the same CSR encoding.

      • maxCacheBytes: number = DEFAULT_MAX_CACHE_BYTES

        Byte budget for decoded strings across all nodes.

      Returns LabelLoader

    arraysCache: Map<string, LabelArrays | null> = ...

    Opened array handles, or null for nodes known not to carry this channel.

    arraysInflight: Map<string, Promise<LabelArrays | null>> = ...

    In-flight array opens, coalesced per node.

    labelCache: LRUCache<string | null>

    Bounded decoded-label cache shared across nodes.

    labelInflight: Map<string, Promise<string | null | undefined>> = ...

    In-flight label reads, coalesced per node and element.

    decoder: TextDecoder = ...

    UTF-8 text decoder (reused).

    rootLoc: Location<Readable>
    channel: "keys" | "labels" = 'labels'

    Which per-element string channel to read (issue #1917). 'labels' (default) reads label_offsets / label_bytes; 'keys' reads key_offsets / key_bytes. Both use the same CSR encoding.

    • Get one label, or null when absent, empty, invalid, or unreadable.

      Parameters

      • nodePath: string
      • elementIndex: number

      Returns Promise<string | null>

    • Check if a node has this string channel in its cached metadata.

      Parameters

      • nodeAttrs: Record<string, unknown>

      Returns boolean

    • Return undefined for retryable failures; null is a cacheable missing or empty label.

      Parameters

      • nodePath: string
      • elementIndex: number

      Returns Promise<string | null | undefined>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods