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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cesium-kotlin

Kotlin/JS declarations for Cesium

The newest version!

// Automatically generated - do not modify!

@file:JsModule("cesium")

@file:Suppress(
    "EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)

package cesium

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

    /**
     * @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()
}