Configure Time Bar Defaults
The time bar feature is available for all visual styles. When enabled, it appears at the bottom of a dashboard. You can use the time bar to filter the data in your visuals by a specified time attribute. If more than one data source is used for visuals on a dashboard, the time bar shown on the dashboard depends on the visual that is selected in the dashboard. For information on using the time bar on the dashboard, see Use the Time Bar.
You can set time bar defaults for data sources used in your Composer environment. These defaults are specified in data source configurations and are applied to visuals that are created using the data sources. Specifically, you can specify:
- The default time field used for the time bar
- Whether playback and live mode should be available time bar features
- The default time range used for the time bar.
To specify default time bar settings for a data source configuration:
Make sure you are logged in as a Composer administrator or as a user assigned to a group that can edit data source configurations.
Select Sources on the UI menu () or the top-level navigation menu, or select the Sources box on the Home page. The Sources page appears.
In the table on the Sources page, locate and select the data source configuration you want to edit. The data source configuration wizard appears.
Select the Visuals tab in the data source configuration wizard.
Select the Global Default Settings bar on the Visuals tab, if it is not already selected. The time bar settings appear on the right side of the tab.
In the Time Attribute box, select the default time field that should be used for the time bar. If you do not want the time bar to be enabled by default, select None (Time Bar is Off). You can always enable and disable the time bar on the dashboard later.
The attribute you select is used as the default and is displayed on the time bar after you open the visual:
If the time attribute you select is playable, the Enable Playback and Enable Live Mode settings can be changed.
Live mode and historical playback (also know as Data DVR) allow you to get the most from data sources using connectors that support live mode and playback (see Live Mode and Historical Playback). The only difference between live mode and historical playback is the time range that is selected:
- Live mode refreshes field data on your visuals for fields that are indexed as playable. In live mode, your data plays forever without an end date.
- Historical playback (Data DVR) shows the historical record of field data for fields that are indexed as playable. Playback can show up to the last moment before the current period in your data.
Live mode and historical playback require an index or partition field. The data store should be capable of receiving new or updated data, that is, data that is not static like flat files. If the data store does not support indexing or partitioning, then live mode and historical playback are not available. For most data stores, indexing is the default. For more information about the requirements for playback, see Live Mode and Historical Playback.
Select the Enable Playback checkbox to show the Play button (Data DVR functionality) on the time bar.
Select the Enable Live Mode checkbox to enable playing data in live mode.
Note that if you select Enable Live Mode, Enable Playback is selected also, by default.
If you enable live mode for a data source (Enable Live Mode checkbox), you can set the refresh rate and delay time. The time bar defaults expand to show these settings.
Use the Refresh Rate box to specify the data refresh rate for the data source. The time granularity for the time field's refresh rate is defined in the Configure column on the Fields tab of the data source configuration wizard.
For information about using the REST API to identify and modify refresh rates, see Configure Data Source Refresh Rates Using the API.
Use the Delay By box to specify the delay time when playing data in live mode.
Use the From and To boxes to specify the default time bar range.
You can set the range in static time or dynamic time, or use preset ranges provided with Composer.
Select Static Time or Dynamic Time in the fx drop-down menu.
If you select Static Time, the From and To boxes are filled with default dates and times. Use the boxes to select specific from and to times:
If you select Dynamic Time, the From and To boxes are filled with Start of data and End of data automatically. Use the boxes to select different dynamic from and to times:
Alternatively, select to fill the From and To boxes with predefined time ranges provided by Composer:
Use the filter box at the top of the presets list to locate the preset setting you want. Descriptions of each of the preset options are provided in Preset Time Ranges.
When your changes are complete, select to save the data source configuration and close the wizard.
Please sign in to leave a comment.