Geoportal Extension for OpenLayers 3 API Reference

Class: MeasureLength

ol.control.MeasureLength

Length measurement Control. Allows users to draw a path on OL3 map and have its length computed and displayed.

new MeasureLength(options)

Ol3/Controls/Measures/MeasureLength.js, line 47
Name Type Description
options Object

options for function call.

Name Type Default Description
geodesic Boolean true optional

If true, length will be computed on the global sphere using the ol.Sphere.haversineDistance() function. Otherwise, length will be computed on the projected plane.

styles Object {} optional

styles used when drawing. Specified with following properties.

Name Type Default Description
pointer Object {} optional

Style for mouse pointer when drawing the path. Specified with an ol.style.Image subclass object.

start Object {} optional

Line Style when drawing. Specified with an ol.style.Style object.

finish Object {} optional

Line Style when finished drawing. Specified with an ol.style.Style object.

Example
var measureLength = new ol.control.MeasureLength({
   geodesic : false
});

Extends

  • ol.control.Control

Methods

setMap(map)

Ol3/Controls/Measures/MeasureLength.js, line 111

Overwrite OpenLayers setMap method

Name Type Description
map ol.Map

Map.