// bind a checkbox with id 'visible' to a layer's visibility
var visible = new ol.dom.Input(document.getElementById('visible'));
visible.bindTo('checked', layer, 'visible');

Extends

• ol.Object

Observable Properties

Name	Type	Settable	ol.ObjectEvent type	Description
value	string	yes	change:value	the value of the Input
checked	boolean	yes	change:checked	the checked state of the Input

Methods

bindTo

Stability: experimental

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;
    }
  );

Parameters:

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

Inherited From:

• ol.Object#bindTo

Source:

• object.js, line 247

Returns:

Type

ol.ObjectAccessor

dispatchChangeEvent

Stability: experimental

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

Inherited From:

• ol.Observable#dispatchChangeEvent

Source:

• observable.js, line 39

Fires:

• event:change

get

Stability: experimental

Gets a value.

Parameters:

Name	Type	Description
key	string	Key name.

Inherited From:

• ol.Object#get

Source:

• object.js, line 304

Returns:

Value.

Type

*

getChecked

Stability: experimental

If the input is a checkbox, return whether or not the checbox is checked.

Source:

• input.js, line 64

Returns:

checked.

Type

boolean | undefined

getKeys

Stability: experimental

Get a list of object property names.

Inherited From:

• ol.Object#getKeys

Source:

• object.js, line 332

Returns:

List of property names.

Type

Array.<string>

getProperties

Stability: experimental

Get an object of all property names and values.

Inherited From:

• ol.Object#getProperties

Source:

• object.js, line 364

Returns:

Object.

Type

Object.<string, *>

getValue

Stability: experimental

Get the value of the input.

Source:

• input.js, line 78

Returns:

input value.

Type

string | undefined

notify

Stability: experimental

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.

Parameters:

Name	Type	Description
key	string	Key name.

Inherited From:

• ol.Object#notify

Source:

• object.js, line 384

on

Stability: experimental

Listen for a certain type of event.

Parameters:

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

Inherited From:

• ol.Observable#on

Source:

• observable.js, line 61

Returns:

Unique key for the listener.

Type

goog.events.Key

once

Stability: experimental

Listen once for a certain type of event.

Parameters:

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

Inherited From:

• ol.Observable#once

Source:

• observable.js, line 74

Returns:

Unique key for the listener.

Type

goog.events.Key

set

Stability: experimental

Sets a value.

Parameters:

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

Inherited From:

• ol.Object#set

Source:

• object.js, line 415

setChecked

Stability: experimental

Set whether or not a checkbox is checked.

Parameters:

Name	Type	Description
checked	boolean	Checked.

Source:

• input.js, line 106

setValue

Stability: experimental

Sets the value of the input.

Parameters:

Name	Type	Description
value	string	Value.

Source:

• input.js, line 92

setValues

Stability: experimental

Sets a collection of key-value pairs.

Parameters:

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

Inherited From:

• ol.Object#setValues

Source:

• object.js, line 444

un

Stability: experimental

Unlisten for a certain type of event.

Parameters:

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

Inherited From:

• ol.Observable#un

Source:

• observable.js, line 86

unbind

Stability: experimental

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.

Parameters:

Name	Type	Description
key	string	Key name.

Inherited From:

• ol.Object#unbind

Source:

• object.js, line 458

unbindAll

Stability: experimental

Removes all bindings.

Inherited From:

• ol.Object#unbindAll

Source:

• object.js, line 482

unByKey

Stability: experimental

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

Parameters:

Name	Type	Description
key	goog.events.Key	Key.

Inherited From:

• ol.Observable#unByKey

Source:

• observable.js, line 96