Dimension
Extends SceneObject
Inherited from SceneObject
name()
name(value: string): this
Sets a custom display name for this object, overriding the default type-based name.
| Parameter | Type | Description |
|---|---|---|
value | string | The display name to assign. |
Methods
labelAt()
labelAt(u: NumberParam, v: NumberParam): this
Places the dimension's value where it reads best. This is what the sketcher writes when a dimension is placed as it is drawn, or dragged afterwards; it only moves the annotation and never changes the geometry. Without it the value is laid out automatically.
The two numbers are sketch units in the dimension's own frame, so the placement follows the geometry when it moves or turns:
distance()andoffsetFrom():uslides the value along the dimension line from its middle,vis how far the dimension line stands off the span it measures (either side).radius()anddiameter(): the value sits(u, v)from the center along the sketch's x and y; the leader turns to pass through it. An ellipse'sradius(el, r, 'x')reads like a distance instead: along and off its semi-axis.angle(): the value sitsuout along the bisector of the measured angle from the corner andvto its side; the arc is drawn through it.
| Parameter | Type | Description |
|---|---|---|
u | NumberParam | Position along the dimension's frame, in sketch units |
v | NumberParam | Position across the dimension's frame, in sketch units |