Spec-Zone.ru › OpenLayers

ol/interaction/DragAndDrop~DragAndDrop


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

Обрабатывает ввод векторных данных перетаскиванием и отпусканием.

new DragAndDrop(options)

interaction/DragAndDrop.js, line 94
Имя Тип Описание
formatConstructors Array.<(Class.<module:ol/format/Feature~FeatureFormat>|module:ol/format/Feature~FeatureFormat)> | undefined

Конструкторы форматов (и/или предварительно сконструированные форматы с опциями).

source VectorSource | undefined

Необязательный векторный источник, куда будут добавлены объекты. Если источник указан, все существующие объекты будут удалены, а новые объекты будут добавлены при их отпускании на целевой объект. Если вы хотите добавлять объекты в векторный источник без удаления существующих объектов (только добавлять), вместо указания опции источника, подпишитесь на событие "addfeatures".

projection ProjectionLike | undefined

Целевой проекции. По умолчанию используется проекция представления карты.

target HTMLElement | undefined

Элемент, используемый в качестве целевого объекта перетаскивания, по умолчанию — элемент представления.

События:
  • addfeatures (DragAndDropEvent) - Срабатывает, когда объекты добавляются
  • 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

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

Возвращает:
Номер ревизии.

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

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

Обрабатывает событие map browser event.

Имя Тип Описание
mapBrowserEvent MapBrowserEvent

Событие браузера карты.

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

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/DragAndDrop.js, строка 243

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

Имя Тип Описание
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_DragAndDrop-DragAndDrop.html

Spec-Zone.ru

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