Skip to content

/AWS1/IF_GEM=>GETSTYLEDESCRIPTOR()

About GetStyleDescriptor

GetStyleDescriptor returns information about the style.

For more information, see Style dynamic maps in the Amazon Location Service Developer Guide.

Method Signature

METHODS /AWS1/IF_GEM~GETSTYLEDESCRIPTOR
  IMPORTING
    !IV_STYLE TYPE /AWS1/GEMMAPSTYLE OPTIONAL
    !IV_COLORSCHEME TYPE /AWS1/GEMCOLORSCHEME OPTIONAL
    !IV_POLITICALVIEW TYPE /AWS1/GEMCOUNTRYCODE OPTIONAL
    !IV_TERRAIN TYPE /AWS1/GEMTERRAIN OPTIONAL
    !IV_CONTOURDENSITY TYPE /AWS1/GEMCONTOURDENSITY OPTIONAL
    !IV_TRAFFIC TYPE /AWS1/GEMTRAFFIC OPTIONAL
    !IT_TRAVELMODES TYPE /AWS1/CL_GEMTRAVELMODELIST_W=>TT_TRAVELMODELIST OPTIONAL
    !IV_BUILDINGS TYPE /AWS1/GEMBUILDINGS OPTIONAL
    !IV_POIDENSITY TYPE /AWS1/GEMPOIDENSITY OPTIONAL
    !IT_POICATEGORIES TYPE /AWS1/CL_GEMPOICATEGORYLIST_W=>TT_POICATEGORYLIST OPTIONAL
    !IV_KEY TYPE /AWS1/GEMAPIKEY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gemgetstyledescript01
  RAISING
    /AWS1/CX_GEMCLIENTEXC
    /AWS1/CX_GEMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_style TYPE /AWS1/GEMMAPSTYLE /AWS1/GEMMAPSTYLE

Style specifies the desired map style. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the Standard and Monochrome values.

Optional arguments:

iv_colorscheme TYPE /AWS1/GEMCOLORSCHEME /AWS1/GEMCOLORSCHEME

Sets the color tone for the map, such as dark and light.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

iv_politicalview TYPE /AWS1/GEMCOUNTRYCODE /AWS1/GEMCOUNTRYCODE

Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

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_terrain TYPE /AWS1/GEMTERRAIN /AWS1/GEMTERRAIN

Adjusts how physical terrain details are rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

The following terrain styles are currently supported:

  • Hillshade: Displays the physical terrain details through shading and highlighting of elevation change and geographic features.

  • Terrain3D: Displays physical terrain details and elevations as a three-dimensional model.

Hillshade is valid only for the Standard and Monochrome map styles.

iv_contourdensity TYPE /AWS1/GEMCONTOURDENSITY /AWS1/GEMCONTOURDENSITY

Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

This parameter is valid for all map styles except Satellite.

iv_traffic TYPE /AWS1/GEMTRAFFIC /AWS1/GEMTRAFFIC

Displays real-time traffic information overlay on map, such as incident events and flow events. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

This parameter is valid for all map styles except Satellite.

it_travelmodes TYPE /AWS1/CL_GEMTRAVELMODELIST_W=>TT_TRAVELMODELIST TT_TRAVELMODELIST

Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

This parameter is valid for all map styles except Satellite.

iv_buildings TYPE /AWS1/GEMBUILDINGS /AWS1/GEMBUILDINGS

Adjusts how building details are rendered on the map.

The following building styles are currently supported:

  • Buildings3D: Displays buildings as three-dimensional extrusions on the map.

Buildings3D is valid only for the Standard and Monochrome map styles.

iv_poidensity TYPE /AWS1/GEMPOIDENSITY /AWS1/GEMPOIDENSITY

Controls how densely points of interest are rendered on the map. The density value controls the zoom level at which each category of points of interest appears, and how quickly less prominent points of interest are revealed as you zoom in. Denser values display more points of interest at lower zoom levels.

Use Off to hide all points of interest. When you omit this parameter, the map renders at Default density.

The difference between density values is most noticeable at mid-range zoom levels. At high zoom levels, all density values converge on displaying every available point of interest.

This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

it_poicategories TYPE /AWS1/CL_GEMPOICATEGORYLIST_W=>TT_POICATEGORYLIST TT_POICATEGORYLIST

Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories.

The following categories are currently supported:

  • FoodAndDrink

  • Entertainment

  • SightsAndMuseums

  • Transportation

  • Accommodations

  • LeisureAndOutdoor

  • Shopping

  • BusinessAndServices

  • FacilitiesAndBuildings

Specify each category as a separate poi-categories query parameter. Duplicate values are rejected.

This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category.

This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_gemgetstyledescript01 /AWS1/CL_GEMGETSTYLEDESCRIPT01

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->getstyledescriptor(
  it_poicategories = VALUE /aws1/cl_gempoicategorylist_w=>tt_poicategorylist(
    ( new /aws1/cl_gempoicategorylist_w( |string| ) )
  )
  it_travelmodes = VALUE /aws1/cl_gemtravelmodelist_w=>tt_travelmodelist(
    ( new /aws1/cl_gemtravelmodelist_w( |string| ) )
  )
  iv_buildings = |string|
  iv_colorscheme = |string|
  iv_contourdensity = |string|
  iv_key = |string|
  iv_poidensity = |string|
  iv_politicalview = |string|
  iv_style = |string|
  iv_terrain = |string|
  iv_traffic = |string|
).

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( ).
ENDIF.