Package-level declarations

Types

Link copied to clipboard
external class Animation(val container: Element, val viewModel: AnimationViewModel)

The Animation widget provides buttons for play, pause, and reverse, along with the current time and date, surrounded by a "shuttle ring" for controlling the speed of animation.

Link copied to clipboard
external class AnimationViewModel(var clockViewModel: ClockViewModel)

The view model for the Animation widget.

Link copied to clipboard
external class BaseLayerPicker(var container: Element, options: BaseLayerPicker.ConstructorOptions)

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.

Link copied to clipboard
Link copied to clipboard
external class Cesium3DTilesInspector(var container: Element, scene: Scene)

Inspector widget to aid in debugging 3D Tiles

Link copied to clipboard
external class Cesium3DTilesInspectorViewModel(val scene: Scene, val performanceContainer: HTMLElement)

The view model for Cesium3DTilesInspector.

Link copied to clipboard
external class CesiumInspector(var container: Element, scene: Scene)

Inspector widget to aid in debugging

Link copied to clipboard
external class CesiumInspectorViewModel(var scene: Scene, var performanceContainer: Element)

The view model for CesiumInspector.

Link copied to clipboard
external class ClockViewModel(var clock: Clock = definedExternally)

A view model which exposes a Clock for user interfaces.

Link copied to clipboard
abstract external class Command

A Command is a function with an extra canExecute observable property to determine whether the command can be executed. When executed, a Command function will check the value of canExecute and throw if false.

Link copied to clipboard
typealias ComputeScreenSpacePosition = (position: Cartesian3, result: Cartesian2) -> Cartesian2

A function that converts the world position of an object to a screen space position.

Link copied to clipboard
typealias CreationFunction = () -> Any

A function which creates one or more providers.

Link copied to clipboard
typealias DateFormatter = (date: JulianDate, viewModel: AnimationViewModel) -> String

A function that formats a date for display.

Link copied to clipboard
typealias DestinationFoundFunction = (viewModel: GeocoderViewModel, destination: Any) -> Unit

A function that handles the result of a successful geocode.

Link copied to clipboard
external class FullscreenButton(var container: Element, fullscreenElement: Element? = definedExternally)

A single button widget for toggling fullscreen mode.

Link copied to clipboard
external class FullscreenButtonViewModel(var fullscreenElement: Element = definedExternally, container: Element? = definedExternally)

The view model for FullscreenButton.

Link copied to clipboard
external class Geocoder(options: Geocoder.ConstructorOptions)

A widget for finding addresses and landmarks, and flying the camera to them. Geocoding is performed using Cesium ion.

Link copied to clipboard

The view model for the Geocoder widget.

Link copied to clipboard
external class HomeButton(var container: Element, scene: Scene, duration: Double? = definedExternally)

A single button widget for returning to the default camera view of the current scene.

Link copied to clipboard
external class HomeButtonViewModel(var scene: Scene, duration: Double? = definedExternally)

The view model for HomeButton.

Link copied to clipboard
external class I3sBslExplorerViewModel(i3sProvider: I3SDataProvider)

The view model for I3SBuildingSceneLayerExplorer.

Link copied to clipboard
external class I3SBuildingSceneLayerExplorer(containerId: String, i3sProvider: I3SDataProvider)

I3S Building Scene Layer widget

Link copied to clipboard
external class InfoBox(var container: Element)

A widget for displaying information or a description.

Link copied to clipboard
external class InfoBoxViewModel

The view model for InfoBox.

Link copied to clipboard

The NavigationHelpButton is a single button widget for displaying instructions for navigating the globe with the mouse.


Link copied to clipboard

The view model for NavigationHelpButton.

Link copied to clipboard
external class PerformanceWatchdog(options: PerformanceWatchdog.ConstructorOptions? = definedExternally)

Monitors performance of the application and displays a message if poor performance is detected.

Link copied to clipboard

The view model for PerformanceWatchdog.

Link copied to clipboard
external class ProjectionPicker(var container: Element, scene: Scene)

The ProjectionPicker is a single button widget for switching between perspective and orthographic projections.

Link copied to clipboard
external class ProjectionPickerViewModel(var scene: Scene)

The view model for ProjectionPicker.

Link copied to clipboard

A view model that represents each item in the BaseLayerPicker.

Link copied to clipboard
external class SceneModePicker(var container: Element, scene: Scene, duration: Double? = definedExternally)

The SceneModePicker is a single button widget for switching between scene modes; shown to the left in its expanded state. Programatic switching of scene modes will be automatically reflected in the widget as long as the specified Scene is used to perform the change.


Link copied to clipboard
external class SceneModePickerViewModel(var scene: Scene, var duration: Double = definedExternally)

The view model for SceneModePicker.

Link copied to clipboard
external class SelectionIndicator(var container: Element, scene: Scene)

A widget for displaying an indicator on a selected object.

Link copied to clipboard
external class SelectionIndicatorViewModel(var scene: Scene, var selectionIndicatorElement: Element, var container: Element)

The view model for SelectionIndicator.

Link copied to clipboard
external object SvgPathBindingHandler

A Knockout binding handler that creates a DOM element for a single SVG path. This binding handler will be registered as cesiumSvgPath.

Link copied to clipboard
typealias TimeFormatter = (date: JulianDate, viewModel: AnimationViewModel) -> String

A function that formats a time for display.

Link copied to clipboard
external class Timeline(var container: Element, clock: Clock)

The Timeline is a widget for displaying and controlling the current scene time.

Link copied to clipboard
external class ToggleButtonViewModel(var command: Command)

A view model which exposes the properties of a toggle button.

Link copied to clipboard
external class Viewer(val container: Element, options: Viewer.ConstructorOptions? = definedExternally)

A base widget for building applications. It composites all of the standard Cesium widgets into one reusable package. The widget can always be extended by using mixins, which add functionality useful for a variety of applications.

Link copied to clipboard
external interface ViewerDragDropMixinOptions
Link copied to clipboard
typealias ViewerMixin = (viewer: Viewer, options: Any) -> Unit

A function that augments a Viewer instance with additional functionality.

Link copied to clipboard
external class VoxelInspector(var container: Element, scene: Scene)

Inspector widget to aid in debugging voxels

Link copied to clipboard
external class VoxelInspectorViewModel(val scene: Scene)

The view model for VoxelInspector.

Link copied to clipboard
external class VRButton(var container: Element, scene: Scene, vrElement: Element? = definedExternally)

A single button widget for toggling vr mode.

Link copied to clipboard
external class VRButtonViewModel(scene: Scene, var vrElement: Element = definedExternally)

The view model for VRButton.

Functions

Link copied to clipboard
external fun createCommand(func: Function<*>, canExecute: Boolean? = definedExternally)

Create a Command from a given function, for use with ViewModels.

Link copied to clipboard

A mixin which adds the Cesium3DTilesInspector widget 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.

Link copied to clipboard
external fun viewerCesiumInspectorMixin(viewer: Viewer)

A mixin which adds the CesiumInspector widget 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.

Link copied to clipboard
external fun viewerDragDropMixin(viewer: Viewer, options: ViewerDragDropMixinOptions? = definedExternally)

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.

Link copied to clipboard
external fun viewerPerformanceWatchdogMixin(viewer: Viewer, options: ViewerPerformanceWatchdogMixinOptions? = definedExternally)

A mixin which adds the PerformanceWatchdog widget 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.

Link copied to clipboard
external fun viewerVoxelInspectorMixin(viewer: Viewer)

A mixin which adds the VoxelInspector widget 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.