IFClite TypeScript API
    Preparing search index...

    Interface StoreBackendMethods

    interface StoreBackendMethods {
        addBeam(
            modelId: string,
            storeyExpressId: number,
            params: ProfiledBeamInStoreParams | AddBeamInStoreParams,
        ): EntityRef;
        addColumn(
            modelId: string,
            storeyExpressId: number,
            params: ProfiledColumnInStoreParams | AddColumnInStoreParams,
        ): EntityRef;
        addColumnOnGrid?(
            modelId: string,
            storeyExpressId: number,
            params: ColumnInStoreParams | ProfiledColumnInStoreParams,
            binding: GridColumnBinding,
        ): EntityRef;
        addCostItem(modelId: string, params: CostItemParams): EntityRef;
        addCostQuantity(modelId: string, params: CostQuantityParams): EntityRef;
        addCostSchedule(modelId: string, params: CostScheduleParams): EntityRef;
        addCostValue(modelId: string, params: CostValueParams): EntityRef;
        addCurtainWall?(
            modelId: string,
            storeyExpressId: number,
            params: CurtainWallInStoreParams,
        ): EntityRef;
        addDoor(
            modelId: string,
            storeyExpressId: number,
            params: AddDoorInStoreParams,
        ): EntityRef;
        addElementType(
            modelId: string,
            params: ElementTypeInStoreParams,
        ): EntityRef;
        addEntity(
            modelId: string,
            def: { attributes: unknown[]; type: string },
        ): EntityRef;
        addGrid?(
            modelId: string,
            storeyExpressId: number,
            params: GridInStoreParams,
        ): EntityRef;
        addGroup?(
            modelId: string,
            params: GroupStoreCreateParams,
        ): GroupStoreIdentity;
        addHostedDoor(
            modelId: string,
            hostExpressId: number,
            params: HostedDoorInStoreParams,
        ): EntityRef;
        addHostedWindow(
            modelId: string,
            hostExpressId: number,
            params: HostedWindowInStoreParams,
        ): EntityRef;
        addMaterial(modelId: string, params: MaterialInStoreParams): EntityRef;
        addMaterialLayerSet(
            modelId: string,
            params: MaterialLayerSetInStoreParams,
        ): EntityRef;
        addMaterialLayerSetUsage(
            modelId: string,
            params: MaterialLayerSetUsageInStoreParams,
        ): EntityRef;
        addMember(
            modelId: string,
            storeyExpressId: number,
            params: ProfiledMemberInStoreParams | AddMemberInStoreParams,
        ): EntityRef;
        addOpening(
            modelId: string,
            hostExpressId: number,
            params: OpeningInStoreParams,
        ): EntityRef;
        addPlate(
            modelId: string,
            storeyExpressId: number,
            params: AddPlateInStoreParams,
        ): EntityRef;
        addRailing?(
            modelId: string,
            storeyExpressId: number,
            params: RailingInStoreParams,
        ): EntityRef;
        addRoof(
            modelId: string,
            storeyExpressId: number,
            params: AddRoofInStoreParams,
        ): EntityRef;
        addSlab(
            modelId: string,
            storeyExpressId: number,
            params: AddSlabInStoreParams,
        ): EntityRef;
        addSpace(
            modelId: string,
            storeyExpressId: number,
            params: AddSpaceInStoreParams,
        ): EntityRef;
        addStair?(
            modelId: string,
            storeyExpressId: number,
            params: StairInStoreParams,
        ): EntityRef;
        addStructuralAnalysisModel(
            modelId: string,
            params: StructuralAnalysisModelInStoreParams,
        ): EntityRef;
        addStructuralCurveMember(
            modelId: string,
            storeyExpressId: number,
            params: StructuralCurveMemberInStoreParams,
        ): EntityRef;
        addStructuralLinearAction(
            modelId: string,
            params: StructuralLinearActionInStoreParams,
        ): EntityRef;
        addStructuralLoadGroup(
            modelId: string,
            params: StructuralLoadGroupInStoreParams,
        ): EntityRef;
        addStructuralPointAction(
            modelId: string,
            params: StructuralPointActionInStoreParams,
        ): EntityRef;
        addStructuralPointConnection(
            modelId: string,
            storeyExpressId: number,
            params: StructuralPointConnectionInStoreParams,
        ): EntityRef;
        addWall(
            modelId: string,
            storeyExpressId: number,
            params: AddWallInStoreParams,
        ): EntityRef;
        addWindow(
            modelId: string,
            storeyExpressId: number,
            params: AddWindowInStoreParams,
        ): EntityRef;
        alignElements?(
            modelId: string,
            reference: number,
            targets: readonly number[],
            mode: AlignMode,
        ): Promise<EntityRef[]>;
        arrayElements?(
            modelId: string,
            expressIds: readonly number[],
            params: CopyArrayParams,
        ): EntityRef[];
        assignCostItemsToSchedule(
            modelId: string,
            scheduleExpressId: number,
            itemExpressIds: number[],
        ): EntityRef;
        assignMaterial(
            modelId: string,
            materialExpressId: number,
            objectExpressIds: number[],
        ): EntityRef;
        assignToCostItem(
            modelId: string,
            costItemExpressId: number,
            objectExpressIds: number[],
        ): EntityRef;
        assignToStructuralGroup(
            modelId: string,
            groupExpressId: number,
            objectExpressIds: number[],
        ): EntityRef;
        assignType(
            modelId: string,
            typeExpressId: number,
            objectExpressIds: number[],
        ): EntityRef;
        connectStructuralActivityToItem(
            modelId: string,
            itemExpressId: number,
            activityExpressId: number,
        ): EntityRef;
        connectStructuralMemberToConnection(
            modelId: string,
            memberExpressId: number,
            connectionExpressId: number,
        ): EntityRef;
        copyElements?(
            modelId: string,
            expressIds: readonly number[],
            transforms: readonly CopyTransform[],
        ): EntityRef[];
        duplicateElement?(
            ref: EntityRef,
            options: { Name?: string; offset: [number, number, number] },
        ): EntityRef;
        editHostedElement?(ref: EntityRef, patch: HostedElementEdit): EntityRef;
        joinWalls(
            modelId: string,
            aExpressId: number,
            bExpressId: number,
            options?: WallJoinApplyOptions,
        ): EntityRef;
        nestCostItems(
            modelId: string,
            parentExpressId: number,
            childExpressIds: number[],
        ): EntityRef;
        readGroup?(target: GroupStoreIdentity): GroupStoreSnapshot;
        removeCostEntity(
            modelId: string,
            expressId: number,
            options?: { detach?: boolean },
        ): void;
        removeEntity(ref: EntityRef): boolean;
        removeGroup?(expected: GroupStoreSnapshot): void;
        removeStair?(ref: EntityRef): boolean;
        replaceElement?(
            ref: EntityRef,
            storeyExpressId: number,
            element: InStoreReplacementElement,
        ): EntityRef;
        resizeWall?(
            ref: EntityRef,
            start: [number, number, number],
            end: [number, number, number],
            options?: { moveJoinedEnds?: boolean },
        ): EntityRef[];
        roomCommand?(
            modelId: string,
            storeyId: number,
            command: RoomCommand,
        ): Promise<RoomCommandResult>;
        setCostItemValues(
            modelId: string,
            itemExpressId: number,
            valueExpressIds: number[],
        ): void;
        setElementSize?(ref: EntityRef, patch: PhysicalSizePatch): EntityRef[];
        setPositionalAttribute(ref: EntityRef, index: number, value: unknown): void;
        splitElements?(
            modelId: string,
            requests: readonly ElementSplitRequest[],
        ): {
            added: EntityRef;
            left: EntityRef;
            right: EntityRef;
            source: EntityRef;
        }[];
        transformElements?(
            modelId: string,
            expressIds: readonly number[],
            operation: StoreyTransformOp,
        ): EntityRef[];
        trimExtendElement?(
            ref: EntityRef,
            params: ElementTrimExtendParams,
        ): EntityRef[];
        updateGroup?(
            expected: GroupStoreSnapshot,
            patch: GroupStorePatch,
        ): GroupStoreIdentity;
    }

    Hierarchy

    • StoreAuthoringBackendMethods
      • StoreBackendMethods
    Index
    addBeam addColumn addColumnOnGrid? addCostItem addCostQuantity addCostSchedule addCostValue addCurtainWall? addDoor addElementType addEntity addGrid? addGroup? addHostedDoor addHostedWindow addMaterial addMaterialLayerSet addMaterialLayerSetUsage addMember addOpening addPlate addRailing? addRoof addSlab addSpace addStair? addStructuralAnalysisModel addStructuralCurveMember addStructuralLinearAction addStructuralLoadGroup addStructuralPointAction addStructuralPointConnection addWall addWindow alignElements? arrayElements? assignCostItemsToSchedule assignMaterial assignToCostItem assignToStructuralGroup assignType connectStructuralActivityToItem connectStructuralMemberToConnection copyElements? duplicateElement? editHostedElement? joinWalls nestCostItems readGroup? removeCostEntity removeEntity removeGroup? removeStair? replaceElement? resizeWall? roomCommand? setCostItemValues setElementSize? setPositionalAttribute splitElements? transformElements? trimExtendElement? updateGroup?

    • High-level builders: drop an element into an existing parsed model, anchored to a target IfcBuildingStorey. Each emits the full STEP sub-graph (placement → profile → solid → representation + IfcRelContainedInSpatialStructure / IfcRelAggregates for spaces) into the overlay so the element appears alongside the existing model on export.

      Parameters

      Returns EntityRef

    • Complete IfcCurtainWall aggregate, including its member and panel bodies.

      Parameters

      Returns EntityRef

    • Parameters

      • modelId: string
      • def: { attributes: unknown[]; type: string }

      Returns EntityRef

    • IfcGrid with straight, tagged axes and its FootPrint representation.

      Parameters

      Returns EntityRef

    • IfcDoor in a new opening of an IfcWall, linked by IfcRelFillsElement. Returns the door.

      Parameters

      Returns EntityRef

    • IfcWindow in a new opening of an IfcWall, linked by IfcRelFillsElement. Returns the window.

      Parameters

      Returns EntityRef

    • IfcOpeningElement + IfcRelVoidsElement cut into an existing IfcWall or IfcSlab. Returns the opening.

      Parameters

      Returns EntityRef

    • Optional host capability: an IfcRailing along a storey-local polyline. Returns the railing.

      Parameters

      Returns EntityRef

    • Optional host capability: a storey-local IfcStair aggregating one IfcStairFlight. Returns the stair.

      Parameters

      Returns EntityRef

    • Parameters

      • modelId: string
      • reference: number
      • targets: readonly number[]
      • mode: AlignMode

      Returns Promise<EntityRef[]>

    • Array count includes the original; full circles exclude a coincident final copy.

      Parameters

      Returns EntityRef[]

    • Assign itemExpressIds (IfcCostItem) to scheduleExpressId (IfcCostSchedule)'s control.

      Parameters

      • modelId: string
      • scheduleExpressId: number
      • itemExpressIds: number[]

      Returns EntityRef

    • Associate a material (any IfcMaterialSelect) with objects via IfcRelAssociatesMaterial, replacing their previous association. Returns the relationship.

      Parameters

      • modelId: string
      • materialExpressId: number
      • objectExpressIds: number[]

      Returns EntityRef

    • Assign objectExpressIds (products AND/OR tasks) to costItemExpressId's control.

      Parameters

      • modelId: string
      • costItemExpressId: number
      • objectExpressIds: number[]

      Returns EntityRef

    • IfcRelAssignsToGroup — members/connections into an analysis model, or activities into a load group.

      Parameters

      • modelId: string
      • groupExpressId: number
      • objectExpressIds: number[]

      Returns EntityRef

    • Type objects via IfcRelDefinesByType, extending the type's relationship and detaching them from a previous type. Returns the relationship.

      Parameters

      • modelId: string
      • typeExpressId: number
      • objectExpressIds: number[]

      Returns EntityRef

    • IfcRelConnectsStructuralActivity applying an action/reaction to the member or connection it acts on.

      Parameters

      • modelId: string
      • itemExpressId: number
      • activityExpressId: number

      Returns EntityRef

    • IfcRelConnectsStructuralMember linking a curve member to a point connection.

      Parameters

      • modelId: string
      • memberExpressId: number
      • connectionExpressId: number

      Returns EntityRef

    • Copy a dependency-pruned selection once per storey-local transform, atomically.

      Parameters

      • modelId: string
      • expressIds: readonly number[]
      • transforms: readonly CopyTransform[]

      Returns EntityRef[]

    • Duplicate with the viewer naming policy; explicit storey-local IFC XYZ displacement.

      Parameters

      • ref: EntityRef
      • options: { Name?: string; offset: [number, number, number] }

      Returns EntityRef

    • Join two straight walls through IfcRelConnectsPathElements, rewriting their bodies/axes atomically. Returns the relationship.

      Parameters

      Returns EntityRef

    • Nest childExpressIds (IfcCostItem) under parentExpressId as IfcRelNests. A child already nested elsewhere is reparented.

      Parameters

      • modelId: string
      • parentExpressId: number
      • childExpressIds: number[]

      Returns EntityRef

    • Safe-delete an IfcCostSchedule / IfcCostItem / IfcCostValue. Throws, naming referrers, if a value is still listed in another item's CostValues or another value's Components — unless options.detach is set, which rewrites those lists first. Deleting an item detaches it from every IfcRelNests / IfcRelAssignsToControl and cascades to values referenced ONLY by it.

      Parameters

      • modelId: string
      • expressId: number
      • Optionaloptions: { detach?: boolean }

      Returns void

    • Optional host capability: atomically remove a uniquely owned single-flight stair assembly.

      Parameters

      Returns boolean

    • Parameters

      • ref: EntityRef
      • start: [number, number, number]
      • end: [number, number, number]
      • Optionaloptions: { moveJoinedEnds?: boolean }

      Returns EntityRef[]

    • Native mesh/DCEL Room operations with atomic history-aware layout edits.

      Parameters

      Returns Promise<RoomCommandResult>

    • Replace itemExpressId's CostValues. Pass [] to clear it (written as $).

      Parameters

      • modelId: string
      • itemExpressId: number
      • valueExpressIds: number[]

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns EntityRef[]

    Settings
    Member Visibility

    On This Page
    Methods
    addBeamaddColumnaddColumnOnGridaddCostItemaddCostQuantityaddCostScheduleaddCostValueaddCurtainWalladdDooraddElementTypeaddEntityaddGridaddGroupaddHostedDooraddHostedWindowaddMaterialaddMaterialLayerSetaddMaterialLayerSetUsageaddMemberaddOpeningaddPlateaddRailingaddRoofaddSlabaddSpaceaddStairaddStructuralAnalysisModeladdStructuralCurveMemberaddStructuralLinearActionaddStructuralLoadGroupaddStructuralPointActionaddStructuralPointConnectionaddWalladdWindowalignElementsarrayElementsassignCostItemsToScheduleassignMaterialassignToCostItemassignToStructuralGroupassignTypeconnectStructuralActivityToItemconnectStructuralMemberToConnectioncopyElementsduplicateElementeditHostedElementjoinWallsnestCostItemsreadGroupremoveCostEntityremoveEntityremoveGroupremoveStairreplaceElementresizeWallroomCommandsetCostItemValuessetElementSizesetPositionalAttributesplitElementstransformElementstrimExtendElementupdateGroup