IFClite TypeScript API
    Preparing search index...

    Interface Ifc5ExportOptions

    Options for IFC5 export

    interface Ifc5ExportOptions {
        applyMutations?: boolean;
        author?: string;
        dataVersion?: string;
        hiddenEntityIds?: Set<number>;
        includeGeometry?: boolean;
        includeProperties?: boolean;
        isolatedEntityIds?: Set<number> | null;
        onlyKnownProperties?: boolean;
        onlyTreeEntities?: boolean;
        prettyPrint?: boolean;
        stripPathPrefix?: string;
        textureSources?: ReadonlyMap<string, IfcxEncodedImage>;
        visibleOnly?: boolean;
    }
    Index
    applyMutations? author? dataVersion? hiddenEntityIds? includeGeometry? includeProperties? isolatedEntityIds? onlyKnownProperties? onlyTreeEntities? prettyPrint? stripPathPrefix? textureSources? visibleOnly?
    applyMutations?: boolean

    Apply mutations (default: true if mutation view provided)

    author?: string

    Author name

    dataVersion?: string

    Data version identifier

    hiddenEntityIds?: Set<number>

    Hidden entity IDs (local expressIds)

    includeGeometry?: boolean

    Include geometry as USD meshes (default: true)

    includeProperties?: boolean

    Include properties (default: true)

    isolatedEntityIds?: Set<number> | null

    Isolated entity IDs (local expressIds, null = no isolation)

    onlyKnownProperties?: boolean

    Only export properties with known IFC5 schemas (default: true). When false, all IFC4 properties are exported even if they lack an official IFC5 schema definition (viewer may show warnings).

    onlyTreeEntities?: boolean

    Only export entities reachable from the spatial tree (default: true). When true, relationship entities (IfcRel*), type objects, materials, and other non-spatial entities are excluded from the output.

    prettyPrint?: boolean

    Pretty print JSON (default: true)

    stripPathPrefix?: string

    A namespace prefix to remove from GlobalId-derived node paths (#4444). A store reconstructed from a shared room keys its entities by room path, /<slotId>/<GlobalId>; the slot is the room's namespace, not the model's, so the exported file carries /<GlobalId> — the same paths a single-model room exports. GlobalIds outside the prefix are untouched.

    textureSources?: ReadonlyMap<string, IfcxEncodedImage>

    Original image bytes keyed by exact MeshTextureRef.url; retained in IFCX without recompression.

    visibleOnly?: boolean

    Only export visible entities

    Settings
    Member Visibility

    On This Page
    Properties