diff --git a/content/en/docs/marketplace/platform-supported-content/widgets/charts/_index.md b/content/en/docs/marketplace/platform-supported-content/widgets/charts/_index.md index 324fd68a26c..bb3aa4cac96 100644 --- a/content/en/docs/marketplace/platform-supported-content/widgets/charts/_index.md +++ b/content/en/docs/marketplace/platform-supported-content/widgets/charts/_index.md @@ -94,6 +94,21 @@ The **Events** tab contains the **On click action** property. This action runs w 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**. +#### Refresh Time (in Seconds) {#refresh-time} + +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**. + +* **0** (default) – Automatic refresh is disabled. +* **Greater than 0** – The chart reloads all of its data sources this number of seconds after its last data update. + +Keep the following in mind: + +* 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. +* If a data source is still loading when the timer ends, it is not reloaded again. +* The chart keeps showing its current data while it reloads, so it does not go blank between refreshes. + +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. + ### General Section {#general} #### Enable Advanced Options {#enable-advanced-options} diff --git a/content/en/docs/refguide/modeling/pages/chart-widgets/charts-configuration.md b/content/en/docs/refguide/modeling/pages/chart-widgets/charts-configuration.md index 20f2d98a41b..b7b36c2c3f4 100644 --- a/content/en/docs/refguide/modeling/pages/chart-widgets/charts-configuration.md +++ b/content/en/docs/refguide/modeling/pages/chart-widgets/charts-configuration.md @@ -233,6 +233,8 @@ The properties above are common across the chart types. In this section, the pro * **Colors**: Contains the color of each slice, for example, green, #00FF00, rgb(0,255,0), rgba(0,255,0, 0.5) * **Refresh interval (ms)**: Refresh the chart in intervals of milliseconds, when set to 0 refresh is disabled + {{% 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 %}} + ### Area Chart **Series New or Edit** diff --git a/content/en/docs/refguide10/modeling/pages/chart-widgets/charts-configuration.md b/content/en/docs/refguide10/modeling/pages/chart-widgets/charts-configuration.md index f41c85f5a29..03ebe3957ab 100644 --- a/content/en/docs/refguide10/modeling/pages/chart-widgets/charts-configuration.md +++ b/content/en/docs/refguide10/modeling/pages/chart-widgets/charts-configuration.md @@ -229,6 +229,8 @@ The properties above are common across the chart types. In this section, the pro * **Colors**: Contains the color of each slice, for example, green, #00FF00, rgb(0,255,0), rgba(0,255,0, 0.5) * **Refresh interval (ms)**: Refresh the chart in intervals of milliseconds, when set to 0 refresh is disabled + {{% 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 %}} + ### Area Chart **Series New or Edit**