Skip to content

Commit 7864c9a

Browse files
Documentation edits made through Mintlify web editor
1 parent 436d391 commit 7864c9a

File tree

3 files changed

+19
-5
lines changed

3 files changed

+19
-5
lines changed
38.1 KB
Loading

references/embedding.mdx

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ There are a couple of known limitations today with embedding:
2222
- Embedding only works for dashboards, not table explores or single charts (unless the single chart is pinned to a dashboard first).
2323
- The **Filter dashboard to** option when clicking on individual chart segments will not work on embedded dashboards.
2424

25-
If you're interested in embedding and one or more of these items are blockers, please reach out - we can activate them quickly.
25+
If you're interested in embedding and one or more of these items are blockers, please reach out - we can activate them quickly.
2626

2727
## Embed secret
2828

@@ -72,7 +72,19 @@ To learn about getting your embedded dashboard to show different values for diff
7272

7373
### Interactivity
7474

75-
There are options to enable certain dashboard interactivity features on your embedded dashboard in this section. By default, all interactivity is disabled on an embedded dashboard.
75+
There are options to enable certain dashboard interactivity features on your embedded dashboard in this section. This includes filters as well as granular control over Lightdash features and capabilities. By default, all interactivity is disabled on an embedded dashboard.
76+
77+
**iframe**
78+
79+
To control interactive features for an embedded iframe, simply use the toggles in the settings page.
80+
81+
<Frame>
82+
![](/images/references/embedding-interactivity.png)
83+
</Frame>
84+
85+
**React SDK**
86+
87+
Use the React [SDK docs](/references/react-sdk).
7688

7789
#### Allow users to change dashboard filters
7890

@@ -120,17 +132,17 @@ On the embedded dashboard, this `download button` is accessible from the `...` o
120132

121133
This option allows users to open a dashboard chart in the [Lightdash Explore view](https://docs.lightdash.com/get-started/exploring-data/using-explores#select-your-fields). Within an embedded context, users can only interact with the chart from which they clicked "Explore from here". Any changes to a chart in this context will not be saved. Embedded users also are not able to run raw SQL for any Explores.
122134

123-
On the embedded dashboard, "Explore from here" is accessible from the `...` options menu located in the top right corner when hovering over the chart tile.
135+
On the embedded dashboard, "Explore from here" is accessible from the `...` options menu located in the top right corner when hovering over the chart tile.
124136

125137
<Frame>
126138
![](/images/references/embedding-explore-from-here.png)
127139
</Frame>
128140

129141
#### Can View Underlying Data
130142

131-
[View Underlying Data](/get-started/exploring-data/exploring-your-content#view-underlying-data) allows users to open a table for a given dashboard tile, and view a table of the data powering that tile. In the embedded context, users can only view the underlying data—that underlying data cannot be exported or opened in an Explore view.
143+
[View Underlying Data](/get-started/exploring-data/exploring-your-content#view-underlying-data) allows users to open a table for a given dashboard tile, and view a table of the data powering that tile. In the embedded context, users can only view the underlying data—that underlying data cannot be exported or opened in an Explore view.
132144

133-
The "View underlying data" option can be opened by clicking on a chart or big number to see the "View Underlying Data" menu option.
145+
The "View underlying data" option can be opened by clicking on a chart or big number to see the "View Underlying Data" menu option.
134146

135147
<Frame>
136148
![](/images/references/embedding-view-underlying-data.png)

references/react-sdk.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ const data = {
9393
canExportImages: false,
9494
canExportPagePdf: true,
9595
canDateZoom: false,
96+
canExplore: false,
97+
canViewUnderlyingData: false,
9698
},
9799
user: {
98100
externalId: undefined,

0 commit comments

Comments
 (0)