@@ -36,12 +36,9 @@ To learn more about dashboard permissions in |charts|, see :ref:`Dashboard Permi
36
36
Each dashboard shows the following information:
37
37
38
38
- Title
39
-
40
39
- Description
41
-
42
40
- A preview of the first three charts in the dashboard, including the
43
41
chart title and type
44
-
45
42
- When the dashboard was last modified
46
43
47
44
By default, the most recently modified dashboards are shown first in
@@ -114,10 +111,18 @@ To add a sample dashboard:
114
111
a sample dashboard where you can experiment with
115
112
:ref:`dashboard filtering <dashboard-filtering>`
116
113
and :ref:`interactive filtering <interact-with-charts>`.
117
-
114
+
115
+ .. figure:: /images/charts/add-sample-dashboard.png
116
+ :figwidth: 50%
117
+ :alt: Add a sample dashboard.
118
+
118
119
.. step:: Click :guilabel:`Add and Open`
119
120
to create a new :guilabel:`Sample Dashboard` of which you are the ``Owner``.
120
121
122
+ .. figure:: /images/charts/movies-sample-dashboard.png
123
+ :figwidth: 80%
124
+ :alt: Movies sample dashboard.
125
+
121
126
You can also create a :guilabel:`Sample Dashboard` by going through
122
127
the |charts-short| :ref:`Welcome Experience <welcome-experience>`.
123
128
@@ -137,235 +142,11 @@ to visualize your |service| billing data. Billing dashboards
137
142
contain prebuilt charts with insights into your |service|
138
143
usage. To learn more, see :ref:`billing-dashboards`.
139
144
140
- .. _refresh-dashboard-overview:
141
-
142
- Refresh Dashboard Data
143
- ----------------------
144
-
145
- |charts| automatically refreshes chart data once it becomes out of
146
- date with the backing data source. You can also manually refresh
147
- dashboard data at any time.
148
-
149
- To learn how to configure refresh settings and underlying
150
- refresh behavior, see :doc:`/dashboard-refresh`.
151
-
152
- .. _get-chart-data-dashboard:
153
- .. _view-chart-data-dashboard:
154
-
155
- View Chart Data
156
- ---------------
157
-
158
- The data underlying a chart can be exported as a table. All viewers of
159
- public dashboards and authenticated users of non-public dashboards can
160
- view and export data. To view the chart data, click :guilabel:`View
161
- chart data` from the :icon-fa5:`ellipsis-h` menu. Each row in the table
162
- represents a data point.
163
-
164
- .. include:: /includes/get-chart-data-details.rst
165
-
166
- .. _import-export-dashboard:
167
-
168
- Export and Import a Dashboard
169
- -----------------------------
170
-
171
- You can export a dashboard to a file, which you can then import. Use
172
- this feature to:
173
-
174
- - Store your dashboard outside of |charts|
175
- - Import exported charts into the same or a different project
176
-
177
- .. _export-dashboard:
178
-
179
- Export a Dashboard to a File
180
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181
-
182
- You can export a dashboard to a single file named
183
- ``<Dashboard-Title>.charts``.
184
- You can export a dashboard from the :guilabel:`Dashboards` page or from
185
- the dashboard itself.
186
-
187
- To export a dashboard:
188
-
189
- .. procedure::
190
- :style: normal
191
-
192
- .. step:: If you are on the :guilabel:`Dashboards` page, click the ellipsis
193
- (``...``) for the dashboard you want to export. If you are already viewing a specific dashboard, click the ellipsis
194
- (``...``) in the top right corner.
195
-
196
- .. step:: Click
197
- :guilabel:`Export as .charts`.
198
-
199
- The ``<Dashboard-Title>.charts`` file contains the metadata for the
200
- dashboard, including:
201
-
202
- - Dashboard name and description
203
- - Dashboard layout including location of the charts in the dashboard
204
- - Chart definitions
205
- - Dashboard filter definitions
206
- - Details of the data sources used on the charts including:
207
-
208
- - Cluster name
209
- - Database name
210
- - Collection name
211
-
212
- - Embedding settings for each chart including:
213
-
214
- - Whether each embedding type is enabled or disabled
215
- - Filter allow list
216
- - Injected filter code
217
-
218
- The ``<Dashboard-Title>.charts`` file does **not** include:
219
-
220
- - Dashboard :ref:`permissions <dashboard-permissions>`
221
- - External sharing settings for the data sources used
222
- - Data source pipelines
223
- - Chart embedding IDs
224
-
225
- You must have ``Viewer`` or higher :ref:`permissions
226
- <dashboard-permissions>` to export a dashboard.
227
-
228
-
229
-
230
-
231
-
232
- .. _import-dashboard:
233
-
234
- Import a Dashboard From a File
235
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
236
-
237
- You can import a dashboard from a file on the :ref:`Dashboards page
238
- <dashboards-tab>`.
239
-
240
- The file to import:
241
-
242
- - Can't be larger than 16 MBs
243
- - Must be a valid ``.charts`` file that you downloaded from a
244
- dashboard
245
-
246
- To import a dashboard from a file:
247
-
248
- .. procedure:: Import a Dashboard From a File
249
- :style: normal
250
-
251
- .. step:: From the :guilabel:`Dashboards` page,
252
- expand the :guilabel:`Add Dashboard` dropdown menu and select :guilabel:`Import Dashboard`.
253
-
254
- .. step:: In the :guilabel:`Import Dashboard` modal, drag and drop the file to import
255
- or click :guilabel:`Choose File` and select the file to import.
256
-
257
- .. step:: Click
258
- :guilabel:`Next`.
259
-
260
- .. step:: Click the pencil icon :icon-fa4:`pencil`
261
- under :guilabel:`Data source at destination`.
262
-
263
- .. step:: Select the :guilabel:`Data source at destination`
264
- for each :guilabel:`Data source in file`.
265
-
266
- The :guilabel:`Import Dashboard` modal displays a list of all of the data
267
- sources you are importing under the :guilabel:`Data source in file` column.
268
- To connect each data source from your imported dashboard to a data source in your destination project,
269
- choose one of the following options under the :guilabel:`Data Source at Destination` column:
270
-
271
- .. list-table::
272
- :header-rows: 1
273
- :widths: 15 40
274
-
275
- * - Option
276
- - Description
277
-
278
- * - :guilabel:`Connect later`
279
- - Option to choose the data source to use later. |charts|
280
- imports all charts using the :guilabel:`Data source in file`,
281
- but no data source is selected. The charts don't render until
282
- you edit each chart and choose a new data source.
283
-
284
- * - :guilabel:`Connect now`
285
- - Option to select any data source in your project. The data
286
- source you select is used instead of the :guilabel:`Data
287
- source in file` for charts imported in to the dashboard.
288
-
289
- If |charts| detects that a data source in your imported dashboard is the same
290
- as the data source in your destination project, that data source is selected by
291
- default. Otherwise, :guilabel:`Connect later` is selected by default.
292
-
293
- To select a data source:
294
-
295
- 1. Select a deployment from the first dropdown.
296
- #. Select a database from the second dropdown.
297
- #. Select a data source from the third dropdown.
298
- #. Click :guilabel:`Save`.
299
-
300
- * - :guilabel:`Exclude charts using this data source`
301
- - Option to exclude charts that use the :guilabel:`Data source
302
- in file`. Charts that use the :guilabel:`Data source in
303
- file` won't be imported.
304
-
305
- .. important::
306
-
307
- Imported charts may not render properly if mapped to a data
308
- source that the chart wasn't built to use.
309
-
310
- .. step:: Click one of the
311
- following buttons:
312
-
313
- - :guilabel:`Save` to import the dashboard.
314
- - :guilabel:`Save and Import Another` to import this dashboard and
315
- import another dashboard from a file.
316
- - :guilabel:`Cancel` to exit the modal without importing the
317
- dashboard.
318
-
319
- .. _fullscreen-view:
320
-
321
- Fullscreen Dashboard View
322
- -------------------------
323
-
324
- |charts| provides a fullscreen view for dashboards. In this view,
325
- |charts| hides the main navigation bar and expands the dashboard to
326
- show the title, description, time of last modification, and charts in
327
- the entire space of the screen.
328
-
329
- To enter the fullscreen view for dashboards:
330
-
331
- .. procedure:: Import a Dashboard From a File
332
- :style: normal
333
-
334
- .. step:: Select a dashboard from the
335
- :guilabel:`Dashboards` page.
336
-
337
- .. step:: Click
338
- :icon-fa5:`expand` at the top-right of the dashboard.
339
-
340
- .. note::
341
-
342
- In the fullscreen view for dashboards, you can still:
343
-
344
- - :ref:`Remove <dashboard-remove-chart>`, :ref:`resize
345
- <dashboard-resize-chart>`, :ref:`rearrange
346
- <dashboard-rearrange-chart>`, and :ref:`edit
347
- <dashboard-edit-chart>` charts by hovering over the desired chart.
348
-
349
- - Configure refresh settings and manually refresh chart data.
350
-
351
- - Enter the :ref:`fullscreen charts view <fullscreen-charts-view>`.
352
-
353
- To exit the fullscreen view for dashboards, do one of the following
354
- tasks:
355
-
356
- - Click :icon-fa5:`compress` at
357
- the top-right of the dashboard.
358
-
359
- - Press the escape key.
360
145
361
146
.. toctree::
362
147
:titlesonly:
363
148
364
- /dashboard-ownership
365
- /manage-dashboards
366
- /dashboard-permissions
367
- /scheduled-reports
368
- /billing-dashboards
369
- /dashboard-refresh
370
- /dashboard-filtering
371
- /interact-with-charts
149
+ /dashboards/dashboard-access
150
+ /dashboards/manage-dashboards
151
+ /dashboards/dashboard-import-export
152
+ /dashboards/view-dashboard-data
0 commit comments