main.cesium.PerformanceWatchdog.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* Monitors performance of the application and displays a message if poor performance is detected.
* @see Online Documentation
*/
@JsName("\$cesium__PerformanceWatchdog")
external class PerformanceWatchdog(options: ConstructorOptions? = definedExternally) {
/**
* @property [container] The DOM element that will contain the widget.
* @property [scene] The [Scene] for which to monitor performance.
* @property [lowFrameRateMessage] The
* message to display when a low frame rate is detected. The message is interpeted as HTML, so make sure
* it comes from a trusted source so that your application is not vulnerable to cross-site scripting attacks.
* Default value - `'This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.'`
*/
interface ConstructorOptions {
var container: org.w3c.dom.Element
var scene: Scene
var lowFrameRateMessage: String?
}
/**
* Gets the parent container.
* @see Online Documentation
*/
var container: org.w3c.dom.Element
/**
* Gets the view model.
* @see Online Documentation
*/
var viewModel: PerformanceWatchdogViewModel
/**
* @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()
}