Class: Input

Extends

• ol.Object

Observable Properties

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

Methods

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

src/ol/object.js, line 257

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	Description
key	string	Key name.
target	ol.Object	Target.
targetKey	string	optional Target key.

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 41

Dispatches a change event.

Fires:

• change experimental

get(key){*} inherited experimental

src/ol/object.js, line 314

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getChecked(){boolean|undefined} experimental

src/ol/dom/input.js, line 64

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

Returns:

The checked state of the Input.

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

src/ol/object.js, line 342

Get a list of object property names.

Returns:

List of property names.

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

src/ol/object.js, line 374

Get an object of all property names and values.

Returns:

Object.

getValue(){string|undefined} experimental

src/ol/dom/input.js, line 79

Get the value of the input.

Returns:

The value of the Input.

notify(key) inherited experimental

src/ol/object.js, line 394

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.

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

src/ol/observable.js, line 63

Listen for a certain type of event.

Name	Type	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.

Returns:

Unique key for the listener.

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

src/ol/observable.js, line 76

Listen once for a certain type of event.

Name	Type	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.

Returns:

Unique key for the listener.

set(key, value) inherited experimental

src/ol/object.js, line 425

Sets a value.

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

setChecked(checked) experimental

src/ol/dom/input.js, line 109

Set whether or not a checkbox is checked.

Name	Type	Description
checked	boolean	The checked state of the Input.

setValue(value) experimental

src/ol/dom/input.js, line 94

Sets the value of the input.

Name	Type	Description
value	string	The value of the Input.

setValues(values) inherited experimental

src/ol/object.js, line 454

Sets a collection of key-value pairs.

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

un(type, listener, opt_this) inherited experimental

src/ol/observable.js, line 88

Unlisten for a certain type of event.

Name	Type	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.

unbind(key) inherited experimental

src/ol/object.js, line 468

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.

unbindAll() inherited experimental

src/ol/object.js, line 492

Removes all bindings.

unByKey(key) inherited experimental

src/ol/observable.js, line 98

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

Name	Type	Description
key	goog.events.Key	Key.