DragZoom~DragZoom

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

Позволяет пользователю изменять масштаб карты, нажимая и перетаскивая по карте, обычно в сочетании с ol/events/condition, ограничивающим это действием до момента удержания клавиши, по умолчанию Shift.

Для изменения стиля рамки используйте CSS и селектор .ol-dragzoom, или свой пользовательский селектор, настроенный с помощью className.

new DragZoom(options) interaction/DragZoom.js, line 32

Имя	Тип	Описание
`className`	string (defaults to 'ol-dragzoom')	Имя класса CSS для стилизации рамки.
`condition`	Condition \| undefined	Функция, принимающая `MapBrowserEvent` и возвращающая булево значение, указывающее, должно ли обрабатываться это событие. По умолчанию `shiftKeyOnly`.
`duration`	number (defaults to 200)	Продолжительность анимации в миллисекундах.
`out`	boolean (defaults to false)	Использовать взаимодействие для уменьшения масштаба.
`minArea`	number (defaults to 64)	Минимальная площадь рамки в пикселях. Это значение используется родительской функцией по умолчанию `boxEndCondition`.

Вызываемые события:

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

Расширяет

DragBox

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

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

Методы

changed() inherited Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

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

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

Возвращает:

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

get(key){*} inherited Object.js, line 135

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

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

Возвращает:

Значение.

getActive(){boolean} inherited interaction/Interaction.js, line 82

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

Возвращает:

true, если интерактивный элемент активен, false в противном случае.

getGeometry(){Polygon} inherited interaction/DragBox.js, line 198

Возвращает геометрию последней нарисованной области.

Возвращает:

Геометрию.

getKeys(){Array.<string>} inherited Object.js, line 148

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

Возвращает:

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

getMap(){Map | null} inherited interaction/Interaction.js, line 91

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

Возвращает:

Карту.

getPointerCount(){number} inherited interaction/Pointer.js, line 95

Возвращает текущее количество указателей, участвующих во взаимодействии, например, 2, когда используются два пальца.

Возвращает:

Количество указателей.

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

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

Возвращает:

Объект.

getRevision(){number} inherited Observable.js, line 79

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

Возвращает:

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

handleEvent(mapBrowserEvent){boolean} inherited interaction/Pointer.js, line 125

Обрабатывает событие map browser event и может вызывать другие функции, если обнаружены последовательности событий, такие как, например, 'drag' или 'down-up' и т. д.

Имя	Тип	Описание
`mapBrowserEvent`	MapBrowserEvent	Событие браузера карты.

Возвращает:

false для остановки распространения события.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

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

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

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

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

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

Возвращает:

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

set(key, value, silent) inherited Object.js, строка 215

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

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

setActive(active) inherited interaction/DragBox.js, строка 292

Активировать или деактивировать взаимодействие.

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

setProperties(values, silent) inherited Object.js, строка 235

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

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

un(type, listener) inherited Observable.js, строка 173

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

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

unset(key, silent) inherited Object.js, строка 259

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

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