Skip to main content

Import

Inheritance: extends OPElement implements IShape, IPlaceable

Constructor

DatumType.GRID
GridKind
GridAxis[]
GridAxis[]
GridHead
string[]
Characters omitted from auto-generated alpha labels.
number
Elevation (world Y) at which the grid is drawn.
boolean
Render axis lines as dashed. Default false (solid).
string
string
number
Line / symbol colour. Defaulted per subtype when omitted.
number
Line weight for the datum’s 2D representation.
DatumVisibility
Whether this datum is shown in plan / model views.

Properties

string
string
Map<string, THREE.Object3D>
Map<string, THREE.Object3D>
boolean
boolean
boolean
Event<null>
GridOptions
string
DatumType
Read-only.
boolean
boolean

Methods

editableSchema

Self-describing editable surface; a host inspector renders this generically.

rectangular

Build a rectangular grid from spacing arrays and return the resulting options so callers can pass them straight into the constructor.

generateLabels

Sequence of axis labels following ISO 5457 / US NCS conventions: A, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, ... (I and O skipped).

move

Translate this element by delta (world-space, meters).

rotate

Rotate this element by angleDeg around axis (default Y-up), pivoted at anchor (default the element’s own centroid).

setOPConfig

getOPConfig

getEditAnchors

Two handles (start/end) per LINE axis, free on the grid’s elevation plane.

applyEditAnchor

setOPMaterial

setOPGeometry

getAxesSnapshot

Types

GridOptions

GridHead

number
required
Diameter of the bubble on the XZ plane in world units.
number
required
Text size for the bubble label.

GridLabelMode

GridAxis

string
required
GridAxisCurve
required
{ start?: boolean; end?: boolean; }
Which endpoint(s) carry a bubble.

GridKind

GridAxisCurve

Last modified on October 6, 2026