OpenLayers

Class: TileLayer

ol/layer/Tile~TileLayer 


import TileLayer from 'ol/layer/Tile';

For layer sources that provide pre-rendered, tiled images in grids that are organized by zoom levels for specific resolutions. Note that any property set in the options is set as a module:ol/Object~BaseObject property on the layer object; for example, setting title: 'My Title' in the options means that title is observable, and has get/set accessors.

new TileLayer(opt_options)

layer/Tile.js, line 42
Name Type Description
options

Tile layer options.

Name Type Default Description
opacity number 1

Opacity (0, 1).
visible boolean true

Visibility.
extent module:ol/extent~Extent

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
zIndex number 0

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position.
minResolution number

The minimum resolution (inclusive) at which this layer will be visible.
maxResolution number

The maximum resolution (exclusive) below which this layer will be visible.
preload number 0

Preload. Load low-resolution tiles up to preload levels. 0 means no preloading.
source module:ol/source/Tile~TileSource

Source for this layer.
map module:ol/PluggableMap~PluggableMap

Sets the layer as overlay on a map. The map will not manage this layer in its layers collection, and the layer will be rendered on top. This is useful for temporary layers. The standard way to add a layer to a map and have it managed by the map is to use module:ol/Map#addLayer.
useInterimTilesOnError boolean true

Use interim tiles on error.

Methods

getPreload(){number}

layer/Tile.js, line 74

Return the level as number to which we will preload tiles up to.

Returns:
The level to preload tiles up to.

getSource(){module:ol/source/Tile~TileSource}

layer/Tile.js, line 116

Return the associated tilesource of the layer.

Returns:
Source.

getUseInterimTilesOnError(){boolean}

layer/Tile.js, line 94

Whether we use interim tiles on error.

Returns:
Use interim tiles on error.

setPreload(preload)

layer/Tile.js, line 84

Set the level as number to which we will preload tiles up to.

Name Type Description
preload number

The level to preload tiles up to.

setUseInterimTilesOnError(useInterimTilesOnError)

layer/Tile.js, line 104

Set whether we use interim tiles on error.

Name Type Description
useInterimTilesOnError boolean

Use interim tiles on error.