ol/interaction/DragAndDrop~DragAndDrop
import DragAndDrop from 'ol/interaction/DragAndDrop.js';
Обрабатывает ввод векторных данных перетаскиванием и отпусканием.
-
new DragAndDrop(options)
-
Имя Тип Описание formatConstructorsArray.<(Class.<module:ol/format/Feature~FeatureFormat>|module:ol/format/Feature~FeatureFormat)> | undefined Конструкторы форматов (и/или предварительно сконструированные форматы с опциями).
sourceVectorSource | undefined Необязательный векторный источник, куда будут добавлены объекты. Если источник указан, все существующие объекты будут удалены, а новые объекты будут добавлены при их отпускании на целевой объект. Если вы хотите добавлять объекты в векторный источник без удаления существующих объектов (только добавлять), вместо указания опции источника, подпишитесь на событие "addfeatures".
projectionProjectionLike | undefined Целевой проекции. По умолчанию используется проекция представления карты.
targetHTMLElement | undefined Элемент, используемый в качестве целевого объекта перетаскивания, по умолчанию — элемент представления.
События:
-
addfeatures(DragAndDropEvent) - Срабатывает, когда объекты добавляются -
change(BaseEvent) - Общее событие изменения. Срабатывает, когда счётчик ревизий увеличивается. -
change:active(ObjectEvent) -
error(BaseEvent) - Общее событие об ошибке. Срабатывает при возникновении ошибки. -
propertychange(ObjectEvent) - Срабатывает, когда свойство изменено.
-
Расширяет
Наблюдаемые свойства
| Имя | Тип | Устанавливаемое | ObjectEvent тип | Описание |
|---|---|---|---|---|
active | boolean | да | change:active |
|
Методы
-
changed() унаследованный
-
Увеличивает счётчик ревизий и отправляет событие 'change'.
-
dispatchEvent(event){boolean | undefined} унаследованный
-
Отправляет событие и вызывает все слушатели, ожидающие события этого типа. Параметр event может быть строкой или объектом с свойством
type.Имя Тип Описание eventBaseEvent | string Объект события.
Возвращает:
false, если кто-то вызвал preventDefault у объекта события или любой из слушателей вернул false.
-
get(key){*} унаследованный
-
Получает значение.
Имя Тип Описание keystring Имя ключа.
Возвращает:
Значение.
-
getActive(){boolean} унаследованный
-
Возвращает, активен ли инструмент в данный момент.
Возвращает:
true, если инструмент активен,falseв противном случае.
-
getKeys(){Array.<string>} унаследованный
-
Получает список имён свойств объекта.
Возвращает:
Список имён свойств.
-
getMap(){Map | null} унаследованный
-
Получает карту, связанную с этим инструментом.
Возвращает:
Карту.
-
getProperties(){Object.<string, *>} унаследованный
-
Получает объект со всеми именами и значениями свойств.
Возвращает:
Объект.
-
getRevision(){number} унаследованный
-
Получает номер версии для этого объекта. Каждый раз, когда объект изменяется, его номер версии увеличивается.
Возвращает:
Номер ревизии.
-
handleEvent(mapBrowserEvent){boolean} унаследованный
-
Обрабатывает событие
map browser event.Имя Тип Описание mapBrowserEventMapBrowserEvent Событие браузера карты.
Возвращает:
falseдля остановки распространения события.
-
on(type, listener){EventsKey | Array<EventsKey>} унаследованный
-
Прислушивается к определённому типу события.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-слушатель.
Возвращает:
Уникальный ключ слушателя. Если вызван с массивом типов событий в качестве первого аргумента, возвращаемое значение будет массивом ключей.
-
once(type, listener){EventsKey | Array<EventsKey>} унаследованный
-
Прислушивается один раз к определённому типу события.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-слушатель.
Возвращает:
Уникальный ключ слушателя. Если вызван с массивом типов событий в качестве первого аргумента, возвращаемое значение будет массивом ключей.
-
set(key, value, silent) унаследованный
-
Устанавливает значение.
Имя Тип Описание keystring Имя ключа.
value* Значение.
silentboolean | undefined Обновление без срабатывания события.
-
setActive(active)
-
Активировать или деактивировать взаимодействие.
Имя Тип Описание activeboolean Активно.
-
setProperties(values, silent) унаследованный
-
Устанавливает коллекцию пар «ключ-значение». Обратите внимание, что это изменяет все существующие свойства и добавляет новые (не удаляет существующие свойства).
Имя Тип Описание valuesObject.<string, *> Значения.
silentboolean | undefined Обновление без срабатывания события.
-
un(type, listener) унаследованный
-
Отписывается от определённого типа события.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-слушатель.
-
unset(key, silent) унаследованный
-
Удаляет свойство.
Имя Тип Описание keystring Имя ключа.
silentboolean | 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