Maps SDK for Web - L.MeasurementRuler

Class L.MeasurementRuler

Layer that show a ruler with distance labels over the map.

Name	Description	Required	Type/Values	Default
options		No	Object	None
options.markerColor	Color to use for the ruler's stops	No	String	"#000"
options.lineColor	Color of the rule's line	No	String	"#000"
options.rulerClassname	Class name that should be apply to the ruler	No	String	"leaflet-distance-measurement__ruler"
options.labelClassname	Class name that should be apply to the distance label container	No	String	"leaflet-distance-measurement__ruler__label"
options.dashArray	A string that defines the stroke dash pattern of the leaflet polyline used to draw the ruler. For more details read	No	String	"5 5"
options.distanceOffset	Distance (in meters) that needs to be added to the distance calculation of the ruler	No	Number	0
options.unitScheme	Unit scheme to use for the distance calculations	No	"metric" \| "imperial"	"metric"
options.useArc	Uses a great arc instead of a rect line	No	Boolean	false

Total distance (in meters) of the ruler. This property will be updated each time a coordinate is added to the ruler.

All the coordinates that conform the ruler path.

Add new coordinates to the ruler path and redraw the ruler.

This method extends the size of the ruler.

Name	Description	Required	Type/Values	Default
latLng		Yes	L.LatLng	None

Returns the last coordinates added to the ruler.

L.LatLng If the ruler doesn't have coordinates it will return NULL

Set all the ruler's path at once.

Name	Description	Required	Type/Values	Default
latLngs		Yes	L.LatLng[]	None