ContextAPI#

Interface ContextAPI

The ContextAPI combines all functionality which can be applied on the WebvisContext.

Hierarchy

Index

Methods

add addCustomNode addToCollection addToSelection addTopologyToSelection anchorXR changeAnnotation changeClipPlane changeClippingRoom changeDrawing changeDrawingPlane changeMeasurement changeSetting changeSnapshot clear clearSelection clearTopologySelection clipOtherParts collectRuntimeNodesOfType connectToSession connectXR createAnimationFrames createAnnotation createAttachment createBoxVolume createCapping createCircularArcDescriptor createClipPlane createClippingRoom createCollection createDrawing createDrawingPlane createExplosion createMeasurement createNodePathHandles createPointDescriptor createSnapshot createViewer disableCapping disconnectFromSession disconnectXR enableCapping endExplosion enterXRInitMode exportXRInitTemplate fetchAttachmentData getAnnotationData getAnnotations getAttachmentData getAttachmentDataURI getClipPlanes getClipRoom getCollection getCollectionElements getCollectionNodeCount getCoordinateSystemForwardVector getCoordinateSystemMatrix getCoordinateSystemRightVector getCoordinateSystemUpVector getDrawingPlaneData getDrawingPlanes getDrawings getEnabledAuxNodes getEnabledLayerFilters getInteractionMode getMeasurements getMetadata getName getProperties getProperty getRegisteredLayerFilters getRootNodeId getSelectedLeafNodes getSelectedNodes getSelectedTopologyHandles getSelection getSessionMemberID getSessionMembers getSessionStateData getShapeHandle getSnapshotData getSnapshots getStatistics getTopologyType getViewer getViewers getXRCapabilities getXRMembers getXRPlaybackProperties getXRPlaybackState getXRState hideXRBackgroundFeed importConfig importSession importXRInitTemplate invertEnabledStates invertSelection isColorComparisonActive isNodeDeletable isNodePartOfEnabledLayers isNodePartOfEnabledVariant isNodeType isOfflineStorageAvailable isSelected isTopologySelected mapInternalToOriginalTopologyHandles mapOriginalToInternalTopologyHandles measureBetween measureTangent measureThickness performExplosion processInteractionInput promoteSessionMember query readSetting registerCustomProperty registerFrameListener registerListener remove removeAnimationFrames removeAnnotation removeAttachment removeCapping removeClipPlane removeClippingRoom removeCollection removeDrawing removeDrawingPlane removeFromCollection removeFromSelection removeMeasurement removeSessionMember removeSnapshot removeTopologyFromSelection removeViewer requestActiveSceneVolume requestAnnotationData requestAuxRootNodeIds requestBoxDescriptor requestClipPlaneData requestClipRoomData requestDrawingData requestFullSceneVolume requestHubVersion requestL3DInformation requestMeasurementData requestNodeIdsByBoxVolume requestNodePathHandleMap requestNodePathStrings requestRootNodeIds requestServiceStates requestSnapshotData requestSupportedContentTypes requestSupportedRenderSetups requestTopologyDescriptor requestVariants requestXRDeviceScreenshot resetInteractionMode resetProperties resetProperty resetSetting resetUserSettings restoreSession restoreSnapshot searchByVolume seekXRPlayback selectCollection setAttachmentData setAttachmentDataURI setInteractionMode setLayerFilterEnabled setParent setProperty setSelection setTopologyProperty setTopologySelection setVariantEnabled setXRPlaybackBoomerang setXRPlaybackFrameRange setXRPlaybackSource setXRPlaybackSpeed showXRBackgroundFeed shutdownSession startXRPlayback startXRSpectate stopXRPlayback stopXRSpectate storeSession transferSession unanchorXR unregisterFrameListener unregisterListener waitFor

Methods

add

add(options): number
Adds a new Node to the InstanceGraph.
Parameters
- options: AddNodeOptions
  
  Specifies the options for the new Node.
Returns number
The id of added Node

Inherited from InstanceGraphAPI.add
add(dataURI, parentID?, usage?, label?, contentType?, initialProperties?, cacheStrategy?): number
Parameters
- dataURI: string
  
  Specifies the URI to the data resource.
- Optional parentID: number
  
  Specifies the parent Node ID of the added Node.
- Optional usage: UsageString
  
  The usage parameter allows to define how the resource should be inserted in the InstanceGraph.
- Optional label: string
  
  Specifies a custom label for the added Node.
- Optional contentType: string
  
  Specifies the MimeType of the data resource.
- Optional initialProperties: InitialNodeProperties
  
  Specifies initialProperties of the added Node.
- Optional cacheStrategy: CacheStrategy
  
  Specifies the strategy which is used when a data cache is requested from the Hub.
Returns number
The id of added Node

Deprecated
Adds a new Node to the InstanceGraph.

Inherited from InstanceGraphAPI.add

addCustomNode

addCustomNode(customNodeType, data, dataType?): number
Creates a custom Node with custom data which is stored in an Attachment.
Parameters
- customNodeType: string
  
  {string} Specifies the custom Node type.
- data: any
  
  {any} Specifies the data of the custom Node.
- Optional dataType: AttachmentType
  
  {AttachmentType="json"} Specifies the type of the data.
Returns number

Inherited from InstanceGraphAPI.addCustomNode

addToCollection

addToCollection(collectionID, nodeID, recursive?): void
Adds the node given by nodeID to the collection with id collectionID. If recursive is true, the descendants of the node are also added. Returns the number of nodes in the collection.
Parameters
- collectionID: number
  
  Specifies to which collection the node should be added
- nodeID: number
  
  Specifies which node should be added to the collection
- Optional recursive: boolean
  
  Specifies if the children of the node should also be added to the collection
Returns void

Inherited from CollectionAPI.addToCollection

addToSelection

addToSelection(nodeID, silent?): Promise<ChangeSelectionResult>
Adds the given Nodes to the Selection.
Parameters
- nodeID: number | number[]
  
  The ID of the Node that should be added to the current Selection
- Optional silent: boolean
  
  If set to true, no event will be emitted.
Returns Promise<ChangeSelectionResult>

Inherited from SelectionAPI.addToSelection

addTopologyToSelection

addTopologyToSelection(handle): Promise<void>
Adds one or multiple Topology elements to the current selection.
Parameters
- handle: TopologyHandle | TopologyHandle[]
  
  A Topology Element or the list of Topology Elements which should be added to the current selection.
Returns Promise<void>

Inherited from TopologyAPI.addTopologyToSelection

anchorXR

anchorXR(): void
Experimental
Anchors the model at the current 3D pose. Visually, this will have the effect that the model will stay at the current position and orientation in the real world.

Please note, that in a model-based tracking scenario, the model will get anchored automatically when the alignment of the model with the real world object is high enough that tracking can be performed (model is snapped).

This will trigger a XRStateChangedEvent with anchored set to true.

Returns void

Inherited from RealityAPI.anchorXR

changeAnnotation

changeAnnotation(annotationId, properties): AnnotationProperties
Changes one or more properties of an Annotation with the specified id.
Parameters
- annotationId: number
  
  The id of the Annotation you want to change.
- properties: AnnotationProperties
  
  The properties of the Annotation you want change.
Returns AnnotationProperties
An Object with the changed Properties.

Inherited from AnnotationAPI.changeAnnotation
changeAnnotation(annotationID, label?, visible?, anchorPosition?, labelPosition?, active?, transform?): void
Parameters
- annotationID: number
  
  The ID of the Annotation.
- Optional label: string
  
  The text of the Annotation.
- Optional visible: boolean
  
  Indicates if the Annotation should be visible or hidden.
- Optional anchorPosition: number[] | Float32Array
  
  Anchor position in world space coordinates.
- Optional labelPosition: number[] | Float32Array
  
  The position of the label.
- Optional active: boolean
  
  DEPRECATED
- Optional transform: number[] | Float32Array
  
  The transformation of the Annotation.
Returns void

Deprecated
Changes an annotation.

Inherited from AnnotationAPI.changeAnnotation

changeClipPlane

changeClipPlane(clipPlaneId, properties): ClipPlaneProperties
Changes one or more properties of a clip plane with the specified id.
Parameters
- clipPlaneId: number
  
  The id of the clip plane you want to change.
- properties: ClipPlaneProperties
  
  The properties of the clip plane you want change.
Returns ClipPlaneProperties
An Object with the changed Properties.

Inherited from ClipPlaneAPI.changeClipPlane
changeClipPlane(clipPlaneID, normal?, point?, name?, thickness?, tangent?, disabled?, invisible?, exclusive?): void
Changes the properties of the clip plane defined by the clipPlaneID with the optional parameters normal, points and name.
Parameters
- clipPlaneID: number
  
  The ID of an existing clip plane which should be changed
- Optional normal: number[] | Float32Array
  
  The new normal of the clip plane
- Optional point: number[] | Float32Array
  
  An arbitrary new point in space which lies on the clip plane
- Optional name: string
  
  The new name for the clip plane
- Optional thickness: number
  
  The thickness for the clip plane
- Optional tangent: number[] | Float32Array
  
  The tangent of the clip plane
- Optional disabled: boolean
  
  The enabled state of the clip plane
- Optional invisible: boolean
  
  Invisible on the UI
- Optional exclusive: boolean
  
  set the exclusive flag to clip geometry when using exclusiveClipplanes property
Returns void

Deprecated
Calling changeClipPlane with single parameters is deprecated, please use ClipPlaneProperties instead.

Inherited from ClipPlaneAPI.changeClipPlane

changeClippingRoom

changeClippingRoom(properties?): ClipRoomProperties
Changes one or more properties of the clip room.
Parameters
- Optional properties: ClipRoomProperties
  
  The properties of the clip room you want change.
Returns ClipRoomProperties
An object with the changed properties.

Inherited from ClipPlaneAPI.changeClippingRoom
changeClippingRoom(name?, size?, transformation?, disabled?, invisible?): ClipRoomProperties
Parameters
- Optional name: string
  
  The name of the clip room.
- Optional size: number[] | Float32Array
  
  The size of the clip room.
- Optional transformation: number[] | Float32Array
  
  The transformation of the clip room.
- Optional disabled: boolean
  
  The disabled state of the clip room.
- Optional invisible: boolean
  
  The invisible state of the clip room.
Returns ClipRoomProperties
An object with the changed properties.

Deprecated
Calling changeClippingRoom with single parameters is deprecated, please use ClipRoomProperties instead.

Changes one or more properties of the clip room.

Inherited from ClipPlaneAPI.changeClippingRoom

changeDrawing

changeDrawing(drawingId, properties): DrawingProperties
Changes one or more properties of a Drawing with the specified id.
Parameters
- drawingId: number
  
  The id of the Drawing.
- properties: DrawingProperties
  
  The properties of the Drawing.
Returns DrawingProperties
An object with the changed properties.

Inherited from DrawingAPI.changeDrawing

changeDrawingPlane

changeDrawingPlane(drawingPlaneId, properties): DrawingPlaneProperties
Experimental
Changes one or more properties of a DrawingPlane with the specified ID.
Parameters
- drawingPlaneId: number
  
  The ID of the DrawingPlane you want to change.
- properties: DrawingPlaneProperties
  
  The properties of the DrawingPlane you want change.
Returns DrawingPlaneProperties
An Object with the changed Properties.

Inherited from DrawingPlaneAPI.changeDrawingPlane

changeMeasurement

changeMeasurement(measurementID, properties): MeasurementProperties
Changes one or more properties of a Measurement with the specified id.
Parameters
- measurementID: number
  
  The id of the Measurement you want to change.
- properties: MeasurementProperties
  
  The properties of the Measurement you want change.
Returns MeasurementProperties
An Object with the changed Properties.

Inherited from MeasurementAPI.changeMeasurement

changeSetting

changeSetting<T>(setting, value): boolean
Changes the setting to the given value.
Type Parameters
- T extends string
Parameters
- setting: T
  
  A name that specifies a particular setting
- value: ContextSettingType<T>
  
  The new value for the setting
Returns boolean
A boolean which indicates if the setting has changed

Inherited from SettingsAPI.changeSetting

changeSnapshot

changeSnapshot(snapshotID, properties): SnapshotProperties
Changes one or more properties of a Snapshot with the specified ID.
Parameters
- snapshotID: number
  
  The ID of the Snapshot you want to change.
- properties: SnapshotProperties
  
  The properties of the Snapshot you want to change.
Returns SnapshotProperties
An object with the changed Properties.

Inherited from SessionStorageAPI.changeSnapshot
changeSnapshot(snapshotID, name?, screenshotURL?, order?): SnapshotProperties
This changes the textual description of the Snapshot for given snapshotID to the value of text.
Parameters
- snapshotID: number
  
  The ID of the Snapshot.
- Optional name: string
  
  The new name of the Snapshot.
- Optional screenshotURL: string
  
  The new screenshot URL of the Snapshot.
- Optional order: number
  
  The order inside the List of Snapshots.
Returns SnapshotProperties

Deprecated
Calling changeSnapshot with single parameters is deprecated, please use SnapshotProperties instead.

Inherited from SessionStorageAPI.changeSnapshot

clear

clear(): Promise<void>
Clears the whole Context by removing all Nodes, Snapshots, ClipPlanes, Drawings, Measurements, etc.

Returns Promise<void>

clearSelection

clearSelection(silent?): Promise<ChangeSelectionResult>
Clears the current Selection.
Parameters
- Optional silent: boolean
  
  If set to true, no event will be emitted.
Returns Promise<ChangeSelectionResult>

Inherited from SelectionAPI.clearSelection

clearTopologySelection

clearTopologySelection(): Promise<void>
Clears the current Topology Selection.

Returns Promise<void>

Inherited from TopologyAPI.clearTopologySelection

clipOtherParts

clipOtherParts(target): void
Creates a clip room around the box volume of the specified node.
Parameters
- target: number | number[]
  
  ID(s) of the target Node(s).
Returns void

Inherited from ClipPlaneAPI.clipOtherParts

collectRuntimeNodesOfType

collectRuntimeNodesOfType(nodeType, subType?): number[]
Returns a list of all existing runtime Node ids of a specified type.
Parameters
- nodeType: NodeType
  
  The Node type to collect.
- Optional subType: string
  
  The sub type to collect. Only used for Custom-Nodes.
Returns number[]
A list of runtime Node ids of the specified type.

Inherited from InstanceGraphAPI.collectRuntimeNodesOfType

connectToSession

connectToSession(sessionID?, name?): Promise<SessionStateData>
Parameters
- Optional sessionID: string
  
  The ID of the Session.
- Optional name: string
  
  The ID of the Session.
Returns Promise<SessionStateData>

Deprecated
The whole SessionAPI is under consolidation and will be replaced in a future release.

Connects to a Session. If the ID does not exist, a new Session will be created.

Inherited from SessionAPI.connectToSession

connectXR

connectXR(xrConfiguration): Promise<void>
Experimental
Connect to the XR system with the given XRConfiguration. The configuration determines what parts of the API are desired to be used.

By default, XR will be connected with the following configuration:
```
const defaultXRConfiguration = {
     imageSourceConfig:
     {
         type: XRImageSource.DEVICE
     }
}
```
If unspecified, modelTrackingEnabled and autoShowBackgroundFeed will be inferred as true and deviceScreenshotsEnabled as false automatically.

Note: If a change of configuration is required after being initialized, the user has to disconnectXR and connect with the new configuration.
Parameters
- xrConfiguration: XRConfiguration
  
  The configuration for the XR system
Returns Promise<void>
Returns a Promise which resolved when the operation was successful or rejects in an error case

Inherited from RealityAPI.connectXR

createAnimationFrames

createAnimationFrames(name, frames): void
Creates a new keyframe-based animation sequence.
Parameters
- name: string
  
  The name of the animation sequence.
- frames: AnimationFrame[]
  
  The keyframes of the animation sequence.
Returns void

Inherited from AnimationAPI.createAnimationFrames

createAnnotation

createAnnotation(properties?): number
Creates a new Annotation.
Parameters
- Optional properties: AnnotationProperties
  
  Initial properties of the created Annotation.
Returns number
The id of the newly created Annotation.

Inherited from AnnotationAPI.createAnnotation
createAnnotation(nodeID, label, visible?, anchorPosition?, labelOffset?): number
Parameters
- nodeID: number
  
  The ID of the node that the Annotation belongs to.
- label: string
  
  The text of the Annotation.
- Optional visible: boolean
  
  Indicates if the Annotation should be visible or hidden.
- Optional anchorPosition: number[] | Float32Array
  
  Anchor position in world space coordinates.
- Optional labelOffset: number[] | Float32Array
  
  The offset between anchorPosition and where the label should be displayed.
Returns number
The ID of the new annotation.

Deprecated
Creates a new annotation.

Inherited from AnnotationAPI.createAnnotation

createAttachment

createAttachment(dataType?): number
Creates a new attachment.
Parameters
- Optional dataType: AttachmentType
  
  Specifies the attachment data type.
Returns number
The attachment id.

Inherited from AttachmentAPI.createAttachment

createBoxVolume

createBoxVolume(min?, max?): BoxVolume
Creates a new BoxVolume object.
Parameters
- Optional min: [number, number, number]
- Optional max: [number, number, number]
Returns BoxVolume
A new Box Volume

Inherited from UtilityAPI.createBoxVolume

createCapping

createCapping(clipPlaneId): Promise<void>
Experimental
Generates capping geometry for the surface that is cut by the clip plane. The generated surfaces allow measurements and all other operations which can be performed on usual geometry.
Parameters
- clipPlaneId: number
  
  the id of the clip plane
Returns Promise<void>

Inherited from ClipPlaneAPI.createCapping

createCircularArcDescriptor

createCircularArcDescriptor(point0, point1, point2): {
descriptor: TopologyCircularArcDescriptor;
type: CIRCULAR_ARC;
}
Create Circular arc descriptor by the three specified points.
Parameters
- point0: [number, number, number]
  
  The first point.
- point1: [number, number, number]
  
  The second point.
- point2: [number, number, number]
  
  The third point.
Returns {
descriptor: TopologyCircularArcDescriptor;
type: CIRCULAR_ARC;
}
- descriptor: TopologyCircularArcDescriptor
  
  The attributes of the Topological Element.
- type: CIRCULAR_ARC
  
  The syb type of the Topological Element.
Inherited from TopologyAPI.createCircularArcDescriptor

createClipPlane

createClipPlane(properties?): number
Creates a new clip plane.
Parameters
- Optional properties: ClipPlaneProperties
  
  Initial properties of the created clip plane.
Returns number
The id of the newly created clip plane.

Inherited from ClipPlaneAPI.createClipPlane
createClipPlane(normal?, point?, name?, thickness?, tangent?, disabled?, invisible?, exclusive?): number
Creates a clip plane defined by the plane’s normal, positioned at an optional point (otherwise at the world space origin) and an optional name. Returns the ID of the clip plane.
Parameters
- Optional normal: number[] | Float32Array
  
  The normal of the clip plane
- Optional point: number[] | Float32Array
  
  An arbitrary point in space which lies on the clip plane
- Optional name: string
  
  The name of the clip plane
- Optional thickness: number
  
  The thickness of the clip plane
- Optional tangent: number[] | Float32Array
  
  The tangent of the clip plane
- Optional disabled: boolean
  
  The state of the clip plane
- Optional invisible: boolean
  
  Invisible on the UI
- Optional exclusive: boolean
  
  set the exclusive flag to clip geometry when using exclusiveClipplanes property
Returns number
The ID of the newly created clip plane

Deprecated
Calling createClipPlane with single parameters is deprecated, please use ClipPlaneProperties instead.

Inherited from ClipPlaneAPI.createClipPlane

createClippingRoom

createClippingRoom(properties?): void
Creates a new clip room.
Parameters
- Optional properties: ClipRoomProperties
  
  Initial properties of the created clip room.
Returns void

Inherited from ClipPlaneAPI.createClippingRoom
createClippingRoom(name?, size?, transformation?, disabled?, invisible?): void
Parameters
- Optional name: string
  
  The name of the clip room.
- Optional size: number[] | Float32Array
  
  The size of the clip room.
- Optional transformation: number[] | Float32Array
  
  The transformation of the clip room.
- Optional disabled: boolean
  
  The disabled state of the clip room.
- Optional invisible: boolean
  
  The invisible state of the clip room.
Returns void

Deprecated
Calling createClippingRoom with single parameters is deprecated, please use ClipRoomProperties instead.

Creates a new clip room.

Inherited from ClipPlaneAPI.createClippingRoom

createCollection

createCollection(nodeIDlist?): number
Returns the id of a new collection containing the nodes from the given list.
Parameters
- Optional nodeIDlist: number[]
  
  An array of node id's from which a new node collection should be created.
Returns number
The id of the newly created node collection.

Inherited from CollectionAPI.createCollection
createCollection(): number
Creates a new, empty collection and returns its id.

Returns number
The id of the newly created collection.

Inherited from CollectionAPI.createCollection

createDrawing

createDrawing(data, properties?): number
Creates a new Drawing from the Output of the ViewerDrawingAPI.
Parameters
- data: ViewerDrawingResult
  
  The data generated with the help of the ViewerDrawingAPI.
- Optional properties: DrawingProperties
  
  Initial properties of the created Drawing.
Returns number
The id of the newly created Drawing.

Inherited from DrawingAPI.createDrawing

createDrawingPlane

createDrawingPlane(properties?): number
Experimental
Creates a new DrawingPlane with the specified properties.
Parameters
- Optional properties: DrawingPlaneProperties
  
  Initial properties of the created Drawing.
Returns number
The ID of the newly created Drawing.

Inherited from DrawingPlaneAPI.createDrawingPlane

createExplosion

createExplosion(centerNodeID?): void
Creates an Explosion (around a given point).
Parameters
- Optional centerNodeID: number
  
  The nodeID of the node around which center the explosion is created.
Returns void

Inherited from ExplosionAPI.createExplosion

createMeasurement

createMeasurement<T>(type, targets, properties?): number
Creates a new Measurement.
Type Parameters
- T extends keyof MeasurementTypeToTargetMap
Parameters
- type: T
  
  The type of the Measurement.
- targets: MeasurementTypeToTargetMap[T]
  
  The targets of the Measurement.
- Optional properties: MeasurementProperties
  
  The properties of the Measurement.
Returns number
The ID of the created Measurement.

Inherited from MeasurementAPI.createMeasurement

createNodePathHandles

createNodePathHandles(targets): Promise<NodePathHandle[]>
createNodePathHandles Creates and returns handles for the target node ids or topology selectors.
Parameters
- targets: number[]
  
  {Array} Array of target node ids to create the handles for
Returns Promise<NodePathHandle[]>
The array of handles

Inherited from NodePathAPI.createNodePathHandles

createPointDescriptor

createPointDescriptor(point): {
descriptor: TopologyPointDescriptor;
type: POINT;
}
Create Point descriptor by the specified point.
Parameters
- point: [number, number, number]
  
  The point.
Returns {
descriptor: TopologyPointDescriptor;
type: POINT;
}
- descriptor: TopologyPointDescriptor
  
  The attributes of the Topological Element.
- type: POINT
  
  The syb type of the Topological Element.
Inherited from TopologyAPI.createPointDescriptor

createSnapshot

createSnapshot(name?, options?): Promise<number>
Creates a Snapshot of the current.
Parameters
- Optional name: string
  
  The Name of the Snapshot.
- Optional options: SnapshotCreationOptions
  
  Options used for the Snapshot creation.
Returns Promise<number>
The Snapshot ID.

Inherited from SessionStorageAPI.createSnapshot

createViewer

createViewer(viewerID?, canvas?, settings?): ViewerAPI
Creates a viewer element.
Parameters
- Optional viewerID: string
  
  The id of the viewer.
- Optional canvas: HTMLCanvasElement
  
  The canvas which is attached to the viewer.
- Optional settings: {
      aaSetting: any;
      backgroundColor: any;
      cappingEffectEdgeColor: any;
      cappingEffectEnabled: any;
      cappingEffectInnerColor: any;
      colorComparisonFirstColor: any;
      colorComparisonMatchingColor: any;
      colorComparisonSecondColor: any;
      colorizeEffect: any;
      coordSys: any;
      defaultFieldOfView: any;
      disableSpecularHighlights: any;
      doubleClickAnimationVolumeScale: any;
      doubleClickTimeWindow: any;
      drawingArrowheadEnd: any;
      drawingArrowheadStart: any;
      drawingColor: any;
      drawingMode: any;
      drawingSize: any;
      dynamicAuxContrastEnabled: any;
      dynamicCOREnabled: any;
      dynamicClippingDistance: any;
      dynamicClippingEnabled: any;
      expandOnViewerSelection: any;
      faceHighlightColor: any;
      faceSelectionColor: any;
      fitViewFactor: any;
      flyNavigationSpeed: any;
      flyToOnDoubleClick: any;
      focusOnDoubleClick: any;
      frustumCulling: any;
      ghostedSceneOpacity: any;
      gizmoScalingFactor: any;
      gizmosEnabled: any;
      gpuMemoryReleaseFactor: any;
      hoverColor: any;
      initView: any;
      initialFit: any;
      lightingEnvironment: any;
      lineHighlightColor: any;
      lineSelectionColor: any;
      maxDynamicClipDistance: any;
      maxGPUMemory: any;
      maxSRCCPUMemory: any;
      mouseInvertZoomingDirection: any;
      navigationMode: any;
      navigationSampling: any;
      navigationSpeedFactor: any;
      navigationSpeedThrottleFactor: any;
      outlineColor: any;
      outlineColorOccluded: any;
      outlineInnerRadius: any;
      outlineOuterRadius: any;
      preSelectionColor: any;
      projectionType: any;
      renderAuxOnTop: any;
      renderMode: any;
      renderSetup: any;
      screenSpaceCoverageCalculationMethod: any;
      selectionColor: any;
      showAuxOnNavigation: any;
      silhouetteEffect: any;
      silhouetteEffectColor: any;
      silhouetteEffectExclusiveEnabled: any;
      smallFeatureCulling: any;
      smallFeaturePixelThreshold: any;
      soc: any;
      spacemouseMultiplier: any;
      ssaoEnabled: any;
      taaEnabled: any;
      topoGeometryColor: any;
      topoGeometrySecondaryColor: any;
      topoPointsEnabled: any;
      turntableLowerVerticalLimit: any;
      turntableUpperVerticalLimit: any;
      turntableVerticalLimitsEnabled: any;
      useDevicePixelRatio: any;
      vertexColorsEnabled: any;
      viewPerspective: any;
      webglPreserveDrawingbuffer: any;
  }
  
  ViewerSettings
  - aaSetting: any
  - backgroundColor: any
  - cappingEffectEdgeColor: any
  - cappingEffectEnabled: any
  - cappingEffectInnerColor: any
  - colorComparisonFirstColor: any
  - colorComparisonMatchingColor: any
  - colorComparisonSecondColor: any
  - colorizeEffect: any
  - coordSys: any
  - defaultFieldOfView: any
  - disableSpecularHighlights: any
  - doubleClickAnimationVolumeScale: any
  - doubleClickTimeWindow: any
  - drawingArrowheadEnd: any
  - drawingArrowheadStart: any
  - drawingColor: any
  - drawingMode: any
  - drawingSize: any
  - dynamicAuxContrastEnabled: any
  - dynamicCOREnabled: any
  - dynamicClippingDistance: any
  - dynamicClippingEnabled: any
  - expandOnViewerSelection: any
  - faceHighlightColor: any
  - faceSelectionColor: any
  - fitViewFactor: any
  - flyNavigationSpeed: any
  - flyToOnDoubleClick: any
  - focusOnDoubleClick: any
  - frustumCulling: any
  - ghostedSceneOpacity: any
  - gizmoScalingFactor: any
  - gizmosEnabled: any
  - gpuMemoryReleaseFactor: any
  - hoverColor: any
  - initView: any
  - initialFit: any
  - lightingEnvironment: any
  - lineHighlightColor: any
  - lineSelectionColor: any
  - maxDynamicClipDistance: any
  - maxGPUMemory: any
  - maxSRCCPUMemory: any
  - mouseInvertZoomingDirection: any
  - navigationMode: any
  - navigationSampling: any
  - navigationSpeedFactor: any
  - navigationSpeedThrottleFactor: any
  - outlineColor: any
  - outlineColorOccluded: any
  - outlineInnerRadius: any
  - outlineOuterRadius: any
  - preSelectionColor: any
  - projectionType: any
  - renderAuxOnTop: any
  - renderMode: any
  - renderSetup: any
  - screenSpaceCoverageCalculationMethod: any
  - selectionColor: any
  - showAuxOnNavigation: any
  - silhouetteEffect: any
  - silhouetteEffectColor: any
  - silhouetteEffectExclusiveEnabled: any
  - smallFeatureCulling: any
  - smallFeaturePixelThreshold: any
  - soc: any
  - spacemouseMultiplier: any
  - ssaoEnabled: any
  - taaEnabled: any
  - topoGeometryColor: any
  - topoGeometrySecondaryColor: any
  - topoPointsEnabled: any
  - turntableLowerVerticalLimit: any
  - turntableUpperVerticalLimit: any
  - turntableVerticalLimitsEnabled: any
  - useDevicePixelRatio: any
  - vertexColorsEnabled: any
  - viewPerspective: any
  - webglPreserveDrawingbuffer: any
Returns ViewerAPI

disableCapping

disableCapping(clipPlaneId): Promise<void>
Experimental
Disables the generated capping geometry.
Parameters
- clipPlaneId: number
  
  the id of the clip plane
Returns Promise<void>

Inherited from ClipPlaneAPI.disableCapping

disconnectFromSession

disconnectFromSession(): void
Returns void

Deprecated
The whole SessionAPI is under consolidation and will be replaced in a future release.

Disconnects from a Session.

Inherited from SessionAPI.disconnectFromSession

disconnectXR

disconnectXR(): Promise<void>
Experimental
Disconnect from the XR system.

This method should be called when the AR functionalities are no longer needed.

Returns Promise<void>
Returns a Promise which resolved when the operation was successful or rejects in an error case

Inherited from RealityAPI.disconnectXR

enableCapping

enableCapping(clipPlaneId): Promise<void>
Experimental
Enables the generated capping geometry.
Parameters
- clipPlaneId: number
  
  the id of the clip plane
Returns Promise<void>

Inherited from ClipPlaneAPI.enableCapping

endExplosion

endExplosion(): void
Restores the initial transformations of all exploded parts.

Returns void

Inherited from ExplosionAPI.endExplosion

enterXRInitMode

enterXRInitMode(xrInitOptions?): Promise<void>
Experimental
Enter the XR initialization mode. The initialization mode is used as an entry point for model-based tracking. It unanchors any previously anchored model and starts the model-based tracking process. In this mode, the user can align the model with the real object (snapping). When the model is snapped, the anchored value will be set to true which will trigger a XRStateChangedEvent. By that, the init mode gets exited and the model is anchored to the real object. The model now gets tracked and moves with the device.

Please note, that this method should only be called if the XR system has the SUPPORTS_MODEL_TRACKING capability.
Parameters
- Optional xrInitOptions: XRInitOptions
  
  The options for the XR initialization mode
Returns Promise<void>
Returns a Promise which resolved when the operation was successful or rejects in an error case

Inherited from RealityAPI.enterXRInitMode

exportXRInitTemplate

exportXRInitTemplate(): Promise<string>
Experimental
Exports an initialization template for model-based tracking.

In a model-based tracking scenario, after a successful tracking session, the learned initialization data can be exported with this function and stored as a template for later.

This method is only available if the XR system has the SUPPORTS_MODEL_TRACKING capability.

The acquired data can be imported via importXRInitTemplate function.

Returns Promise<string>
Returns a Promise which contains the base64 encoded initialization template data when the operation was successful or rejects in an error case.

Inherited from RealityAPI.exportXRInitTemplate

fetchAttachmentData

fetchAttachmentData<T>(attachmentID?): Promise<T>
Fetches & returns the attachment data.
Type Parameters
- T = any
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
Returns Promise<T>
The attached data.

Inherited from AttachmentAPI.fetchAttachmentData

getAnnotationData

getAnnotationData(annotationId): AnnotationData
Parameters
- annotationId: number
  
  The ID of the Annotation.
Returns AnnotationData
The content and properties of an annotation.

Deprecated

Inherited from AnnotationAPI.getAnnotationData

getAnnotations

getAnnotations(): number[]
Returns number[]
The ids of all available Annotations

Inherited from AnnotationAPI.getAnnotations

getAttachmentData

getAttachmentData<T>(attachmentID?): T
Returns the attachment data.
Type Parameters
- T = any
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
Returns T
The attached data

Deprecated
getAttachmentData is deprecated, please use fetchAttachmentData instead.

Inherited from AttachmentAPI.getAttachmentData

getAttachmentDataURI

getAttachmentDataURI(attachmentID?): string
Returns the attachment data URI.
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
Returns string

Inherited from AttachmentAPI.getAttachmentDataURI

getClipPlanes

getClipPlanes(): number[]
Returns the ids of all available clip planes.

Returns number[]
The ids of all available clip planes.

Inherited from ClipPlaneAPI.getClipPlanes

getClipRoom

getClipRoom(): number
Returns the id the clip room.

Returns number
The id the clip room.

Inherited from ClipPlaneAPI.getClipRoom

getCollection

getCollection(collectionID): ICollection
Parameters
- collectionID: number
Returns ICollection

Inherited from CollectionAPI.getCollection

getCollectionElements

getCollectionElements(collectionID): Promise<number[]>
Returns an array containing the ids of the nodes in the collection. Modifying the returned array results in undefined behavior.
Parameters
- collectionID: number
  
  The id of the node collection
Returns Promise<number[]>
Array of node IDs representing the node collection

READONLY

Inherited from CollectionAPI.getCollectionElements

getCollectionNodeCount

getCollectionNodeCount(collectionID): Promise<number>
Returns the number of elements inside a collection.
Parameters
- collectionID: number
  
  The id of the collection
Returns Promise<number>
Number of elements in a collection.

Inherited from CollectionAPI.getCollectionNodeCount

getCoordinateSystemForwardVector

getCoordinateSystemForwardVector(): Float32Array | [number, number, number]
Returns the forward vector of the current coordinate system.

Returns Float32Array | [number, number, number]
The forward vector of the current coordinate system.

Inherited from CoordinateSystemAPI.getCoordinateSystemForwardVector

getCoordinateSystemMatrix

getCoordinateSystemMatrix(): Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]
Returns a 4x4 rotation matrix which is used to transform the internal default right-handed coordinate system with X and Y as front plane axis to the configured one.

Returns Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]
The CoordinateSystem Matrix

Inherited from CoordinateSystemAPI.getCoordinateSystemMatrix

getCoordinateSystemRightVector

getCoordinateSystemRightVector(): Float32Array | [number, number, number]
Returns the right vector of the current coordinate system.

Returns Float32Array | [number, number, number]

Retuns
The right vector of the current coordinate system.

Inherited from CoordinateSystemAPI.getCoordinateSystemRightVector

getCoordinateSystemUpVector

getCoordinateSystemUpVector(): Float32Array | [number, number, number]
Returns the up vector of the current coordinate system.

Returns Float32Array | [number, number, number]
The up vector of the current coordinate system.

Inherited from CoordinateSystemAPI.getCoordinateSystemUpVector

getDrawingPlaneData

getDrawingPlaneData(drawingPlaneId): DrawingPlaneProperties
Experimental
Returns the DrawingPlane properties for the specified DrawingPlane ID.
Parameters
- drawingPlaneId: number
  
  The ID of the DrawingPlane you want to get the Data for.
Returns DrawingPlaneProperties
The requested DrawingPlane properties.

Inherited from DrawingPlaneAPI.getDrawingPlaneData

getDrawingPlanes

getDrawingPlanes(): number[]
Experimental
Returns all available DrawingPlane IDs.

Returns number[]
An Array of all available DrawingPlane IDs.

Inherited from DrawingPlaneAPI.getDrawingPlanes

getDrawings

getDrawings(): number[]
Returns all available Drawing ids.

Returns number[]
An Array of all available Drawing ids.

Inherited from DrawingAPI.getDrawings

getEnabledAuxNodes

getEnabledAuxNodes(nodeID?): Promise<number[]>
Parameters
- Optional nodeID: number
  
  Specifies the entry point of the subtree traversal (default: 0)
Returns Promise<number[]>
An Array of all enabled aux Node id's

Deprecated
This function will no longer be available in future webvis releases

Traverses the subtree of a given nodeID and collects all enabled aux Nodes.

Inherited from InstanceGraphAPI.getEnabledAuxNodes

getEnabledLayerFilters

getEnabledLayerFilters(): string[]
Returns the currently defined list of enabled LayerFilters.

Returns string[]
An array of strings representing the names of the enabled LayerFilters.

Inherited from LayerFilterAPI.getEnabledLayerFilters

getInteractionMode

getInteractionMode(): InteractionMode
Returns the current Interaction mode.

Returns InteractionMode
The current Interaction mode.

Inherited from InteractionAPI.getInteractionMode

getMeasurements

getMeasurements(): number[]
Returns number[]
The IDs of all available Measurements.

Inherited from MeasurementAPI.getMeasurements

getMetadata

getMetadata(nodeID): Promise<{
[key: string]: string;
}>
Returns a JSON object containing the metadata for the given nodeID.
Parameters
- nodeID: number
  
  The id of a Node.
Returns Promise<{
[key: string]: string;
}>
A JSON object containing the requested metadata.

Inherited from InstanceGraphAPI.getMetadata

getName

getName(): string
Returns string
The name of the context.

getProperties

getProperties<T>(nodeID, properties): Promise<PropertyType<T>[]>
Returns the values of the properties on the Node with the matching id.
Type Parameters
- T extends string
Parameters
- nodeID: number
  
  The id of the Node whose properties should be read.
- properties: T[]
  
  The names of the properties whose value should be read.
Returns Promise<PropertyType<T>[]>
The retrieved values of the Node's properties.

Inherited from InstanceGraphAPI.getProperties

getProperty

getProperty<T>(nodeID, property): Promise<PropertyType<T>>
Returns the value of the property on the Node with the matching id.
Type Parameters
- T extends string
Parameters
- nodeID: number
  
  The id of the Node whose property should be read.
- property: T
  
  The name of the property whose value should be read.
Returns Promise<PropertyType<T>>
The retrieved value of the Node property.

Inherited from InstanceGraphAPI.getProperty

getRegisteredLayerFilters

getRegisteredLayerFilters(): {
[key: string]: boolean;
}
Returns the currently defined list of LayerFilters.

Returns {
[key: string]: boolean;
}
Returns the registered LayerFilters and their states.
- [key: string]: boolean
Inherited from LayerFilterAPI.getRegisteredLayerFilters

getRootNodeId

getRootNodeId(target, includeTarget?): number
Returns the root Node id of the given Node or Topology Element.
Parameters
- target: number | TopologyHandle
  
  Specifies the target Node or Topology Element.
- Optional includeTarget: boolean
  
  Controls if the target Node itself can be returned as root Node. If set to false and a root Node id is passed in, it returns the next higher root Node id.
Returns number
- The root Node id of the given Node id or Topology handle.
Inherited from InstanceGraphAPI.getRootNodeId

getSelectedLeafNodes

getSelectedLeafNodes(): number[]
Returns a list of all selected nodes.

Returns number[]
An array which contains the IDs of all Nodes in the current Selection.

Inherited from SelectionAPI.getSelectedLeafNodes

getSelectedNodes

getSelectedNodes(): number[]
Returns all selected leaf nodes.

Returns number[]
An array which contains the IDs of all leaf Nodes in the current Selection.

Inherited from SelectionAPI.getSelectedNodes

getSelectedTopologyHandles

getSelectedTopologyHandles(): TopologyHandle[]
Returns a list of all selected topology elements.

Returns TopologyHandle[]
A List of all selected Topology elements.

Inherited from TopologyAPI.getSelectedTopologyHandles

getSelection

getSelection(): Promise<number[]>
Returns a list of all selected nodes.

Returns Promise<number[]>
An array which contains the IDs of all leaf Nodes in the current Selection.

Deprecated
getSelection is deprecated, please use getSelectedNodes instead.

Inherited from SelectionAPI.getSelection

getSessionMemberID

getSessionMemberID(): number
Returns number
The ID of the SessionMember.

Deprecated
The whole SessionAPI is under consolidation and will be replaced in a future release.

Inherited from SessionAPI.getSessionMemberID

getSessionMembers

getSessionMembers(): Promise<SessionMemberData[]>
Returns Promise<SessionMemberData[]>
The IDs of all SessionMembers.

Deprecated
The whole SessionAPI is under consolidation and will be replaced in a future release.

Inherited from SessionAPI.getSessionMembers

getSessionStateData

getSessionStateData(): SessionStateData
Returns SessionStateData
Information about the Session.

Deprecated
The whole SessionAPI is under consolidation and will be replaced in a future release.

Inherited from SessionAPI.getSessionStateData

getShapeHandle

getShapeHandle(handle): TopologyHandle
Returns a handle to the corresponding Shape of the specified Topology Element.
Parameters
- handle: TopologyHandle
  
  The Topology Handle.
Returns TopologyHandle
- The corresponding Shape of the specified Topology Element.
Inherited from TopologyAPI.getShapeHandle

getSnapshotData

getSnapshotData(snapshotID): {
    attachmentID: number;
    name: string;
    order: number;
}
Parameters
- snapshotID: number
Returns {
    attachmentID: number;
    name: string;
    order: number;
}
The data of the specified Snapshot.
- attachmentID: number
- name: string
- order: number
Deprecated
getSnapshotData is deprecated, please use requestSnapshotData instead.

Inherited from SessionStorageAPI.getSnapshotData

getSnapshots

getSnapshots(): number[]
Returns the ids of all available Snapshots.

Returns number[]
The ids of all available Snapshots.

Inherited from SessionStorageAPI.getSnapshots

getStatistics

getStatistics(nodeType?, nodeID?, recursive?): Promise<any>
Traverses the subtree of a given nodeID and collects all statistics (currently only available for AUX-Nodes).
Parameters
- Optional nodeType: NodeType
  
  Specifies the target Node type.
- Optional nodeID: number
  
  Specifies the entry point of the subtree traversal (default: 0).
- Optional recursive: boolean
Returns Promise<any>
An Object of Type/Count pairs.

Inherited from InstanceGraphAPI.getStatistics

getTopologyType

getTopologyType(handle): TopologyType
Returns the type of the given topology element
Parameters
- handle: TopologyHandle
  
  The TopologyHandle.
Returns TopologyType
The type of the given topology element

Inherited from TopologyAPI.getTopologyType

getViewer

getViewer(id?): ViewerAPI
Parameters
- Optional id: string
  
  The id of the viewer.
Returns ViewerAPI
The viewer element by the given id.

getViewers

getViewers(): ViewerAPI[]
Returns ViewerAPI[]
An array of all viewer elements.

getXRCapabilities

getXRCapabilities(): XRCapability[]
Experimental
Get the array of XRCapability. The array of capabilities determines what parts of the API can be used. The capabilities are mostly defined by the used device.

Returns XRCapability[]
Returns an Array<XRCapability> containing the XR system's capabilities.

Inherited from RealityAPI.getXRCapabilities

getXRMembers

getXRMembers(): number[]
Experimental
Returns an array of memberIDs of those session members which are currently using an XR device and have an active Reality connection. The array will not contain the session member ID of the current session member. If the session is not connected, the promise will reject with an error. If the session is connected, but no active Reality users are found, the promise will resolve with an empty array.

Returns number[]
The array of memberIDs of those session members that are currently publishing an XRImage stream

Inherited from RealityAPI.getXRMembers

getXRPlaybackProperties

getXRPlaybackProperties(): XRPlaybackProperties
Experimental
Get static information about the playback sequence.

Returns XRPlaybackProperties
The current XRPlaybackProperties

Inherited from RealityAPI.getXRPlaybackProperties

getXRPlaybackState

getXRPlaybackState(): XRPlaybackState
Experimental
Get real-time information about the current state of the playback.

Returns XRPlaybackState
The current XRPlaybackState

Inherited from RealityAPI.getXRPlaybackState

getXRState

getXRState(): XRState
Experimental
Get the runtime state of the XR system.

Returns XRState
Returns either the current XRState or undefined if the XR system is not connected.

Inherited from RealityAPI.getXRState

hideXRBackgroundFeed

hideXRBackgroundFeed(): Promise<void>
Experimental
Stops putting the image feed into the viewer's background. Also see showXRBackgroundFeed.

This will trigger a XRStateChangedEvent with backgroundFeedVisible set to false.

Returns Promise<void>
Returns a Promise which resolved when the operation was successful or rejects in an error case

Inherited from RealityAPI.hideXRBackgroundFeed

importConfig

importConfig(config): void
Applies the specified set of settings to the context.
Parameters
- config: {
      aaSetting: any;
      additionalCookies: any;
      additionalRequestHeaders: any;
      additionalWSQueryParameters: any;
      applicationIdentifier: any;
      auxModeRecursiveSearch: any;
      auxModeUncolorFacesOnLeave: any;
      backgroundColor: any;
      boosterURL: any;
      cappingEffectEdgeColor: any;
      cappingEffectEnabled: any;
      cappingEffectInnerColor: any;
      cappingGeometryColor: any;
      colorComparisonFirstColor: any;
      colorComparisonMatchingColor: any;
      colorComparisonSecondColor: any;
      colorizeEffect: any;
      contextMenuFunction: any;
      coordSys: any;
      defaultFieldOfView: any;
      defaultQueryLinkDepth: any;
      disableDefaultInteraction: any;
      disableSpecularHighlights: any;
      doubleClickAnimationVolumeScale: any;
      doubleClickTimeWindow: any;
      drawingArrowheadEnd: any;
      drawingArrowheadStart: any;
      drawingColor: any;
      drawingMode: any;
      drawingSize: any;
      dynamicAuxContrastEnabled: any;
      dynamicCOREnabled: any;
      dynamicClippingDistance: any;
      dynamicClippingEnabled: any;
      expandOnViewerSelection: any;
      faceHighlightColor: any;
      faceSelectionColor: any;
      fitViewFactor: any;
      flyNavigationSpeed: any;
      flyToOnDoubleClick: any;
      focusOnDoubleClick: any;
      frontPlaneAxis: any;
      frustumCulling: any;
      ghostedSceneOpacity: any;
      gizmoScalingFactor: any;
      gizmosEnabled: any;
      gpuMemoryReleaseFactor: any;
      hoverColor: any;
      hubURL: any;
      initView: any;
      initialFit: any;
      initialStateActivation: any;
      lightingEnvironment: any;
      lineHighlightColor: any;
      lineSelectionColor: any;
      loadRemoteConfigFile: any;
      logLevel: any;
      maxActiveSceneVolumeDiameter: any;
      maxConcurrentDownloads: any;
      maxDynamicClipDistance: any;
      maxGPUMemory: any;
      maxSRCCPUMemory: any;
      measurementAngularTolerance: any;
      measurementMaterialDensities: any;
      mouseInvertZoomingDirection: any;
      navigationMode: any;
      navigationSampling: any;
      navigationSpeedFactor: any;
      navigationSpeedThrottleFactor: any;
      notificationLogLevels: any;
      outlineColor: any;
      outlineColorOccluded: any;
      outlineInnerRadius: any;
      outlineOuterRadius: any;
      parentSelectEnabled: any;
      preSelectionColor: any;
      preferXHRWithCredentials: any;
      projectionType: any;
      renderAuxOnTop: any;
      renderMode: any;
      renderSetup: any;
      screenSpaceCoverageCalculationMethod: any;
      selectionColor: any;
      sessionDeviceTags: any;
      sessionForwardUrl: any;
      sessionInteractions: any;
      sessionMemberName: any;
      showAuxOnNavigation: any;
      silhouetteEffect: any;
      silhouetteEffectColor: any;
      silhouetteEffectExclusiveEnabled: any;
      skipSslVerify: any;
      smallFeatureCulling: any;
      smallFeaturePixelThreshold: any;
      snapshotContentSelection: any;
      soc: any;
      spacemouseMultiplier: any;
      ssaoEnabled: any;
      taaEnabled: any;
      topoGeometryColor: any;
      topoGeometrySecondaryColor: any;
      topoPointsEnabled: any;
      turntableLowerVerticalLimit: any;
      turntableUpperVerticalLimit: any;
      turntableVerticalLimitsEnabled: any;
      uriMap: any;
      useDevicePixelRatio: any;
      vertexColorsEnabled: any;
      viewPerspective: any;
      webglPreserveDrawingbuffer: any;
      xrEnableDebugImages: any;
      xrFusionMode: any;
      xrImageCompressionQuality: any;
      xrImageResolutionProfile: any;
      xrModelTrackerQualityThreshold: any;
      xrModelTrackerSmoothingFactor: any;
  }
  
  Settings to import
  - aaSetting: any
  - additionalCookies: any
  - additionalRequestHeaders: any
  - additionalWSQueryParameters: any
  - applicationIdentifier: any
  - auxModeRecursiveSearch: any
  - auxModeUncolorFacesOnLeave: any
  - backgroundColor: any
  - boosterURL: any
  - cappingEffectEdgeColor: any
  - cappingEffectEnabled: any
  - cappingEffectInnerColor: any
  - cappingGeometryColor: any
  - colorComparisonFirstColor: any
  - colorComparisonMatchingColor: any
  - colorComparisonSecondColor: any
  - colorizeEffect: any
  - contextMenuFunction: any
  - coordSys: any
  - defaultFieldOfView: any
  - defaultQueryLinkDepth: any
  - disableDefaultInteraction: any
  - disableSpecularHighlights: any
  - doubleClickAnimationVolumeScale: any
  - doubleClickTimeWindow: any
  - drawingArrowheadEnd: any
  - drawingArrowheadStart: any
  - drawingColor: any
  - drawingMode: any
  - drawingSize: any
  - dynamicAuxContrastEnabled: any
  - dynamicCOREnabled: any
  - dynamicClippingDistance: any
  - dynamicClippingEnabled: any
  - expandOnViewerSelection: any
  - faceHighlightColor: any
  - faceSelectionColor: any
  - fitViewFactor: any
  - flyNavigationSpeed: any
  - flyToOnDoubleClick: any
  - focusOnDoubleClick: any
  - frontPlaneAxis: any
  - frustumCulling: any
  - ghostedSceneOpacity: any
  - gizmoScalingFactor: any
  - gizmosEnabled: any
  - gpuMemoryReleaseFactor: any
  - hoverColor: any
  - hubURL: any
  - initView: any
  - initialFit: any
  - initialStateActivation: any
  - lightingEnvironment: any
  - lineHighlightColor: any
  - lineSelectionColor: any
  - loadRemoteConfigFile: any
  - logLevel: any
  - maxActiveSceneVolumeDiameter: any
  - maxConcurrentDownloads: any
  - maxDynamicClipDistance: any
  - maxGPUMemory: any
  - maxSRCCPUMemory: any
  - measurementAngularTolerance: any
  - measurementMaterialDensities: any
  - mouseInvertZoomingDirection: any
  - navigationMode: any
  - navigationSampling: any
  - navigationSpeedFactor: any
  - navigationSpeedThrottleFactor: any
  - notificationLogLevels: any
  - outlineColor: any
  - outlineColorOccluded: any
  - outlineInnerRadius: any
  - outlineOuterRadius: any
  - parentSelectEnabled: any
  - preSelectionColor: any
  - preferXHRWithCredentials: any
  - projectionType: any
  - renderAuxOnTop: any
  - renderMode: any
  - renderSetup: any
  - screenSpaceCoverageCalculationMethod: any
  - selectionColor: any
  - sessionDeviceTags: any
  - sessionForwardUrl: any
  - sessionInteractions: any
  - sessionMemberName: any
  - showAuxOnNavigation: any
  - silhouetteEffect: any
  - silhouetteEffectColor: any
  - silhouetteEffectExclusiveEnabled: any
  - skipSslVerify: any
  - smallFeatureCulling: any
  - smallFeaturePixelThreshold: any
  - snapshotContentSelection: any
  - soc: any
  - spacemouseMultiplier: any
  - ssaoEnabled: any
  - taaEnabled: any
  - topoGeometryColor: any
  - topoGeometrySecondaryColor: any
  - topoPointsEnabled: any
  - turntableLowerVerticalLimit: any
  - turntableUpperVerticalLimit: any
  - turntableVerticalLimitsEnabled: any
  - uriMap: any
  - useDevicePixelRatio: any
  - vertexColorsEnabled: any
  - viewPerspective: any
  - webglPreserveDrawingbuffer: any
  - xrEnableDebugImages: any
  - xrFusionMode: any
  - xrImageCompressionQuality: any
  - xrImageResolutionProfile: any
  - xrModelTrackerQualityThreshold: any
  - xrModelTrackerSmoothingFactor: any
Returns void

Inherited from SettingsAPI.importConfig

importSession

importSession(data, format?): Promise<any>
Imports a session from the data string of the given format. Supported formats are: JSON.
Parameters
- data: any
  
  the content of the file.
- Optional format: "xscn"
Returns Promise<any>

Inherited from SessionStorageAPI.importSession

importXRInitTemplate

importXRInitTemplate(template): Promise<void>
Experimental
Imports an initialization template for model-based tracking.

In a model-based tracking scenario, initialization templates are captured during the tracking process. This initialization data is linked to previously visited viewpoints along the traveled camera path. Once the tracking is lost the templates are used to quickly reinitialize from similar viewpoints without the user having to align the line model with the real object.

Once the initialization template data is imported, it will persist until enterXRInitMode with resetInitTemplate set to true is called.

This method is only available if the XR system has the SUPPORTS_MODEL_TRACKING capability.

The input data can be aquired via the exportXRInitTemplate method.
Parameters
- template: string
Returns Promise<void>
Returns a Promise which resolved when the operation was successful or rejects in an error case

Inherited from RealityAPI.importXRInitTemplate

invertEnabledStates

invertEnabledStates(): void
Inverts all enabled states.

Returns void

Inherited from InstanceGraphAPI.invertEnabledStates

invertSelection

invertSelection(silent?): Promise<ChangeSelectionResult>
Inverts the current Selection.
Parameters
- Optional silent: boolean
  
  If set to true, no event will be emitted.
Returns Promise<ChangeSelectionResult>

Inherited from SelectionAPI.invertSelection

isColorComparisonActive

isColorComparisonActive(): boolean
Checks if the color comparison mode is active.

Returns boolean
true if the color comparison mode is active, otherwise false.

Inherited from InteractionAPI.isColorComparisonActive

isNodeDeletable

isNodeDeletable(nodeID): boolean
Parameters
- nodeID: number
Returns boolean
Returns true if a Node is deletable.

Inherited from InstanceGraphAPI.isNodeDeletable

isNodePartOfEnabledLayers

isNodePartOfEnabledLayers(nodeID): Promise<boolean>
Returns true if the specified nodeID is part of an enabled Layer.
Parameters
- nodeID: number
  
  The nodeID which should be checked.
Returns Promise<boolean>

Inherited from LayerFilterAPI.isNodePartOfEnabledLayers

isNodePartOfEnabledVariant

isNodePartOfEnabledVariant(nodeId): Promise<boolean>
Parameters
- nodeId: number
  
  The ID of the Node.
Returns Promise<boolean>
True, if the Node is Part of an enabled Variant. False otherwise.

Inherited from VariantsAPI.isNodePartOfEnabledVariant

isNodeType

isNodeType(nodeID, nodeType): boolean
Parameters
- nodeID: number
- nodeType: NodeType
Returns boolean
Checks the Node's type for the given Node id.

Inherited from InstanceGraphAPI.isNodeType

isOfflineStorageAvailable

isOfflineStorageAvailable(): Promise<boolean>
Returns Promise<boolean>

Deprecated
isOfflineStorageAvailable is deprecated.

Checks if offline storage is currently available which can be used to transfer a session via transferSession.

Inherited from SessionStorageAPI.isOfflineStorageAvailable

isSelected

isSelected(nodeID): Promise<boolean>
Checks if the specified Node is part of the selection.
Parameters
- nodeID: number
  
  The ID of the node for which we would like to know if it is selected or not.
Returns Promise<boolean>
True of the given node is selected, otherwise false.

Inherited from SelectionAPI.isSelected

isTopologySelected

isTopologySelected(handle): boolean
Checks if the specified Topology Element is part of the current selection.
Parameters
- handle: TopologyHandle
  
  The topology element which should be checked if it selected.
Returns boolean
A boolean value which indicates if the specified Topology Element is part of the current selection or not.

Inherited from TopologyAPI.isTopologySelected

mapInternalToOriginalTopologyHandles

mapInternalToOriginalTopologyHandles(handles): Promise<OriginalTopologyHandle[]>
Maps the given webvis internal topology handles to original topology handles.
Parameters
- handles: TopologyHandle[]
  
  A list of webvis internal topology handles.
Returns Promise<OriginalTopologyHandle[]>
Promise<Array<OriginalTopologyHandle|undefined>> - A list of the corresponding original topology handles.

Inherited from TopologyAPI.mapInternalToOriginalTopologyHandles

mapOriginalToInternalTopologyHandles

mapOriginalToInternalTopologyHandles(nodeID, handles): Promise<TopologyHandle[]>
Maps the given original topology handles to webvis internal topology handles.
Parameters
- nodeID: number
  
  The Node which specifies the Part the topology relates to.
- handles: OriginalTopologyHandle[]
  
  A list of original topology handles.
Returns Promise<TopologyHandle[]>
Promise<Array<TopologyHandle|undefined>> - A list of the corresponding webvis internal topology handles.

Inherited from TopologyAPI.mapOriginalToInternalTopologyHandles

measureBetween

measureBetween(target0, target1): Promise<BetweenMeasurementResult>
Measures the distance and if possible the angle between two measurement targets.
Parameters
- target0: MeasurementTarget
  
  The first measurement target.
- target1: MeasurementTarget
  
  The second measurement target.
Returns Promise<BetweenMeasurementResult>
The result of the Measurement between the two specified targets.

Inherited from MeasurementAPI.measureBetween

measureTangent

measureTangent(topology, point): Promise<TangentMeasurementResult>
Measures the tangent of an edge at the specified point.
Parameters
- topology: {
  class: TOPOLOGY;
  value: TopologyHandle;
  }
  
  The topological target.
  - class: TOPOLOGY
    
    Describes the MeasurementTargetClass of the target.
  - value: TopologyHandle
    
    Describes the value of the target depending on the specified class.
- point: {
  class: POINT;
  value: [number, number, number];
  }
  
  The point target.
  - class: POINT
    
    Describes the MeasurementTargetClass of the target.
  - value: [number, number, number]
    
    Describes the value of the target depending on the specified class.
Returns Promise<TangentMeasurementResult>
The result of the tangent measurement.

Inherited from MeasurementAPI.measureTangent

measureThickness

measureThickness(topology, point): Promise<ThicknessMeasurementResult>
Measures the thickness of a shape at the specified point.
Parameters
- topology: {
  class: TOPOLOGY;
  value: TopologyHandle;
  }
  
  The topological target.
  - class: TOPOLOGY
    
    Describes the MeasurementTargetClass of the target.
  - value: TopologyHandle
    
    Describes the value of the target depending on the specified class.
- point: {
  class: POINT;
  value: [number, number, number];
  }
  
  The point target.
  - class: POINT
    
    Describes the MeasurementTargetClass of the target.
  - value: [number, number, number]
    
    Describes the value of the target depending on the specified class.
Returns Promise<ThicknessMeasurementResult>
The result of the thickness measurement.

Inherited from MeasurementAPI.measureThickness

performExplosion

performExplosion(explosionFactor): void
Performs the actual Explosion.
Parameters
- explosionFactor: number
  
  The value by which the parts are expanded.
Returns void

Inherited from ExplosionAPI.performExplosion

processInteractionInput

processInteractionInput(interactionData): void
Triggers an interaction on the current active interaction mode.
Parameters
- interactionData: InteractionData
  
  Definition of the triggered Interaction.
Returns void

Inherited from InteractionAPI.processInteractionInput

promoteSessionMember

promoteSessionMember(memberID): void
Parameters
- memberID: number
  
  The ID of the SessionMember.
Returns void

Deprecated
The whole SessionAPI is under consolidation and will be replaced in a future release.

Promotes a SessionMember to the Role of the Moderator.

Inherited from SessionAPI.promoteSessionMember

query

query(query, nodeID?): Promise<QueryResult>
Executes the query on the specified subtree
Parameters
- query: string | Query
- Optional nodeID: number
Returns Promise<QueryResult>

Inherited from QueryAPI.query

readSetting

readSetting<T>(setting): ContextSettingType<T>
Returns the value of a setting.
Type Parameters
- T extends string
Parameters
- setting: T
  
  The name of the setting that should be read
Returns ContextSettingType<T>
The value of the specified setting

Inherited from SettingsAPI.readSetting

registerCustomProperty

registerCustomProperty(name, defaultValue, recursive?): void
Registering a new custom property.
Parameters
- name: string
  
  The name of the new property.
- defaultValue: any
  
  Specifies the default value.
- Optional recursive: boolean
  
  Defines whether the property is recursive.
Returns void

Inherited from InstanceGraphAPI.registerCustomProperty

registerFrameListener

registerFrameListener(listener): void
Registers a listener function which get called once per internal update tick.
Parameters
- listener: FrameListener
  
  The listener to register.
Returns void

Inherited from FrameAPI.registerFrameListener

registerListener

registerListener<T>(eventTypes, listener, nodeID?, observeSubTree?): number
Registers the listener to the node with the matching nodeID and returns the id of the listener. The observeSubTree flag allows to observe the whole subtree under the respective node with the listener. With the eventTypes array, you can specify the types of events the listener should be reacting on. If an empty array is passed, the listener will react on all event types.
Type Parameters
- T extends WebVisEvent<T> = WebVisEvent
Parameters
- eventTypes: EventType[]
  
  The kind of events on which the event listener should listen.
- listener: IEventListener<T>
  
  The event listener.
- Optional nodeID: number
  
  The id of the node on which the event listener should be registered.
- Optional observeSubTree: boolean
  
  Indicates whether the event listener should also listen to events in all child nodes. This has an effect on NODE_* events only.
Returns number
The id of the event listener.

Inherited from EventAPI.registerListener

remove

remove(nodeID?, safe?): Promise<RemoveState>
Removes the Node for the given nodeID from the Scene and all related Snapshots. If no nodeID is supplied all Nodes are deleted.
Parameters
- Optional nodeID: number | number[]
  
  The id of the Node that should be removed.
- Optional safe: boolean
  
  Performs a safe remove which interrupt the removal process if the Node is part of one or more Snapshots.
Returns Promise<RemoveState>

Inherited from InstanceGraphAPI.remove

removeAnimationFrames

removeAnimationFrames(name): void
Removes an existing animation sequence.
Parameters
- name: string
  
  Specifies the name of the animation frames.
Returns void

Inherited from AnimationAPI.removeAnimationFrames

removeAnnotation

removeAnnotation(annotationId, safe?): RemoveState
Removes the Annotation from the scene and all related Snapshots.
Parameters
- annotationId: number
  
  The ID of the Annotation.
- Optional safe: boolean
  
  Performs a safe remove which interrupt the removal process if the Annotation is part of one or more Snapshots.
Returns RemoveState

Inherited from AnnotationAPI.removeAnnotation

removeAttachment

removeAttachment(attachmentID?, safe?): RemoveState
Removes the Attachment from the scene and all related Snapshots.
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
- Optional safe: boolean
  
  Performs a safe remove which interrupt the removal process if the Attachment is part of one or more Snapshots.
Returns RemoveState

Inherited from AttachmentAPI.removeAttachment

removeCapping

removeCapping(clipPlaneId): Promise<void>
Experimental
Removes the generated capping geometry.
Parameters
- clipPlaneId: number
  
  the id of the clip plane
Returns Promise<void>

Inherited from ClipPlaneAPI.removeCapping

removeClipPlane

removeClipPlane(clipPlaneId, safe?): RemoveState
Removes a clip room with the specified id.
Parameters
- clipPlaneId: number
  
  The id of the clip room you want to remove.
- Optional safe: boolean
  
  Performs a safe remove which interrupt the removal process if the ClipPlane is part of one or more Snapshots.
Returns RemoveState

Inherited from ClipPlaneAPI.removeClipPlane

removeClippingRoom

removeClippingRoom(safe?): RemoveState
Removes the clip room from the scene and all related Snapshots.
Parameters
- Optional safe: boolean
  
  Performs a safe remove which interrupt the removal process if the ClipRoom is part of one or more Snapshots.
Returns RemoveState

Inherited from ClipPlaneAPI.removeClippingRoom

removeCollection

removeCollection(collectionID): void
Parameters
- collectionID: number
Returns void

Inherited from CollectionAPI.removeCollection

removeDrawing

removeDrawing(drawingId, safe?): RemoveState
Removes a Drawing with the specified id. If a Drawing is part of a Snapshot the removal will fail with the State REFERENCED_BY_SNAPSHOT
Parameters
- drawingId: number
  
  The id of the to be removed Drawing.
- Optional safe: boolean
  
  Performs a safe remove which interrupt the removal process if the Drawing is part of one or more Snapshots.
Returns RemoveState

Inherited from DrawingAPI.removeDrawing

removeDrawingPlane

removeDrawingPlane(drawingPlaneId, safe?): RemoveState
Experimental
Removes a DrawingPlane with the specified ID. If a DrawingPlane is part of a Snapshot the removal will fail with the State REFERENCED_BY_SNAPSHOT.
Parameters
- drawingPlaneId: number
  
  The ID of the Drawing you want to remove.
- Optional safe: boolean
  
  Performs a safe remove which interrupt the removal process if the Drawing is part of one or more Snapshots.
Returns RemoveState

Inherited from DrawingPlaneAPI.removeDrawingPlane

removeFromCollection

removeFromCollection(collectionID, nodeID, recursive?): void
Removes a node given by nodeID from the collection with id collectionID. If recursive is true, the descendants of the node are also removed.
Parameters
- collectionID: number
  
  Specifies from which collection the node should be removed
- nodeID: number
  
  Specifies which node should be removed from the collection
- Optional recursive: boolean
  
  Specifies whether the children of the node should be removed from the collection too
Returns void

Inherited from CollectionAPI.removeFromCollection

removeFromSelection

removeFromSelection(nodeID, silent?): Promise<ChangeSelectionResult>
Removes the given nodes from the Selection
Parameters
- nodeID: number | number[]
  
  The ID of the Node that should be removed from the current Selection
- Optional silent: boolean
  
  If set to true, no event will be emitted.
Returns Promise<ChangeSelectionResult>

Inherited from SelectionAPI.removeFromSelection

removeMeasurement

removeMeasurement(measurementID, safe?): RemoveState
Removes the Measurement from the scene and all related Snapshots.
Parameters
- measurementID: number
- Optional safe: boolean
  
  Performs a safe remove which interrupt the removal process if the Measurement is part of one or more Snapshots.
Returns RemoveState

Inherited from MeasurementAPI.removeMeasurement

removeSessionMember

removeSessionMember(memberID): void
Parameters
- memberID: number
  
  The ID of the SessionMember.
Returns void

Deprecated
The whole SessionAPI is under consolidation and will be replaced in a future release.

Removes a SessionMember from a Session.

Inherited from SessionAPI.removeSessionMember

removeSnapshot

removeSnapshot(snapshotID): void
Deletes the Snapshot for given snapshotID.
Parameters
- snapshotID: number
Returns void

Inherited from SessionStorageAPI.removeSnapshot

removeTopologyFromSelection

removeTopologyFromSelection(handle): Promise<void>
Removes one or multiple Topology elements to the current selection.
Parameters
- handle: TopologyHandle | TopologyHandle[]
  
  A Topology Element or a list of Topology Elements which should be removed from the current selection.
Returns Promise<void>

Inherited from TopologyAPI.removeTopologyFromSelection

removeViewer

removeViewer(viewer): void
Removes a viewer element.
Parameters
- viewer: ViewerAPI
  
  The id of the viewer.
Returns void

requestActiveSceneVolume

requestActiveSceneVolume(): Promise<BoxVolume>
Returns the active volume of currently loaded scene.

Returns Promise<BoxVolume>
The active volume of currently loaded scene.

Inherited from InstanceGraphAPI.requestActiveSceneVolume

requestAnnotationData

requestAnnotationData(annotationId): Promise<AnnotationProperties>
Returns the AnnotationData for the specified Annotation id.
Parameters
- annotationId: number
  
  The id of the Annotation you want to request the data for.
Returns Promise<AnnotationProperties>
The requested Annotation data.

Inherited from AnnotationAPI.requestAnnotationData

requestAuxRootNodeIds

requestAuxRootNodeIds(scopeNodeId?): Promise<number[]>
Returns a list of all existing aux root Node ids below the specified subtree.
Parameters
- Optional scopeNodeId: number
  
  Specifies the top one Node id of the subtree to be searched.
Returns Promise<number[]>
A list of aux root Node ids.

Inherited from InstanceGraphAPI.requestAuxRootNodeIds

requestBoxDescriptor

requestBoxDescriptor(nodeIds): Promise<{
descriptor: TopologyBoxDescriptor;
type: BOX;
}>
Returns a Box descriptor by the specified list of Node Ids.
Parameters
- nodeIds: number[]
  
  List of Node Ids.
Returns Promise<{
descriptor: TopologyBoxDescriptor;
type: BOX;
}>
The Box descriptor for the given Node Ids.

Inherited from TopologyAPI.requestBoxDescriptor

requestClipPlaneData

requestClipPlaneData(clipPlaneId): Promise<ClipPlaneProperties>
Returns the ClipPlaneData for the specified clip plane id.
Parameters
- clipPlaneId: number
  
  The id of the clip plane you want to request the data for.
Returns Promise<ClipPlaneProperties>
The requested clip plane data.

Inherited from ClipPlaneAPI.requestClipPlaneData

requestClipRoomData

requestClipRoomData(): Promise<ClipRoomProperties>
Returns the ClipRoomData.

Returns Promise<ClipRoomProperties>
The requested clip room data.

Inherited from ClipPlaneAPI.requestClipRoomData

requestDrawingData

requestDrawingData(drawingId): Promise<DrawingData>
Returns the DrawingData for the specified Drawing id.
Parameters
- drawingId: number
  
  The id of the Drawing from which the data is requested.
Returns Promise<DrawingData>
The requested Drawing data.

Inherited from DrawingAPI.requestDrawingData

requestFullSceneVolume

requestFullSceneVolume(): Promise<BoxVolume>
Returns the full volume of currently loaded scene.

Returns Promise<BoxVolume>
- The full volume of currently loaded scene.
Inherited from InstanceGraphAPI.requestFullSceneVolume

requestHubVersion

requestHubVersion(): Promise<string>
Returns Promise<string>
The current version of the connected instant3Dhub. May return undefined for older versions.

Inherited from HubAPI.requestHubVersion

requestL3DInformation

requestL3DInformation(targetNodeId): Promise<any>
Returns the L3D information of the specified Node.
Parameters
- targetNodeId: number
  
  Specifies the target Node id.
Returns Promise<any>
The L3D information of the specified Node

Inherited from InstanceGraphAPI.requestL3DInformation

requestMeasurementData

requestMeasurementData(measurementID): Promise<MeasurementProperties>
Returns the MeasurementProperties for the specified Measurement id.
Parameters
- measurementID: number
  
  The id of the Measurement you want to request the data for.
Returns Promise<MeasurementProperties>
The requested Measurement properties.

Inherited from MeasurementAPI.requestMeasurementData

requestNodeIdsByBoxVolume

requestNodeIdsByBoxVolume(boxVolume, includeOverlappingNodes?, includeDisabledNodes?, forceExpand?, scopeNodeId?): Promise<number[]>
Returns a List of all Node ids which are included or overlapped by the specified 3D world space Bounding Volume.
Parameters
- boxVolume: BoxVolume
  
  Specifies the 3D world space Bounding Volume.
- Optional includeOverlappingNodes: boolean
  
  Specifies that the result should include Nodes which overlap the specified 3D world space Bounding Volume as well.
- Optional includeDisabledNodes: boolean
  
  Specifies that the result should include Nodes which are disabled as well.
- Optional forceExpand: boolean
- Optional scopeNodeId: number
  
  Specifies the top one Node id of the subtree to be searched.
Returns Promise<number[]>
List of all NodeIds which are included or overlapped by the specified 3D world space Bounding Volume.

Inherited from InstanceGraphAPI.requestNodeIdsByBoxVolume

requestNodePathHandleMap

requestNodePathHandleMap(paths, scope?): Promise<NodePathHandleMap>
requestNodePathHandleMap Returns an object mapping from input paths to the respective handles.
Parameters
- paths: string[]
  
  {Array<string | NodePathHandle>} The array of node path strings or handles.
- Optional scope: number
  
  {number} [scope=0] nodeID specifying the scope as starting point for the paths
Returns Promise<NodePathHandleMap>
The resulting object mapping paths to handles

Inherited from NodePathAPI.requestNodePathHandleMap

requestNodePathStrings

requestNodePathStrings(handles, scope?, typePriorities?): Promise<string[]>
requestNodePathStrings Returns string representations for the respective node path handles.
Parameters
- handles: NodePathHandle[]
  
  {Array}
- Optional scope: number
  
  {number} nodeID specifying the scope as starting point for the path resolution
- Optional typePriorities: NodePathFragmentType[]
  
  {Array} Array of priorities to control the fragments for the path string assembly.
Returns Promise<string[]>
String representation of the node path for the respective scope.

Inherited from NodePathAPI.requestNodePathStrings

requestRootNodeIds

requestRootNodeIds(scopeNodeId?, recursive?): Promise<number[]>
Returns a list of all existing root Node ids below the specified subtree.
Parameters
- Optional scopeNodeId: number
  
  Specifies the top one Node id of the subtree to be searched.
- Optional recursive: boolean
  
  Specifies if the subtree is traversed recursively.
Returns Promise<number[]>
A list of root Node ids.

Inherited from InstanceGraphAPI.requestRootNodeIds

requestServiceStates

requestServiceStates(): Promise<Map<ServiceType, ServiceState>>
Returns Promise<Map<ServiceType, ServiceState>>
All current state of all available Services.

Inherited from HubAPI.requestServiceStates

requestSnapshotData

requestSnapshotData(snapshotID): Promise<void | SnapshotProperties>
Parameters
- snapshotID: number
Returns Promise<void | SnapshotProperties>
The data of the specified Snapshot.

Inherited from SessionStorageAPI.requestSnapshotData

requestSupportedContentTypes

requestSupportedContentTypes(): Promise<ContentType[]>
Returns Promise<ContentType[]>
All supported data formats.

Inherited from HubAPI.requestSupportedContentTypes

requestSupportedRenderSetups

requestSupportedRenderSetups(): Promise<{
name: string;
value: string;
}[]>
Returns Promise<{
name: string;
value: string;
}[]>
All supported render setups.

Inherited from HubAPI.requestSupportedRenderSetups

requestTopologyDescriptor

requestTopologyDescriptor(handle): Promise<TopologyDescriptor>
Returns a detailed description of the Topology Element.
Parameters
- handle: TopologyHandle
  
  The Topology Element.
Returns Promise<TopologyDescriptor>
The detailed description of the Topological Element.

Inherited from TopologyAPI.requestTopologyDescriptor

requestVariants

requestVariants(nodeId): Promise<VariantProperties[]>
Parameters
- nodeId: number
  
  The ID of the Node.
Returns Promise<VariantProperties[]>
The Variant(s) for a given nodeID.

Inherited from VariantsAPI.requestVariants

requestXRDeviceScreenshot

requestXRDeviceScreenshot(): Promise<string>
Experimental
Request a screenshot of the webview's content inside the native XR device application.

Returns Promise<string>
Returns a Promise which contains the base64 encoded image data when the operation was successful or rejects in an error case.

Inherited from RealityAPI.requestXRDeviceScreenshot

resetInteractionMode

resetInteractionMode(keepColorCompareActive?): void
Sets the current interaction mode back to the Default mode.
Parameters
- Optional keepColorCompareActive: boolean
  
  Specifies if the color comparison mode should stay active. (Default: false)
Returns void

Inherited from InteractionAPI.resetInteractionMode

resetProperties

resetProperties<T>(nodeID, properties, recursive?): Promise<void>
Resets the value of the specified properties on the given Node.
Type Parameters
- T extends string
Parameters
- nodeID: number
  
  The id of the Node whose property should be reset.
- properties: T[]
  
  List of properties which should be reset.
- Optional recursive: boolean
  
  If set to true, the properties are reset recursively.
Returns Promise<void>

Inherited from InstanceGraphAPI.resetProperties

resetProperty

resetProperty<T>(nodeID, property, recursive?): Promise<void>
Resets the value of the property on the Node with the matching id.
Type Parameters
- T extends string
Parameters
- nodeID: number
  
  The id of the Node whose property should be reset.
- property: T
  
  Property which should be reset.
- Optional recursive: boolean
  
  If set to true, the properties are reset recursively.
Returns Promise<void>

Inherited from InstanceGraphAPI.resetProperty

resetSetting

resetSetting(setting): void
Resets the value of a setting to the installation default.
Parameters
- setting: ViewerSettingStrings | SettingStrings
  
  The name of the setting that should be reset.
Returns void

Inherited from SettingsAPI.resetSetting

resetUserSettings

resetUserSettings(): void
Returns void

Inherited from SettingsAPI.resetUserSettings

restoreSession

restoreSession(handle): Promise<void>
Restores a Session for the given access handle from the infrastructure.
Parameters
- handle: string
Returns Promise<void>

Inherited from SessionStorageAPI.restoreSession

restoreSnapshot

restoreSnapshot(snapshotID, options?): Promise<void>
Restores the Snapshot for the given snapshotID. The settings parameter allows to control the subset of the Snapshot data to be restored.
Parameters
- snapshotID: number
- Optional options: SnapshotRestoreOptions
Returns Promise<void>

Inherited from SessionStorageAPI.restoreSnapshot

searchByVolume

searchByVolume(selectionBox, includeOverlappingNodes, rootNodeID?): Promise<number>
Finds nodes within the given BoxVolume (created using the createBoxVolume() function). If includeOverlappingNodes is false, only nodes fully contained by the box volume are returned. The rootNodeID specifies the node from which the subtree is searched.
Parameters
- selectionBox: BoxVolume
  
  3-dimensional search volume.
- includeOverlappingNodes: boolean
  
  Specifies whether the search result contains only those nodes which lie entirely in the search volume or if overlapping nodes are also included.
- Optional rootNodeID: number
  
  Restricts the search to a subtree of a node with the given id.
Returns Promise<number>
A the id of the created collection of nodes that are fitting the given search criteria.

Inherited from CollectionAPI.searchByVolume

seekXRPlayback

seekXRPlayback(frameIndex): Promise<void>
Experimental
Jump to the frame with the specified index in the playback sequence. To get the total amount of frames in the sequence, see XRPlaybackProperties and getXRPlaybackProperties method.

Triggers a XRPlaybackStateChangedEvent.
Parameters
- frameIndex: number
  
  The index of the frame to jump to
Returns Promise<void>
Returns a Promise which reports wether the operation was successful or not

Inherited from RealityAPI.seekXRPlayback

selectCollection

selectCollection(collectionID, silent?): Promise<void | ChangeSelectionResult>
Replaces the current Selection with the Nodes from the given Collection.
Parameters
- collectionID: number
  
  The ID of the Collection.
- Optional silent: boolean
  
  If set to true, no event will be emitted.
Returns Promise<void | ChangeSelectionResult>

Inherited from SelectionAPI.selectCollection

setAttachmentData

setAttachmentData<T>(attachmentID?, data?): void
Sets the attachment data.
Type Parameters
- T = any
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
- Optional data: T
  
  The new attachment data.
Returns void

Inherited from AttachmentAPI.setAttachmentData

setAttachmentDataURI

setAttachmentDataURI(attachmentID?, dataURI?): void
Sets the attachment data URI.
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
- Optional dataURI: string
  
  The attachment data URI.
Returns void

Inherited from AttachmentAPI.setAttachmentDataURI

setInteractionMode

setInteractionMode(mode, keepColorCompareActive?): void
Set the current interaction mode.
Parameters
- mode: string | string[]
  
  Specifies the interaction mode you want set.
- Optional keepColorCompareActive: boolean
  
  Specifies if the color comparison mode should stay active. (Default: false)
Returns void

Deprecated
Calling setInteractionMode with the mode parameter of type string or string[] is deprecated, please use the InteractionMode enum instead.

Inherited from InteractionAPI.setInteractionMode
setInteractionMode(mode, keepColorCompareActive?): void
Set the current interaction mode.
Parameters
- mode: InteractionMode
  
  Specifies the interaction mode you want set.
- Optional keepColorCompareActive: boolean
  
  Specifies if the color comparison mode should stay active. (Default: false)
Returns void

Inherited from InteractionAPI.setInteractionMode

setLayerFilterEnabled

setLayerFilterEnabled(name, enabled): SetLayerFilterEnabledResult
Sets layers to enabled whose names are in the array of names.
Parameters
- name: string
  
  The name of the LayerFilter
- enabled: boolean
  
  The new enabled state.
Returns SetLayerFilterEnabledResult

Inherited from LayerFilterAPI.setLayerFilterEnabled

setParent

setParent(nodeID, newParentID): void
Parameters
- nodeID: number
- newParentID: number
Returns void

Inherited from InstanceGraphAPI.setParent

setProperty

setProperty<T>(nodeID, property, value, silent?): Promise<void>
Sets the property named property to value on the Node with id nodeID.
Type Parameters
- T extends string
Parameters
- nodeID: number | number[]
  
  The id of the Node whose property has to be set.
- property: T
  
  The name of the property that has to be set.
- value: PropertyType<T>
  
  The new value of the specified property.
- Optional silent: boolean
  
  The silent flag indicates that no NODE_CHANGED event is fired.
Returns Promise<void>

Inherited from InstanceGraphAPI.setProperty

setSelection

setSelection(nodeID, silent?): Promise<ChangeSelectionResult>
Replaces the current Selection with the specified nodes.
Parameters
- nodeID: number | number[]
  
  The nodeID(s) to select.
- Optional silent: boolean
  
  If set to true, no event will be emitted.
Returns Promise<ChangeSelectionResult>

Inherited from SelectionAPI.setSelection

setTopologyProperty

setTopologyProperty<T>(handle, property, value): Promise<PromiseSettledResult<void>[]>
Sets a Property of one or multiple Topology Elements.
Type Parameters
- T extends keyof TopologyPropertyTypeMap
Parameters
- handle: TopologyHandle | TopologyHandle[]
- property: T
  
  The property which should be set.
- value: TopologyPropertyTypeMap[T]
Returns Promise<PromiseSettledResult<void>[]>

Inherited from TopologyAPI.setTopologyProperty

setTopologySelection

setTopologySelection(handle): Promise<void>
Selects the specified Topology Elements.
Parameters
- handle: TopologyHandle | TopologyHandle[]
  
  A Topology Element or a list of Topology Elements to select.
Returns Promise<void>

Inherited from TopologyAPI.setTopologySelection

setVariantEnabled

setVariantEnabled(variant, enabled): Promise<void>
Enables or disables a given Variant.
Parameters
- variant: number
  
  The ID of the Variant.
- enabled: boolean
  
  The enabled state.
Returns Promise<void>

Inherited from VariantsAPI.setVariantEnabled

setXRPlaybackBoomerang

setXRPlaybackBoomerang(boomerang): Promise<void>
Experimental
Specify whether the playback should "boomerang" (play forward and backward in a loop). This is useful for creating a seamless transition at the end of a sequence in terms of pose updates.
Parameters
- boomerang: boolean
  
  Whether the playback should boomerang or not
Returns Promise<void>
Returns a Promise which reports whether the operation was successful or not

Inherited from RealityAPI.setXRPlaybackBoomerang

setXRPlaybackFrameRange

setXRPlaybackFrameRange(startFrame, endFrame): Promise<number>
Experimental
Sets the frame range to play back. The total amount of frames in a sequence can be found in the XRPlaybackProperties.

Triggers a XRPlaybackStateChangedEvent.
Parameters
- startFrame: number
  
  The index of the first frame to play back
- endFrame: number
  
  The index of the last frame to play back
Returns Promise<number>
Returns a Promise which resolves with the new amount of frames in the playback if successful and rejects otherwise

Inherited from RealityAPI.setXRPlaybackFrameRange

setXRPlaybackSource

setXRPlaybackSource(url): Promise<number>
Experimental
Set the URL pointing to the manifest.json file of the frame sequence to be played back.

Triggers a XRPlaybackStateChangedEvent.
Parameters
- url: string
  
  The URL of the frame sequence
Returns Promise<number>
Returns a Promise which resolves with the amount of frames in the playback if successful and rejects otherwise

Inherited from RealityAPI.setXRPlaybackSource

setXRPlaybackSpeed

setXRPlaybackSpeed(speed): void
Experimental
Set the desired playback speed. The specified speed must be a value between 0 and 1. It gives the playback speed as a fraction of the original FPS which is stored in the XRPlaybackProperties.

Triggers a XRPlaybackStateChangedEvent.
Parameters
- speed: number
  
  The desired playback speed. Must be a value between 0 and 1.
Returns void

Inherited from RealityAPI.setXRPlaybackSpeed

showXRBackgroundFeed

showXRBackgroundFeed(): Promise<void>
Experimental
Starts putting the image feed into the viewer's background. Also see hideXRBackgroundFeed.

This will trigger a XRStateChangedEvent with backgroundFeedVisible set to true.

Returns Promise<void>
Returns a Promise which resolved when the operation was successful or rejects in an error case

Inherited from RealityAPI.showXRBackgroundFeed

shutdownSession

shutdownSession(): Promise<void>
Returns Promise<void>

Deprecated
The whole SessionAPI is under consolidation and will be replaced in a future release.

Shuts down a Session and disconnects all joined SessionMembers.

Inherited from SessionAPI.shutdownSession

startXRPlayback

startXRPlayback(): void
Experimental
Start the XR playback.

Make sure to set the playback source before starting the playback. Triggers a XRPlaybackStateChangedEvent.

Returns void

Inherited from RealityAPI.startXRPlayback

startXRSpectate

startXRSpectate(sessionMemberId): Promise<void>
Experimental
Starts spectating the XRImage stream published by the session member with the specified ID within a shared session. This will also hide any other background feed that is currently shown.
Parameters
- sessionMemberId: number
  
  The session member id of the member to spectate
Returns Promise<void>
Returns a promise which resolves when the operation was successful or rejects in an error case

Inherited from RealityAPI.startXRSpectate

stopXRPlayback

stopXRPlayback(): void
Experimental
Stop the XR playback.

Triggers a XRPlaybackStateChangedEvent.

Returns void

Inherited from RealityAPI.stopXRPlayback

stopXRSpectate

stopXRSpectate(): void
Experimental
Stops spectating the currently spectated XRImage stream of a session member.

Returns void

Inherited from RealityAPI.stopXRSpectate

storeSession

storeSession(): Promise<string | void>
Temporarily stores the Session in the connected hub instance and returns an access handle. This function does not transfer Caches of referenced resources to the connected hub instance. For that, see transferSession.

Returns Promise<string | void>
The access handle of the stored Session.

Inherited from SessionStorageAPI.storeSession

transferSession

transferSession(progressCallback): Promise<string | void>
Experimental
Parameters
- progressCallback: StoreSessionProgressCallback
  
  Can be used to track the progress of the transfer.
Returns Promise<string | void>
The access handle of the transferred Session.

Deprecated
transferSession with progress callback is deprecated. Please use transferSession without parameters and utilize the returned Promise instead!

Temporarily stores the Session in the connected hub instance and returns an access handle. Transfers Caches of referenced resources to the connected hub instance if they are not already present.

Inherited from SessionStorageAPI.transferSession
transferSession(): Promise<string | void>
Experimental
Temporarily stores the Session in the connected hub instance and returns an access handle. Transfers Caches of referenced resources to the connected hub instance if they are not already present.

Returns Promise<string | void>
The access handle of the transferred Session.

Inherited from SessionStorageAPI.transferSession

unanchorXR

unanchorXR(): void
Experimental
Unanchors the model. This will have the effect that the model will no longer be anchored to the real world.

This will trigger a XRStateChangedEvent with anchored set to false.

Returns void

Inherited from RealityAPI.unanchorXR

unregisterFrameListener

unregisterFrameListener(listener): void
Unregisters a previously registered listener via registerFrameListener.
Parameters
- listener: FrameListener
  
  The listener to unregister.
Returns void

Inherited from FrameAPI.unregisterFrameListener

unregisterListener

unregisterListener(listenerID): void
Removes the listener for the given listenerID.
Parameters
- listenerID: number
  
  The id of the event listener that should be unregistered.
Returns void

Inherited from EventAPI.unregisterListener

waitFor

waitFor(state): Promise<void>
Register a callback to a specific state. The callback is executed once when the state is reached. If webVis is already in that state the callback is triggered immediately.
Parameters
- state: ContextState
  
  The state for which a callback is registered
Returns Promise<void>
A promise which throws an error if the requested state is invalid

The following states are allowed as target init - Is reached when webVis is fully configured and set up.
resourceStateUpdated - Is reached when there is state information available for all resources (This information can also be "still transcoding").
resourceProcessed - This is triggered when all resources are done transcoding.
renderingFinished - This is triggered when webVis is done with rendering. So no more image changes are imminent.

Inherited from ContextStateAPI.waitFor

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

This page needs code samples
Code samples do not work
Information is missing
Please tell us more about what's wrong:
Information is incorrect
Please tell us more about what's wrong:
Information is unclear or confusing
Please tell us more about what's wrong:
The page is rendered incorrectly (styling/CSS)
Give Feedback

ContextAPI#

Interface ContextAPI

Hierarchy

Index

Methods

Methods

add

Parameters

options: AddNodeOptions

Returns number

Parameters

dataURI: string

Optional parentID: number

Optional usage: UsageString

Optional label: string

Optional contentType: string

Optional initialProperties: InitialNodeProperties

Optional cacheStrategy: CacheStrategy

Returns number

Deprecated

addCustomNode

Parameters

customNodeType: string

data: any

Optional dataType: AttachmentType

Returns number

addToCollection

Parameters

collectionID: number

nodeID: number

Optional recursive: boolean

Returns void

addToSelection

Parameters

nodeID: number | number[]

Optional silent: boolean

Returns Promise<ChangeSelectionResult>

addTopologyToSelection

Parameters

handle: TopologyHandle | TopologyHandle[]

Returns Promise<void>

anchorXR

Returns void

changeAnnotation

Parameters

annotationId: number

properties: AnnotationProperties

Returns AnnotationProperties

Parameters

annotationID: number

Optional label: string

Optional visible: boolean

Optional anchorPosition: number[] | Float32Array

Optional labelPosition: number[] | Float32Array

Optional active: boolean

Optional transform: number[] | Float32Array

Returns void

Deprecated

changeClipPlane

Parameters

clipPlaneId: number

properties: ClipPlaneProperties

Returns ClipPlaneProperties

Parameters

clipPlaneID: number

Optional normal: number[] | Float32Array

Optional point: number[] | Float32Array

Optional name: string

Optional thickness: number

Optional tangent: number[] | Float32Array

Optional disabled: boolean

Optional invisible: boolean

Optional exclusive: boolean

Returns void

Deprecated

changeClippingRoom

Parameters

Optional properties: ClipRoomProperties

Returns ClipRoomProperties

Parameters

`Optional` parentID: number

`Optional` usage: UsageString

`Optional` label: string

`Optional` contentType: string

`Optional` initialProperties: InitialNodeProperties

`Optional` cacheStrategy: CacheStrategy

`Optional` dataType: AttachmentType

`Optional` recursive: boolean

`Optional` silent: boolean

`Optional` label: string

`Optional` visible: boolean

`Optional` anchorPosition: number[] | Float32Array

`Optional` labelPosition: number[] | Float32Array

`Optional` active: boolean

`Optional` transform: number[] | Float32Array

`Optional` normal: number[] | Float32Array

`Optional` point: number[] | Float32Array

`Optional` name: string

`Optional` thickness: number

`Optional` tangent: number[] | Float32Array

`Optional` disabled: boolean

`Optional` invisible: boolean

`Optional` exclusive: boolean

`Optional` properties: ClipRoomProperties

`Optional` name: string

`Optional` size: number[] | Float32Array

`Optional` transformation: number[] | Float32Array

`Optional` disabled: boolean

`Optional` invisible: boolean

`Optional` name: string

`Optional` screenshotURL: string

`Optional` order: number

`Optional` silent: boolean

`Optional` subType: string

`Optional` sessionID: string

`Optional` name: string