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.

DrawingPlaneAPI

• webVis API Reference
• 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