Home

Awesome

Leaflet JSON Layer

npm version

Simple way for transform any JSON data source in a Leaflet Layer!

A Dynamic Leaflet Layer that load JSON data in layer in the form of markers with attributes

and minimize remote requests with caching system

Copyright 2023 Stefano Cudini

If this project helped your work help me to keep this alive by Paypal DONATION ❤

Tested in Leaflet 0.7 and 1.1

Options

OptionDataDescription
urlStringremote url
jsonpParamStringcallback parameter name for jsonp request append to url
jsonpParamStringcallback parameter name for jsonp request append to url
callDataFunctioncustom function for data source, params: (req: url
Filtering
propertyItemsStringjson property used contains data items
propertyLocStringjson property used as Latlng of marker, if is array: ['lat','lon'] select double fields
locAsGeoJSONStringinterpret location data as [lon, lat] value pair instead of [lat, lon]
propertyTitleStringjson property used as title in marker
filterDataFunctionfunction for pre-filter data
Rendering
dataToMarkerFunctionfunction that will be used for creating markers from json points
layerTargetL.Layerpre-existing layer to add markers(L.LayerGroup, L.MarkerClusterGroup)
buildPopupFunctionfunction popup builder
optsPopupStringpopup options
buildIconFunctionfunction icon builder
Caching
minZoomNumbermin zoom for call data
cachingBooleanremote requests caching
cacheIdFunctionfunction to generate id used to uniquely identify data items in cache
minShiftNumbermin shift for update data(in meters)
precisionNumbernumber of digit send to server for lat,lng precision
updateOutBoundsStringrequest new data only if current bounds higher than last bounds
updateMarkersBooleanupdate all markers in map to last results of callData

Events

EventDataDescription
'dataloading'{req: urlbbox}
'dataloaded'{data: json}fired on ajax/jsonp request success

Usage

var l = new L.LayerJSON({url: "search.php?lat1={lat1}&lat2={lat2}&lon1={lon1}&lon2={lon2}" });
map.addLayer(l);

Where

Demos:

https://opengeo.tech/maps/leaflet-layerjson

Source:

Github

Atmosphere

Build

This plugin support Grunt for building process. Therefore the deployment require NPM installed in your system.

After you've made sure to have npm working, run this in command line:

npm install
grunt