Skip to content

Commit 9b30091

Browse files
zach-carrkanchana-mongodbcorryroot
authored
1.24 release (#477)
* DOCSP-15704/15705 Atlas Data Lakes in the Add Data Source dialog (#472) * DOCSP-15704 Atlas Data Lakes in the Add Data Source dialog * DOCSP-15704 updates for copy review feedback * DOCSP-15704 updates for external review feedback * (DOCSP-15680): Created a new page for Combo Charts. (#473) * (DOCSP-15680): Created a new page for Combo Charts. * (DOCSP-15680): Incorporated Zach's feedback. * (DOCSP-15680): Incorporated Tom's feedback. * (DOCSP-15680): Incorporated Tom's feedback. * (DOCSP-14861) Conditional Formatting (#474) * (DOCSP-14861) Conditional formatting * (DOCSP-15579) Add Dutch provinces choropleth scheme (#476) * (DOCSP-15579) Add Dutch province shape scheme * (DOCSP-16067) 1.24.2 release notes (#475) * (DOCSP-16067) 1.24.2 release notes Co-authored-by: kanchana-mongodb <[email protected]> Co-authored-by: corryroot <[email protected]>
1 parent e42523a commit 9b30091

27 files changed

+855
-91
lines changed

‎conf.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@
6262
'.. |checkmark| unicode:: U+2713',
6363
'.. |tls-ssl| replace:: :abbr:`TLS (Transport Layer Security)`/:abbr:`SSL (Secure Sockets Layer)`',
6464
'.. |service| replace:: Atlas',
65+
'.. |adl| replace:: Atlas Data Lake',
66+
'.. |dl| replace:: Data Lake',
6567
'.. |enc-channel| replace:: :ref:`encoding channel <encoding-channels>`',
6668
'.. |aws| replace:: :abbr:`AWS (Amazon Web Services)`',
6769
'.. |gcp| replace:: :abbr:`GCP (Google Cloud Platform)`',

‎config/sphinx_local.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ theme:
2828
- /chart-type-reference/circular-charts
2929
- /encoding-channels
3030
- /customize-charts
31+
- /customize-charts/conditional-formatting
3132
- /embedding-charts
3233
- /view-export-chart-data
3334
- /embedding-tutorials

‎snooty.toml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ toc_landing_pages = ["/installation", "/dashboards", "/data-sources",
1111
"/chart-types", "/chart-type-reference/data-table",
1212
"/chart-type-reference/geo-spatial",
1313
"/chart-type-reference/choropleth",
14-
"/customize-charts", "/embedding-charts",
14+
"/customize-charts",
15+
"/customize-charts/conditional-formatting",
16+
"/embedding-charts",
1517
"/view-export-chart-data",
1618
"/embedding-tutorials",
1719
"/embedding-charts-sdk",
@@ -25,6 +27,8 @@ charts = "MongoDB Charts"
2527
charts-short = "Charts"
2628
tls-ssl = ":abbr:`TLS (Transport Layer Security)`/:abbr:`SSL (Secure Sockets Layer)`"
2729
service = "Atlas"
30+
adl = "Atlas Data Lake"
31+
dl = "Data Lake"
2832
enc-channel = ":ref:`encoding channel <encoding-channels>`"
2933
aws = ":abbr:`AWS (Amazon Web Services)`"
3034
gcp = ":abbr:`GCP (Google Cloud Platform)`"

‎source/chart-type-reference/choropleth-regions.txt‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ expected :guilabel:`Location` values:
4848

4949
* - :guilabel:`Canadian Provinces`
5050
- Full names and :wikipedia:`two-letter codes <Canadian_postal_abbreviations_for_provinces_and_territories>`
51-
for Canadian provinces expressed in English or French language.
52-
- ``New Brunswick``, ``Nouveau-Brunswick``.
51+
for Canadian provinces, expressed in English or French language.
52+
- ``New Brunswick``, ``Nouveau-Brunswick``
5353

5454
* - :guilabel:`UK Countries`
5555
- Countries in the United Kingdom.
@@ -75,23 +75,27 @@ expected :guilabel:`Location` values:
7575
- ``Norfolk``, ``Essex``
7676

7777
* - :guilabel:`German States`
78-
-
79-
- Full names and
80-
- :wikipedia:`two-letter German state codes <States_of_Germany#List>`
81-
of German states expressed in German or English language.
78+
- Full names and
79+
:wikipedia:`two-letter German state codes <States_of_Germany#List>`
80+
of German states, expressed in German or English language.
8281
- ``Saxony``, ``Sachsen``
8382

8483
* - :guilabel:`Australian States`
8584
- :wikipedia:`Full names and abbreviations <States_and_territories_of_Australia#States_and_territories>`
8685
for Australian states.
87-
- ``Victoria``, ``VIC``.
86+
- ``Victoria``, ``VIC``
8887

8988
* - :guilabel:`Australian Local Government Areas`
9089
- Australian local government areas.
9190
- ``Yarra``, ``Waverley``
9291

9392
* - :guilabel:`Italian Regions`
9493
- `Full names and three-letter abbreviations <https://www.circolocalabrese.org/geography/standard-abbreviations-of-italian-regions-and-provinces.asp>`__
95-
for all Italian regions in expressed Italian or English language.
94+
for all Italian regions, expressed in Italian or English
95+
language.
9696
- ``Liguria``, ``LIG``
9797

98+
* - :guilabel:`Dutch Provinces`
99+
- `Full names and abbreviations <https://www.landafkorting.nl/provincies.htm>`__ for Dutch provinces, expressed in Dutch or
100+
English language.
101+
- ``Drenthe``, ``DR``

‎source/chart-type-reference/combo-charts.txt‎

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
.. _combo-chart-ref:
2+
3+
============
4+
Combo Charts
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+
Combo charts offer a combined :ref:`column <column-bar-chart-ref>` and
16+
:ref:`line <line-area-chart-ref>` view.
17+
18+
Combo Chart Encoding Channels
19+
-----------------------------
20+
21+
Combo charts provide the following
22+
:ref:`encoding channels <encoding-channels>`:
23+
24+
.. list-table::
25+
:header-rows: 1
26+
:widths: 20 80
27+
28+
* - Encoding Channel
29+
- Description
30+
31+
* - X Axis
32+
- In the :guilabel:`category` axis encoding channel, a column is
33+
rendered for each unique value from this field.
34+
35+
* - Columns
36+
- - The fields that you use in this channel build the columns in
37+
this chart.
38+
39+
- The :guilabel:`aggregation` axis encoding channel dictates
40+
which field to aggregate on and the type of aggregation to
41+
perform. This ultimately dictates the size of each column.
42+
43+
.. note::
44+
45+
You can map multiple fields to this channel to create
46+
a multi-series chart. However, unlike other charts, you can't
47+
create a multi-series chart with the :guilabel:`Series`
48+
channel on combo charts. To learn more, see
49+
:ref:`Multiple Field Mappings <multiple-field-mappings>`.
50+
51+
* - Lines
52+
- - The fields that you use in this channel build one or more
53+
lines on this chart.
54+
55+
- The :guilabel:`aggregation` axis encoding channel dictates
56+
which field to aggregate on and the type of aggregation to
57+
perform.
58+
59+
Combo Chart Types
60+
-----------------
61+
62+
Combo charts provide the following sub-types:
63+
64+
.. list-table::
65+
:header-rows: 1
66+
:widths: 20 80
67+
68+
* - Sub-Type Name
69+
- Description
70+
71+
* - :ref:`Grouped <grouped-combo-ref-example>`
72+
- |charts| groups data by the category specified in the
73+
:guilabel:`category` :ref:`encoding channel
74+
<encoding-channels>`, and plots a column for each value
75+
in the :guilabel:`Columns` encoding channel.
76+
77+
* - :ref:`Stacked <stacked-combo-ref-example>`
78+
- |charts| creates a column for each distinct value in the
79+
:guilabel:`category` :ref:`encoding channel <encoding-channels>`
80+
field, and splits each column into segments based on the
81+
the :guilabel:`Columns` encoding channel.
82+
83+
Use Cases
84+
---------
85+
86+
- Combo charts bring together the useful aspects of both :ref:`column
87+
<column-bar-chart-ref>` and :ref:`line <line-area-chart-ref>` charts
88+
into a single chart.
89+
90+
Customization Options
91+
---------------------
92+
93+
The following customization options are specific to combo
94+
charts. To see all available customization options, see
95+
:ref:`customize-charts`.
96+
97+
.. note::
98+
99+
If the columns and lines in your combo use different scales,
100+
consider a :ref:`secondary-y-axis`. This option appears on the
101+
:guilabel:`Customize` pane in the :guilabel:`Fields` section for any
102+
fields mapped to the :guilabel:`Lines` channel. Fields mapped to the
103+
:guilabel:`Columns` channel appear only on the primary axis.
104+
105+
Adjust X-Axis Label Angle
106+
~~~~~~~~~~~~~~~~~~~~~~~~~~
107+
You can adjust the X-axis label angle.
108+
109+
.. include:: /includes/customization/adjust-x-axis-label-angle.rst
110+
111+
Set Distinct Dash Style per Series
112+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113+
114+
On combo charts, you can opt to display each series in the chart with a
115+
distinct dash style. This option can help make your chart more
116+
accessible by distinguishing between series beyond color.
117+
118+
.. include:: /includes/customization/set-distinct-dash-style-per-series.rst
119+
120+
Smooth Lines
121+
~~~~~~~~~~~~
122+
123+
.. include:: /includes/customization/smooth-lines.rst
124+
125+
Show or Hide Data Markers
126+
~~~~~~~~~~~~~~~~~~~~~~~~~
127+
128+
On combo charts, you can dictate whether |charts-short| displays
129+
visible data markers that represent individual data points along the
130+
line. Enabling this option makes it easier to see exactly where your
131+
data points lie along a line. Hovering over these markers shows the
132+
exact data values in a tooltip, making it easier to view precise
133+
measurements.
134+
135+
.. include:: /includes/customization/show-hide-data-markers.rst
136+
137+
Show or Hide Data Value Labels
138+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139+
140+
.. include:: /includes/customization/show-hide-data-labels.rst
141+
142+
Examples
143+
--------
144+
145+
.. _grouped-combo-ref-example:
146+
147+
Grouped Combo Chart
148+
~~~~~~~~~~~~~~~~~~~
149+
150+
The following grouped combo chart shows the number of award
151+
nominations, wins, and metascores by director.
152+
153+
The :guilabel:`X Axis` category of ``director`` creates a group
154+
for each director in the data set, and each group is split by the
155+
:guilabel:`Columns` encoding channel fields of ``nominations`` and
156+
``wins``. The :guilabel:`Lines` encoding channel field of
157+
``metacritic`` displays as a line:
158+
159+
.. figure:: /images/charts/combo-chart-grouped.png
160+
:figwidth: 750px
161+
:alt: Grouped Combo Chart Reference
162+
163+
.. _stacked-combo-ref-example:
164+
165+
Stacked Combo Chart
166+
~~~~~~~~~~~~~~~~~~~~
167+
168+
The following stacked combo chart shows the number of award
169+
nominations, wins, and metascores by director.
170+
171+
The :guilabel:`X Axis` category of ``director`` creates a column for
172+
each director in the data set, :ref:`limited <charts-limit-data>` to
173+
only the top 10 as sorted by the aggregated sum of ``awards.wins`` from
174+
:guilabel:`Columns`. The :guilabel:`Columns` encoding channel fields of
175+
``nominations`` and ``wins`` segment each column. The :guilabel:`Lines`
176+
encoding channel field of ``metacritic`` displays as a line:
177+
178+
.. figure:: /images/charts/combo-chart-stacked.png
179+
:figwidth: 750px
180+
:alt: Stacked Combo Chart Reference
181+
182+
Limitations
183+
-----------
184+
185+
The maximum query response size for combo charts is 5000
186+
documents.

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,18 @@ the column you want to unpin. The :icon-fa5:`map-pin` button toggles off
138138
and if the column is a :guilabel:`Group` column, it moves to the right
139139
of any pinned :guilabel:`Group` columns.
140140

141+
Conditional Formatting
142+
~~~~~~~~~~~~~~~~~~~~~~
143+
144+
You can create styling rules for table cell values that match
145+
conditions you define. Conditional formatting rules affect the look of
146+
your chart dynamically: if the value of a table cell changes to match
147+
or stop matching your conditions, its styling updates to reflect that.
148+
149+
To learn how to use conditional formatting rules, see the
150+
:ref:`Conditional Formatting <conditional-formatting>`
151+
customization option.
152+
141153
Examples
142154
--------
143155

‎source/chart-type-reference/line-area-chart.txt‎

Lines changed: 3 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -239,16 +239,7 @@ this option makes it easier to see exactly where your data points lie
239239
along a line. Hovering over these markers shows the exact data values in
240240
a tooltip, making it easier to view precise measurements.
241241

242-
To set this option:
243-
244-
1. Open the :ref:`Customize <customize-charts>` pane for your chart.
245-
246-
#. In the :guilabel:`General Customization` section, set the
247-
:guilabel:`Data Markers` toggle switch to the desired setting.
248-
249-
To customize the formatting of the number in the data marker tooltip,
250-
modify the :ref:`Number Formatting <customize-number-formats>`
251-
settings for the relevant field.
242+
.. include:: /includes/customization/show-hide-data-markers.rst
252243

253244
Set Distinct Dash Style per Series on Line Charts
254245
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -258,13 +249,7 @@ series in the chart with a distinct dash style. This option can help
258249
make your chart more accessible by distinguishing between
259250
series beyond color.
260251

261-
To set this option:
262-
263-
1. Open the :ref:`Customize <customize-charts>` pane for your chart.
264-
265-
#. In the :guilabel:`General Customization` section, set the
266-
:guilabel:`Dash Styles per Series` toggle switch to the desired
267-
setting.
252+
.. include:: /includes/customization/set-distinct-dash-style-per-series.rst
268253

269254
Show or Hide Data Value Labels
270255
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -279,39 +264,7 @@ Add a Trendline
279264
Smooth Lines
280265
~~~~~~~~~~~~
281266

282-
You can change the way lines are drawn on your chart. To smooth lines:
283-
284-
1. Open the :ref:`Customize <customize-charts>` pane for your chart.
285-
286-
#. In the :guilabel:`General Customization` section, set
287-
:guilabel:`Line Smoothing` to the desired option.
288-
289-
The following line smoothing options are available:
290-
291-
.. list-table::
292-
:header-rows: 1
293-
:stub-columns: 1
294-
:widths: 30 70
295-
296-
* - Option
297-
- Description
298-
299-
* - None (Default)
300-
- Draws straight lines between data points.
301-
302-
* - Smooth
303-
- Draws curved lines between data points.
304-
305-
* - Step Before
306-
- Lines extend horizontally to data points. This is useful
307-
for visualizing data that only changes in intervals and is
308-
collected at the end of a period, such as
309-
daily average temperature.
310-
311-
* - Step After
312-
- Lines extend horizontally from data points. This is useful
313-
for visualizing data that only changes in intervals, such as
314-
stock prices.
267+
.. include:: /includes/customization/smooth-lines.rst
315268

316269
Examples
317270
--------

‎source/chart-type-reference/number-chart.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,21 @@ average number of vacant rooms across all hotels, or apply a
3333
:ref:`filter <charts-filter-documents>` to see the total number of
3434
vacant rooms in a select region.
3535

36+
Customization Options
37+
---------------------
38+
39+
Conditional Formatting
40+
~~~~~~~~~~~~~~~~~~~~~~
41+
42+
You can style the number that your chart displays with conditional
43+
formatting rules. These rules are applied dynamically: if your
44+
number changes to match or stop matching a condition you define, its
45+
styling updates.
46+
47+
To learn how to use conditional formatting rules, see the
48+
:ref:`Conditional Formatting <conditional-formatting>`
49+
customization option.
50+
3651
.. _number-chart-example:
3752

3853
Examples

0 commit comments

Comments
 (0)