IFClite TypeScript API
    Preparing search index...

    Interface ListDefinition

    interface ListDefinition {
        capturedScope?: CapturedEntityScope;
        columns: ColumnDefinition[];
        createdAt: number;
        description?: string;
        entityTypes: IfcTypeEnum[];
        expressIdsByModel?: Record<string, number[]>;
        grouping?: ListGrouping;
        groups: FilterGroup[];
        id: string;
        legacyConditions?: PropertyCondition[];
        modelTagScope?: ListModelTagScope;
        name: string;
        sortBy?: { columnId: string; direction: "asc" | "desc" };
        unreadableConditions?: UnreadableListCondition[];
        updatedAt: number;
    }
    Index
    capturedScope? columns createdAt description? entityTypes expressIdsByModel? grouping? groups id legacyConditions? modelTagScope? name sortBy? unreadableConditions? updatedAt
    capturedScope?: CapturedEntityScope

    Durable captured population, intersected with the list's existing source criteria.

    columns: ColumnDefinition[]

    Columns to display

    createdAt: number
    description?: string
    entityTypes: IfcTypeEnum[]

    Which entity types to include

    expressIdsByModel?: Record<string, number[]>

    Optional explicit element scope — a snapshot of express IDs per model (e.g. from a search/filter result), keyed by modelId. When present, the list targets exactly these elements per model and entityTypes is ignored; filter groups still apply on top. Keyed by model so federated snapshots don't over-select when local express IDs collide across files.

    grouping?: ListGrouping

    Optional grouping + summation for the summary view

    groups: FilterGroup[]

    Canonical Rules filters for migrated and newly-authored lists.

    id: string
    legacyConditions?: PropertyCondition[]

    Flat predicates for provider-only executeList callers (the SDK). Saved lists carry every predicate in groups instead (listCondition, #6190).

    modelTagScope?: ListModelTagScope

    Optional MODEL scope by model tag (#4215, model-tag-scope.ts); absent = every model.

    name: string
    sortBy?: { columnId: string; direction: "asc" | "desc" }

    Current sort state

    unreadableConditions?: UnreadableListCondition[]

    Saved filters migration could not read (malformed, unknown operator or source, a rule this build does not know). Kept visible; a list with any cannot run until they are removed.

    updatedAt: number

    Settings
    Member Visibility

    On This Page
    Properties