Code Monkey home page Code Monkey logo

leaflet-measure-path's Introduction

Leaflet Measure Path

Leaflet 1.0 compatible!

A plugin to show measurements on paths (polylines, polygons and circles currently supported).

Leaflet Measure Path demo

Usage

Load leaflet-measure-path.js and leaflet-measure-path.css. Then, to enable measurements on a path:

var polygon = L.polygon([ ... ])
    .addTo(map)
    .showMeasurements();

To later hide measurements:

var polygon = L.polygon([ ... ])
    .addTo(map)
    .hideMeasurements();

API

The simplest way to enable measurements for a path is to pass the option showMeasurements: true when creating the path. To control the measurement options, you can also pass measurementOptions, see options below.

The plugin also adds the methods listed below to Leaflet's L.Polyline, L.Polygon and L.Circle classes.

showMeasurements(options)

Enables measurements. You can also overide the defaults by passing an options object.

Options

  • showOnHover: Boolean (default false): if true, the measurements will only show when the user hovers the cursor over the path
  • showTotalDistance: Boolean (default true): if false, the total length of polyline will not be shown
  • minDistance: Number (default 30): the minimum length a line segment in the feature must have for a measurement to be added
  • formatDistance: Function: allows to override the built-in function that formats a distance in meters to the string shown in the map
  • formatArea: Function: allows to override the built-in function that formats an area in square meters to the string shown in the map

hideMeasurements()

Disables measurements.

updateMeasurements()

Updates the measurements displayed. Normally, this method is called automatically if the path's geometry is changed using setLatLngs, spliceLatLngs or when the map is zoomed. If the geometry is somehow changed by other means, this method can be called to force the measurements to update.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.