Skip to content

Commit da2b677

Browse files
steverenjwilliams-mongozach-carr
authored
V1.21 (#447)
* DOCSP-13540: [CHARTS] As an author, I can add a description to a chart (#439) * DOCSP-13094: [CHARTS] As an author, I can enable data labels on a stacked bar/column chart (#440) * (DOCSP-13701): charts 1.21 release notes * DOCSP-13113: [CHARTS] As a user, I can choose chart customisation options with an accordion (#441) * (DOCSP-13578) Resize table text (#442) * (DOCSP-13578) Resize table text * update terminology * move section to table chart topic * add link to other customization * DOCSP-13401: [CHARTS] As an author, I can wrap text in specific Table columns (#445) * DOCSP-13223: [CHARTS] As an author, I can add a trendline to a chart (#446) * DOCSP-13400: [CHARTS] [LeafyGreen] Update all buttons in dashboard header to LG (#443) Co-authored-by: John Williams <[email protected]> Co-authored-by: zach-carr <[email protected]>
1 parent c5d2758 commit da2b677

37 files changed

+393
-222
lines changed

source/bin-data.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ start date.
359359
~~~~~~~~
360360

361361
The following chart groups genres from the
362-
:ref:`Movies Sample Data <sample-data>` into broader bins:
362+
:ref:`Movies Sample Data <charts-sample-data>` into broader bins:
363363

364364
- :guilabel:`Historical Movies`, which includes the genres
365365
Documentary, Biography, History, and War.

source/build-charts.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Learn More
6767
:titlesonly:
6868

6969
/encoding-channels
70+
/title-description
7071
/single-series-categories
7172
/multi-series-charts
7273
/rich-schema-support

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,17 @@ The maximum query response size for a data table is 50000 documents.
103103

104104
.. _data-table-example:
105105

106+
Customization Options
107+
---------------------
108+
109+
You have the option to make text which does not fit in a single data cell
110+
wrap across multiple lines. This setting is off by default. To turn it on:
111+
112+
1. Select the :guilabel:`Customize` tab of the Chart Builder.
113+
#. Expand the :guilabel:`Fields` section.
114+
#. Select your desired field from the dropdown menu.
115+
#. Toggle the :guilabel:`Wrap Text` switch to enable this feature.
116+
106117
Examples
107118
--------
108119

@@ -174,5 +185,6 @@ mean weekly price as currency.
174185

175186
/chart-type-reference/data-table/reorder-columns
176187
/chart-type-reference/data-table/sort-resize-columns
188+
/chart-type-reference/data-table/resize-table-text
177189
/chart-type-reference/data-table/toggle-row-column-totals
178190
/chart-type-reference/data-table/limit-rows
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _resize-table-text:
2+
3+
======================
4+
Resize Data Table Text
5+
======================
6+
7+
You can resize :ref:`Data Table <data-table-example>` chart text.
8+
Resizing table text changes the pixel size of the following components:
9+
10+
- Header text, including icons
11+
- Body text and the vertical height of rows
12+
- Footer text
13+
14+
Procedure
15+
---------
16+
17+
To resize data table text:
18+
19+
1. Navigate to the :guilabel:`Customize` tab in the
20+
:doc:`Chart Builder </build-charts>`.
21+
22+
#. In the :guilabel:`General` section, set the
23+
:guilabel:`Text Size` to the desired number of pixels. You can
24+
adjust text size to be between 8 and 24 pixels. The default is 14
25+
pixels.
26+
27+
For a complete list of Chart Customization options, see :doc:`Customize
28+
Charts </customize-charts/>`.

source/chart-type-reference/geo-spatial.txt

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,74 @@ intensity to compare concentrations of data points on a map.
7373
:figwidth: 700px
7474
:alt: Heatmap chart example
7575

76+
Customization Options
77+
---------------------
78+
79+
You can customize geospatial charts in several ways, including custom color
80+
palettes, viewport options, data marker size and opacity, and heatmap radius.
81+
82+
.. figure:: /images/charts/geospatial-customization-tab.png
83+
:figwidth: 242px
84+
:alt: Geospatial customization tab
85+
86+
Custom Color Palette
87+
~~~~~~~~~~~~~~~~~~~~
88+
89+
The color palette specifies the range of colors that corresponds to
90+
relative aggregated values in your map.
91+
92+
:ref:`Geospatial Scatter <scatter-ref>` charts use a discrete color
93+
picker, and :ref:`Geospatial Heatmap <geospatial-heatmap-type>` and
94+
:ref:`Choropleth <choropleth-ref>` charts use a gradient color picker,
95+
but the mechanism to enable customization is the same. To enable
96+
palette customization, toggle the :guilabel:`Custom Color Palette`
97+
switch in the :guilabel:`General` section.
98+
99+
For more information, see :ref:`Color Palette Customization
100+
<color-palette-customization>`.
101+
102+
Automatically Set Viewport
103+
~~~~~~~~~~~~~~~~~~~~~~~~~~
104+
105+
By default, geospatial charts show a map which includes all the data
106+
point markers in your specified collection. You can pan and zoom to
107+
change the map view, but if you close the chart and re-open it the map
108+
reverts to its default state. This behavior is controlled by the
109+
:guilabel:`Automatically Set Viewport` option.
110+
111+
When you toggle the :guilabel:`Automatically Set Viewport` switch to
112+
``Off``, the area and zoom level at which the map is saved becomes the
113+
new default view.
114+
115+
.. note::
116+
117+
You can pan and zoom the map area in a chart on a dashboard, but
118+
these changes do not affect the default map view.
119+
120+
Opacity
121+
~~~~~~~
122+
123+
The :guilabel:`Opacity` level of a map modifies the degree to which
124+
the chart's map data shows through the data point markers. This
125+
setting is available on all geospatial charts.
126+
127+
On :ref:`Geospatial Heatmap <geospatial-heatmap-type>` and
128+
:ref:`Choropleth <choropleth-ref>` charts, the :guilabel:`Opacity`
129+
level defaults to 100%. On :ref:`Geospatial Scatter <scatter-ref>`
130+
charts, it defaults to 20%.
131+
132+
Radius
133+
~~~~~~
134+
135+
.. include:: /includes/radius-description.rst
136+
137+
Stroke Thickness
138+
~~~~~~~~~~~~~~~~
139+
140+
:ref:`Scatter <scatter-ref>` charts provide the customization option
141+
to set the :guilabel:`Stroke Thickness`, measured in pixels, of the
142+
map's data point markers. This setting defaults to ``2``.
143+
76144
.. toctree::
77145
:titlesonly:
78146

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,13 @@ Continuous line and area charts provide the following
152152
mapped to the :guilabel:`Y Axis aggregation`
153153
:ref:`encoding channel <encoding-channels>`.
154154

155+
.. _smart-labels-dates:
156+
157+
Smart Date Labels for Continuous Line and Area Charts
158+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
159+
160+
.. include:: /includes/smart-labels.rst
161+
155162
Discrete Area Versus Continuous Area Charts Display
156163
---------------------------------------------------
157164

@@ -389,6 +396,11 @@ Show or Hide Data Value Labels
389396

390397
.. include:: /includes/customization/show-hide-data-labels.rst
391398

399+
Add a Trendline
400+
~~~~~~~~~~~~~~~
401+
402+
.. include:: /includes/customization/trendline.rst
403+
392404
Limitations
393405
-----------
394406

source/chart-type-reference/scatter-chart.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,16 @@ encoding channel.
130130
and also controls the difference between the smallest and largest
131131
marks.
132132

133+
Smart Date Labels
134+
~~~~~~~~~~~~~~~~~
135+
136+
.. include:: /includes/smart-labels.rst
137+
138+
Add a Trendline
139+
~~~~~~~~~~~~~~~
140+
141+
.. include:: /includes/customization/trendline.rst
142+
133143
Examples
134144
--------
135145

source/customize-charts.txt

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,18 @@ particular chart type.
2424

2525
|charts| provides the following types of customization options:
2626

27-
General Customizaton Options
27+
General
2828
:ref:`General Customization Options <general-customization>` modify
2929
high-level aspects of the chart such as its colors and data labels.
3030
These options affect the overall look and format of your data.
3131

32-
Field-Level Options
32+
Axes
33+
:ref:`Value Axis Options <value-axis-options>` modify the
34+
chart's axes, such as their scale and their minimum and maximum
35+
values. These options only affect the chart's axes, and not how
36+
|charts-short| formats data points in the visualization.
37+
38+
Fields
3339
:ref:`Field-Level Options <field-level-options>` modify how
3440
|charts-short| renders data fields, such as specific formatting
3541
for numbers and dates. These options apply to individual data fields
@@ -39,24 +45,7 @@ Field-Level Options
3945
:ref:`channel type <charts-channel-type-table>` of the field you are
4046
customizing.
4147

42-
Value Axis Options
43-
:ref:`Value Axis Options <value-axis-options>` modify the
44-
chart's axes, such as their scale and their minimum and maximum
45-
values. These options only affect the chart's axes, and not how
46-
|charts-short| formats data points in the visualization.
47-
48-
Geospatial Customization Options
49-
:ref:`Geospatial customization options <geospatial-customization>`
50-
modify options specific to :ref:`geospatial charts
51-
<geo-spatial-charts>`, including viewport options, data marker size
52-
and opacity, and heatmap radius.
53-
54-
Secondary Y Axis
55-
If you map multiple :guilabel:`Aggregation` or :guilabel:`Value` fields
56-
to the :guilabel:`Y axis`, you can plot one set of values on a :ref:`secondary
57-
Y axis <secondary-y-axis>`.
58-
59-
To customize a chart, click the :guilabel:`Customization` tab above the
48+
To customize a chart, click the :guilabel:`Customize` tab above the
6049
:ref:`encoding channels <encoding-channels>` in the
6150
:doc:`Chart Builder </build-charts>`:
6251

@@ -70,7 +59,5 @@ Your chart automatically updates as you modify customization options.
7059
:titlesonly:
7160

7261
/customize-charts/general-customization
73-
/customize-charts/field-level-options
7462
/customize-charts/value-axis-options
75-
/customize-charts/geospatial-customization
76-
/customize-charts/secondary-y-axis
63+
/customize-charts/field-level-options

source/customize-charts/field-level-options.txt

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _field-level-options:
22

3-
===================
4-
Field-Level Options
5-
===================
3+
======
4+
Fields
5+
======
66

77
.. default-domain:: mongodb
88

@@ -16,6 +16,17 @@ Within the customization tab, you can modify how |charts| displays
1616
data fields in your visualization. The customization options
1717
available depend on the data type of the value you are customizing.
1818

19+
.. note::
20+
21+
This page illustrates the field-level customization options which are
22+
available for most :ref:`chart types <chart-type-reference>`. Some
23+
chart types have other customization options which are noted on their
24+
individual documentation pages.
25+
26+
To access field-level customization options, expand the :guilabel:`General`
27+
section of the :guilabel:`Customize` tab. Select the desired field from
28+
the dropdown menu.
29+
1930
.. figure:: /images/charts/field-level-custom.png
2031
:figwidth: 251px
2132
:alt: Field level customizations
@@ -33,11 +44,13 @@ insightful or descriptive field labels.
3344

3445
To override a field label:
3546

36-
1. Navigate to the :guilabel:`Customization` tab in the
47+
1. Navigate to the :guilabel:`Customize` tab in the
3748
:doc:`Chart Builder </build-charts>`.
3849

39-
#. Click the field whose label you wish to modify to expand its
40-
customization options.
50+
#. Expand the :guilabel:`Fields` section.
51+
52+
#. Select the field whose label you wish to modify from the dropdown menu
53+
to expand its customization options.
4154

4255
#. Set the :guilabel:`Label Override` toggle switch to :guilabel:`On`.
4356

@@ -92,10 +105,13 @@ as convert dates to a specified time zone.
92105

93106
To customize date formats and configure time zones:
94107

95-
1. Navigate to the :guilabel:`Customization` tab in the
108+
1. Navigate to the :guilabel:`Customize` tab in the
96109
:doc:`Chart Builder </build-charts>`.
97110

98-
#. Click the field whose date format and time zone you wish to modify.
111+
#. Expand the :guilabel:`Fields` section.
112+
113+
#. Select the field whose date format and time zone you wish to modify
114+
from the dropdown menu.
99115

100116
#. Configure the :ref:`Date and Time Formatting <date-time-format>` and
101117
:ref:`Convert Time Zone <convert-time-zone>` settings as desired.

source/customize-charts/general-customization.txt

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _general-customization:
22

3-
=============================
4-
General Customization Options
5-
=============================
3+
=======
4+
General
5+
=======
66

77
.. default-domain:: mongodb
88

@@ -16,12 +16,22 @@ General Customization Options
1616
visualization at a high level, rather than individual pieces of the
1717
visualization.
1818

19+
.. note::
20+
21+
This page illustrates the general customization options which are
22+
available for most :ref:`chart types <chart-type-reference>`. Some
23+
chart types have other customization options which are noted on their
24+
individual documentation pages.
25+
26+
To access the general customization options, expand the :guilabel:`General`
27+
section of the :guilabel:`Customize` tab.
28+
1929
.. figure:: /images/charts/general-custom.png
2030
:figwidth: 251px
2131
:alt: Field level customizations
2232

23-
Resize Text Labels
24-
------------------
33+
Resize Labels
34+
-------------
2535

2636
You can resize the text labels on a chart. Resizing text labels changes:
2737

@@ -33,10 +43,10 @@ You can resize the text labels on a chart. Resizing text labels changes:
3343

3444
To set this option:
3545

36-
1. Navigate to the :guilabel:`Customization` tab in the
46+
1. Navigate to the :guilabel:`Customize` tab in the
3747
:doc:`Chart Builder </build-charts>`.
38-
39-
#. In the :guilabel:`General Customization` section, set the
48+
#. Expand the :guilabel:`General` section.
49+
#. In the :guilabel:`General` section, set the
4050
:guilabel:`Label Size` slider to the desired text size. You can
4151
adjust label text to be between 50% and 200% of the default text
4252
size.
@@ -58,10 +68,10 @@ specify its position relative to your chart.
5868

5969
To set this option:
6070

61-
1. Navigate to the :guilabel:`Customization` tab in the
71+
1. Navigate to the :guilabel:`Customize` tab in the
6272
:doc:`Chart Builder </build-charts>`.
63-
64-
#. In the :guilabel:`General Customization` section, set the
73+
#. Expand the :guilabel:`General` section.
74+
#. In the :guilabel:`General` section, set the
6575
:guilabel:`Legend` toggle switch to the desired setting. The
6676
legend is shown by default.
6777

@@ -88,9 +98,9 @@ Color Palette Customization
8898

8999
Palette customization allows you to select custom colors for your
90100
chart. To enable color customization, select the
91-
:guilabel:`Customization` tab of the :guilabel:`Chart Type` column.
101+
:guilabel:`Customize` tab of the :guilabel:`Chart Type` column.
92102
A toggle switch labeled :guilabel:`Custom Color Palette` appears in
93-
the :guilabel:`General Customization` section.
103+
the :guilabel:`General` section.
94104

95105
Most chart types allow you to customize individual colors in their
96106
palette. The :ref:`heatmap <heatmap-chart-ref>` and :ref:`colored bar

0 commit comments

Comments
 (0)