Skip to content

/AWS1/IF_LOC=>GETMAPSPRITES()

About GetMapSprites

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

  • GetMapSprites 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 GetSprites 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 the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.

Method Signature

METHODS /AWS1/IF_LOC~GETMAPSPRITES
  IMPORTING
    !IV_MAPNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
    !IV_FILENAME TYPE /AWS1/LOCSTRING OPTIONAL
    !IV_KEY TYPE /AWS1/LOCAPIKEY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_locgetmapspritesrsp
  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 sprite file.

iv_filename TYPE /AWS1/LOCSTRING /AWS1/LOCSTRING

The name of the sprite file. Use the following file names for the sprite sheet:

  • sprites.png

  • sprites@2x.png for high pixel density displays

For the JSON document containing image offsets. Use the following file names:

  • sprites.json

  • sprites@2x.json for high pixel density displays

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_locgetmapspritesrsp /AWS1/CL_LOCGETMAPSPRITESRSP

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->getmapsprites(
  iv_filename = |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.