Class: Input

Input

Helper class for binding HTML input to an ol.Object.

Example:

// 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');

new ol.dom.Input(target) experimental

Name Type Description
target Element

Target element.

Fires:

Extends

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

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an object with a transform method that you can use to provide from and to functions to 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

Target key.

changed() inherited experimental

Increases the revision counter and disptches a 'change' event.

Fires:
  • change experimental

get(key){*} inherited experimental

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getChecked(){boolean|undefined} experimental

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

Returns:
The checked state of the Input.

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

Get a list of object property names.

Returns:
List of property names.

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

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

Returns:
Revision.

getValue(){string|undefined} experimental

Get the value of the input.

Returns:
The value of the Input.

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

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

The object to use as this in listener.

Returns:
Unique key for the listener.

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

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

The object to use as this in listener.

Returns:
Unique key for the listener.

set(key, value) inherited experimental

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

setChecked(checked) experimental

Set whether or not a checkbox is checked.

Name Type Description
checked boolean

The checked state of the Input.

setProperties(values) inherited experimental

Sets a collection of key-value pairs.

Name Type Description
values Object.<string, *>

Values.

setValue(value) experimental

Sets the value of the input.

Name Type Description
value string

The value of the Input.

un(type, listener, opt_this) inherited

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

The object which was used as this by the listener.

unbind(key) inherited 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.

Name Type Description
key string

Key name.

unbindAll() inherited experimental

Removes all bindings.

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().