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

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

The newest version!
// Automatically generated - do not modify!

@file:JsModule("cesium")

@file:Suppress(
    "EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)

package cesium

/**
 * The view model for [FullscreenButton].
 * @see Online Documentation
 *
 * @constructor
 * @property [fullscreenElement] The element or id to be placed into fullscreen mode.
 *   Default value - `document.body`
 * @param [container] The DOM element that will contain the widget.
 * @see Online Documentation
 */
external class FullscreenButtonViewModel(
    var fullscreenElement: org.w3c.dom.Element = definedExternally,
    container: org.w3c.dom.Element? = definedExternally,
) {
    /**
     * Gets whether or not fullscreen mode is active.  This property is observable.
     * @see Online Documentation
     */
    var isFullscreen: Boolean

    /**
     * Gets or sets whether or not fullscreen functionality should be enabled.  This property is observable.
     * @see Online Documentation
     */
    var isFullscreenEnabled: Boolean

    /**
     * Gets the tooltip.  This property is observable.
     * @see Online Documentation
     */
    var tooltip: String

    /**
     * Gets the Command to toggle fullscreen mode.
     * @see Online Documentation
     */
    var command: Command

    /**
     * @return true if the object has been destroyed, false otherwise.
     * @see Online Documentation
     */
    fun isDestroyed(): Boolean

    /**
     * Destroys the view model.  Should be called to
     * properly clean up the view model when it is no longer needed.
     * @see Online Documentation
     */
    fun destroy()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy