Type Definitions

Options{Object}

Properties:

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.

Render order. Function to be used when sorting
features before rendering. By default features are drawn in the order that they are created. Use
null to avoid the sort, but get an undefined draw order.

renderBuffer

number

<optional>

100

The buffer in pixels around the viewport extent used by the
renderer when getting features from the vector source for the rendering or hit-detection.
Recommended value: the size of the largest symbol, line width or label.

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 module:ol/Map#addLayer.

declutter

boolean

<optional>

false

Declutter images and text. Decluttering is applied to all
image and text styles, and the priority is defined by the z-index of the style. Lower z-index
means higher priority.

Layer style. See
module:ol/style for default style which will be used if this is not defined.

updateWhileAnimating

boolean

<optional>

false

When set to true and renderMode
is vector, feature batches will be recreated during animations. This means that no
vectors will be shown clipped, but the setting will have a performance impact for large
amounts of vector data. When set to false, batches will be recreated when no animation
is active.

updateWhileInteracting

boolean

<optional>

false

When set to true and renderMode
is vector, feature batches will be recreated during interactions. See also
updateWhileAnimating.