IFClite TypeScript API
    Preparing search index...

    Interface BimBackend

    Abstraction over the viewer's internal state — SDK namespaces use this.

    Each namespace is a typed property with methods matching the adapter contract. SDK namespace classes call backend.query.entities(...) instead of dispatch().

    BimHost (wire protocol) uses dispatchToBackend() to route string-based SdkRequests to the typed namespace methods.

    interface BimBackend {
        cost?: CostBackendMethods;
        export: ExportBackendMethods;
        files: FilesBackendMethods;
        lens: LensBackendMethods;
        model: ModelBackendMethods;
        mutate: MutateBackendMethods;
        query: QueryBackendMethods;
        schedule: ScheduleBackendMethods;
        selection: SelectionBackendMethods;
        spaces?: SpacesBackendMethods;
        spatial: SpatialBackendMethods;
        store: StoreBackendMethods;
        structural?: StructuralBackendMethods;
        style?: StyleBackendMethods;
        viewer: ViewerBackendMethods;
        visibility: VisibilityBackendMethods;
        subscribe(
            event: BimEventType,
            handler: (data: unknown) => void,
        ): () => void;
    }

    Implemented by

    Index
    cost? export files lens model mutate query schedule selection spaces? spatial store structural? style? viewer visibility
    subscribe
    cost?: CostBackendMethods

    IFC 5D cost reads, when the backend retains loaded source bytes.

    export: ExportBackendMethods
    files: FilesBackendMethods
    lens: LensBackendMethods
    model: ModelBackendMethods
    mutate: MutateBackendMethods
    query: QueryBackendMethods
    schedule: ScheduleBackendMethods
    selection: SelectionBackendMethods
    spaces?: SpacesBackendMethods

    Space derivation — present only on local backends with store access.

    spatial: SpatialBackendMethods
    store: StoreBackendMethods
    structural?: StructuralBackendMethods

    Structural analysis reads, when supported by the backend.

    style?: StyleBackendMethods

    Persistent colouring — present only on local backends with store access.

    viewer: ViewerBackendMethods
    visibility: VisibilityBackendMethods

    • Subscribe to viewer events

      Parameters

      Returns () => void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods