DrawingAPI¶

Interface DrawingAPI

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

interface DrawingAPI {
    changeDrawing(
        drawingId: number,
        properties: DrawingProperties,
    ): DrawingProperties;
    createDrawing(
        data: ViewerDrawingResult,
        properties?: DrawingProperties,
    ): number;
    getDrawings(): number[];
    removeDrawing(drawingId: number, safe?: boolean): RemoveState;
    requestDrawingData(drawingId: number): Promise<DrawingData>;
}

Hierarchy (View Summary)

DrawingAPI
- ContextAPI

Index

Methods

changeDrawing createDrawing getDrawings removeDrawing requestDrawingData

Methods

changeDrawing

changeDrawing(
drawingId: number,
properties: DrawingProperties,
): 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: ViewerDrawingResult, properties?: DrawingProperties): number
Creates a new Drawing from the Output of the ViewerDrawingAPI.
Parameters
- data: ViewerDrawingResult
  The data generated with the help of the ViewerDrawingAPI.
- Optionalproperties: 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: number, safe?: boolean): RemoveState
Removes a Drawing with the specified id. If a Drawing is part of a Snapshot the removal will fail with the State RemoveState.REFERENCED_BY_SNAPSHOT
Parameters
- drawingId: number
  The id of the to be removed Drawing.
- Optionalsafe: 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: number): 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.

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