AutoRefreshMenu.ViewerUpdateSettings

Syntax

ViewerUpdateSettings: object;

Description

The ViewerUpdateSettings property determines autoupdate parameters.

Comments

Use the setViewerUpdateSettings method to set the property value, and the getViewerUpdateSettings method to get the property value. Property value cannot be set from JSON.

Example

To execute the example, the HTML page must contain the ExpressBox component named expressBox (see Example of Creating the ExpressBox Component). Change report autoupdate period:

// Get report autoupdate menu by steps
ribbonView = expressBox.getRibbonView();
control = ribbonView.getControl();
auReMenuControl = control.getControlById("MainAutoRefreshButton");
autoRefreshMenu = auReMenuControl.getMenu();
// Get autoupdate parameters
updSettings = autoRefreshMenu.getViewerUpdateSettings()
// -> Object {updateByIntervalEnabled: false, autoUpdateByData: false, AutoUpdateInterval: 5, autoUpdateIntervalUnits: "Seconds"}
// Change report autoupdate period
updSettings.AutoUpdateInterval = 2
// Apply new settings
autoRefreshMenu.setViewerUpdateSettings(updSettings)

After executing the example report autoupdate period is changed.