main.cesium.viewerDragDropMixin.kt Maven / Gradle / Ivy
The newest version!
// Automatically generated - do not modify!
@file:JsModule("cesium")
package cesium
/**
* 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.
* ```
* // Add basic drag and drop support and pop up an alert window on error.
* const viewer = new Viewer('cesiumContainer');
* viewer.extend(viewerDragDropMixin);
* viewer.dropError.addEventListener(function(viewerArg, source, error) {
* window.alert('Error processing ' + source + ':' + error);
* });
* ```
* @param [viewer] The viewer instance.
* @see Online Documentation
*/
external fun viewerDragDropMixin(
viewer: Viewer,
options: ViewerDragDropMixinOptions? = definedExternally,
)
/**
* @property [dropTarget] The DOM element which will serve as the drop target.
* Default value - [viewer.container]
* @property [clearOnDrop] When true, dropping files will clear all existing data sources first, when false, new data sources will be loaded after the existing ones.
* Default value - `true`
* @property [flyToOnDrop] When true, dropping files will fly to the data source once it is loaded.
* Default value - `true`
* @property [clampToGround] When true, datasources are clamped to the ground.
* Default value - `true`
* @property [proxy] The proxy to be used for KML network links.
*/
external interface ViewerDragDropMixinOptions {
var dropTarget: org.w3c.dom.Element?
var clearOnDrop: Boolean?
var flyToOnDrop: Boolean?
var clampToGround: Boolean?
var proxy: Proxy?
}