viewerDragDropMixin

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.

Parameters:

Name Type Argument Description

viewer Viewer The viewer instance.

options

Object

Configuration options for the mixin.

Properties

Name	Type	Argument	Default	Description
`dropTarget`	Element \| String	<optional>	viewer.container	The DOM element which will serve as the drop target.
`clearOnDrop`	Boolean	<optional>	true	When true, dropping files will clear all existing data sources first, when false, new data sources will be loaded after the existing ones.

Throws:

DeveloperError : viewer is required.
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 : onDropError 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 Viewer('cesiumContainer');
viewer.extend(viewerDragDropMixin);
viewer.onDropError.addEventListener(function(viewerArg, source, error) {
    window.alert('Error processing ' + source + ':' + error);
});

Source:

/Source/Widgets/Viewer/viewerDragDropMixin.js

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.

dropTarget :Element

Gets or sets the element to serve as the drop target.

onDropError :Event

Gets the event that will be raised when an error is encountered during drop processing.