MlMeasureTool
The MlMeasureTool facilitates the measurement of either area or length on a map. It integrates with a feature editor component (MlFeatureEditor) to allow users to draw geometries (polygons or lines) directly onto the map. This component supports both polygon and line measurements, with configurable units of measurement.
Visit the storybook for a complete list of properties & documentation.
Functionality:
-
Measurement Types: The component can measure either areas (polygons) or lengths (lines), determined by the
measureTypeprop. -
Units of Measurement: It supports various units of measurement (like kilometers, miles), specified through the
unitprop. The display adjusts automatically between square units for area measurement and linear units for length. -
Measurement Calculation: When a geometry is drawn or modified, the component calculates the area (in square units) or length (in linear units) of the feature. For areas, the calculation is done in square kilometers or square miles, and for lengths, in kilometers or miles. The component can also display smaller units (meters or inches) for more precise measurements.
-
Change Handling: The component has an
onChangecallback prop, which is triggered every time there's a change in the measurement. This callback receives the new measurement value, the unit of measurement, and the corresponding GeoJSON object as parameters. -
Responsive Design: The component updates its state and UI based on changes in the selected features or unit of measurement.
Note: There can only be one active MlMeasureTool or MlFeatureEditor (used by MlMeasureTool to draw measure geometries) component used per map instance at a time.
Basic Usage
Measure line example
<MlMeasureTool measureType={"line"} unit={"kilometers"} />
Measure polygon example
<MlMeasureTool measureType={"polygon"} unit={"kilometers"} />