Package com.azure.maps.render.models
Class MapTileset
java.lang.Object
com.azure.maps.render.models.MapTileset
Metadata for a tileset in the TileJSON format.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the attribution property: Copyright attribution to be displayed on the map.com.azure.core.models.GeoBoundingBox
Bounds must define an area covered by all zoom levels.com.azure.core.models.GeoPosition
Get the center property: The default location of the tileset in the form [longitutde, latitude, zoom].getData()
Get the data property: An array of data files in GeoJSON format.Get the description property: Text description of the tileset.getGrids()
Get the grids property: An array of interactivity endpoints.Get the legend property: A legend to be displayed with the map.Get the maxZoom property: The maximum zoom level.Get the minZoom property: The minimum zoom level.getName()
Get the name property: A name describing the tileset.Get the scheme property: Default: "xyz".Get the template property: A mustache template to be used to format data from grids for interaction.Get the tilejson property: Describes the version of the TileJSON spec that is implemented by this JSON object.getTiles()
Get the tiles property: An array of tile endpoints.Get the version property: A semver.org style version number for the tiles contained within the tileset.setAttribution
(String attribution) Set the attribution property: Copyright attribution to be displayed on the map.Set the data property: An array of data files in GeoJSON format.setDescription
(String description) Set the description property: Text description of the tileset.Set the grids property: An array of interactivity endpoints.Set the legend property: A legend to be displayed with the map.setMaxZoom
(Integer maxZoom) Set the maxZoom property: The maximum zoom level.setMinZoom
(Integer minZoom) Set the minZoom property: The minimum zoom level.Set the name property: A name describing the tileset.Set the scheme property: Default: "xyz".setTemplate
(String template) Set the template property: A mustache template to be used to format data from grids for interaction.setTileJson
(String tilejson) Set the tilejson property: Describes the version of the TileJSON spec that is implemented by this JSON object.Set the tiles property: An array of tile endpoints.setVersion
(String version) Set the version property: A semver.org style version number for the tiles contained within the tileset.
-
Constructor Details
-
MapTileset
public MapTileset()
-
-
Method Details
-
getName
Get the name property: A name describing the tileset. The name can contain any legal character. Implementations SHOULD NOT interpret the name as HTML.- Returns:
- the name value.
-
setName
Set the name property: A name describing the tileset. The name can contain any legal character. Implementations SHOULD NOT interpret the name as HTML.- Parameters:
name
- the name value to set.- Returns:
- the MapTileset object itself.
-
getDescription
Get the description property: Text description of the tileset. The description can contain any legal character. Implementations SHOULD NOT interpret the description as HTML.- Returns:
- the description value.
-
setDescription
Set the description property: Text description of the tileset. The description can contain any legal character. Implementations SHOULD NOT interpret the description as HTML.- Parameters:
description
- the description value to set.- Returns:
- the MapTileset object itself.
-
getVersion
Get the version property: A semver.org style version number for the tiles contained within the tileset. When changes across tiles are introduced, the minor version MUST change.- Returns:
- the version value.
-
setVersion
Set the version property: A semver.org style version number for the tiles contained within the tileset. When changes across tiles are introduced, the minor version MUST change.- Parameters:
version
- the version value to set.- Returns:
- the MapTileset object itself.
-
getAttribution
Get the attribution property: 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.- Returns:
- the attribution value.
-
setAttribution
Set the attribution property: 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.- Parameters:
attribution
- the attribution value to set.- Returns:
- the MapTileset object itself.
-
getTemplate
Get the template property: A mustache template to be used to format data from grids for interaction.- Returns:
- the template value.
-
setTemplate
Set the template property: A mustache template to be used to format data from grids for interaction.- Parameters:
template
- the template value to set.- Returns:
- the MapTileset object itself.
-
getLegend
Get the legend property: 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.- Returns:
- the legend value.
-
setLegend
Set the legend property: 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.- Parameters:
legend
- the legend value to set.- Returns:
- the MapTileset object itself.
-
getScheme
Get the scheme property: Default: "xyz". Either "xyz" or "tms". Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed.- Returns:
- the scheme value.
-
setScheme
Set the scheme property: Default: "xyz". Either "xyz" or "tms". Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed.- Parameters:
scheme
- the scheme value to set.- Returns:
- the MapTileset object itself.
-
getTiles
Get the tiles property: 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.- Returns:
- the tiles value.
-
setTiles
Set the tiles property: 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.- Parameters:
tiles
- the tiles value to set.- Returns:
- the MapTileset object itself.
-
getGrids
Get the grids property: An array of interactivity endpoints.- Returns:
- the grids value.
-
setGrids
Set the grids property: An array of interactivity endpoints.- Parameters:
grids
- the grids value to set.- Returns:
- the MapTileset object itself.
-
getData
Get the data property: An array of data files in GeoJSON format.- Returns:
- the data value.
-
setData
Set the data property: An array of data files in GeoJSON format.- Parameters:
data
- the data value to set.- Returns:
- the MapTileset object itself.
-
getMinZoom
Get the minZoom property: The minimum zoom level.- Returns:
- the minZoom value.
-
setMinZoom
Set the minZoom property: The minimum zoom level.- Parameters:
minZoom
- the minZoom value to set.- Returns:
- the MapTileset object itself.
-
getMaxZoom
Get the maxZoom property: The maximum zoom level.- Returns:
- the maxZoom value.
-
setMaxZoom
Set the maxZoom property: The maximum zoom level.- Parameters:
maxZoom
- the maxZoom value to set.- Returns:
- the MapTileset object itself.
-
getBounds
public com.azure.core.models.GeoBoundingBox getBounds()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.- Returns:
- a
GeoBoundingBox
representing the bounding box.
-
getCenter
public com.azure.core.models.GeoPosition getCenter()Get the center property: The default location of the tileset in the form [longitutde, latitude, zoom]. The zoom level must be between minzoom and maxzoom. Implementation can use this value to set the default location.- Returns:
- a
GeoPosition
representing the center.
-
getTileJson
Get the tilejson property: Describes the version of the TileJSON spec that is implemented by this JSON object.- Returns:
- the tilejson value.
-
setTileJson
Set the tilejson property: Describes the version of the TileJSON spec that is implemented by this JSON object.- Parameters:
tilejson
- TileJson version- Returns:
- the MapTileset object itself.
-