Classes
Type Definitions
-
Options{Object}
-
Properties:
Name Type Description 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)Visibility.
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
, 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 | 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
TileSource | undefined Source for this layer.
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
map.addLayer()
.background
BackgroundColor | undefined Background color for the layer. If not specified, no background will be rendered.
useInterimTilesOnError
boolean
(defaults to true)Deprecated. Use interim tiles on error.
properties
Object.<string, *> | undefined Arbitrary observable properties. Can be accessed with
#get()
and#set()
.cacheSize
number
(defaults to 512)The internal tile cache size. This needs to be large enough to render two zoom levels worth of tiles.