OpenLayers 3

Class: Rotate

ol.control.Rotate

A button control to reset rotation to 0. To style this control use css selector .ol-rotate. A .ol-hidden css selector is added to the button when the rotation is 0.

new ol.control.Rotate(opt_options)

src/ol/control/rotatecontrol.js, line 24
Name Type Description
options

Rotate options.

Name Type Description
className string | undefined

CSS class name. Default is ol-rotate.
label string | Element | undefined

Text label to use for the rotate button. Default is ⇧. Instead of text, also a Node (e.g. a span element) can be used.
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.
render function | undefined experimental

Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.
resetNorth function | undefined experimental

Function called when the control is clicked. This will override the default resetNorth.
target Element | undefined

Target.
Fires:
  • change experimental - Triggered when the revision counter is increased.
  • propertychange (ol.ObjectEvent) - Triggered when a property is changed.

Extends

Methods

ol.control.Rotate.render(mapEvent) experimental

src/ol/control/rotatecontrol.js, line 149

Update the rotate control element.

This:
Name Type Description
mapEvent ol.MapEvent

Map event.

changed() inherited experimental

src/ol/observable.js, line 57

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

dispatchEvent(event) inherited experimental

src/ol/observable.js, line 81

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event Object | ol.events.Event | string

Event object.

get(key){*} inherited

src/ol/object.js, line 148

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 162

Get a list of object property names.

Returns:
List of property names.

getMap(){ol.Map} inherited

src/ol/control/control.js, line 94

Get the map associated with this control.

Returns:
Map.

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

src/ol/object.js, line 172

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 90

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

on(type, listener, opt_this){ol.events.Key|Array.<ol.events.Key>} inherited

src/ol/observable.js, line 105

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. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener, opt_this){ol.events.Key|Array.<ol.events.Key>} inherited

src/ol/observable.js, line 130

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. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, opt_silent) inherited

src/ol/object.js, line 197

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setMap(map) inherited

src/ol/control/control.js, line 106

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, opt_silent) inherited

src/ol/object.js, line 217

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.
silent boolean

Update without triggering an event.

setTarget(target) inherited experimental

src/ol/control/control.js, line 137

This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.

Name Type Description
target Element | string

Target.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 153

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.

unByKey(key) inherited

src/ol/observable.js, line 174

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 ol.events.Key | Array.<ol.events.Key>

The key returned by on() or once() (or an array of keys).

unset(key, opt_silent) inherited

src/ol/object.js, line 231

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.