MapTilesetOutput interface

Package:

@azure-rest/maps-render

Metadata for a tileset in the TileJSON format.

Properties

attribution	Copyright attribution to be displayed on the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking.
bounds	The maximum extent of available map tiles. Bounds MUST define an area covered by all zoom levels. The bounds are represented in WGS:84 latitude and longitude values, in the order left, bottom, right, top. Values may be integers or floating point numbers.
center	The default location of the tileset in the form [longitude, latitude, zoom]. The zoom level MUST be between minzoom and maxzoom. Implementations can use this value to set the default location.
data	An array of data files in GeoJSON format.
description	Text description of the tileset. The description can contain any legal character. Implementations SHOULD NOT interpret the description as HTML.
grids	An array of interactivity endpoints.
legend	A legend to be displayed with the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking.
maxzoom	The maximum zoom level.
minzoom	The minimum zoom level.
name	A name describing the tileset. The name can contain any legal character. Implementations SHOULD NOT interpret the name as HTML.
scheme	Default: "xyz". Either "xyz" or "tms". Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed.
template	A mustache template to be used to format data from grids for interaction.
tilejson	Describes the version of the TileJSON spec that is implemented by this JSON object.
tiles	An array of tile endpoints. If multiple endpoints are specified, clients may use any combination of endpoints. All endpoints MUST return the same content for the same URL. The array MUST contain at least one endpoint.
version	A semver.org style version number for the tiles contained within the tileset. When changes across tiles are introduced, the minor version MUST change.

Property Details

attribution

Copyright attribution to be displayed on the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking.

attribution?: string

Property Value

string

bounds

The maximum extent of available map tiles. Bounds MUST define an area covered by all zoom levels. The bounds are represented in WGS:84 latitude and longitude values, in the order left, bottom, right, top. Values may be integers or floating point numbers.

bounds?: number[]

Property Value

number[]

center

The default location of the tileset in the form [longitude, latitude, zoom]. The zoom level MUST be between minzoom and maxzoom. Implementations can use this value to set the default location.

center?: number[]

Property Value

number[]

data

An array of data files in GeoJSON format.

data?: string[]

Property Value

string[]

description

Text description of the tileset. The description can contain any legal character. Implementations SHOULD NOT interpret the description as HTML.

description?: string

Property Value

string

grids

An array of interactivity endpoints.

grids?: string[]

Property Value

string[]

legend

A legend to be displayed with the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking.

legend?: string

Property Value

string

maxzoom

The maximum zoom level.

maxzoom?: number

Property Value

number

minzoom

The minimum zoom level.

minzoom?: number

Property Value

number

name

A name describing the tileset. The name can contain any legal character. Implementations SHOULD NOT interpret the name as HTML.

name?: string

Property Value

string

scheme

Default: "xyz". Either "xyz" or "tms". Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed.

scheme?: string

Property Value

string

template

A mustache template to be used to format data from grids for interaction.

template?: string

Property Value

string

tilejson

Describes the version of the TileJSON spec that is implemented by this JSON object.

tilejson: string

Property Value

string

tiles

An array of tile endpoints. If multiple endpoints are specified, clients may use any combination of endpoints. All endpoints MUST return the same content for the same URL. The array MUST contain at least one endpoint.

tiles: string[]

Property Value

string[]

version

A semver.org style version number for the tiles contained within the tileset. When changes across tiles are introduced, the minor version MUST change.

version?: string

Property Value

string