OpenLayers 3

ol.dom.Input

new Input

Stability: experimental

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');
Parameters:
Name Type Description
target Element

Target element.
Source:
  • input.js, line 36

Extends

Observable Properties

Name Type Settable Event 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:
Source:
  • object.js, line 232
Returns:
Type
ol.ObjectAccessor

dispatchChangeEvent

Stability: experimental
Inherited From:
Source:
  • observable.js, line 35

get

Stability: experimental

Gets a value.

Parameters:
Name Type Description
key string

Key name.
Inherited From:
Source:
  • object.js, line 289
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

getProperties

Stability: experimental

Get an object of all property names and values.

Inherited From:
Source:
  • object.js, line 348
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:
Source:
  • object.js, line 368

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:
Source:
  • observable.js, line 58
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:
Source:
  • observable.js, line 71
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:
Source:
  • object.js, line 399

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:
Source:
  • object.js, line 428

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:
Source:
  • observable.js, line 83

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:
Source:
  • object.js, line 442

unbindAll

Stability: experimental

Removes all bindings.

Inherited From:
Source:
  • object.js, line 466

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:
Source:
  • observable.js, line 93