OpenLayers 3

Class: Zoom

ol.control.Zoom

A control with 2 buttons, one for zoom in and one for zoom out. This control is one of the default controls of a map. To style this control use css selectors .ol-zoom-in and .ol-zoom-out.

new ol.control.Zoom(opt_options)

src/ol/control/zoomcontrol.js, line 25
Name Type Description
options

Zoom options.

Name Type Description
duration number | undefined

Animation duration in milliseconds. Default is 250.
className string | undefined

CSS class name. Default is ol-zoom.
zoomInLabel string | Node | undefined

Text label to use for the zoom-in button. Default is +. Instead of text, also a Node (e.g. a span element) can be used.
zoomOutLabel string | Node | undefined

Text label to use for the zoom-out button. Default is -. Instead of text, also a Node (e.g. a span element) can be used.
zoomInTipLabel string | undefined

Text label to use for the button tip. Default is Zoom in
zoomOutTipLabel string | undefined

Text label to use for the button tip. Default is Zoom out
delta number | undefined

The zoom delta applied on each click.
target Element | undefined

Target.
Fires:

Extends

Methods

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:
  • change experimental

get(key){*} inherited

src/ol/object.js, line 150

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 164

Get a list of object property names.

Returns:
List of property names.

getMap(){ol.Map} inherited

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

Get the map associated with this control.

Returns:
Map.

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

src/ol/object.js, line 174

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 62
Returns:
Revision.

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

src/ol/observable.js, line 75

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

src/ol/observable.js, line 88

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

src/ol/object.js, line 203

Sets a value.

Name Type Description
key string

Key name.
value *

Value.

setMap(map) inherited

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

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

src/ol/object.js, line 216

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.

setTarget(target) inherited experimental

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

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 101

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 114

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

unset(key) inherited

src/ol/object.js, line 229

Unsets a property.

Name Type Description
key string

Key name.