sdk-maps-static-image / com.tomtom.online.sdk.staticimage / StaticImage / Builder

Builder

open class Builder : StaticImage.NotRequiredStep, StaticImage.RequiredStep, StaticImage.Build

Builder

Constructors

<init>

Builder(apiKey: String!)

Builds a StaticImage which is a model for a Request static image.

Builder(apiKey: String!, version: Int)

Builds a StaticImage which is a model for the requested static image.

Functions

boundingBox

open fun boundingBox(bb: BoundingBox!): StaticImage.NotRequiredStep

The bounding box of the static map. The usage of boundingBox is mutually exclusive with the usage of center. EPSG:3857 projection is used. (Note that EPSG:3857 is functionally equivalent to EPSG:900913/EPSG:3785) If both center and bounding box are used, the service will return a HTTP 400 Response. One can ask for longitudes on both sides of the 180th meridian. Thus all combinations of minLon and maxLon are valid. Yes.

build

open fun build(): StaticImage

Builds and validates the StaticImage model.

center

open fun center(latLng: LatLng!): StaticImage.NotRequiredStep

The center-point coordinates of the static map image. Usage of #center(LatLng) is mutually exclusive with usage of #boundingBox(BoundingBox). If both are used, the service will return an error.

geopoliticalViewIndian

open fun geopoliticalViewIndian(): StaticImage.NotRequiredStep

The IN Geopolitical view. The Default view is recognised based on the country the Request came from.

geopoliticalViewUnified

open fun geopoliticalViewUnified(): StaticImage.NotRequiredStep

The unified geopolitical view. The default view is recognised based on the country the Request came from.

jpeg

open fun jpeg(): StaticImage.Build

The requested jpeg map image format. The default value is #EXT_PNG.

jpg

open fun jpg(): StaticImage.Build

The requested jpg map image format. The default value is #EXT_PNG.

layer

open fun layer(layer: String!): StaticImage.NotRequiredStep

The map layer requested. If the layer is not set in the Request the default value is used. See #layerBasic(), or #layerHybrid(), or #layerLabels(). The default value is #LAYER_BASIC.

layerBasic

open fun layerBasic(): StaticImage.NotRequiredStep

The Request basic map layer. If this layer is not set in the Request the default value is used. The basic layer contains full map data, i.e., polygons, roads, borders, and labels. The default value is #LAYER_BASIC.

layerHybrid

open fun layerHybrid(): StaticImage.NotRequiredStep

The Request hybrid map layer. If this layer is not set in the Request the default value is used. The hybrid layer contains borders, roads, and labels (all the map features, except geographic polygons). It can be overlaid on another map layer (such as satellite imagery) in order to produce a hybrid map. The default value is #LAYER_BASIC. See #layerBasic().

layerLabels

open fun layerLabels(): StaticImage.NotRequiredStep

The Request labels map layer. If this layer is not set in the Request the default value is used. The default value is #LAYER_BASIC. See #layerBasic(). The labels layer only provides label information (the same as the basic map layer). It can be used in situations where traffic tubes or other overlaid information cover labels of the base map layer. The labels are precisely placed in order to align with the labels on the basic layer.

mapSize

open fun mapSize(widthPixels: Int, heightPixels: Int): StaticImage.NotRequiredStep

The map size is set on the server side by default.

png

open fun png(): StaticImage.Build

The requested png map image format. The default value is #EXT_PNG.

style

open fun style(style: String!): StaticImage.NotRequiredStep

Styles define the colour scheme. This Method allows the provision of a custom style name.

styleMain

open fun styleMain(): StaticImage.NotRequiredStep

Styles define the colour scheme. This is the main style general full-colour scheme with default TomTom colours. It is the requested style of the map image. When this requested style is not set the default value is used. The default value is #STYLE_MAIN.

styleNight

open fun styleNight(): StaticImage.NotRequiredStep

Styles define the colour scheme. Night style is a modification of the main theme, and is changed to be less invasive than main while using it at night. This is the requested style of the map image. When this requested style is not set the default value is used. The default value is #STYLE_MAIN.

zoom

open fun zoom(zoomLevel: Int): StaticImage.NotRequiredStep

The requested zoom level.