Module: ol/layer/Layer

ol/layer/Layer


Classes

Layer

Type Definitions

LayerEventType{'sourceready'} {'change:source'}

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

source SourceType <optional>

Source for this layer. If not provided to the constructor, the source can be set by calling layer.setSource(source) after construction.

map Map | null <optional>

Map.

render RenderFunction <optional>

Render function. Takes the frame state as input and is expected to return an HTML element. Will overwrite the default rendering for the layer.

properties Object.<string, *> <optional>

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

RenderFunction()

State{Object}

Properties:
Name Type Argument Description
layer Layer

Layer.

opacity number

Opacity, the value is rounded to two digits to appear after the decimal point.

visible boolean

Visible.

managed boolean

Managed.

extent Extent <optional>

Extent.

zIndex number

ZIndex.

maxResolution number

Maximum resolution.

minResolution number

Minimum resolution.

minZoom number

Minimum zoom.

maxZoom number

Maximum zoom.