Tutorial: Find service areas

Learn how to calculate the area that can be reached in a given driving 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 routing 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 create and display five, ten, and fifteen minute drive time service areas when the map is clicked. You use data-driven styling to give each polygon a different shade of blue.

Prerequisites

You need an ArcGIS Location Platform or ArcGIS Online account.

Steps

Create a new pen

To get started, you can complete the Display a scene tutorial or use the .

Get an access token

You need an access token with the correct privileges to access the resources 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
Copy the API key access token to your clipboard when prompted.

In CodePen, update the accessToken variable to use your access token.

Use dark colors for code blocks
      const accessToken = "YOUR_ACCESS_TOKEN";

      Cesium.ArcGisMapService.defaultAccessToken = accessToken;

      const cesiumAccessToken = "YOUR_CESIUM_ACCESS_TOKEN";

      Cesium.Ion.defaultAccessToken = cesiumAccessToken;

      const arcGisImagery = Cesium.ArcGisMapServerImageryProvider.fromBasemapType(Cesium.ArcGisBaseMapType.SATELLITE);

      const viewer = new Cesium.Viewer("cesiumContainer", {

        baseLayer: Cesium.ImageryLayer.fromProviderAsync(arcGisImagery),

      });

Run the code to ensure the base layer is displayed in the scene.

To learn about the other types of authentication available, go to Types of authentication.

Add references to ArcGIS REST JS

In the <head> element, reference the routing and request packages from ArcGIS REST JS.

Expand
Use dark colors for code blocks
    <script src="https://cesium.com/downloads/cesiumjs/releases/1.121/Build/Cesium/Cesium.js"></script>
    <link href="https://cesium.com/downloads/cesiumjs/releases/1.121/Build/Cesium/Widgets/widgets.css" rel="stylesheet">

    <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-routing@4/dist/bundled/routing.umd.js"></script>

Expand

Update the scene

This routing application uses a 3D object layer San Francisco. Update the scene extent to focus on San Francisco, CA.

Update the setView command to center on location [-122.38329, 37.74015, 16000], San Francisco.

Expand
Use dark colors for code blocks
    viewer.camera.setView({

      destination : Cesium.Cartesian3.fromDegrees(-122.38329, 37.74015, 16000),
      orientation : {
        pitch : Cesium.Math.toRadians(-70.0),
      }

    });
Expand

Create a starting location graphic

Create a Billboard entity to indicate the location from which a service area will be calculated. You can use Billboard entities to display custom pins and images.

Add a new Billboard entity to the viewer to represent the origin location. Set the position of the entity to null.

Expand
Use dark colors for code blocks
    viewer.camera.setView({

      destination : Cesium.Cartesian3.fromDegrees(-122.38329, 37.74015, 16000),
      orientation : {
        pitch : Cesium.Math.toRadians(-70.0),
      }

    });

    // Add Esri attribution
    // Learn more in https://esriurl.com/attribution
    const poweredByEsri = new Cesium.Credit("Powered by <a href='https://www.esri.com/en-us/home' target='_blank'>Esri</a>", true)
    viewer.creditDisplay.addStaticCredit(poweredByEsri);

    const origin = viewer.entities.add({
        name:'start',
        position:null,
        billboard: {
            verticalOrigin: Cesium.VerticalOrigin.BOTTOM,
            heightReference: Cesium.HeightReference.CLAMP_TO_GROUND,

        }
    })
Expand

Create a PinBuilder and use it to set the image property of the billboard.

Expand
Use dark colors for code blocks
    const pinBuilder = new Cesium.PinBuilder();

    const origin = viewer.entities.add({
        name:'start',
        position:null,
        billboard: {
            verticalOrigin: Cesium.VerticalOrigin.BOTTOM,
            heightReference: Cesium.HeightReference.CLAMP_TO_GROUND,

            image: pinBuilder.fromColor(Cesium.Color.fromCssColorString('#ffffff'),48).toDataURL(),

        }
    })
Expand

Add a click handler

Use an event handler to set the location of the origin and when a user clicks.

Create a ScreenSpaceEventHandler for the Viewer that listens for left clicks. Create an onLeftClick function that runs when a click is detected.

Expand
Use dark colors for code blocks
            image: pinBuilder.fromColor(Cesium.Color.fromCssColorString('#ffffff'),48).toDataURL(),

        }
    })

    viewer.screenSpaceEventHandler.setInputAction(movement => {

    },Cesium.ScreenSpaceEventType.LEFT_CLICK);
Expand

Set the position of the origin entity to the coordinates of the clicked location. Call viewer.dataSources.removeAll() to remove stale service area polygons.

Expand
Use dark colors for code blocks
    viewer.screenSpaceEventHandler.setInputAction(movement => {

        const pickedPosition = viewer.scene.pickPosition(movement.position);
        origin.position = pickedPosition;

        viewer.dataSources.removeAll();

    },Cesium.ScreenSpaceEventType.LEFT_CLICK);
Expand

Get service areas

To calculate a service area from a point, use the ArcGIS REST JS serviceArea function to make a request to the routing service.

Create a new arcgisRest.ApiKeyManager and set your access token.

Expand
Use dark colors for code blocks
    const accessToken = "YOUR_ACCESS_TOKEN";

    Cesium.ArcGisMapService.defaultAccessToken = accessToken;

    const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
Expand

Create a function called getServiceArea that accepts a coordinate pair. Inside, call arcgisRest.serviceArea and set the facilities parameter to the set of coordinates.

arcgisRest.serviceArea creates a direct request to the solveServiceArea endpoint of the routing service. To learn more about the solveServiceArea endpoint, go to the Routing service page in the Mapping and location services guide.

Expand
Use dark colors for code blocks
    viewer.screenSpaceEventHandler.setInputAction(movement => {

        const pickedPosition = viewer.scene.pickPosition(movement.position);
        origin.position = pickedPosition;

        viewer.dataSources.removeAll();

    },Cesium.ScreenSpaceEventType.LEFT_CLICK);

    function getServiceArea(coordinates) {
        arcgisRest
        .serviceArea({
            facilities: [coordinates],
            authentication
        })

    }
Expand

Access the service response and add the returned GeoJSON to your application as a GeoJsonDataSource.

Expand
Use dark colors for code blocks
    function getServiceArea(coordinates) {
        arcgisRest
        .serviceArea({
            facilities: [coordinates],
            authentication
        })

        .then((response) => {

            const serviceJSON = response.saPolygons.geoJson;

            Cesium.GeoJsonDataSource.load(serviceJSON,{
                    clampToGround:true
            })
            .then((dataSource)=>{
                viewer.dataSources.add(dataSource);

            });
        })

    }
Expand

Set the material of each service area polygon based on its drive time from the origin using the FromBreak property.

Expand
Use dark colors for code blocks
        .then((response) => {

            const serviceJSON = response.saPolygons.geoJson;

            Cesium.GeoJsonDataSource.load(serviceJSON,{
                    clampToGround:true
            })
            .then((dataSource)=>{
                viewer.dataSources.add(dataSource);

                const entities = dataSource.entities.values;

                for (let i=0; i<entities.length;i++) {
                    const feature = entities[i];
                    feature.polygon.outline = false;
                    if (feature.properties.FromBreak == 0) {
                        feature.polygon.material = Cesium.Color.fromHsl(0.5833,.8,.4,.7);
                        feature.polygon.extrudedHeight = 300;
                    }
                    else if (feature.properties.FromBreak == 5) {
                        feature.polygon.material = Cesium.Color.fromHsl(0.5833,.8,.6,.7);
                        feature.polygon.extrudedHeight = 200;
                    }
                    else {
                        feature.polygon.material = Cesium.Color.fromHsl(0.5833,.8,.8,.7);
                        feature.polygon.extrudedHeight = 100;
                    }
                }

            });
        })
Expand

In your onLeftClick function, convert the coordinates of the user's click from Cartesian to longitude and latitude degrees. Call getServiceArea with the longitude and latitude

Expand
Use dark colors for code blocks
    viewer.screenSpaceEventHandler.setInputAction(movement => {

        const pickedPosition = viewer.scene.pickPosition(movement.position);
        origin.position = pickedPosition;

        viewer.dataSources.removeAll();

        const cartographic = Cesium.Cartographic.fromCartesian(pickedPosition);
        const originLatLng = [Cesium.Math.toDegrees(cartographic.longitude),Cesium.Math.toDegrees(cartographic.latitude)]

        getServiceArea(originLatLng);

    },Cesium.ScreenSpaceEventType.LEFT_CLICK);
Expand

Run the app

In CodePen, run your code to display the map.

When the application loads, you should be able to click on a locations to create an origin point. The routing service should then calculate drive time polygons representing the areas reachable within a 5, 10, and 15 minute drive.

What's next?

Learn how to use additional ArcGIS location services in these tutorials:

Find a route and directions

Find a route and directions with the route service.

Find place addresses

Search for coffee shops, gas stations, restaurants and other nearby places with the Geocoding service.

Reverse geocode

Find an address near a location with the Geocoding service.