IFClite TypeScript API
    Preparing search index...

    Interface MaterialPropertiesView

    Structural overlay shape accepted by live on-demand parser reads.

    interface MaterialPropertiesView {
        getAttributeMutationsForEntity?(
            id: number,
        ): readonly { name: string; value: string }[];
        getEffectiveChanges?(): readonly { entityId: number; kind: string }[];
        getMutationRevision?(): number;
        getNewEntities(): readonly {
            attributes?: readonly unknown[];
            expressId: number;
            type: string;
        }[];
        getNewEntitiesOfType?(
            type: string,
        ): Iterable<{ expressId: number; type: string }>;
        getNewEntity?(
            id: number,
        ): { attributes?: readonly unknown[]; type: string } | null;
        getPositionalMutationsForEntity?(
            id: number,
        ): ReadonlyMap<number, unknown> | null;
        getTombstones?(): ReadonlySet<number>;
        getTypeMutations?(): ReadonlyMap<number, { newType: string }>;
        isDeleted(expressId: number): boolean;
        resolveBaseEntityId?(id: number): number;
    }

    Hierarchy

    • MaterialReadView
      • MaterialPropertiesView
    Index
    getAttributeMutationsForEntity? getEffectiveChanges? getMutationRevision? getNewEntities getNewEntitiesOfType? getNewEntity? getPositionalMutationsForEntity? getTombstones? getTypeMutations? isDeleted resolveBaseEntityId?

    • Parameters

      • id: number

      Returns readonly { name: string; value: string }[]

    • Returns readonly { entityId: number; kind: string }[]

    • Returns number

    • Overlay-created entities, in creation order, with their authored class.

      Returns readonly { attributes?: readonly unknown[]; expressId: number; type: string }[]

    • Created entities authored as one class, in creation order. Lets a single-class query skip the other created entities, which is what keeps per-element authoring linear (#5413). Absent: the full list is scanned.

      Parameters

      • type: string

      Returns Iterable<{ expressId: number; type: string }>

    • O(1) created-entity lookup. Absent (a plain-data snapshot): membership is built from getNewEntities.

      Parameters

      • id: number

      Returns { attributes?: readonly unknown[]; type: string } | null

    • Parameters

      • id: number

      Returns ReadonlyMap<number, unknown> | null

    • Optional indexed tombstones let aggregate counts avoid a full source walk.

      Returns ReadonlySet<number>

    • Retype intents by express id. Absent means the overlay carries none.

      Returns ReadonlyMap<number, { newType: string }>

    • True for a deleted source entity and for a created-then-deleted one.

      Parameters

      • expressId: number

      Returns boolean

    • Parameters

      • id: number

      Returns number

    Settings
    Member Visibility

    On This Page
    Methods