Documentation - v20.0.0-dev
    Preparing search index...
    • REST client for reading and updating twin projects and their search exports.

      Parameters

      Returns {
          downloadExport(
              twin: Twin,
              filter: TwinSearchDownloadExportFilter,
          ): Promise<void>;
          getMgeomGeometryInfo(
              twin: Twin,
              geometryType: MgeomGeometryType,
              axis?: Vector3,
          ): Promise<TwinMgeomGeometryInfo>;
          getMgeomGeometryRequest(
              twin: Twin,
              pageNumber: number,
              pageSize: number,
              geometryType: MgeomGeometryType,
              axis?: Vector3,
          ): FileRequest;
          getTwinProjectInfo(twin: Twin): Promise<TwinProjectInfo>;
          getTwinProjectList(
              pageNumber?: number,
              pageSize?: number,
              type?: TwinProjectType,
          ): Promise<ApiDataList<TwinProject>>;
          putTwinProjectInfo(projectId: number, info: TwinProjectInfo): Promise<void>;
      }

      • downloadExport: function
      • getMgeomGeometryInfo: function
        • Returns the geometry information of a twin's FlatBuffers (.mgeom) maquette, for a twin of a project in FlatBuffers (ProjectApi.getFlatBuffers).

          Parameters

          • twin: Twin

            The twin to get the information from

          • geometryType: MgeomGeometryType

            The geometry asked for

          • Optionalaxis: Vector3

            Normal of the projection plane, for the 2D geometry

          Returns Promise<TwinMgeomGeometryInfo>

          The geometry information, including the mesh count used for pagination

      • getMgeomGeometryRequest: function
        • Builds the request for one page of a twin's FlatBuffers (.mgeom) maquette, in the frame of the twin.

          Parameters

          • twin: Twin

            The twin to get the geometry from

          • pageNumber: number

            Page to request, starting at 1

          • pageSize: number

            Number of meshes per page

          • geometryType: MgeomGeometryType

            The geometry asked for

          • Optionalaxis: Vector3

            Normal of the projection plane, for the 2D geometry

          Returns FileRequest

          The request to send to get the page geometry, a .mgeom file

      • getTwinProjectInfo: function
      • getTwinProjectList: function
      • putTwinProjectInfo: function
        • Parameters

          Returns Promise<void>