getMeasureSettings

Returns the current measure tool settings.
Example
﻿
Usage
JS
const measureSettings = viewer3d.getMeasureSettings();
const measureSettings = viewer3d.getMeasureSettings();
﻿
Return Value
The measure tool settings.
Type
Object
The default unit for measurements is meters.
Properties
Name
Type
Description
appendMeasures
Boolean
Replaces existing measures when using addMeasure method
conversionFactor
Number
Conversion factor applied to measure values
decimals
Number
Number of decimals displayed for measure values
labelMode
String
Position of measure label
labelMode
The following label modes are available:
pointDistance
segmentLength
segmentIndex
Example
JS
{
  appendMeasures: true,
  conversionFactor: 1000,
  decimals: 0,
  labelMode: "segmentLength",
};
{
  appendMeasures: true,
  conversionFactor: 1000,
  decimals: 0,
  labelMode: "segmentLength",
};
﻿
﻿

Type
Object

Name	Type	Description
appendMeasures	Boolean	Replaces existing measures when using addMeasure method
conversionFactor	Number	Conversion factor applied to measure values
decimals	Number	Number of decimals displayed for measure values
labelMode	String	Position of measure label

Updated 13 Sep 2024

Did this page help you?

enableMeasure

removeMeasure