Client.js

Global

Members

MarkupMode

Defines type of markup object. For old Visualize markup (MarkupType) only "Line" and "Text" markup objects are supported. For new Konva markup (MarkupType) available markup objects: Line, Text, Rectangle, Ellipse, Arrow, Image, Cloud.

MarkupType

Version of the markup support. Old = "Visualize", New = "Konva"

Type Definitions

AssembliesResult

Result for assembly list.

Type:
  • Object
Properties:
Name Type Description
allSize number

Total number of assemblies the user has access to.
start number

The starting index in the assembly list in the request.
limit number

The maximum number of requested assemblies.
result Array.<Assembly>

Result assembly list.
size number

The number of assemblies in the result list.

Event

Each event is represented by an object and may have additional custom fields to provide information about what happened.

Type:
  • Object
Properties:
Name Type Description
type string

Event type.
* any

Additional custom fields. See events description for more information.

EventListener(event)

Event listener function.

Parameters:
Name Type Description
event Event

Event object.

FetchError

The FetchError object indicates an error when request to Open Cloud Server could not be performed. A FetchError is typically (but not exclusively) thrown when a network error occurs, access denied, or object not found.

Type:
  • Class
Properties:
Name Type Description
message string

Error message. Inherited from Error.
status number

The HTTP status code of the response.
statusText string

The status message corresponding to the status code.

FileInformation

Information about the file (model) that can be reference in the project topics.

Type:
  • Object
Properties:
Name Type Description
display_information Array.<Object>

The list of fields to allow users to associate the file with a server model.

Properties
Name Type Description
field_display_name string

Field display name.
field_value string

Field value.
file Object

The file reference object.

Properties
Name Type Description
file_name string

File name.
reference string

File ID.

FileProgressCallback(progress, file)

File upload progress receiver.

Parameters:
Name Type Description
progress number

The ratio of work done from 0 to 1. To get a percentage (%), multiply the progress by 100.
file file

The file that is being uploaded.

FileReference

Reference to file.

Type:
  • Object
Properties:
Name Type Description
id number

The ID of the referenced file.
name string

The name of the referenced file.

FileReferences

References are images, fonts, or any other files to correct rendering of the file.

Type:
  • Object
Properties:
Name Type Description
id string

The references ID, changed after each update of the file references.
references Array.<FileReference> | null

List of file references or null if there are no references.

FilesResult

Result for file list.

Type:
  • Object
Properties:
Name Type Description
allSize number

Total number of files the user has access to.
start number

The starting index in the file list in the request.
limit number

The maximum number of requested files.
result Array.<File>

Result file list.
size number

The number of files in the result list.

JobsResult

Result for job list.

Type:
  • Object
Properties:
Name Type Description
allSize number

Total number of jobs created by the user.
start number

The starting index in the job list in the request.
limit number

The maximum number of requested jobs.
result Array.<Job>

Result job list.
size number

The number of jobs in the result list.

Options

VisualizeJS parameters.

Type:
  • Class
Properties:
Name Type Default Description
showWCS boolean true

Show WCS.
cameraAnimation boolean true

Enable camera animation.
antialiasing boolean true

Enable antialiasing use FXAA.
shadows boolean false

Enable shadows.
groundShadow boolean false

Enable ground shadows.
ambientOcclusion boolean false

Ambient occlusion.
enablePartialMode boolean false

Enable partial load mode to be able open large drawing. If enablePartialMode enabled, then sceneGraph will be switched off
memoryLimit number 3294967296

The size of the memory buffer that the Viewer can use for graphics data.
edgesColor Object

Outline edges color in RGB format.
facesColor Object

Faces color in the RGB format.
edgesVisibility= boolean

Show or hide edges.
edgesOverlap= boolean

Show edges over drawing.
facesOverlap= boolean

Show faces over drawing.
facesTransparancy= number

Faces transparency value from 0 to 255.
enableCustomHighlight= boolean

Enable custom highlight settings
sceneGraph boolean false

Enable or disable scene graph, it increases perfomance improvement, but consumes memory If sceneGraph enabled, then enablePartialMode will be switched off

Principial

Principials are any entity that can be authenticated by the server, such as a any user or project that will get access to the file.

Type:
  • Object
Properties:
Name Type Description
user Object

The user entry that get access to the file.

Properties
Name Type Description
id string

User ID.
name string

User name.
project Object

The project entry that get access to the file.

Properties
Name Type Description
id string

Project ID.
name string

Project name.

ProgressCallback(progress)

Work progress receiver.

Parameters:
Name Type Description
progress number

The ratio of work done from 0 to 1. To get a percentage (%), multiply the progress by 100.

ProjectsResult

Result for project list.

Type:
  • Object
Properties:
Name Type Description
allSize number

Total number of projects the user has access to.
start number

The starting index in the project list in the request.
limit number

The maximum number of requested projects.
result Array.<Project>

Result project list.
size number

The number of projects in the result list.

Properties

Object properties.

Type:
  • Object
Properties:
Name Type Description
handle string

Object original handle.
* string | Object

Object property. Can be Object for nested properties.

QueryOperator

Query operator. Operator name can be $and, $or, $not, $eq, $regex.

Type:
  • Object
Properties:
Name Type Description
* string | Array.<SearchPattern> | Array.<QueryOperator>

Array of the query values or patterns for operator.

SearchPattern

Search pattern.

Type:
  • Object
Properties:
Name Type Description
key string

Property name.
value string

Property value.

Transform

Transformation matrix.

Type:
  • Object
Properties:
Name Type Description
translate Object

Translation part, move along the X, Y, Z axes.

Properties
Name Type Description
x number

The value for substruct for X axes.
y number

The value for substruct for Y axes.
z number

The value for substruct for Z axes.
rotation Object

Rotation part, rotate by the specified angle, around the specified vector.

Properties
Name Type Description
x number

X coordinate of the rotation vector.
y number

Y coordinate of the rotation vector.
z number

Z coordinate of the rotation vector.
angle number

The angle of rotation.
scale number

Scaling part, scale with multiplier, from center of extends.

VersionResult

The Object represents server version information.

Type:
  • Object
Properties:
Name Type Description
version string

The server version.
hash string

Build hash.

Events

select

A Viewer event that fires when the user selects an entity with the mouse.

Properties:
Name Type Description
type string

select
data OdTvSelectionSet

The set of selected entities. For more information, see OdTvSelectionSet.

update

A Viewer event that fires when the viewer needs to be updated.

Properties:
Name Type Description
type string

update

uploadprogress

A Client event measuring progress of an file uploading process.

Properties:
Name Type Description
type string

uploadprogress
data number

The non-rounded progress value from 0 to 1. To get a percentage (%), multiply the data by 100.
file file

File object to upload.

visualizeprogress

A Viewer event measuring progress of loading a VisualizeJS library.

Properties:
Name Type Description
type string

visualizeprogress
loaded number

A 64-bit unsigned integer value indicating the amount of work already performed by the underlying process. The ratio of work done can be calculated by dividing total by the value of this property.
total number

A 64-bit unsigned integer representing the total amount of work that the underlying process is in the progress of performing.