Skip to content

Commit 66d0924

Browse files
(DOCSP-4643): Refactor data table and data source pages
1 parent e9ed69a commit 66d0924

File tree

8 files changed

+281
-227
lines changed

8 files changed

+281
-227
lines changed

config/sphinx_local.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ theme:
2121
- /tutorial/order-data/order-data-tutorial-overview
2222
- /tutorial/movie-details/movie-details-tutorial-overview
2323
- /chart-types
24+
- /chart-type-reference/data-table
2425
- /customize-charts
2526
sidebars:
2627
'**':

source/chart-type-reference/data-table.txt

Lines changed: 6 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -161,106 +161,11 @@ mean weekly price as currency.
161161
Blank table cells indicate that there are no documents that match
162162
the corresponding intersection of ``property_type`` and ``suburb``.
163163

164-
Sort and Resize Data Table Columns
165-
----------------------------------
164+
.. class:: hidden
166165

167-
Users with the viewer and author :ref:`roles <dashboard-roles>`
168-
on data tables can sort and resize data table columns. You
169-
can sort and resize columns either in the
170-
:doc:`dashboard </dashboards>` or the :doc:`Chart Builder
171-
</build-charts>`.
166+
.. toctree::
167+
:titlesonly:
172168

173-
Behavior
174-
~~~~~~~~
175-
176-
When a viewer or author sorts or resizes columns from the
177-
:doc:`dashboard </dashboards>`, the changes do not persist as part of
178-
the chart definition. In this case, the chart returns to its
179-
original state once the chart or corresponding dashboard is
180-
refreshed.
181-
182-
To save the changes as part of the chart definition, an author must
183-
make the changes in the Chart Builder. All |charts-short| users will
184-
see the new column sorting and sizing.
185-
186-
Procedure
187-
~~~~~~~~~
188-
189-
Sort Columns
190-
````````````
191-
192-
To sort a data table column, click on its header. With each click, |charts| cycles between sorting the column in
193-
ascending order, descending order, and the default chart sorting order.
194-
195-
To sort by multiple columns, Shift + Click on the additional columns
196-
by which you wish to sort. |charts-short| applies the sort order in
197-
the same order you select additional columns. |charts-short| displays
198-
numbers in the column headers indicating the order in which the
199-
sorting is applied.
200-
201-
Resize Columns
202-
``````````````
203-
204-
To resize a column, click the the column divider and drag until the
205-
column reaches the desired width.
206-
207-
To return a column to its default width, double-click on the column
208-
divider.
209-
210-
Reorder Data Table Columns
211-
--------------------------
212-
213-
Users with the author and owner :ref:`roles <dashboard-roles>`
214-
on data tables can reorder data table columns in the :doc:`Chart
215-
Builder </build-charts>`.
216-
217-
To reorder data table columns, click and drag column headers to the
218-
desired order.
219-
220-
When an author reorders data table columns and saves the
221-
chart, |charts| saves the specified order as part of the chart
222-
definition. All |charts-short| users will see the new column order.
223-
224-
.. note::
225-
226-
Data table :ref:`authors <dashboard-roles>` can also reorder
227-
columns by modifying the order of the respective column
228-
:ref:`encoding channels <encoding-channels>`. |charts| renders data
229-
table columns in the same order you specify the column encoding
230-
channels. To modify the order of the encoding channels, drag and
231-
drop one field on top of another to swap their order.
232-
233-
Considerations
234-
~~~~~~~~~~~~~~
235-
236-
- You can only reorder columns within their respective table sections,
237-
being :guilabel:`Groups` or :guilabel:`Values`.
238-
239-
- You cannot reorder :guilabel:`Dynamic Columns`.
240-
241-
Toggle Row and Column Totals
242-
----------------------------
243-
244-
By default, data tables include a Column Totals row, which consists of
245-
a row of values with sum totals for each column. Optionally, you can
246-
enable a Row Totals column, which consists of a column of
247-
values containing sum totals for each row.
248-
249-
The following image shows a detail from a data table with row and
250-
column totals enabled and added text indicating which is which:
251-
252-
.. figure:: /images/charts/row-column-totals.png
253-
:figwidth: 541px
254-
:alt: Data table with row and column totals
255-
256-
To toggle the totals on and off:
257-
258-
1. Navigate to the :guilabel:`Customization` tab in the
259-
:doc:`Chart Builder </build-charts>`.
260-
261-
#. In the :guilabel:`General Customization` section, set the
262-
:guilabel:`Column Totals` and :guilabel:`Row Totals` toggles
263-
to the desired settings.
264-
265-
For a complete list of Chart Customization options, see :doc:`Customize
266-
Charts </customize-charts/>`.
169+
/chart-type-reference/data-table/reorder-columns
170+
/chart-type-reference/data-table/sort-resize-columns
171+
/chart-type-reference/data-table/toggle-row-column-totals
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. _reorder-data-table-columns:
2+
3+
==========================
4+
Reorder Data Table Columns
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+
Users with the author and owner :ref:`roles <dashboard-roles>`
16+
on data tables can reorder data table columns in the :doc:`Chart
17+
Builder </build-charts>`.
18+
19+
Behavior
20+
--------
21+
22+
When a user reorders data table columns and saves the
23+
chart, |charts| saves the specified order as part of the chart
24+
definition. All |charts-short| users will see the new column order.
25+
26+
Procedure
27+
---------
28+
29+
To reorder data table columns, click and drag column headers to the
30+
desired order.
31+
32+
.. note::
33+
34+
Data table :ref:`authors and owners <dashboard-roles>` can also
35+
reorder columns by modifying the order of the respective column
36+
:ref:`encoding channels <encoding-channels>`. |charts| renders data
37+
table columns in the same order you specify the column encoding
38+
channels. To modify the order of the encoding channels, drag and
39+
drop one field on top of another to swap their order.
40+
41+
Considerations
42+
--------------
43+
44+
- You can only reorder columns within their respective table sections,
45+
being :guilabel:`Groups` or :guilabel:`Values`.
46+
47+
- You cannot reorder :guilabel:`Dynamic Columns`.
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. _sort-resize-data-table-columns:
2+
3+
==================================
4+
Sort and Resize Data Table Columns
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+
Users with the viewer and author :ref:`roles <dashboard-roles>`
16+
on data tables can sort and resize data table columns. You
17+
can sort and resize columns either in the
18+
:doc:`dashboard </dashboards>` or the :doc:`Chart Builder
19+
</build-charts>`.
20+
21+
Behavior
22+
--------
23+
24+
When a viewer or author sorts or resizes columns from the
25+
:doc:`dashboard </dashboards>` view, the changes do not persist as
26+
part of the chart definition. In this case, the chart returns to its
27+
original state once the chart or corresponding dashboard is
28+
refreshed.
29+
30+
To save the changes as part of the chart definition, an author must
31+
make the changes in the Chart Builder. All |charts-short| users will
32+
see the new column sorting and sizing.
33+
34+
Procedure
35+
---------
36+
37+
Sort Columns
38+
~~~~~~~~~~~~
39+
40+
To sort a data table column, click on its header. With each click, |charts| cycles between sorting the column in
41+
ascending order, descending order, and the default chart sorting order.
42+
43+
To sort by multiple columns, Shift + Click on the additional columns
44+
by which you wish to sort. |charts-short| applies the sort order in
45+
the same order you select additional columns. |charts-short| displays
46+
numbers in the column headers indicating the order in which the
47+
sorting is applied.
48+
49+
Resize Columns
50+
~~~~~~~~~~~~~~
51+
52+
To resize a column, click the the column divider and drag until the
53+
column reaches the desired width.
54+
55+
To return a column to its default width, double-click on the column
56+
divider.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _toggle-row-column-totals:
2+
3+
=======================================
4+
Toggle Data Table Row and Column Totals
5+
=======================================
6+
7+
By default, data tables include a Column Totals row, which consists of
8+
a row of values with sum totals for each column. Optionally, you can
9+
enable a Row Totals column, which consists of a column of
10+
values containing sum totals for each row.
11+
12+
The following image shows a detail from a data table with row and
13+
column totals enabled and added text indicating which is which:
14+
15+
.. figure:: /images/charts/row-column-totals.png
16+
:figwidth: 541px
17+
:alt: Data table with row and column totals
18+
19+
Procedure
20+
---------
21+
22+
To toggle the totals on and off:
23+
24+
1. Navigate to the :guilabel:`Customization` tab in the
25+
:doc:`Chart Builder </build-charts>`.
26+
27+
#. In the :guilabel:`General Customization` section, set the
28+
:guilabel:`Column Totals` and :guilabel:`Row Totals` toggles
29+
to the desired settings.
30+
31+
For a complete list of Chart Customization options, see :doc:`Customize
32+
Charts </customize-charts/>`.

0 commit comments

Comments
 (0)