DrawingPlaneAPI¶

Interface DrawingPlaneAPI

interface DrawingPlaneAPI {
    changeDrawingPlane(
        drawingPlaneId: number,
        properties: DrawingPlaneProperties,
    ): DrawingPlaneProperties;
    createDrawingPlane(properties?: DrawingPlaneProperties): number;
    getDrawingPlaneData(drawingPlaneId: number): DrawingPlaneProperties;
    getDrawingPlanes(): number[];
    removeDrawingPlane(drawingPlaneId: number, safe?: boolean): RemoveState;
}

Hierarchy (View Summary)

DrawingPlaneAPI
- ContextAPI

Index

Methods

changeDrawingPlane createDrawingPlane getDrawingPlaneData getDrawingPlanes removeDrawingPlane

Methods

changeDrawingPlane

changeDrawingPlane(
drawingPlaneId: number,
properties: DrawingPlaneProperties,
): DrawingPlaneProperties
Experimental
Changes one or more properties of a DrawingPlane with the specified ID.
Parameters
- drawingPlaneId: number
  The ID of the DrawingPlane you want to change.
- properties: DrawingPlaneProperties
  The properties of the DrawingPlane you want change.
Returns DrawingPlaneProperties
An Object with the changed Properties.

createDrawingPlane

createDrawingPlane(properties?: DrawingPlaneProperties): number
Experimental
Creates a new DrawingPlane with the specified properties.
Parameters
- Optionalproperties: DrawingPlaneProperties
  Initial properties of the created Drawing.
Returns number
The ID of the newly created Drawing.

getDrawingPlaneData

getDrawingPlaneData(drawingPlaneId: number): DrawingPlaneProperties
Experimental
Returns the DrawingPlane properties for the specified DrawingPlane ID.
Parameters
- drawingPlaneId: number
  The ID of the DrawingPlane you want to get the Data for.
Returns DrawingPlaneProperties
The requested DrawingPlane properties.

getDrawingPlanes

getDrawingPlanes(): number[]
Experimental
Returns all available DrawingPlane IDs.

Returns number[]
An Array of all available DrawingPlane IDs.

removeDrawingPlane

removeDrawingPlane(drawingPlaneId: number, safe?: boolean): RemoveState
Experimental
Removes a DrawingPlane with the specified ID. If a DrawingPlane is part of a Snapshot the removal will fail with the State RemoveState.REFERENCED_BY_SNAPSHOT.
Parameters
- drawingPlaneId: number
  The ID of the Drawing you want to remove.
- Optionalsafe: boolean
  Performs a safe remove which interrupt the removal process if the Drawing is part of one or more Snapshots.
Returns RemoveState

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