NARU API
    Preparing search index...

    Interface HierarchySidecarEntry

    One occurrence as the compiler hands it to the encoder.

    interface HierarchySidecarEntry {
        depth: number;
        nodeIndex?: number;
        relocated?: {
            initialVisibility: boolean;
            localTransform: readonly number[];
            name: string;
            occurrenceId: string;
            prototypeId: string;
            semanticId?: string | null;
            sourceRef?: string | null;
            tags: readonly string[];
        };
    }
    Index
    depth nodeIndex? relocated?
    depth: number

    Occurrence nesting depth, matching the runtime's traversal depth.

    nodeIndex?: number

    Document node index, or undefined when the node is relocated.

    relocated?: {
        initialVisibility: boolean;
        localTransform: readonly number[];
        name: string;
        occurrenceId: string;
        prototypeId: string;
        semanticId?: string | null;
        sourceRef?: string | null;
        tags: readonly string[];
    }

    Present only for a relocated entry.

    Type Declaration

    • ReadonlyinitialVisibility: boolean
    • ReadonlylocalTransform: readonly number[]

      The local transform the relocated node carried in the document.

    • Readonlyname: string
    • ReadonlyoccurrenceId: string
    • ReadonlyprototypeId: string
    • Optional ReadonlysemanticId?: string | null

      The value the document node would have carried: a string, an explicit null for an occurrence that genuinely has none, and undefined for an omitted key. Relocation must not decide between them for a reader, so all three states survive.

    • Optional ReadonlysourceRef?: string | null
    • Readonlytags: readonly string[]

    Settings
    Member Visibility

    On This Page
    Properties