Cognite JavaScript SDK > ThreeD

Class: ThreeD

Hierarchy

ThreeD

Index

Methods


Methods

<Static> createAssetMappings

createAssetMappings(modelId: number, revisionId: number, assetMappings: AssetMapping[]): Promise<AssetMapping[]>

Defined in ThreeD.ts:157

Parameters:

Name Type
modelId number
revisionId number
assetMappings AssetMapping[]

Returns: Promise<AssetMapping[]>


<Static> createModels

createModels(names: string[]): Promise<Model[]>

Defined in ThreeD.ts:172

Parameters:

Name Type
names string[]

Returns: Promise<Model[]>


<Static> createRevisions

createRevisions(modelId: number, revisions: CreateRevision[]): Promise<Revision[]>

Defined in ThreeD.ts:183

Parameters:

Name Type
modelId number
revisions CreateRevision[]

Returns: Promise<Revision[]>


<Static> deleteAssetMappings

deleteAssetMappings(modelId: number, revisionId: number, mappings: AssetMapping[]): Promise<void>

Defined in ThreeD.ts:276

Parameters:

Name Type
modelId number
revisionId number
mappings AssetMapping[]

Returns: Promise<void>


<Static> deleteModels

deleteModels(modelIds: number[]): Promise<void>

Defined in ThreeD.ts:261

Parameters:

Name Type
modelIds number[]

Returns: Promise<void>


<Static> deleteRevisions

deleteRevisions(modelId: number, revisionIds: number[]): Promise<void>

Defined in ThreeD.ts:267

Parameters:

Name Type
modelId number
revisionIds number[]

Returns: Promise<void>


<Static> listAssetMappings

listAssetMappings(modelId: number, revisionId: number, params?: ThreeDListAssetMappingsParams): Promise<DataWithCursor<AssetMapping>>

Defined in ThreeD.ts:286

Parameters:

Name Type
modelId number
revisionId number
Optional params ThreeDListAssetMappingsParams

Returns: Promise<DataWithCursor<AssetMapping>>


<Static> listModels

listModels(params?: ThreeDListModelsParams): Promise<DataWithCursor<Model>>

Defined in ThreeD.ts:298

Parameters:

Name Type
Optional params ThreeDListModelsParams

Returns: Promise<DataWithCursor<Model>>


<Static> listNodeAncestors

listNodeAncestors(modelId: number, revisionId: number, params: ThreeDListNodeAncestorsParams): Promise<DataWithCursor<Node>>

Defined in ThreeD.ts:320

Parameters:

Name Type
modelId number
revisionId number
params ThreeDListNodeAncestorsParams

Returns: Promise<DataWithCursor<Node>>


<Static> listNodes

listNodes(modelId: number, revisionId: number, params?: ThreeDListNodesParams): Promise<DataWithCursor<Node>>

Defined in ThreeD.ts:308

Parameters:

Name Type
modelId number
revisionId number
Optional params ThreeDListNodesParams

Returns: Promise<DataWithCursor<Node>>


<Static> listRevisions

listRevisions(modelId: number, params?: ThreeDListRevisionsParams): Promise<DataWithCursor<Revision>>

Defined in ThreeD.ts:332

Parameters:

Name Type
modelId number
Optional params ThreeDListRevisionsParams

Returns: Promise<DataWithCursor<Revision>>


<Static> listSectors

listSectors(modelId: number, revisionId: number, params?: ThreeDListSectorsParams): Promise<DataWithCursor<Sector>>

Defined in ThreeD.ts:343

Parameters:

Name Type Default value
modelId number -
revisionId number -
Default value params ThreeDListSectorsParams {}

Returns: Promise<DataWithCursor<Sector>>


<Static> retrieveFile

retrieveFile(fileId: number, responseType: ResponseType, onProgress?: DownloadProgress): Promise<any>

Defined in ThreeD.ts:197

Parameters:

Name Type Default value
fileId number -
responseType ResponseType -
Default value onProgress DownloadProgress () => {}

Returns: Promise<any>


<Static> retrieveModel

retrieveModel(modelId: number): Promise<Model>

Defined in ThreeD.ts:211

Parameters:

Name Type
modelId number

Returns: Promise<Model>


<Static> retrieveRevision

retrieveRevision(modelId: number, revisionId: number): Promise<Revision>

Defined in ThreeD.ts:217

Parameters:

Name Type
modelId number
revisionId number

Returns: Promise<Revision>


<Static> updateModels

updateModels(models: Partial<Model>[]): Promise<Model[]>

Defined in ThreeD.ts:226

Parameters:

Name Type
models Partial<Model>[]

Returns: Promise<Model[]>


<Static> updateRevisionThumbnail

updateRevisionThumbnail(modelId: number, revisionId: number, fileId: number): Promise<void>

Defined in ThreeD.ts:251

Parameters:

Name Type
modelId number
revisionId number
fileId number

Returns: Promise<void>


<Static> updateRevisions

updateRevisions(modelId: number, revisions: Partial<Revision>[]): Promise<Revision[]>

Defined in ThreeD.ts:237

Parameters:

Name Type
modelId number
revisions Partial<Revision>[]

Returns: Promise<Revision[]>