DrawingAPI#

Interface DrawingAPI

The DrawingAPI provides basic functionalities to interact with 2D Drawings created with the help of the ViewerDrawingAPI.

Hierarchy

DrawingAPI
- ContextAPI

Index

Methods

changeDrawing createDrawing getDrawings removeDrawing requestDrawingData

Methods

changeDrawing

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

createDrawing

createDrawing(data, properties?): 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.

getDrawings

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

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

removeDrawing

removeDrawing(drawingId, safe?): RemoveState
Removes a Drawing with the specified id. If a Drawing is part of a Snapshot the removal will fail with the State REFERENCED_BY_SNAPSHOT
Parameters
- drawingId: number
  
  The id of the to be removed Drawing.
- Optional safe: boolean
  
  Performs a safe remove which interrupt the removal process if the Drawing is part of one or more Snapshots.
Returns RemoveState

requestDrawingData

requestDrawingData(drawingId): 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.