behavior.ScrollZoom

Extends IBehavior.

The "zooming the map with the mouse wheel" behavior.

Constructor | Fields | Events | Methods

Constructor

behavior.ScrollZoom([options])

Parameters:

Parameter Default value Description
options

Type: Object

Options.

options.maximumDelta 5

Type: Number

The maximum change in the map zoom for a single scroll event (uninterrupted turn of the mouse wheel). When this limit is reached, the map is re-drawn (tiles are shown for the zoom level that was reached).

options.speed 5

Type: Number

The speed of zooming the map with the enabled behavior behavior.ScrollZoom, in zoom levels per second.

Fields

Name Type Description
events IEventManager

Event manager.

Inherited from IEventEmitter.

options IOptionManager

Options manager.

Inherited from ICustomizable.

Events

Name Description
disable

Disabling behaviors.

Inherited from IBehavior.

enable

Enabling behaviors.

Inherited from IBehavior.

optionschange

Change to the object options.

Inherited from ICustomizable.

parentchange

The parent object reference changed.

Data fields:

  • oldParent - Old parent.
  • newParent - New parent.

Inherited from IChild.

Methods

Name Returns Description
disable()

Disables the behavior.

Inherited from IBehavior.

enable()

Enables the behavior.

Inherited from IBehavior.

getParent()

IParentOnMap|null

Returns link to the parent object, or null if the parent element was not set.

Inherited from IChildOnMap.

isEnabled()

Boolean

Checks whether the behavior is enabled.

Inherited from IBehavior.

setParent(parent)

IChildOnMap

Sets the parent object. If the null value is passed, the manager element will only be deleted from the current parent object.

Inherited from IChildOnMap.