You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/embed-methods.adoc
+30-37Lines changed: 30 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,31 +14,30 @@ Based on your embedding requirements and integration setup, you can use one of t
14
14
15
15
* xref:getting-started.adoc[Embed using Visual Embed SDK] (Recommended)
16
16
* xref:embed-without-sdk.adoc[iFrame embedding without SDK]
17
-
* link:https://docs.thoughtspot.com/software/7.2/embedding[Legacy embedding method with app.min.js, window=_blank] (ThoughtSpot Software only)
17
+
//* link:https://docs.thoughtspot.com/software/7.2/embedding[Legacy embedding method with app.min.js, window=_blank] (ThoughtSpot Software only)
18
18
19
19
To determine the method that best fits your embedding requirement, refer to the information in the following tables.
20
20
21
21
[div boxAuto]
22
22
--
23
-
[width="100%" cols="4,7,7,7"]
23
+
[width="100%" cols="4,7,7"]
24
24
[options='header']
25
25
|=====
26
-
||Visual Embed SDK|Embed without SDK|Legacy embedding method
27
-
s|When to use|The SDK Supports all embed and customization use cases. Use the SDK for embedding ThoughtSpot if your host platform allows custom Javascript.
28
-
|Use this method only if your host platform doesn't allow custom Javascript. This method involves embedding a ThoughtSpot component in an iFrame.| The legacy embedding method is available for only ThoughtSpot Software deployments. With this method, you can embed a ThoughtSpot page, object, or the full application using `api.min.js` script.
26
+
||Visual Embed SDK|Embed without SDK
27
+
s|When to use|The SDK supports all embed and customization use cases. Use the SDK for embedding ThoughtSpot if your host platform allows custom Javascript.
28
+
|Use this method only if your host platform doesn't allow custom Javascript. This method involves embedding a ThoughtSpot component in an iFrame.
29
+
29
30
s|Feature availability a|
30
31
ThoughtSpot Cloud ts7.may.cl or later +
31
32
ThoughtSpot Software version 8.4.1-sw or later a|
32
33
ThoughtSpot Cloud ts7.may.cl or later +
33
-
ThoughtSpot Software version 6.0 or later a| ThoughtSpot Software version 6.0 or later
34
-
35
-
ThoughtSpot recommends using Visual Embed SDK and ThoughtSpot Embedded features from 8.4.1-sw onwards.
34
+
ThoughtSpot Software version 6.0 or later
36
35
37
36
s|Required user privilege|`DEVELOPER` +
38
37
`ADMINISTRATOR`
39
-
|`ADMINISTRATOR`|`ADMINISTRATOR`
38
+
|`ADMINISTRATOR`
40
39
41
-
s|Maintenance and support|Available | Available | Limited support
40
+
s|Maintenance and support|Available|Available
42
41
|=====
43
42
--
44
43
== Feature comparison
@@ -47,50 +46,44 @@ The following table lists the features available with each embed flavor:
47
46
48
47
[div tableContainer tableStyle1]
49
48
--
50
-
[width="100%" cols="4,5,5,6,6"]
49
+
[width="100%" cols="4,5,5,6"]
51
50
[options='header']
52
51
|=====
53
-
|Feature category|Features|Visual Embed SDK|Embedding without SDK |Legacy embedding method
52
+
|Feature category|Features|Visual Embed SDK|Embedding without SDK
|Auto-login on authentication expiry|[tag greenBackground tick]#✓#|[tag greyBackground tick]#–#
76
67
77
-
.4+|**Granular control of embedded UI**|Customization flags such as hiding data sources, search options configuration, setting a Liveboard to full height, and so on| [tag greenBackground tick]#✓#|[tag greyBackground tick]#–#|[tag greyBackground tick]#–#|
78
-
Show or hide UI menu actions| [tag greenBackground tick]#✓#| [tag greyBackground tick]#–#|[tag greyBackground tick]#–#|
79
-
Style customization and rebranding of UI elements|[tag greenBackground tick]#✓# |[tag greenBackground tick]#✓# |[tag greenBackground tick]#✓# |
80
-
Link customization|[tag greenBackground tick]#✓#|[tag greenBackground tick]#✓#|[tag greenBackground tick]#✓#|
**Events** a|Ability to trigger and handle embed lifecycle and host app events +
71
+
.4+|**Granular control of embedded UI**|Customization flags such as hiding data sources, search options configuration, setting a Liveboard to full height, and more|[tag greenBackground tick]#✓#|[tag greyBackground tick]#–#
72
+
|Show or hide UI menu actions|[tag greenBackground tick]#✓#|[tag greyBackground tick]#–#
73
+
|Style customization and rebranding of UI elements|[tag greenBackground tick]#✓#|[tag greenBackground tick]#✓#
Interaction between host and embedded ThoughtSpot app| [tag greenBackground tick]#✓# |[tag greyBackground tick]#–#|[tag greyBackground tick]#–# +
76
+
|**Events** a|Ability to trigger and handle embed lifecycle and host app events +
85
77
86
-
__Legacy events only__|
78
+
Interaction between host and embedded ThoughtSpot app|[tag greenBackground tick]#✓#|[tag greyBackground tick]#–#
87
79
88
-
**Runtime filters**|Ability to pass filters as URL query parameters|[tag greenBackground tick]#✓#|[tag greenBackground tick]#✓# |[tag greenBackground tick]#✓# |
80
+
|**Runtime filters**|Ability to pass filters as URL query parameters|[tag greenBackground tick]#✓#|[tag greenBackground tick]#✓#
89
81
90
-
**React components**|Ability to embed ThoughtSpot components in a React app|[tag greenBackground tick]#✓# |[tag greyBackground tick]#–#|[tag greyBackground tick]#–#|
82
+
|**React components**|Ability to embed ThoughtSpot components in a React app|[tag greenBackground tick]#✓#|[tag greyBackground tick]#–#|
91
83
|=====
92
84
--
93
85
86
+
////
94
87
== Embed using REST APIs
95
88
96
89
ThoughtSpot REST API framework supports data APIs, using which you can embed an answer, Liveboard, or a specific visualization from a Liveboard. You can use these APIs with or without the SDK to embed ThoughtSpot content in your app.
0 commit comments