viewerDragDropMixin(viewer, options)
A mixin which adds default drag and drop support for CZML files to the Viewer widget.
Rather than being called directly, this function is normally passed as
a parameter to
Viewer#extend, as shown in the example below.
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
viewer |
Viewer | The viewer instance. | ||||||||||||
options |
Object |
optional
Object with the following properties:
|
Throws:
-
DeveloperError : Element with id
does not exist in the document. -
DeveloperError : dropTarget is already defined by another mixin.
-
DeveloperError : dropEnabled is already defined by another mixin.
-
DeveloperError : dropError is already defined by another mixin.
-
DeveloperError : clearOnDrop is already defined by another mixin.
Example:
// Add basic drag and drop support and pop up an alert window on error.
var viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerDragDropMixin);
viewer.dropError.addEventListener(function(viewerArg, source, error) {
window.alert('Error processing ' + source + ':' + error);
});Members
-
clearOnDrop :Boolean
-
Gets or sets a value indicating if existing data sources should be cleared before adding the newly dropped sources.
-
dropEnabled :Element
-
Gets or sets a value indicating if drag and drop support is enabled.
-
dropError :Event
-
Gets the event that will be raised when an error is encountered during drop processing.
-
dropTarget :Element
-
Gets or sets the element to serve as the drop target.