FAQ

General

Yes, Esri Leaflet is a fully supported API to use with ArcGIS services.

Yes. Esri Leaflet is a plug-in, therefore, you need to reference Leaflet.js and Leaflet.css in your application. To learn how to reference the libraries, go to Install and set up.

Yes! version 2.x of Esri Leaflet is compatible with Leaflet version 1.x.

If you'd like to continue building applications that target Leaflet 0.7.x, please use Esri Leaflet 1.x.

Most modern browsers and versions of Node.js are supported. Go to Browser support to see the specific brower versions.

You can find the official community at Esri Community.

In general, Esri Leaflet is a smaller and lighter-weight library for accessing ArcGIS services.

You may want to use Esri Leaflet if you:

  • Are already using Leaflet.
  • Have an exisiting application and you want to integrate ArcGIS services.
  • Still want to leverage non-ArcGIS services or data.
  • Want to leverage Leaflet plugins.

You may want to use ArcGIS API for JavaScript if you:

  • Need tighter integration with ArcGIS.
  • Need to work with web maps.
  • Need to access and display all layer types.
  • Need Web GL support.
  • Need to work in non-Mercator/WGS 84 projections.

No. To work with web maps, you should use the ArcGIS API for JavaScript.

Feel free to ask questions in the Esri community or Stack overflow. You can report issues in the Esri Leaflet GitHub repository.

To contribute, create an issue and pull request in the Esri Leaflet GitHub repository.

ArcGIS services

Esri Leaflet has built in functionality to access the follwing ArcGIS services:

  • Basemap layer service
  • Vector tile service
  • Image tile service
  • Map service
  • Feature service
  • Geocoding service
  • Geoprocessing service

You can also access other services such as the routing service or GeoEnrichment service by using request or ArcGIS REST JS. To see examples of how to use ArcGIS REST JS, go to Routing and Demographics.

ArcGIS location services

Yes, you need need to provide an API key or you need to implement OAuth 2.0 to access ArcGIS location services.

ArcGIS Enterprise services

For services that are private, yes, you need to provide authenticaiton to access ArcGIS Enterprise services. You typically implement OAuth 2.0 to do so. Public services do not require authentication.

To learn more about the different types of authentication, go to Security and authentication in the Mapping APIs and location services guide.

In general Esri Leaflet supports any version of ArcGIS Server that is not retired. You view supported versions of ArcGIS Server on Product Life Cycle.

If you server is not setup for CORS (pre 10.1) you will either need to setup CORS on your server or set the useCORS option to false when using Esri Leaflet.

ArcGIS Server 9.3 is not supported. There are known bugs with L.esri.DynamicMapLayer.

No. The services are no longer maintained and recommended for use by Esri.

To learn more about ArcGIS location services and capabilities, go to the Mapping APIs and location services guide.

To learn more about ArcGIS Enterprise services and capabilities, go to the REST API documentation.

Service usage and billing

You need either an ArcGIS Developer account or ArcGIS Online account. This will give you the ability to access the developer dashboard, create API keys, set up OAuth 2.0, and manage your data.

The cost to access ArcGIS location services depends on the type of ArcGIS account you have and the service operation you use.

  1. If you have an ArcGIS Developer account, you are billed in US dollars. To determine the cost of accessing different services, go to Pricing. A free tier of access is available for some services.

  2. If you have an ArcGIS Online account, you are billed in credits. To determine the cost of accessing different services, go to Understnading credits.

If you have ArcGIS Enterprise, there is no cost for accessing your own ArcGIS services.

To learn about accounts, content and data, and basemap layer attribution, go to Deployment in the Mapping APIs and locaiton services guide.

To find the Esri Terms of Use, go to Terms of use in the Mapping APIs and locaiton services guide.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.