PrxMdService.setAutoUpdate

Syntax

setAutoUpdate(report: PP.Prx.Report, updateSettings: object, callback: PP.Delegate);

Parameters

report. Report, for which autoupdate is set up.

updateSettings. Autoupdate settings.

callback. Callback procedure.

Description

The setAutoUpdate method sets report autoupdate.

Comments

The updateSettings autoupdate settings have the following parameters:

updateByIntervalEnabled. The parameter determines use of periodic update. If it is set to True, periodic update is enabled, otherwise it is set to False.
AutoUpdateInterval. Periodic update interval.
autoUpdateIntervalUnits. Periodic update measurement unit.

Example

To execute this example, the HTML page must contain the ReportBox component named reportBox and the service used to work with a regular report named prxMbService (see. Example of the ReportBox Component Layout). Set up report autoupdate:

// Determine autoupdate settings - periodic update each 2 seconds
updateSettings = {updateByIntervalEnabled: true, AutoUpdateInterval: 2, autoUpdateIntervalUnits: "Seconds"};
report = reportBox.getSource();
// Apply settings
prxMbService.setAutoUpdate(report, updateSettings);
// Refresh report
reportBox.refreshAll();

After executing the example report autoupdate is set up.