TileLayerOptions interface
Options used when rendering raster tiled images in a TileLayer.
- Extends
Properties
| bounds | A bounding box that specifies where tiles are available.
When specified, no tiles outside of the bounding box will be requested.
Default |
| contrast | A number between -1 and 1 that increases or decreases the contrast of the overlay.
Default |
| fade |
The duration in milliseconds of a fade transition when a new tile is added.
Must be greater or equal to 0.
Default |
| filter | An expression specifying conditions on source features. Only features that match the filter are displayed. |
| hue |
Rotates hues around the color wheel.
A number in degrees.
Default |
| isTMS | Specifies if the tile systems coordinates uses the Tile Map Services specification,
which reverses the Y coordinate axis.
Default |
| max |
A number between 0 and 1 that increases or decreases the maximum brightness of the overlay.
Default |
| max |
An integer specifying the maximum zoom level in which tiles are available from the tile source.
Default |
| max |
An integer specifying the maximum zoom level to render the layer at.
This value is exclusive, i.e. the layer will be visible at |
| min |
A number between 0 and 1 that increases or decreases the minimum brightness of the overlay.
Default |
| min |
An integer specifying the minimum zoom level in which tiles are available from the tile source.
Default |
| min |
An integer specifying the minimum zoom level to render the layer at.
This value is inclusive, i.e. the layer will be visible at |
| opacity | A number between 0 and 1 that indicates the opacity at which the overlay will be drawn.
Default |
| saturation | A number between -1 and 1 that increases or decreases the saturation of the overlay.
Default |
| subdomains | An array of subdomain values to apply to the tile URL. |
| tile |
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 |
| tile |
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. |
| visible | Specifies if the layer is visible or not.
Default |
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?: BoundingBoxProperty Value
contrast
A number between -1 and 1 that increases or decreases the contrast of the overlay.
Default 0.
contrast?: numberProperty Value
number
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?: numberProperty Value
number
filter
An expression specifying conditions on source features. Only features that match the filter are displayed.
filter?: ExpressionProperty Value
hueRotation
Rotates hues around the color wheel.
A number in degrees.
Default 0.
hueRotation?: numberProperty Value
number
isTMS
Specifies if the tile systems coordinates uses the Tile Map Services specification,
which reverses the Y coordinate axis.
Default false.
isTMS?: booleanProperty Value
boolean
maxBrightness
A number between 0 and 1 that increases or decreases the maximum brightness of the overlay.
Default 1.
maxBrightness?: numberProperty Value
number
maxSourceZoom
An integer specifying the maximum zoom level in which tiles are available from the tile source.
Default 22.
maxSourceZoom?: numberProperty Value
number
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?: numberProperty Value
number
minBrightness
A number between 0 and 1 that increases or decreases the minimum brightness of the overlay.
Default 0.
minBrightness?: numberProperty Value
number
minSourceZoom
An integer specifying the minimum zoom level in which tiles are available from the tile source.
Default 0.
minSourceZoom?: numberProperty Value
number
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?: numberProperty Value
number
opacity
A number between 0 and 1 that indicates the opacity at which the overlay will be drawn.
Default 1.
opacity?: numberProperty Value
number
saturation
A number between -1 and 1 that increases or decreases the saturation of the overlay.
Default 0.
saturation?: numberProperty 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?: numberProperty 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?: stringProperty Value
string
visible
Specifies if the layer is visible or not.
Default true.
visible?: booleanProperty Value
boolean