TileLayerOptions interface

Package:

azure-maps-control

Options used when rendering raster tiled images in a TileLayer.

Extends

MediaLayerOptions

Properties

bounds	A bounding box that specifies where tiles are available. When specified, no tiles outside of the bounding box will be requested. Default [-180, -85.0511, 180, 85.0511].
isTMS	Specifies if the tile systems coordinates uses the Tile Map Services specification, which reverses the Y coordinate axis. Default false.
maxSourceZoom	An integer specifying the maximum zoom level in which tiles are available from the tile source. Default 22.
minSourceZoom	An integer specifying the minimum zoom level in which tiles are available from the tile source. Default 0.
subdomains	An array of subdomain values to apply to the tile URL.
tileSize	An integer value that specifies the width and height dimensions of the map tiles. For a seamless experience, the tile size must be a multiplier of 2. Default 512.
tileUrl	A http/https URL to a TileJSON resource or a tile URL template that uses the following parameters: {x}: X position of the tile. Usually also needs {y} and {z}. {y}: Y position of the tile. Usually also needs {x} and {z}. {z}: Zoom level of the tile. Usually also needs {x} and {y}. {quadkey}: Tile quadKey id based on the Bing Maps tile system naming convention. {bbox-epsg-3857}: A bounding box string with the format {west},{south},{east},{north} in the EPSG 4325 Spacial Reference System. {subdomain}: A placeholder where the subdomain values if specified will be added.

Inherited Properties

contrast	A number between -1 and 1 that increases or decreases the contrast of the overlay. Default 0.
fadeDuration	The duration in milliseconds of a fade transition when a new tile is added. Must be greater or equal to 0. Default 300.
filter	An expression specifying conditions on source features. Only features that match the filter are displayed.
hueRotation	Rotates hues around the color wheel. A number in degrees. Default 0.
maxBrightness	A number between 0 and 1 that increases or decreases the maximum brightness of the overlay. Default 1.
maxZoom	An integer specifying the maximum zoom level to render the layer at. This value is exclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 24.
minBrightness	A number between 0 and 1 that increases or decreases the minimum brightness of the overlay. Default 0.
minZoom	An integer specifying the minimum zoom level to render the layer at. This value is inclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 0.
opacity	A number between 0 and 1 that indicates the opacity at which the overlay will be drawn. Default 1.
saturation	A number between -1 and 1 that increases or decreases the saturation of the overlay. Default 0.
visible	Specifies if the layer is visible or not. Default true.

Property Details

bounds

A bounding box that specifies where tiles are available. When specified, no tiles outside of the bounding box will be requested. Default [-180, -85.0511, 180, 85.0511].

bounds?: BoundingBox

Property Value

BoundingBox

isTMS

Specifies if the tile systems coordinates uses the Tile Map Services specification, which reverses the Y coordinate axis. Default false.

isTMS?: boolean

Property Value

boolean

maxSourceZoom

An integer specifying the maximum zoom level in which tiles are available from the tile source. Default 22.

maxSourceZoom?: number

Property Value

number

minSourceZoom

An integer specifying the minimum zoom level in which tiles are available from the tile source. Default 0.

minSourceZoom?: number

Property Value

number

subdomains

An array of subdomain values to apply to the tile URL.

subdomains?: string[]

Property Value

string[]

tileSize

An integer value that specifies the width and height dimensions of the map tiles. For a seamless experience, the tile size must be a multiplier of 2. Default 512.

tileSize?: number

Property Value

number

tileUrl

A http/https URL to a TileJSON resource or a tile URL template that uses the following parameters:

{x}: X position of the tile. Usually also needs {y} and {z}.

{y}: Y position of the tile. Usually also needs {x} and {z}.

{z}: Zoom level of the tile. Usually also needs {x} and {y}.

{quadkey}: Tile quadKey id based on the Bing Maps tile system naming convention.

{bbox-epsg-3857}: A bounding box string with the format {west},{south},{east},{north} in the EPSG 4325 Spacial Reference System.

{subdomain}: A placeholder where the subdomain values if specified will be added.

tileUrl?: string

Property Value

string

Inherited Property Details

contrast

A number between -1 and 1 that increases or decreases the contrast of the overlay. Default 0.

contrast?: number

Property Value

number

Inherited From MediaLayerOptions.contrast

fadeDuration

The duration in milliseconds of a fade transition when a new tile is added. Must be greater or equal to 0. Default 300.

fadeDuration?: number

Property Value

number

Inherited From MediaLayerOptions.fadeDuration

filter

An expression specifying conditions on source features. Only features that match the filter are displayed.

filter?: Expression

Property Value

Expression

Inherited From LayerOptions.filter

hueRotation

Rotates hues around the color wheel. A number in degrees. Default 0.

hueRotation?: number

Property Value

number

Inherited From MediaLayerOptions.hueRotation

maxBrightness

A number between 0 and 1 that increases or decreases the maximum brightness of the overlay. Default 1.

maxBrightness?: number

Property Value

number

Inherited From MediaLayerOptions.maxBrightness

maxZoom

An integer specifying the maximum zoom level to render the layer at. This value is exclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 24.

maxZoom?: number

Property Value

number

Inherited From LayerOptions.maxZoom

minBrightness

A number between 0 and 1 that increases or decreases the minimum brightness of the overlay. Default 0.

minBrightness?: number

Property Value

number

Inherited From MediaLayerOptions.minBrightness

minZoom

An integer specifying the minimum zoom level to render the layer at. This value is inclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 0.

minZoom?: number

Property Value

number

Inherited From LayerOptions.minZoom

opacity

A number between 0 and 1 that indicates the opacity at which the overlay will be drawn. Default 1.

opacity?: number

Property Value

number

Inherited From MediaLayerOptions.opacity

saturation

A number between -1 and 1 that increases or decreases the saturation of the overlay. Default 0.

saturation?: number

Property Value

number

Inherited From MediaLayerOptions.saturation

visible

Specifies if the layer is visible or not. Default true.

visible?: boolean

Property Value

boolean

Inherited From LayerOptions.visible