com.mapbox.mapboxsdk.style.sources

Class TileSet

java.lang.Object

com.mapbox.mapboxsdk.style.sources.TileSet

public class TileSet
extends java.lang.Object

Tile set, allows using TileJson specification as source. Note that `encoding` is only relevant to `raster-dem` sources, and is not supported in the TileJson spec.

See Also:

The tileset specification

Constructor Summary

Constructors

Constructor and Description
TileSet(java.lang.String tilejson, java.lang.String... tiles)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttribution()
java.lang.Float[]	getBounds()
java.lang.Float[]	getCenter()
java.lang.String[]	getData()
java.lang.String	getDescription()
java.lang.String	getEncoding()
java.lang.String[]	getGrids()
java.lang.String	getLegend()
float	getMaxZoom()
float	getMinZoom()
java.lang.String	getName()
java.lang.String	getScheme()
java.lang.String	getTemplate()
java.lang.String	getTilejson()
java.lang.String[]	getTiles()
java.lang.String	getVersion()
void	setAttribution(java.lang.String attribution) Default: null.
void	setBounds(java.lang.Float... bounds) Default: [-180, -90, 180, 90].
void	setCenter(java.lang.Float... center) The first value is the longitude, the second is latitude (both in WGS:84 values), the third value is the zoom level as an integer.
void	setCenter(LatLng center)
void	setData(java.lang.String... data) An array of data files in GeoJSON format.
void	setDescription(java.lang.String description) A text description of the tileset.
void	setEncoding(java.lang.String encoding) Default: "mapbox".
void	setGrids(java.lang.String... grids) An array of interactivity endpoints.
void	setLegend(java.lang.String legend) Contains a legend to be displayed with the map.
void	setMaxZoom(float maxZoom) 0.
void	setMinZoom(float minZoom) 0.
void	setName(java.lang.String name) A name describing the tileset.
void	setScheme(java.lang.String scheme) Default: "xyz".
void	setTemplate(java.lang.String template) Contains a mustache template to be used to format data from grids for interaction.
void	setVersion(java.lang.String version)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TileSet

public TileSet(java.lang.String tilejson,
               java.lang.String... tiles)

Parameters:

tilejson - A semver.org style version number. Describes the version of the TileJSON spec that is implemented by this JSON object.

tiles - An array of tile endpoints. {z}, {x} and {y}, if present, are replaced with the corresponding integers. 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. Example: "http:localhost:8888/admin/1.0.0/world-light,broadband/{z}/{x}/{y}.png"

Method Detail

getTilejson

public java.lang.String getTilejson()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

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

Parameters:

name - the name to be set

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

A text description of the tileset. The description can contain any legal character. Implementations SHOULD NOT interpret the description as HTML. "description": "A simple, light grey world."

Parameters:

description - the description to set

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getAttribution

public java.lang.String getAttribution()

setAttribution

public void setAttribution(java.lang.String attribution)

Default: null. Contains an attribution to be displayed when the map is shown to a user. 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": "OSM contributors",

Parameters:

attribution - the attribution to set

getTemplate

public java.lang.String getTemplate()

setTemplate

public void setTemplate(java.lang.String template)

Contains a mustache template to be used to format data from grids for interaction. See https:github.com/mapbox/utfgrid-spec/tree/master/1.2 for the interactivity specification. "template": "{{#__teaser__}}{{NAME}}{{/__teaser__}}"

Parameters:

template - the template to set

getLegend

public java.lang.String getLegend()

setLegend

public void setLegend(java.lang.String legend)

Contains 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": "Dangerous zones are red, safe zones are green"

Parameters:

legend - the legend to set

getScheme

public java.lang.String getScheme()

setScheme

public void setScheme(java.lang.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": "xyz"

Parameters:

scheme - the scheme to set

getTiles

public java.lang.String[] getTiles()

getGrids

public java.lang.String[] getGrids()

setGrids

public void setGrids(java.lang.String... grids)

An array of interactivity endpoints. {z}, {x} and {y}, if present, are replaced with the corresponding integers. If multiple endpoints are specified, clients may use any combination of endpoints. All endpoints MUST return the same content for the same URL. If the array doesn't contain any entries, interactivity is not supported for this tileset. See https:github.com/mapbox/utfgrid-spec/tree/master/1.2 for the interactivity specification.

Example: "http:localhost:8888/admin/1.0.0/broadband/{z}/{x}/{y}.grid.json"

Parameters:

grids - the grids to set

getData

public java.lang.String[] getData()

setData

public void setData(java.lang.String... data)

An array of data files in GeoJSON format. {z}, {x} and {y}, if present, are replaced with the corresponding integers. If multiple endpoints are specified, clients may use any combination of endpoints. All endpoints MUST return the same content for the same URL. If the array doesn't contain any entries, then no data is present in the map.

"http:localhost:8888/admin/data.geojson"

Parameters:

data - the data array to set

getMinZoom

public float getMinZoom()

setMinZoom

public void setMinZoom(float minZoom)

0. >= 0, < 22. An integer specifying the minimum zoom level.

Parameters:

minZoom - the minZoom level to set

getMaxZoom

public float getMaxZoom()

setMaxZoom

public void setMaxZoom(float maxZoom)

0. >= 0, <= 22. An integer specifying the maximum zoom level.

Parameters:

maxZoom - the maxZoom level to set

getBounds

public java.lang.Float[] getBounds()

setBounds

public void setBounds(@Size(value=4L)
                      java.lang.Float... bounds)

Default: [-180, -90, 180, 90]. 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.

Parameters:

bounds - the Float array to set

getEncoding

public java.lang.String getEncoding()

setEncoding

public void setEncoding(java.lang.String encoding)

Default: "mapbox". The encoding formula for a raster-dem tileset. Supported values are "mapbox" and "terrarium".

Parameters:

encoding - the String encoding formula to set

getCenter

public java.lang.Float[] getCenter()

setCenter

public void setCenter(@Size(value=2L)
                      java.lang.Float... center)

The first value is the longitude, the second is latitude (both in WGS:84 values), the third value is the zoom level as an integer. Longitude and latitude MUST be within the specified bounds. The zoom level MUST be between minzoom and maxzoom. Implementations can use this value to set the default location. If the value is null, implementations may use their own algorithm for determining a default location.

Parameters:

center - the Float array to set

setCenter

public void setCenter(@NonNull
                      LatLng center)