DrawingPlaneAPI

• webVis API Reference
• DrawingPlaneAPI

Interface DrawingPlaneAPI

Hierarchy

• DrawingPlaneAPI
  • ContextAPI

Index

Methods

changeDrawingPlane createDrawingPlane getDrawingPlaneData getDrawingPlanes removeDrawingPlane

Methods

changeDrawingPlane

• changeDrawingPlane(drawingPlaneId, properties): 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?): number
• Experimental

  Creates a new DrawingPlane with the specified properties.

  Parameters

  • Optional properties: DrawingPlaneProperties

    Initial properties of the created Drawing.

  Returns number

  The ID of the newly created Drawing.

getDrawingPlaneData

• getDrawingPlaneData(drawingPlaneId): 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, safe?): RemoveState
• Experimental

  Removes a DrawingPlane with the specified ID. If a DrawingPlane is part of a Snapshot the removal will fail with the State REFERENCED_BY_SNAPSHOT.

  Parameters

  • drawingPlaneId: number

    The ID of the Drawing you want to remove.

  • Optional safe: boolean

    Performs a safe remove which interrupt the removal process if the Drawing is part of one or more Snapshots.

  Returns RemoveState