ViewerDrawingAPI¶
Interface ViewerDrawingAPI
interface ViewerDrawingAPI {
cancelDrawingMode(): void;
enterDrawingMode(): void;
leaveDrawingMode(
options?: ViewerDrawingProcessOptions,
): Promise<ViewerDrawingResult>;
}
cancelDrawingMode(): void;
enterDrawingMode(): void;
leaveDrawingMode(
options?: ViewerDrawingProcessOptions,
): Promise<ViewerDrawingResult>;
}
Hierarchy (View Summary)
- ViewerDrawingAPI
Index
Methods
cancel
enter
leave
- 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: ViewerDrawingProcessOptionsOptions to configure the result of the processing.
Returns Promise<ViewerDrawingResult>
The processed 2D drawing data.
The ViewerDrawingAPI provides basic functionalities to control the 2D Drawing Mode and the processed Output.