.. _widget-measuretool-label:

=============
 MeasureTool
=============

Creates a MesureTool button menu containing "Length" and "Area and Perimeter"
measure tools.  The default units used are : metric and english.


XML Sample
-----------
Sample configuration with *Length* type

.. code-block:: xml

   <measuretool>
     <name>W_MeasureTool</name>
     <options />
   </measuretool>


How to draw the widget
-----------------------

The MeasureTool widget doesn't need to be drawn.  Instead, it must be added to
a GeoExtToolbar widget :

.. code-block:: xml

   <geoexttoolbar>
     <name>W_Toolbar</name>
     <options>
       <widgets>
         <widget>W_MeasureTool</widget>
       </widgets>
     </options>
   </geoexttoolbar>


Mandatory Options
-------------------
N/A


Optional Options
------------------
:geodesic: (Boolean) Defaults to false. Set to true when the map is in a
           geodesic projection.
:hectare:  (Boolean) Defaults to false. Whether to add the hectare metric unit.
:immediate: (Boolean) Defaults to true. Whether the partial measure should be
            updated on sketch immediate change (true) or single click (false).
:showLastSegmentMeasure: (Boolean) Defaults to false. Whether the measuse of the
            last segment should be displayed in the popup.
:tooltipAtCursor: (Boolean) Defaults to true. The information tooltip follow
            the cursor when user click.


Service Type
--------------
N/A


Widget Action
--------------
read