Class: Image

Extends

• ol.layer.Layer

Observable Properties

Name	Type	Settable	ol.ObjectEvent type	Description
brightness	number | undefined	yes	change:brightness	The brightness of the layer.
contrast	number | undefined	yes	change:contrast	The contrast of the layer.
hue	number | undefined	yes	change:hue	The hue of the layer.
maxResolution	number | undefined	yes	change:maxresolution	The maximum resolution of the layer.
minResolution	number | undefined	yes	change:minresolution	The minimum resolution of the layer.
opacity	number | undefined	yes	change:opacity	The opacity of the layer.
saturation	number | undefined	yes	change:saturation	The saturation of the layer.
visible	boolean | undefined	yes	change:visible	The visiblity of the layer.

Methods

experimental inherited bindTo(key, target, opt_targetKey){ol.ObjectAccessor}

src/ol/object.js, line 247

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an ol.ObjectAccessor with a transform method that lets you transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );

Name	Type	Argument	Description
key	string		Key name.
target	ol.Object		Target.
targetKey	string	<optional>	optional Target key.

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:

• change

experimental inherited get(key){*}

src/ol/object.js, line 304

Gets a value.

Name	Type	Description
key	string	Key name.

experimental inherited getBrightness(){number|undefined}

src/ol/layer/layerbase.js, line 84

Returns:

brightness of the layer.

experimental inherited getContrast(){number|undefined}

src/ol/layer/layerbase.js, line 99

Returns:

contrast of the layer.

experimental inherited getHue(){number|undefined}

src/ol/layer/layerbase.js, line 114

Returns:

hue of the layer.

experimental inherited getKeys(){Array.<string>}

src/ol/object.js, line 332

Get a list of object property names.

Returns:

of property names.

experimental inherited getMaxResolution(){number|undefined}

src/ol/layer/layerbase.js, line 172

Returns:

maximum resolution of the layer.

experimental inherited getMinResolution(){number|undefined}

src/ol/layer/layerbase.js, line 187

Returns:

minimum resolution of the layer.

experimental inherited getOpacity(){number|undefined}

src/ol/layer/layerbase.js, line 202

Returns:

opacity of the layer.

experimental inherited getProperties(){Object.<string, *>}

src/ol/object.js, line 364

Get an object of all property names and values.

experimental inherited getSaturation(){number|undefined}

src/ol/layer/layerbase.js, line 217

Returns:

saturation of the layer.

experimental inherited getSource(){ol.source.Source}

src/ol/layer/layer.js, line 63

experimental inherited getVisible(){boolean|undefined}

src/ol/layer/layerbase.js, line 238

Returns:

visiblity of the layer.

experimental inherited notify(key)

src/ol/object.js, line 384

Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

Name	Type	Description
key	string	Key name.

experimental inherited on(type, listener, opt_this){goog.events.Key}

src/ol/observable.js, line 61

Listen for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

Returns:

key for the listener.

experimental inherited once(type, listener, opt_this){goog.events.Key}

src/ol/observable.js, line 74

Listen once for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

Returns:

key for the listener.

experimental inherited set(key, value)

src/ol/object.js, line 415

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.

experimental inherited setBrightness(brightness)

src/ol/layer/layerbase.js, line 270

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

Name	Type	Description
brightness	number | undefined	The brightness of the layer.

experimental inherited setContrast(contrast)

src/ol/layer/layerbase.js, line 288

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

Name	Type	Description
contrast	number | undefined	The contrast of the layer.

experimental inherited setHue(hue)

src/ol/layer/layerbase.js, line 304

Apply a hue-rotation to the layer. A value of 0 will leave the hue unchanged. Other values are radians around the color circle.

Name	Type	Description
hue	number | undefined	The hue of the layer.

experimental inherited setMaxResolution(maxResolution)

src/ol/layer/layerbase.js, line 318

Name	Type	Description
maxResolution	number | undefined	The maximum resolution of the layer.

experimental inherited setMinResolution(minResolution)

src/ol/layer/layerbase.js, line 332

Name	Type	Description
minResolution	number | undefined	The minimum resolution of the layer.

experimental inherited setOpacity(opacity)

src/ol/layer/layerbase.js, line 346

Name	Type	Description
opacity	number | undefined	The opacity of the layer.

experimental inherited setSaturation(saturation)

src/ol/layer/layerbase.js, line 365

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

Name	Type	Description
saturation	number | undefined	The saturation of the layer.

experimental inherited setValues(values)

src/ol/object.js, line 444

Sets a collection of key-value pairs.

Name	Type	Description
values	Object.<string, *>	Values.

experimental inherited setVisible(visible)

src/ol/layer/layerbase.js, line 379

Name	Type	Description
visible	boolean | undefined	The visiblity of the layer.

experimental inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

Unlisten for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

experimental inherited unbind(key)

src/ol/object.js, line 458

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Name	Type	Description
key	string	Key name.

experimental inherited unbindAll()

src/ol/object.js, line 482

Removes all bindings.

experimental inherited unByKey(key)

src/ol/observable.js, line 96

Removes an event listener using the key returned by on() or once().

Name	Type	Description
key	goog.events.Key	Key.