ContextAPI¶

Interface ContextAPI

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

Hierarchy

Index

Methods

add addCustomNode addToCollection addToSelection addTopologyToSelection changeAnnotation changeClipPlane changeClippingRoom changeDrawing changeMeasurement changeSetting changeSnapshot clearSelection clearTopologySelection clipOtherParts collectRuntimeNodesOfType connectToSession connectXRSession createAnimationFrames createAnnotation createAttachment createBoxVolume createCapping createClipPlane createClippingRoom createCollection createDrawing createExplosion createMeasurement createNodePathHandles createSnapshot createViewer disableCapping disconnectFromSession enableCapping endExplosion enterXRMemberInitMode exitXRMemberInitMode fetchAttachmentData fixateXRMember getAnnotationData getAnnotations getAttachmentData getAttachmentDataURI getClipPlanes getClipRoom getCollection getCollectionElements getCollectionNodeCount getDrawings getEnabledAuxNodes getEnabledLayerFilters getInteractionMode getMeasurementData getMeasurements getMetadata getName getProperties getProperty getRegisteredLayerFilters getRootNodeId getSelectedLeafNodes getSelectedNodes getSelectedTopologyHandles getSelection getSessionMemberID getSessionMembers getSessionStateData getSnapshotData getSnapshots getStatistics getTopologyType getViewer getViewers getXRMemberInfo getXRMemberState getXRMembers getXRSessionState importConfig importSession invertEnabledStates invertSelection isColorComparisonActive isNodeDeletable isNodePartOfEnabledLayers isNodePartOfEnabledVariant isNodeType isOfflineStorageAvailable isSelected isTopologySelected mapInternalToOriginalTopologyHandles mapOriginalToInternalTopologyHandles measureTangent performExplosion processInteractionInput promoteSessionMember query readSetting registerCustomProperty registerFrameListener registerListener remove removeAnimationFrames removeAnnotation removeAttachment removeCapping removeClipPlane removeClippingRoom removeCollection removeDrawing removeFromCollection removeFromSelection removeMeasurement removeSessionMember removeSnapshot removeTopologyFromSelection removeViewer requestActiveSceneVolume requestAdditionalMeasurementData requestAuxRootNodeIds requestClipPlaneData requestClipRoomData requestDrawingData requestFullSceneVolume requestL3DInformation requestNodeIdsByBoxVolume requestNodePathHandleMap requestNodePathStrings requestRootNodeIds requestSnapshotData requestSupportedContentTypes requestSupportedRenderSetups requestVariants requestXMemberCapabilities resetAR resetInteractionMode resetProperties resetProperty resetSetting resetUserSettings restoreMeasurement restoreSession restoreSnapshot searchByVolume selectCollection setAttachmentData setAttachmentDataURI setInteractionMode setLayerFilterEnabled setParent setProperty setSelection setTopologyProperty setTopologySelection setVariantEnabled setXRMemberSettings showExpertDialog shutdownSession startAR startXRMemberSpectate stopAR stopXRMemberSpectate storeSession unfixateXRMember unregisterFrameListener unregisterListener waitFor

Methods

add

add(dataURI: string, parentID?: number, usage?: UsageString, label?: string, contentType?: string, initialProperties?: { [key: string]: any }, cacheStrategy?: CacheStrategy): number
Loads the resource behind the given dataURI and returns the id of the new contents root Node.
Parameters
- dataURI: string
  
  Specifies the URI of the data resource.
- Optional parentID: number
  
  By specifying a parentID the resource can be added to an arbitrary Node instead of the tree root.
- Optional usage: UsageString
  
  The usage parameter allows to define how the resource should be inserted in the InstanceGraph.
- Optional label: string
  
  The label can be used to set a string that is shown in the UI as a name of the Node.
- Optional contentType: string
  
  With contentType the type of the input data can be specified with a MimeType or any other descriptor.
- Optional initialProperties: { [key: string]: any }
  
  A map of properties to initialize the new Node.
  - [key: string]: any
- Optional cacheStrategy: CacheStrategy
  
  Defines the strategy which is used when a data cache is requested from the Hub.
Returns number
The id of the new contents root Node

Inherited from InstanceGraphAPI.add
add(params: { [key: string]: any }): number
Variant of the add function, accepting a params object instead of explicit parameters. The params object is a map from parameter names to parameter values.
Parameters
- params: { [key: string]: any }
  
  The params object.
  - [key: string]: any
Returns number

Inherited from InstanceGraphAPI.add

addCustomNode

addCustomNode(customNodeType: string, data: any, dataType?: AttachmentType): 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: number, nodeID: number, recursive?: boolean): 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: number | number[], silent?: boolean): 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: TopologyHandle | TopologyHandle[]): 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

changeAnnotation

changeAnnotation(annotationID: number, label?: string, visible?: boolean, anchorPosition?: Float32Array | number[], labelPosition?: Float32Array | number[], active?: boolean, transform?: Float32Array | number[]): void
Changes an annotation.
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: Float32Array | number[]
  
  Anchor position in world space coordinates.
- Optional labelPosition: Float32Array | number[]
  
  The position of the label.
- Optional active: boolean
  
  DEPRECATED
- Optional transform: Float32Array | number[]
  
  The transformation of the annotation.
Returns void

Inherited from AnnotationAPI.changeAnnotation

changeClipPlane

changeClipPlane(clipPlaneId: number, properties: ClipPlaneProperties): 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: number, normal?: Float32Array | number[], point?: Float32Array | number[], name?: string, thickness?: number, tangent?: Float32Array | number[], disabled?: boolean, invisible?: boolean, exclusive?: boolean): void
Changes the properties of the clip plane defined by the clipPlaneID with the optional parameters normal, points and name.

Deprecated
Calling changeClipPlane with single parameters is deprecated, please use ClipPlaneProperties instead.
Parameters
- clipPlaneID: number
  
  The ID of an existing clip plane which should be changed
- Optional normal: Float32Array | number[]
  
  The new normal of the clip plane
- Optional point: Float32Array | number[]
  
  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: Float32Array | number[]
  
  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

Inherited from ClipPlaneAPI.changeClipPlane

changeClippingRoom

changeClippingRoom(properties?: ClipRoomProperties): ClipRoomProperties
Changes one or more properties of a clip room with the specified id.
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?: string, size?: Float32Array | number[], transformation?: Float32Array | number[], disabled?: boolean, invisible?: boolean): ClipRoomProperties
Deprecated
Calling changeClippingRoom with single parameters is deprecated, please use ClipRoomProperties instead.

Changes one or more properties of a clip room with the specified id.
Parameters
- Optional name: string
  
  The name of the clip room.
- Optional size: Float32Array | number[]
  
  The size of the clip room.
- Optional transformation: Float32Array | number[]
  
  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.

Inherited from ClipPlaneAPI.changeClippingRoom

changeDrawing

changeDrawing(drawingId: number, properties: DrawingProperties): 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

changeMeasurement

changeMeasurement(measurementID: number, progress: MeasurementProgress, visible?: boolean, name?: string): void
Parameters
- measurementID: number
- progress: MeasurementProgress
- Optional visible: boolean
- Optional name: string
Returns void

Inherited from MeasurementAPI.changeMeasurement

changeSetting

changeSetting<T>(setting: T, value: ContextSettingType<T>): 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: number, properties: SnapshotProperties): 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: number, name?: string, screenshotURL?: string, order?: number): SnapshotProperties
This changes the textual description of the Snapshot for given snapshotID to the value of text.

Deprecated
Calling changeSnapshot with single parameters is deprecated, please use SnapshotProperties instead.
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
Returns SnapshotProperties

Inherited from SessionStorageAPI.changeSnapshot

clearSelection

clearSelection(silent?: boolean): 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: number | number[]): 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: NodeType, subType?: string): 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?: string, name?: string): Promise<SessionStateData>
Connects to a Session. If the ID does not exist, a new Session will be created.
Parameters
- Optional sessionID: string
  
  The ID of the Session.
- Optional name: string
  
  The ID of the Session.
Returns Promise<SessionStateData>

Inherited from SessionAPI.connectToSession

connectXRSession

connectXRSession(): Promise<XRSessionState>
Experimental

Returns Promise<XRSessionState>
returns a Promise

Inherited from RealityAPI.connectXRSession

createAnimationFrames

createAnimationFrames(name: string, frames: AnimationFrame[]): 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(nodeID: number, label: string, visible?: boolean, anchorPosition?: Float32Array | number[], labelOffset?: Float32Array | number[]): number
Creates a new annotation.
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: Float32Array | number[]
  
  Anchor position in world space coordinates.
- Optional labelOffset: Float32Array | number[]
  
  The offset between anchorPosition and where the label should be displayed.
Returns number
The ID of the new annotation.

Inherited from AnnotationAPI.createAnnotation

createAttachment

createAttachment(dataType?: AttachmentType): 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?: [number, number, number], max?: [number, number, number]): 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: number): 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

createClipPlane

createClipPlane(properties?: ClipPlaneProperties): 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?: Float32Array | number[], point?: Float32Array | number[], name?: string, thickness?: number, tangent?: Float32Array | number[], disabled?: boolean, invisible?: boolean, exclusive?: boolean): 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.

Deprecated
Calling createClipPlane with single parameters is deprecated, please use ClipPlaneProperties instead.
Parameters
- Optional normal: Float32Array | number[]
  
  The normal of the clip plane
- Optional point: Float32Array | number[]
  
  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: Float32Array | number[]
  
  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

Inherited from ClipPlaneAPI.createClipPlane

createClippingRoom

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

Inherited from ClipPlaneAPI.createClippingRoom
createClippingRoom(name?: string, size?: Float32Array | number[], transformation?: Float32Array | number[], disabled?: boolean, invisible?: boolean): void
Deprecated
Calling createClippingRoom with single parameters is deprecated, please use ClipRoomProperties instead.

Creates a new clip room.
Parameters
- Optional name: string
  
  The name of the clip room.
- Optional size: Float32Array | number[]
  
  The size of the clip room.
- Optional transformation: Float32Array | number[]
  
  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

Inherited from ClipPlaneAPI.createClippingRoom

createCollection

createCollection(nodeIDlist?: number[]): 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: ViewerDrawingResult, properties?: DrawingProperties): 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

createExplosion

createExplosion(centerNodeID?: number): 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(type: MeasurementType, clickResult1: IClickResult, clickResult2?: IClickResult, name?: string): number
Creates a new measurement and returns the ID. If no name is given, the measurement will be automatically named (e.g., “Measurement 23”).
Parameters
- type: MeasurementType
- clickResult1: IClickResult
- Optional clickResult2: IClickResult
- Optional name: string
Returns number

Inherited from MeasurementAPI.createMeasurement

createNodePathHandles

createNodePathHandles(targets: number[]): 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

createSnapshot

createSnapshot(name?: string, options?: SnapshotCreationOptions): 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?: string, canvas?: HTMLCanvasElement, 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; 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; gizmoScalingFactor: any; gizmosEnabled: any; gpuMemoryReleaseFactor: 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; preSelectionColor: any; projectionType: any; renderAuxOnTop: any; renderMode: any; renderServiceCanvasRatio: any; renderSetup: any; screenSpaceCoverageCalculationMethod: any; selectionColor: any; showAuxOnNavigation: any; silhouetteEffect: any; silhouetteEffectColor: any; silhouetteEffectExclusiveEnabled: any; smallFeatureCulling: any; smallFeaturePixelThreshold: any; soc: any; spacemouseMultiplier: any; topoGeometryColor: any; topoGeometrySecondaryColor: any; topoPointsEnabled: any; turntableLowerVerticalLimit: any; turntableUpperVerticalLimit: any; turntableVerticalLimitsEnabled: any; useDevicePixelRatio: any; vertexColorsEnabled: any; viewPerspective: any; webglPreserveDrawingbuffer: any }): 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; 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; gizmoScalingFactor: any; gizmosEnabled: any; gpuMemoryReleaseFactor: 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; preSelectionColor: any; projectionType: any; renderAuxOnTop: any; renderMode: any; renderServiceCanvasRatio: any; renderSetup: any; screenSpaceCoverageCalculationMethod: any; selectionColor: any; showAuxOnNavigation: any; silhouetteEffect: any; silhouetteEffectColor: any; silhouetteEffectExclusiveEnabled: any; smallFeatureCulling: any; smallFeaturePixelThreshold: any; soc: any; spacemouseMultiplier: 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
  - 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
  - gizmoScalingFactor: any
  - gizmosEnabled: any
  - gpuMemoryReleaseFactor: 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
  - preSelectionColor: any
  - projectionType: any
  - renderAuxOnTop: any
  - renderMode: any
  - renderServiceCanvasRatio: any
  - renderSetup: any
  - screenSpaceCoverageCalculationMethod: any
  - selectionColor: any
  - showAuxOnNavigation: any
  - silhouetteEffect: any
  - silhouetteEffectColor: any
  - silhouetteEffectExclusiveEnabled: any
  - smallFeatureCulling: any
  - smallFeaturePixelThreshold: any
  - soc: any
  - spacemouseMultiplier: 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: number): 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
Disconnects from a Session.

Returns void

Inherited from SessionAPI.disconnectFromSession

enableCapping

enableCapping(clipPlaneId: number): 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

enterXRMemberInitMode

enterXRMemberInitMode(memberId: number, xrInitOptions?: XRInitOptions): Promise<boolean>
Experimental
enters the initialization phase for modeltracking, this is also used to reset the current modeltracking. It will also trigger REALITY_MODELTRACKERSTATE_CHANGED event with the ModelTrackingState.INIT set to true By default the modeltracking will be softreset. If you choose to reset different data on the modeltracker you can do so by specifying the xrInitOptions.
Parameters
- memberId: number
  
  the XRMember that the operation should be applied on
- Optional xrInitOptions: XRInitOptions
  
  Specify initOptions. E.g. reset behavior of modeltracker. Default is softreset.
Returns Promise<boolean>
returns a Promise which reports wether the operation was successful or not

Inherited from RealityAPI.enterXRMemberInitMode

exitXRMemberInitMode

exitXRMemberInitMode(memberId: number): Promise<boolean>
Experimental
leaves the initialization phase for modeltracking, this will also fixate the model at the current position
Parameters
- memberId: number
  
  the XRMember that the operation should be applied on
Returns Promise<boolean>
returns a Promise which reports wether the operation was successful or not

Inherited from RealityAPI.exitXRMemberInitMode

fetchAttachmentData

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

Inherited from AttachmentAPI.fetchAttachmentData

fixateXRMember

fixateXRMember(memberId: number): Promise<boolean>
Experimental
Fixates the model at the current position. It will also trigger REALITY_XRSTATE_CHANGED event with the XRState.FIXATED set to true
Parameters
- memberId: number
  
  the XRMember that the operation should be applied on
Returns Promise<boolean>
returns a Promise which reports wether the operation was successful or not

Inherited from RealityAPI.fixateXRMember

getAnnotationData

getAnnotationData(annotationID: number): AnnotationData
Parameters
- annotationID: number
Returns AnnotationData
The content and properties of an annotation.

Inherited from AnnotationAPI.getAnnotationData

getAnnotations

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

Inherited from AnnotationAPI.getAnnotations

getAttachmentData

getAttachmentData(attachmentID?: number): any
Returns the attachment data.

Deprecated
getAttachmentData is deprecated, please use fetchAttachmentData instead.
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
Returns any
The attached data

Inherited from AttachmentAPI.getAttachmentData

getAttachmentDataURI

getAttachmentDataURI(attachmentID?: number): 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: number): ICollection
Parameters
- collectionID: number
Returns ICollection

Inherited from CollectionAPI.getCollection

getCollectionElements

getCollectionElements(collectionID: number): Promise<number[]>
Returns an array containing the ids of the nodes in the collection. Modifying the returned array results in undefined behavior.

READONLY
Parameters
- collectionID: number
  
  The id of the node collection
Returns Promise<number[]>
Array of node IDs representing the node collection

Inherited from CollectionAPI.getCollectionElements

getCollectionNodeCount

getCollectionNodeCount(collectionID: number): 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

getDrawings

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

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

Inherited from DrawingAPI.getDrawings

getEnabledAuxNodes

getEnabledAuxNodes(nodeID?: number): Promise<number[]>
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.
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

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

getMeasurementData

getMeasurementData(measurementID: number): MeasurementData
Parameters
- measurementID: number
  
  The ID of the Measurement.
Returns MeasurementData
The MeasurementData.

Inherited from MeasurementAPI.getMeasurementData

getMeasurements

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

Inherited from MeasurementAPI.getMeasurements

getMetadata

getMetadata(nodeID: number): 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: number, properties: T[]): 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: number, property: T): 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: number | TopologyHandle): number
Returns the id of the root Node for the given Node or Topology Element.
- The id of the root Node for the given Node or Topology Element.
Parameters
- target: number | TopologyHandle
  
  Specifies a Node or Topology Element
Returns number

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.

Deprecated
getSelection is deprecated, please use getSelectedNodes instead.

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

Inherited from SelectionAPI.getSelection

getSessionMemberID

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

Inherited from SessionAPI.getSessionMemberID

getSessionMembers

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

Inherited from SessionAPI.getSessionMembers

getSessionStateData

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

Inherited from SessionAPI.getSessionStateData

getSnapshotData

getSnapshotData(snapshotID: number): { attachmentID: number; name: string; order: number }
Deprecated
getSnapshotData is deprecated, please use requestSnapshotData instead.
Parameters
- snapshotID: number
Returns { attachmentID: number; name: string; order: number }
The data of the specified Snapshot.
- attachmentID: number
- name: string
- order: number
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?: NodeType, nodeID?: number): 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).
Returns Promise<any>
An Object of Type/Count pairs.

Inherited from InstanceGraphAPI.getStatistics

getTopologyType

getTopologyType(handle: TopologyHandle): 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?: string): 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.

getXRMemberInfo

getXRMemberInfo(memberId: number): XRMemberInfo
Experimental
list all the available XR members in the current session
Parameters
- memberId: number
  
  the XRMember that the operation should be applied on
Returns XRMemberInfo
returns a struct containing all relevant infos (memberId, XRCapabilities, sessionMemberData) for the given member

Inherited from RealityAPI.getXRMemberInfo

getXRMemberState

getXRMemberState(memberId: number): XRMemberState
Experimental
Get the runtime state of a XR Member
Parameters
- memberId: number
  
  the XRMember that the state should be queried from
Returns XRMemberState
returns either the member state if the member exist or return undefined if xr is not connected or memberId does not exist

Inherited from RealityAPI.getXRMemberState

getXRMembers

getXRMembers(): number[]
Experimental
list all the available XR members in the current session

Returns number[]
returns a Promise with the list of all available XRMembers

Inherited from RealityAPI.getXRMembers

getXRSessionState

getXRSessionState(): XRSessionState
Experimental
Get current state if XR functionality

Returns XRSessionState
returns a Promise

Inherited from RealityAPI.getXRSessionState

importConfig

importConfig(config: { aaSetting: any; additionalCookies: any; additionalRequestHeaders: any; additionalWSQueryParameters: any; annotationEditingEnabled: any; arkitConfigs: 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; customIconMap: any; customToolbarIconMap: any; defaultFieldOfView: any; defaultQueryLinkDepth: any; disableDefaultInteraction: any; disableSpecularHighlights: any; doubleClickAnimationVolumeScale: any; doubleClickTimeWindow: 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; gizmoScalingFactor: any; gizmosEnabled: any; gpuMemoryReleaseFactor: any; hubURL: any; initView: any; initialFit: any; initialStateActivation: any; language: any; lightingEnvironment: any; lineHighlightColor: any; lineSelectionColor: any; logLevel: any; maxActiveSceneVolumeDiameter: any; maxConcurrentDownloads: any; maxDynamicClipDistance: any; maxGPUMemory: any; maxSRCCPUMemory: any; measurementAngularTolerance: any; measurementMaterialDensities: any; modelviewPrintContentFunction: any; mouseInvertZoomingDirection: any; navigationMode: any; navigationSampling: any; navigationSpeedFactor: any; navigationSpeedThrottleFactor: any; notificationLogLevels: any; parentSelectEnabled: any; preSelectionColor: any; preferXHRWithCredentials: any; projectionType: any; renderAuxOnTop: any; renderMode: any; renderServiceCanvasRatio: 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; slamProviderType: any; smallFeatureCulling: any; smallFeaturePixelThreshold: any; snapshotContentSelection: any; soc: any; spacemouseMultiplier: any; topoGeometryColor: any; topoGeometrySecondaryColor: any; topoPointsEnabled: any; turntableLowerVerticalLimit: any; turntableUpperVerticalLimit: any; turntableVerticalLimitsEnabled: any; uriMap: any; useDevicePixelRatio: any; vertexColorsEnabled: any; viewPerspective: any; webglPreserveDrawingbuffer: any; xrEnabled: any; ´modelviewPrintResourceNameFunction: any }): void
Applies the specified set of settings to the context.
Parameters
- config: { aaSetting: any; additionalCookies: any; additionalRequestHeaders: any; additionalWSQueryParameters: any; annotationEditingEnabled: any; arkitConfigs: 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; customIconMap: any; customToolbarIconMap: any; defaultFieldOfView: any; defaultQueryLinkDepth: any; disableDefaultInteraction: any; disableSpecularHighlights: any; doubleClickAnimationVolumeScale: any; doubleClickTimeWindow: 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; gizmoScalingFactor: any; gizmosEnabled: any; gpuMemoryReleaseFactor: any; hubURL: any; initView: any; initialFit: any; initialStateActivation: any; language: any; lightingEnvironment: any; lineHighlightColor: any; lineSelectionColor: any; logLevel: any; maxActiveSceneVolumeDiameter: any; maxConcurrentDownloads: any; maxDynamicClipDistance: any; maxGPUMemory: any; maxSRCCPUMemory: any; measurementAngularTolerance: any; measurementMaterialDensities: any; modelviewPrintContentFunction: any; mouseInvertZoomingDirection: any; navigationMode: any; navigationSampling: any; navigationSpeedFactor: any; navigationSpeedThrottleFactor: any; notificationLogLevels: any; parentSelectEnabled: any; preSelectionColor: any; preferXHRWithCredentials: any; projectionType: any; renderAuxOnTop: any; renderMode: any; renderServiceCanvasRatio: 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; slamProviderType: any; smallFeatureCulling: any; smallFeaturePixelThreshold: any; snapshotContentSelection: any; soc: any; spacemouseMultiplier: any; topoGeometryColor: any; topoGeometrySecondaryColor: any; topoPointsEnabled: any; turntableLowerVerticalLimit: any; turntableUpperVerticalLimit: any; turntableVerticalLimitsEnabled: any; uriMap: any; useDevicePixelRatio: any; vertexColorsEnabled: any; viewPerspective: any; webglPreserveDrawingbuffer: any; xrEnabled: any; ´modelviewPrintResourceNameFunction: any }
  
  Settings to import
  - aaSetting: any
  - additionalCookies: any
  - additionalRequestHeaders: any
  - additionalWSQueryParameters: any
  - annotationEditingEnabled: any
  - arkitConfigs: 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
  - customIconMap: any
  - customToolbarIconMap: any
  - defaultFieldOfView: any
  - defaultQueryLinkDepth: any
  - disableDefaultInteraction: any
  - disableSpecularHighlights: any
  - doubleClickAnimationVolumeScale: any
  - doubleClickTimeWindow: 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
  - gizmoScalingFactor: any
  - gizmosEnabled: any
  - gpuMemoryReleaseFactor: any
  - hubURL: any
  - initView: any
  - initialFit: any
  - initialStateActivation: any
  - language: any
  - lightingEnvironment: any
  - lineHighlightColor: any
  - lineSelectionColor: any
  - logLevel: any
  - maxActiveSceneVolumeDiameter: any
  - maxConcurrentDownloads: any
  - maxDynamicClipDistance: any
  - maxGPUMemory: any
  - maxSRCCPUMemory: any
  - measurementAngularTolerance: any
  - measurementMaterialDensities: any
  - modelviewPrintContentFunction: any
  - mouseInvertZoomingDirection: any
  - navigationMode: any
  - navigationSampling: any
  - navigationSpeedFactor: any
  - navigationSpeedThrottleFactor: any
  - notificationLogLevels: any
  - parentSelectEnabled: any
  - preSelectionColor: any
  - preferXHRWithCredentials: any
  - projectionType: any
  - renderAuxOnTop: any
  - renderMode: any
  - renderServiceCanvasRatio: 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
  - slamProviderType: any
  - smallFeatureCulling: any
  - smallFeaturePixelThreshold: any
  - snapshotContentSelection: any
  - soc: any
  - spacemouseMultiplier: any
  - topoGeometryColor: any
  - topoGeometrySecondaryColor: any
  - topoPointsEnabled: any
  - turntableLowerVerticalLimit: any
  - turntableUpperVerticalLimit: any
  - turntableVerticalLimitsEnabled: any
  - uriMap: any
  - useDevicePixelRatio: any
  - vertexColorsEnabled: any
  - viewPerspective: any
  - webglPreserveDrawingbuffer: any
  - xrEnabled: any
  - ´modelviewPrintResourceNameFunction: any
Returns void

Inherited from SettingsAPI.importConfig

importSession

importSession(data: any, format?: "xscn"): 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

invertEnabledStates

invertEnabledStates(): void
Inverts all enabled states.

Returns void

Inherited from InstanceGraphAPI.invertEnabledStates

invertSelection

invertSelection(silent?: boolean): 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: number): boolean
Parameters
- nodeID: number
Returns boolean
Returns true if a Node is deletable.

Inherited from InstanceGraphAPI.isNodeDeletable

isNodePartOfEnabledLayers

isNodePartOfEnabledLayers(nodeID: number): 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: number): 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: number, nodeType: 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>
Checks if offline storage is currently available.

Returns Promise<boolean>

Inherited from SessionStorageAPI.isOfflineStorageAvailable

isSelected

isSelected(nodeID: number): 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: TopologyHandle): 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: TopologyHandle[]): 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: number, handles: OriginalTopologyHandle[]): 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

measureTangent

measureTangent(measurementDescriptor: MeasurementDescriptor, l3dToShapeInstanceIDMap: Map<number, number[]>): Promise<TangentMeasurementResult>
Parameters
- measurementDescriptor: MeasurementDescriptor
- l3dToShapeInstanceIDMap: Map<number, number[]>
Returns Promise<TangentMeasurementResult>

Inherited from MeasurementAPI.measureTangent

performExplosion

performExplosion(explosionFactor: number): 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: 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: number): void
Promotes a SessionMember to the Role of the Moderator.
Parameters
- memberID: number
  
  The ID of the SessionMember.
Returns void

Inherited from SessionAPI.promoteSessionMember

query

query(query: string | Query, nodeID?: number): 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: T): 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: string, defaultValue: any, recursive?: boolean): 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: FrameListener): 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: EventType[], listener: IEventListener<T>, nodeID?: number, observeSubTree?: boolean): 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?: number | number[]): Promise<void>
Removes the Node for the given nodeID from the InstanceGraph. If no nodeID is supplied all Nodes are deleted.
Parameters
- Optional nodeID: number | number[]
  
  The id of the Node that should be removed.
Returns Promise<void>

Inherited from InstanceGraphAPI.remove

removeAnimationFrames

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

Inherited from AnimationAPI.removeAnimationFrames

removeAnnotation

removeAnnotation(annontationID: number): void
Removes an annotation.
Parameters
- annontationID: number
  
  The ID of the annotation.
Returns void

Inherited from AnnotationAPI.removeAnnotation

removeAttachment

removeAttachment(attachmentID?: number): void
Removes an existing attachment.
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
Returns void

Inherited from AttachmentAPI.removeAttachment

removeCapping

removeCapping(clipPlaneId: number): 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: number): void
Removes a clip room with the specified id.
Parameters
- clipPlaneId: number
  
  The id of the clip room you want to remove.
Returns void

Inherited from ClipPlaneAPI.removeClipPlane

removeClippingRoom

removeClippingRoom(): void
Removes the clip room.

Returns void

Inherited from ClipPlaneAPI.removeClippingRoom

removeCollection

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

Inherited from CollectionAPI.removeCollection

removeDrawing

removeDrawing(drawingId: number, force?: boolean): RemoveDrawingState
Removes a Drawing with the specified id. If a Drawing is part of a Snapshot the removal will fail with the State RemoveDrawingState.PART_OF_SNAPSHOT
Parameters
- drawingId: number
  
  The id of the to be removed Drawing.
- Optional force: boolean
  
  Forces the removal of the Drawing even if the Drawing is part of one or more Snapshots.
Returns RemoveDrawingState

Inherited from DrawingAPI.removeDrawing

removeFromCollection

removeFromCollection(collectionID: number, nodeID: number, recursive?: boolean): 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: number | number[], silent?: boolean): 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: number): void
The measurement for the given measurementID is removed.
Parameters
- measurementID: number
Returns void

Inherited from MeasurementAPI.removeMeasurement

removeSessionMember

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

Inherited from SessionAPI.removeSessionMember

removeSnapshot

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

Inherited from SessionStorageAPI.removeSnapshot

removeTopologyFromSelection

removeTopologyFromSelection(handle: TopologyHandle | TopologyHandle[]): 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: ViewerAPI): 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

requestAdditionalMeasurementData

requestAdditionalMeasurementData(measurementID: number): void
Calculates the additional measurement information like thickness and displays it in the UI.
Parameters
- measurementID: number
  
  the ID of a Measurement
Returns void

Inherited from MeasurementAPI.requestAdditionalMeasurementData

requestAuxRootNodeIds

requestAuxRootNodeIds(scopeNodeId?: number): 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

requestClipPlaneData

requestClipPlaneData(clipPlaneId: number): 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: number): 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.
- The full volume of currently loaded scene.
Returns Promise<BoxVolume>

Inherited from InstanceGraphAPI.requestFullSceneVolume

requestL3DInformation

requestL3DInformation(targetNodeId: number): 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

requestNodeIdsByBoxVolume

requestNodeIdsByBoxVolume(boxVolume: BoxVolume, includeOverlappingNodes?: boolean, includeDisabledNodes?: boolean, forceExpand?: boolean, scopeNodeId?: number): 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: string[], scope?: number): 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: NodePathHandle[], scope?: number, typePriorities?: NodePathFragmentType[]): 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?: number, recursive?: boolean): 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

requestSnapshotData

requestSnapshotData(snapshotID: number): Promise<SnapshotProperties>
Parameters
- snapshotID: number
Returns Promise<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

requestVariants

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

Inherited from VariantsAPI.requestVariants

requestXMemberCapabilities

requestXMemberCapabilities(memberId: number): Promise<boolean>
Experimental
execute whatever is necessary to enable XRCapbilities on the given member, e.g. start the camera or forward to the booster
Parameters
- memberId: number
  
  the XRMember that the operation should be applied on
Returns Promise<boolean>
returns a Promise which reports wether the operation was successful or not

Inherited from RealityAPI.requestXMemberCapabilities

resetAR

resetAR(): Promise<boolean>
Deprecated
restart modeltracker initialization for the local xr member

Returns Promise<boolean>
returns true if resetting was successfull or false if not

Inherited from RealityAPI.resetAR

resetInteractionMode

resetInteractionMode(keepColorCompareActive?: boolean): 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: number, properties: T[]): 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.
Returns Promise<void>

Inherited from InstanceGraphAPI.resetProperties

resetProperty

resetProperty<T>(nodeID: number, property: T): 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.
Returns Promise<void>

Inherited from InstanceGraphAPI.resetProperty

resetSetting

resetSetting(setting: ViewerSettingStrings | SettingStrings): 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

restoreMeasurement

restoreMeasurement(data: MeasurementData, measurementID?: number): number
Parameters
- data: MeasurementData
  
  The MeasurementData that should be restored.
- Optional measurementID: number
  
  The ID of the restored Measurement.
Returns number

Inherited from MeasurementAPI.restoreMeasurement

restoreSession

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

Inherited from SessionStorageAPI.restoreSession

restoreSnapshot

restoreSnapshot(snapshotID: number, options?: SnapshotRestoreOptions): 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: BoxVolume, includeOverlappingNodes: boolean, rootNodeID?: number): 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

selectCollection

selectCollection(collectionID: number, silent?: boolean): 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(attachmentID?: number, data?: any): void
Sets the attachment data.
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
- Optional data: any
  
  The new attachment data.
Returns void

Inherited from AttachmentAPI.setAttachmentData

setAttachmentDataURI

setAttachmentDataURI(attachmentID?: number, dataURI?: string): 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: string | string[], keepColorCompareActive?: boolean): void
Set the current interaction mode.

Deprecated
Calling setInteractionMode with the mode parameter of type string or string[] is deprecated, please use the InteractionMode enum instead.
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

Inherited from InteractionAPI.setInteractionMode
setInteractionMode(mode: InteractionMode, keepColorCompareActive?: boolean): 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: string, enabled: boolean): 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: number, newParentID: number): void
Parameters
- nodeID: number
- newParentID: number
Returns void

Inherited from InstanceGraphAPI.setParent

setProperty

setProperty<T>(nodeID: number | number[], property: T, value: PropertyType<T>, silent?: boolean): Promise<SetPropertyResults>
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<SetPropertyResults>

Inherited from InstanceGraphAPI.setProperty

setSelection

setSelection(nodeID: number | number[], silent?: boolean): 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: TopologyHandle | TopologyHandle[], property: T, value: TopologyPropertyTypeMap[T]): 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: TopologyHandle | TopologyHandle[]): 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: number, enabled: boolean): void
Enables or disables a given Variant.
Parameters
- variant: number
  
  The ID of the Variant.
- enabled: boolean
  
  The enabled state.
Returns void

Inherited from VariantsAPI.setVariantEnabled

setXRMemberSettings

setXRMemberSettings(memberId: number, settings: XRMemberSettings): Promise<boolean>
Experimental
This will set settings for the specific xr member.

modeltrackerQualityThreshold sets a normalized threshold for the modeltracker. The threshold determines the actual correspondence of the generated line model to the real world. A value of 1 means total correspondence, while a value of zero means no correspondence at all. Depending on that value the tracker will trigger a REALITY_MODELTRACKERSTATE_CHANGED event with the ModelTrackingState.SNAPPED to true and a REALITY_XRSTATE_CHANGED event with XRState.FIXATED set to true

enableDebugImages will enable or disable the edge images to be send from the modeltracker. If set to true it will trigger REALITY_MODELTRACKER_EDGEIMG_RECEIVED events once an debug image arrives. Note: When enabled this will impact bandwidth and perfomance of the application, so we recommand using this only on demand.
Parameters
- memberId: number
  
  the XRMember that the operation should be applied on
- settings: XRMemberSettings
  
  The quality threshold for the modeltracker must be between 0 and 1
Returns Promise<boolean>
returns a Promise which reports wether the operation was successful or not

Inherited from RealityAPI.setXRMemberSettings

showExpertDialog

showExpertDialog(): Promise<boolean>
Deprecated
show expert dialog for developers or advanced users

Returns Promise<boolean>
returns true if the operation was successfull or false if not

Inherited from RealityAPI.showExpertDialog

shutdownSession

shutdownSession(): Promise<void>
Shuts down a Session and disconnects all joined SessionMembers.

Returns Promise<void>

Inherited from SessionAPI.shutdownSession

startAR

startAR(): Promise<boolean>
Deprecated
start AR. Projects the camera stream in the background and starts searching for the given reference. The reference is defined by setting the realproperty on the particular node via the webvis API. E.g. webvis.setProperty(0, pluginAPI.realProperty, pluginAPI.realState.Enabled)

Returns Promise<boolean>
returns true if starting was successfull or false if it could not start AR

Inherited from RealityAPI.startAR

startXRMemberSpectate

startXRMemberSpectate(memberId: number): Promise<boolean>
Experimental
Puts the image stream in the background of the renderer. It will also trigger REALITY_XRSTATE_CHANGED event with the XRState.FOLLOWING set to true
Parameters
- memberId: number
  
  the XRMember that the operation should be applied on
Returns Promise<boolean>
returns a Promise which reports wether the operation was successful or not

Inherited from RealityAPI.startXRMemberSpectate

stopAR

stopAR(): Promise<boolean>
Deprecated
stop AR. Stop projecting the camera stream in the background and reset background to default color.

Returns Promise<boolean>
returns true if stopping was successfull or false if it could not stop AR

Inherited from RealityAPI.stopAR

stopXRMemberSpectate

stopXRMemberSpectate(memberId: number): Promise<boolean>
Experimental
Stops the image stream in the background of the renderer. It will also trigger REALITY_XRSTATE_CHANGED event with the XRState.FOLLOWING set to false
Parameters
- memberId: number
  
  the XRMember that the operation should be applied on
Returns Promise<boolean>
returns a Promise which reports wether the operation was successful or not

Inherited from RealityAPI.stopXRMemberSpectate

storeSession

storeSession(offline?: boolean, progressCallback?: StoreSessionProgressCallback): Promise<string | void>
Temporarily stores the Session in the infrastructure and returns a handle.
Parameters
- Optional offline: boolean
  
  sets the space domain to the local one
- Optional progressCallback: StoreSessionProgressCallback
Returns Promise<string | void>

Inherited from SessionStorageAPI.storeSession

unfixateXRMember

unfixateXRMember(memberId: number): Promise<boolean>
Experimental
Unfixates the model. The model will move with the device. It will also trigger REALITY_XRSTATE_CHANGED event with the XRState.FIXATED set to false
Parameters
- memberId: number
  
  the XRMember that the operation should be applied on
Returns Promise<boolean>
returns a Promise which reports wether the operation was successful or not

Inherited from RealityAPI.unfixateXRMember

unregisterFrameListener

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

Inherited from FrameAPI.unregisterFrameListener

unregisterListener

unregisterListener(listenerID: number): 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: ContextState): 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.

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.
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

Inherited from ContextStateAPI.waitFor

ContextAPI¶

Interface ContextAPI

Hierarchy

Index

Methods

Methods

add

Parameters

dataURI: string

Optional parentID: number

Optional usage: UsageString

Optional label: string

Optional contentType: string

Optional initialProperties: { [key: string]: any }

[key: string]: any

Optional cacheStrategy: CacheStrategy

Returns numberThe id of the new contents root Node

Parameters

params: { [key: string]: any }

[key: string]: any

Returns number

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>

changeAnnotation

Parameters

annotationID: number

Optional label: string

Optional visible: boolean

Optional anchorPosition: Float32Array | number[]

Optional labelPosition: Float32Array | number[]

Optional active: boolean

Optional transform: Float32Array | number[]

Returns void

changeClipPlane

Parameters

clipPlaneId: number

properties: ClipPlaneProperties

Returns ClipPlanePropertiesAn Object with the changed Properties.

Deprecated

Parameters

clipPlaneID: number

Optional normal: Float32Array | number[]

Optional point: Float32Array | number[]

Optional name: string

Optional thickness: number

Optional tangent: Float32Array | number[]

Optional disabled: boolean

Optional invisible: boolean

Optional exclusive: boolean

Returns void

changeClippingRoom

Parameters

Optional properties: ClipRoomProperties

Returns ClipRoomPropertiesAn object with the changed properties.

Deprecated

Parameters

Optional name: string

Optional size: Float32Array | number[]

Optional transformation: Float32Array | number[]

Optional disabled: boolean

Optional invisible: boolean

`Optional` parentID: number

`Optional` usage: UsageString

`Optional` label: string

`Optional` contentType: string

`Optional` initialProperties: { [key: string]: any }

`Optional` cacheStrategy: CacheStrategy

Returns number
The id of the new contents root Node

`Optional` dataType: AttachmentType

`Optional` recursive: boolean

`Optional` silent: boolean

`Optional` label: string

`Optional` visible: boolean

`Optional` anchorPosition: Float32Array | number[]

`Optional` labelPosition: Float32Array | number[]

`Optional` active: boolean

`Optional` transform: Float32Array | number[]

Returns ClipPlaneProperties
An Object with the changed Properties.

`Optional` normal: Float32Array | number[]

`Optional` point: Float32Array | number[]

`Optional` name: string

`Optional` thickness: number

`Optional` tangent: Float32Array | number[]

`Optional` disabled: boolean

`Optional` invisible: boolean

`Optional` exclusive: boolean

`Optional` properties: ClipRoomProperties

Returns ClipRoomProperties
An object with the changed properties.

`Optional` name: string

`Optional` size: Float32Array | number[]

`Optional` transformation: Float32Array | number[]

`Optional` disabled: boolean

`Optional` invisible: boolean

Returns ClipRoomProperties
An object with the changed properties.

Returns DrawingProperties
An object with the changed properties.

`Optional` visible: boolean

`Optional` name: string

Returns boolean
A boolean which indicates if the setting has changed

Returns SnapshotProperties
An object with the changed Properties.

`Optional` name: string

`Optional` screenshotURL: string

`Optional` order: number

`Optional` silent: boolean

`Optional` subType: string

Returns number[]
A list of runtime Node ids of the specified type.

`Optional` sessionID: string

`Optional` name: string

Returns Promise<XRSessionState>
returns a Promise

`Optional` visible: boolean

`Optional` anchorPosition: Float32Array | number[]

`Optional` labelOffset: Float32Array | number[]

Returns number
The ID of the new annotation.