Style a feature layer | OpenLayers

Learn how to use style feature layersA feature layer (client-side) is a data layer that can access and display features from a feature service that has the same type of geometry and attribute fields.Learn more.

Style a feature layer using API key authentication

A feature layerA feature layer (server-side) is a spatially-enabled table in a feature service. All features in a feature layer share the same geometry type and set of fields.Learn more is a dataset in a feature serviceA feature service is a data service that provides access to spatial and non-spatial data in feature layers, feature layer views, and tables.Learn more hosted in ArcGISArcGIS is the brand name for all of the desktop, server, and developer products and technologies offered by Esri.Learn more. Each feature layer contains featuresA feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes.Learn more with a single geometryA geometry is a geometric shape, such as a point, polyline, or polygon, that contains one or more coordinates and a spatial reference.Learn more type (point, line, or polygon), and a set of attributesAttributes are fields and values for a single feature or non-spatial record. They are typically stored in a database or service such as a feature service.Learn more. Layers in OpenLayers can contain style functions, which use attribute values to change the appearance of features. This allows you to create complex, data-driven visualizations by relating visual variables to data attributes.

In this tutorial, you apply different styles to enhance the visualization of the Trailheads, Trails and Parks and Open Spaces feature layers.

Prerequisites

You need an ArcGIS Location Platform or ArcGIS Online account.

Steps

Get the starter app

Select a type of authentication and follow the steps to create a new app.

Choose API key authentication if you:

Want the easiest way to get started.
Want to build public applicationsA public application is an application that allows anonymous access without requiring users to sign in with an ArcGIS account. It supports API key or app authentication.Learn more that access ArcGIS Location ServicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services.Learn more and secure itemsAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
Have an ArcGIS Location Platform or ArcGIS Online account.

Choose user authentication if you:

Want to build private applications.
Require application users to sign in with their own ArcGIS accountAn ArcGIS account is an identity with a user type and set of privileges that can access specific ArcGIS products, tools, APIs, services, and resources. The main account types that can be used for development are an ArcGIS Location Platform account, ArcGIS Online account, and ArcGIS Enterprise account. ArcGIS Location Platform and ArcGIS Online accounts are also associated with a subscription.Learn more and access resources their behalf.
Have an ArcGIS Online account.

To learn more about both types of authentication, go to Authentication.

You can choose one of the following to create a new CodePen:

Option 1: Complete the Display a map tutorial; or,
Option 2: Start from the Display a map tutorial .

Set up authentication

Create a new API key credentialAPI key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential.Learn more with the correct privileges to get an access token.

Go to the Create an API key tutorial and create an API keyAn API key is a long-lived access token created using API key credentials. They are valid for up to one year and are typically embedded directly into client applications.Learn more with the following privilege(s)Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS.Learn more:
- Privileges
  - Location services > Basemaps
- Item access
  - Note: If you are using your own custom data layer for this tutorial, you need to grant the API key credentialsAPI key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential.Learn more access to the layer item. Learn more in Item access privileges.

Create a new OAuth credentialOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more to register the application.

Go to the Create OAuth credentials for user authentication tutorial to create an OAuth credential.
Copy the Client ID and Redirect URL from your OAuth credentials item and paste them to a safe location. They will be used in a later step.

Set developer credentials

Use the API key or OAuth developer credentialsDeveloper credentials are a type of item in a portal that contains parameters for authentication. There are two types of developer credentials: API key credentials and OAuth credentials.Learn more so your application can access ArcGIS servicesA service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise.Learn more.

Update the accessToken variable to use your API key.

Expand
Use dark colors for code blocksCopy
    /* Use for API key authentication */
    const accessToken = "YOUR_ACCESS_TOKEN";
Expand

In both the index.html and callback.html files, replace YOUR_CLIENT_ID and YOUR_REDIRECT_URL with the client ID and redirect URL of your OAuth credentialsOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more.

index.html
Use dark colors for code blocksCopy
    /* Use for user authentication */
    const clientId = "YOUR_CLIENT_ID"; // Your client ID from OAuth credentials
    const redirectUri = ""YOUR_REDIRECT_URI""; // The redirect URL registered in your OAuth credentials
    const session = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
      clientId,
      redirectUri,
      portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    });

    const accessToken = session.token;

callback.html
Use dark colors for code blocksCopy
    arcgisRest.ArcGISIdentityManager.completeOAuth2({
      clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
      redirectUri: "YOUR_REDIRECT_URI", // The redirect URL registered in your OAuth credentials
      portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    });

Run the app and ensure you can sign in successfully.

If you are unable to sign in, make sure you have the correct redirect URL and port. This URL varies based on your application and typically takes the format of https://<server>[:port]/callback.html or http://my-arcgis-app:/auth. For example, if you are running an application on http://127.0.0.1:5500/, set http://127.0.0.1:5500/callback.html as your redirect URL in the index.html and callback.html file and your developer credential. They all have to match!

Style trailheads with an image and labels

A Style in OpenLayers has several possible components: an image, text, stroke, fill and so on. To display a hiker icon for the trailheads layer, you use an Icon style as the image component. Specify which image file as the src, and the size as the scale parameter.

To display the trailhead name, you use a Text style. Use a left value for textAlign with an offsetX of 10 to display the labels to the right of the icons. Use Fill and Stroke styles as the fill and stroke properties to give the labels white text with a teal outline. The font property is a CSS font definition. Since the label for each trailhead is different, use a function to return a Style for a given feature. Set the text property using feature's TRL_NAME attribute.

Inside olms load handler, create a trailheadStyle function that takes a feature and returns a Style containing an Icon style. Use http://static.arcgis.com/images/Symbols/NPS/npsPictograph_0231b.png for the src and set a scale of 25%.

Expand
Use dark colors for code blocks
    const basemapId = "arcgis/streets";
    const basemapURL = `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapId}?token=${accessToken}`;

    olms.apply(map, basemapURL).then(function (map) {

      const trailheadStyle = function (feature) {
        return new ol.style.Style({
          image: new ol.style.Icon({
            src: "http://static.arcgis.com/images/Symbols/NPS/npsPictograph_0231b.png",
            scale: 0.25
          }),

Expand

Add a Text style to display labels with white text, teal outline, in an italic sans-serif font. Set the text property using the feature's TRL_NAME attribute.

Expand
Use dark colors for code blocks
      const trailheadStyle = function (feature) {
        return new ol.style.Style({
          image: new ol.style.Icon({
            src: "http://static.arcgis.com/images/Symbols/NPS/npsPictograph_0231b.png",
            scale: 0.25
          }),

          text: new ol.style.Text({
            text: feature.get("TRL_NAME"),
            font: "italic 12px sans-serif",
            offsetX: 10,
            textAlign: "left",
            fill: new ol.style.Fill({
              color: "#FFFFFF"
            }),

            stroke: new ol.style.Stroke({
              color: "#5E8D74",
              width: 3
            })
          })

        });
      };
Expand

Add a Vector layer with a Vector source to load and display the trailheads feature layer. Set declutter to be true to prevent label overlap. Pass the trailheadsStyle function as the style property.

Expand
Use dark colors for code blocks
            stroke: new ol.style.Stroke({
              color: "#5E8D74",
              width: 3
            })
          })

        });
      };

      const trailheadsLayerName = "Trailheads";
      const trailheadsLayerURL =
        "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/" +
        trailheadsLayerName +
        "/FeatureServer/0/query?where=1%3D1&outFields=*&returnGeometry=true&f=pgeojson";

      const trailheadsLayer = new ol.layer.Vector({
        source: new ol.source.Vector({
          format: new ol.format.GeoJSON(),
          url: trailheadsLayerURL,

        }),

        style: trailheadStyle,
        declutter: true
      });


Expand

For more information about adding feature layersA feature layer (server-side) is a spatially-enabled table in a feature service. All features in a feature layer share the same geometry type and set of fields.Learn more using GeoJSONGeoJSON is an open standard for representing geographic information in a JSON file. It is commonly used for sharing data between web services or manipulating vector data in the browser.Learn more, see the Add a feature layer as GeoJSON tutorial.

Add the data attributionData attribution is the requirement to display the names of data source providers in all applications when accessing ArcGIS content, layers, or services.Learn more for the feature layer source.

Go to the Trailheads (Santa Monica Mountains) itemAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
Scroll down to the Acknowledgments section and copy its value.

Paste the copied value to the attributions property.

Expand
Use dark colors for code blocks
            stroke: new ol.style.Stroke({
              color: "#5E8D74",
              width: 3
            })
          })

        });
      };

      const trailheadsLayerName = "Trailheads";
      const trailheadsLayerURL =
        "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/" +
        trailheadsLayerName +
        "/FeatureServer/0/query?where=1%3D1&outFields=*&returnGeometry=true&f=pgeojson";

      const trailheadsLayer = new ol.layer.Vector({
        source: new ol.source.Vector({
          format: new ol.format.GeoJSON(),
          url: trailheadsLayerURL,

          // Attribution text retrieved from https://arcgis.com/home/item.html?id=883cedb8c9fe4524b64d47666ed234a7
          attributions: ["Los Angeles GeoHub |"]

        }),

        style: trailheadStyle,
        declutter: true
      });


Expand

Style trail width by elevation gain

To visualize the elevation gain of a trail you can use the width of a Stroke style. To do this, create another function which returns a Style. The width of the style's stroke property will be a calculation converting feet of elevation gain to pixels of width.

Create a trailStyle function that takes a feature and returns a Style with a Stroke style. Set the color to pink, and calculate the width property from the feature's ELEV_GAIN attribute.

Expand
Use dark colors for code blocks
        style: trailheadStyle,
        declutter: true
      });



      const trailStyle = function (feature) {
        return new ol.style.Style({
          stroke: new ol.style.Stroke({
            color: "#BA55D3",
            width: 3 + (4 * feature.get("ELEV_GAIN")) / 2300
          })
        });
      };
Expand

Add the Trails feature layerA feature layer (server-side) is a spatially-enabled table in a feature service. All features in a feature layer share the same geometry type and set of fields.Learn more as a Vector layer with a GeoJSON Vector source. Pass your trailStyle function as the style property.

Expand
Use dark colors for code blocks
      const trailStyle = function (feature) {
        return new ol.style.Style({
          stroke: new ol.style.Stroke({
            color: "#BA55D3",
            width: 3 + (4 * feature.get("ELEV_GAIN")) / 2300
          })
        });
      };

      const trailsLayerName = "Trails";
      const trailsLayerURL =
        "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/" +
        trailsLayerName +
        "/FeatureServer/0/query?where=1%3D1&outFields=*&returnGeometry=true&f=pgeojson";
      const trailsLayer = new ol.layer.Vector({
        source: new ol.source.Vector({
          format: new ol.format.GeoJSON(),
          url: trailsLayerURL,

        }),

        style: trailStyle
      });

Expand

Go to the Trails itemAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
Scroll down to the Acknowledgments section and copy its value.

Paste the copied value to the attributions property.

Expand
Use dark colors for code blocks
      const trailStyle = function (feature) {
        return new ol.style.Style({
          stroke: new ol.style.Stroke({
            color: "#BA55D3",
            width: 3 + (4 * feature.get("ELEV_GAIN")) / 2300
          })
        });
      };

      const trailsLayerName = "Trails";
      const trailsLayerURL =
        "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/" +
        trailsLayerName +
        "/FeatureServer/0/query?where=1%3D1&outFields=*&returnGeometry=true&f=pgeojson";
      const trailsLayer = new ol.layer.Vector({
        source: new ol.source.Vector({
          format: new ol.format.GeoJSON(),
          url: trailsLayerURL,

          // Attribution text retrieved from https://arcgis.com/home/item.html?id=69e12682738e467eb509d8b54dc73cbd
          attributions: ["Los Angeles GeoHub |"]

        }),

        style: trailStyle
      });

Expand

Create a bikeTrailsStyle function. If the featureA feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes.Learn more has a Yes value for USE_BIKE, return a white dashed Stroke style. Otherwise, do not return a Style, so the featureA feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes.Learn more will not be displayed.

Expand
Use dark colors for code blocks
        style: trailStyle
      });


      const bikeTrailsStyle = function (feature) {
        if (feature.get("USE_BIKE") === "Yes") {
          return new ol.style.Style({

            stroke: new ol.style.Stroke({
              lineDash: [1, 4],
              color: "white",
              width: 2
            })
          });
        }
      };
Expand

Add a bikeTrailsLayer using the source from trailsLayer, with the bikeTrailsStyle function.

Expand
Use dark colors for code blocks
            stroke: new ol.style.Stroke({
              lineDash: [1, 4],
              color: "white",
              width: 2
            })
          });
        }
      };

      const bikeTrailsLayer = new ol.layer.Vector({
        source: trailsLayer.getSource(),
        style: bikeTrailsStyle
      });

Expand

Style park colors by type

You can use color to communicate the category of a featureA feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes.Learn more, such as the type of a park or open space. Use a style function to returns a Fill style, in which you derive the color property from the feature's TYPE property.

Create a parksStyle function which returns a Fill style. Look up the feature's TYPE attribute in a table to give a different color for Natural Areas, Regionla Open Space, Local Park and Regional Recreation Park. If the type is not one of these, make the color transparent.

Expand
Use dark colors for code blocks
      const bikeTrailsLayer = new ol.layer.Vector({
        source: trailsLayer.getSource(),
        style: bikeTrailsStyle
      });


      const parksStyle = function (feature) {
        const colorTable = {
          "Natural Areas": "#9E559C",
          "Regional Open Space": "#A7C636",
          "Local Park": "#149ECE",
          "Regional Recreation Park": "#ED5151"
        };

        return new ol.style.Style({
          fill: new ol.style.Fill({
            color: colorTable[feature.get("TYPE")] || "transparent"
          })
        });
      };
Expand

Create a Vector layer with a Vector source for the parks feature layerA feature layer (server-side) is a spatially-enabled table in a feature service. All features in a feature layer share the same geometry type and set of fields.Learn more. Pass your parksStyle function as the style property, with a low opacity.

Expand
Use dark colors for code blocks
        return new ol.style.Style({
          fill: new ol.style.Fill({
            color: colorTable[feature.get("TYPE")] || "transparent"
          })
        });
      };

      const parksLayerName = "Parks_and_Open_Space";
      const parksLayerURL =
        "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/" +
        parksLayerName +
        "/FeatureServer/0/query?where=1%3D1&outFields=*&returnGeometry=true&f=pgeojson";
      const parksLayer = new ol.layer.Vector({
        source: new ol.source.Vector({
          format: new ol.format.GeoJSON(),
          url: parksLayerURL,

        }),
        opacity: 0.2,
        style: parksStyle
      });
Expand

Go to the Parks and Open Space itemAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
Scroll down to the Acknowledgments section and copy its value.

Paste the copied value to the attributions property.

Expand
Use dark colors for code blocks
        return new ol.style.Style({
          fill: new ol.style.Fill({
            color: colorTable[feature.get("TYPE")] || "transparent"
          })
        });
      };

      const parksLayerName = "Parks_and_Open_Space";
      const parksLayerURL =
        "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/" +
        parksLayerName +
        "/FeatureServer/0/query?where=1%3D1&outFields=*&returnGeometry=true&f=pgeojson";
      const parksLayer = new ol.layer.Vector({
        source: new ol.source.Vector({
          format: new ol.format.GeoJSON(),
          url: parksLayerURL,

          // Attribution text retrieved from https://arcgis.com/home/item.html?id=f2ea5d874dad427294641d2d45097c0e
          attributions: ["Los Angeles GeoHub |"]

        }),
        opacity: 0.2,
        style: parksStyle
      });
Expand

Add all layers to map

To display multiple layers in a specific order, you group them using a LayerGroup. This makes it easier to manage and organize your map layers. Once the group is set up, you can display on it to the map using map.addLayer().

Create a layer group to add all the layers with the correct ordering.

Expand
Use dark colors for code blocks
      const layerGroup = new ol.layer.Group({
        layers: [parksLayer, bikeTrailsLayer, trailsLayer, trailheadsLayer]
      });

Expand

Display the layers on the map.

Expand
Use dark colors for code blocks
      const layerGroup = new ol.layer.Group({
        layers: [parksLayer, bikeTrailsLayer, trailsLayer, trailheadsLayer]
      });

      map.addLayer(layerGroup);
Expand

Run the app

Run the app.

You should now see parks of different colors, beneath the trails and trailhead layers.

What's next?

Learn how to use additional location services in these tutorials:

Map of Santa Monica, California showing parcels overlaid in different colors.

Style vector tiles

Change the fill and outline color of vector tiles based on their attributes on the client side.

Search for an address

Find an address or place using a search box.

Map showing a calculated driving route through downtown Toronto with turn‑by‑turn directions.

Find a route and directions

Find a route and directions from a start and finish location.