Skip to content

Get Map Sprites

locationservice_get_map_sprites R Documentation

Retrieves the sprite sheet corresponding to a map resource

Description

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"
)