Edge
A straight line segment between two 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”The curve or arc this edge belongs to, or null.
readonlyend:Vertex
The vertex the edge ends at.
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”
readonlyfaces: readonlyFace[]
The faces the edge bounds: none for a loose edge, two between neighboring faces.
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
Length in the edge’s own context, in meters.
material
Section titled “material”material:
Material|null
The edge’s material, or null for the default; assign a material of this model inside
Model.operation. Like SketchUp’s default style, Modlumi draws every edge in the
edge color, but the material is kept for plugins and saved files.
smooth
Section titled “smooth”smooth:
boolean
Whether the edge is marked for smooth shading across its faces; assign inside Model.operation.
soft:
boolean
Whether the edge’s line is suppressed so its faces read as one surface; assign inside Model.operation. The solids from Entities.addCylinder and its relatives soften their facet edges.
readonlystart:Vertex
The vertex the edge starts at.
readonlytype:"Edge"
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”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"
Inherited from
Section titled “Inherited from”transformedLength()
Section titled “transformedLength()”transformedLength(
transformation):number
The edge’s length after a transformation, such as Model.activeTransformation for world lengths of edges in the context being edited.
Parameters
Section titled “Parameters”transformation
Section titled “transformation”Returns
Section titled “Returns”number