Skip to main content
All docs
V24.1

PollingDelay Function

Specifies the wait time needed before a request about the document generation status is sent.

Declaration

export const PollingDelay: DevExpress.Analytics.Internal.IGlobalSubscribableValue<number>

Parameters

Name Type
newVal number

Returns

Type
number

Remarks

The PollingDelay parameter allows you to configure polling requests. The value is specified in milliseconds and defines the interval between requests sent by the Document Viewer. The initial value is 300 ms.

You can use the PollingDelay setting to adjust the document generation progress indicator behavior.

You can initialize the PollingDelay property using the client-side BeforeRender event handler, as the following code snippet illustrates:

function Viewer_BeforeRender(s, e) {
    DevExpress.Reporting.Viewer.Settings.PollingDelay(1000); //Set polling delay to 1000ms
    DevExpress.Reporting.Viewer.Settings.TimeOut(45000); //Set timeout to 45000ms
}

For more information, review the following help topic: Document Viewer Lifecycle.