mapbox-maps-android/com.mapbox.maps.extension.style.sources/TileSet/RasterDemBuilder

RasterDemBuilder

Builder of TileSet for RasterDemSource.

class RasterDemBuilder(tilejson: String, tiles: List<String>) : TileSet.Builder

Constructors

RasterDemBuilder

fun RasterDemBuilder(tilejson: String, tiles: List<String>)

Functions

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

override fun attribution(value: String): TileSet.Builder

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.

override fun bounds(value: List<Double>): TileSet.Builder

build

Build the TileSet.

override fun build(): TileSet

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.

override fun center(value: List<Double>): TileSet.Builder

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"

override fun data(value: List<String>): TileSet.Builder

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

override fun description(value: String): TileSet.Builder

encoding

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

fun encoding(value: Encoding): TileSet.RasterDemBuilder

equals

open operator override fun equals(other: Any?): Boolean

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"

override fun grids(value: List<String>): TileSet.Builder

hashCode

open override fun hashCode(): Int

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"

override fun legend(value: String): TileSet.Builder

maxZoom

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

override fun maxZoom(value: Int): TileSet.Builder

minZoom

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

override fun minZoom(value: Int): TileSet.Builder

name

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

override fun name(value: String): TileSet.Builder

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"

override fun scheme(value: Scheme): TileSet.Builder

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

override fun template(value: String): TileSet.Builder

toString

open override fun toString(): String

version

Default: "1.0.0". A semver.org style version number. When changes across tiles are introduced, the minor version MUST change. This may lead to cut off labels. Therefore, implementors can decide to clean their cache when the minor version changes. Changes to the patch level MUST only have changes to tiles that are contained within one tile. When tiles change significantly, the major version MUST be increased. Implementations MUST NOT use tiles with different major versions.

override fun version(value: String): TileSet.Builder

Properties

tilejson

override val tilejson: String

tiles

override val tiles: List<String>