DimensionRadialRef

A lightweight placeholder for a DimensionRadial that hasn’t been fully loaded yet.

When you create radial dimensions inside a SketchupOperation, the API returns DimensionRadialRef objects immediately, before SketchUp has finished processing the annotation. You can often pass these refs to other operation methods, but if you need the full DimensionRadial instance, you can request it with entityForRef().

A radial dimension annotates the radius of a circle or arc — it displays an “R” prefix followed by the radius value, with a leader line pointing to the curve.

Think of a ref as a “claim ticket” — it guarantees a radial dimension will exist after the operation commits, but it doesn’t carry the dimension’s properties yet. A ref is only valid inside the performOperation callback that created it — do not return it or use it after the operation commits.

Example

let model = await SketchUpApi.getActiveModel();

await model.performOperation(async op => {
  // Create a circle to annotate
  const circle = op.createCircle(
    model,
    [0, 0, 0],   // center
    [0, 0, 1],   // normal
    50, 24       // radius, segments
  );
  // Attach a radial dimension
  const dimRef = op.createDimensionRadial(
    model,
    circle.curve,
    [75, 0, 0]   // leader break point
  );
}, 'Annotate a circle radius');

See

Since

SDK 2.23.0 Protocol 1.20.0

Properties

sketchupId

readonly sketchupId: SketchupId

type

readonly type: DimensionRadial = EntityType.DimensionRadial

Accessors

typeName

Get Signature

get typeName(): string

Returns a named variant of the type field.

Since

SDK 2.35.0

Returns

string

Methods

toString()

toString(): string

Returns

string