TypeDefs

BaseOptions

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

Source:

• olx.js, line 1866

GroupOptions

Stability: 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.
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.
layers	Array.<ol.layer.Base> | ol.Collection | undefined	Child layers.

Source:

• olx.js, line 2015

HeatmapOptions

Stability: experimental

Properties:

Name	Type	Description
brightness	number | undefined	Brightness.
contrast	number | undefined	Contrast.
hue	number | undefined	Hue.
gradient	Array.<string> | undefined	The color gradient of the heatmap, specified as an array of CSS color strings. Default is ['#00f', '#0ff', '#0f0', '#ff0', '#f00'].
radius	number | undefined	Radius size in pixels. Default is 8.
blur	number | undefined	Blur size in pixels. Default is 15.
shadow	number | undefined	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.
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.
opacity	number | undefined	Opacity. 0-1. Default is 1.
saturation	number | undefined	Saturation.
source	ol.source.Vector	Source.
visible	boolean | undefined	Visibility. Default is true (visible).

Source:

• olx.js, line 2098

LayerOptions

Stability: 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.
source	ol.source.Source	Source for this layer.
visible	boolean | undefined	Visibility. Default is true (visible).
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.

Source:

• olx.js, line 1937

TileOptions

Stability: 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.
preload	number | undefined	Preload.
saturation	number | undefined	Saturation. Default is 1.
source	ol.source.Source	Source for this layer.
visible	boolean | undefined	Visibility. Default is true (visible).
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.
useInterimTilesOnError	boolean | undefined	Use interim tiles on error. Default is true.

Source:

• olx.js, line 2216

VectorOptions

Stability: experimental

Properties:

Name	Type	Description
brightness	number | undefined	Brightness.
contrast	number | undefined	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	Hue.
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.
opacity	number | undefined	Opacity. 0-1. Default is 1.
saturation	number | undefined	Saturation.
source	ol.source.Vector	Source.
style	ol.style.Style | Array.<ol.style.Style> | ol.feature.StyleFunction | undefined	Layer style.
visible	boolean | undefined	Visibility. Default is true (visible).

Source:

• olx.js, line 2310