Skip to content

Commit bef58db

Browse files
steverenjeff-allen-mongo
authored andcommitted
DOCSP-4343: [Charts] Customization options (#144)
* DOCSP-4343: [Charts] Customization options
1 parent 547f7df commit bef58db

File tree

5 files changed

+89
-7
lines changed

5 files changed

+89
-7
lines changed

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

Lines changed: 72 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
:noprevnext:
22

3+
.. _geo-spatial-charts:
4+
35
=================
46
Geospatial Charts
57
=================
@@ -12,12 +14,80 @@ Geospatial Charts
1214
:depth: 1
1315
:class: singlecol
1416

15-
Placeholder description for the Geospatial chart type.
17+
Placeholder description for the geospatial chart type.
18+
19+
Customization
20+
-------------
21+
22+
To access the available customizations for any chart, click the
23+
:guilabel:`Customization` tab above the :ref:`encoding channels
24+
<encoding-channels>` in the :doc:`Chart Builder </build-charts>`.
25+
26+
.. figure:: /images/charts/geospatial-customization-tab.png
27+
:figwidth: 242px
28+
:alt: Geospatial customization tab
29+
30+
Custom Color Palette
31+
~~~~~~~~~~~~~~~~~~~~
32+
33+
The color palette specifies the range of colors that corresponds to
34+
relative aggregated values in your map.
35+
36+
:ref:`Geospatial Scatter <scatter-ref>` charts use a discrete color
37+
picker, and :ref:`Geospatial Heatmap <geospatial-heatmap-type>` and
38+
:ref:`Choropleth <choropleth-ref>` charts use a gradient color picker,
39+
but the mechanism to enable customization is the same. To enable
40+
palette customization, toggle the :guilabel:`Custom Color Palette`
41+
switch in the :guilabel:`General Customization` section.
42+
43+
For more information, see :ref:`Color Palette Customization
44+
<color-palette-customization>`.
45+
46+
Automatically Set Viewport
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~
48+
49+
By default, geospatial charts show a map which includes all the data
50+
point markers in your specified collection. You can pan and zoom to
51+
change the map view, but if you close the chart and re-open it the map
52+
reverts to its default state. This behavior is controlled by the
53+
:guilabel:`Automatically Set Viewport` option.
54+
55+
When you toggle the :guilabel:`Automatically Set Viewport` switch to
56+
``Off``, the area and zoom level at which the map is saved becomes the
57+
new default view.
58+
59+
.. note::
60+
61+
You can pan and zoom the map area in a chart on a dashboard, but
62+
these changes do not affect the default map view.
63+
64+
Opacity
65+
~~~~~~~
66+
67+
The :guilabel:`Opacity` level of a map modifies the degree to which
68+
the chart's map data shows through the data point markers. This
69+
setting is available on all geospatial charts.
70+
71+
On :ref:`Geospatial Heatmap <geospatial-heatmap-type>` and
72+
:ref:`Choropleth <choropleth-ref>` charts, the :guilabel:`Opacity`
73+
level defaults to 100%. On :ref:`Geospatial Scatter <scatter-ref>`
74+
charts, it defaults to 20%.
75+
76+
Radius
77+
~~~~~~
78+
79+
.. include:: /includes/radius-description.rst
80+
81+
Stroke Thickness
82+
~~~~~~~~~~~~~~~~
83+
84+
:ref:`Scatter <scatter-ref>` charts provide the customization option
85+
to set the :guilabel:`Stroke Thickness`, measured in pixels, of the
86+
map's data point markers. This setting defaults to ``2``.
1687

1788
.. class:: hidden
1889

1990
.. toctree::
2091
:titlesonly:
2192

2293
/chart-type-reference/geospatial-heatmap
23-

source/chart-type-reference/geospatial-heatmap.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _geospatial-heatmap-type:
2+
13
==================
24
Geospatial Heatmap
35
==================
@@ -49,11 +51,7 @@ Intensity
4951

5052
.. include:: /includes/intensity-definition.rst
5153

52-
In geospatial heatmaps, values are aggregated within the radius
53-
specified in the :doc:`customization </customize-charts>` tab.
54-
Radius is measured in pixels, and defaults to ``30``. For example:
55-
if ten data points exist within the specified radius, the color
56-
displayed is based on the aggregated value of those ten data points.
54+
.. include:: /includes/radius-description.rst
5755

5856
.. note::
5957

Loading

source/includes/chart-type-ref-list.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,7 @@ for each chart type in MongoDB Charts:
1818
- :ref:`Data Table <data-table-ref>`
1919

2020
- :ref:`Number Chart <number-chart-ref>`
21+
22+
- :ref:`Geospatial Charts <geo-spatial-charts>`
23+
24+
- :ref:`Heatmap <geospatial-heatmap-type>`
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
The radius customization option dictates the size of the data markers
2+
in :ref:`Geospatial Heatmaps <geospatial-heatmap-type>`. The color of
3+
each data marker reflects the aggregated value of all data points
4+
within that marker's radius. Radius is measured in pixels, and defaults
5+
to ``30``.
6+
7+
.. example::
8+
9+
If ten data points exist within the specified radius, the color
10+
displayed is based on the aggregated value of those ten data points.

0 commit comments

Comments
 (0)