Class Assembly

Provides properties and methods for obtaining information about an assembly on the Open Cloud Server and managing its data.

Hierarchy (View Summary)

Endpoint
- Assembly

Constructors

constructor

new Assembly(data: any, httpClient: IHttpClient): Assembly
Parameters
- data: any
  Raw assembly data received from the server. For more information, see Open Cloud Assemblies API.
- httpClient: IHttpClient
  HTTP client instance used to send requests to the REST API server.
Returns Assembly
Overrides Endpoint.constructor

Properties

headers

headers: HeadersInit

Endpoint-specific HTTP headers for the GET, POST, PUT and DELETE requests. You can add custom headers at any time.

path

path: string

Endpoint API path relative to the REST API server URL.

Accessors

associatedFiles

get associatedFiles(): IAssociatedFileData[]
List of unique files from which the assembly was created.

Returns IAssociatedFileData[]

created

get created(): string
Assembly creation time (UTC) in the format specified in ISO 8601.

Returns string

data

get data(): any
Returns the raw assembly data received from the server. For more information, see Open Cloud Assemblies API.

Returns any

files

get files(): string[]
List of file IDs from which the assembly was created.

Returns string[]

geometryType

get geometryType(): string
Assembly geometry data type:
- vsfx - VSFX format, assembly can be opened in VisualizeJS 3D viewer.
Returns an empty string if the geometry data is not yet ready.
Returns string

id

get id(): string
Unique assembly ID.

Returns string

name

get name(): string
Assembly name.

Returns string

owner

get owner(): IShortUserDesc
Assembly owner information.

Returns IShortUserDesc

relatedJobs

get relatedJobs(): string[]
List of assembly related job IDs.

Returns string[]

status

get status(): string
Assembly geometry data and properties status. Can be waiting, inprogress, done or failed.

An assemblies without geometry data cannot be opened in viewer.

Returns string

type

get type(): string
Assembly type. Returns an assembly string.

Returns string

Methods

checkout

checkout(): Promise<Assembly>
Reloads assembly data from the server.

Returns Promise<Assembly>

createClashTest

createClashTest(
    name: string,
    selectionTypeA: string,
    selectionTypeB: string,
    selectionSetA?: string | string[],
    selectionSetB?: string | string[],
    params?: {
        clearance?: boolean;
        interval?: number;
        signal?: AbortSignal;
        timeout?: number;
        tolerance?: string | number;
        waitForDone?: boolean;
    },
): Promise<ClashTest>
Creates an assembly clash test. Assembly must be in a done state, otherwise the test will fail.
Parameters
- name: string
  Test name.
- selectionTypeA: string
  The type of first selection set for clash detection. Can be one of:
  
  all - All file/assembly objects.
  
  handle - Objects with original handles specified in the selectionSetA.
  
  models - All objects of the models with original handles specified in the selectionSetA.
  
  searchquery - Objects retrieved by the search queries specified in selectionSetA.
- selectionTypeB: string
  The type of second selection set for clash detection. Can be one of:
  
  all - All file/assembly objects.
  
  handle - Objects with original handles specified in the selectionSetB.
  
  models - All objects of the models with original handles specified in the selectionSetB.
  
  searchquery - Objects retrieved by the search queries specified in selectionSetB.
- OptionalselectionSetA: string | string[]
  First selection set for clash detection. Objects from selectionSetA will be tested against each others by objects from the selectionSetB during the test.
- OptionalselectionSetB: string | string[]
  Second selection set for clash detection. Objects from selectionSetB will be tested against each others by objects from the selectionSetA during the test.
- Optionalparams: {
      clearance?: boolean;
      interval?: number;
      signal?: AbortSignal;
      timeout?: number;
      tolerance?: string | number;
      waitForDone?: boolean;
  }
  An object containing test parameters.
  - Optionalclearance?: boolean
    The type of the clashes that the test detects:
    
    true - Сlearance clash. A clash in which the object A may or may not intersect with object B, but comes within a distance of less than the tolerance.
    
    false - Hard clash. A clash in which the object A intersects with object B by a distance of more than the tolerance.
  - Optionalinterval?: number
    The time, in milliseconds, the function should delay in between checking test status.
  - Optionalsignal?: AbortSignal
    An AbortController signal, which can be used to abort waiting as desired.
  - Optionaltimeout?: number
    The time, in milliseconds that the function should wait test. If test is not complete during this time, the TimeoutError exception will be thrown.
  - Optionaltolerance?: string | number
    The distance of separation between objects at which test begins detecting clashes.
  - OptionalwaitForDone?: boolean
    Wait for test to complete.
Returns Promise<ClashTest>

delete

delete(): Promise<any>
Deletes an assembly from the server.

Returns Promise<any>
Returns the raw data of a deleted assembly. For more information, see Open Cloud Assemblies API.

Overrides Endpoint.delete

deleteClashTest

deleteClashTest(testId: string): Promise<any>
Deletes the specified assembly clash test.
Parameters
- testId: string
  Test ID.
Returns Promise<any>
Returns the raw data of a deleted test. For more information, see Open Cloud Assemblies API.

deleteViewpoint

deleteViewpoint(guid: string): Promise<any>
Deletes the specified assembly viewpoint.
Parameters
- guid: string
  Viewpoint GUID.
Returns Promise<any>
Returns a deleted viewpoint. For more information, see Open Cloud Assembly Viewpoints API.

downloadFileRange

downloadFileRange(
    requestId: number,
    records: any,
    dataId: string,
    onProgress?: (
        progress: number,
        chunk: Uint8Array,
        requestId: number,
    ) => void,
    signal?: AbortSignal,
): Promise<void>
Deprecated since 25.3. Use downloadResourceRange() instead.
Parameters
- requestId: number
- records: any
- dataId: string
- OptionalonProgress: (progress: number, chunk: Uint8Array, requestId: number) => void
- Optionalsignal: AbortSignal
Returns Promise<void>

downloadResource

downloadResource(
    dataId: string,
    onProgress?: (progress: number, chunk: Uint8Array) => void,
    signal?: AbortSignal,
): Promise<ArrayBuffer>
Downloads an assembly resource file. Resource files are files that contain model scene descriptions, or geometry data.
Parameters
- dataId: string
  Resource file name.
- OptionalonProgress: (progress: number, chunk: Uint8Array) => void
  Download progress callback.
- Optionalsignal: AbortSignal
  An AbortController signal. Allows to communicate with a fetch request and abort it if desired.
Returns Promise<ArrayBuffer>

downloadResourceRange

downloadResourceRange(
    dataId: string,
    requestId: string | number,
    ranges: { begin: number; end: number; requestId: number }[],
    onProgress?: (
        progress: number,
        chunk: Uint8Array,
        requestId: number,
    ) => void,
    signal?: AbortSignal,
): Promise<ArrayBuffer>
Downloads a part of assembly resource file. Resource files are files that contain model scene descriptions, or geometry data.
Parameters
- dataId: string
  Resource file name.
- requestId: string | number
  Specify a non-empty requestId to append the ?requestId= search parameter to the server request. If specified, server-side caching may not work.
- ranges: { begin: number; end: number; requestId: number }[]
  A ranges of resource file contents to download. See HTTP range requests for more details.
- OptionalonProgress: (progress: number, chunk: Uint8Array, requestId: number) => void
  Download progress callback.
- Optionalsignal: AbortSignal
  An AbortController signal. Allows to communicate with a fetch request and abort it if desired.
Returns Promise<ArrayBuffer>

getCdaTree

getCdaTree(): Promise<ICdaNode[]>
Returns the CDA tree for an assembly.

Returns Promise<ICdaNode[]>

getClashTest

getClashTest(testId: string): Promise<ClashTest>
Returns information about the specified assembly clash test.
Parameters
- testId: string
  Test ID.
Returns Promise<ClashTest>

getClashTests

getClashTests(
    start?: number,
    limit?: number,
    name?: string,
    ids?: string | string[],
    sortByDesc?: boolean,
    sortField?: string,
): Promise<
    {
        allSize: number;
        limit: number;
        result: ClashTest[];
        size: number;
        start: number;
    },
>
Returns a list of assembly clash tests.
Parameters
- Optionalstart: number
  The starting index in the test list. Used for paging.
- Optionallimit: number
  The maximum number of tests that should be returned per request. Used for paging.
- Optionalname: string
  Filter the tests by part of the name. Case sensitive.
- Optionalids: string | string[]
  List of tests IDs to return.
- OptionalsortByDesc: boolean
  Allows to specify the descending order of the result. By default tests are sorted by name in ascending order.
- OptionalsortField: string
  Allows to specify sort field.
Returns Promise<
    {
        allSize: number;
        limit: number;
        result: ClashTest[];
        size: number;
        start: number;
    },
>

getModels

getModels(): Promise<Model[]>
Returns list of assembly models.

Returns Promise<Model[]>

getModelTransformMatrix

getModelTransformMatrix(handle: string): IModelTransformMatrix
Returns a model transformation.
Parameters
- handle: string
  Model original handle.
Returns IModelTransformMatrix

getProperties

getProperties(handles?: string | string[], group?: boolean): Promise<any[]>
Returns the properties for an objects in the assembly.
Parameters
- Optionalhandles: string | string[]
  Object original handle or handles array. Specify undefined to get properties for all objects in the assembly.
- group: boolean = false
  If the group parameter is true, properties are returned grouped by category. By default, or if group is set to false, properties are returned ungrouped.
  
  To get grouped properties, the --properties_group command line argument must be specified for the properties File Converter job when creating the assembly.
  
  await client.createAssembly([file1.id, file2.id], "AssemblyName", { jobParameters: { properties: "--properties_group" }, waitForDone: true, });
  
  Otherwise, the properties will be returned ungrouped, even if the group is true.
Returns Promise<any[]>

getReferences

getReferences(signal?: AbortSignal): Promise<IFileReferences>
Returns a list of assembly references containing references from all the files from which the assembly was created.

References are images, fonts, or any other files to correct rendering of the assembly.
Parameters
- Optionalsignal: AbortSignal
  An AbortController signal, which can be used to abort waiting as desired.
Returns Promise<IFileReferences>

getSnapshot

getSnapshot(guid: string): Promise<string>
Returns the viewpoint snapshot as base64-encoded Data URL.
Parameters
- guid: string
  Viewpoint GUID.
Returns Promise<string>

getSnapshotData

getSnapshotData(guid: string, bitmapGuid: string): Promise<string>
Returns the viewpoint snapshot data.
Parameters
- guid: string
  Viewpoint GUID.
- bitmapGuid: string
  Bitmap GUID.
Returns Promise<string>

getViewpoints

getViewpoints(): Promise<any[]>
Returns a list of assembly viewpoints. For more information, see Open Cloud Assembly Viewpoints API.

Returns Promise<any[]>

partialDownloadResource

partialDownloadResource(
    dataId: string,
    onProgress?: (progress: number, chunk: Uint8Array) => void,
    signal?: AbortSignal,
): Promise<ArrayBuffer>
Deprecated since 25.3. Use downloadResource() instead.
Parameters
- dataId: string
- OptionalonProgress: (progress: number, chunk: Uint8Array) => void
- Optionalsignal: AbortSignal
Returns Promise<ArrayBuffer>
Deprecated

save

save(): Promise<Assembly>
Saves assembly properties changes to the server. Call this method to update assembly data on the server after any property changes.

Returns Promise<Assembly>

saveViewpoint

saveViewpoint(viewpoint: any): Promise<any>
Saves a new assembly viewpoint to the server. To create a viewpoint use Viewer.createViewpoint().
Parameters
- viewpoint: any
  Viewpoint object. For more information, see Open Cloud Assembly Viewpoints API.
Returns Promise<any>

searchProperties

searchProperties(searchPattern: any): Promise<any[]>
Returns the list of original handles for an objects in the file that match the specified patterns. Search patterns may be combined using query operators.
Parameters
- searchPattern: any
  Search pattern or combination of the patterns, see example below.
Returns Promise<any[]>
Example: Simple search pattern.
```
searchPattern = {
  key: "Category",
  value: "OST_Stairs",
};
```
Example: Search patterns combination.
```
searchPattern = {
  $or: [
    {
      $and: [
        { key: "Category", value: "OST_GenericModel" },
        { key: "Level", value: "03 - Floor" },
      ],
    },
    { key: "Category", value: "OST_Stairs" },
  ],
};
```

setModelTransformMatrix

setModelTransformMatrix(
handle: string,
transform?: IModelTransformMatrix,
): Promise<Assembly>
Sets or removes a model transformation.
Parameters
- handle: string
  Model original handle.
- Optionaltransform: IModelTransformMatrix
  Transformation matrix. Specify undefined to remove transformation.
Returns Promise<Assembly>

update

update(data: any): Promise<Assembly>
Updates assembly data on the server.
Parameters
- data: any
  Raw assembly data. For more information, see Open Cloud Assemblies API.
Returns Promise<Assembly>

waitForDone

waitForDone(
    params?: {
        interval?: number;
        onCheckout?: (assembly: Assembly, ready: boolean) => boolean;
        signal?: AbortSignal;
        timeout?: number;
    },
): Promise<Assembly>
Waits for assembly to be created. Assembly is created when it changes to done or failed status.
Parameters
- Optionalparams: {
      interval?: number;
      onCheckout?: (assembly: Assembly, ready: boolean) => boolean;
      signal?: AbortSignal;
      timeout?: number;
  }
  An object containing waiting parameters.
  - Optionalinterval?: number
    The time, in milliseconds, the function should delay in between checking assembly status.
  - OptionalonCheckout?: (assembly: Assembly, ready: boolean) => boolean
    Waiting progress callback. Return true to cancel waiting.
  - Optionalsignal?: AbortSignal
    An AbortController signal, which can be used to abort waiting as desired.
  - Optionaltimeout?: number
    The time, in milliseconds that the function should wait assembly. If assembly is not created during this time, the TimeoutError exception will be thrown.
Returns Promise<Assembly>

Class Assembly

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Assembly

Properties

headers

path

Accessors

associatedFiles

Returns IAssociatedFileData[]

created

Returns string

data

Returns any

files

Returns string[]

geometryType

Returns string

id

Returns string

name

Returns string

owner

Returns IShortUserDesc

relatedJobs

Returns string[]

status

Returns string

type

Returns string

Methods

checkout

Returns Promise<Assembly>

createClashTest

Parameters

Optionalclearance?: boolean

Optionalinterval?: number

Optionalsignal?: AbortSignal

Optionaltimeout?: number

Optionaltolerance?: string | number

OptionalwaitForDone?: boolean

Returns Promise<ClashTest>

delete

Returns Promise<any>

deleteClashTest

Parameters

Returns Promise<any>

deleteViewpoint

Parameters

Returns Promise<any>

downloadFileRange

Parameters

Returns Promise<void>

downloadResource

Parameters

Returns Promise<ArrayBuffer>

downloadResourceRange

Parameters

Returns Promise<ArrayBuffer>

getCdaTree

Returns Promise<ICdaNode[]>

getClashTest

Parameters

Returns Promise<ClashTest>

getClashTests

Parameters

Returns Promise< { allSize: number; limit: number; result: ClashTest[]; size: number; start: number; },>

getModels

Returns Promise<Model[]>

getModelTransformMatrix

Parameters

Returns IModelTransformMatrix

getProperties

`Optional`clearance?: boolean

`Optional`interval?: number

`Optional`signal?: AbortSignal

`Optional`timeout?: number

`Optional`tolerance?: string | number

`Optional`waitForDone?: boolean

Returns Promise<
{
allSize: number;
limit: number;
result: ClashTest[];
size: number;
start: number;
},
>

`Optional`interval?: number

`Optional`onCheckout?: (assembly: Assembly, ready: boolean) => boolean

`Optional`signal?: AbortSignal

`Optional`timeout?: number