Module: ol/layer/WebGLTile

ol/layer/WebGLTile

Classes

WebGLTileLayer

Type Definitions

Options{Object}

Properties:

Name	Type	Argument	Default	Description
`style`	module:ol/layer/WebGLTile~Style	<optional>		Style to apply to the layer.
`className`	string	<optional>	'ol-layer'	A CSS class name to set to the layer element.
`opacity`	number	<optional>	1	Opacity (0, 1).
`visible`	boolean	<optional>	true	Visibility.
`extent`	module:ol/extent~Extent	<optional>		The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
`zIndex`	number	<optional>		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	<optional>		The minimum resolution (inclusive) at which this layer will be visible.
`maxResolution`	number	<optional>		The maximum resolution (exclusive) below which this layer will be visible.
`minZoom`	number	<optional>		The minimum view zoom level (exclusive) above which this layer will be visible.
`maxZoom`	number	<optional>		The maximum view zoom level (inclusive) at which this layer will be visible.
`preload`	number	<optional>	0	Preload. Load low-resolution tiles up to `preload` levels. `0` means no preloading.
`source`	module:ol/layer/WebGLTile~SourceType	<optional>		Source for this layer.
`sources`	Array.<SourceType> \| function	<optional>		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 `module:ol/source.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`	module:ol/PluggableMap~PluggableMap	<optional>		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~Map#addLayer`.
`useInterimTilesOnError`	boolean	<optional>	true	Use interim tiles on error.
`cacheSize`	number	<optional>	512	The internal texture cache size. This needs to be large enough to render two zoom levels worth of tiles.

ParsedStyle{Object}

Properties:

Name	Type	Description
`vertexShader`	string	The vertex shader.
`fragmentShader`	string	The fragment shader.
`uniforms`	Object.<string, module:ol/webgl/Helper~UniformValue>	Uniform definitions.
`paletteTextures`	Array.<module:ol/webgl/PaletteTexture~PaletteTexture>	Palette textures.

SourceType{module:ol/source/DataTile~DataTileSource} {module:ol/source/TileImage~TileImage}

Style{Object}

Translates tile data to rendered pixels.

Properties:

Name	Type	Argument	Default	Description
`variables`	Object.<string, (string\|number)>	<optional>		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 `module:ol/layer/WebGLTile~WebGLTileLayer#updateStyleVariables` method.
`color`	module:ol/style/expressions~ExpressionValue	<optional>		An expression applied to color values.
`brightness`	module:ol/style/expressions~ExpressionValue	<optional>	0	Value used to decrease or increase the layer brightness. Values range from -1 to 1.
`contrast`	module:ol/style/expressions~ExpressionValue	<optional>	0	Value used to decrease or increase the layer contrast. Values range from -1 to 1.
`exposure`	module:ol/style/expressions~ExpressionValue	<optional>	0	Value used to decrease or increase the layer exposure. Values range from -1 to 1.
`saturation`	module:ol/style/expressions~ExpressionValue	<optional>	0	Value used to decrease or increase the layer saturation. Values range from -1 to 1.
`gamma`	module:ol/style/expressions~ExpressionValue	<optional>	1	Apply a gamma correction to the layer. Values range from 0 to infinity.