Function ModelApi

Returns {
    getGeometryInfo(model: ModelVersion): Promise<ModelGeometryInfo>;
    getGeometryRequest(
        model: ModelVersion,
        pageNumber: number,
        pageSize: number,
    ): FileRequest;
    getModels(
        pageNumber?: number,
        pageSize?: number,
    ): Promise<ApiDataList<InstanceModel>>;
    getObjectDetails(
        model: ModelVersion,
        guid: string,
    ): Promise<ModelObjectProperty[]>;
    getTreeView(
        model: ModelVersion,
        signal?: AbortSignal,
    ): Promise<ModelTreeViewNode[]>;
}

• getGeometryInfo: function

  • getGeometryInfo(model: ModelVersion): Promise<ModelGeometryInfo>

    Returns the geometry information of a model version.

    Parameters

    • model: ModelVersion

      The model version to get the information from

    Returns Promise<ModelGeometryInfo>

    The geometry information, including the node count used for pagination

• getGeometryRequest: function

  • getGeometryRequest(
        model: ModelVersion,
        pageNumber: number,
        pageSize: number,
    ): FileRequest

    Builds the request for one page of a model version's geometry.

    Parameters

    • model: ModelVersion

      The model version to get the geometry from

    • pageNumber: number

      Page to request, starting at 1

    • pageSize: number

      Number of root nodes per page

    Returns FileRequest

    The request to send to get the page geometry

• getModels: function

  • getModels(
        pageNumber?: number,
        pageSize?: number,
    ): Promise<ApiDataList<InstanceModel>>

    Returns a page of the models of the instance.

    Parameters

    • pageNumber: number = 1

      Page to request, starting at 1

    • pageSize: number = 1000

      Number of models per page

    Returns Promise<ApiDataList<InstanceModel>>

    The requested page of models

• getObjectDetails: function

  • getObjectDetails(
        model: ModelVersion,
        guid: string,
    ): Promise<ModelObjectProperty[]>

    Returns the IFC properties of an object of a model version.

    Parameters

    • model: ModelVersion

      The model version holding the object

    • guid: string

      The GUID of the object

    Returns Promise<ModelObjectProperty[]>

    The properties of the object

• getTreeView: function

  • getTreeView(
        model: ModelVersion,
        signal?: AbortSignal,
    ): Promise<ModelTreeViewNode[]>

    Returns the whole object tree view of a model version.

    Parameters

    • model: ModelVersion

      The model version to get the tree view from

    • Optionalsignal: AbortSignal

      Signal used to abort the request

    Returns Promise<ModelTreeViewNode[]>

    The root nodes of the tree view, each node carrying its children