ChartDirector Ver 4.1 (ColdFusion Edition)

JsChartViewer.streamUpdate


Usage

streamUpdate(timeout)

Description

Refreshes the <IMG> that the JsChartViewer is bound to.

Unlike JsChartViewer.partialUpdate, this method does not send the JsChartViewer state to the server. It merely sends a new request to the server using the existing URL of the <IMG> tag.

If this method is called periodically (eg. using a Javascript timer), and the server sends the most updated chart for these requests, then the chart will appear to be automatically update.

One can always refresh an <IMG> tag using standard client side Javascript without using JsChartViewer at all. This method offers the following additional features:

Arguments

ArgumentDefaultDescription
timeout60If there is an existing non-completed streamUpdate request, the timeout value determines whether to abort the existing request, or to ignore the current request and continue with the existing request. If the existing request has been pending for longer than the timeout in seconds, it will be aborted, otherwise it will continue.

Return Value

True if the current streamUpdate request is sent out. False if the request is not sent out (due to an existing request that has not timeout).