Class: Rotate

ol.control.Rotate

A button control to reset rotation to 0. To style this control use css selector .ol-rotate.

new ol.control.Rotate(opt_options)

Name Type Description
options

Rotate options.

Name Type Description
className string | undefined

CSS class name. Default is ol-rotate.

label string | undefined

Text label to use for the rotate button. Default is

tipLabel string | undefined

Text label to use for the rotate tip. Default is Reset rotation

duration number | undefined

Animation duration in milliseconds. Default is 250.

autoHide boolean | undefined

Hide the control when rotation is 0. Default is true.

target Element | undefined

Target.

Fires:

Extends

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.

dispatchChangeEvent() inherited experimental

Dispatches a change event.

Fires:
  • change experimental

get(key){*} inherited experimental

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

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

Get a list of object property names.

Returns:
List of property names.

Get the map associated with this control.

Returns:
Map.

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

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

Returns:
Revision.

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.

Remove the control from its current map and attach it to the new map. Subclasses may set up event handlers to get notified about changes to the map here.

Name Type Description
map ol.Map

Map.

setProperties(values) inherited experimental

Sets a collection of key-value pairs.

Name Type Description
values Object.<string, *>

Values.

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().

Name Type Description
key goog.events.Key

Key.