Skip to main content
Use it for furniture, equipment and other objects that are not walls, slabs or roofs. One definition gives a 2D plan symbol and a 3D model.

Import

Example

Notes

  • The definition uses metres.
  • The input can be text, a definition object, or options with a source.
  • Use updateNodeProperty or setOPConfig to change the element. An unknown node id throws an error.
  • getOPBuffer returns the definition as text.
  • Start the geometry kernel before you create this object. See Floorkit.
Inheritance: extends Polyline implements IShape, PlanVectorExportable, PortOwner

Constructor

Properties

string
Map<string, THREE.Object3D>
Map<string, THREE.Object3D>
boolean
boolean
boolean
OpenElementConfig
string
Read-only.
boolean
string
boolean
boolean

Methods

parseBuffer

normalizeDefinition

getOPBuffer

getAnchorDefinition

getAnchorMatrix

getExportRoots

toDrawing

Standardized plan primitives from the asset’s authored 2D profile view.

setOPConfig

beginEdit

Start one live edit; a second beginEdit before endEdit keeps the first start.

endEdit

End the live edit; its exact undo and redo, or undefined when no option changed.

getOPConfig

getControlSchema

updateNodeProperty

getEditAnchors

applyEditAnchor

Apply a previewed handle drag.

dispose

setConfig

setOPGeometry

setOPMaterial

Types

PortOwner

OpenElementConfig

OpenElementInput

OpenElementDefinition

AnchorDefinition

ControlSchema

DistributionPort

string
required
PortDomain
required
string
required
Free-form but conventional: “supplyAir”, “chilledWaterSupply”, “power”.
PortFlowDirection
required
Placement
required
Local placement on the owning element.
PortProfile
required
Cross-section the connecting run must match.
boolean
Chain-internal port of a generated run piece. Regenerated wholesale on every path edit, so external connections must never target it — the graph rejects such connects with INTERNAL_PORT.
Record<string, string>

OpenElementOptions

OpenElementDimensions

OpenElementAnchors

PortDefinition

A distribution port authored on a .op asset.

OpenElementDefinitions

OpenElementProfileView

OpenElementModelView

NodeControlDescriptor

PortDomain

PortFlowDirection

PortProfile

Cross-section a connecting run must match (or bridge with a transition).

DefinitionNode

ProfileViewElement

ModelViewElement

PropertyDescriptor

ProfileNode

Curve3DNode

ModelNode

OperationNode

RefNode

ControlPropertyType

ProfilePolygonNode

ProfilePolylineNode

ProfileArcNode

Curve3DPolylineNode

ModelCuboidNode

ModelCylinderNode

ModelSweepNode

Offset2DOpNode

Boolean3DOpNode

BaseElementNode

The package does not export this type by name.

Point2

The package does not export this type by name.

Point3

The package does not export this type by name.

ModelSweepDirectNode

ModelSweepRefNode

ColorValue

The package does not export this type by name.
Last modified on October 11, 2026