main.cesium.NavigationHelpButton.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* The NavigationHelpButton is a single button widget for displaying instructions for
* navigating the globe with the mouse.
* ```
* // In HTML head, include a link to the NavigationHelpButton.css stylesheet,
* // and in the body, include:
*
* var navigationHelpButton = new NavigationHelpButton({
* container : 'navigationHelpButtonContainer'
* });
* ```
* @see Online Documentation
*/
@JsName("\$cesium__NavigationHelpButton")
external class NavigationHelpButton(options: ConstructorOptions) {
/**
* @property [container] The DOM element that will contain the widget.
* @property [instructionsInitiallyVisible] True if the navigation instructions should initially be visible; otherwise, false.
* Default value - `false`
*/
interface ConstructorOptions {
var container: org.w3c.dom.Element
var instructionsInitiallyVisible: Boolean?
}
/**
* Gets the parent container.
* @see Online Documentation
*/
var container: org.w3c.dom.Element
/**
* Gets the view model.
* @see Online Documentation
*/
var viewModel: NavigationHelpButtonViewModel
/**
* @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()
}