ViewerAPI

• webVis API Reference
• ViewerAPI

Interface ViewerAPI

The ViewerDrawingAPI provides basic functionalities to control the 2D Drawing Mode and the processed Output.

Hierarchy

• ViewerDrawingAPI
• ViewerInteractionAPI
• ViewerGizmoAPI
• ViewerHighlightAPI
• ViewerPolylineAPI
• ViewerUserGeometryAPI
• ViewerStateAPI
  • ViewerAPI

Index

Methods

animateViewToViewmatrix cancelDrawingMode changePolyline changeSetting createCollectionFromGizmo createGeometry createPolyline dehighlightEntity destroy enableNavigation enableSnapping enterColorCompareMode enterDrawingMode fitView fitViewToAuxNode fitViewToDirection fitViewToNode fitViewToRectangle fitViewToVolume fitViewToVolumeFromDirection flipAuxToView getActiveItem getAvailableGizmoTransformationModes getBoxGizmoProperties getCameraPosition getCameraProjectionType getCenterOfRotation getContext getCurrentGizmoType getGizmoSize getGizmoTransform getGizmoTransformationMode getID getProjectionMatrix getState getToCoordinateSystemMatrix getViewMatrix hideAllLineMarkers hideAllMarkers hideAllPointMarkers hideGizmo hidePointMarker highlightArc highlightBBox highlightEntity highlightLine highlightPoint isSnappingEnabled leaveColorCompareMode leaveDrawingMode readSetting removeGeometry removePolyline requestNodeIdsByRect requestScreenshot requestTopologyHandlesByRect reset resetSetting restoreInitView setActiveItem setCORGizmoVisible setCenterOfRotation setGizmoTransformationMode setInteractionLevel setProjectionMatrix setView setViewMatrix showAxisMarker showBoxGizmo showClippingBoxGizmo showPointMarker showSelectionBoxGizmo showSelectionBoxGizmoFromVolume showSelectionTransformationGizmo takeScreenshot toggleStatsViewer updateGeometry

Methods

animateViewToViewmatrix

• animateViewToViewmatrix(matrix, transitionTime?): Promise<void>

• Animates to the given viewmatrix

  Parameters

  • matrix: Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

    The new view matrix for the camera

  • Optional transitionTime: number

    Defines the transition time for the camera movement

  Returns Promise<void>

cancelDrawingMode

• cancelDrawingMode(): void

• Leaves the 2D Drawing Mode and discards all drawings.

  Returns void

  Inherited from ViewerDrawingAPI.cancelDrawingMode

changePolyline

• changePolyline(polylineId, properties): void

• Changes the properties of the Polyline with the specified Id.

  Parameters

  • polylineId: number

    The Id of the Polyline which should be removed.

  • properties: PolylineProperties

    The properties which should be changed.

  Returns void

  Inherited from ViewerPolylineAPI.changePolyline

changeSetting

• changeSetting<T>(viewerSetting, value): boolean

• Changes the viewer setting with the given name to the given value.

  Type Parameters

  • T extends string

  Parameters

  • viewerSetting: T

    Specifies a particular viewer setting which one would like to change.

  • value: ViewerSettingType<T>

    A new value for the specified setting.

  Returns boolean

  A boolean which indicates if the setting has changed

createCollectionFromGizmo

• createCollectionFromGizmo(includeOverlappingNodes): Promise<number>

• Parameters

  • includeOverlappingNodes: boolean

  Returns Promise<number>

  Inherited from ViewerGizmoAPI.createCollectionFromGizmo

createGeometry

• createGeometry(userGeoData): number

• Parameters

  • userGeoData: UserGeometryData

  Returns number

  Inherited from ViewerUserGeometryAPI.createGeometry

createPolyline

• createPolyline(positions, properties?): number

• Creates a new Polyline with the specified positions and properties.

  Parameters

  • positions: number[]

    List of 3D positions which defines the Polyline.

  • Optional properties: PolylineProperties

    The properties of the Polyline.

  Returns number

  Inherited from ViewerPolylineAPI.createPolyline

dehighlightEntity

• dehighlightEntity(highlightHandle?): void

• Disable highlighting for the handle

  Parameters

  • Optional highlightHandle: number

    : number

  Returns void

  Inherited from ViewerHighlightAPI.dehighlightEntity

destroy

• destroy(): void

• Returns void

enableNavigation

• enableNavigation(flag?): void

• Toggles the state of the 3D navigation (on or off).

  Parameters

  • Optional flag: boolean

  Returns void

enableSnapping

• enableSnapping(useSnapping): void

• Parameters

  • useSnapping: boolean

  Returns void

  Inherited from ViewerInteractionAPI.enableSnapping

enterColorCompareMode

• enterColorCompareMode(): void

• Enters the color compare mode which renders Nodes depending on the COMPARISON_GROUP-Property.

  Returns void

enterDrawingMode

• enterDrawingMode(): void

• Enters the 2D drawing Mode where you can draw on top of your 3D Model.

  Returns void

  Inherited from ViewerDrawingAPI.enterDrawingMode

fitView

• fitView(view?, up?, transitionTime?): Promise<void>

• Positions the camera such that the whole geometry is fitting into the view. The view and up parameter allow to define a viewing direction and roll for the resulting camera pose.

  Parameters

  • Optional view: Float32Array | [number, number, number]

    Defines the desired viewing direction

  • Optional up: Float32Array | [number, number, number]

    Defines the desired camera orientation in conjunction with the viewing direction

  • Optional transitionTime: number

    Defines the transition time for the camera movement

  Returns Promise<void>

fitViewToAuxNode

• fitViewToAuxNode(nodeID, transitionTime?): Promise<void>

• Positions the camera such that the aux node is fitting into the view.

  Parameters

  • nodeID: number

    The ID of the node on which one wants to fit the view

  • Optional transitionTime: number

    Defines the transition time for the camera movement

  Returns Promise<void>

fitViewToDirection

• fitViewToDirection(direction?, transitionTime?): Promise<void>

• Positions the camera such that it looks from a specific direction.

  Parameters

  • Optional direction: ViewDirection

    The direction to fit.

  • Optional transitionTime: number

    Defines the transition time for the camera movement

  Returns Promise<void>

fitViewToNode

• fitViewToNode(nodeID, view?, up?, transitionTime?): Promise<void>

• Positions the camera such that the node’s bounding box is fitting into the view. The view and up parameter allow to define a viewing direction and roll for the resulting camera pose.

  Parameters

  • nodeID: number

    The ID of the node on which one wants to fit the view

  • Optional view: Float32Array | [number, number, number]

    The direction in which the camera will look on the node

  • Optional up: Float32Array | [number, number, number]

    The orientation in which the camera will look on the node

  • Optional transitionTime: number

    Defines the transition time for the camera movement

  Returns Promise<void>

fitViewToRectangle

• fitViewToRectangle(x, y, width, height, transitionTime?): Promise<void>

• Positions the camera such that the view is focused onto the given rectangle.

  Parameters

  • x: number

    Specifies the X-Coordinate of the 2D screen space Rectangle.

  • y: number

    Specifies the Y-Coordinate of the 2D screen space Rectangle.

  • width: number

    Specifies the width of the 2D screen space Rectangle.

  • height: number

    Specifies the height of the 2D screen space Rectangle.

  • Optional transitionTime: number

    Defines the transition time for the camera movement.

  Returns Promise<void>

fitViewToVolume

• fitViewToVolume(volume, view?, up?, transitionTime?): Promise<void>

• Positions the camera such that the view is focused onto the given volume. The view and up parameter allow to define a viewing direction and roll for the resulting camera pose.

  Parameters

  • volume: BoxVolume

    A particular volume on which the view will be fitted

  • Optional view: Float32Array | [number, number, number]

    Specifies the direction in which the camera will look on the volume

  • Optional up: Float32Array | [number, number, number]

    Specifies the orientation in which the camera will look on the volume

  • Optional transitionTime: number

    Defines the transition time for the camera movement

  Returns Promise<void>

fitViewToVolumeFromDirection

• fitViewToVolumeFromDirection(volume, direction?, transitionTime?): Promise<void>

• Positions the camera such that it looks from the specified direction onto the specified volume.

  Parameters

  • volume: BoxVolume

    The volume on which the camera will be fitted

  • Optional direction: ViewDirection

    The direction to fit.

  • Optional transitionTime: number

    Defines the transition time for the camera movement

  Returns Promise<void>

flipAuxToView

• flipAuxToView(): void

• Flips the auxiliaries with respect to the current view

  Returns void

getActiveItem

• getActiveItem(): ActiveItemInfo

• Returns ActiveItemInfo

  Inherited from ViewerGizmoAPI.getActiveItem

getAvailableGizmoTransformationModes

• getAvailableGizmoTransformationModes(): number

• Returns number

  Inherited from ViewerGizmoAPI.getAvailableGizmoTransformationModes

getBoxGizmoProperties

• getBoxGizmoProperties(): BoxGizmoProperties

• Returns the properties of the BoxGizmo

  Returns BoxGizmoProperties

  The properties of the BoxGizmo

  Inherited from ViewerGizmoAPI.getBoxGizmoProperties

getCameraPosition

• getCameraPosition(): Float32Array | [number, number, number]

• Return the current Camera position

  Returns Float32Array | [number, number, number]

  The current Camera position

getCameraProjectionType

• getCameraProjectionType(): CameraProjectionType

• Return the current Camera projection tyxpe

  Returns CameraProjectionType

  The current Camera projection tyxpe

getCenterOfRotation

• getCenterOfRotation(): Float32Array

• Returns the center of rotation being the point around which the camera rotates around.

  Returns Float32Array

getContext

• getContext(): ContextAPI

• Returns ContextAPI

getCurrentGizmoType

• getCurrentGizmoType(): GizmoType

• Returns GizmoType

  Inherited from ViewerGizmoAPI.getCurrentGizmoType

getGizmoSize

• getGizmoSize(): Float32Array | [number, number, number]

• Returns Float32Array | [number, number, number]

  Inherited from ViewerGizmoAPI.getGizmoSize

getGizmoTransform

• getGizmoTransform(): Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

• Returns Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

  Inherited from ViewerGizmoAPI.getGizmoTransform

getGizmoTransformationMode

• getGizmoTransformationMode(): GizmoTransformationMode

• Returns GizmoTransformationMode

  Inherited from ViewerGizmoAPI.getGizmoTransformationMode

getID

• getID(): string

• Returns string

getProjectionMatrix

• getProjectionMatrix(): Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

• Returns the current projection matrix.

  Returns Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

  The current projection matrix

getState

• getState(): ViewerState

• Returns ViewerState

  Inherited from ViewerStateAPI.getState

getToCoordinateSystemMatrix

• getToCoordinateSystemMatrix(): 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 toCoordinateSystem Matrix

getViewMatrix

• getViewMatrix(): Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

• Returns the current view matrix.

  Returns Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

  The current view matrix of the camera

hideAllLineMarkers

• hideAllLineMarkers(): void

• Returns void

  Inherited from ViewerGizmoAPI.hideAllLineMarkers

hideAllMarkers

• hideAllMarkers(): void

• Returns void

  Inherited from ViewerGizmoAPI.hideAllMarkers

hideAllPointMarkers

• hideAllPointMarkers(): void

• Returns void

  Inherited from ViewerGizmoAPI.hideAllPointMarkers

hideGizmo

• hideGizmo(): void

• Hides the currently visible Gizmo

  Returns void

  Inherited from ViewerGizmoAPI.hideGizmo

hidePointMarker

• hidePointMarker(index?): void

• Parameters

  • Optional index: number

  Returns void

  Inherited from ViewerGizmoAPI.hidePointMarker

highlightArc

• highlightArc(pickedPt1, pickedPt3, center, axis, angle, measurementID): number

• Parameters

  • pickedPt1: Float32Array | [number, number, number]

  • pickedPt3: Float32Array | [number, number, number]

  • center: Float32Array | [number, number, number]

  • axis: Float32Array | [number, number, number]

  • angle: number

  • measurementID: number

  Returns number

  Inherited from ViewerHighlightAPI.highlightArc

highlightBBox

• highlightBBox(center, size): number

• Parameters

  • center: Float32Array | [number, number, number]

  • size: Float32Array | [number, number, number]

  Returns number

  Inherited from ViewerHighlightAPI.highlightBBox

highlightEntity

• highlightEntity(handle, highlightParameters?): Promise<number>

• Enable highlighting of the entity , which matches the attributes informed in the viewerDataSelector

  Parameters

  • handle: TopologyHandle

    : IViewerHighlightSelector

  • Optional highlightParameters: ViewerHighlightParameters

  Returns Promise<number>

  the highlightHandle, which it reqed to remove the highlighting

  Inherited from ViewerHighlightAPI.highlightEntity

highlightLine

• highlightLine(values, scale, markerIndex): void

• Parameters

  • values: number[]

  • scale: number

  • markerIndex: number

  Returns void

  Inherited from ViewerHighlightAPI.highlightLine

highlightPoint

• highlightPoint(position, markerIndex): void

• Parameters

  • position: Float32Array | [number, number, number]

  • markerIndex: number

  Returns void

  Inherited from ViewerHighlightAPI.highlightPoint

isSnappingEnabled

• isSnappingEnabled(): boolean

• Returns boolean

  Inherited from ViewerInteractionAPI.isSnappingEnabled

leaveColorCompareMode

• leaveColorCompareMode(): void

• Leave the color compare render mode.

  Returns void

leaveDrawingMode

• leaveDrawingMode(options?): Promise<ViewerDrawingResult>

• Leaves the 2D Drawing Mode and returns the processed 2D drawing data which can be used to create a Drawing with the help of the DrawingAPI.

  Parameters

  • Optional options: ViewerDrawingProcessOptions

    Options to configure the result of the processing.

  Returns Promise<ViewerDrawingResult>

  The processed 2D drawing data.

  Inherited from ViewerDrawingAPI.leaveDrawingMode

readSetting

• readSetting<T>(viewerSetting): ViewerSettingType<T>

• Returns the value of a viewer setting.

  Type Parameters

  • T extends string

  Parameters

  • viewerSetting: T

    The name of a particular setting whose value one wants to read

  Returns ViewerSettingType<T>

  The value of the specified setting

removeGeometry

• removeGeometry(id): void

• Parameters

  • id: number

  Returns void

  Inherited from ViewerUserGeometryAPI.removeGeometry

removePolyline

• removePolyline(polylineId): void

• Removes the Polyline with the specified Id.

  Parameters

  • polylineId: number

    The Id of the Polyline which should be removed.

  Returns void

  Inherited from ViewerPolylineAPI.removePolyline

requestNodeIdsByRect

• requestNodeIdsByRect(x, y, width, height, includeOverlappingNodes?): Promise<number[]>

• Returns a List of all NodeIds which are included or overlapped by the specified 2D screen space Rectangle.

  Parameters

  • x: number

    Specifies the X-Coordinate of the 2D screen space Rectangle.

  • y: number

    Specifies the Y-Coordinate of the 2D screen space Rectangle.

  • width: number

    Specifies the width of the 2D screen space Rectangle.

  • height: number

    Specifies the height of the 2D screen space Rectangle.

  • Optional includeOverlappingNodes: boolean

    Specifies that the result should include Nodes which overlap the specified 2D screen space Rectangle as well.

  Returns Promise<number[]>

  List of all NodeIds which are included or overlapped by the specified 2D screen space Rectangle.

requestScreenshot

• requestScreenshot(width?, height?, mimeType?, resetCanvasSize?): Promise<string>

• Requests a screenshot from the current view.

  Parameters

  • Optional width: number

    The width of the requested screenshot. If not specified it uses the width of the current view.

  • Optional height: number

    The height of the requested screenshot. If not specified it uses the height of the current view.

  • Optional mimeType: "image/png" | "image/jpeg"

    A string indicating the image format. The default type is image/png.

  • Optional resetCanvasSize: boolean

  Returns Promise<string>

  • A string containing the requested screenshot as dataUrl.

requestTopologyHandlesByRect

• requestTopologyHandlesByRect(x, y, width, height): Promise<TopologyHandle[]>

• Returns a List of all TopologyHandles which ared included & overlapped by the specified 2D screen space Rectangle.

  Parameters

  • x: number

    Specifies the X-Coordinate of the 2D screen space Rectangle.

  • y: number

    Specifies the Y-Coordinate of the 2D screen space Rectangle.

  • width: number

    Specifies the width of the 2D screen space Rectangle.

  • height: number

    Specifies the height of the 2D screen space Rectangle.

  Returns Promise<TopologyHandle[]>

  List of all TopologyHandles which are included & overlapped by the specified 2D screen space Rectangle.

reset

• reset(): void

• The viewer is destroyed and reinitialized with renderSetup selection

  Returns void

resetSetting

• resetSetting(viewerSetting): void

• Resets the value of a viewer setting.

  Parameters

  • viewerSetting: string

    The name of the viewer setting that should be reset.

  Returns void

restoreInitView

• restoreInitView(): void

• Sets the camera to the initial position

  Returns void

setActiveItem

• setActiveItem(id, type): void

• Parameters

  • id: number

  • type: ActiveItemType

  Returns void

  Inherited from ViewerGizmoAPI.setActiveItem

setCORGizmoVisible

• setCORGizmoVisible(flag): void

• Parameters

  • flag: boolean

  Returns void

  Inherited from ViewerGizmoAPI.setCORGizmoVisible

setCenterOfRotation

• setCenterOfRotation(center?): Promise<void>

• Sets the center of rotation being the point around which the inspection camera rotates. If no center parameter is supplied the center of rotation is set to the center of all currently loaded models.

  Parameters

  • Optional center: Float32Array | [number, number, number]

    The center of rotation

  Returns Promise<void>

setGizmoTransformationMode

• setGizmoTransformationMode(mode): void

• Parameters

  • mode: GizmoTransformationMode

  Returns void

  Inherited from ViewerGizmoAPI.setGizmoTransformationMode

setInteractionLevel

• setInteractionLevel(level): void

• Sets the Viewer interaction level.

  Parameters

  • level: ViewerInteractionLevel

    Specifies the interaction level.

  Returns void

  Inherited from ViewerInteractionAPI.setInteractionLevel

setProjectionMatrix

• setProjectionMatrix(matrix): void

• Sets the current projection matrix.

  Parameters

  • matrix: Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

    The new projection matrix

  Returns void

setView

• setView(position, target, upVector?, transitionTime?): Promise<void>

• Sets the camera position, its target and the up-vector. If the up-vector is not defined, the previous up-vector is kept.

  Parameters

  • position: Float32Array | [number, number, number]

    Specifies the new position or center of the camera

  • target: Float32Array | [number, number, number]

    Specifies the point on which the camera will look

  • Optional upVector: Float32Array | [number, number, number]

    Specifies the new orientation of the camera

  • Optional transitionTime: number

    Defines the transition time for the camera movement

  Returns Promise<void>

setViewMatrix

• setViewMatrix(matrix, transitionTime?): Promise<void>

• Sets the camera view matrix.

  Parameters

  • matrix: Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

    The new view matrix for the camera

  • Optional transitionTime: number

    Defines the transition time for the camera movement

  Returns Promise<void>

showAxisMarker

• showAxisMarker(values, scale?, index?): void

• Parameters

  • values: Float32Array | [number, number, number, number, number, number]

  • Optional scale: number

  • Optional index: number

  Returns void

  Inherited from ViewerGizmoAPI.showAxisMarker

showBoxGizmo

• showBoxGizmo(properties?): void

• Shows the BoxGizmo based on the specified properties. If the BoxGizmo is already visible the specified properties will be updated.

  Parameters

  • Optional properties: BoxGizmoProperties

    The properties of the BoxGizmo.

  Returns void

  Inherited from ViewerGizmoAPI.showBoxGizmo

showClippingBoxGizmo

• showClippingBoxGizmo(clipRoomID): void

• Parameters

  • clipRoomID: number

  Returns void

  Inherited from ViewerGizmoAPI.showClippingBoxGizmo

showPointMarker

• showPointMarker(position, index?): void

• Parameters

  • position: Float32Array | [number, number, number]

  • Optional index: number

  Returns void

  Inherited from ViewerGizmoAPI.showPointMarker

showSelectionBoxGizmo

• showSelectionBoxGizmo(size?, transform?): void

• Parameters

  • Optional size: Float32Array | [number, number, number]

  • Optional transform: Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

  Returns void

  Inherited from ViewerGizmoAPI.showSelectionBoxGizmo

showSelectionBoxGizmoFromVolume

• showSelectionBoxGizmoFromVolume(volume?): void

• Parameters

  • Optional volume: BoxVolume

  Returns void

  Inherited from ViewerGizmoAPI.showSelectionBoxGizmoFromVolume

showSelectionTransformationGizmo

• showSelectionTransformationGizmo(nodeIds): void

• Parameters

  • nodeIds: number[]

  Returns void

  Inherited from ViewerGizmoAPI.showSelectionTransformationGizmo

takeScreenshot

• takeScreenshot(callback, mimeType?, width?, height?): void

• Takes a screenshot from the current view.

  Parameters

  • callback: ((dataUrl) => void)

    A callback containing the result which is executed after all Rendering operations are finished.

    • • (dataUrl): void

      • Parameters

        • dataUrl: string

        Returns void

  • Optional mimeType: string

    A string indicating the image format. The default type is image/png.

  • Optional width: number

    The width of the requested screenshot. If not specified it uses the width of the current view.

  • Optional height: number

    The height of the requested screenshot. If not specified it uses the height of the current view.

  Returns void

  Deprecated

  takeScreenshot is deprecated, please use requestScreenshot instead

toggleStatsViewer

• toggleStatsViewer(): void

• Toggles the visibility of the Viewer statistics window.

  Returns void

  Inherited from ViewerGizmoAPI.toggleStatsViewer

updateGeometry

• updateGeometry(id, data): void

• Parameters

  • id: number

  • data: UserGeometryData

  Returns void

  Inherited from ViewerUserGeometryAPI.updateGeometry

---

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

Please tell us more about what's wrong: Name E-Mail Problem (required)