Find answers and key resources for successfully building apps with Leaflet and ArcGIS.
General
This guide is for:
- New developers interested in building mapping applications using ArcGIS and Leaflet.
- ArcGIS developers who want to use an open-source library like Leaflet to display maps in web applications.
- Leaflet developers who want to integrate ArcGIS services in their applications.
Use Leaflet together with the Esri Leaflet plugin to display ArcGIS basemap styles, access data, and perform location search.
To access other ArcGIS Location Services, such as the ArcGIS Routing
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 browser 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 existing 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 Maps SDK for JavaScript if you:
- Need tighter integration with ArcGIS.
- Need to work with web maps
A web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification. . - 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 Maps SDK for JavaScript.
Feel free to ask questions in the Esri Community.
To contribute, create an issue and pull request in the Esri Leaflet GitHub repository.
ArcGIS services
ArcGIS services are software that support an ArcGIS REST API and provides geospatial functionality or data. ArcGIS provides many types of services, such as location services
The ArcGIS Basemap Styles service
- Get an ArcGIS Online subscription.
- Find an ArcGIS scene layer.
- Use ArcGIS Maps SDK for JavaScript or ArcGIS Maps SDKs for Native Apps to load the scene layers.
- If you are using ArcGIS Location Platform and want to display 3D basemaps, contact Esri.
Esri Leaflet has built in functionality to access the following ArcGIS services:
- ArcGIS Basemap Styles service
- ArcGIS Static Basemap Tiles service
- ArcGIS Geocoding service
- Vector tile service
- Map tile service
- Map service
- Feature service
You can also access other services such as the ArcGIS Routing serviceL.esri.request or ArcGIS REST JS. To see examples of how to use ArcGIS REST JS, go to Routing and Data enrichment.
You need either an ArcGIS Location Platform account or ArcGIS Online account to access ArcGIS Location Services. This will give you the ability to access the portal, create developer credentials, and manage your data.
You can not use an ArcGIS Enterprise account to access ArcGIS Location Services.
The table below shows the account types you can use to access each service:
ArcGIS Location Services
Yes, you need to provide an API key or implement another type of authentication to access ArcGIS Location Services
ArcGIS Enterprise services
For services that are private, yes, you need to provide authentication 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 Types of authentication.
To learn more about ArcGIS Location Services and capabilities, go to the Mapping and location services guide.
To learn more about ArcGIS Enterprise services and capabilities, go to the REST API documentation.
Data services
Data services
-
Feature services
A feature service is a data service that provides access to spatial and non-spatial data in feature layers, feature layer views, and tables. -
Vector tile services
A vector tile service is a data service that provides access to vector tile data and a style definition. -
Map tile services
A map tile service, formerly known as image tile service, is a data service that provides access to static, pre-rendered mao tiles. The tiles are typical in PNG format. Map tiles are typically retrieved by specifying a specific level, row, and column value. -
Image services
An image service is a data service that can store, process, analyze, and share raster data.
Data services are typically created by importing data with the data management tools
The type of data service you use depends on the product you have, the format of your existing data, storage and output data format requirements, the size and complexity of the data, and the service functionality required.
Below is an overview of the main services and the data type each supports.
| Data service | Data type | Data output | Use cases |
|---|---|---|---|
| Feature service | Feature (geometry and/or attributes) | JSON, PBF, GeoJSON | Display, visualization, editing, updating, accessing geometry, accessing attributes |
| Vector tile service | Vector tile | PBF | Display, styling, accessing attributes |
| Map tile service | Map tile | PNG32 | Display |
| Image service | Static and dynamic tiles | JPEG, PNG, LERC | Display, visualization, anlaysis, mosaicking images |
Yes, Esri offers data hosting through ArcGIS Location Platform
ArcGIS Location Platform
With ArcGIS Enterprise
You can import and host many different types of geographic data as data services
To learn more about supported data types, go to Portal and data services > Data services.
Esri Leaflet plugin supports many different data services, such as feature services, vector tile services, and map tile services. The plugin has built-in classes to access the services and load the data into a Leaflet map.
An access token is required for private data services.
No, your data is your data. You retain complete ownership of your content.
Service usage and billing
- ArcGIS Online: As an organization administrator, use the ArcGIS portal
ArcGIS portal, also known as a portal, is a website with applications and tools that can be used to create, manage, access, and share geospatial content and data. It supports security and authentication, developer credentials, content and data service management, user and group management, and site administration. A portal can be hosted in Esri's infrastructure or your own infrastructure. to generate reports on basemap usage. - ArcGIS Location Platform: Use your ArcGIS Location Platform dashboard to view basemap session and tile usage. To learn more, see Basemap usage .
The cost to access ArcGIS location services
-
If you have an ArcGIS Location Platform account
An ArcGIS Location Platform account, formerly known as an ArcGIS Developer account, is an identity associated with an ArcGIS Location Platform subscription. , 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. -
If you have an ArcGIS Online account
An ArcGIS Online account, also known as an ArcGIS Organization account, is an identity associated with an ArcGIS Online subscription. It can be used to access ArcGIS tools and develop applications with ArcGIS location services for an organization. , you are billed in creditsCredits are the currency used by ArcGIS Online Organization accounts to account for data storage and location service consumption. Credits are consumed for specific transactions, such as accessing location services, and types of storage, such as storing features, performing analytics, and using premium content. . To determine the cost of accessing different services, go to Understanding credits.
If you have ArcGIS Enterprise, there is no cost for accessing your own ArcGIS services.
To find the Esri Terms of Use, go to Terms of use.