Allows for drawing of features for measurements.
| OpenLayers. | Allows for drawing of features for measurements. |
| Constants | |
| EVENT_TYPES | {Array(String)} Supported application event types. |
| Properties | |
| handlerOptions | {Object} Used to set non-default properties on the control’s handler |
| callbacks | {Object} The functions that are sent to the handler for callback |
| displaySystem | {String} Display system for output measurements. |
| geodesic | {Boolean} Calculate geodesic metrics instead of planar metrics. |
| displaySystemUnits | {Object} Units for various measurement systems. |
| delay | {Number} Number of milliseconds between clicks before the event is considered a double-click. |
| delayedTrigger | {Number} Timeout id of trigger for measurepartial. |
| persist | {Boolean} Keep the temporary measurement sketch drawn after the measurement is complete. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| cancel | Stop the control from measuring. |
| updateHandler | |
| measureComplete | Called when the measurement sketch is done. |
| measurePartial | Called each time a new point is added to the measurement sketch. |
| measure | |
| getBestArea | Based on the displaySystem returns the area of a geometry. |
| getArea | |
| getBestLength | Based on the displaySystem returns the length of a geometry. |
| getLength |
{Array(String)} Supported application event types. Register a listener for a particular event with the following syntax:
control.events.register(type, obj, listener);
Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened.
| measure | Triggered when a measurement sketch is complete. Listeners will receive an event with measure, units, order, and geometry properties. |
| measurepartial | Triggered when a new point is added to the measurement sketch. Listeners receive an event with measure, units, order, and geometry. |
{Number} Number of milliseconds between clicks before the event is considered a double-click. The “measurepartial” event will not be triggered if the sketch is completed within this time. This is required for IE where creating a browser reflow (if a listener is modifying the DOM by displaying the measurement values) messes with the dblclick listener in the sketch handler.
{Boolean} Keep the temporary measurement sketch drawn after the measurement is complete. The geometry will persist until a new measurement is started, the control is deactivated, or cancel is called.
| handler | {OpenLayers.Handler} |
| options | {Object} |
cancel: function()
Stop the control from measuring. If persist is true, the temporary sketch will be erased.
measureComplete: function( geometry )
Called when the measurement sketch is done.
| geometry | {OpenLayers.Geometry} |
measurePartial: function( point, geometry )
Called each time a new point is added to the measurement sketch.
| point | {OpenLayers.Geometry.Point} The last point added. |
| geometry | {OpenLayers.Geometry} The sketch geometry. |
getBestArea: function( geometry )
Based on the displaySystem returns the area of a geometry.
| geometry | {OpenLayers.Geometry} |
{Array([Float, String])} Returns a two item array containing the area and the units abbreviation.
getArea: function( geometry, units )
| geometry | {OpenLayers.Geometry} |
| units | {String} Unit abbreviation |
{Float} The geometry area in the given units.
getBestLength: function( geometry )
Based on the displaySystem returns the length of a geometry.
| geometry | {OpenLayers.Geometry} |
{Array([Float, String])} Returns a two item array containing the length and the units abbreviation.
getLength: function( geometry, units )
| geometry | {OpenLayers.Geometry} |
| units | {String} Unit abbreviation |
{Float} The geometry length in the given units.
Stop the control from measuring.
cancel: function()
updateHandler: function( handler, options )
Called when the measurement sketch is done.
measureComplete: function( geometry )
Called each time a new point is added to the measurement sketch.
measurePartial: function( point, geometry )
measure: function( geometry, eventType )
Based on the displaySystem returns the area of a geometry.
getBestArea: function( geometry )
getArea: function( geometry, units )
Based on the displaySystem returns the length of a geometry.
getBestLength: function( geometry )
getLength: function( geometry, units )