cn_docs AdptDESITE

# activateStyleSchemaScheme(smartSetId) → {ApiResponse.<boolean>}

Activate style schema scheme.

Parameters:

Name	Type	Description
`smartSetId`	`string`	ID the SmartSet.

Since:

10.2025

Overrides:

IModelViewer#activateStyleSchemaScheme

View Source adapter/IModelViewer.js, line 1285

Returns:

True if successfully activated.

Type: ApiResponse.<boolean>

# activateViewpoint(objId) → {ApiResponse.<boolean>}

Activate a viewpoint.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID

Overrides:

IModelViewer#activateViewpoint

View Source adapter/IModelViewer.js, line 1002

Returns:

True if viewpoint was activated.

Type: ApiResponse.<boolean>

# async addObjectsToSmartSet(smartSetId, objIds, includeChildren) → {ApiResponse.<int>}

Add objects to SmartSet.

Parameters:

Name	Type	Description
`smartSetId`	`string`	SmartSet ID.
`objIds`	`Array.<string>`	Object IDs.
`includeChildren`	`boolean`	true: tree structure, false: flat list

Since:

10.2025

Overrides:

IModelViewer#addObjectsToSmartSet

View Source adapter/IModelViewer.js, line 1219

Returns:

Number of added objects

Type: ApiResponse.<int>

# addSelectionEventListener(listener) → {Promise.<null>}

add selection listener, no extra call back function

Parameters:

Name	Type	Description
`listener`	`*`

Since:

08.12.2025, ar

Overrides:

IModelViewer#addSelectionEventListener

View Source adapter/IModelViewer.js, line 252

Returns:

Type: Promise.<null>

# addStyleSchemaToSmartSet(smartSetId, options) → {ApiResponse.<string>}

Add style to SmartSet.

Parameters:

Name	Type	Description
`smartSetId`	`string`	ID the SmartSet.
`options`	`object`

Since:

10.2025

Overrides:

IModelViewer#addStyleSchemaToSmartSet

View Source adapter/IModelViewer.js, line 1263

Returns:

ID of newly created style.

Type: ApiResponse.<string>

# addViewpointToSmartSet(smartSetId, options) → {ApiResponse.<status>}

Add viewpoint to SmartSet.

Parameters:

Name	Type	Description
`smartSetId`	`string`	ID the SmartSet.
`options`	`object`

Since:

10.2025

Overrides:

IModelViewer#addViewpointToSmartSet

View Source adapter/IModelViewer.js, line 1297

Returns:

Type: ApiResponse.<status>

# addVisibilityEventListener(listener) → {Promise.<null>}

add visibility listener, no extra call back function

Parameters:

Name	Type	Description
`listener`	`*`

Since:

08.12.2025, ar

Overrides:

IModelViewer#addVisibilityEventListener

View Source adapter/IModelViewer.js, line 262

Returns:

Type: Promise.<null>

# applyStyleToObjects(styleId, objIds) → {ApiResponse.<boolean>}

Apply style to objects.

Parameters:

Name	Type	Description
`styleId`	`string`	Style ID.
`objIds`	`Array.<string>`	Object IDs.

Overrides:

IModelViewer#applyStyleToObjects

View Source adapter/IModelViewer.js, line 1117

Returns:

True if objects style has been changed

Type: ApiResponse.<boolean>

# async calcOptOBB(objIds) → {ApiResponse.<object>}

Calculate optimized oriented bounding boxes (OBBs) for given object IDs.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`

Overrides:

IModelViewer#calcOptOBB

View Source adapter/IModelViewer.js, line 1389

Returns:

Number of affected objects

Type: ApiResponse.<object>

# checkOverlapObjectList(idList, overlapAllowed, statusCallback) → {ApiResponse.<Array.<object>>}

Check overlap of oriented bounding boxes (OBBs) for given IDs every object against every other object. Objects having no geometry are ignored.

Parameters:

Name	Type	Default	Description
`idList`	`Array.<string>`
`overlapAllowed`	`number`	0.1	Minimum overlap to report (0.0 - 1.0), default: 0.1
`statusCallback`	`function` \| `null`	null	Optional callback function to report progress status.

Overrides:

IModelViewer#checkOverlapObjectList

View Source adapter/IModelViewer.js, line 1379

Returns:

data: Array of overlapping OBB pairs. [ { id1: id1, id2: id2, maxOverlap: 0.9 }, ... ]

Type: ApiResponse.<Array.<object>>

# async checkOverlapObjects(id1, id2) → {ApiResponse.<number>}

Calculate overlap of oriented bounding boxes (OBBs) for two given object IDs.

Parameters:

Name	Type	Description
`id1`	`string`
`id2`	`string`

Overrides:

IModelViewer#checkOverlapObjects

View Source adapter/IModelViewer.js, line 1400

Returns:

max overlap. example: 0.9 for 90% overlap

Type: ApiResponse.<number>

# connectModelViewer(on_sc, on_vc, cb) → {Object}

Connect signals selection changed and visibility changed to given functions.

Parameters:

Name	Type	Description
`on_sc`	`function`	Function to be called on selection changed, null to disconnect
`on_vc`	`function`	Function to be called on visibility changed, null to disconnect
`cb`	`*`

Overrides:

IModelViewer#connectModelViewer

View Source adapter/IModelViewer.js, line 235

Returns:

{
     'status' : ...
}

Type: Object

# createModel(name, domain, settings) → {ApiResponse.<string>}

Create model. Synchronizes with Infohub.

Parameters:

Name	Type	Description
`name`	`string`	Model name.
`domain`	`string`	Domain (e.g. 'geo')
`settings`	`object`	Model settings.

Overrides:

IModelViewer#createModel

View Source adapter/IModelViewer.js, line 371

Returns:

ID of newly created model.

Type: ApiResponse.<string>

# createObject(parentId, data) → {ApiResponse.<string>}

Create a new object. Synchronizes data with Infohub.

Parameters:

Name	Type	Description
`parentId`	`string`	ID of parent object
`data`	`object`	Data for the new object in JSON notation

Overrides:

IModelViewer#createObject

View Source adapter/IModelViewer.js, line 486

Returns:

ID of newly created object.

Type: ApiResponse.<string>

Example

{
                    info: {
                        object_type : "geo_container",
                        object_name : "MyObject"
                    },
                    properties: {
                        ...
                    },
                    geometry: {
                        ...
                    }
                }

# createPropertyType(propData, updateExisting) → {ApiResponse.<boolean>}

Create or update property type. Synchronizes with Infohub.

Parameters:

Name	Type	Description
`propData`	`object`	Property type definition.
`updateExisting`	`boolean`	Whether to update existing type.

Overrides:

IModelViewer#createPropertyType

View Source adapter/IModelViewer.js, line 925

Returns:

Type: ApiResponse.<boolean>

Example

* // Example propData objects:
                propData1 = {
                    name: "MyLength",
                    datatype: "xs:double",
                    unit: "m"
                }
                propData2 = {
                    name: "TrafficLight",
                    datatype: "xs:string",
                    values: ["red", "yellow", "green"]
                    readOnly: true
                }

# async createSmartSet(parentId, name, objectIds, options) → {ApiResponse.<string>}

Create new SmartSet.

Parameters:

Name	Type	Default	Description
`parentId`	`string`		Id of parent or domain name (eDomain) for topmost
`name`	`string`		Name of the SmartSet.
`objectIds`	`Array.<string>`		List of object IDs (root nodes, children will be automatically collected). If all objects should be taken into account, use getObjectsRootId(domain) to get ID of root node of domain and add root node of domain as SmartSet Object only. To add specific objects to a SmartSet (Set by enumeration) use objects which are leafs in the object hierarchy as SmartSet Objects.
`options`	`object` \| `null`	null	Additional options for SmartSet creation. `{ "filter": { "skip_openings": true, "skip_assembly_parts": false, "visible_only": false }, "group_by": { "propertytypes": [ "ifcEntity##xs:string", "cnVolume##xs:double" ], "options": { "decimal_precision": 4, "case_sensitive": true, "skip_null_values": true, "interval_size": 5.0, "interval_offset": 0.0, "date_grouping": "week" } } }`

Since:

10.2025

Overrides:

IModelViewer#createSmartSet

View Source adapter/IModelViewer.js, line 1194

Returns:

ID of newly created SmartSet.

Type: ApiResponse.<string>

# createSmartSetsFromSchema(schema) → {ApiResponse.<Array.<string>>}

Create SmartSets from schema.

Parameters:

Name	Type	Description
`schema`	`object`	Schema definition.

Overrides:

IModelViewer#createSmartSetsFromSchema

View Source adapter/IModelViewer.js, line 1241

Returns:

Array of SmartSet IDs.

Type: ApiResponse.<Array.<string>>

# createStyle(styleData) → {ApiResponse.<string>}

Create a new style / material.

Parameters:

Name	Type	Description
`styleData`	`object`	Style definition.

Overrides:

IModelViewer#createStyle

View Source adapter/IModelViewer.js, line 1084

Returns:

ID of newly created style.

Type: ApiResponse.<string>

Example

* // Example styleData:
const styleData = {
id: "12345",        // optional
name: "MyStyle",    // not empty
color: "#rrggbbaa"  // valid color value in hexadecimal RGBA format
}

# createViewpoint(parentId, options) → {ApiResponse.<string>}

Create a new viewpoint.

Parameters:

Name	Type	Description
`parentId`	`string` \| `null`	ID of parent object
`options`	`object`

Overrides:

IModelViewer#createViewpoint

View Source adapter/IModelViewer.js, line 980

Returns:

ID of newly created viewpoint.

Type: ApiResponse.<string>

# deleteObjects(objIds) → {ApiResponse.<number>}

Delete objects by ID. Synchronizes data with Infohub.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`	IDs of objects to delete.

Overrides:

IModelViewer#deleteObjects

View Source adapter/IModelViewer.js, line 496

Returns:

Number of objects deleted.

Type: ApiResponse.<number>

# deletePropertyType(ptKeyStr) → {ApiResponse.<boolean>}

Delete exsisting property type. Synchronizes with Infohub.

Parameters:

Name	Type	Description
`ptKeyStr`	`string`	Access key of property type in the format name##datatype.

Overrides:

IModelViewer#deletePropertyType

View Source adapter/IModelViewer.js, line 938

Returns:

Type: ApiResponse.<boolean>

# async deleteSmartSet(smartSetId) → {ApiResponse.<boolean>}

Delete a SmartSet.

Parameters:

Name	Type	Description
`smartSetId`	`string`	Id of SmartSet.

Since:

10.2025

Overrides:

IModelViewer#deleteSmartSet

View Source adapter/IModelViewer.js, line 1206

Returns:

True if deleted.

Type: ApiResponse.<boolean>

# deleteStyles(styleIds) → {ApiResponse.<boolean>}

Delete styles / materials.

Parameters:

Name	Type	Description
`styleIds`	`Array.<string>`	IDs of styles to delete.

Since:

10.2025

Overrides:

IModelViewer#deleteStyles

View Source adapter/IModelViewer.js, line 1106

Returns:

True if styles deleted.

Type: ApiResponse.<boolean>

# deleteViewpoint(objId) → {ApiResponse.<boolean>}

Delete a viewpoint.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID

Overrides:

IModelViewer#deleteViewpoint

View Source adapter/IModelViewer.js, line 1033

Returns:

True if viewpoint was deleted.

Type: ApiResponse.<boolean>

# dump()

Dump info to console

Overrides:

IModelViewer#dump

View Source adapter/IModelViewer.js, line 212

# filterObjectsByProperties(objIds, filterExpression) → {ApiResponse.<Array.<string>>}

Filter objects by property values.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`	Object IDs of objects to filter.
`filterExpression`	`Array.<any>`	Filter criteria.

Overrides:

IModelViewer#filterObjectsByProperties

View Source adapter/IModelViewer.js, line 520

Returns:

Filtered object IDs.

Type: ApiResponse.<Array.<string>>

Examples

[ "$ifcEntity##xs:string" , "==" , "IfcWall" ]

[ "$ifcEntity##xs:string" , "in" , ["IfcWall", "IfcWallStandardCase"]] , "and" , "$cnVolume##xs:double", ">=" , 2.5 ]]

[ "$ifcEntity##xs:string" , "match" , "/^IfcWall/g"]]

# filterObjectsByStatus(objIds, statusCode, statusFlag) → {ApiResponse.<Array.<string>>}

Filter objects by status.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`	Object IDs of objects to filter.
`statusCode`	`string`	one of [ 'selected', 'visible', 'wired', 'locked'].
`statusFlag`	`boolean`	true: status, false: inverted status.

Overrides:

IModelViewer#filterObjectsByStatus

View Source adapter/IModelViewer.js, line 532

Returns:

Filtered object IDs.

Type: ApiResponse.<Array.<string>>

# async getChildIds(objIdList, depth)

Collect object Ids contained in objects of objIdList, serach to depth of 'depth' or the complete hiererchy if depth is 0 (default)

Parameters:

Name	Type	Default	Description
`objIdList`	`*`		Collect child ids from these root objects
`depth`	`*`	0	[optional] Recursion depth, default = 0 (maximum depth)

Overrides:

IModelViewer#getChildIds

View Source adapter/IModelViewer.js, line 463

# async getConfig() → {Promise.<ApiResponse>}

Overrides:

IModelViewer#getConfig

View Source adapter/IModelViewer.js, line 1432

Returns:

Type: Promise.<ApiResponse>

# getDrawEdges() → {ApiResponse.<boolean>}

DEPRECATED !

Since:

28.11.2025, ar

Overrides:

IModelViewer#getDrawEdges

View Source adapter/IModelViewer.js, line 1455

Returns:

Type: ApiResponse.<boolean>

# getInfo() → {object}

Get name and version of the current ModelViewer.

Since:

10.2025

Overrides:

IModelViewer#getInfo

View Source adapter/IModelViewer.js, line 171

Returns:

JSON object containing name and version.

Type: object

Example

{
     "name"      : "...",
     "type"      : "...",
     "version"   : ".."
 }

# getInfohubSettings() → {object}

Overrides:

IModelViewer#getInfohubSettings

View Source adapter/IModelViewer.js, line 203

Returns:

settings object

Type: object

Example

{
      'scope_id'        : ' ... ',
      'project_shortid' : ' ... ',
      'connected_by'    : ' ... '
  }

# getModelIds(domains) → {ApiResponse.<Array.<string>>}

Get model IDs for given domains.

Parameters:

Name	Type	Description
`domains`	`Array.<eDomain>`	Domain (e.g. 'all') or combination as array, e.g. ['geo', 'act'].

Since:

10.2025

Overrides:

IModelViewer#getModelIds

View Source adapter/IModelViewer.js, line 348

Returns:

Array of model IDs.

Type: ApiResponse.<Array.<string>>

# getModelMetadata(modelId) → {ApiResponse.<object>}

Get metadata for given model.

Parameters:

Name	Type	Description
`modelId`	`string`	Model ID.

Since:

10.2025

Overrides:

IModelViewer#getModelMetadata

View Source adapter/IModelViewer.js, line 359

Returns:

Type: ApiResponse.<object>

# getObject(objId) → {ApiResponse.<cnObject>}

Get object by ID. Synchronizes data with Infohub.

Parameters:

Name	Type	Description
`objId`	`string`	ID of object.

Overrides:

IModelViewer#getObject

View Source adapter/IModelViewer.js, line 414

Returns:

returns object in GOM format

Type: ApiResponse.<cnObject>

# getObjectIds(domain) → {ApiResponse.<Array.<string>>}

Get all object IDs for given domains as list.

Parameters:

Name	Type	Description
`domain`	`Array.<eDomain>`	Domain (e.g. 'all') or combination as array, e.g. ['geo', 'act'].

Overrides:

IModelViewer#getObjectIds

View Source adapter/IModelViewer.js, line 506

Returns:

Array of object IDs.

Type: ApiResponse.<Array.<string>>

# getObjects(objIdList, opt)

Get objects in GOM format

Parameters:

Name	Type	Description
`objIdList`	`Array.<string>`	Object Ids
`opt`	`*`	`{ "properties" : { ... options ... } // if empty, return all "geometry" : { ... options ... }, "relations" : {}, "nodes" : {} }`

Overrides:

IModelViewer#getObjects

View Source adapter/IModelViewer.js, line 451

Example

getObjects(
      ["obj1", "obj2"], 
      {
          properties: { 
              "propertytypes": [          // whitelist by default
                  "cnName##xs:string",
                  "MyNumber##xs:double"
              ]
          },
          geometry: {},
          relations: {},
          nodes: {}
      }
  );

# getObjectsRootId(domain) → {ApiResponse.<string>}

Get root object ID for given domain.

Parameters:

Name	Type	Description
`domain`	`*`	Domain (e.g. 'geo')

Overrides:

IModelViewer#getObjectsRootId

View Source adapter/IModelViewer.js, line 404

Returns:

Root object ID

Type: ApiResponse.<string>

# getParentId(objId) → {ApiResponse.<string>}

Get parent ID of object.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID.

Since:

10.2025

Overrides:

IModelViewer#getParentId

View Source adapter/IModelViewer.js, line 688

Returns:

ID of closest parent

Type: ApiResponse.<string>

# getPickedPoint()

return { 'intern' : [ ix , iy , iz ], 'global' : [ x , y , z ] }

Overrides:

IModelViewer#getPickedPoint

View Source adapter/IModelViewer.js, line 1334

# getProjectDirectory() → {ApiResponse.<string>}

Get project directory

Overrides:

IModelViewer#getProjectDirectory

View Source adapter/IModelViewer.js, line 325

Returns:

file path

Type: ApiResponse.<string>

# getProjectId()

Get project id

Since:

12.2025

Overrides:

IModelViewer#getProjectId

View Source adapter/IModelViewer.js, line 316

# getProjectInfo() → {ApiResponse.<object>}

Get project metadata

Since:

10.2025

Overrides:

IModelViewer#getProjectInfo

View Source adapter/IModelViewer.js, line 307

Returns:

//RM

Type: ApiResponse.<object>

# getProperties(objId, inclPropsFromTypes, filter) → {ApiResponse.<object>}

Get all properties of object.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID.
`inclPropsFromTypes`	`boolean`	Include props from types.
`filter`	`object`	Filter criteria.

Overrides:

IModelViewer#getProperties

View Source adapter/IModelViewer.js, line 784

Returns:

Type: ApiResponse.<object>

Examples

* // Example filter object:
const filter = {
 name:       "MyPset:MyNumber*",
 datatype :  ["xs:double", "xs:float"]
};

data: {
                    "MyPset:MyNumber##xs:double": "11",
                    "MyPset:MyNumberNew##xs:float": 42,
                }

# getPropertyTypeInfo(ptKeyStr) → {ApiResponse.<(object|null)>}

Get property type metadata.

Parameters:

Name	Type	Description
`ptKeyStr`	`string`	Access key of property type in the format name##datatype.

Overrides:

IModelViewer#getPropertyTypeInfo

View Source adapter/IModelViewer.js, line 801

Returns:

Type: ApiResponse.<(object|null)>

Example

data: {
                    name: "cnName",
                    displayName: "cn:Name",
                    datatype: "xs:string",
                    readonly: false,
                    ...
                }

# getPropertyTypeValues(ptKeyStr, options) → {ApiResponse.<Array.<string>>}

Get unique property values for type.

Parameters:

Name	Type	Description
`ptKeyStr`	`string`	Access key of property type in the format name##datatype.
`options`	`object`	Options for filtering.

Since:

10.2025

Overrides:

IModelViewer#getPropertyTypeValues

View Source adapter/IModelViewer.js, line 763

Returns:

returns list of unique property values

Type: ApiResponse.<Array.<string>>

Example

* // Example options object:
const options = {
  objects: ['obj_1', 'obj_2'],
  precision: 0.0001,
  case_sensitive: true,
  interval_size: 2.0,
  interval_offset: 1.0,
  date_grouping: 'week',
  max_values: 0
};

# getPropertyTypes(filter) → {ApiResponse.<Array.<string>>}

Get a list of all available property types matching filter.

Parameters:

Name	Type	Description
`filter`	`object`	Filter criteria.

Overrides:

IModelViewer#getPropertyTypes

View Source adapter/IModelViewer.js, line 844

Returns:

Type: ApiResponse.<Array.<string>>

Example

* // Example filter object:
const filter = {
 name:       "MyPset:MyNumber*",
 datatype :  ["xs:double", "xs:float"]
 readOnly: true
};

# getPropertyTypesByObject(objId, filter) → {ApiResponse.<Array.<object>>}

Get property types used by object.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID.
`filter`	`object`	Filter criteria.

Overrides:

IModelViewer#getPropertyTypesByObject

View Source adapter/IModelViewer.js, line 828

Returns:

Type: ApiResponse.<Array.<object>>

Examples

* // Example filter object:
const filter = {
 name:       "MyPset:MyNumber*",
 datatype :  ["xs:double", "xs:float"]
 readOnly: true
};

data: [
                    {
                        name: "MyPset:MyNumber",
                        displayName: "MyPset:MyNumber",
                        datatype: "xs:double",
                        readonly: true,
                        ...
                    }
                ]

# getPropertyValue(objId, ptKeyStr) → {ApiResponse.<any>}

Get property value for object.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID.
`ptKeyStr`	`string`	Access key of property type in the format name##datatype.

Overrides:

IModelViewer#getPropertyValue

View Source adapter/IModelViewer.js, line 723

Returns:

-alue of property, depending on the datatype

Type: ApiResponse.<any>

# getPropertyValues(objIds, ptKeyStr) → {ApiResponse.<Array.<object>>}

Get property values for multiple objects.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`	Object IDs.
`ptKeyStr`	`string`	Access key of property type in the format name##datatype.

Overrides:

IModelViewer#getPropertyValues

View Source adapter/IModelViewer.js, line 741

Returns:

Map with object IDs as keys.

Type: ApiResponse.<Array.<object>>

Example

data: {
                    "id1" : {
                        "value": 1.234,
                        "comment": ""
                    },
                    ...
                }

# getRootNodeId(domain) → {ApiResponse.<string>}

Get root node of object trees for a given domain.

Parameters:

Name	Type	Description
`domain`	`string`	Domain (e.g. 'geo')

Since:

10.2025

Overrides:

IModelViewer#getRootNodeId

View Source adapter/IModelViewer.js, line 699

Returns:

returns ID of root node of object trees for a given domain

Type: ApiResponse.<string>

# getRootNodeIdOfSets(domain) → {ApiResponse.<string>}

Get root nodes of smartsets for given domain.

Parameters:

Name	Type	Description
`domain`	`string`	Domain (e.g. 'geo')

Since:

10.2025

Overrides:

IModelViewer#getRootNodeIdOfSets

View Source adapter/IModelViewer.js, line 710

Returns:

Type: ApiResponse.<string>

# getSelectedObjectIds(domains) → {ApiResponse.<Array.<string>>}

Get IDs of currently selected objects.

Parameters:

Name	Type	Description
`domains`	`Array.<eDomain>`	Domain (e.g. 'all') or combination as array, e.g. ['geo', 'act'].

Since:

10.2025

Overrides:

IModelViewer#getSelectedObjectIds

View Source adapter/IModelViewer.js, line 613

Returns:

returns IDs of currently selected objects

Type: ApiResponse.<Array.<string>>

# getStyleData(styleId, key) → {ApiResponse.<(object|string)>}

Get information about specific style / material attributes.

Parameters:

Name	Type	Description
`styleId`	`string`	Style ID.
`key`	`string`	If specified, only the corresponding attribute is returned, otherwise the entire object.

Since:

10.2025

Overrides:

IModelViewer#getStyleData

View Source adapter/IModelViewer.js, line 1068

Returns:

Style attribute info.

Type: ApiResponse.<(object|string)>

# getStyleIds() → {ApiResponse.<Array.<string>>}

Get list of Ids of all available styles.

Since:

10.2025

Overrides:

IModelViewer#getStyleIds

View Source adapter/IModelViewer.js, line 1045

Returns:

Array of style object Ids.

Type: ApiResponse.<Array.<string>>

# getStyles(objIDs) → {ApiResponse.<Array.<object>>}

Get styles / materials / colors applied to given objects.

Parameters:

Name	Type	Description
`objIDs`	`Array.<string>`	Object IDs.

Since:

10.2025

Overrides:

IModelViewer#getStyles

View Source adapter/IModelViewer.js, line 1056

Returns:

Array of applied style / material objects.

Type: ApiResponse.<Array.<object>>

# getViewpointData(objId) → {ApiResponse.<object>}

Get viewpoint data.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID

Overrides:

IModelViewer#getViewpointData

View Source adapter/IModelViewer.js, line 1012

Returns:

JSON object with viewpoint data.

Type: ApiResponse.<object>

# getViewpointIds() → {ApiResponse.<Array.<string>>}

Get list of all viewpoint ids.

Since:

10.2025

Overrides:

IModelViewer#getViewpointIds

View Source adapter/IModelViewer.js, line 969

Returns:

Type: ApiResponse.<Array.<string>>

# getVisibleObjectIds(domains) → {ApiResponse.<Array.<string>>}

Get IDs of currently visible objects in given domain/domains.

Parameters:

Name	Type	Description
`domains`	`Array.<eDomain>`	Domain (e.g. 'all') or combination as array, e.g. ['geo', 'act'].

Since:

10.2025

Overrides:

IModelViewer#getVisibleObjectIds

View Source adapter/IModelViewer.js, line 545

Returns:

returns IDs of currently visible objects in given domain/domains

Type: ApiResponse.<Array.<string>>

# importModel(modelId) → {ApiResponse.<boolean>}

Add model to coordination model. Synchronizes with Infohub.

Parameters:

Name	Type	Description
`modelId`	`string`	Model ID.

Overrides:

IModelViewer#importModel

View Source adapter/IModelViewer.js, line 382

Returns:

True if successfully added

Type: ApiResponse.<boolean>

# isSelected(objId) → {ApiResponse.<boolean>}

Check if object is selected.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID.

Overrides:

IModelViewer#isSelected

View Source adapter/IModelViewer.js, line 675

Returns:

True if object is selected.

Type: ApiResponse.<boolean>

# isVisible(objId) → {ApiResponse.<boolean>}

Check if object is visible.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID.

Overrides:

IModelViewer#isVisible

View Source adapter/IModelViewer.js, line 602

Returns:

True if object is visible.

Type: ApiResponse.<boolean>

# loginUser(cb, user) → {ApiResponse.<Object>}

Get 'user' and 'token' from ModelViewer.

Parameters:

Name	Type	Default	Description
`cb`	`function`		Callback function
`user`	`string`	null	Login this user (optional)

Overrides:

IModelViewer#loginUser

View Source adapter/IModelViewer.js, line 117

Returns:

response

Type: ApiResponse.<Object>

Example

{
     "status"    : 200,
     "data"      : {
         "user": "JohnDoe",
         "token": "abc123"
     }
 }

# logoutUser(cb) → {ApiResponse.<Object>}

Logout user. Clear user and token.

Parameters:

Name	Type	Description
`cb`	`function`	Callback function

Overrides:

IModelViewer#logoutUser

View Source adapter/IModelViewer.js, line 132

Returns:

response

Type: ApiResponse.<Object>

# onSelectionChanged()

Overrides:

IModelViewer#onSelectionChanged

View Source adapter/IModelViewer.js, line 289

# onVisibilityChanged()

Overrides:

IModelViewer#onVisibilityChanged

View Source adapter/IModelViewer.js, line 296

# openUrl(url, target)

Open URL/Link in Browser (target = null -> default browser )

Parameters:

Name	Type	Description
`url`	`*`
`target`	`*`

Overrides:

IModelViewer#openUrl

View Source adapter/IModelViewer.js, line 1320

# removeModel(modelId) → {ApiResponse.<boolean>}

remove model from project. Synchronizes with Infohub.

Parameters:

Name	Type	Description
`modelId`	`string`	Model ID.

Overrides:

IModelViewer#removeModel

View Source adapter/IModelViewer.js, line 392

Returns:

True if model was successfully removed.

Type: ApiResponse.<boolean>

# async removeObjectsFromSmartSet(smartSetId, objIds) → {ApiResponse.<boolean>}

Remove objects from SmartSet.

Parameters:

Name	Type	Description
`smartSetId`	`string`	SmartSet ID.
`objIds`	`Array.<string>`	Object IDs to remove.

Since:

10.2025

Overrides:

IModelViewer#removeObjectsFromSmartSet

View Source adapter/IModelViewer.js, line 1231

Returns:

True if objects effectivily removed

Type: ApiResponse.<boolean>

# removeSelectionEventListener(listener) → {Promise.<null>}

remove selection listener, no extra call back function

Parameters:

Name	Type	Description
`listener`	`*`

Since:

08.12.2025, ar

Overrides:

IModelViewer#removeSelectionEventListener

View Source adapter/IModelViewer.js, line 272

Returns:

Type: Promise.<null>

# removeStyleSchemaFromSmartSet(smartSetId) → {ApiResponse.<boolean>}

Remove style from SmartSet.

Parameters:

Name	Type	Description
`smartSetId`	`string`	ID the SmartSet.

Since:

10.2025

Overrides:

IModelViewer#removeStyleSchemaFromSmartSet

View Source adapter/IModelViewer.js, line 1274

Returns:

True if successfully removed.

Type: ApiResponse.<boolean>

# removeViewpointFromSmartSet(smartSetId) → {ApiResponse.<boolean>}

remove viewpoint to SmartSet.

Parameters:

Name	Type	Description
`smartSetId`	`string`	ID the SmartSet.

Since:

10.2025

Overrides:

IModelViewer#removeViewpointFromSmartSet

View Source adapter/IModelViewer.js, line 1308

Returns:

True if successfully removed.

Type: ApiResponse.<boolean>

# removeVisibilityEventListener(listener) → {Promise.<null>}

remove visibility listener, no extra call back function

Parameters:

Name	Type	Description
`listener`	`*`

Since:

08.12.2025, ar

Overrides:

IModelViewer#removeVisibilityEventListener

View Source adapter/IModelViewer.js, line 282

Returns:

Type: Promise.<null>

# async resetStyles() → {ApiResponse.<void>}

Reset styles (materials,colors) of all objects

Overrides:

IModelViewer#resetStyles

View Source adapter/IModelViewer.js, line 1143

Returns:

Type: ApiResponse.<void>

Example

Infohub.ModelViewer.resetStyles( [ Infohub.ModelViewer.eDomain.GEO ] )

# resetStylesOfObjects(objIds) → {ApiResponse.<boolean>}

Reset styles to default.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`	Object IDs.

Since:

10.2025

Overrides:

IModelViewer#resetStylesOfObjects

View Source adapter/IModelViewer.js, line 1128

Returns:

True if reset succeeded. styles reset to default

Type: ApiResponse.<boolean>

# async restoreProjectContext(ctx, cb) → {Promise.<ApiResponse>}

Restore project context (scope,project) from model viewer (from current project) and store it in infohub context ctx.

Parameters:

Name	Type	Description
`ctx`	`Context`
`cb`	`*`	Call back

Overrides:

IModelViewer#restoreProjectContext

View Source adapter/IModelViewer.js, line 145

Returns:

Returns object with status and ProjectContext data

Type: Promise.<ApiResponse>

# saveProject() → {ApiResponse.<boolean>}

Save current project, show SaveFileDialog if project was newly created and no file path is available.

Overrides:

IModelViewer#saveProject

View Source adapter/IModelViewer.js, line 334

Returns:

True if project was saved successfully.

Type: ApiResponse.<boolean>

# setAllSelected(flagOnOff, domains) → {ApiResponse.<void>}

Set all objects of specified domains as selected or deselected.

Example:

// assume a COLNEO pro adapter is instantiated (e.g. in index.js) ...
const { COLNEOproAdapterServices } = await import("./node_modules/@colneo/infohub-js-api/dist/adapter/AdapterColneoPro.js");
Infohub.ModelViewer = await COLNEOproAdapterServices.createAdapter()

// clear selection of objects in domain 'geometry'
Infohub.ModelViewer.setAllSelected( [ Infohub.ModelViewer.eDomain.GEO ], false )

Parameters:

Name	Type	Description
`flagOnOff`	`boolean`
`domains`	`Array.<string>`

Overrides:

IModelViewer#setAllSelected

View Source adapter/IModelViewer.js, line 665

Returns:

Type: ApiResponse.<void>

# setAllVisible(domains, flagOnOff) → {ApiResponse.<void>}

Set visibility of all objects of given domains.

Parameters:

Name	Type	Description
`domains`	`Array.<eDomain>`	Array of domains to be taken into account
`flagOnOff`	`boolean`	true = show, false = hide

Since:

01.12.2025, ar

Overrides:

IModelViewer#setAllVisible

View Source adapter/IModelViewer.js, line 582

Returns:

Type: ApiResponse.<void>

Example

// assume a COLNEO pro adapter is instantiated (e.g. in index.js) ...
     const { COLNEOproAdapterServices } = await import("./node_modules/@colneo/infohub-js-api/dist/adapter/AdapterColneoPro.js");
     Infohub.ModelViewer = await COLNEOproAdapterServices.createAdapter( Infohub.Context )
     
     // set visibility for objects in domain 'geometry'
     Infohub.ModelViewer.setAllVisible( [ Infohub.ModelViewer.eDomain.GEO ], true )

# async setConfig(cfg) → {Promise.<ApiResponse>}

Set viewer configuration.
Changes configuration partially!

Parameters:

Name	Type	Description
`cfg`	`*`	= { "edges" : bool, "grid" : { "show" : bool, "color" : #hex }, "background" : { "color" : #hex } }

Overrides:

IModelViewer#setConfig

View Source adapter/IModelViewer.js, line 1424

Returns:

Type: Promise.<ApiResponse>

# setDrawEdges(onOff) → {ApiResponse}

DEPRECATED !

Parameters:

Name	Type	Description
`onOff`	`boolean`

Since:

28.11.2025, ar

Overrides:

IModelViewer#setDrawEdges

View Source adapter/IModelViewer.js, line 1445

Returns:

Type: ApiResponse

# setInfohubSettings(settings) → {ApiResponse.<void>}

Parameters:

Name	Type	Description
`settings`	`object`	{ 'scope_id' : ' ... ', 'project_shortid' : ' ... ', 'connected_by' : ' ... ' }

Overrides:

IModelViewer#setInfohubSettings

View Source adapter/IModelViewer.js, line 189

Returns:

complies with COLNEOpro-API, 2025-10-14, ar

Type: ApiResponse.<void>

# setProperties(objIds, properties) → {ApiResponse.<boolean>}

Set multiple property values for each object in object list.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`	Array of Object IDs.
`properties`	`object`	Key/value pairs, key format name##datatype

Overrides:

IModelViewer#setProperties

View Source adapter/IModelViewer.js, line 878

Returns:

Type: ApiResponse.<boolean>

Example

// Example properties object:

                    const properties = {
                        "myType##xs:string"     : "ABC",
                        "myNumber##xs:double"   : 1.234,
                        "myBoolean##xs:boolean" : true
                    };

# setPropertiesByMap(propertyMap) → {ApiResponse.<boolean>}

Set properties in a batch by a property map object -> properties

Parameters:

Name Type Description

propertyMap

*

{

     "object id 1" : {
         "proptypeid1" : value1,
         "proptypeid2" : value2
     },
     "object id 2" : {
         "proptypeid1" : value1,
         "proptypeid2" : value2,

```
       "proptypeid3" : value3,
   },
```

}

Overrides:

IModelViewer#setPropertiesByMap

View Source adapter/IModelViewer.js, line 902

Returns:

Type: ApiResponse.<boolean>

# setPropertyValue(objId, ptKeyStr, value) → {ApiResponse.<boolean>}

Set single property value. Synchronizes with Infohub.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID.
`ptKeyStr`	`string`	property typeidö in the format name##datatype.
`value`	`string`	New value.

Overrides:

IModelViewer#setPropertyValue

View Source adapter/IModelViewer.js, line 856

Returns:

Type: ApiResponse.<boolean>

# setSelected(objIds, flagOnOff, exclusively) → {ApiResponse.<number>}

Set selection of objects.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`	Object IDs.
`flagOnOff`	`boolean`	Selection flag.
`exclusively`	`boolean`	If true, clear all other selections.

Since:

10.2025

Overrides:

IModelViewer#setSelected

View Source adapter/IModelViewer.js, line 629

Returns:

Number of objects whose selection changed.

Type: ApiResponse.<number>

# setViewpointData(objId, viewpointData) → {ApiResponse.<boolean>}

Set viewpoint data.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID
`viewpointData`	`object`	Viewpoint data to set.

Overrides:

IModelViewer#setViewpointData

View Source adapter/IModelViewer.js, line 1023

Returns:

True if viewpoint data was set.

Type: ApiResponse.<boolean>

# setVisible(objIds, flagOnOff, exclusively) → {ApiResponse.<number>}

Set visibility of objects.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`	Object IDs.
`flagOnOff`	`boolean`	true: visible, false: hidden
`exclusively`	`boolean`	If the 'exclusivly' flag is set to true, the domains affected are determined by the specified objects. The remaining objects in these domains are set to the inverse status.

Since:

10.2025

Overrides:

IModelViewer#setVisible

View Source adapter/IModelViewer.js, line 560

Returns:

Number of objects whose status changed.

Type: ApiResponse.<number>

# async showHomeViewpoint() → {ApiResponse.<void>}

Reset camera to home viewpoint.

If a home viewpoint does not exist, the camera and clipping planes are reset

Since:

01.2026

Overrides:

IModelViewer#showHomeViewpoint

View Source adapter/IModelViewer.js, line 957

Returns:

Type: ApiResponse.<void>

Example

Infohub.ModelViewer.showHomeViewpoint()

# toggleSelection(objIds) → {ApiResponse.<void>}

Toggle selection status of given objects.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`	Object IDs to toggle.

Overrides:

IModelViewer#toggleSelection

View Source adapter/IModelViewer.js, line 639

Returns:

Type: ApiResponse.<void>

# toggleVisibility(objIds) → {ApiResponse.<void>}

Toggle visibility of given objects.

Parameters:

Name	Type	Description
`objIds`	`Array.<string>`	Object IDs to toggle.

Overrides:

IModelViewer#toggleVisibility

View Source adapter/IModelViewer.js, line 592

Returns:

Type: ApiResponse.<void>

# async transformObject(id, T) → {ApiResponse}

Rotate and Translate object.

Rotation is executed first around point 'rotatePoint' with rotation matrix 'rotateMat6rix', then object is translated.

if includeContained is true ont only the geometry of the object itself is transformed but also the included objects ('id' could be a model, a container or an assembly)

Parameters:

Name	Type	Description
`id`	`*`
`T`	`*`	= { 'move' : [], 'rotate' : { 'pivot' : [ x , y , z ], 'alpha' : val_deg } }

Overrides:

IModelViewer#transformObject

View Source adapter/IModelViewer.js, line 1360

Returns:

Type: ApiResponse

# updateSmartSet(smartSetId) → {ApiResponse.<boolean>}

Update SmartSet. Synchronizes with Infohub.

Parameters:

Name	Type	Description
`smartSetId`	`string`	SmartSet ID.

Overrides:

IModelViewer#updateSmartSet

View Source adapter/IModelViewer.js, line 1251

Returns:

True if SmartSet was updated.

Type: ApiResponse.<boolean>

# updateStyle(styleId, styleData) → {ApiResponse.<boolean>}

Update style / material.

Parameters:

Name	Type	Description
`styleId`	`string`	Style ID.
`styleData`	`object`	Updated style data.

Overrides:

IModelViewer#updateStyle

View Source adapter/IModelViewer.js, line 1095

Returns:

True if style was updated.

Type: ApiResponse.<boolean>

# updateViewpoint(objId, data) → {ApiResponse.<boolean>}

Update existing viewpoint.

Parameters:

Name	Type	Description
`objId`	`string`	Object ID
`data`	`object`	Data for the viewpoint in JSON notation

Since:

10.2025

Overrides:

IModelViewer#updateViewpoint

View Source adapter/IModelViewer.js, line 992

Returns:

True if update was successful.

Type: ApiResponse.<boolean>

# new AdptDESITE_32()

Extends

Classes

Methods

# activateStyleSchemaScheme(smartSetId) → {ApiResponse.<boolean>}

Parameters:

# activateViewpoint(objId) → {ApiResponse.<boolean>}

Parameters:

# async addObjectsToSmartSet(smartSetId, objIds, includeChildren) → {ApiResponse.<int>}

Parameters:

# addSelectionEventListener(listener) → {Promise.<null>}

Parameters:

# addStyleSchemaToSmartSet(smartSetId, options) → {ApiResponse.<string>}

Parameters:

# addViewpointToSmartSet(smartSetId, options) → {ApiResponse.<status>}

Parameters:

# addVisibilityEventListener(listener) → {Promise.<null>}

Parameters:

# applyStyleToObjects(styleId, objIds) → {ApiResponse.<boolean>}

Parameters:

# async calcOptOBB(objIds) → {ApiResponse.<object>}

Parameters:

# checkOverlapObjectList(idList, overlapAllowed, statusCallback) → {ApiResponse.<Array.<object>>}

Parameters:

# async checkOverlapObjects(id1, id2) → {ApiResponse.<number>}

Parameters:

# connectModelViewer(on_sc, on_vc, cb) → {Object}

Parameters:

# createModel(name, domain, settings) → {ApiResponse.<string>}

Parameters:

# createObject(parentId, data) → {ApiResponse.<string>}

Parameters:

Example

# createPropertyType(propData, updateExisting) → {ApiResponse.<boolean>}

Parameters:

Example

# async createSmartSet(parentId, name, objectIds, options) → {ApiResponse.<string>}

Parameters:

# createSmartSetsFromSchema(schema) → {ApiResponse.<Array.<string>>}

Parameters:

# createStyle(styleData) → {ApiResponse.<string>}

Parameters:

Example

# createViewpoint(parentId, options) → {ApiResponse.<string>}

Parameters:

# deleteObjects(objIds) → {ApiResponse.<number>}

Parameters:

# deletePropertyType(ptKeyStr) → {ApiResponse.<boolean>}

Parameters:

# async deleteSmartSet(smartSetId) → {ApiResponse.<boolean>}

Parameters:

# deleteStyles(styleIds) → {ApiResponse.<boolean>}

Parameters:

# deleteViewpoint(objId) → {ApiResponse.<boolean>}

Parameters:

# dump()

# filterObjectsByProperties(objIds, filterExpression) → {ApiResponse.<Array.<string>>}

Parameters:

Examples

# filterObjectsByStatus(objIds, statusCode, statusFlag) → {ApiResponse.<Array.<string>>}

Parameters:

# async getChildIds(objIdList, depth)

Parameters:

# async getConfig() → {Promise.<ApiResponse>}

# getDrawEdges() → {ApiResponse.<boolean>}

# getInfo() → {object}

Example

# getInfohubSettings() → {object}

Example

# getModelIds(domains) → {ApiResponse.<Array.<string>>}

Parameters:

# getModelMetadata(modelId) → {ApiResponse.<object>}

Parameters:

# getObject(objId) → {ApiResponse.<cnObject>}

Parameters:

# getObjectIds(domain) → {ApiResponse.<Array.<string>>}

Parameters:

# getObjects(objIdList, opt)

Parameters:

Example