Spec-Zone.ru › OpenLayers

ol/interaction/DoubleClickZoom~DoubleClickZoom


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

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

new DoubleClickZoom(options)

interaction/DoubleClickZoom.js, line 18
Название Тип Описание
duration number (по умолчанию 250)

Продолжительность анимации в миллисекундах.

delta number (по умолчанию 1)

Дельта масштабирования, применяемая при каждом двойном щелчке.

События:
  • 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 | string

Объект события.

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

get(key){*} унаследованный

Object.js, строка 135

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

Имя Тип Описание
key string

Имя ключа.

Возвращает:
Значение.

getActive(){boolean} унаследованный

interaction/Interaction.js, строка 82

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

Возвращает:
true, если инструмент активен, false в противном случае.

getKeys(){Array.<string>} унаследованный

Object.js, строка 148

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

Возвращает:
Список имён свойств.

getMap(){Map | 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 string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-обработчик.

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

once(type, listener){EventsKey | Array<EventsKey>} унаследованный

Observable.js, строка 164

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

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-обработчик.

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

set(key, value, silent) унаследованный

Object.js, строка 215

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

Имя Тип Описание
key string

Имя ключа.

value *

Значение.

silent boolean | undefined

Обновить без запуска события.

setActive(active) унаследованный

interaction/Interaction.js, строка 111

Активировать или деактивировать инструмент.

Имя Тип Описание
active boolean

Активно.

setProperties(values, silent) установлено

Object.js, строка 235

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

Имя Тип Описание
values Object.<string, *>

Значения.

silent boolean | undefined

Обновить без срабатывания события.

un(type, listener) установлено

Observable.js, строка 173

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

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-прослушиватель.

unset(key, silent) установлено

Object.js, строка 259

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

Имя Тип Описание
key string

Имя ключа.

silent boolean | undefined

Удалить без срабатывания события.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_interaction_DoubleClickZoom-DoubleClickZoom.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API