Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

ViewerDrawingAPI

• webVis API Reference
• ViewerDrawingAPI

Interface ViewerDrawingAPI

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

interface ViewerDrawingAPI {
    cancelDrawingMode(): void;
    enterDrawingMode(): void;
    leaveDrawingMode(
        options?: ViewerDrawingProcessOptions,
    ): Promise<ViewerDrawingResult>;
}

Hierarchy (View Summary)

• 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?: ViewerDrawingProcessOptions,
  ): 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

  • Optionaloptions: ViewerDrawingProcessOptions

    Options to configure the result of the processing.

  Returns Promise<ViewerDrawingResult>

  The processed 2D drawing data.