Skip to content

Commit 5781bac

Browse files
(DOCSP-11436): Show gauge chart as a percentage
1 parent 58909ab commit 5781bac

File tree

2 files changed

+85
-41
lines changed

2 files changed

+85
-41
lines changed

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

Lines changed: 85 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -56,74 +56,118 @@ To access the customization options, click the :guilabel:`Customize` tab
5656
above the encoding channels in the Chart Builder.
5757

5858
.. figure:: /images/charts/customize-tab.png
59-
:figwidth: 252
59+
:figwidth: 200
6060
:alt: Customization tab
6161

6262
General Customization
6363
~~~~~~~~~~~~~~~~~~~~~
6464

65-
- :guilabel:`Custom Color Palette`
66-
67-
Off by default. Toggle on to enable. Only the first palette color is used by
68-
gauge charts.
69-
70-
- :guilabel:`Value Label`
71-
72-
Off by default. Toggle on to enable. Controls whether a label is displayed
73-
above the :guilabel:`Value` number.
74-
75-
- :guilabel:`Max/Min Values`
76-
77-
On by default. Controls whether the minimum and maximum range
78-
numbers are displayed at the left and right edges of the chart.
65+
.. list-table::
66+
:header-rows: 1
67+
:stub-columns: 1
68+
:widths: 20 60 20
7969

80-
- :guilabel:`Target Label & Value`
70+
* - Option
71+
- Description
72+
- Default
8173

82-
Off by default. Toggle on to enable. Controls whether the :guilabel:`Target`
83-
value and its label are displayed at the bottom of the chart.
74+
* - :guilabel:`Custom Color Palette`
75+
- Only the first palette color is used by gauge charts.
76+
- Off
77+
78+
* - :guilabel:`Value Label`
79+
- Controls whether a label is displayed above the
80+
:guilabel:`Value` number.
81+
- Off
82+
83+
* - :guilabel:`Max/Min Values`
84+
- Controls whether the minimum and maximum range
85+
numbers are displayed at the left and right edges of the chart.
86+
- On
87+
88+
* - :guilabel:`Target Label & Value`
89+
- Controls whether the :guilabel:`Target`
90+
value and its label are displayed at the bottom of the chart.
91+
- Off
92+
93+
* - :guilabel:`Show As Percentage`
94+
- Controls whether the value of your gauge chart is
95+
shown as a percentage of the :guilabel:`Target` value. If you
96+
enable this option and do not have a :guilabel:`Target` value,
97+
the value is shown is a percentage of the maximum value.
98+
For more information, see :ref:`target-max`.
99+
- Off
84100

85101
Value Axis
86102
~~~~~~~~~~
87103

88-
- :guilabel:`Maximum`
89-
90-
Off by default. Toggle on to enable. Specifies the maximum range of the
91-
gauge when enabled. See :ref:`Target and Maximum Interaction <target-max>`
92-
for more information on how the maximum range of the gauge is determined.
104+
.. list-table::
105+
:header-rows: 1
106+
:stub-columns: 1
107+
:widths: 20 60 20
93108

94-
- :guilabel:`Minimum`
109+
* - Option
110+
- Description
111+
- Default
95112

96-
Off by default. Toggle on to enable. Specifies the minimum range of the
97-
gauge when enabled. Defaults to ``0``.
113+
* - :guilabel:`Maximum`
114+
- Specifies the maximum range
115+
of the gauge when enabled. See :ref:`Target and Maximum
116+
Interaction <target-max>` for more information on how the maximum
117+
range of the gauge is determined.
118+
- Off
119+
120+
* - :guilabel:`Minimum`
121+
- Specifies the minimum range of the gauge when enabled. Defaults
122+
to ``0``.
123+
- Off
124+
98125

99126
Value Field
100127
~~~~~~~~~~~
101128

102-
- :guilabel:`Label Override`
129+
.. list-table::
130+
:header-rows: 1
131+
:stub-columns: 1
132+
:widths: 20 60 20
103133

104-
Off by default. Toggle on to enable. When enabled, displays a custom
105-
label for the :guilabel:`Value` number if the :guilabel:`Value Label`
106-
option is also enabled. Displays a custom label for the Value Field tooltips.
134+
* - Option
135+
- Description
136+
- Default
107137

108-
- :guilabel:`Number Formatting`
138+
* - :guilabel:`Label Override`
139+
- When enabled, displays a custom label for the :guilabel:`Value`
140+
number if the :guilabel:`Value Label` option is also enabled.
141+
Displays a custom label for the Value Field tooltips.
142+
- Off
109143

110-
Controls formatting of the large value in the chart, the tooltips,
111-
and the min/max labels.
144+
* - :guilabel:`Number Formatting`
145+
- Controls formatting of the large value in the chart, the
146+
tooltips, and the min/max labels.
147+
- None
112148

113149
Target Field
114150
~~~~~~~~~~~~
115151

116-
- :guilabel:`Label Override`
152+
.. list-table::
153+
:header-rows: 1
154+
:stub-columns: 1
155+
:widths: 20 60 20
117156

118-
Off by default. Toggle on to enable. When enabled, displays a custom
119-
label for the :guilabel:`Target` value if the :guilabel:`Target Label
120-
& Value` option is also enabled. Displays a custom label for the Target
121-
Field tooltips.
157+
* - Option
158+
- Description
159+
- Default
122160

123-
- :guilabel:`Number Formatting`
161+
* - :guilabel:`Label Override`
162+
- When enabled, displays custom label for the :guilabel:`Target`
163+
value if the :guilabel:`Target Label & Value` option is also
164+
enabled. Displays a custom label for the Target Field tooltips.
165+
- Off
124166

125-
Controls formatting of the Target value if it is displayed under the
126-
chart.
167+
* - :guilabel:`Number Formatting`
168+
- Controls formatting of the Target value if it is displayed under
169+
the chart.
170+
- None
127171

128172
.. _target-max:
129173

64.4 KB
Loading

0 commit comments

Comments
 (0)