This is a
playground to test code. It runs a full
Node.js environment and already has all of
npm’s 400,000 packages pre-installed, including
leaflet-underneath with all
npm packages installed. Try it out:
This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.
With a normal tile layer, the user can't interact to find out more about a location, since it is a static image. With this plugin, you can find out what features are underneath the current mouse position, for example when the user clicks the map.
This is done using Mapbox Vector Tiles, that are queried for features in a way that is both fast and reasonably bandwidth efficient.
Version 3.0 and up of Leaflet Underneath is only compatible with Leaflet 1.0; earlier versions only work with Leaflet 0.7.
Download the code. Include the pre-built Leaflet Underneath script in your project:
or, even better, use Browserify or similar and install from npm:
npm install --save leaflet-underneath
var L = require('leaflet'); require('leaflet-underneath'); // Leaflet Underneath will be available as L.underneath
For a complete example on how to use Leaflet Underneath, see basic Leaflet Underneath example.
Leaflet Underneath can be queried for features from a location.
|Instantiates a new Leaflet Underneath layer|
|Minimum zoom level in the tile set|
|Maximum zoom level in the tile set|
|Names of layers to include in search|
|Default number of pixels search radius|
|Function that returns a unique feature id; used to filter out duplicates. Default returns a features |
|Zoom in relative to the map's current zoom level when making a query; used to get more or less detailed results than current zoom would give|
|For features with same id, should geometries be joined (|
|Asynchronously queries for features near |
|Take from layer options||Number of pixels search radius|
|Only return features (polygons) that the queried location is inside|