Class: PerformanceWatchdog

PerformanceWatchdog

new PerformanceWatchdog(optionsopt)

Monitors performance of the application and displays a message if poor performance is detected.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
container Element | String The DOM element or ID that will contain the widget.
scene Scene The Scene for which to monitor performance.
lowFrameRateMessage String <optional>
 'This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.' 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.
Source:

Members

container :Element

Gets the parent container.
Type:
  • Element
Source:

viewModel :PerformanceWatchdogViewModel

Gets the view model.
Type:
Source:

Methods

destroy()

Destroys the widget. Should be called if permanently removing the widget from layout.
Source:

isDestroyed() → {Boolean}

Source:
Returns:
true if the object has been destroyed, false otherwise.
Type
Boolean