UnitOptions

The measurement unit settings for the model — length, area, volume, angle, and snapping.

Access it from model.options.unitOptions. Use it to read which units and precision the model is using, or update them.

Example

let model = await SketchUpApi.getActiveModel();
let opts = model.options.unitOptions;

console.log(opts.lengthUnit);
// => 0 (LengthUnit.Inches)
console.log(opts.lengthPrecision);
// => 2 (decimal places)

// Switch to meters
// 4 = LengthUnit.Meters
await opts.update({ LengthUnit: 4 });
let updated = await opts.refresh();
console.log(updated.lengthUnit);
// => 4 (LengthUnit.Meters)

See

Properties

anglePrecision

readonly anglePrecision: number

Number of decimal places shown for angle measurements, like 1.

angleSnapEnabled

readonly angleSnapEnabled: boolean

Whether angle snapping is enabled when rotating.

areaPrecision

readonly areaPrecision: number

Number of decimal places shown for area measurements.

areaUnit

readonly areaUnit: AreaUnit

The unit used to display area measurements, like AreaUnit.SquareFeet.

forceInchDisplay

readonly forceInchDisplay: boolean

Controls how inch quotes are shown in the SketchUp UI. If true, show 5" for example, vs 5.

lengthFormat

readonly lengthFormat: LengthFormat

The format used to display lengths — decimal, architectural (feet and inches), fractional, or engineering.

lengthPrecision

readonly lengthPrecision: number

Number of decimal places shown for length measurements, like 2.

lengthSnapEnabled

readonly lengthSnapEnabled: boolean

Whether length snapping is enabled when drawing.

lengthSnapLength

readonly lengthSnapLength: number

The snap increment for length input when snapping is enabled.

lengthUnit

readonly lengthUnit: LengthUnit

The unit used to display lengths, like LengthUnit.Inches.

name

readonly name: string

The internal name of this options provider, like 'UnitsOptions'.

options

readonly options: OptionsProvider

snapAngle

readonly snapAngle: number

The snap increment for angle input in degrees when snapping is enabled.

suppressUnitsDisplay

readonly suppressUnitsDisplay: boolean

Whether unit labels are hidden from dimension and length displays.

volumePrecision

readonly volumePrecision: number

Number of decimal places shown for volume measurements.

volumeUnit

readonly volumeUnit: VolumeUnit

The unit used to display volume measurements, like VolumeUnit.CubicFeet.

Methods

refresh()

refresh(): Promise<UnitOptions>

Re-fetches these options from SketchUp to pick up any changes the user has made since this snapshot was taken.

Returns

Promise<UnitOptions>

Since

SDK 1.18.0

toString()

toString(): string

Returns

string

update()

update(updates): Promise<string[]>

Applies updates to the unit settings. Returns an array of any keys that were rejected as invalid.

Parameters

Parameter	Type	Description
`updates`	`UnitOptionsUpdate`	the properties to change

Returns

Promise<string[]>

rejected keys, or an empty array on success

Since

SDK 1.18.0 protocol 1.15.0