GETMAPGLYPHS()`¶

About GetMapGlyphs¶

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetGlyphs unless you require Grab data.

GetMapGlyphs is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).
The version 2 GetGlyphs operation gives a better user experience and is compatible with the remainder of the V2 Maps API.
If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location.
Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.

Retrieves glyphs used to display labels on a map.

Method Signature¶

METHODS /AWS1/IF_LOC~GETMAPGLYPHS
  IMPORTING
    !IV_MAPNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
    !IV_FONTSTACK TYPE /AWS1/LOCSTRING OPTIONAL
    !IV_FONTUNICODERANGE TYPE /AWS1/LOCSTRING OPTIONAL
    !IV_KEY TYPE /AWS1/LOCAPIKEY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_locgetmapglyphsrsp
  RAISING
    /AWS1/CX_LOCACCESSDENIEDEX
    /AWS1/CX_LOCINTERNALSERVEREX
    /AWS1/CX_LOCRESOURCENOTFOUNDEX
    /AWS1/CX_LOCTHROTTLINGEX
    /AWS1/CX_LOCVALIDATIONEX
    /AWS1/CX_LOCCLIENTEXC
    /AWS1/CX_LOCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_mapname` `TYPE /AWS1/LOCRESOURCENAME` `/AWS1/LOCRESOURCENAME`¶

The map resource associated with the glyph ﬁle.

`iv_fontstack` `TYPE /AWS1/LOCSTRING` `/AWS1/LOCSTRING`¶

A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.

Valid font stacks for Esri styles:

VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold

VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold

VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic

VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold

VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold

Valid font stacks for HERE Technologies styles:

VectorHereContrast – Fira GO Regular | Fira GO Bold

VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular

Valid font stacks for GrabMaps styles:

VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular | Noto Sans Medium | Noto Sans Bold

Valid font stacks for Open Data styles:

VectorOpenDataStandardLight, VectorOpenDataStandardDark, VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold | Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold | Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold | Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular | Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular | Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium

The fonts used by the Open Data map styles are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.

`iv_fontunicoderange` `TYPE /AWS1/LOCSTRING` `/AWS1/LOCSTRING`¶

A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples of 256.

Optional arguments:¶

`iv_key` `TYPE /AWS1/LOCAPIKEY` `/AWS1/LOCAPIKEY`¶

The optional API key to authorize the request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_locgetmapglyphsrsp` `/AWS1/CL_LOCGETMAPGLYPHSRSP`¶

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->getmapglyphs(
  iv_fontstack = |string|
  iv_fontunicoderange = |string|
  iv_key = |string|
  iv_mapname = |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( ).
ENDIF.

/AWS1/IF_LOC=>GETMAPGLYPHS()¶