Skip to content

Vibe coding a plugin? Teach your agent Modlumi first. Works with Claude Code, Codex, Cursor and more.

Guide

A construction point or infinite construction line. Guides don’t form faces.

readonly bounds: 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.

DrawingElement.bounds


readonly direction: Vector3d

Direction of the guide line; the zero vector for a guide point.


readonly entityId: number

Identifier that stays the same for the entity’s lifetime, including across undo and redo.

DrawingElement.entityId


hidden: boolean

The element’s own hidden flag; assign inside Model.operation. Hidden ancestors are not taken into account; use Model.isDrawingElementVisible for that.

DrawingElement.hidden


readonly isDeleted: boolean

Whether the entity was deleted, for example by an edit or by undo.

DrawingElement.isDeleted


readonly isPoint: boolean

Whether the guide is a point rather than a line.


readonly isValid: boolean

Whether the entity still exists in the model.

DrawingElement.isValid


readonly position: Point3d

The guide point, or a point on the guide line.


readonly type: "Guide"

The concrete class name, for narrowing unions such as AnyElement.

DrawingElement.type


visible: boolean

The inverse of hidden; assign inside Model.operation.

DrawingElement.visible

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.

Layer | null

set layer(value): void

Layer | null

void

DrawingElement.layer

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" }.

object

entityId: number

optional name?: string

type: "Material" | "Vertex" | "Edge" | "Face" | "Loop" | "EdgeUse" | "Curve" | "ArcCurve" | "ComponentDefinition" | "ComponentInstance" | "Group" | "Layer" | "Guide" | "Text" | "LinearDimension" | "SectionPlane"

DrawingElement.toJSON