Skip to content

Commit e255f02

Browse files
authored
(DOCSP-9656) Charts embedding SDK background option (#327)
* (DOCSP-9656) Charts embedding SDK background option
1 parent 4d57617 commit e255f02

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
'.. |aws| replace:: :abbr:`AWS (Amazon Web Services)`',
6767
'.. |gcp| replace:: :abbr:`GCP (Google Cloud Platform)`',
6868
'.. |html| replace:: :abbr:`HTML (HyperText Markup Language)`',
69+
'.. |css| replace:: :abbr:`CSS (Cascading Style Sheets)`',
6970
]
7071

7172
rst_epilog.extend(get_replacements(conf))

source/embedding-charts-sdk.txt

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,34 @@ of the chart by calling methods on its handle.
210210
* - ``theme``
211211
- string
212212
- A :ref:`theme <chart-display-theme>` for the chart to use. Valid
213-
options are ``light`` and ``dark``. Defaults to ``light``.
213+
options are:
214+
215+
- ``light`` for a light background with dark text and chart
216+
elements, or
217+
218+
- ``dark`` for a dark background with light text and chart
219+
elements.
220+
221+
Defaults to ``light``.
222+
- no
223+
224+
* - ``background``
225+
- string
226+
- A background color to apply to your chart instead of the
227+
``theme`` background. You can specify:
228+
229+
- A color hex code
230+
231+
- A |css| color name
232+
233+
- ``transparent`` for a transparent background
234+
235+
If no background is provided, the background color defaults to
236+
the current ``theme``:
237+
238+
- ``#FFFFFF`` for the ``light`` theme, or
239+
240+
- ``#21313C`` for the ``dark`` theme.
214241
- no
215242

216243
* - ``showAttribution``

0 commit comments

Comments
 (0)