Learn how to calculate the area that can be reached in a given drive time from a location.
A service area, also known as an isochrone, is a polygon that represents the area that can be reached when driving or walking on a street network. The area that can be reached is restricted by either time or distance. To calculate service areas, you can use the Service area service. You provide a start location (facilities), one or more time or distance values, and a spatial reference. Once processed, the service returns the service areas that can be reached.
In this tutorial, you will create and display five, ten, and fifteen minute drive time service areas when the map is clicked.
To learn how to find a route and directions to different locations, visit the Get a route and directions tutorial.
Prerequisites
Steps
Create a new pen
- To get started, either complete the Display a map tutorial or .
Get an access token
You need an access token with the correct privileges to access the location services used in this tutorial.
- Go to the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges
- Location services > Basemaps
- Location services > Routing
- Privileges
- In CodePen, set
esri
to your API key..Config.api Key Use dark colors for code blocks esriConfig.apiKey = "YOUR_ACCESS_TOKEN"; const map = new Map({ basemap: "arcgis/topographic" // basemap styles service });
To learn about other ways to get an access token, go to Types of authentication.
Add modules
-
In the
require
statement, add theservice
,Area Service
,Area Parameters Feature
, andSet Graphic
modules.The ArcGIS Maps SDK for JavaScript is available as AMD modules and ES modules, but this tutorial is based on AMD. The AMD
require
function uses references to determine which modules will be loaded – for example, you can specify"esri/
for loading the Map module. After the modules are loaded, they are passed as parameters (e.g.Map" Map
) to the callback function where they can be used in your application. It is important to keep the module references and callback parameters in the same order. To learn more about the API's different modules visit the Overview Guide page.Use dark colors for code blocks require([ "esri/config", "esri/Map", "esri/views/MapView", "esri/rest/serviceArea", "esri/rest/support/ServiceAreaParameters", "esri/rest/support/FeatureSet", "esri/Graphic" ], function(esriConfig, Map, MapView, serviceArea, ServiceAreaParams, FeatureSet, Graphic) {
Update the map
A streets basemap layer is typically used in routing applications. Update the basemap
property to use the arcgis/navigation
basemap layer and change the position of the map to center on Osaka.
-
Update the
basemap
property fromarcgis/topographic
toarcgis/navigation
.Use dark colors for code blocks esriConfig.apiKey = "YOUR_ACCESS_TOKEN"; const map = new Map({ basemap: "arcgis/navigation" });
-
Change the
zoom
andcenter
properties to center on Osaka.Use dark colors for code blocks esriConfig.apiKey = "YOUR_ACCESS_TOKEN"; const map = new Map({ basemap: "arcgis/navigation" }); const view = new MapView({ container: "viewDiv", map: map, center: [135.5023,34.6937], //Longitude, latitude zoom: 11 });
Define the service url
The service
module makes a request to a service and returns the results. Use the service
class to access the Service area service.
- Define a property,
service
, to reference the service url.Area Url Use dark colors for code blocks const view = new MapView({ container: "viewDiv", map: map, center: [135.5023,34.6937], //Longitude, latitude zoom: 11 }); const serviceAreaUrl = "https://route-api.arcgis.com/arcgis/rest/services/World/ServiceAreas/NAServer/ServiceArea_World/solveServiceArea";
Add a point graphic
Use a point graphic to display the location (facility) for the service area starting point.
-
Add a
click
handler to add a point graphic to theview
.Use dark colors for code blocks const serviceAreaUrl = "https://route-api.arcgis.com/arcgis/rest/services/World/ServiceAreas/NAServer/ServiceArea_World/solveServiceArea"; view.on("click", function(event){ });
-
Create a
create
function that takes a point as a parameter and returns a whiteGraphic Graphic
. It should remove all graphics each time.Use dark colors for code blocks // Create the location graphic function createGraphic(point) { view.graphics.removeAll(); const graphic = new Graphic({ geometry: point, symbol: { type: "simple-marker", color: "white", size: 8 } }); view.graphics.add(graphic); return graphic; }
-
Update the
click
handler to call thecreate
function and store the graphic inGraphic location
.Graphic Use dark colors for code blocks view.on("click", function(event){ const locationGraphic = createGraphic(event.mapPoint); });
-
Click on the map to see a point graphic.
Create service area parameters
A service
uses drive times (cutoffs) and spatial reference parameters to calculate the service area. It also uses a Feature
to set the facilities
(location) from where the service area polygon will be drawn. Use a click
handler in the View
to set the parameters required to create the service area.
-
Create a
create
function that takes point graphic, drive time, and spatial reference parameters.Service Area Params Use dark colors for code blocks view.graphics.add(graphic); return graphic; } function createServiceAreaParams(locationGraphic, driveTimeCutoffs, outSpatialReference) { }
-
Create a
Feature
to set theSet features
property with the point graphic.Use dark colors for code blocks function createServiceAreaParams(locationGraphic, driveTimeCutoffs, outSpatialReference) { // Create one or more locations (facilities) to solve for const featureSet = new FeatureSet({ features: [locationGraphic] }); }
-
Create a
Service
and return theArea Params task
element.Parameters Use dark colors for code blocks function createServiceAreaParams(locationGraphic, driveTimeCutoffs, outSpatialReference) { // Create one or more locations (facilities) to solve for const featureSet = new FeatureSet({ features: [locationGraphic] }); // Set all of the input parameters for the service const taskParameters = new ServiceAreaParams({ facilities: featureSet, defaultBreaks: driveTimeCutoffs, trimOuterPolygon: true, outSpatialReference: outSpatialReference }); return taskParameters; }
-
Update the click handler to add drive time cutoffs of 5, 10, and 15 minutes and to call the
create
function.Service Area Params Use dark colors for code blocks view.on("click", function(event){ const locationGraphic = createGraphic(event.mapPoint); const driveTimeCutoffs = [5,10,15]; // Minutes const serviceAreaParams = createServiceAreaParams(locationGraphic, driveTimeCutoffs, view.spatialReference); });
Solve the service area
To solve the service area, pass the service
to the solve
method. Use a solve
function to find the service area polygon and add the resulting graphic to the view
.
-
Create a
solve
function.Service Area Use dark colors for code blocks // Set all of the input parameters for the service const taskParameters = new ServiceAreaParams({ facilities: featureSet, defaultBreaks: driveTimeCutoffs, trimOuterPolygon: true, outSpatialReference: outSpatialReference }); return taskParameters; } function solveServiceArea(url, serviceAreaParams) { }
-
Call the
solve
method to find the service area and add the results to theview
.Use dark colors for code blocks function solveServiceArea(url, serviceAreaParams) { return serviceArea.solve(url, serviceAreaParams) .then(function(result){ if (result.serviceAreaPolygons.features.length) { // Draw each service area polygon result.serviceAreaPolygons.features.forEach(function(graphic){ graphic.symbol = { type: "simple-fill", color: "rgba(255,50,50,.25)" } view.graphics.add(graphic,0); }); } }, function(error){ console.log(error); }); }
-
Update the
click
handler to call thesolve
function.Service Area Use dark colors for code blocks view.on("click", function(event){ const locationGraphic = createGraphic(event.mapPoint); const driveTimeCutoffs = [5,10,15]; // Minutes const serviceAreaParams = createServiceAreaParams(locationGraphic, driveTimeCutoffs, view.spatialReference); solveServiceArea(serviceAreaUrl, serviceAreaParams); });
Run the app
In CodePen, run your code to display the map.
Click on the map to create service areas. When you click on the map, you will see a point graphic along with drive time service areas. The service areas represent the area that can be reached within 5, 10, and 15 minutes.
What's next?
Learn how to use additional API features and ArcGIS services in these tutorials: