ComponentInstance
One placement of a component definition.
Extends
Section titled “Extends”Properties
Section titled “Properties”definition
Section titled “definition”
readonlydefinition:ComponentDefinition
The definition this instance places.
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”material
Section titled “material”
readonlymaterial:Material|null
The material applied to the whole instance, or null.
name:
string
Name of this placement only; assign inside Model.operation.
transformation
Section titled “transformation”transformation:
Transformation
Maps definition-local coordinates into the parent context. Assigning replaces the placement; do so inside Model.operation.
readonlytype:"ComponentInstance"
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”Methods
Section titled “Methods”transform()
Section titled “transform()”transform(
transformation):void
Applies a transformation in the parent context, so the new placement is
transformation.multiply(old). Call it inside Model.operation.
Parameters
Section titled “Parameters”transformation
Section titled “transformation”Returns
Section titled “Returns”void