Types | Esri Developer REST APIs documentation

Attribution

Example
Use dark colors for code blocksCopy
{
  "attribution": "Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community."
}

The map's attribution information.

Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the /static-maps/arcgis/{arcgis-style}/attribution endpoint. For more information see the ArcGIS Location Platform Agreement on the Terms of use.

Properties

Name	Type	Required
`attribution`	`string`

CoordGeometry

Example
Use dark colors for code blocksCopy
[
  -117.1957,
  34.0561
]

The x (longitude) and y (latitude) coordinate pair in the WGS84 spatial reference.

longitude in the range -179.99 to 179.99 representing the east/west or x-axis
latitude in the range -85.05 to 85.05 representing the north/south or y-axis

CustomMarkerSymbol

Example
Use dark colors for code blocksCopy
{
  "customSymbolId": "campground",
  "scale": 1,
  "offsetX": 0,
  "offsetY": 0
}

The custom marker symbol can display an SVG image that is stored in the CustomSymbols dictionary.

To use a custom SVG symbol, store the base64‑encoded data URL string representing the SVG image in the customSymbols property. This property is a dictionary, where the key is a unique string, such as campground, 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.

Properties

Name	Type	Description
`customSymbolId`	`string`	The key to a base64-encoded data url string for an SVG image in the `CustomSymbols` dictionary.
`scale`	`SymbolScale`	The scale of the marker symbol as a multiplier of the symbol's dimensions. A scale value less than 1.0 indicates that the symbol is scaled down, while a value greater than 1.0 indicates that the symbol is scaled up. For example, a scale of 0.5 will reduce the symbol's dimensions to half its original size. A scale of 2.0 will double the symbol's dimensions. The minimum scale is 0.1 and the maximum scale is 4.0.
`offsetX`	`SymbolOffsetX`	The offset rightward in pixels along the X-axis. If the offset exceeds the bounds of the map, the symbol may be located outside of the resultant image.
`offsetY`	`SymbolOffsetY`	The offset downward in pixels along the Y-axis. If the offset exceeds the bounds of the map, the symbol may be located outside of the resultant image.

CustomSymbols

Example
Use dark colors for code blocksCopy
{
  "parkEntrance": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+",
  "campground": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+"
}

customSymbols is a dictionary of key-value pairs, where each pair defines a custom symbol to be added to the map.

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:

Obtain the XML string from the SVG file.
Encode the XML string into base64 format.
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.

Error

Example
Use dark colors for code blocksCopy
{
  "error": {
    "code": 400,
    "message": "string",
    "details": [
      "string"
    ],
    "restInfoUrl": "https://static-maps-api.arcgis.com/arcgis/rest/info"
  }
}

Properties

Name	Type	Required	Description
`error`	`object`		Error information

`error` properties

Name	Type	Description
`code`	`integer`	A code identifying the type of error, either an HTTP error code, `498` (signifying invalid or expired token), or `499` (signifying missing token).
`message`	`string`	A message describing the error.
`details`	`[string]`	List of details about the error.
`restInfoUrl`	`string`	URL that provides the static maps service information.

Enumerated values

code

400

Click to copy

401

Click to copy

403

Click to copy

404

Click to copy

498

Click to copy

499

Click to copy

500

Click to copy

FillStyle

Example
Use dark colors for code blocksCopy
"solid"

The style of the fill.

The default line style is solid.

Type: string
Required: false
Restrictions: none
Default value: solid

Enumerated values

anonymous

solid

Click to copy

none

Click to copy

GraphicManyPoints

Example
Use dark colors for code blocksCopy
{
  "customSymbols": {
    "parkEntrance": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+",
    "campground": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+"
  },
  "manyPoints": [
    {
      "geometry": {
        "x": -117.1957,
        "y": 34.0561,
        "spatialReference": {
          "wkid": 4326
        }
      },
      "symbol": {
        "customSymbolId": "campground",
        "scale": 1,
        "offsetX": 0,
        "offsetY": 0
      }
    }
  ]
}

The manyPoints geometry and its associated symbol. The symbol can be a simple marker symbol or a custom marker symbol.

Properties

Name Type Required Description

Name	Type	Required	Description
`customSymbols`	`CustomSymbols`		`customSymbols` is a dictionary of key-value pairs, where each pair defines a custom symbol to be added to the map. 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: Obtain the XML string from the SVG file. Encode the XML string into base64 format. 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.
`manyPoints`	`[PointAndSymbol]`		An array x,y (lon, lat) coordinate pairs in the WGS84 spatial reference along with a symbol for the point.

customSymbols

CustomSymbols

customSymbols is a dictionary of key-value pairs, where each pair defines a custom symbol to be added to the map.

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:

Obtain the XML string from the SVG file.
Encode the XML string into base64 format.
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.

manyPoints

[PointAndSymbol]

An array x,y (lon, lat) coordinate pairs in the WGS84 spatial reference along with a symbol for the point.

GraphicPoint

Example
Use dark colors for code blocksCopy
{
  "customSymbols": {
    "parkEntrance": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+",
    "campground": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+"
  },
  "point": {
    "geometry": {
      "x": -117.1957,
      "y": 34.0561,
      "spatialReference": {
        "wkid": 4326
      }
    },
    "symbol": {
      "customSymbolId": "campground",
      "scale": 1,
      "offsetX": 0,
      "offsetY": 0
    }
  }
}

The point geometry and its associated symbol. The symbol can be a simple marker symbol or a custom marker symbol.

Properties

Name Type Required Description

Name	Type	Required	Description
`customSymbols`	`CustomSymbols`		`customSymbols` is a dictionary of key-value pairs, where each pair defines a custom symbol to be added to the map. 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: Obtain the XML string from the SVG file. Encode the XML string into base64 format. 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.
`point`	`PointAndSymbol`		The point geometry and its associated symbol. The symbol can be a simple marker symbol or a custom marker symbol. To use a custom SVG symbol, store the base64‑encoded data URL string representing the SVG image in the `customSymbols` property. This property is a dictionary, where the key is a unique string, such as `campground`, 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`.

customSymbols

CustomSymbols

customSymbols is a dictionary of key-value pairs, where each pair defines a custom symbol to be added to the map.

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:

Obtain the XML string from the SVG file.
Encode the XML string into base64 format.
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.

point

PointAndSymbol

The point geometry and its associated symbol. The symbol can be a simple marker symbol or a custom marker symbol.

GraphicPolygon

Example
Use dark colors for code blocksCopy
{
  "polygon": {
    "rings": [
      [
        [
          -117.247325,
          34.100934
        ],
        [
          -117.247506,
          34.104433
        ],
        [
          -117.247962,
          34.105095
        ],
        [
          -117.244321,
          34.106745
        ],
        [
          -117.209646,
          34.106204
        ],
        [
          -117.208757,
          34.105251
        ]
      ]
    ]
  },
  "ringStyle": {
    "polygonSymbol": {
      "style": "solid",
      "color": "007AC2",
      "outline": {
        "style": "solid",
        "color": "007AC2",
        "width": 2
      }
    }
  }
}

The ring geometry and its associated ring style.

Properties

Name Type Required Description

Name	Type	Required	Description
`polygon`	`Polygon`		An array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference. The first coordinate pair in a ring array represents the start of the area. Subsequent coordinates represent the vertices, in a clockwise manner, that define area boundary. The last x,y coordinate pair will be connected to the first coordinate pair to close the area. A ring can contain between 3 and 5000 coordinate pairs.
`ringStyle`	`RingStyle`		The properties that define the style, color, and outline of the polygon.

polygon

Polygon

An array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference.

The first coordinate pair in a ring array represents the start of the area. Subsequent coordinates represent the vertices, in a clockwise manner, that define area boundary. The last x,y coordinate pair will be connected to the first coordinate pair to close the area.

A ring can contain between 3 and 5000 coordinate pairs.

ringStyle

RingStyle

The properties that define the style, color, and outline of the polygon.

GraphicPolyline

Example
Use dark colors for code blocksCopy
{
  "customSymbols": {
    "parkEntrance": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+",
    "campground": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+"
  },
  "polyline": {
    "paths": [
      [
        [
          -117.247325,
          34.100934
        ],
        [
          -117.247506,
          34.104433
        ],
        [
          -117.247962,
          34.105095
        ]
      ],
      [
        [
          -117.247962,
          34.105095
        ],
        [
          -117.244321,
          34.106745
        ],
        [
          -117.209646,
          34.106204
        ],
        [
          -117.208757,
          34.105251
        ]
      ]
    ],
    "spatialReference": {
      "wkid": 4326
    }
  },
  "polylineStyle": {
    "startSymbol": {
      "customSymbolId": "campground",
      "scale": 1,
      "offsetX": 0,
      "offsetY": 0
    },
    "endSymbol": {
      "customSymbolId": "campground",
      "scale": 1,
      "offsetX": 0,
      "offsetY": 0
    },
    "lineSymbol": {
      "style": "solid",
      "color": "007AC2",
      "width": 2
    }
  }
}

The polyline geometry and polyline style with its associated symbol. The symbol can be a simple marker symbol or a custom marker symbol.

Properties

Name Type Required Description

Name	Type	Description
`customSymbols`	`CustomSymbols`	`customSymbols` is a dictionary of key-value pairs, where each pair defines a custom symbol to be added to the map. 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: Obtain the XML string from the SVG file. Encode the XML string into base64 format. 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.
`polyline`	`Polyline`	The polyline is represented as a line that is displayed on a static map. Each polyline can consist of one or more paths, where each path is an array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference. When a polyline consists of more than one path, the polyline is contiguous only if the last point of each path matches the first point of the next path in the array. The polyline starts at the first coordinate pair in the polyline's first path, and ends at the last coordinate pair in the polyline's last path. The polyline is displayed using the `lineSymbol`, while the start and end points are represented by the `startSymbol` and `endSymbol`, respectively. The polyline can contain from 2 to 5000 coordinate pairs that can be defined in one or more paths.
`polylineStyle`	`PolylineStyle`	The symbols associated with the polyline's line, start, and end points. The start and end symbols can either be simple marker symbols or custom marker symbols. To use a custom SVG symbol, store the base64‑encoded data URL string representing the SVG image in the `customSymbols` property. This property is a dictionary, where the key is a unique string, such as `campground`, 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`.

customSymbols

CustomSymbols

customSymbols is a dictionary of key-value pairs, where each pair defines a custom symbol to be added to the map.

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:

Obtain the XML string from the SVG file.
Encode the XML string into base64 format.
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.

polyline

Polyline

The polyline is represented as a line that is displayed on a static map.

Each polyline can consist of one or more paths, where each path is an array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference. When a polyline consists of more than one path, the polyline is contiguous only if the last point of each path matches the first point of the next path in the array. The polyline starts at the first coordinate pair in the polyline's first path, and ends at the last coordinate pair in the polyline's last path. The polyline is displayed using the lineSymbol, while the start and end points are represented by the startSymbol and endSymbol, respectively. The polyline can contain from 2 to 5000 coordinate pairs that can be defined in one or more paths.

polylineStyle

PolylineStyle

The symbols associated with the polyline's line, start, and end points.

The start and end symbols can either be simple marker symbols or custom marker symbols.

HexColor

Example
Use dark colors for code blocksCopy
"007AC2"

The color of the marker symbol in hexadecimal format.

It has the format RRGGBB or RRGGBBAA.

RR is the red value
GG is the green value
BB is the blue value
AA is the alpha value. 00 is fully transparent and FF is a solid fill.

For example, a semi-transparent red color is represented as FF000080. The default color is a medium-dark shade of blue (007AC2).

Type: string
Required: false
Restrictions: none
Default value: 007AC2
Minimum length: 6
Maximum length: 8

Image

Example
Use dark colors for code blocksCopy
{
  "width": 500,
  "height": 500,
  "format": "png",
  "padding": [
    10,
    0,
    10,
    20
  ]
}

Define the width, height and format of the requested static map image.

Properties

Name Type Required Description

width

ImageDimension

A dimension of the requested map image in pixels at 96 DPI between 64 and 1024 pixels.

height

ImageDimension

A dimension of the requested map image in pixels at 96 DPI between 64 and 1024 pixels.

format

ImageFormat

The format in which the map image is returned. Supported formats include png, jpeg, and webp.

padding

Padding

The 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. It is applied to the static map image, according to the table below:

Number of values in the array	Description	Example
One	The same padding % is applied to all four sides.	[10]
Two	The first value applies padding to the top and bottom, the second to the left and right sides.	[10, 5 ]
Three	The first value applies padding to the top, the second to the left and right sides, and the third to the bottom.	[10, 20, 10]
Four	The four values apply padding to the top, right, bottom, and left in a clockwise order.	[10, 5, 5, 20]

If padding is not specified, a value of 10% is applied to all sides. The maximum allowed padding value is 25%

ImageDimension

Example
Use dark colors for code blocksCopy
500

A dimension of the requested map image in pixels at 96 DPI between 64 and 1024 pixels.

Type: integer
Required: false
Restrictions: none
Default value: 200
Minimum: 64
Maximum: 1024

ImageFormat

Example
Use dark colors for code blocksCopy
"png"

The format in which the map image is returned. Supported formats include png, jpeg, and webp.

Type: string
Required: false
Restrictions: none
Default value: webp

Enumerated values

anonymous

png

Click to copy

jpeg

Click to copy

webp

Click to copy

LineStyle

Example
Use dark colors for code blocksCopy
"solid"

The style, or stroke, to apply to the line symbol.

The default line style is solid.

Type: string
Required: false
Restrictions: none
Default value: solid

Enumerated values

anonymous

solid

Click to copy

dash

Click to copy

dot

Click to copy

LineSymbol

Example
Use dark colors for code blocksCopy
{
  "style": "solid",
  "color": "007AC2",
  "width": 2
}

The properties that define the width, style, and color of a line.

Properties

Name Type Required Description

Name	Type	Description
`style`	`LineStyle`	The style, or stroke, to apply to the line symbol. The default line style is `solid`.
`color`	`HexColor`	The color of the marker symbol in hexadecimal format. It has the format `RRGGBB` or `RRGGBBAA`. `RR` is the red value `GG` is the green value `BB` is the blue value `AA` is the alpha value. `00` is fully transparent and `FF` is a solid fill. For example, a semi-transparent red color is represented as `FF000080`. The default color is a medium-dark shade of blue (`007AC2`).
`width`	`LineWidth`	The width of the line in device-independent pixels. The minimum width is 1 and the maximum width is 16.

style

LineStyle

The style, or stroke, to apply to the line symbol.

The default line style is solid.

color

HexColor

The color of the marker symbol in hexadecimal format.

It has the format RRGGBB or RRGGBBAA.

RR is the red value
GG is the green value
BB is the blue value
AA is the alpha value. 00 is fully transparent and FF is a solid fill.

For example, a semi-transparent red color is represented as FF000080. The default color is a medium-dark shade of blue (007AC2).

width

LineWidth

The width of the line in device-independent pixels.

The minimum width is 1 and the maximum width is 16.

LineWidth

Example
Use dark colors for code blocksCopy
2

The width of the line in device-independent pixels.

The minimum width is 1 and the maximum width is 16.

Type: integer
Required: false
Restrictions: none
Default value: 2
Minimum: 1
Maximum: 16

ManyPointsGet

An array x,y (lon, lat) coordinate pairs in the WGS84 spatial reference along with their associated symbol definitions.

The symbol can be a simple marker symbol or a custom marker symbol.

Properties

Name Type Required Description

Name	Type	Required	Description
`manyPoints`	`[PointAndSymbol]`		An array x,y (lon, lat) coordinate pairs in the WGS84 spatial reference along with a symbol for the point. The array can contain from 1 to 10 coordinate pairs and symbols.

manyPoints

[PointAndSymbol]

An array x,y (lon, lat) coordinate pairs in the WGS84 spatial reference along with a symbol for the point.

The array can contain from 1 to 10 coordinate pairs and symbols.

Map

Example
Use dark colors for code blocksCopy
{
  "radius": 1000,
  "zoom": 12,
  "center": {
    "x": -117.1957,
    "y": 34.0561,
    "spatialReference": {
      "wkid": 4326
    }
  }
}

Represents the visible extent 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.

Note: zoom and radius are mutually exclusive.

Properties

Name Type Required Description

radius

RadiusDistance

The radius, in meters, that defines the minimum geographic area shown around the specified point on the static map.

Note: mapZoom and mapRadius are mutually exclusive. Please only choose one or the other.

The mapRadius value is used to define the real world radius of the area displayed in the map image. The area covered by the radius will always be displayed on the static map image.

If the image width and height are equal, the static map image will be square and the geographic extent displayed by the static map image will match that defined by the radius. However, if the image width is greater than the height, the geographic extent displayed by the static map image will be wider than that defined by the radius.

As a guide, the following radius values can be used for the following types of static maps.

Radius (meters)	Approximate extent (diameter)	Typical map usage	Zoom
10	~20 m	Building / site	22
100	~200 m	Street / block	18–19
1,000	~2 km	Neighborhood / district	15–16
10,000	~20 km	City	12–13
100,000	~200 km	Metro / region	9–10
1,000,000	~2,000 km	State / large region	6–7

The radius has a minimum value of 10 meters and a maximum value of 20,000,000 meters.

zoom

ZoomLevel

Specifies the map zoom level, which determines the level of detail (LOD) displayed. Valid values range from 0 to 22. Higher zoom values show more detailed features at a smaller geographic extent, while lower zoom values display broader areas with less detail. This parameter is typically used to control map rendering scale, tile selection, and feature visibility.

center

PointGeometry

An x,y (lon, lat) coordinate pair in the WGS84 spatial reference.

Padding

Example
Use dark colors for code blocksCopy
[
  10,
  0,
  10,
  20
]

The 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. It is applied to the static map image, according to the table below:

Number of values in the array	Description	Example
One	The same padding % is applied to all four sides.	[10]
Two	The first value applies padding to the top and bottom, the second to the left and right sides.	[10, 5 ]
Three	The first value applies padding to the top, the second to the left and right sides, and the third to the bottom.	[10, 20, 10]
Four	The four values apply padding to the top, right, bottom, and left in a clockwise order.	[10, 5, 5, 20]

If padding is not specified, a value of 10% is applied to all sides. The maximum allowed padding value is 25%

PathGeometry

Example
Use dark colors for code blocksCopy
[
  [
    -117.1957,
    34.0561
  ],
  [
    -117.1957,
    34.0561
  ]
]

A path is an array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference.

PathGeometryGet

Example
Use dark colors for code blocksCopy
[
  [
    -117.247325,
    34.100934
  ],
  [
    -117.247506,
    34.104433
  ],
  [
    -117.247962,
    34.105095
  ]
]

An array x,y (lon, lat) coordinate pairs in the WGS84 spatial reference that define a path.

The array can contain from 2 to 10 coordinate pairs.

Paths

Example
Use dark colors for code blocksCopy
[
  [
    [
      -117.247325,
      34.100934
    ],
    [
      -117.247506,
      34.104433
    ],
    [
      -117.247962,
      34.105095
    ]
  ],
  [
    [
      -117.247962,
      34.105095
    ],
    [
      -117.244321,
      34.106745
    ],
    [
      -117.209646,
      34.106204
    ],
    [
      -117.208757,
      34.105251
    ]
  ]
]

An array polyline paths.

When a polyline consists of more than one path, the polyline is contiguous only if the last point of each path matches the first point of the next path in the array.

The polyline can contain between 2 and 5000 coordinate pairs across all paths.

PointAndSymbol

Example
Use dark colors for code blocksCopy
{
  "geometry": {
    "x": -117.1957,
    "y": 34.0561,
    "spatialReference": {
      "wkid": 4326
    }
  },
  "symbol": {
    "customSymbolId": "campground",
    "scale": 1,
    "offsetX": 0,
    "offsetY": 0
  }
}

The point geometry and its associated symbol. The symbol can be a simple marker symbol or a custom marker symbol.

Properties

Name	Type	Required	Description
`geometry`	`PointGeometry`		An x,y (lon, lat) coordinate pair in the WGS84 spatial reference.
`symbol`	`oneOf: CustomMarkerSymbol, SimpleMarkerSymbol`		The symbol can be a simple marker symbol or a custom marker symbol.

PointGeometry

Example
Use dark colors for code blocksCopy
{
  "x": -117.1957,
  "y": 34.0561,
  "spatialReference": {
    "wkid": 4326
  }
}

An x,y (lon, lat) coordinate pair in the WGS84 spatial reference.

Properties

Name Type Required Description

Name	Type	Description
`x`	`number`	An x-coordinate, or longitude, in WGS84 decimal degrees.
`y`	`number`	A y-coordinate, or latitude, in WGS84 decimal degrees.
`spatialReference`	`SpatialReference`	The spatial reference of the geometry. The spatial reference must always be WGS84 (wkid = 4326).

x

number

An x-coordinate, or longitude, in WGS84 decimal degrees.

y

number

A y-coordinate, or latitude, in WGS84 decimal degrees.

spatialReference

SpatialReference

The spatial reference of the geometry.

The spatial reference must always be WGS84 (wkid = 4326).

Polygon

Example
Use dark colors for code blocksCopy
{
  "rings": [
    [
      [
        -117.247325,
        34.100934
      ],
      [
        -117.247506,
        34.104433
      ],
      [
        -117.247962,
        34.105095
      ],
      [
        -117.244321,
        34.106745
      ],
      [
        -117.209646,
        34.106204
      ],
      [
        -117.208757,
        34.105251
      ]
    ]
  ]
}

An array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference.

A ring can contain between 3 and 5000 coordinate pairs.

Properties

Name Type Required Description

Name	Type	Required	Description
`rings`	`Rings`		An array of rings that contain x,y (lon, lat) coordinate pairs in the WGS84 spatial reference. Interior holes is not supported. The ring can contain between 3 and 5000 coordinate pairs.

rings

Rings

An array of rings that contain x,y (lon, lat) coordinate pairs in the WGS84 spatial reference.

Interior holes is not supported. The ring can contain between 3 and 5000 coordinate pairs.

PolygonSymbol

Example
Use dark colors for code blocksCopy
{
  "style": "solid",
  "color": "007AC2",
  "outline": {
    "style": "solid",
    "color": "007AC2",
    "width": 2
  }
}

The properties that define the style, color, and outline of the polygon.

Properties

Name Type Required Description

Name	Type	Description
`style`	`FillStyle`	The style of the fill. The default line style is `solid`.
`color`	`HexColor`	The color of the marker symbol in hexadecimal format. It has the format `RRGGBB` or `RRGGBBAA`. `RR` is the red value `GG` is the green value `BB` is the blue value `AA` is the alpha value. `00` is fully transparent and `FF` is a solid fill. For example, a semi-transparent red color is represented as `FF000080`. The default color is a medium-dark shade of blue (`007AC2`).
`outline`	`LineSymbol`	The properties that define the width, style, and color of a line.

style

FillStyle

The style of the fill.

The default line style is solid.

color

HexColor

The color of the marker symbol in hexadecimal format.

It has the format RRGGBB or RRGGBBAA.

RR is the red value
GG is the green value
BB is the blue value
AA is the alpha value. 00 is fully transparent and FF is a solid fill.

For example, a semi-transparent red color is represented as FF000080. The default color is a medium-dark shade of blue (007AC2).

outline

LineSymbol

The properties that define the width, style, and color of a line.

Polyline

Example
Use dark colors for code blocksCopy
{
  "paths": [
    [
      [
        -117.247325,
        34.100934
      ],
      [
        -117.247506,
        34.104433
      ],
      [
        -117.247962,
        34.105095
      ]
    ],
    [
      [
        -117.247962,
        34.105095
      ],
      [
        -117.244321,
        34.106745
      ],
      [
        -117.209646,
        34.106204
      ],
      [
        -117.208757,
        34.105251
      ]
    ]
  ],
  "spatialReference": {
    "wkid": 4326
  }
}

The polyline is represented as a line that is displayed on a static map.

Properties

Name Type Required Description

Name	Type	Required	Description
`paths`	`Paths`		An array polyline paths. When a polyline consists of more than one path, the polyline is contiguous only if the last point of each path matches the first point of the next path in the array. The polyline can contain between 2 and 5000 coordinate pairs across all paths.
`spatialReference`	`SpatialReference`		The spatial reference of the geometry. The spatial reference must always be WGS84 (wkid = 4326).

paths

Paths

An array polyline paths.

When a polyline consists of more than one path, the polyline is contiguous only if the last point of each path matches the first point of the next path in the array.

The polyline can contain between 2 and 5000 coordinate pairs across all paths.

spatialReference

SpatialReference

The spatial reference of the geometry.

The spatial reference must always be WGS84 (wkid = 4326).

PolylineStyle

Example
Use dark colors for code blocksCopy
{
  "startSymbol": {
    "customSymbolId": "campground",
    "scale": 1,
    "offsetX": 0,
    "offsetY": 0
  },
  "endSymbol": {
    "customSymbolId": "campground",
    "scale": 1,
    "offsetX": 0,
    "offsetY": 0
  },
  "lineSymbol": {
    "style": "solid",
    "color": "007AC2",
    "width": 2
  }
}

The symbols associated with the polyline's line, start, and end points.

The start and end symbols can either be simple marker symbols or custom marker symbols.

Properties

Name	Type	Description
`startSymbol`	`oneOf: CustomMarkerSymbol, SimpleMarkerSymbol`	The symbol displayed at the start of the polyline. It can be a simple marker symbol or a custom marker symbol.
`endSymbol`	`oneOf: CustomMarkerSymbol, SimpleMarkerSymbol`	The symbol displayed at the start of the polyline. It can be a simple marker symbol or a custom marker symbol.
`lineSymbol`	`LineSymbol`	The properties that define the width, style, and color of a line.

RadiusDistance

Example
Use dark colors for code blocksCopy
1000

The radius, in meters, that defines the minimum geographic area shown around the specified point on the static map.

Note: mapZoom and mapRadius are mutually exclusive. Please only choose one or the other.

The mapRadius value is used to define the real world radius of the area displayed in the map image. The area covered by the radius will always be displayed on the static map image.

As a guide, the following radius values can be used for the following types of static maps.

Radius (meters)	Approximate extent (diameter)	Typical map usage	Zoom
10	~20 m	Building / site	22
100	~200 m	Street / block	18–19
1,000	~2 km	Neighborhood / district	15–16
10,000	~20 km	City	12–13
100,000	~200 km	Metro / region	9–10
1,000,000	~2,000 km	State / large region	6–7

The radius has a minimum value of 10 meters and a maximum value of 20,000,000 meters.

Type: number(float)
Required: false
Restrictions: none
Minimum: 10
Maximum: 20000000

Ring

Example
Use dark colors for code blocksCopy
[
  [
    [
      -117.247962,
      34.105095
    ],
    [
      -117.244321,
      34.106745
    ],
    [
      -117.209646,
      34.106204
    ],
    [
      -117.208757,
      34.105251
    ]
  ]
]

A ring is an array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference.

Rings

Example
Use dark colors for code blocksCopy
[
  [
    [
      -117.247325,
      34.100934
    ],
    [
      -117.247506,
      34.104433
    ],
    [
      -117.247962,
      34.105095
    ],
    [
      -117.244321,
      34.106745
    ],
    [
      -117.209646,
      34.106204
    ],
    [
      -117.208757,
      34.105251
    ]
  ]
]

An array of rings that contain x,y (lon, lat) coordinate pairs in the WGS84 spatial reference.

Interior holes is not supported. The ring can contain between 3 and 5000 coordinate pairs.

RingStyle

Example
Use dark colors for code blocksCopy
{
  "polygonSymbol": {
    "style": "solid",
    "color": "007AC2",
    "outline": {
      "style": "solid",
      "color": "007AC2",
      "width": 2
    }
  }
}

The properties that define the style, color, and outline of the polygon.

Properties

Name	Type	Required	Description
`polygonSymbol`	`PolygonSymbol`		The properties that define the style, color, and outline of the polygon.

SimpleMarkerSymbol

Example
Use dark colors for code blocksCopy
{
  "style": "pin",
  "scale": 1,
  "color": "007AC2",
  "label": "A",
  "offsetX": 0,
  "offsetY": 0
}

The simple marker symbol can have a colored pin or circle style. It can be labeled and scaled, as required.

Properties

Name	Type	Description
`style`	`SymbolStyle`	The style of the marker symbol can be `pin` or `circle`.
`scale`	`SymbolScale`	The scale of the marker symbol as a multiplier of the symbol's dimensions. A scale value less than 1.0 indicates that the symbol is scaled down, while a value greater than 1.0 indicates that the symbol is scaled up. For example, a scale of 0.5 will reduce the symbol's dimensions to half its original size. A scale of 2.0 will double the symbol's dimensions. The minimum scale is 0.1 and the maximum scale is 4.0.
`color`	`HexColor`	The color of the marker symbol in hexadecimal format. It has the format `RRGGBB` or `RRGGBBAA`. `RR` is the red value `GG` is the green value `BB` is the blue value `AA` is the alpha value. `00` is fully transparent and `FF` is a solid fill. For example, a semi-transparent red color is represented as `FF000080`. The default color is a medium-dark shade of blue (`007AC2`).
`label`	`SymbolLabel`	A label to be displayed on the marker symbol. The label can be a maximum of two letters or numbers from a-z, A-Z, and 0-9.
`offsetX`	`SymbolOffsetX`	The offset rightward in pixels along the X-axis. If the offset exceeds the bounds of the map, the symbol may be located outside of the resultant image.
`offsetY`	`SymbolOffsetY`	The offset downward in pixels along the Y-axis. If the offset exceeds the bounds of the map, the symbol may be located outside of the resultant image.

SpatialReference

Example
Use dark colors for code blocksCopy
{
  "wkid": 4326
}

The spatial reference of the geometry.

The spatial reference must always be WGS84 (wkid = 4326).

Properties

Name Type Required Description

Name	Type	Required	Description
`wkid`	`Wkid`		The WKID (Well-Known ID) is a unique integer identifier used to define a specific spatial reference. The wkid value of 4326, for WGS84, is currently the only supported WKID.

wkid

Wkid

The WKID (Well-Known ID) is a unique integer identifier used to define a specific spatial reference.

The wkid value of 4326, for WGS84, is currently the only supported WKID.

SymbolLabel

Example
Use dark colors for code blocksCopy
"A"

A label to be displayed on the marker symbol.

The label can be a maximum of two letters or numbers from a-z, A-Z, and 0-9.

Type: string
Required: false
Restrictions: none
Minimum length: 1
Maximum length: 2

SymbolOffsetX

Example
Use dark colors for code blocksCopy
0

The offset rightward in pixels along the X-axis.

If the offset exceeds the bounds of the map, the symbol may be located outside of the resultant image.

Type: integer
Required: false
Restrictions: none
Default value: 0
Minimum: -512
Maximum: 512

SymbolOffsetY

Example
Use dark colors for code blocksCopy
0

The offset downward in pixels along the Y-axis.

If the offset exceeds the bounds of the map, the symbol may be located outside of the resultant image.

Type: integer
Required: false
Restrictions: none
Default value: 0
Minimum: -512
Maximum: 512

SymbolScale

Example
Use dark colors for code blocksCopy
1

The scale of the marker symbol as a multiplier of the symbol's dimensions.

A scale value less than 1.0 indicates that the symbol is scaled down, while a value greater than 1.0 indicates that the symbol is scaled up. For example, a scale of 0.5 will reduce the symbol's dimensions to half its original size. A scale of 2.0 will double the symbol's dimensions.

The minimum scale is 0.1 and the maximum scale is 4.0.

Type: number(float)
Required: false
Restrictions: none
Default value: 1
Minimum: 0.1
Maximum: 4

SymbolStyle

Example
Use dark colors for code blocksCopy
"pin"

The style of the marker symbol can be pin or circle.

Type: string
Required: false
Restrictions: none
Default value: none

Enumerated values

anonymous

Click to copy

circle

Click to copy

none

Click to copy

Wkid

Example
Use dark colors for code blocksCopy
4326

The WKID (Well-Known ID) is a unique integer identifier used to define a specific spatial reference.

The wkid value of 4326, for WGS84, is currently the only supported WKID.

Type: integer
Required: false
Restrictions: none
Default value: 4326

Enumerated values

anonymous

4326

Click to copy

ZoomLevel

Example
Use dark colors for code blocksCopy
12

Type: integer
Required: false
Restrictions: none
Minimum: 0
Maximum: 22

Attribution

Properties

CoordGeometry

CustomMarkerSymbol

Properties

CustomSymbols

Error

Properties

error properties

Enumerated values

code

FillStyle

Enumerated values

anonymous

GraphicManyPoints

Properties

GraphicPoint

Properties

GraphicPolygon

Properties

GraphicPolyline

Properties

HexColor

Image

Properties

ImageDimension

ImageFormat

Enumerated values

anonymous

LineStyle

Enumerated values

anonymous

LineSymbol

Properties

LineWidth

ManyPointsGet

Properties

Map

Properties

Padding

PathGeometry

PathGeometryGet

Paths

PointAndSymbol

Properties

PointGeometry

Properties

Polygon

Properties

PolygonSymbol

Properties

Polyline

Properties

PolylineStyle

Properties

RadiusDistance

Ring

Rings

RingStyle

Properties

SimpleMarkerSymbol

Properties

SpatialReference

Properties

SymbolLabel

SymbolOffsetX

SymbolOffsetY

SymbolScale

SymbolStyle

Enumerated values

anonymous

Wkid

Enumerated values

anonymous

ZoomLevel

`error` properties