Embedded Dashboard Options
On this page
You can customize the appearance and behavior of your embedded dashboards with a variety of options. Options are available to dashboards embedded with the Embedding SDK and embedded within iframes.
Note
To embed dashboards, you must configure embedding options on your data sources. For instructions, see Embed Dashboards in Your Web Application.
Options
The following options are available for embedded dashboards:
Option | Purpose |
|---|---|
Provides the JavaScript createDashboard() method for rendering a
dashboard within a web page. You can control properties such as the
height and width of the dashboard. To learn more, see
Embedded Dashboard Options. | |
You can set dashboard options within an iframe by adding inline style
tags and query parameters to the chart URL. |
Refresh and Data Caching Behavior
The following table describes how Atlas Charts loads data from the cache
when loading or refreshing the dashboard based on the
autoRefresh and maxDataAge values.
autoRefresh Value | maxDataAge Value | Atlas Charts Behavior |
|---|---|---|
omitted or false | omitted | The chart or dashboard does not automatically refresh. When you initially load or manually refresh the chart or dashboard, Atlas Charts renders the chart or dashboard with data from the cache if the data is less than one hour old. If the data from the cache is more than one hour old, Charts queries the data source for the latest data, refreshes the cache, and renders the chart or dashboard using this data. |
omitted or false | -1 | The chart or dashboard does not automatically refresh. When you initially load or manually refresh the chart or dashboard, Atlas Charts renders the chart or dashboard using data from the cache. Charts queries the data source for the latest data only if the cache has no data for the chart or dashboard. |
omitted or false | 0 | The chart or dashboard does not automatically refresh. When you initially load or manually refresh the chart or dashboard, Atlas Charts queries the data source for the latest data, and renders the chart or dashboard using this data. Charts doesn't read data from the cache. |
omitted or false | Number greater than 0 | The chart or dashboard does not automatically refresh. When you initially load or manually refresh the chart or
dashboard, Atlas Charts renders the chart or dashboard with data
from the cache if the age of the data is less than the
|
true | omitted | The chart or dashboard automatically refreshes every hour. When you initially load, manually refresh, or automatically refresh the chart or dashboard, Atlas Charts renders the chart or dashboard with data from the cache if the age of the data is less than one hour old. If the age of the data from the cache is more than one hour old, Charts queries the data source for the latest data, refreshes the cache, and renders the chart or dashboard using this data. |
true | Number greater than or equal to 60 | The chart or dashboard automatically refreshes at the
When you initially load, manually refresh, or automatically
refresh the chart or dashboard, Atlas Charts renders the chart or
dashboard with data from the cache if the age of the data is
less than the |
true | Number less than 60 | The chart or dashboard automatically refreshes at the minimum period of 60 seconds. When you initially load, manually refresh, or automatically
refresh the chart or dashboard, Atlas Charts renders the chart or
dashboard with data from the cache if the age of the data is
less than the minimum |