Skip to content

/AWS1/IF_GEM=>GETSTATICMAP()

About GetStaticMap

GetStaticMap provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots.

For more information, see the following topics in the Amazon Location Service Developer Guide:

Method Signature

METHODS /AWS1/IF_GEM~GETSTATICMAP
  IMPORTING
    !IV_BOUNDINGBOX TYPE /AWS1/GEMPOSITIONLISTSTRING OPTIONAL
    !IV_BOUNDEDPOSITIONS TYPE /AWS1/GEMPOSITIONLISTSTRING OPTIONAL
    !IV_CENTER TYPE /AWS1/GEMPOSITIONSTRING OPTIONAL
    !IV_COLORSCHEME TYPE /AWS1/GEMCOLORSCHEME OPTIONAL
    !IV_COMPACTOVERLAY TYPE /AWS1/GEMCOMPACTOVERLAY OPTIONAL
    !IV_CROPLABELS TYPE /AWS1/GEMBOOLEAN OPTIONAL
    !IV_GEOJSONOVERLAY TYPE /AWS1/GEMGEOJSONOVERLAY OPTIONAL
    !IV_HEIGHT TYPE /AWS1/GEMSENSITIVEINTEGER OPTIONAL
    !IV_KEY TYPE /AWS1/GEMAPIKEY OPTIONAL
    !IV_LABELSIZE TYPE /AWS1/GEMLABELSIZE OPTIONAL
    !IV_LANGUAGE TYPE /AWS1/GEMLANGUAGETAG OPTIONAL
    !IV_PADDING TYPE /AWS1/GEMSENSITIVEINTEGER OPTIONAL
    !IV_POLITICALVIEW TYPE /AWS1/GEMCOUNTRYCODE OPTIONAL
    !IV_POINTSOFINTERESTS TYPE /AWS1/GEMMAPFEATUREMODE OPTIONAL
    !IV_RADIUS TYPE /AWS1/GEMDISTANCEMETERS OPTIONAL
    !IV_FILENAME TYPE /AWS1/GEMSTRING OPTIONAL
    !IV_SCALEBARUNIT TYPE /AWS1/GEMSCALEBARUNIT OPTIONAL
    !IV_STYLE TYPE /AWS1/GEMSTATICMAPSTYLE OPTIONAL
    !IV_WIDTH TYPE /AWS1/GEMSENSITIVEINTEGER OPTIONAL
    !IV_ZOOM TYPE /AWS1/RT_FLOAT_AS_STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gemgetstaticmaprsp
  RAISING
    /AWS1/CX_GEMACCESSDENIEDEX
    /AWS1/CX_GEMINTERNALSERVEREX
    /AWS1/CX_GEMTHROTTLINGEX
    /AWS1/CX_GEMVALIDATIONEX
    /AWS1/CX_GEMCLIENTEXC
    /AWS1/CX_GEMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_height TYPE /AWS1/GEMSENSITIVEINTEGER /AWS1/GEMSENSITIVEINTEGER

Specifies the height of the map image.

iv_filename TYPE /AWS1/GEMSTRING /AWS1/GEMSTRING

The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$.

Example: map, map@2x

iv_width TYPE /AWS1/GEMSENSITIVEINTEGER /AWS1/GEMSENSITIVEINTEGER

Specifies the width of the map image.

Optional arguments:

iv_boundingbox TYPE /AWS1/GEMPOSITIONLISTSTRING /AWS1/GEMPOSITIONLISTSTRING

Takes in two pairs of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image.

Example: -123.17075,49.26959,-123.08125,49.31429

iv_boundedpositions TYPE /AWS1/GEMPOSITIONLISTSTRING /AWS1/GEMPOSITIONLISTSTRING

Takes in two or more pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates.

Cannot be used with Zoom and or Radius

Example: 97.170451,78.039098,99.045536,27.176178

iv_center TYPE /AWS1/GEMPOSITIONSTRING /AWS1/GEMPOSITIONSTRING

Takes in a pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], which becomes the center point of the image. This parameter requires that either zoom or radius is set.

Cannot be used with Zoom and or Radius

Example: 49.295,-123.108

iv_colorscheme TYPE /AWS1/GEMCOLORSCHEME /AWS1/GEMCOLORSCHEME

Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

iv_compactoverlay TYPE /AWS1/GEMCOMPACTOVERLAY /AWS1/GEMCOMPACTOVERLAY

Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: [Lon, Lat]

Example: line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B

Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

iv_croplabels TYPE /AWS1/GEMBOOLEAN /AWS1/GEMBOOLEAN

It is a flag that takes in true or false. It prevents the labels that are on the edge of the image from being cut or obscured.

iv_geojsonoverlay TYPE /AWS1/GEMGEOJSONOVERLAY /AWS1/GEMGEOJSONOVERLAY

Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object.

Example: {"type":"FeatureCollection","features": [{"type":"Feature","geometry":{"type":"MultiPoint","coordinates": [[-90.076345,51.504107],[-0.074451,51.506892]]},"properties": {"color":"#00DD00"}}]}

iv_key TYPE /AWS1/GEMAPIKEY /AWS1/GEMAPIKEY

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

iv_labelsize TYPE /AWS1/GEMLABELSIZE /AWS1/GEMLABELSIZE

Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.

iv_language TYPE /AWS1/GEMLANGUAGETAG /AWS1/GEMLANGUAGETAG

Specifies the language on the map labels using the BCP 47 language tag, limited to ISO 639-1 two-letter language codes. If the specified language data isn't available for the map image, the labels will default to the regional primary language.

Supported codes:

  • ar

  • as

  • az

  • be

  • bg

  • bn

  • bs

  • ca

  • cs

  • cy

  • da

  • de

  • el

  • en

  • es

  • et

  • eu

  • fi

  • fo

  • fr

  • ga

  • gl

  • gn

  • gu

  • he

  • hi

  • hr

  • hu

  • hy

  • id

  • is

  • it

  • ja

  • ka

  • kk

  • km

  • kn

  • ko

  • ky

  • lt

  • lv

  • mk

  • ml

  • mr

  • ms

  • mt

  • my

  • nl

  • no

  • or

  • pa

  • pl

  • pt

  • ro

  • ru

  • sk

  • sl

  • sq

  • sr

  • sv

  • ta

  • te

  • th

  • tr

  • uk

  • uz

  • vi

  • zh

iv_padding TYPE /AWS1/GEMSENSITIVEINTEGER /AWS1/GEMSENSITIVEINTEGER

Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.

Value for max and min is determined by:

Min: 1

Max: min(height, width)/4

Example: 100

iv_politicalview TYPE /AWS1/GEMCOUNTRYCODE /AWS1/GEMCOUNTRYCODE

Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format.

The following political views are currently supported:

  • ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

  • EGY: Egypt's view on Bir Tawil

  • IND: India's view on Gilgit-Baltistan

  • KEN: Kenya's view on the Ilemi Triangle

  • MAR: Morocco's view on Western Sahara

  • RUS: Russia's view on Crimea

  • SDN: Sudan's view on the Halaib Triangle

  • SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

  • SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

  • SYR: Syria's view on the Golan Heights

  • TUR: Turkey's view on Cyprus and Northern Cyprus

  • TZA: Tanzania's view on Lake Malawi

  • URY: Uruguay's view on Rincon de Artigas

  • VNM: Vietnam's view on the Paracel Islands and Spratly Islands

iv_pointsofinterests TYPE /AWS1/GEMMAPFEATUREMODE /AWS1/GEMMAPFEATUREMODE

Determines if the result image will display icons representing points of interest on the map.

iv_radius TYPE /AWS1/GEMDISTANCEMETERS /AWS1/GEMDISTANCEMETERS

Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value >= 1.

Example: 1500

Cannot be used with Zoom.

Unit: Meters

iv_scalebarunit TYPE /AWS1/GEMSCALEBARUNIT /AWS1/GEMSCALEBARUNIT

Displays a scale on the bottom right of the map image with the unit specified in the input.

Example: KilometersMiles, Miles, Kilometers, MilesKilometers

iv_style TYPE /AWS1/GEMSTATICMAPSTYLE /AWS1/GEMSTATICMAPSTYLE

Style specifies the desired map style.

iv_zoom TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING

Specifies the zoom level of the map image.

Cannot be used with Radius.

RETURNING

oo_output TYPE REF TO /aws1/cl_gemgetstaticmaprsp /AWS1/CL_GEMGETSTATICMAPRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getstaticmap(
  iv_boundedpositions = |string|
  iv_boundingbox = |string|
  iv_center = |string|
  iv_colorscheme = |string|
  iv_compactoverlay = |string|
  iv_croplabels = ABAP_TRUE
  iv_filename = |string|
  iv_geojsonoverlay = |string|
  iv_height = 123
  iv_key = |string|
  iv_labelsize = |string|
  iv_language = |string|
  iv_padding = 123
  iv_pointsofinterests = |string|
  iv_politicalview = |string|
  iv_radius = 123
  iv_scalebarunit = |string|
  iv_style = |string|
  iv_width = 123
  iv_zoom = |0.1|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_blob = lo_result->get_blob( ).
  lv_string = lo_result->get_contenttype( ).
  lv_string = lo_result->get_cachecontrol( ).
  lv_string = lo_result->get_etag( ).
  lv_string = lo_result->get_pricingbucket( ).
ENDIF.