LinearDimension
A dimension showing the distance between two points. Its dimension line runs parallel to
them, moved away by offset. Ends that lie on vertices follow them when an edit moves the
vertices.
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”
readonlyend:Point3d
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”length
Section titled “length”
readonlylength:number
The distance between start and end, in meters in the context’s coordinates.
offset
Section titled “offset”
readonlyoffset:Vector3d
From the measured points to the dimension line, perpendicular to them.
readonlystart:Point3d
The measured points, in the dimension’s context’s coordinates.
readonlytype:"LinearDimension"
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”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 text():
string
The label’s text override. Empty shows the measured length; otherwise each <> in it
stands for the length, as in "Width <>".
Returns
Section titled “Returns”string
Set Signature
Section titled “Set Signature”set text(
value):void
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Methods
Section titled “Methods”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"