Class: DragAndDrop

ol/interaction/DragAndDrop~DragAndDrop 


import DragAndDrop from 'ol/interaction/DragAndDrop';

Handles input of vector data by drag and drop.

new DragAndDrop(opt_options)

interaction/DragAndDrop.js, line 86
Name Type Description
options

Options.

Name Type Description
formatConstructors Array.<Class.<module:ol/format/Feature~FeatureFormat>>

Format constructors.
source module:ol/source/Vector~VectorSource

Optional vector source where features will be added. If a source is provided all existing features will be removed and new features will be added when they are dropped on the target. If you want to add features to a vector source without removing the existing features (append only), instead of providing the source option listen for the "addfeatures" event.
projection module:ol/proj~ProjectionLike

Target projection. By default, the map's view's projection is used.
target HTMLElement

The element that is used as the drop target, default is the viewport element.
Fires:

Extends

Observable Properties

Name Type Settable ol/Object.ObjectEvent type Description
active boolean yes change:active

true if the interaction is active, false otherwise.

Methods

changed() inherited

Observable.js, line 34

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event module:ol/events/Event~BaseEvent | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 113

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getActive(){boolean} inherited

interaction/Interaction.js, line 58

Return whether the interaction is currently active.

Returns:
true if the interaction is active, false otherwise.

getKeys(){Array.<string>} inherited

Object.js, line 126

Get a list of object property names.

Returns:
List of property names.

getMap(){module:ol/PluggableMap~PluggableMap} inherited

interaction/Interaction.js, line 67

Get the map associated with this interaction.

Returns:
Map.

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

Object.js, line 135

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 45

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

handleEvent(mapBrowserEvent){boolean} inherited

interaction/Interaction.js, line 77

Handles the map browser event.

Name Type Description
mapBrowserEvent module:ol/MapBrowserEvent~MapBrowserEvent

Map browser event.
Returns:
false to stop event propagation.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 58

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 80

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, opt_silent) inherited

Object.js, line 165

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setActive(active)

interaction/DragAndDrop.js, line 188

Activate or deactivate the interaction.

Name Type Description
active boolean

Active.

setProperties(values, opt_silent) inherited

Object.js, line 185

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.
silent boolean

Update without triggering an event.

un(type, listener) inherited

Observable.js, line 101

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.

unset(key, opt_silent) inherited

Object.js, line 197

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.