Module: ol/layer/WebGLTile




Type Definitions


Name Type Description
style Style | undefined

Style to apply to the layer.

className string
(defaults to 'ol-layer')

A CSS class name to set to the layer element.

opacity number
(defaults to 1)

Opacity (0, 1).

visible boolean
(defaults to true)


extent Extent | undefined

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

zIndex number | undefined

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. When undefined, a zIndex of 0 is assumed for layers that are added to the map's layers collection, or Infinity when the layer's setMap() method was used.

minResolution number | undefined

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

maxResolution number | undefined

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

minZoom number | undefined

The minimum view zoom level (exclusive) above which this layer will be visible.

maxZoom number | undefined

The maximum view zoom level (inclusive) at which this layer will be visible.

preload number
(defaults to 0)

Preload. Load low-resolution tiles up to preload levels. 0 means no preloading.

source SourceType | undefined

Source for this layer.

sources Array.<SourceType> | function | undefined

Array of sources for this layer. Takes precedence over source. Can either be an array of sources, or a function that expects an extent and a resolution (in view projection units per pixel) and returns an array of sources. See sourcesFromTileGrid for a helper function to generate sources that are organized in a pyramid following the same pattern as a tile grid. Note: All sources must have the same band count and content.

map Map | undefined

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

useInterimTilesOnError boolean
(defaults to true)

Use interim tiles on error.

cacheSize number
(defaults to 512)

The internal texture cache size. This needs to be large enough to render two zoom levels worth of tiles.

properties Object.<string, *> | undefined

Arbitrary observable properties. Can be accessed with #get() and #set().


Name Type Description
vertexShader string

The vertex shader.

fragmentShader string

The fragment shader.

uniforms Object<UniformValue>

Uniform definitions.

paletteTextures Array<PaletteTexture>

Palette textures.

SourceType{DataTileSource} {TileImage}


Translates tile data to rendered pixels.

Name Type Description
variables Object.<string, (string|number)> | undefined

Style variables. Each variable must hold a number or string. These variables can be used in the color, brightness, contrast, exposure, saturation and gamma expressions, using the ['var', 'varName'] operator. To update style variables, use the updateStyleVariables method.

color ExpressionValue | undefined

An expression applied to color values.

brightness ExpressionValue
(defaults to 0)

Value used to decrease or increase the layer brightness. Values range from -1 to 1.

contrast ExpressionValue
(defaults to 0)

Value used to decrease or increase the layer contrast. Values range from -1 to 1.

exposure ExpressionValue
(defaults to 0)

Value used to decrease or increase the layer exposure. Values range from -1 to 1.

saturation ExpressionValue
(defaults to 0)

Value used to decrease or increase the layer saturation. Values range from -1 to 1.

gamma ExpressionValue
(defaults to 1)

Apply a gamma correction to the layer. Values range from 0 to infinity.