ViewerDrawingAPI

• webVis API Reference
• ViewerDrawingAPI

Interface ViewerDrawingAPI

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

Hierarchy

• ViewerDrawingAPI
  • ViewerAPI

Index

Methods

cancelDrawingMode enterDrawingMode leaveDrawingMode

Methods

cancelDrawingMode

• cancelDrawingMode(): void

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

  Returns void

enterDrawingMode

• enterDrawingMode(): void

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

  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.