L.esri.Layers.HeatMapFeatureLayer

L.esri.Layers.HeatMapFeatureLayer provides integration for Feature Layers with the Leaflet.heat plugin. Because of the extra dependency on Leaflet.heat we do not include L.esri.Layers.HeatMapFeatureLayer in the default build of Esri Leaflet. It lives in /dist/extras/heatmap-feature-layer.js. You will also need to include your own copy of the Leaflet.heat plugin.

More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation.

Constructor

Constructor Description
new L.esri.Layers.HeatmapFeatureLayer(<String> url, <Object> options)

L.esri.Layers.heatmapFeatureLayer(<String> url, <Object> options)

new L.esri.HeatmapFeatureLayer(<String> url, <Object> options)

L.esri.heatmapFeatureLayer(<String> url, <Object> options)		 url should be the URL to the Feature Layer.
### Options
Option Type Description
where String A server side expression that will be evaluated to filter features. By default this will include all features in a service.
fields Array An array of metadata names to pull from the service. Includes all fields by default.
from Date When paired with to defines the time range of features to display. Required the Feature Layer to be time enabled.
to Date When paired with from defines the time range of features to display. Required the Feature Layer to be time enabled.
timeField false The name of the field to lookup the time of the feature. Can be an object like {start:'startTime', end:'endTime'} or a string like 'created'.
timeFilterMode 'client' or 'server' Determines where features are filtered by time. By default features will be filtered by the server. If set to 'client' all features are loaded and filtered on the client before display.
precision Integer How many digits of precision to request from the server. Wikipedia has a great reference of digit precision to meters.
token String If you pass a token in your options it will be included in all requests to the service.
proxy String URL of an ArcGIS API for JavaScript proxies or ArcGIS Resource Proxies to use for proxying POST requests.
useCors Boolean If this service should use CORS when making GET requests.

L.esri.HeatMapFeatureLayer will also accept any options that can be passed to Leaflet.heat to customize the appearance of the heatmap.

Events

Event Type Description
loading <LoadingEvent> Fires when new features start loading.
load <Load> Fires when all features in the current bounds of the map have loaded.

L.esri.Layers.FeatureLayer also fires all L.esri.Services.FeatureLayer events.

Methods

Method Returns Description
getWhere() String Returns the current where setting
setWhere(<String> where, <Function> callback, <Object> context) this Sets the new where option and refreshes the layer to reflect the new where filter. Accepts an optional callback and function context.
getTimeRange() Array Returns the current time range as an array like [from, to]
setTimeRange(<Date> from, <Date> to, , <Function> callback, <Object> context) this Sets the current time filter applied to features. An optional callback is run upon completion if timeFilterMode is set to 'server'. Also accepts function context as the last argument.
authenticate(<String> token) this Authenticates this service with a new token and runs any pending requests that required a token.
query() this Returns a new L.esri.services.Query object that can be used to query this layer. Your callback function will be passed a GeoJSON FeatureCollection with the results or an error. 
featureLayer.query()
            .within(latlngbounds)
            .where("Direction = 'WEST'")
            .run(function(error, featureCollection){
                console.log(featureCollection);
            });
metadata(<Function> callback, <Object> context) this Requests metadata about this Feature Layer. Callback will be called with error and metadata. 
featureLayer.metadata(function(error, metadata){
  console.log(metadata);
});
addFeature(<GeoJSON Feature> feature, <Function> callback, <Object> context) this Adds a new feature to the feature layer. this also adds the feature to the map if creation is successful.
  • Requires authentication as a user who has permission to edit the service in ArcGIS Online or the user who created the service.
  • Requires the Create capability be enabled on the service. You can check if creation exists by checking the metadata of your service under capabilities in the metadata.
updateFeature(<GeoJSON Feature> feature, <Function> callback, <Object> context) this Update the provided feature on the Feature Layer. This also updates the feature on the map.
  • Requires authentication as a user who has permission to edit the service in ArcGIS Online or the user who created the service.
  • Requires the Update capability be enabled on the service. You can check if creation exists by checking the metadata of your service under capabilities in the metadata.
deleteFeature(<String or Integer> id, <Function> callback, <Object> context) this Remove the feature with the provided id from the feature layer. This will also remove the feature from the map if it exists.
  • Requires authentication as a user who has permission to edit the service in ArcGIS Online or the user who created the service.
  • Requires the Update capability be enabled on the service. You can check if creation exists by checking the metadata of your service under capabilities in the metadata.

Example

var map = new L.Map('map').setView([40.722868115037,-73.92142295837404], 14);

L.esri.basemapLayer('Gray').addTo(map);

var heatmap = new L.esri.HeatmapFeatureLayer("http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Graffiti_Locations3/FeatureServer/0", {
  radius: 12
}).addTo(map);

Edit this page on GitHub