Get Map Sprites

locationservice_get_map_sprites

R Documentation

This operation is no longer current and may be deprecated in the future

Description

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

• get_map_sprites 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.

Usage

locationservice_get_map_sprites(MapName, FileName, Key)

Arguments

MapName	[required] The map resource associated with the sprite file.
FileName	[required] 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
Key	The optional API key to authorize the request.

Value

A list with the following syntax:

list(
  Blob = raw,
  ContentType = "string",
  CacheControl = "string"
)

Request syntax

svc$get_map_sprites(
  MapName = "string",
  FileName = "string",
  Key = "string"
)