Skip to content

Commit c4c50f4

Browse files
committed
Document Refresh time (in seconds) property for pluggable Charts
1 parent 1fd3ea0 commit c4c50f4

3 files changed

Lines changed: 19 additions & 0 deletions

File tree

‎content/en/docs/marketplace/platform-supported-content/widgets/charts/_index.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,21 @@ The **Events** tab contains the **On click action** property. This action runs w
9494

9595
The **Advanced** tab contains the **Custom series options** property. This property holds a JSON object with advanced configuration for this series. For more information, see [Custom Series Settings](#custom-series-settings). This property is visible only when [Enable advanced options](#enable-advanced-options) is set to **Yes**.
9696

97+
#### Refresh Time (in Seconds) {#refresh-time}
98+
99+
The **Refresh time (in seconds)** property reloads a chart's data automatically. It is the last property in the **Data source** section. It is available for all chart types except **Custom chart**.
100+
101+
* **0** (default) – Automatic refresh is disabled.
102+
* **Greater than 0** – The chart reloads all of its data sources this number of seconds after its data was last updated.
103+
104+
Keep the following in mind:
105+
106+
* The timer restarts every time the chart's data is updated. This means the chart reloads a set time after the most recent update, not at a fixed clock interval.
107+
* If a data source is still loading when the timer ends, it is not reloaded again.
108+
* The chart keeps showing its current data while it reloads, so it does not go blank between refreshes.
109+
110+
Use this property when a chart cannot detect that its data has changed, for example when it shows data from a view entity or aggregated data.
111+
97112
### General Section {#general}
98113

99114
#### Enable Advanced Options {#enable-advanced-options}

‎content/en/docs/refguide/modeling/pages/chart-widgets/charts-configuration.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,8 @@ The properties above are common across the chart types. In this section, the pro
233233
* **Colors**: Contains the color of each slice, for example, green, #00FF00, rgb(0,255,0), rgba(0,255,0, 0.5)
234234
* **Refresh interval (ms)**: Refresh the chart in intervals of milliseconds, when set to 0 refresh is disabled
235235

236+
{{% alert color="info" %}}The current Charts module (v3.0.0 and above) uses the **Refresh time (in seconds)** property instead, which is set in seconds rather than milliseconds. For details, see the [Refresh Time (in Seconds)](/appstore/widgets/charts/#refresh-time) section of *Charts*.{{% /alert %}}
237+
236238
### Area Chart
237239

238240
**Series New or Edit**

‎content/en/docs/refguide10/modeling/pages/chart-widgets/charts-configuration.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,8 @@ The properties above are common across the chart types. In this section, the pro
229229
* **Colors**: Contains the color of each slice, for example, green, #00FF00, rgb(0,255,0), rgba(0,255,0, 0.5)
230230
* **Refresh interval (ms)**: Refresh the chart in intervals of milliseconds, when set to 0 refresh is disabled
231231

232+
{{% alert color="info" %}}The current Charts module (v3.0.0 and above) uses the **Refresh time (in seconds)** property instead, which is set in seconds rather than milliseconds. For details, see the [Refresh Time (in Seconds)](/appstore/widgets/charts/#refresh-time) section of *Charts*.{{% /alert %}}
233+
232234
### Area Chart
233235

234236
**Series New or Edit**

0 commit comments

Comments
 (0)