OpenLayers 3 API Documentation

Namespace: layer

olx.layer

Type Definitions

olx.layer.BaseOptions{Object} experimental

Properties:
Name Type Description
brightness number | undefined

Brightness. Default is 0.
contrast number | undefined

Contrast. Default is 1.
hue number | undefined

Hue. Default is 0.
opacity number | undefined

Opacity (0, 1). Default is 1.
saturation number | undefined

Saturation. Default is 1.
visible boolean | undefined

Visibility. Default is true.
extent ol.Extent | undefined

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
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.

olx.layer.GroupOptions{Object} experimental

Properties:
Name Type Argument Description
brightness number | undefined <optional>

Brightness. Default is 0.
contrast number | undefined <optional>

Contrast. Default is 1.
hue number | undefined <optional>

Hue. Default is 0.
opacity number | undefined <optional>

Opacity (0, 1). Default is 1.
saturation number | undefined <optional>

Saturation. Default is 1.
visible boolean | undefined <optional>

Visibility. Default is true.
extent ol.Extent | undefined <optional>

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
minResolution number | undefined <optional>

The minimum resolution (inclusive) at which this layer will be visible.
maxResolution number | undefined <optional>

The maximum resolution (exclusive) below which this layer will be visible.
layers Array.<ol.layer.Base> | ol.Collection.<ol.layer.Base> | undefined <optional>

Child layers.

olx.layer.HeatmapOptions{Object} experimental

Properties:
Name Type Argument Description
brightness number | undefined <optional>

Brightness.
contrast number | undefined <optional>

Contrast.
hue number | undefined <optional>

Hue.
gradient Array.<string> | undefined <optional>

The color gradient of the heatmap, specified as an array of CSS color strings. Default is ['#00f', '#0ff', '#0f0', '#ff0', '#f00'].
radius number | undefined <optional>

Radius size in pixels. Default is 8.
blur number | undefined <optional>

Blur size in pixels. Default is 15.
shadow number | undefined <optional>

Shadow size in pixels. Default is 250.
weight string | function

The feature attribute to use for the weight or a function that returns a weight from a feature. Weight values should range from 0 to 1 (and values outside will be clamped to that range). Default is weight.
extent ol.Extent | undefined <optional>

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
minResolution number | undefined <optional>

The minimum resolution (inclusive) at which this layer will be visible.
maxResolution number | undefined <optional>

The maximum resolution (exclusive) below which this layer will be visible.
opacity number | undefined <optional>

Opacity. 0-1. Default is 1.
saturation number | undefined <optional>

Saturation.
source ol.source.Vector

Source.
visible boolean | undefined <optional>

Visibility. Default is true (visible).

olx.layer.LayerOptions{Object} experimental

Properties:
Name Type Argument Description
brightness number | undefined <optional>

Brightness. Default is 0.
contrast number | undefined <optional>

Contrast. Default is 1.
hue number | undefined <optional>

Hue. Default is 0.
opacity number | undefined <optional>

Opacity (0, 1). Default is 1.
saturation number | undefined <optional>

Saturation. Default is 1.
source ol.source.Source

Source for this layer.
visible boolean | undefined <optional>

Visibility. Default is true (visible).
extent ol.Extent | undefined <optional>

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
minResolution number | undefined <optional>

The minimum resolution (inclusive) at which this layer will be visible.
maxResolution number | undefined <optional>

The maximum resolution (exclusive) below which this layer will be visible.

olx.layer.TileOptions{Object} experimental

Properties:
Name Type Argument Description
brightness number | undefined <optional>

Brightness. Default is 0.
contrast number | undefined <optional>

Contrast. Default is 1.
hue number | undefined <optional>

Hue. Default is 0.
opacity number | undefined <optional>

Opacity (0, 1). Default is 1.
preload number | undefined <optional>

Preload. Load low-resolution tiles up to preload levels. By default preload is 0, which means no preloading.
saturation number | undefined <optional>

Saturation. Default is 1.
source ol.source.Source

Source for this layer.
visible boolean | undefined <optional>

Visibility. Default is true (visible).
extent ol.Extent | undefined <optional>

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
minResolution number | undefined <optional>

The minimum resolution (inclusive) at which this layer will be visible.
maxResolution number | undefined <optional>

The maximum resolution (exclusive) below which this layer will be visible.
useInterimTilesOnError boolean | undefined <optional>

Use interim tiles on error. Default is true.

olx.layer.VectorOptions{Object} experimental

Properties:
Name Type Argument Description
brightness number | undefined <optional>

Brightness.
contrast number | undefined <optional>

Contrast.
renderOrder function

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.
hue number | undefined <optional>

Hue.
extent ol.Extent | undefined <optional>

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
minResolution number | undefined <optional>

The minimum resolution (inclusive) at which this layer will be visible.
maxResolution number | undefined <optional>

The maximum resolution (exclusive) below which this layer will be visible.
opacity number | undefined <optional>

Opacity. 0-1. Default is 1.
saturation number | undefined <optional>

Saturation.
source ol.source.Vector

Source.
style ol.style.Style | Array.<ol.style.Style> | ol.style.StyleFunction | undefined <optional>

Layer style. See ol.style for default style which will be used if this is not defined.
visible boolean | undefined <optional>

Visibility. Default is true (visible).