Skip to content

Commit d16811f

Browse files
committed
Document Refresh time (in seconds) property for pluggable Charts
1 parent 61b1db0 commit d16811f

2 files changed

Lines changed: 17 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
@@ -70,6 +70,21 @@ Beside the **General** tab you will find 3 more tabs in the **Edit Series** dial
7070
* **Events** – This lists possible event triggers.
7171
* **Advanced** – This uses one field which will hold a JSON object with advanced configuration for this data series.
7272

73+
#### Refresh Time (in Seconds) {#refresh-time}
74+
75+
The **Refresh time (in seconds)** property reloads a chart's data automatically. You can find it at the end of the **Data source** section on the **General** tab. It is available for all chart types except **Custom chart**.
76+
77+
* **0** (default) – Automatic refresh is disabled.
78+
* **Greater than 0** – The chart reloads all of its data sources this number of seconds after its data was last updated.
79+
80+
Keep the following in mind:
81+
82+
* 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.
83+
* If a data source is still loading when the timer ends, it is not reloaded again.
84+
* The chart keeps showing its current data while it reloads, so it does not go blank between refreshes.
85+
86+
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.
87+
7388
### General
7489

7590
#### Enable Developer Mode

‎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
@@ -224,6 +224,8 @@ The properties above are common across the chart types. In this section, the pro
224224
* **Colors**: Contains the color of each slice, for example, green, #00FF00, rgb(0,255,0), rgba(0,255,0, 0.5)
225225
* **Refresh interval (ms)**: Refresh the chart in intervals of milliseconds, when set to 0 refresh is disabled
226226

227+
{{% alert color="info" %}}This property only applies to the chart widgets described in this document. The pluggable Charts widgets (Charts v3.0.0 and above) use 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 %}}
228+
227229
### Area Chart
228230

229231
**Series New or Edit**

0 commit comments

Comments
 (0)