setMeasureSettings
Sets the measure tool settings.
Example
Usage
const settings = {
appendMeasures: true,
conversionFactor: 1000,
decimals: 0,
labelMode: "segmentLength",
numberFormatter: (value) => String(value)
};
viewer3d.setMeasureSettings(settings);Parameters
settings
Settings for the measure tool.
Type | Required |
|---|---|
Object | Yes |
The default unit for measurements is meters.
Properties
Name | Type | Required | Description |
|---|---|---|---|
appendMeasures | Boolean | No | Replace any existing measures when using addMeasure method |
conversionFactor | Number | No | Conversion factor applied to measure values |
decimals | Number | No | Number of decimals to display for measure values |
labelMode | String | No | Display mode for measure values |
numberFormatter | Function | No | Custom number formatter function for measure values |
labelMode
The following label modes are available:
- pointDistance
- segmentLength
- segmentIndex