/generate-map/arcgis/navigation/centered-at

lon

The longitude of the specified point within the WGS84 coordinate system. The longitude can be in the range of -179.99 to 179.99, representing the East/West or X-Axis.

Minimum

-179.99

Maximum

179.99

lat

The latitude of the specified point within the WGS84 coordinate system. The latitude can be in the range of -85.05 to 85.05, representing the North/South or Y-Axis.

Minimum

-85.05

Maximum

85.05

zoomLevel

The level of detail or zoom level for a map.

Supplying a level of 5 returns the smallest scale of the static map (the Country scale) and a level of 23 returns the largest scale (the House scale).

The table below shows the scale of each level:

For more information on levels of detail see the Zoom levels and scale topic.

Default

15

Enumerated values

markerSymbol

The map marker symbol that will be placed on the static map. This value can be a simple map marker symbol (see SimpleMarkerSymbol) (pin, X, cross, square, circle, triangle) or the data URL encoding of a base64 encoded SVG symbol.

You can create your own SVG symbol or obtain an SVG point symbol from a Github repository such as the Calcite point symbols. To see the full range of SVG point symbols in this repository see Calcite Design System.

Once you have an SVG file, read the file and obtain the its XML string. Next, convert the SVG XML string into a URL safe string as follows:

1. Convert the SVG XML string into a base64-encoded string.
2. Append the base64-encoded string to the data url prefix data:/svg+xml;base64,.
3. URL encode the prefixed string.
4. Set the markerSymbol parameter to the url safe string.

As a Javascript example:

    function encodeSVG(svgXMLString) {
        const base64EncodedString = btoa(svgXMLString);
        const dataURLAppended = "data:/svg+xml;base64," + base64Encoded;
        const urlSafeString = encodeURIComponent(dataURLAppended);
        return urlSafeString;
    }

Enumerated values

mapImageFormat

Returns the image in the specified format.

Default

webp

Enumerated values

mapImageWidth

The width of the requested map image in pixels at 96 DPI between 64 and 1024 pixels.

Minimum

64

Maximum

1024

Default

200

mapImageHeight

The height of the requested map image in pixels at 96 DPI between 64 and 1024 pixels.

Minimum

64

Maximum

1024

Default

200

markerSymbolScale

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

This value increments by 0.1.

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.

Minimum

0.1

Maximum

2

Default

1

markerSymbolOffsetX

The X offset of the map marker symbol in pixels from the center of the generated map image.

Minimum

-512

Maximum

512

Default

0

markerSymbolOffsetY

The Y offset of the map marker symbol in pixels from the center of the generated map image.

Minimum

-512

Maximum

512

Default

0

token

The authentication token, used to access the static maps service.

The token parameter can be either an API Key or short-lived token.

This parameter is required unless you supply an access token in the request header with one of the following keys using the "Bearer" scheme:

• Authorization: Bearer <YOUR_TOKEN>
• X-Esri-Authorization: Bearer <YOUR_TOKEN>

The provided token must be created from an ArcGIS Location Platform account and have the necessary premium:user:staticMaps privilege to use the static maps service.

Developer guide: To learn more, go to Security and authentication.