Skip to content

Commit 8c028eb

Browse files
DOCSP-26575 more information about embedded charts (#684)
1 parent f1586e0 commit 8c028eb

File tree

2 files changed

+49
-3
lines changed

2 files changed

+49
-3
lines changed

source/embedding-charts.txt

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,21 @@ with an :ref:`iframe <embedding-charts-iframe>`.
2525
To learn how to embed charts in a web application, see the
2626
:ref:`embedding-tutorials`.
2727

28-
To learn more, see :ref:`embedded-chart-options` and
29-
:ref:`filter-embedded-charts`.
28+
To learn about what you can do with an embedded chart, see
29+
:ref:`embedded-chart-options` and :ref:`filter-embedded-charts`.
30+
31+
How Authentication Works
32+
------------------------
33+
34+
When you visit a webpage with an embedded chart, the :ref:`Embedding
35+
SDK <embedding-charts-sdk>` sends the chart ID and the user's token to
36+
|charts|. |charts| then validates the token with an authentication
37+
provider.
38+
39+
If the token is valid for the specified chart ID, |charts| executes
40+
pipelines to the |service| database with any specified injected filters
41+
and returns the data back to the user's webpage. If the token is
42+
invalid, the user cannot view the embedded chart.
3043

3144
.. toctree::
3245
:titlesonly:

source/get-started-embedding.txt

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,40 @@ Get Started with Embedding
99
|charts-short| offers a :guilabel:`Getting Started` UI to help you
1010
learn how to embed :ref:`charts <embedding-charts>` and
1111
:ref:`dashboards <embedding-dashboards>` with an iFrame or Javascript
12-
SDK.
12+
SDK. You can use authenticated or unauthenticated embedding to view
13+
charts and dashboards generated from your environment.
14+
15+
Authenticated embedding allows you to perform the following actions to
16+
your charts and dashboards:
17+
18+
- Control user access
19+
- :ref:`Injected filtering <embedded-chart-options>`
20+
- :ref:`Google and JWT authentication <configure-auth-providers>`
21+
22+
Unauthenticated embedding allows you to perform the following actions to
23+
your charts and dashboards:
24+
25+
- Allow everyone with the chart or dashboard link to have view access
26+
- Specify the following options:
27+
28+
- Maximum data range
29+
- Auto-refresh
30+
- Color theme, width, and height
31+
- Whether to display the title and description
32+
33+
.. tip::
34+
35+
If you use the :ref:`Embedding SDK <embedding-charts-sdk>`, you can
36+
make more flexible adjustments to dashboard settings and rendering
37+
specifications such as styling and branding. To learn more, see
38+
:ref:`charts-embedding-sdk`.
39+
40+
Prerequisites
41+
-------------
42+
43+
- You must be a chart or dashboard :ref:`Author <dashboard-permissions>`
44+
to enable embedding for a chart or dashboard.
45+
- Access to the :ref:`data source <data-sources>`.
1346

1447
Use the Getting Started UI
1548
--------------------------

0 commit comments

Comments
 (0)