Class: MeasureParameters

mapboxgl.supermap.MeasureParameters

The MeasureParameters class.

new mapboxgl.supermapMeasureParameters(geometry, options)

MeasureParameters.js, line 5
Name Type Description
geometry Object

The geometry object to measure.
options Object

The parameters.

Name Type Default Description
unit mapboxgl.supermapUnit mapboxgl.supermapUnit.METER optional

The measure unit.
prjCoordSys string optional

Used to specify the projection of the measure.
distanceMode string "Geodesic" optional

Used to specify the mode of the measure is 'Geodesic' or 'Planar'.

Members

distanceModestring

Used to specify the mode of the measure is 'Geodesic' or 'Planar'.

Default Value:
"Geodesic"
Example
var param = new mapboxgl.supermapMeasureParameters(getmetry,{distanceMode:'Planar'});

geometryObject

The geometry object to measure. The point type could be: mapboxgl.supermapGeometry.Point|L.Point|L.GeoJSON|ol.geom.Point|ol.format.GeoJSON. The line type could be: mapboxgl.supermapGeometry.LineString|mapboxgl.supermapGeometry.LinearRing|L.Polyline|L.GeoJSON|ol.geom.LineString|ol.format.GeoJSON. The polygon type could be: mapboxgl.supermapGeometry.Polygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON.

prjCoordSysstring

Used to specify the projection of the measure.

unitmapboxgl.supermapUnit

The measure unit.

Default Value:
mapboxgl.supermapUnit.METER

Methods

destroy()

MeasureParameters.js, line 57

Disposes the resource. The property that references resource is set to null.