// 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

Methods

bindTo

Binds a View to a Model.

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:

• ol.Object#bindTo

Source:

• object.js, line 147

get

Gets a value.

Parameters:

Name	Type	Description
key	string	Key.

Inherited From:

• ol.Object#get

Source:

• object.js, line 170

Returns:

Value.

Type

*

getChecked

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

Source:

• input.js, line 62

Returns:

checked.

Type

boolean | undefined

getValue

Get the value of the input.

Source:

• input.js, line 75

Returns:

input value.

Type

string | undefined

getValueAsNumber

Get the value of the input as a number.

Source:

• input.js, line 88

Returns:

input value as number.

Type

number | null | undefined

notify

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.

Inherited From:

• ol.Object#notify

Source:

• object.js, line 208

on

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.
scope	Object	<optional>	(Optional) Object is whose scope to call the listener.

Inherited From:

• ol.Object#on

Source:

• object.js, line 240

Returns:

Unique key for the listener.

Type

goog.events.Key

once

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.
scope	Object	<optional>	(Optional) Object is whose scope to call the listener.

Inherited From:

• ol.Object#once

Source:

• object.js, line 253

Returns:

Unique key for the listener.

Type

goog.events.Key

set

Sets a value.

Parameters:

Name	Type	Description
key	string	Key.
value	*	Value.

Inherited From:

• ol.Object#set

Source:

• object.js, line 263

setChecked

Set whether or not a checkbox is checked.

Parameters:

Name	Type	Description
checked	boolean	Checked.

Source:

• input.js, line 127

setValue

Sets the value of the input.

Parameters:

Name	Type	Description
value	string	Value.

Source:

• input.js, line 101

setValueAsNumber

Sets the number value of the input.

Parameters:

Name	Type	Description
value	number	Number value.

Source:

• input.js, line 114

setValues

Sets a collection of key-value pairs.

Parameters:

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

Inherited From:

• ol.Object#setValues

Source:

• object.js, line 286

un

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.
scope	Object	<optional>	(Optional) Object is whose scope to call the listener.

Inherited From:

• ol.Object#un

Source:

• object.js, line 326

unbind

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.

Inherited From:

• ol.Object#unbind

Source:

• object.js, line 305

unbindAll

Removes all bindings.

Inherited From:

• ol.Object#unbindAll

Source:

• object.js, line 344

unByKey

Removes an event listener which was added with listen() by the key returned by on().

Parameters:

Name	Type	Argument	Description
key	number	<nullable>	Key.

Inherited From:

• ol.Object#unByKey

Source:

• object.js, line 336