Model

The document the script runs against. Get it from activeModel.

Properties

activeEntities

readonly activeEntities: Entities

The entities of the context being edited, such as an open group.

---

activeView

readonly activeView: View

The view for image export.

---

definitions

readonly definitions: readonly ComponentDefinition[]

All component and group definitions.

---

entities

readonly entities: Entities

The entities at the model root.

---

materials

readonly materials: readonly Material[]

All materials.

---

selection

readonly selection: Selection

The current selection.

Methods

isDrawingElementVisible()

isDrawingElementVisible(path, options?): boolean

Whether an element is visible, taking hidden ancestors into account. path lists the element’s ancestors from the model root down to the element itself.

Parameters

path

readonly DrawingElement[]

options?

VisibilityOptions

Returns

boolean

---

operation()

operation<T>(name, body): T

Runs body as one named undo step and returns its result. Every edit must happen inside an operation. A thrown error, or any failed edit inside body (even when caught), rolls the whole operation back. Empty operations add no undo step. Operations can’t be nested, and body must be synchronous.

Type Parameters

T

T

Parameters

name

string

body

() => T

Returns

T

---

redo()

redo(): void

Redoes the last undone operation. Not allowed inside an operation.

Returns

void

---

undo()

undo(): void

Undoes the last operation. Not allowed inside an operation.

Returns

void