Module: ol/layer/Base

ol/layer/Base


Classes

BaseLayer

Type Definitions

BackgroundColor()

A css color, or a function called with a view resolution returning a css color.

BaseLayerObjectEventTypes{module:ol/ObjectEventType~Types} {'change:extent'} {'change:maxResolution'} {'change:maxZoom'} {'change:minResolution'} {'change:minZoom'} {'change:opacity'} {'change:visible'} {'change:zIndex'}

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

background module:ol/layer/Base~BackgroundColor <optional>

Background color for the layer. If not specified, no background will be rendered.

properties Object.<string, *> <optional>

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