Class: ol.layer.Layer

ol.layer.Layer

new Layer

Parameters:
Name Type Description
layerOptions ol.layer.LayerOptions LayerOptions.
Source:
  • layer.js, line 43

Extends

Members

changed

Inherited From:
Source:
  • object.js, line 156

setValues

Inherited From:
Source:
  • object.js, line 249

Methods

bindTo

Parameters:
Name Type Argument Description
key string Key.
target ol.Object Target.
targetKey string <optional>
 (Optional) Target key.
noNotify boolean <optional>
 (Optional) No notify.
Inherited From:
Source:
  • object.js, line 135

get

Parameters:
Name Type Description
key string Key.
Inherited From:
Source:
  • object.js, line 163
Returns:
Value.
Type
*

getBrightness

Source:
  • layer.js, line 86
Returns:
Brightness.
Type
number

getContrast

Source:
  • layer.js, line 98
Returns:
Contrast.
Type
number

getHue

Source:
  • layer.js, line 110
Returns:
Hue.
Type
number

getLayerState

Source:
  • layer.js, line 122
Returns:
Layer state.
Type
ol.layer.LayerState

getOpacity

Source:
  • layer.js, line 145
Returns:
Opacity.
Type
number

getSaturation

Source:
  • layer.js, line 157
Returns:
Saturation.
Type
number

getSource

Source:
  • layer.js, line 169
Returns:
Source.
Type
ol.source.Source

getVisible

Source:
  • layer.js, line 177
Returns:
Visible.
Type
boolean

isReady

Source:
  • layer.js, line 197
Returns:
Is ready.
Type
boolean

notify

Parameters:
Name Type Description
key string Key.
Inherited From:
Source:
  • object.js, line 184

set

Parameters:
Name Type Description
key string Key.
value * Value.
Inherited From:
Source:
  • object.js, line 212

setBrightness

Adjust the layer brightness. A value of -1 will render the layer completely black. A value of 0 will leave the brightness unchanged. A value of 1 will render the layer completely white. Other values are linear multipliers on the effect (values are clamped between -1 and 1). The filter effects draft [1] says the brightness function is supposed to render 0 black, 1 unchanged, and all other values as a linear multiplier. The current WebKit implementation clamps values between -1 (black) and 1 (white) [2]. There is a bug open to change the filter effect spec [3]. TODO: revisit this if the spec is still unmodified before we release [1] https://dvcs.w3.org/hg/FXTF/raw-file/tip/filters/index.html [2] https://github.com/WebKit/webkit/commit/8f4765e569 [3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
Parameters:
Name Type Description
brightness number Brightness.
Source:
  • layer.js, line 222

setContrast

Adjust the layer contrast. A value of 0 will render the layer completely grey. A value of 1 will leave the contrast unchanged. Other values are linear multipliers on the effect (and values over 1 are permitted).
Parameters:
Name Type Description
contrast number Contrast.
Source:
  • layer.js, line 241

setHue

Apply a hue-rotation to the layer. A value of 0 will leave the hue unchanged. Other values are radians around the color circle.
Parameters:
Name Type Description
hue number Hue.
Source:
  • layer.js, line 258

setOpacity

Parameters:
Name Type Description
opacity number Opacity.
Source:
  • layer.js, line 272

setOptions

Parameters:
Name Type Description
options Object.<string, *> Options.
Inherited From:
Source:
  • object.js, line 234

setSaturation

Adjust layer saturation. A value of 0 will render the layer completely unsaturated. A value of 1 will leave the saturation unchanged. Other values are linear multipliers of the effect (and values over 1 are permitted).
Parameters:
Name Type Description
saturation number Saturation.
Source:
  • layer.js, line 292

setVisible

Parameters:
Name Type Description
visible boolean Visible.
Source:
  • layer.js, line 307

unbind

Parameters:
Name Type Description
key string Key.
Inherited From:
Source:
  • object.js, line 255

unbindAll

Removes all bindings.
Inherited From:
Source:
  • object.js, line 272