Measure Properties

Measure Properties

This page describes all measure event properties. All of these properties are only set when the measurement mode has a sensible value for them.

About Units :

A coordinate is expressed in the publication CRS unless another CRS was set using the setCRS() function of the API.
A distances is expressed in meters.
An area is expressed in squared meters.
A slope is expressed in percentages.
A volume is expressed in cubic meters.
An angle is expressed in degrees.
A heading is expressed in degrees.

Available properties :

coordinate : The unique coordinate of the measurement.
coordinates : The coordinates for all measurements.
errorXYZ : The measurement error distance for X, Y and Z.
errorXY : The measurement error distance for X and Y.
errorZ : The measurement error distance for Z.
lengthXY : The length of the string of measurements in X and Y.
lengthXYZ : The length of the string of measurements in X, Y and Z.
height : The height of a box holding all measurements and constructed points.
areaXY : The area defined by all measurements in X and Y.
areaXYZ : The area defined by all measurements in X, Y and Z.
slope : The slope defined by the first and second coordinates.
volume : The volume of the measurement.
baseline1 : The length of the first baseline.
baseline2 : The length of the second baseline.
angle : The angle defined by two lines.
heading : The heading defined by a vector (0° north, clockwise direction).

Note that the height property also takes 'construction points' into account. For example when using measurePointDrop mode, a point on the ground is constructed. The height property then holds the distance from the measurement to the constructed point on the ground.

Note on the errorXYZ, errorXY and errorZ fields : When the measurement mode needs multiple measurements, these properties holds the average error for all measurements made.

The table below describes which properties are returned when measuring in a specific measuring mode. On top are the measuring modes, on your left are the measurement properties.

Map Measurements

Below is an overview of the properties returned by the Map measurement functions.

Property	Since	Type	measurePoint	measureDistance	measurePolyline	measureAngle	measureAreaFree	measureAreaCircle
coordinate	10.5.2	<coordinate>	x
coordinates	10.5.2	[<coordinate>,…]		x	x		x	x
lengthXY	10.5.2	<float>		x	x		x	x
areaXY	10.5.2	<float>					x	x
angle	10.5.2	<float>				x
direction	10.5.2	<float>		x

Panorama Measurements

Below is an overview of the properties returned by the Panorama measurement functions.

Property	Since	Type	measurePoint	measurePointDrop	measureDistance ¹⁾	measurePolyline	measureAreaFree	measureVolume
coordinate	10.4.0	<coordinate>	x	x
errorXYZ	10.4.0	<float> (-1 → n/a)	x	x	x	x	x
errorXY	10.4.0	<float> (-1 → n/a)	x	x	x	x	x
errorZ	10.4.0	<float> (-1 → n/a)	x	x	x	x	x
height	10.4.0	<float>		x	x	x	x	x
coordinates	10.4.0	[<coordinate>,…]			x	x	x
lengthXY	10.4.0	<float>			x	x	x
lengthXYZ	10.4.0	<float>			x	x	x
areaXY	10.4.0	<float>					x
areaXYZ	10.4.0	<float>					x
slope	10.5.1	<float>			x
volume	10.5.1	<float>						x
baseline1	10.5.1	<float>						x
baseline2	10.5.1	<float>						x

Measurement errors are only available when measuring using triangulation.

Oblique Measurements

Below is an overview of the properties returned by the Oblique measurement functions.

Property	Since	Type	measurePoint	measureDistanceLine	measurePolyline	measureAreaFree
coordinate	11.1.0	<coordinate>	x
errorXYZ	11.1.0	<float> (-1 → n/a)	x	x	x	x
errorXY	11.1.0	<float> (-1 → n/a)	x	x	x	x
errorZ	11.1.0	<float> (-1 → n/a)	x	x	x	x
height	11.1.0	<float>		x	x	x
coordinates	11.1.0	[<coordinate>,…]		x	x	x
lengthXY	11.1.0	<float>		x	x	x
lengthXYZ	11.1.0	<float>		x	x	x
areaXY	11.1.0	<float>				x
areaXYZ	11.1.0	<float>
slope	11.1.0	<float>			x

Measurement errors are only available when measuring using triangulation.

¹⁾

Applies to measureDistanceLine, measureDistanceTri and measureDistanceBase.

Table of Contents

Measure Properties

Map Measurements

Panorama Measurements

Oblique Measurements