/static-maps/arcgis/{arcgis-style}/with-overlay

1
https://static-maps-api.arcgis.com/arcgis/rest/services/static-maps-service/beta-rc/static-maps/arcgis/{arcgis-style}/with-overlay

overlay

An array of geometries to display on the static map, including point, polyline, and/or polygon. Supports up to 64 geometries.

Each geometry can define its own symbol and label. Point geometries support either default marker symbols or custom SVG marker symbols referenced from symbolDictionary, while polyline and polygon geometries define their own line and fill styles.

The display order of geometries is determined first by geometry type: points are drawn above polylines, and polylines are drawn above polygons. Within each geometry type, geometries are drawn in the order they are added to the array, with the last geometry of that type drawn on top of the previous ones.

symbolDictionary

Dictionary of custom SVG marker symbols keyed by a unique ID. Values must be base64 data URLs referenced via customSymbolId.

The key is a unique string, such as campground or parkEntrance, and the value is a base64‑encoded data URL string representing the SVG image. To symbolize a specific geometry with a custom symbol, pass the key to the customSymbolId.

The general format of a base64‑encoded data URL string is data:[<mediatype>][;base64],<data>, as specified here.

To construct the data URL for an SVG image follow these steps:

1. Obtain the XML string from the SVG file.
2. Encode the XML string into base64 format.
3. Append the base64-formatted string to data:image/svg+xml;base64,.

There is a range of SVG symbols from ESRI available from the Calcite point symbols repository or the Esri developer Place icons site.

The maximum length of the base64‑encoded data URL string is 8000 characters.

Unsupported SVG Features

• SVG images must not reference external resources using URLs.
• Embedded raster images, such as png, jpeg, and webp formats, are not supported.
• SVG images that contain font-based text elements are not supported.
• It is recommended that text is converted into vector paths so that it can be rendered in custom symbols.

image

The image object defines the image width, height, format, padding and attribution of the static map.

Height and width controls the image size between 128px to 1024px inclusive. Format controls the requested image format which can be either webp, png or jpeg.

Padding applied to the static map adds extra map content between the static map's extent and the edge of the image. Padding value is a % of the static map image's width and/or height.

Attribution defines the theme of the embed attribution within the map. This can be one either auto, dark, light or none.

map

A map view that specifies the center location and visible geographic area of the map.

This object specifies:

radius: The distance from the center point that determines the coverage area. zoom: The map zoom level controlling the scale and detail of the map. center: The geographic coordinates (latitude and longitude) of the focal point for the map.

zoom and radius are mutually exclusive.

arcgis-style

The ArcGIS basemap style used to render the map.

Group	Style	Example	Description	Data attribution
Streets	navigation		A custom navigation style designed for use during daylight hours	Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community
Streets	navigation-night		A custom navigation style designed for use in hours of darkness	Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community
Streets	streets		A classic Esri street map style designed for use during daylight hours	Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community
Streets	streets-night		A classic Esri street map style designed for use in hours of darkness	Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community
Satellite	imagery		Low-resolution satellite imagery for the world and high-resolution satellite and aerial imagery, typically within 3-5 years of currency, for most of the world.	Esri, Vantor, GeoEye, Earthstar Geographics, CNES/Airbus DS, USDA, USGS, AeroGRID, IGN, © OpenStreetMap contributors, TomTom, Garmin, FAO, NOAA, and the GIS User Community

Enumerated values

Click to copyClick to copyClick to copyClick to copyClick to copy

1
2
3
4
5
# You can also use wget
curl -X POST 'https://static-maps-api.arcgis.com/arcgis/rest/services/static-maps-service/beta-rc/static-maps/arcgis/streets/with-overlay' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  --data '{"overlay":[{"type":"string","geometry":{"x":-117.1957,"y":34.0561,"spatialReference":{"wkid":4326}},"symbol":{"customSymbolId":"campground","scale":1,"offsetX":0,"offsetY":0}}],"symbolDictionary":{"parkEntrance":"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+","campground":"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+"},"image":{"width":500,"height":500,"format":"png","padding":[10,0,10,20],"attribution":"auto"},"map":{"radius":1000,"zoom":12,"center":{"x":-117.1957,"y":34.0561,"spatialReference":{"wkid":4326}},"basemapOptions":{"referenceDetails":"all"}}}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
const inputBody = {
  "overlay": [
    {
      "type": "string",
      "geometry": {
        "x": -117.1957,
        "y": 34.0561,
        "spatialReference": {
          "wkid": 4326
        }
      },
      "symbol": {
        "customSymbolId": "campground",
        "scale": 1,
        "offsetX": 0,
        "offsetY": 0
      }
    }
  ],
  "symbolDictionary": {
    "parkEntrance": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+",
    "campground": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+"
  },
  "image": {
    "width": 500,
    "height": 500,
    "format": "png",
    "padding": [
      10,
      0,
      10,
      20
    ],
    "attribution": "auto"
  },
  "map": {
    "radius": 1000,
    "zoom": 12,
    "center": {
      "x": -117.1957,
      "y": 34.0561,
      "spatialReference": {
        "wkid": 4326
      }
    },
    "basemapOptions": {
      "referenceDetails": "all"
    }
  }
};

const headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer <YOUR_TOKEN>"
};

fetch("https://static-maps-api.arcgis.com/arcgis/rest/services/static-maps-service/beta-rc/static-maps/arcgis/streets/with-overlay", {
  method: "POST",
  body: inputBody,
  headers: headers
}).then(response => {
  if (response.status === 200) {
    return response.blob();
  }
  return response.json();
}).then(body => {
  console.log(body);
});