Classes
Type Definitions
-
Options{Object}
-
Properties:
Name Type Argument Default Description 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
, azIndex
of 0 is assumed for layers that are added to the map'slayers
collection, orInfinity
when the layer'ssetMap()
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/source/Tile~TileSource <optional>
Source for this layer.
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
map.addLayer()
.useInterimTilesOnError
boolean <optional>
true Use interim tiles on error.
properties
Object.<string, *> <optional>
Arbitrary observable properties. Can be accessed with
#get()
and#set()
.