Package-level declarations

Types

external class Animation(val container: ERROR CLASS: Symbol not found for 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.

AnimationViewModel

external class AnimationViewModel(var clockViewModel: ClockViewModel)

The view model for the Animation widget.

BaseLayerPicker

external class BaseLayerPicker(var container: ERROR CLASS: Symbol not found for 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.

BaseLayerPickerViewModel

external class BaseLayerPickerViewModel(options: BaseLayerPickerViewModel.ConstructorOptions)

The view model for BaseLayerPicker.

Cesium3DTilesInspector

external class Cesium3DTilesInspector(var container: ERROR CLASS: Symbol not found for Element, scene: ERROR CLASS: Symbol not found for Scene)

Inspector widget to aid in debugging 3D Tiles

Cesium3DTilesInspectorViewModel

external class Cesium3DTilesInspectorViewModel(val scene: ERROR CLASS: Symbol not found for Scene, val performanceContainer: ERROR CLASS: Symbol not found for HTMLElement)

The view model for Cesium3DTilesInspector.

CesiumInspector

external class CesiumInspector(var container: ERROR CLASS: Symbol not found for Element, scene: ERROR CLASS: Symbol not found for Scene)

Inspector widget to aid in debugging

CesiumInspectorViewModel

external class CesiumInspectorViewModel(var scene: ERROR CLASS: Symbol not found for Scene, var performanceContainer: ERROR CLASS: Symbol not found for Element)

The view model for CesiumInspector.

ClockViewModel

external class ClockViewModel(var clock: ERROR CLASS: Symbol not found for Clock = definedExternally)

A view model which exposes a Clock for user interfaces.

Command

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.

ComputeScreenSpacePosition

typealias ComputeScreenSpacePosition = (@R|kotlin/ParameterName|(name = String(position)) ERROR CLASS: Symbol not found for Cartesian3, @R|kotlin/ParameterName|(name = String(result)) ERROR CLASS: Symbol not found for Cartesian2) -> ERROR CLASS: Symbol not found for Cartesian2

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

CreationFunction

typealias CreationFunction = () -> ERROR CLASS: Symbol not found for JsAny

A function which creates one or more providers.

DateFormatter

typealias DateFormatter = (@R|kotlin/ParameterName|(name = String(date)) ERROR CLASS: Symbol not found for JulianDate, viewModel: AnimationViewModel) -> String

A function that formats a date for display.

DestinationFoundFunction

typealias DestinationFoundFunction = (viewModel: GeocoderViewModel, @R|kotlin/ParameterName|(name = String(destination)) ERROR CLASS: Symbol not found for JsAny) -> Unit

A function that handles the result of a successful geocode.

FullscreenButton

external class FullscreenButton(var container: ERROR CLASS: Symbol not found for Element, fullscreenElement: ERROR CLASS: Symbol not found for Element?? = definedExternally)

A single button widget for toggling fullscreen mode.

FullscreenButtonViewModel

external class FullscreenButtonViewModel(var fullscreenElement: ERROR CLASS: Symbol not found for Element = definedExternally, container: ERROR CLASS: Symbol not found for Element?? = definedExternally)

The view model for FullscreenButton.

Geocoder

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.

GeocoderViewModel

external class GeocoderViewModel(options: GeocoderViewModel.ConstructorOptions)

The view model for the Geocoder widget.

HomeButton

external class HomeButton(var container: ERROR CLASS: Symbol not found for Element, scene: ERROR CLASS: Symbol not found for Scene, duration: Double? = definedExternally)

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

HomeButtonViewModel

external class HomeButtonViewModel(var scene: ERROR CLASS: Symbol not found for Scene, duration: Double? = definedExternally)

The view model for HomeButton.

I3sBslExplorerViewModel

external class I3sBslExplorerViewModel(i3sProvider: ERROR CLASS: Symbol not found for I3SDataProvider)

The view model for I3SBuildingSceneLayerExplorer.

I3SBuildingSceneLayerExplorer

external class I3SBuildingSceneLayerExplorer(containerId: String, i3sProvider: ERROR CLASS: Symbol not found for I3SDataProvider)

I3S Building Scene Layer widget

InfoBox

external class InfoBox(var container: ERROR CLASS: Symbol not found for Element)

A widget for displaying information or a description.

InfoBoxViewModel

external class InfoBoxViewModel

The view model for InfoBox.

NavigationHelpButton

external class NavigationHelpButton(options: NavigationHelpButton.ConstructorOptions)

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

NavigationHelpButtonViewModel

external class NavigationHelpButtonViewModel

The view model for NavigationHelpButton.

PerformanceWatchdog

external class PerformanceWatchdog(options: PerformanceWatchdog.ConstructorOptions? = definedExternally)

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

PerformanceWatchdogViewModel

external class PerformanceWatchdogViewModel

The view model for PerformanceWatchdog.

ProjectionPicker

external class ProjectionPicker(var container: ERROR CLASS: Symbol not found for Element, scene: ERROR CLASS: Symbol not found for Scene)

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

ProjectionPickerViewModel

external class ProjectionPickerViewModel(var scene: ERROR CLASS: Symbol not found for Scene)

The view model for ProjectionPicker.

ProviderViewModel

external class ProviderViewModel(options: ProviderViewModel.ConstructorOptions)

A view model that represents each item in the BaseLayerPicker.

SceneModePicker

external class SceneModePicker(var container: ERROR CLASS: Symbol not found for Element, scene: ERROR CLASS: Symbol not found for 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.

SceneModePickerViewModel

external class SceneModePickerViewModel(var scene: ERROR CLASS: Symbol not found for Scene, var duration: Double = definedExternally)

The view model for SceneModePicker.

SelectionIndicator

external class SelectionIndicator(var container: ERROR CLASS: Symbol not found for Element, scene: ERROR CLASS: Symbol not found for Scene)

A widget for displaying an indicator on a selected object.

SelectionIndicatorViewModel

external class SelectionIndicatorViewModel(var scene: ERROR CLASS: Symbol not found for Scene, var selectionIndicatorElement: ERROR CLASS: Symbol not found for Element, var container: ERROR CLASS: Symbol not found for Element)

The view model for SelectionIndicator.

SvgPathBindingHandler

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.

TimeFormatter

typealias TimeFormatter = (@R|kotlin/ParameterName|(name = String(date)) ERROR CLASS: Symbol not found for JulianDate, viewModel: AnimationViewModel) -> String

A function that formats a time for display.

Timeline

external class Timeline(var container: ERROR CLASS: Symbol not found for Element, clock: ERROR CLASS: Symbol not found for Clock)

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

ToggleButtonViewModel

external class ToggleButtonViewModel(var command: Command)

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

Viewer

external class Viewer(val container: ERROR CLASS: Symbol not found for 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.

ViewerDragDropMixinOptions

external interface ViewerDragDropMixinOptions

ViewerMixin

typealias ViewerMixin = (viewer: Viewer, @R|kotlin/ParameterName|(name = String(options)) ERROR CLASS: Symbol not found for JsAny) -> Unit

A function that augments a Viewer instance with additional functionality.

ViewerPerformanceWatchdogMixinOptions

external interface ViewerPerformanceWatchdogMixinOptions

VoxelInspector

external class VoxelInspector(var container: ERROR CLASS: Symbol not found for Element, scene: ERROR CLASS: Symbol not found for Scene)

Inspector widget to aid in debugging voxels

VoxelInspectorViewModel

external class VoxelInspectorViewModel(val scene: ERROR CLASS: Symbol not found for Scene)

The view model for VoxelInspector.

VRButton

external class VRButton(var container: ERROR CLASS: Symbol not found for Element, scene: ERROR CLASS: Symbol not found for Scene, vrElement: ERROR CLASS: Symbol not found for Element?? = definedExternally)

A single button widget for toggling vr mode.

VRButtonViewModel

external class VRButtonViewModel(scene: ERROR CLASS: Symbol not found for Scene, var vrElement: ERROR CLASS: Symbol not found for Element = definedExternally)

The view model for VRButton.

Functions

createCommand

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

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

viewerCesium3DTilesInspectorMixin

external fun viewerCesium3DTilesInspectorMixin(viewer: Viewer)

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.

viewerCesiumInspectorMixin

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.

viewerDragDropMixin

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.

viewerPerformanceWatchdogMixin

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.

viewerVoxelInspectorMixin

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.