DrawingPlaneAPI#

Interface DrawingPlaneAPI

Hierarchy

Methods

  • 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.

  • Experimental

    Creates a new DrawingPlane with the specified properties.

    Parameters

    Returns number

    The ID of the newly created Drawing.

  • 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.

  • Experimental

    Returns all available DrawingPlane IDs.

    Returns number[]

    An Array of all available DrawingPlane IDs.

  • 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


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?
Please tell us more about what's wrong: