SectionPlane
A section plane. While it’s its context’s active plane it cuts away the geometry on the side its normal points away from, in its context and every group and component inside it. A context has at most one active plane.
Extends
Section titled “Extends”Properties
Section titled “Properties”bounds
Section titled “bounds”
readonlybounds:BoundingBox|null
The element’s bounds in its context’s coordinates, or null when it has no geometry.
A group’s or instance’s bounds enclose its transformed contents and may be a little
larger than they are.
Inherited from
Section titled “Inherited from”entityId
Section titled “entityId”
readonlyentityId:number
Identifier that stays the same for the entity’s lifetime, including across undo and redo.
Inherited from
Section titled “Inherited from”hidden
Section titled “hidden”hidden:
boolean
The element’s own hidden flag; assign inside Model.operation. Hidden ancestors are not taken into account; use Model.isDrawingElementVisible for that.
Inherited from
Section titled “Inherited from”isDeleted
Section titled “isDeleted”
readonlyisDeleted:boolean
Whether the entity was deleted, for example by an edit or by undo.
Inherited from
Section titled “Inherited from”isValid
Section titled “isValid”
readonlyisValid:boolean
Whether the entity still exists in the model.
Inherited from
Section titled “Inherited from”normal
Section titled “normal”
readonlynormal:Vector3d
Unit normal pointing toward the geometry the plane keeps.
readonlypoint:Point3d
A point on the plane, in its context’s coordinates.
readonlytype:"SectionPlane"
The concrete class name, for narrowing unions such as AnyElement.
Overrides
Section titled “Overrides”visible
Section titled “visible”visible:
boolean
The inverse of hidden; assign inside Model.operation.
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”active
Section titled “active”Get Signature
Section titled “Get Signature”get active():
boolean
Whether this is its context’s active plane. Activating it deactivates the context’s other planes.
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set active(
value):void
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Get Signature
Section titled “Get Signature”get layer():
Layer|null
The layer the element is on, or null for the default layer; assign inside
Model.operation. A hidden layer hides the element whatever hidden says.
Needs the "layers" feature.
Returns
Section titled “Returns”Layer | null
Set Signature
Section titled “Set Signature”set layer(
value):void
Parameters
Section titled “Parameters”Layer | null
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get name():
string
The plane’s name, shown in its properties.
Returns
Section titled “Returns”string
Set Signature
Section titled “Set Signature”set name(
value):void
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
symbol
Section titled “symbol”Get Signature
Section titled “Get Signature”get symbol():
string
The short symbol shown on the plane, such as "A".
Returns
Section titled “Returns”string
Set Signature
Section titled “Set Signature”set symbol(
value):void
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Methods
Section titled “Methods”reverse()
Section titled “reverse()”reverse():
void
Turns the plane around, so it keeps the side it cut away.
Returns
Section titled “Returns”void
toJSON()
Section titled “toJSON()”toJSON():
object
JSON.stringify writes the entity as its type and entityId, plus its
name when it has one, such as { "type": "Group", "entityId": 12, "name": "Wheel" }.
Returns
Section titled “Returns”object
entityId
Section titled “entityId”entityId:
number
optionalname?:string
type:
"Material"|"Vertex"|"Edge"|"Face"|"Loop"|"EdgeUse"|"Curve"|"ArcCurve"|"ComponentDefinition"|"ComponentInstance"|"Group"|"Layer"|"Guide"|"Text"|"LinearDimension"|"SectionPlane"