import defined from "../../Core/defined.js";
import destroyObject from "../../Core/destroyObject.js";
import DeveloperError from "../../Core/DeveloperError.js";
import FeatureDetection from "../../Core/FeatureDetection.js";
import knockout from "../../ThirdParty/knockout.js";
import getElement from "../getElement.js";
import BaseLayerPickerViewModel from "./BaseLayerPickerViewModel.js";
/**
*
*
*
BaseLayerPicker with its drop-panel open.
*
*
* The BaseLayerPicker is a single button widget that displays a panel of available imagery and
* terrain providers. When imagery is selected, the corresponding imagery layer is created and inserted
* as the base layer of the imagery collection; removing the existing base. When terrain is selected,
* it replaces the current terrain provider. Each item in the available providers list contains a name,
* a representative icon, and a tooltip to display more information when hovered. The list is initially
* empty, and must be configured before use, as illustrated in the below example.
*
* @alias BaseLayerPicker
* @constructor
*
* @param {Element|String} container The parent HTML container node or ID for this widget.
* @param {Object} options Object with the following properties:
* @param {Globe} options.globe The Globe to use.
* @param {ProviderViewModel[]} [options.imageryProviderViewModels=[]] The array of ProviderViewModel instances to use for imagery.
* @param {ProviderViewModel} [options.selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available imagery layer is used.
* @param {ProviderViewModel[]} [options.terrainProviderViewModels=[]] The array of ProviderViewModel instances to use for terrain.
* @param {ProviderViewModel} [options.selectedTerrainProviderViewModel] The view model for the current base terrain layer, if not supplied the first available terrain layer is used.
*
* @exception {DeveloperError} Element with id "container" does not exist in the document.
*
*
* @example
* // In HTML head, include a link to the BaseLayerPicker.css stylesheet,
* // and in the body, include:
*
* //Create the list of available providers we would like the user to select from.
* //This example uses 3, OpenStreetMap, The Black Marble, and a single, non-streaming world image.
* const imageryViewModels = [];
* imageryViewModels.push(new Cesium.ProviderViewModel({
* name : 'Open\u00adStreet\u00adMap',
* iconUrl : Cesium.buildModuleUrl('Widgets/Images/ImageryProviders/openStreetMap.png'),
* tooltip : 'OpenStreetMap (OSM) is a collaborative project to create a free editable \
* map of the world.\nhttp://www.openstreetmap.org',
* creationFunction : function() {
* return new Cesium.OpenStreetMapImageryProvider({
* url : 'https://a.tile.openstreetmap.org/'
* });
* }
* }));
*
* imageryViewModels.push(new Cesium.ProviderViewModel({
* name : 'Earth at Night',
* iconUrl : Cesium.buildModuleUrl('Widgets/Images/ImageryProviders/blackMarble.png'),
* tooltip : 'The lights of cities and villages trace the outlines of civilization \
* in this global view of the Earth at night as seen by NASA/NOAA\'s Suomi NPP satellite.',
* creationFunction : function() {
* return new Cesium.IonImageryProvider({ assetId: 3812 });
* }
* }));
*
* imageryViewModels.push(new Cesium.ProviderViewModel({
* name : 'Natural Earth\u00a0II',
* iconUrl : Cesium.buildModuleUrl('Widgets/Images/ImageryProviders/naturalEarthII.png'),
* tooltip : 'Natural Earth II, darkened for contrast.\nhttp://www.naturalearthdata.com/',
* creationFunction : function() {
* return new Cesium.TileMapServiceImageryProvider({
* url : Cesium.buildModuleUrl('Assets/Textures/NaturalEarthII')
* });
* }
* }));
*
* //Create a CesiumWidget without imagery, if you haven't already done so.
* const cesiumWidget = new Cesium.CesiumWidget('cesiumContainer', { imageryProvider: false });
*
* //Finally, create the baseLayerPicker widget using our view models.
* const layers = cesiumWidget.imageryLayers;
* const baseLayerPicker = new Cesium.BaseLayerPicker('baseLayerPickerContainer', {
* globe : cesiumWidget.scene.globe,
* imageryProviderViewModels : imageryViewModels
* });
*
* @see TerrainProvider
* @see ImageryProvider
* @see ImageryLayerCollection
*/
function BaseLayerPicker(container, options) {
//>>includeStart('debug', pragmas.debug);
if (!defined(container)) {
throw new DeveloperError("container is required.");
}
//>>includeEnd('debug');
container = getElement(container);
const viewModel = new BaseLayerPickerViewModel(options);
const element = document.createElement("button");
element.type = "button";
element.className = "cesium-button cesium-toolbar-button";
element.setAttribute(
"data-bind",
"\
attr: { title: buttonTooltip },\
click: toggleDropDown"
);
container.appendChild(element);
const imgElement = document.createElement("img");
imgElement.setAttribute("draggable", "false");
imgElement.className = "cesium-baseLayerPicker-selected";
imgElement.setAttribute(
"data-bind",
"\
attr: { src: buttonImageUrl }, visible: !!buttonImageUrl"
);
element.appendChild(imgElement);
const dropPanel = document.createElement("div");
dropPanel.className = "cesium-baseLayerPicker-dropDown";
dropPanel.setAttribute(
"data-bind",
'\
css: { "cesium-baseLayerPicker-dropDown-visible" : dropDownVisible }'
);
container.appendChild(dropPanel);
const imageryTitle = document.createElement("div");
imageryTitle.className = "cesium-baseLayerPicker-sectionTitle";
imageryTitle.setAttribute(
"data-bind",
"visible: imageryProviderViewModels.length > 0"
);
imageryTitle.innerHTML = "Imagery";
dropPanel.appendChild(imageryTitle);
const imagerySection = document.createElement("div");
imagerySection.className = "cesium-baseLayerPicker-section";
imagerySection.setAttribute("data-bind", "foreach: _imageryProviders");
dropPanel.appendChild(imagerySection);
const imageryCategories = document.createElement("div");
imageryCategories.className = "cesium-baseLayerPicker-category";
imagerySection.appendChild(imageryCategories);
const categoryTitle = document.createElement("div");
categoryTitle.className = "cesium-baseLayerPicker-categoryTitle";
categoryTitle.setAttribute("data-bind", "text: name");
imageryCategories.appendChild(categoryTitle);
const imageryChoices = document.createElement("div");
imageryChoices.className = "cesium-baseLayerPicker-choices";
imageryChoices.setAttribute("data-bind", "foreach: providers");
imageryCategories.appendChild(imageryChoices);
const imageryProvider = document.createElement("div");
imageryProvider.className = "cesium-baseLayerPicker-item";
imageryProvider.setAttribute(
"data-bind",
'\
css: { "cesium-baseLayerPicker-selectedItem" : $data === $parents[1].selectedImagery },\
attr: { title: tooltip },\
visible: creationCommand.canExecute,\
click: function($data) { $parents[1].selectedImagery = $data; }'
);
imageryChoices.appendChild(imageryProvider);
const providerIcon = document.createElement("img");
providerIcon.className = "cesium-baseLayerPicker-itemIcon";
providerIcon.setAttribute("data-bind", "attr: { src: iconUrl }");
providerIcon.setAttribute("draggable", "false");
imageryProvider.appendChild(providerIcon);
const providerLabel = document.createElement("div");
providerLabel.className = "cesium-baseLayerPicker-itemLabel";
providerLabel.setAttribute("data-bind", "text: name");
imageryProvider.appendChild(providerLabel);
const terrainTitle = document.createElement("div");
terrainTitle.className = "cesium-baseLayerPicker-sectionTitle";
terrainTitle.setAttribute(
"data-bind",
"visible: terrainProviderViewModels.length > 0"
);
terrainTitle.innerHTML = "Terrain";
dropPanel.appendChild(terrainTitle);
const terrainSection = document.createElement("div");
terrainSection.className = "cesium-baseLayerPicker-section";
terrainSection.setAttribute("data-bind", "foreach: _terrainProviders");
dropPanel.appendChild(terrainSection);
const terrainCategories = document.createElement("div");
terrainCategories.className = "cesium-baseLayerPicker-category";
terrainSection.appendChild(terrainCategories);
const terrainCategoryTitle = document.createElement("div");
terrainCategoryTitle.className = "cesium-baseLayerPicker-categoryTitle";
terrainCategoryTitle.setAttribute("data-bind", "text: name");
terrainCategories.appendChild(terrainCategoryTitle);
const terrainChoices = document.createElement("div");
terrainChoices.className = "cesium-baseLayerPicker-choices";
terrainChoices.setAttribute("data-bind", "foreach: providers");
terrainCategories.appendChild(terrainChoices);
const terrainProvider = document.createElement("div");
terrainProvider.className = "cesium-baseLayerPicker-item";
terrainProvider.setAttribute(
"data-bind",
'\
css: { "cesium-baseLayerPicker-selectedItem" : $data === $parents[1].selectedTerrain },\
attr: { title: tooltip },\
visible: creationCommand.canExecute,\
click: function($data) { $parents[1].selectedTerrain = $data; }'
);
terrainChoices.appendChild(terrainProvider);
const terrainProviderIcon = document.createElement("img");
terrainProviderIcon.className = "cesium-baseLayerPicker-itemIcon";
terrainProviderIcon.setAttribute("data-bind", "attr: { src: iconUrl }");
terrainProviderIcon.setAttribute("draggable", "false");
terrainProvider.appendChild(terrainProviderIcon);
const terrainProviderLabel = document.createElement("div");
terrainProviderLabel.className = "cesium-baseLayerPicker-itemLabel";
terrainProviderLabel.setAttribute("data-bind", "text: name");
terrainProvider.appendChild(terrainProviderLabel);
knockout.applyBindings(viewModel, element);
knockout.applyBindings(viewModel, dropPanel);
this._viewModel = viewModel;
this._container = container;
this._element = element;
this._dropPanel = dropPanel;
this._closeDropDown = function (e) {
if (!(element.contains(e.target) || dropPanel.contains(e.target))) {
viewModel.dropDownVisible = false;
}
};
if (FeatureDetection.supportsPointerEvents()) {
document.addEventListener("pointerdown", this._closeDropDown, true);
} else {
document.addEventListener("mousedown", this._closeDropDown, true);
document.addEventListener("touchstart", this._closeDropDown, true);
}
}
Object.defineProperties(BaseLayerPicker.prototype, {
/**
* Gets the parent container.
* @memberof BaseLayerPicker.prototype
*
* @type {Element}
*/
container: {
get: function () {
return this._container;
},
},
/**
* Gets the view model.
* @memberof BaseLayerPicker.prototype
*
* @type {BaseLayerPickerViewModel}
*/
viewModel: {
get: function () {
return this._viewModel;
},
},
});
/**
* @returns {Boolean} true if the object has been destroyed, false otherwise.
*/
BaseLayerPicker.prototype.isDestroyed = function () {
return false;
};
/**
* Destroys the widget. Should be called if permanently
* removing the widget from layout.
*/
BaseLayerPicker.prototype.destroy = function () {
if (FeatureDetection.supportsPointerEvents()) {
document.removeEventListener("pointerdown", this._closeDropDown, true);
} else {
document.removeEventListener("mousedown", this._closeDropDown, true);
document.removeEventListener("touchstart", this._closeDropDown, true);
}
knockout.cleanNode(this._element);
knockout.cleanNode(this._dropPanel);
this._container.removeChild(this._element);
this._container.removeChild(this._dropPanel);
return destroyObject(this);
};
export default BaseLayerPicker;