@@ -252,45 +252,45 @@ variety of options. Options are available to charts charts embedded with the
252
252
Configure Auto Refresh and Data Caching Behavior
253
253
------------------------------------------------
254
254
255
- Use the ``autorefresh `` query parameter to configure the chart
255
+ Use the ``autoRefresh `` query parameter to configure the chart
256
256
to refresh automatically.
257
257
258
258
Use the ``maxDataAge`` query parameter to:
259
259
260
260
- Determine the interval at which the chart refreshes if
261
- ``autorefresh `` is ``true``.
261
+ ``autoRefresh `` is ``true``.
262
262
- Configure the maximum age of data to load from the cache when
263
- loading or manually refreshing the chart if ``autorefresh ``
263
+ loading or manually refreshing the chart if ``autoRefresh ``
264
264
is ``false`` or omitted.
265
265
266
266
To learn how |charts| loads data from the cache when loading
267
- or refreshing the chart based on the ``autorefresh `` and
267
+ or refreshing the chart based on the ``autoRefresh `` and
268
268
``maxDataAge`` values, see :ref:`auto-refresh-behavior`.
269
269
270
270
Use the options on the
271
271
:guilabel:`Unauthenticated` tab on the :guilabel:`Embed Chart`
272
- dialog to customize the ``autorefresh `` value in the iframe
272
+ dialog to customize the ``autoRefresh `` value in the iframe
273
273
snippet.
274
274
275
275
Example
276
276
~~~~~~~
277
277
278
278
The following iframe embeds a chart which automatically
279
279
refreshes every 30 seconds as defined by the
280
- ``autorefresh =true`` and the ``maxDataAge=30`` query
280
+ ``autoRefresh =true`` and the ``maxDataAge=30`` query
281
281
parameters:
282
282
283
283
.. code-block:: html
284
284
285
285
<iframe style="border: none;border-radius: 2px;box-shadow: 0 2px
286
286
10px 0 rgba(70, 76, 79, .2);" width="640" height="480" src="
287
287
{charts-host}/embed/charts?id=b3ca720f-4b4a-40b4-a726-e7dc0c49aa1c&
288
- autorefresh =true&maxDataAge=30"></iframe>
288
+ autoRefresh =true&maxDataAge=30"></iframe>
289
289
290
290
Considerations
291
291
~~~~~~~~~~~~~~
292
292
293
- - The minimum cache duration is 10 seconds. If ``autorefresh ``
293
+ - The minimum cache duration is 10 seconds. If ``autoRefresh ``
294
294
is ``true`` and you specify a ``maxDataAge`` value less than
295
295
10, the chart refreshes every 10 seconds.
296
296
@@ -311,7 +311,7 @@ variety of options. Options are available to charts charts embedded with the
311
311
312
312
.. example::
313
313
314
- If ``autorefresh `` is ``true``, the cache duration is one
314
+ If ``autoRefresh `` is ``true``, the cache duration is one
315
315
minute (``maxDataAge=60``), and the expiry date of the
316
316
signature is in one hour, the chart refreshes every minute
317
317
for an hour. Once one hour has elapsed, the chart will not
@@ -477,25 +477,7 @@ Auto Refresh and Data Caching Behavior
477
477
--------------------------------------
478
478
479
479
The following table describes how |charts| loads data from the cache
480
- when loading or refreshing the chart based on the ``autorefresh`` or
480
+ when loading or refreshing the chart based on the
481
481
``autoRefresh`` and ``maxDataAge`` values.
482
482
483
- .. note::
484
-
485
- The casing of the ``autoRefresh`` option differs based on whether
486
- you embed a chart using the Embedding SDK or an iframe:
487
-
488
- .. list-table::
489
- :header-rows: 1
490
- :widths: 50 50
491
-
492
- * - Embedding Method
493
- - Auto Refresh Option
494
-
495
- * - Embedding SDK
496
- - ``autoRefresh``
497
-
498
- * - iframe
499
- - ``autorefresh``
500
-
501
483
.. include:: /includes/autorefresh-maxdataage-values.rst
0 commit comments