Module: ol/layer/Base




Type Definitions


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

BaseLayerObjectEventTypes{Types} {'change:extent'} {'change:maxResolution'} {'change:maxZoom'} {'change:minResolution'} {'change:minZoom'} {'change:opacity'} {'change:visible'} {'change:zIndex'}


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)


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.

background BackgroundColor | undefined

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

properties Object.<string, *> | undefined

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