MouseWheelZoom~MouseWheelZoom

import MouseWheelZoom from 'ol/interaction/MouseWheelZoom.js';

Позволяет пользователю изменять масштаб карты, прокручивая колесо мыши.

new MouseWheelZoom(options) interaction/MouseWheelZoom.js, line 38

Имя	Тип	Описание
`condition`	Condition \| undefined	Функция, которая принимает `MapBrowserEvent` и возвращает булево значение, указывающее, следует ли обрабатывать это событие. По умолчанию — `always`.
`onFocusOnly`	boolean (по умолчанию false)	Если у целевого элемента карты задано атрибут `tabindex`, взаимодействие будет обрабатывать события только при фокусировке на карте.
`maxDelta`	number (по умолчанию 1)	Максимальное смещение колеса мыши.
`duration`	number (по умолчанию 250)	Длительность анимации в миллисекундах.
`timeout`	number (по умолчанию 80)	Длительность таймаута колеса мыши в миллисекундах.
`useAnchor`	boolean (по умолчанию true)	Включить масштабирование, используя положение курсора мыши в качестве якоря. Если установлено значение `false`, масштабирование будет происходить по центру экрана, а не по положению курсора.
`constrainResolution`	boolean (по умолчанию false)	Если true, событие масштабирования колесом мыши всегда будет анимироваться до ближайшего уровня масштабирования после взаимодействия; false — допускаются промежуточные уровни масштабирования.

Вызывает:

change (BaseEvent) - Общее событие изменения. Срабатывает, когда счётчик пересмотра увеличивается.
change:active (ObjectEvent)
error (BaseEvent) - Общее событие ошибки. Срабатывает при возникновении ошибки.
propertychange (ObjectEvent) - Срабатывает при изменении свойства.

Расширяет

Interaction

Наблюдаемые свойства

Имя	Тип	Устанавливаемое	ObjectEvent тип	Описание
`active`	boolean	да	`change:active`	`true`, если взаимодействие активно; `false` в противном случае.

Методы

changed() унаследованный Observable.js, строка 68

Увеличивает счётчик ревизий и отправляет событие 'change'.

dispatchEvent(event){boolean | undefined} унаследованный events/Target.js, строка 85

Отправляет событие и вызывает все обработчики, реагирующие на события данного типа. Параметр event может быть строкой или объектом с свойством type.

Имя	Тип	Описание
`event`	BaseEvent \| строка	Объект события.

Возвращает:

false, если кто-то вызвал preventDefault в объекте события или если какой-либо из обработчиков вернул false.

get(key){*} унаследованный Object.js, строка 135

Получает значение.

Имя	Тип	Описание
`key`	строка	Имя ключа.

Возвращает:

Значение.

getActive(){boolean} унаследованный interaction/Interaction.js, строка 82

Возвращает, активна ли в данный момент интеракция.

Возвращает:

true, если интеракция активна, false в противном случае.

getKeys(){Array.<string>} унаследованный Object.js, строка 148

Получить список имён свойств объекта.

Возвращает:

Список имён свойств.

getMap(){Карта | null} унаследованный interaction/Interaction.js, строка 91

Получить карту, связанную с этой интеракцией.

Возвращает:

Карту.

getProperties(){Object.<string, *>} унаследованный Object.js, строка 157

Получить объект со всеми именами свойств и их значениями.

Возвращает:

Объект.

getRevision(){number} унаследованный Observable.js, строка 79

Получить номер версии этого объекта. Каждый раз, когда объект изменяется, его номер версии увеличивается.

Возвращает:

Номер ревизии.

on(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 152

Прослушивать события определённого типа.

Имя	Тип	Описание
`type`	строка \| Array.<строка>	Тип события или массив типов событий.
`listener`	функция	Функция-обработчик.

Возвращает:

Уникальный ключ для обработчика. Если вызван с массивом типов событий в качестве первого аргумента, возвращается массив ключей.

once(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 164

Прослушать событие определённого типа один раз.

Имя	Тип	Описание
`type`	строка \| Array.<строка>	Тип события или массив типов событий.
`listener`	функция	Функция-обработчик.

Возвращает:

set(key, value, silent) унаследованный Object.js, строка 215

Устанавливает значение.

Имя	Тип	Описание
`key`	строка	Имя ключа.
`value`	*	Значение.
`silent`	boolean \| undefined	Обновить без срабатывания события.

setActive(active) унаследованный interaction/Interaction.js, строка 111

Активировать или деактивировать интеракцию.

Имя	Тип	Описание
`active`	boolean	Активность.

setMouseAnchor(useAnchor) interaction/MouseWheelZoom.js, line 299

Включить или выключить использование координат мыши в качестве якоря при масштабировании

Имя	Тип	Описание
`useAnchor`	boolean	true для масштабирования к позиции мыши, false для масштабирования к центру карты

setProperties(values, silent) inherited Object.js, line 235

Устанавливает коллекцию пар "ключ-значение". Обратите внимание, что это изменяет все существующие свойства и добавляет новые (не удаляет существующие свойства).

Имя	Тип	Описание
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновить без срабатывания события.

un(type, listener) inherited Observable.js, line 173

Отписаться от определенного типа события.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция обработчика.

unset(key, silent) inherited Object.js, line 259

Удаляет свойство.

Имя	Тип	Описание
`key`	string	Имя ключа.
`silent`	boolean \| undefined	Удалить без срабатывания события.