Auto Refresh settings for the dashboard

To configure the refresh settings for a dashboard, in Dashboard Designer, follow the steps below:

1. Create/Open a dashboard in Designer
2. Navigate to the Server menu, and click Refresh Settings…

The Refresh Settings popup will appear in the designer as in the below image:

This dialog has two options:

• Enable Client-side Caching
• Enable Auto Refresh and

1. Check the Enable Auto Refresh,
2. Click Apply, to preview the dashboard with refresh internal as 30 seconds by default.

Note: The default time interval for the auto refresh will be 30 seconds.

How to customize the Timer for the Auto Refresh of the dashboard?

 To set the timer for the Auto Refresh Time, follow the below steps in Refresh stings dialog:

1. Check the Enable Auto Refresh option
2. Set the time interval ranging from a minimum of 30 seconds to a maximum of 23 hours 59 minutes and 59 seconds and,
3. Click Apply.

How to configure the Widget selection during Auto Refresh?

To configure the auto refresh settings for the specific (or selected) widget(s) in the refresh settings popup,

1. Select the Enable Auto Refresh option in the dialog.
2. Select the Refresh Selected widget(s) only as in the below image and select the widget(s) that needs to be refreshed during auto refresh trigger.

How to set the auto refresh only for the record insertion/deletion in the associated database?

1. Select the Enable Auto Refresh in the Refresh Settings dialog
2. Select the Refresh only for insertion/deletion of rows in the dialog
3. Click Apply

While preview the dashboard, the data will be refreshed only at the insertion or deletion of the rows in the associated database

How to set auto refresh for the dashboard using JavaScript API(s) in Dashboard Viewer?

enableAutoRefresh:

To set the auto refresh for the dashboard:

      In the SDK set the enableAutoRefresh as true.

       Default value is false.

Example

 $(“#container”). ejDashboardViewer ({

enableAutoRefresh: true

});

autoRefreshSettings

Auto Refresh allows you to configure the scheduled refresh of dashboard. It is used to refresh the data on the specified time. Either the whole dashboard or specific widgets in a dashboard can be refreshed automatically.

autoRefreshSettings.interval

Specifies the time interval in seconds for auto refreshing the data. You can set the time interval ranging from minimum of 30 seconds to maximum of 2147483647 seconds.

Default Value is 30.

Example

$(“#container”). ejDashboardViewer ({

enableAutoRefresh: true,

autoRefreshSettings:{interval:50}

});

autoRefreshSettings.showWaitingIndicator

Specifies to show the waiting indicator while the data is refreshed.

Default Value is false.

Example

$(“#container”). ejDashboardViewer ({

enableAutoRefresh: true,

autoRefreshSettings:{showWaitingIndicator:true}

});

autoRefreshSettings.isWidgetSpecific

Specifies to refresh the specific widget alone

Default Value is false

Example

$(“#container”). ejDashboardViewer ({

enableAutoRefresh: true,

autoRefreshSettings:{isWidgetSpecific:true}

});

autoRefreshSettings.widgets

Specifies the Collection of the widgets need to be refreshed.

Default value is [].

Example

$(“#container”). ejDashboardViewer ({

enableAutoRefresh: true,

autoRefreshSettings:{isWidgetSpecific:true,widgets:[“Grid_1”,”Chart_1”]}

});

autoRefreshSettings.trackData

Specifies whether to trigger the refresh of data when there is modification in the data in the server.

Default Value is false.

Example

$(“#container”). ejDashboardViewer ({

enableAutoRefresh: true,

autoRefreshSettings:{trackData:true}

});

The following table shows whether the data will modify or not during refresh for the respective data source:

How to Refresh Data For the Data Source types like File, WebDataSource, Microsoft Azure Table Storage, ODBC(Extracted Mode)

The auto refresh for the above data sources can be achieved through the Syncfusion Dashboard Agent.

Syncfusion Dashboard Agent is a Data Agent is a self-hosting service which is prepared to be installed only in data servers. It is responsible for extracting data from RESTful Web services, Azure Table Storage and incremental update data for Web Accessible Resources on the time-based schedulers.

To know more about the Syncfusion Dashboard Agent please refer the following link:

https://help.syncfusion.com/dashboard-platform/dashboard-designer/extracting-live-data