All Downloads are FREE. Search and download functionalities are using the official Maven repository.

main.cesium.BaseLayerPicker.kt Maven / Gradle / Ivy

There is a newer version: 1.90.0-10
Show newest version
// Automatically generated - do not modify!

@file:Suppress(
    "NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
    "EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)

package cesium

/**
 * 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.
 * ```
 * // 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. * var imageryViewModels = []; * imageryViewModels.push(new ProviderViewModel({ * name : 'Open\u00adStreet\u00adMap', * iconUrl : 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 OpenStreetMapImageryProvider({ * url : 'https://a.tile.openstreetmap.org/' * }); * } * })); * * imageryViewModels.push(new ProviderViewModel({ * name : 'Earth at Night', * iconUrl : 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 IonImageryProvider({ assetId: 3812 }); * } * })); * * imageryViewModels.push(new ProviderViewModel({ * name : 'Natural Earth\u00a0II', * iconUrl : buildModuleUrl('Widgets/Images/ImageryProviders/naturalEarthII.png'), * tooltip : 'Natural Earth II, darkened for contrast.\nhttp://www.naturalearthdata.com/', * creationFunction : function() { * return new TileMapServiceImageryProvider({ * url : buildModuleUrl('Assets/Textures/NaturalEarthII') * }); * } * })); * * //Create a CesiumWidget without imagery, if you haven't already done so. * var cesiumWidget = new CesiumWidget('cesiumContainer', { imageryProvider: false }); * * //Finally, create the baseLayerPicker widget using our view models. * var layers = cesiumWidget.imageryLayers; * var baseLayerPicker = new BaseLayerPicker('baseLayerPickerContainer', { * globe : cesiumWidget.scene.globe, * imageryProviderViewModels : imageryViewModels * }); * ``` * @see Online Documentation * * @constructor * @property [container] The parent HTML container node or ID for this widget. * @see Online Documentation */ @JsName("\$cesium__BaseLayerPicker") external class BaseLayerPicker( var container: org.w3c.dom.Element, options: ConstructorOptions, ) { /** * @property [globe] The Globe to use. * @property [imageryProviderViewModels] The array of ProviderViewModel instances to use for imagery. * Default value - `[]` * @property [selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available imagery layer is used. * @property [terrainProviderViewModels] The array of ProviderViewModel instances to use for terrain. * Default value - `[]` * @property [selectedTerrainProviderViewModel] The view model for the current base terrain layer, if not supplied the first available terrain layer is used. */ interface ConstructorOptions { var globe: Globe var imageryProviderViewModels: Array? var selectedImageryProviderViewModel: ProviderViewModel? var terrainProviderViewModels: Array? var selectedTerrainProviderViewModel: ProviderViewModel? } /** * Gets the view model. * @see Online Documentation */ var viewModel: BaseLayerPickerViewModel /** * @return true if the object has been destroyed, false otherwise. * @see Online Documentation */ fun isDestroyed(): Boolean /** * Destroys the widget. Should be called if permanently * removing the widget from layout. * @see Online Documentation */ fun destroy() }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy