Skip to content

Commit 933186c

Browse files
committed
(DOCSP-6959) Adding information on viewing chart underlying data (#250)
* (DOCSP-6959) Adding 'View Underlying Data' page, screenshots * Line breaks for docs review * Moving work to 'Build Charts' page * Most review changes, some still being discussed * Changes based on feedback with two questions for external review * Wording * Moved to subpage * Wording * Consideration * Formatting * Changes based on feedback, incl. earlier feedback * Copy
1 parent de0b9a3 commit 933186c

File tree

4 files changed

+81
-2
lines changed

4 files changed

+81
-2
lines changed

source/build-charts.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,14 @@ charts, refer to the :ref:`Chart Types <chart-type-reference>` page.
1919
Create a Chart
2020
--------------
2121

22-
To build a new chart:
23-
2422
.. include:: /includes/steps/build-new-chart.rst
2523

2624
.. class:: hidden
2725

2826
.. toctree::
2927
:titlesonly:
3028

29+
/view-export-chart-data
3130
/encoding-channels
3231
/multi-series-charts
3332
/filter-documents
151 KB
Loading
40.2 KB
Loading

source/view-export-chart-data.txt

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
.. _view-export-chart-data:
2+
3+
==========================
4+
View and Export Chart Data
5+
==========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
While editing a chart in the Chart Builder, you can view underlying
16+
data from the :guilabel:`Ellipses (...)` dropdown menu. Access to
17+
underlying data is intended to help you build meaningful charts as well
18+
as export that data for use with third-party tools.
19+
20+
.. figure:: /images/charts/editor-ellipse-menu.png
21+
:figwidth: 60%
22+
:alt: The ellipse menu is in the top-right corner of the charts editor.
23+
24+
.. _view-source-documents:
25+
26+
View Source Documents
27+
---------------------
28+
29+
Once you have selected a :doc:`data source <data-sources>` for your
30+
chart, you can view 20 sample documents from that data source by
31+
clicking the :guilabel:`View Source Documents` menu option.
32+
33+
.. note::
34+
If you want to explore your data source beyond 20 sample documents,
35+
you can use :compass:`Compass </>` or the
36+
:atlas:`Atlas Data Explorer </data-explorer/>`.
37+
38+
The sample documents are intended for reference to help you build a
39+
chart. The documents do not reflect any groupings or projections
40+
applied to an existing chart (i.e. any :guilabel:`Encode` panel options
41+
in the Chart Builder). The documents are produced with a query on your
42+
data source that considers:
43+
44+
- :ref:`Pipelines applied to the data source <data-sources-pipeline>`
45+
46+
- :ref:`Sample mode <charts-sample-mode>` (if toggled on)
47+
48+
- :ref:`Queries <query-bar>` or
49+
:ref:`pipelines specified in the Chart Builder <charts-agg-pipeline>`
50+
51+
- Filters applied in the :ref:`Filter Tab <filter-tab>`
52+
53+
.. _get-chart-data:
54+
55+
Get Chart Data
56+
--------------
57+
58+
After you have configured a valid chart, you can view the data
59+
displayed on the chart as a table. Each row in the table represents a
60+
data point. To view the chart data, click the :guilabel:`Get Chart Data`
61+
menu option.
62+
63+
From the :guilabel:`Chart Data` dialog, you can download your
64+
chart data as a CSV or JSON file. This is useful for analyzing data
65+
with third-party tools.
66+
67+
.. admonition:: Considerations
68+
:class: important
69+
70+
Some Chart Builder configuration options (e.g. the :guilabel:`Limit
71+
Results` option and the :guilabel:`Multiplier` field-level option)
72+
apply only to the chart visualization and do not affect the
73+
underlying data. The :guilabel:`Chart Data` table displays
74+
underlying data, meaning some configuration options you see
75+
reflected on a chart may not be applied to the table. Review your
76+
data to verify its contents.
77+
78+
.. figure:: /images/charts/editor-chart-data.png
79+
:figwidth: 60%
80+
:alt: Viewing chart data will display a table of the values used to create a chart. It also allows for downloading a CSV or JSON representation of that table.

0 commit comments

Comments
 (0)