@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts +29 -4
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +29 -7
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/auth.spec.js +1 -3
- package/cjs/src/auth.spec.js.map +1 -1
- package/cjs/src/authToken.js +0 -1
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/authToken.spec.js +2 -1
- package/cjs/src/authToken.spec.js.map +1 -1
- package/cjs/src/css-variables.d.ts +17 -17
- package/cjs/src/embed/app.d.ts +62 -33
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +10 -3
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +34 -1
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/auto-frame-renderer.d.ts +41 -0
- package/cjs/src/embed/auto-frame-renderer.d.ts.map +1 -0
- package/cjs/src/embed/auto-frame-renderer.js +145 -0
- package/cjs/src/embed/auto-frame-renderer.js.map +1 -0
- package/cjs/src/embed/auto-frame-renderer.spec.d.ts +2 -0
- package/cjs/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
- package/cjs/src/embed/auto-frame-renderer.spec.js +195 -0
- package/cjs/src/embed/auto-frame-renderer.spec.js.map +1 -0
- package/cjs/src/embed/base.d.ts +2 -2
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +6 -9
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/bodyless-conversation.d.ts +5 -5
- package/cjs/src/embed/bodyless-conversation.js +4 -4
- package/cjs/src/embed/conversation.d.ts +43 -30
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +10 -11
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +27 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +0 -2
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +42 -35
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +6 -4
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +5 -3
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +5 -5
- package/cjs/src/embed/sage.js +1 -2
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +7 -7
- package/cjs/src/embed/search-bar.js +1 -1
- package/cjs/src/embed/search.d.ts +13 -12
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +0 -2
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +3 -3
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +15 -9
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +37 -1
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +3 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +3 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/index.d.ts +15 -15
- package/cjs/src/react/index.js +12 -13
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +6 -3
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/tokenizedFetch.d.ts +1 -1
- package/cjs/src/tokenizedFetch.js +1 -1
- package/cjs/src/types.d.ts +350 -287
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +240 -218
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +9 -6
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +13 -15
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +55 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/graphql/preview-service.js +0 -1
- package/cjs/src/utils/graphql/preview-service.js.map +1 -1
- package/cjs/src/utils/processData.js +0 -5
- package/cjs/src/utils/processData.js.map +1 -1
- package/cjs/src/utils.d.ts +9 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +10 -1
- package/cjs/src/utils.js.map +1 -1
- package/dist/{index-Vyh6Ha5f.js → index-DyX-x6uN.js} +1 -1
- package/dist/src/auth.d.ts +29 -4
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/css-variables.d.ts +17 -17
- package/dist/src/embed/app.d.ts +62 -33
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/auto-frame-renderer.d.ts +41 -0
- package/dist/src/embed/auto-frame-renderer.d.ts.map +1 -0
- package/dist/src/embed/auto-frame-renderer.spec.d.ts +2 -0
- package/dist/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
- package/dist/src/embed/base.d.ts +2 -2
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/bodyless-conversation.d.ts +5 -5
- package/dist/src/embed/conversation.d.ts +43 -30
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +42 -35
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +5 -5
- package/dist/src/embed/search-bar.d.ts +7 -7
- package/dist/src/embed/search.d.ts +13 -12
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +3 -3
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +3 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +15 -15
- package/dist/src/tokenizedFetch.d.ts +1 -1
- package/dist/src/types.d.ts +350 -287
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +9 -6
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils.d.ts +9 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +359 -329
- package/dist/tsembed-react.js +358 -328
- package/dist/tsembed.es.js +490 -321
- package/dist/tsembed.js +489 -319
- package/dist/visual-embed-sdk-react-full.d.ts +574 -442
- package/dist/visual-embed-sdk-react.d.ts +572 -440
- package/dist/visual-embed-sdk.d.ts +622 -446
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +29 -4
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +29 -7
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.js +1 -3
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/authToken.js +0 -1
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/authToken.spec.js +2 -1
- package/lib/src/authToken.spec.js.map +1 -1
- package/lib/src/css-variables.d.ts +17 -17
- package/lib/src/embed/app.d.ts +62 -33
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +11 -4
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +34 -1
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/auto-frame-renderer.d.ts +41 -0
- package/lib/src/embed/auto-frame-renderer.d.ts.map +1 -0
- package/lib/src/embed/auto-frame-renderer.js +141 -0
- package/lib/src/embed/auto-frame-renderer.js.map +1 -0
- package/lib/src/embed/auto-frame-renderer.spec.d.ts +2 -0
- package/lib/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
- package/lib/src/embed/auto-frame-renderer.spec.js +192 -0
- package/lib/src/embed/auto-frame-renderer.spec.js.map +1 -0
- package/lib/src/embed/base.d.ts +2 -2
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +6 -9
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/bodyless-conversation.d.ts +5 -5
- package/lib/src/embed/bodyless-conversation.js +4 -4
- package/lib/src/embed/conversation.d.ts +43 -30
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +11 -11
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +27 -0
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +0 -2
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +42 -35
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +6 -4
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +5 -3
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +5 -5
- package/lib/src/embed/sage.js +1 -2
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +7 -7
- package/lib/src/embed/search-bar.js +1 -1
- package/lib/src/embed/search.d.ts +13 -12
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +0 -2
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +3 -3
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +15 -9
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +37 -1
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +3 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +1 -0
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/index.d.ts +15 -15
- package/lib/src/react/index.js +12 -13
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +6 -3
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/tokenizedFetch.d.ts +1 -1
- package/lib/src/tokenizedFetch.js +1 -1
- package/lib/src/types.d.ts +350 -287
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +240 -218
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +9 -6
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +12 -14
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +55 -0
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/graphql/preview-service.js +0 -1
- package/lib/src/utils/graphql/preview-service.js.map +1 -1
- package/lib/src/utils/processData.js +0 -5
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/utils.d.ts +9 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +8 -0
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +11466 -0
- package/package.json +1 -1
- package/src/auth.spec.ts +1 -1
- package/src/auth.ts +32 -7
- package/src/authToken.spec.ts +2 -1
- package/src/authToken.ts +1 -1
- package/src/css-variables.ts +17 -17
- package/src/embed/app.spec.ts +46 -1
- package/src/embed/app.ts +74 -36
- package/src/embed/auto-frame-renderer.spec.ts +266 -0
- package/src/embed/auto-frame-renderer.ts +152 -0
- package/src/embed/base.spec.ts +1 -1
- package/src/embed/base.ts +9 -10
- package/src/embed/bodyless-conversation.ts +5 -5
- package/src/embed/conversation.spec.ts +37 -0
- package/src/embed/conversation.ts +55 -38
- package/src/embed/hostEventClient/host-event-client.ts +2 -2
- package/src/embed/liveboard.spec.ts +5 -3
- package/src/embed/liveboard.ts +47 -38
- package/src/embed/sage.ts +6 -6
- package/src/embed/search-bar.tsx +7 -7
- package/src/embed/search.spec.ts +2 -2
- package/src/embed/search.ts +13 -12
- package/src/embed/ts-embed.spec.ts +44 -1
- package/src/embed/ts-embed.ts +14 -9
- package/src/index.ts +3 -0
- package/src/react/index.spec.tsx +6 -3
- package/src/react/index.tsx +16 -16
- package/src/tokenizedFetch.ts +1 -1
- package/src/types.ts +350 -286
- package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
- package/src/utils/graphql/answerService/answerService.ts +14 -10
- package/src/utils/graphql/preview-service.ts +1 -1
- package/src/utils/processData.ts +5 -5
- package/src/utils.ts +14 -0
package/cjs/src/types.d.ts
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { CustomCssVariables } from './css-variables';
|
|
9
9
|
import type { SessionInterface } from './utils/graphql/answerService/answerService';
|
|
10
10
|
/**
|
|
11
|
-
* The authentication mechanism for allowing access to
|
|
11
|
+
* The authentication mechanism for allowing access to
|
|
12
12
|
* the embedded app
|
|
13
13
|
* @group Authentication / Init
|
|
14
14
|
*/
|
|
@@ -33,6 +33,7 @@ export declare enum AuthType {
|
|
|
33
33
|
* To use this:
|
|
34
34
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
35
35
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
36
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
36
37
|
* @example
|
|
37
38
|
* ```js
|
|
38
39
|
* init({
|
|
@@ -40,18 +41,17 @@ export declare enum AuthType {
|
|
|
40
41
|
* authType: AuthType.EmbeddedSSO,
|
|
41
42
|
* });
|
|
42
43
|
* ```
|
|
43
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
44
44
|
*/
|
|
45
45
|
EmbeddedSSO = "EmbeddedSSO",
|
|
46
46
|
/**
|
|
47
|
-
* SSO using SAML
|
|
48
|
-
* @deprecated
|
|
47
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
48
|
+
* @deprecated This option is deprecated.
|
|
49
49
|
* @hidden
|
|
50
50
|
*/
|
|
51
51
|
SSO = "SSO_SAML",
|
|
52
52
|
/**
|
|
53
|
-
* SSO using SAML
|
|
54
|
-
* @deprecated
|
|
53
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
54
|
+
* @deprecated This option is deprecated.
|
|
55
55
|
* @hidden
|
|
56
56
|
*/
|
|
57
57
|
SAML = "SSO_SAML",
|
|
@@ -102,8 +102,9 @@ export declare enum AuthType {
|
|
|
102
102
|
SAMLRedirect = "SSO_SAML",
|
|
103
103
|
/**
|
|
104
104
|
* SSO using OIDC
|
|
105
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
106
|
+
* @deprecated This option is deprecated.
|
|
105
107
|
* @hidden
|
|
106
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
107
108
|
*/
|
|
108
109
|
OIDC = "SSO_OIDC",
|
|
109
110
|
/**
|
|
@@ -114,8 +115,9 @@ export declare enum AuthType {
|
|
|
114
115
|
OIDCRedirect = "SSO_OIDC",
|
|
115
116
|
/**
|
|
116
117
|
* Trusted authentication server
|
|
118
|
+
* Use {@link TrustedAuth} instead
|
|
119
|
+
* @deprecated This option is deprecated.
|
|
117
120
|
* @hidden
|
|
118
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
119
121
|
*/
|
|
120
122
|
AuthServer = "AuthServer",
|
|
121
123
|
/**
|
|
@@ -142,6 +144,7 @@ export declare enum AuthType {
|
|
|
142
144
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
143
145
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
144
146
|
* implemented by some browsers.
|
|
147
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
145
148
|
* @example
|
|
146
149
|
* ```js
|
|
147
150
|
* init({
|
|
@@ -152,8 +155,8 @@ export declare enum AuthType {
|
|
|
152
155
|
* .then((response) => response.json())
|
|
153
156
|
* .then((data) => data.token);
|
|
154
157
|
* }
|
|
158
|
+
* });
|
|
155
159
|
* ```
|
|
156
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
157
160
|
*/
|
|
158
161
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
159
162
|
/**
|
|
@@ -173,43 +176,43 @@ export declare enum HomeLeftNavItem {
|
|
|
173
176
|
/**
|
|
174
177
|
* The *Search data* option in
|
|
175
178
|
* the *Insights* left navigation panel.
|
|
176
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
179
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
177
180
|
*/
|
|
178
181
|
SearchData = "search-data",
|
|
179
182
|
/**
|
|
180
183
|
* The *Home* menu option in
|
|
181
184
|
* the *Insights* left navigation panel.
|
|
182
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
185
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
183
186
|
*/
|
|
184
187
|
Home = "insights-home",
|
|
185
188
|
/**
|
|
186
189
|
* The *Liveboards* menu option in
|
|
187
190
|
* the *Insights* left navigation panel.
|
|
188
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
191
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
189
192
|
*/
|
|
190
193
|
Liveboards = "liveboards",
|
|
191
194
|
/**
|
|
192
195
|
* The *Answers* menu option in
|
|
193
196
|
* the *Insights* left navigation panel.
|
|
194
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
197
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
195
198
|
*/
|
|
196
199
|
Answers = "answers",
|
|
197
200
|
/**
|
|
198
201
|
* The *Monitor subscriptions* menu option in
|
|
199
202
|
* the *Insights* left navigation panel.
|
|
200
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
203
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
201
204
|
*/
|
|
202
205
|
MonitorSubscription = "monitor-alerts",
|
|
203
206
|
/**
|
|
204
207
|
* The *SpotIQ analysis* menu option in
|
|
205
208
|
* the *Insights* left navigation panel.
|
|
206
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
209
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
207
210
|
*/
|
|
208
211
|
SpotIQAnalysis = "spotiq-analysis",
|
|
209
212
|
/**
|
|
210
213
|
* The *Liveboard schedules* menu option in
|
|
211
214
|
* the *Insights* left navigation panel.
|
|
212
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
215
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
213
216
|
*/
|
|
214
217
|
LiveboardSchedules = "liveboard-schedules",
|
|
215
218
|
/**
|
|
@@ -380,8 +383,8 @@ export interface EmbedConfig {
|
|
|
380
383
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
381
384
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
382
385
|
* place.
|
|
386
|
+
* @deprecated This option is deprecated.
|
|
383
387
|
* @default false
|
|
384
|
-
* @deprecated
|
|
385
388
|
*/
|
|
386
389
|
noRedirect?: boolean;
|
|
387
390
|
/**
|
|
@@ -390,8 +393,8 @@ export interface EmbedConfig {
|
|
|
390
393
|
*
|
|
391
394
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
392
395
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
393
|
-
* @default false
|
|
394
396
|
* @version SDK: 1.18.0
|
|
397
|
+
* @default false
|
|
395
398
|
*/
|
|
396
399
|
inPopup?: boolean;
|
|
397
400
|
/**
|
|
@@ -400,7 +403,7 @@ export interface EmbedConfig {
|
|
|
400
403
|
* terminated.
|
|
401
404
|
*
|
|
402
405
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
403
|
-
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
406
|
+
* @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
404
407
|
*/
|
|
405
408
|
redirectPath?: string;
|
|
406
409
|
/** @internal */
|
|
@@ -473,7 +476,7 @@ export interface EmbedConfig {
|
|
|
473
476
|
detectCookieAccessSlow?: boolean;
|
|
474
477
|
/**
|
|
475
478
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
476
|
-
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
479
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
477
480
|
*/
|
|
478
481
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
479
482
|
/**
|
|
@@ -490,6 +493,7 @@ export interface EmbedConfig {
|
|
|
490
493
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
491
494
|
* button that the user can click to trigger the flow.
|
|
492
495
|
* This attribute sets a containing element for that button.
|
|
496
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
493
497
|
* @example
|
|
494
498
|
* ```js
|
|
495
499
|
* init({
|
|
@@ -498,7 +502,6 @@ export interface EmbedConfig {
|
|
|
498
502
|
* authTriggerContainer: '#auth-trigger-container'
|
|
499
503
|
* })
|
|
500
504
|
* ```
|
|
501
|
-
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
502
505
|
*/
|
|
503
506
|
authTriggerContainer?: string | HTMLElement;
|
|
504
507
|
/**
|
|
@@ -515,11 +518,10 @@ export interface EmbedConfig {
|
|
|
515
518
|
*/
|
|
516
519
|
authTriggerText?: string;
|
|
517
520
|
/**
|
|
518
|
-
* Prevent users from accessing
|
|
519
|
-
*
|
|
520
|
-
* outside of the iframe.
|
|
521
|
-
* @default true
|
|
521
|
+
* Prevent embedded application users from accessing ThoughtSpot
|
|
522
|
+
* application pages outside of the iframe.
|
|
522
523
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
524
|
+
* @default true
|
|
523
525
|
*/
|
|
524
526
|
blockNonEmbedFullAppAccess?: boolean;
|
|
525
527
|
/**
|
|
@@ -549,6 +551,7 @@ export interface EmbedConfig {
|
|
|
549
551
|
* other logs such as warnings, information alerts,
|
|
550
552
|
* and debug messages in the console output.
|
|
551
553
|
*
|
|
554
|
+
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
552
555
|
* @default LogLevel.ERROR
|
|
553
556
|
* @example
|
|
554
557
|
* ```js
|
|
@@ -557,7 +560,6 @@ export interface EmbedConfig {
|
|
|
557
560
|
* logLevel: LogLevel.SILENT
|
|
558
561
|
* })
|
|
559
562
|
* ```
|
|
560
|
-
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
561
563
|
*/
|
|
562
564
|
logLevel?: LogLevel;
|
|
563
565
|
/**
|
|
@@ -584,6 +586,7 @@ export interface EmbedConfig {
|
|
|
584
586
|
* This flag is used to disable the token verification in the SDK.
|
|
585
587
|
* Enabling this flag will also disable the caching of the token.
|
|
586
588
|
* @hidden
|
|
589
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
587
590
|
* @example
|
|
588
591
|
* ```js
|
|
589
592
|
* init({
|
|
@@ -591,12 +594,11 @@ export interface EmbedConfig {
|
|
|
591
594
|
* disableTokenVerification : true
|
|
592
595
|
* })
|
|
593
596
|
* ```
|
|
594
|
-
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
595
597
|
*/
|
|
596
598
|
disableTokenVerification?: boolean;
|
|
597
599
|
/**
|
|
598
600
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
599
|
-
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
601
|
+
* @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
600
602
|
*/
|
|
601
603
|
disableLoginFailurePage?: boolean;
|
|
602
604
|
/**
|
|
@@ -606,6 +608,7 @@ export interface EmbedConfig {
|
|
|
606
608
|
* Warning: This option is for advanced use only and is used internally
|
|
607
609
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
608
610
|
* list of supported keys and values associated with each.
|
|
611
|
+
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
609
612
|
* @example
|
|
610
613
|
* ```js
|
|
611
614
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -616,7 +619,6 @@ export interface EmbedConfig {
|
|
|
616
619
|
* }
|
|
617
620
|
* });
|
|
618
621
|
* ```
|
|
619
|
-
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
620
622
|
*/
|
|
621
623
|
additionalFlags?: {
|
|
622
624
|
[key: string]: string | number | boolean;
|
|
@@ -624,6 +626,7 @@ export interface EmbedConfig {
|
|
|
624
626
|
/**
|
|
625
627
|
* This is an object (key/val) for customVariables being
|
|
626
628
|
* used by the third party tool's script.
|
|
629
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
627
630
|
* @example
|
|
628
631
|
* ```js
|
|
629
632
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -634,15 +637,14 @@ export interface EmbedConfig {
|
|
|
634
637
|
* }
|
|
635
638
|
* });
|
|
636
639
|
* ```
|
|
637
|
-
* @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
638
640
|
*/
|
|
639
641
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
640
642
|
disablePreauthCache?: boolean;
|
|
641
643
|
/**
|
|
642
644
|
* Disable fullscreen presentation mode functionality. When enabled, prevents entering
|
|
643
645
|
* and exiting fullscreen mode for embedded visualizations during presentations.
|
|
644
|
-
* @default true (feature is disabled by default)
|
|
645
646
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
647
|
+
* @default true (feature is disabled by default)
|
|
646
648
|
* @example
|
|
647
649
|
* ```js
|
|
648
650
|
* init({
|
|
@@ -848,7 +850,7 @@ export interface FrameParams {
|
|
|
848
850
|
*/
|
|
849
851
|
loading?: 'lazy' | 'eager' | 'auto';
|
|
850
852
|
/**
|
|
851
|
-
*
|
|
853
|
+
* These parameters will be passed to the iframe
|
|
852
854
|
* as is.
|
|
853
855
|
*/
|
|
854
856
|
[key: string]: string | number | boolean | undefined;
|
|
@@ -923,8 +925,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
923
925
|
*/
|
|
924
926
|
disabledActionReason?: string;
|
|
925
927
|
/**
|
|
926
|
-
* The list of actions to hide from the embedded.
|
|
927
|
-
*
|
|
928
|
+
* The list of actions to hide from the embedded view.
|
|
929
|
+
* These actions will be hidden from the user.
|
|
928
930
|
* Use this to hide an action.
|
|
929
931
|
*
|
|
930
932
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
@@ -965,7 +967,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
965
967
|
* The locale settings to apply to the embedded view.
|
|
966
968
|
*
|
|
967
969
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
968
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
970
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
969
971
|
* @example
|
|
970
972
|
* ```js
|
|
971
973
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -980,12 +982,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
980
982
|
* This is an object (key/val) of override flags which will be applied
|
|
981
983
|
* to the internal embedded object. This can be used to add any
|
|
982
984
|
* URL flag.
|
|
983
|
-
* If the same flags are passed in init, they will be
|
|
985
|
+
* If the same flags are passed in init, they will be overridden by the values here.
|
|
984
986
|
* Warning: This option is for advanced use only and is used internally
|
|
985
987
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
986
988
|
* list of supported keys and values associated with each.
|
|
987
989
|
*
|
|
988
990
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
991
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
989
992
|
* @example
|
|
990
993
|
* ```js
|
|
991
994
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -997,7 +1000,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
997
1000
|
* },
|
|
998
1001
|
* });
|
|
999
1002
|
* ```
|
|
1000
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1001
1003
|
*/
|
|
1002
1004
|
additionalFlags?: {
|
|
1003
1005
|
[key: string]: string | number | boolean;
|
|
@@ -1040,6 +1042,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1040
1042
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1041
1043
|
*
|
|
1042
1044
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1045
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1043
1046
|
* @example
|
|
1044
1047
|
* ```js
|
|
1045
1048
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1049,7 +1052,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1049
1052
|
* });
|
|
1050
1053
|
* embed.showPreRender();
|
|
1051
1054
|
* ```
|
|
1052
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1053
1055
|
*/
|
|
1054
1056
|
preRenderId?: string;
|
|
1055
1057
|
/**
|
|
@@ -1059,7 +1061,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1059
1061
|
* its dimensions based on changes to the size of the embedding element.
|
|
1060
1062
|
* @type {boolean}
|
|
1061
1063
|
* @default false
|
|
1062
|
-
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
1064
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
|
|
1063
1065
|
* @example
|
|
1064
1066
|
* ```js
|
|
1065
1067
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -1074,9 +1076,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1074
1076
|
doNotTrackPreRenderSize?: boolean;
|
|
1075
1077
|
/**
|
|
1076
1078
|
* Enable the V2 shell. This can provide performance benefits
|
|
1077
|
-
* due to a
|
|
1079
|
+
* due to a lighter-weight shell.
|
|
1078
1080
|
*
|
|
1079
1081
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1082
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1080
1083
|
* @example
|
|
1081
1084
|
* ```js
|
|
1082
1085
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1085,7 +1088,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1085
1088
|
* enableV2Shell_experimental: true,
|
|
1086
1089
|
* });
|
|
1087
1090
|
* ```
|
|
1088
|
-
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1089
1091
|
*/
|
|
1090
1092
|
enableV2Shell_experimental?: boolean;
|
|
1091
1093
|
/**
|
|
@@ -1104,6 +1106,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1104
1106
|
* and disable redirection of links in a new tab.
|
|
1105
1107
|
*
|
|
1106
1108
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1109
|
+
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1107
1110
|
* @example
|
|
1108
1111
|
* ```js
|
|
1109
1112
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1112,7 +1115,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1112
1115
|
* disableRedirectionLinksInNewTab: true,
|
|
1113
1116
|
* });
|
|
1114
1117
|
* ```
|
|
1115
|
-
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1116
1118
|
*/
|
|
1117
1119
|
disableRedirectionLinksInNewTab?: boolean;
|
|
1118
1120
|
/**
|
|
@@ -1123,6 +1125,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1123
1125
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
1124
1126
|
*
|
|
1125
1127
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1128
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
1126
1129
|
* @example
|
|
1127
1130
|
* ```js
|
|
1128
1131
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1131,24 +1134,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1131
1134
|
* overrideOrgId: 142536,
|
|
1132
1135
|
* });
|
|
1133
1136
|
* ```
|
|
1134
|
-
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
1135
1137
|
*/
|
|
1136
1138
|
overrideOrgId?: number;
|
|
1137
1139
|
/**
|
|
1138
|
-
* Flag to override the *Open Link in New Tab* context
|
|
1140
|
+
* Flag to override the *Open Link in New Tab* context
|
|
1141
|
+
* menu option.
|
|
1139
1142
|
*
|
|
1140
|
-
*
|
|
1143
|
+
* For improved link override handling, use
|
|
1144
|
+
* {@link enableLinkOverridesV2} instead.
|
|
1145
|
+
*
|
|
1146
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
1147
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
1148
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
1141
1149
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1142
1150
|
* @example
|
|
1143
1151
|
* ```js
|
|
1144
|
-
*
|
|
1145
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1152
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1146
1153
|
* ... // other embed view config
|
|
1147
|
-
* linkOverride:
|
|
1154
|
+
* linkOverride: true,
|
|
1148
1155
|
* })
|
|
1149
1156
|
* ```
|
|
1150
1157
|
*/
|
|
1151
1158
|
linkOverride?: boolean;
|
|
1159
|
+
/**
|
|
1160
|
+
* Enables the V2 link override mechanism with improved
|
|
1161
|
+
* handling. When enabled, navigation links within the
|
|
1162
|
+
* embedded ThoughtSpot app are intercepted and routed
|
|
1163
|
+
* through the SDK via the `EmbedEvent.DialogOpen`
|
|
1164
|
+
* event.
|
|
1165
|
+
*
|
|
1166
|
+
* The SDK automatically sends {@link linkOverride}
|
|
1167
|
+
* alongside this flag for backward compatibility with
|
|
1168
|
+
* older ThoughtSpot versions.
|
|
1169
|
+
*
|
|
1170
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
1171
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
1172
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
1173
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
|
|
1174
|
+
* @example
|
|
1175
|
+
* ```js
|
|
1176
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1177
|
+
* ... // other embed view config
|
|
1178
|
+
* enableLinkOverridesV2: true,
|
|
1179
|
+
* });
|
|
1180
|
+
*
|
|
1181
|
+
* embed.on(EmbedEvent.DialogOpen, (payload) => {
|
|
1182
|
+
* console.log('Link clicked:', payload);
|
|
1183
|
+
* });
|
|
1184
|
+
* ```
|
|
1185
|
+
*/
|
|
1186
|
+
enableLinkOverridesV2?: boolean;
|
|
1152
1187
|
/**
|
|
1153
1188
|
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
1154
1189
|
* Use this to set the primary action.
|
|
@@ -1173,7 +1208,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1173
1208
|
insertInToSlide?: boolean;
|
|
1174
1209
|
/**
|
|
1175
1210
|
* Show alert messages and toast messages in the embed.
|
|
1176
|
-
* Supported
|
|
1211
|
+
* Supported in all embed types.
|
|
1177
1212
|
*
|
|
1178
1213
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1179
1214
|
* @example
|
|
@@ -1403,6 +1438,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1403
1438
|
*/
|
|
1404
1439
|
useHostEventsV2?: boolean;
|
|
1405
1440
|
}
|
|
1441
|
+
export interface AutoMCPFrameRendererViewConfig extends BaseViewConfig {
|
|
1442
|
+
}
|
|
1406
1443
|
/**
|
|
1407
1444
|
* The configuration object for Home page embeds configs.
|
|
1408
1445
|
*/
|
|
@@ -1412,8 +1449,9 @@ export interface HomePageConfig {
|
|
|
1412
1449
|
* *Liveboards* and *Answers*.
|
|
1413
1450
|
* For example: `hiddenListColumns = [ListPageColumns.Author]`
|
|
1414
1451
|
*
|
|
1415
|
-
* **Note**: This option is available only in full app embedding and requires
|
|
1416
|
-
* Starting with version 10.14.0.cl, you can
|
|
1452
|
+
* **Note**: This option is available only in full app embedding and requires
|
|
1453
|
+
* importing the `ListPageColumns` enum. Starting with version 10.14.0.cl, you can
|
|
1454
|
+
* use this attribute to
|
|
1417
1455
|
* hide the columns on all list pages in the *Insights* section.
|
|
1418
1456
|
*
|
|
1419
1457
|
* Supported embed types: `AppEmbed`
|
|
@@ -1453,11 +1491,12 @@ export interface HomePageConfig {
|
|
|
1453
1491
|
/**
|
|
1454
1492
|
* Reorder home page modules.
|
|
1455
1493
|
* To specify the modules, import the `HomepageModule` enum.
|
|
1456
|
-
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
1457
|
-
* **Note**: This attribute is not supported in the
|
|
1494
|
+
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
1495
|
+
* HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
|
|
1496
|
+
* classic (v1) homepage.
|
|
1458
1497
|
*
|
|
1459
1498
|
* Supported embed types: `AppEmbed`
|
|
1460
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
1499
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
1461
1500
|
* @example
|
|
1462
1501
|
* ```js
|
|
1463
1502
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1478,6 +1517,7 @@ export interface HomePageConfig {
|
|
|
1478
1517
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
1479
1518
|
*
|
|
1480
1519
|
* Supported embed types: `AppEmbed`
|
|
1520
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
1481
1521
|
* @example
|
|
1482
1522
|
* ```js
|
|
1483
1523
|
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1488,7 +1528,6 @@ export interface HomePageConfig {
|
|
|
1488
1528
|
* ... //other embed view configuration attributes
|
|
1489
1529
|
* })
|
|
1490
1530
|
* ```
|
|
1491
|
-
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
1492
1531
|
*/
|
|
1493
1532
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
1494
1533
|
}
|
|
@@ -1501,7 +1540,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1501
1540
|
* visualization, or Liveboard.
|
|
1502
1541
|
*
|
|
1503
1542
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1504
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
1543
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1505
1544
|
* @example
|
|
1506
1545
|
* ```js
|
|
1507
1546
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1519,11 +1558,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1519
1558
|
*/
|
|
1520
1559
|
runtimeFilters?: RuntimeFilter[];
|
|
1521
1560
|
/**
|
|
1522
|
-
* The list of parameter
|
|
1561
|
+
* The list of parameter overrides to apply to a search Answer,
|
|
1523
1562
|
* visualization, or Liveboard.
|
|
1524
1563
|
*
|
|
1525
1564
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1526
|
-
* @version SDK
|
|
1565
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1527
1566
|
* @example
|
|
1528
1567
|
* ```js
|
|
1529
1568
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1543,6 +1582,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1543
1582
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
1544
1583
|
*
|
|
1545
1584
|
* Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
|
|
1585
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1546
1586
|
* @example
|
|
1547
1587
|
* ```js
|
|
1548
1588
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
|
|
@@ -1551,7 +1591,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1551
1591
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
1552
1592
|
* })
|
|
1553
1593
|
* ```
|
|
1554
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1555
1594
|
*/
|
|
1556
1595
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
1557
1596
|
/**
|
|
@@ -1574,7 +1613,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1574
1613
|
* when set to false, runtime parameters will be included in the URL
|
|
1575
1614
|
* (default behavior before SDK 1.45.0).
|
|
1576
1615
|
*
|
|
1577
|
-
* Irrespective of this flag, runtime
|
|
1616
|
+
* Irrespective of this flag, runtime parameters (if passed) will be applied to the
|
|
1578
1617
|
* embedded view.
|
|
1579
1618
|
* @default true
|
|
1580
1619
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
@@ -1593,14 +1632,15 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1593
1632
|
* ... // other embed view config
|
|
1594
1633
|
* collapseSearchBar: true,
|
|
1595
1634
|
* });
|
|
1635
|
+
* ```
|
|
1596
1636
|
*/
|
|
1597
1637
|
collapseSearchBar?: boolean;
|
|
1598
1638
|
/**
|
|
1599
1639
|
* Flag to control Data panel experience
|
|
1600
1640
|
*
|
|
1601
1641
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1642
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
1602
1643
|
* @default true
|
|
1603
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
1604
1644
|
* @example
|
|
1605
1645
|
* ```js
|
|
1606
1646
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -1633,6 +1673,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1633
1673
|
* the current time period in filter results.
|
|
1634
1674
|
*
|
|
1635
1675
|
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1676
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
1636
1677
|
* @example
|
|
1637
1678
|
* ```js
|
|
1638
1679
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
@@ -1640,7 +1681,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1640
1681
|
* isThisPeriodInDateFiltersEnabled: true,
|
|
1641
1682
|
* })
|
|
1642
1683
|
* ```
|
|
1643
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
1644
1684
|
*/
|
|
1645
1685
|
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
1646
1686
|
}
|
|
@@ -1700,6 +1740,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1700
1740
|
* Boolean to control if Liveboard header is sticky or not.
|
|
1701
1741
|
*
|
|
1702
1742
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1743
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1703
1744
|
* @example
|
|
1704
1745
|
* ```js
|
|
1705
1746
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -1708,7 +1749,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1708
1749
|
* isLiveboardHeaderSticky: true,
|
|
1709
1750
|
* });
|
|
1710
1751
|
* ```
|
|
1711
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1712
1752
|
*/
|
|
1713
1753
|
isLiveboardHeaderSticky?: boolean;
|
|
1714
1754
|
/**
|
|
@@ -1716,8 +1756,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1716
1756
|
*
|
|
1717
1757
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1718
1758
|
* @type {boolean}
|
|
1759
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
|
|
1719
1760
|
* @default false
|
|
1720
|
-
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1721
1761
|
* @example
|
|
1722
1762
|
* ```js
|
|
1723
1763
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -1733,8 +1773,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1733
1773
|
*
|
|
1734
1774
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1735
1775
|
* @type {boolean}
|
|
1776
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
|
|
1736
1777
|
* @default false
|
|
1737
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
|
|
1738
1778
|
* @example
|
|
1739
1779
|
* ```js
|
|
1740
1780
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -1750,7 +1790,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1750
1790
|
* header.
|
|
1751
1791
|
*
|
|
1752
1792
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1753
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
1793
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
1754
1794
|
* @default true
|
|
1755
1795
|
* @example
|
|
1756
1796
|
* ```js
|
|
@@ -1765,10 +1805,12 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1765
1805
|
/**
|
|
1766
1806
|
* This flag is used to enable/disable hide irrelevant filters in Liveboard tab
|
|
1767
1807
|
*
|
|
1768
|
-
* **Note**: This feature is supported only if compact header is enabled on your
|
|
1808
|
+
* **Note**: This feature is supported only if compact header is enabled on your
|
|
1809
|
+
* Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled`
|
|
1810
|
+
* attribute.
|
|
1769
1811
|
*
|
|
1770
1812
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1771
|
-
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
1813
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
1772
1814
|
* @default false
|
|
1773
1815
|
* @example
|
|
1774
1816
|
* ```js
|
|
@@ -1786,7 +1828,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1786
1828
|
* compact header
|
|
1787
1829
|
*
|
|
1788
1830
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1789
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
1831
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
1790
1832
|
* @default true
|
|
1791
1833
|
* @example
|
|
1792
1834
|
* ```js
|
|
@@ -1819,7 +1861,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1819
1861
|
* the cover and filters pages in the Liveboard PDF.
|
|
1820
1862
|
*
|
|
1821
1863
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1822
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
1864
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
|
|
1823
1865
|
* @example
|
|
1824
1866
|
* ```js
|
|
1825
1867
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -1831,9 +1873,9 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1831
1873
|
*/
|
|
1832
1874
|
coverAndFilterOptionInPDF?: boolean;
|
|
1833
1875
|
/**
|
|
1834
|
-
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
1835
|
-
* When enabled, a unified modal is used to manage and update multiple filters
|
|
1836
|
-
* replacing the older individual filter interactions.
|
|
1876
|
+
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
1877
|
+
* (v2). When enabled, a unified modal is used to manage and update multiple filters
|
|
1878
|
+
* at once, replacing the older individual filter interactions.
|
|
1837
1879
|
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
1838
1880
|
*
|
|
1839
1881
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
@@ -1864,7 +1906,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1864
1906
|
*/
|
|
1865
1907
|
isLinkParametersEnabled?: boolean;
|
|
1866
1908
|
/**
|
|
1867
|
-
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
1909
|
+
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
1910
|
+
* liveboard.
|
|
1868
1911
|
*
|
|
1869
1912
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1870
1913
|
* @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
|
|
@@ -2038,7 +2081,7 @@ export declare enum HomepageModule {
|
|
|
2038
2081
|
*/
|
|
2039
2082
|
Search = "SEARCH",
|
|
2040
2083
|
/**
|
|
2041
|
-
*
|
|
2084
|
+
* KPI watchlist module
|
|
2042
2085
|
*/
|
|
2043
2086
|
Watchlist = "WATCHLIST",
|
|
2044
2087
|
/**
|
|
@@ -2069,7 +2112,8 @@ export declare enum ListPageColumns {
|
|
|
2069
2112
|
*/
|
|
2070
2113
|
Favorites = "FAVOURITE",
|
|
2071
2114
|
/**
|
|
2072
|
-
*
|
|
2115
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
2116
|
+
* @deprecated This option is deprecated.
|
|
2073
2117
|
*/
|
|
2074
2118
|
Favourite = "FAVOURITE",
|
|
2075
2119
|
/**
|
|
@@ -2170,13 +2214,13 @@ export declare enum EmbedEvent {
|
|
|
2170
2214
|
/**
|
|
2171
2215
|
* Rendering has initialized.
|
|
2172
2216
|
* @example
|
|
2173
|
-
|
|
2217
|
+
* ```js
|
|
2174
2218
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
2175
2219
|
* //show a loader
|
|
2176
2220
|
* function showLoader() {
|
|
2177
2221
|
* document.getElementById("loader");
|
|
2178
2222
|
* }
|
|
2179
|
-
|
|
2223
|
+
* ```
|
|
2180
2224
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2181
2225
|
*/
|
|
2182
2226
|
Init = "init",
|
|
@@ -2184,11 +2228,11 @@ export declare enum EmbedEvent {
|
|
|
2184
2228
|
* Authentication has either succeeded or failed.
|
|
2185
2229
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2186
2230
|
* @example
|
|
2187
|
-
|
|
2231
|
+
* ```js
|
|
2188
2232
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
2189
2233
|
* console.log('AuthInit', payload);
|
|
2190
2234
|
* })
|
|
2191
|
-
|
|
2235
|
+
* ```
|
|
2192
2236
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
2193
2237
|
*/
|
|
2194
2238
|
AuthInit = "authInit",
|
|
@@ -2197,13 +2241,13 @@ export declare enum EmbedEvent {
|
|
|
2197
2241
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2198
2242
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2199
2243
|
* @example
|
|
2200
|
-
|
|
2244
|
+
* ```js
|
|
2201
2245
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
2202
2246
|
* //hide loader
|
|
2203
2247
|
* function hideLoader() {
|
|
2204
2248
|
* document.getElementById("loader");
|
|
2205
2249
|
* }
|
|
2206
|
-
|
|
2250
|
+
* ```
|
|
2207
2251
|
*/
|
|
2208
2252
|
Load = "load",
|
|
2209
2253
|
/**
|
|
@@ -2212,11 +2256,11 @@ export declare enum EmbedEvent {
|
|
|
2212
2256
|
* @return data - Answer of Liveboard data
|
|
2213
2257
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2214
2258
|
* @example
|
|
2215
|
-
|
|
2259
|
+
* ```js
|
|
2216
2260
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
2217
2261
|
* console.log('data', payload);
|
|
2218
2262
|
* })
|
|
2219
|
-
|
|
2263
|
+
* ```
|
|
2220
2264
|
* @important
|
|
2221
2265
|
*/
|
|
2222
2266
|
Data = "data",
|
|
@@ -2224,9 +2268,9 @@ export declare enum EmbedEvent {
|
|
|
2224
2268
|
* Search query has been updated by the user.
|
|
2225
2269
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2226
2270
|
* @example
|
|
2227
|
-
|
|
2271
|
+
* ```js
|
|
2228
2272
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
2229
|
-
|
|
2273
|
+
* ```
|
|
2230
2274
|
*/
|
|
2231
2275
|
QueryChanged = "queryChanged",
|
|
2232
2276
|
/**
|
|
@@ -2236,7 +2280,7 @@ export declare enum EmbedEvent {
|
|
|
2236
2280
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2237
2281
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
2238
2282
|
* @example
|
|
2239
|
-
|
|
2283
|
+
* ```js
|
|
2240
2284
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
2241
2285
|
* points: {
|
|
2242
2286
|
* clickedPoint,
|
|
@@ -2244,12 +2288,12 @@ export declare enum EmbedEvent {
|
|
|
2244
2288
|
* },
|
|
2245
2289
|
* autoDrillDown: true,
|
|
2246
2290
|
* })
|
|
2247
|
-
|
|
2291
|
+
* ```
|
|
2248
2292
|
* In this example, `VizPointDoubleClick` event is used for
|
|
2249
2293
|
* triggering the `DrillDown` event when an area or specific
|
|
2250
2294
|
* data point on a table or chart is double-clicked.
|
|
2251
2295
|
* @example
|
|
2252
|
-
|
|
2296
|
+
* ```js
|
|
2253
2297
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
2254
2298
|
* console.log(payload);
|
|
2255
2299
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -2263,7 +2307,7 @@ export declare enum EmbedEvent {
|
|
|
2263
2307
|
* autoDrillDown: true,
|
|
2264
2308
|
* })
|
|
2265
2309
|
* })
|
|
2266
|
-
|
|
2310
|
+
* ```
|
|
2267
2311
|
*/
|
|
2268
2312
|
Drilldown = "drillDown",
|
|
2269
2313
|
/**
|
|
@@ -2388,13 +2432,13 @@ export declare enum EmbedEvent {
|
|
|
2388
2432
|
* The ThoughtSpot authentication session has expired.
|
|
2389
2433
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2390
2434
|
* @example
|
|
2391
|
-
|
|
2435
|
+
* ```js
|
|
2392
2436
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
2393
2437
|
* //show auth expired banner
|
|
2394
2438
|
* function showAuthExpired() {
|
|
2395
2439
|
* document.getElementById("authExpiredBanner");
|
|
2396
2440
|
* }
|
|
2397
|
-
|
|
2441
|
+
* ```
|
|
2398
2442
|
*/
|
|
2399
2443
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
2400
2444
|
/**
|
|
@@ -2429,22 +2473,22 @@ export declare enum EmbedEvent {
|
|
|
2429
2473
|
* Applicable to `SearchBarEmbed` only.
|
|
2430
2474
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2431
2475
|
* @example
|
|
2432
|
-
|
|
2476
|
+
* ```js
|
|
2433
2477
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
2434
2478
|
* .then(data => {
|
|
2435
2479
|
* console.log('Answer Data:', data);
|
|
2436
2480
|
* })
|
|
2437
|
-
|
|
2481
|
+
* ```
|
|
2438
2482
|
*/
|
|
2439
2483
|
GetDataClick = "getDataClick",
|
|
2440
2484
|
/**
|
|
2441
2485
|
* Detects the route change.
|
|
2442
2486
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
2443
2487
|
* @example
|
|
2444
|
-
|
|
2488
|
+
* ```js
|
|
2445
2489
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
2446
2490
|
* console.log('data', payload))
|
|
2447
|
-
|
|
2491
|
+
* ```
|
|
2448
2492
|
*/
|
|
2449
2493
|
RouteChange = "ROUTE_CHANGE",
|
|
2450
2494
|
/**
|
|
@@ -2454,12 +2498,12 @@ export declare enum EmbedEvent {
|
|
|
2454
2498
|
V1Data = "exportVizDataToParent",
|
|
2455
2499
|
/**
|
|
2456
2500
|
* Emitted when the embed does not have cookie access. This happens
|
|
2457
|
-
* when
|
|
2458
|
-
*
|
|
2501
|
+
* when third-party cookies are blocked by Safari or other
|
|
2502
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
2459
2503
|
* @example
|
|
2460
|
-
|
|
2504
|
+
* ```js
|
|
2461
2505
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
2462
|
-
|
|
2506
|
+
* ```
|
|
2463
2507
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
2464
2508
|
*/
|
|
2465
2509
|
NoCookieAccess = "noCookieAccess",
|
|
@@ -2473,22 +2517,22 @@ export declare enum EmbedEvent {
|
|
|
2473
2517
|
* Emitted when any modal is opened in the app
|
|
2474
2518
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2475
2519
|
* @example
|
|
2476
|
-
|
|
2520
|
+
* ```js
|
|
2477
2521
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
2478
2522
|
* console.log('dialog open', payload);
|
|
2479
2523
|
* })
|
|
2480
|
-
|
|
2524
|
+
* ```
|
|
2481
2525
|
*/
|
|
2482
2526
|
DialogOpen = "dialog-open",
|
|
2483
2527
|
/**
|
|
2484
2528
|
* Emitted when any modal is closed in the app
|
|
2485
2529
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2486
2530
|
* @example
|
|
2487
|
-
|
|
2531
|
+
* ```js
|
|
2488
2532
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
2489
2533
|
* console.log('dialog close', payload);
|
|
2490
2534
|
* })
|
|
2491
|
-
|
|
2535
|
+
* ```
|
|
2492
2536
|
*/
|
|
2493
2537
|
DialogClose = "dialog-close",
|
|
2494
2538
|
/**
|
|
@@ -2497,39 +2541,39 @@ export declare enum EmbedEvent {
|
|
|
2497
2541
|
* other events on the rendered Liveboard.
|
|
2498
2542
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2499
2543
|
* @example
|
|
2500
|
-
|
|
2544
|
+
* ```js
|
|
2501
2545
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
2502
2546
|
console.log('Liveboard is rendered', payload);
|
|
2503
2547
|
})
|
|
2504
|
-
|
|
2548
|
+
* ```
|
|
2505
2549
|
* The following example shows how to trigger
|
|
2506
2550
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
2507
2551
|
* @example
|
|
2508
|
-
|
|
2552
|
+
* ```js
|
|
2509
2553
|
* const embedRef = useEmbedRef();
|
|
2510
2554
|
* const onLiveboardRendered = () => {
|
|
2511
2555
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
2512
2556
|
* };
|
|
2513
|
-
|
|
2557
|
+
* ```
|
|
2514
2558
|
*/
|
|
2515
2559
|
LiveboardRendered = "PinboardRendered",
|
|
2516
2560
|
/**
|
|
2517
2561
|
* Emits all events.
|
|
2518
|
-
* @
|
|
2562
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2519
2563
|
* @example
|
|
2520
|
-
|
|
2564
|
+
* ```js
|
|
2521
2565
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
2522
2566
|
* console.log('Embed Events', payload)
|
|
2523
2567
|
* })
|
|
2524
|
-
|
|
2568
|
+
* ```
|
|
2525
2569
|
*/
|
|
2526
2570
|
ALL = "*",
|
|
2527
2571
|
/**
|
|
2528
2572
|
* Emitted when an Answer is saved in the app.
|
|
2529
2573
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
2530
|
-
* @
|
|
2574
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2531
2575
|
* @example
|
|
2532
|
-
|
|
2576
|
+
* ```js
|
|
2533
2577
|
* //Emit when action starts
|
|
2534
2578
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
2535
2579
|
* console.log('Save', payload)
|
|
@@ -2540,7 +2584,7 @@ export declare enum EmbedEvent {
|
|
|
2540
2584
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
2541
2585
|
* console.log('Save', payload)
|
|
2542
2586
|
* })
|
|
2543
|
-
|
|
2587
|
+
* ```
|
|
2544
2588
|
*/
|
|
2545
2589
|
Save = "save",
|
|
2546
2590
|
/**
|
|
@@ -2552,106 +2596,112 @@ export declare enum EmbedEvent {
|
|
|
2552
2596
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
2553
2597
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2554
2598
|
* @example
|
|
2555
|
-
|
|
2599
|
+
* ```js
|
|
2556
2600
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
2557
2601
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2558
2602
|
* })
|
|
2559
|
-
|
|
2603
|
+
* ```
|
|
2560
2604
|
*/
|
|
2561
2605
|
Download = "download",
|
|
2562
2606
|
/**
|
|
2563
2607
|
* Emitted when the download action is triggered on an Answer.
|
|
2564
|
-
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
2608
|
+
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
2609
|
+
* subscribe to when download is completed. Default is end:true.
|
|
2565
2610
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
2566
2611
|
* @example
|
|
2567
|
-
|
|
2612
|
+
* ```js
|
|
2568
2613
|
* //emit when action starts
|
|
2569
2614
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
2570
2615
|
* console.log('download PNG', payload)}, {start: true })
|
|
2571
2616
|
* //emit when action ends
|
|
2572
2617
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
2573
2618
|
* console.log('download PNG', payload)})
|
|
2574
|
-
|
|
2619
|
+
* ```
|
|
2575
2620
|
*/
|
|
2576
2621
|
DownloadAsPng = "downloadAsPng",
|
|
2577
2622
|
/**
|
|
2578
2623
|
* Emitted when the Download as PDF action is triggered on an Answer
|
|
2579
|
-
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
2624
|
+
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
2625
|
+
* subscribe to when download as PDF is completed. Default is end:true.
|
|
2580
2626
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2581
2627
|
* @example
|
|
2582
|
-
|
|
2628
|
+
* ```js
|
|
2583
2629
|
* //emit when action starts
|
|
2584
2630
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
2585
2631
|
* console.log('download PDF', payload)}, {start: true })
|
|
2586
2632
|
* //emit when action ends
|
|
2587
2633
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
2588
2634
|
* console.log('download PDF', payload)})
|
|
2589
|
-
|
|
2635
|
+
* ```
|
|
2590
2636
|
*/
|
|
2591
2637
|
DownloadAsPdf = "downloadAsPdf",
|
|
2592
2638
|
/**
|
|
2593
2639
|
* Emitted when the Download as CSV action is triggered on an Answer.
|
|
2594
|
-
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
2640
|
+
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
2641
|
+
* subscribe to when download as CSV is completed. Default is end:true.
|
|
2595
2642
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2596
2643
|
* @example
|
|
2597
|
-
|
|
2644
|
+
* ```js
|
|
2598
2645
|
* //emit when action starts
|
|
2599
2646
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
2600
2647
|
* console.log('download CSV', payload)}, {start: true })
|
|
2601
2648
|
* //emit when action ends
|
|
2602
2649
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
2603
2650
|
* console.log('download CSV', payload)})
|
|
2604
|
-
|
|
2651
|
+
* ```
|
|
2605
2652
|
*/
|
|
2606
2653
|
DownloadAsCsv = "downloadAsCsv",
|
|
2607
2654
|
/**
|
|
2608
2655
|
* Emitted when the Download as XLSX action is triggered on an Answer.
|
|
2609
|
-
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
2656
|
+
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
2657
|
+
* subscribe to when download as XLSX is completed. Default is end:true.
|
|
2610
2658
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2611
2659
|
* @example
|
|
2612
|
-
|
|
2660
|
+
* ```js
|
|
2613
2661
|
* //emit when action starts
|
|
2614
2662
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
2615
2663
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
2616
2664
|
* //emit when action ends
|
|
2617
2665
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
2618
2666
|
* console.log('download Xlsx', payload)})
|
|
2619
|
-
|
|
2667
|
+
* ```
|
|
2620
2668
|
*/
|
|
2621
2669
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
2622
2670
|
/**
|
|
2623
2671
|
* Emitted when an Answer is deleted in the app
|
|
2624
|
-
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
2672
|
+
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
2673
|
+
* to when delete is completed. Default is end:true.
|
|
2625
2674
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2626
2675
|
* @example
|
|
2627
|
-
|
|
2676
|
+
* ```js
|
|
2628
2677
|
* //emit when action starts
|
|
2629
2678
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
2630
2679
|
* console.log('delete answer', payload)}, {start: true })
|
|
2631
2680
|
* //trigger when action is completed
|
|
2632
2681
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
2633
2682
|
* console.log('delete answer', payload)})
|
|
2634
|
-
|
|
2683
|
+
* ```
|
|
2635
2684
|
*/
|
|
2636
2685
|
AnswerDelete = "answerDelete",
|
|
2637
2686
|
/**
|
|
2638
2687
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
2639
2688
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
2640
2689
|
* @example
|
|
2641
|
-
|
|
2690
|
+
* ```js
|
|
2642
2691
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
2643
2692
|
* console.log('AI Highlights', payload);
|
|
2644
2693
|
* })
|
|
2645
|
-
|
|
2694
|
+
* ```
|
|
2646
2695
|
*/
|
|
2647
2696
|
AIHighlights = "AIHighlights",
|
|
2648
2697
|
/**
|
|
2649
2698
|
* Emitted when a user initiates the Pin action to
|
|
2650
2699
|
* add an Answer to a Liveboard.
|
|
2651
|
-
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
2700
|
+
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
2701
|
+
* when pin is completed. Default is end:true.
|
|
2652
2702
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2653
2703
|
* @example
|
|
2654
|
-
|
|
2704
|
+
* ```js
|
|
2655
2705
|
* //emit when action starts
|
|
2656
2706
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
2657
2707
|
* console.log('pin', payload)
|
|
@@ -2662,14 +2712,14 @@ export declare enum EmbedEvent {
|
|
|
2662
2712
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
2663
2713
|
* console.log('pin', payload)
|
|
2664
2714
|
* })
|
|
2665
|
-
|
|
2715
|
+
* ```
|
|
2666
2716
|
*/
|
|
2667
2717
|
Pin = "pin",
|
|
2668
2718
|
/**
|
|
2669
2719
|
* Emitted when SpotIQ analysis is triggered
|
|
2670
2720
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2671
2721
|
* @example
|
|
2672
|
-
|
|
2722
|
+
* ```js
|
|
2673
2723
|
* //emit when action starts
|
|
2674
2724
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
2675
2725
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -2680,14 +2730,14 @@ export declare enum EmbedEvent {
|
|
|
2680
2730
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
2681
2731
|
* console.log('SpotIQ analyze', payload)
|
|
2682
2732
|
* })
|
|
2683
|
-
|
|
2733
|
+
* ```
|
|
2684
2734
|
*/
|
|
2685
2735
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2686
2736
|
/**
|
|
2687
2737
|
* Emitted when a user shares an object with another user or group
|
|
2688
2738
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2689
2739
|
* @example
|
|
2690
|
-
|
|
2740
|
+
* ```js
|
|
2691
2741
|
* //emit when action starts
|
|
2692
2742
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
2693
2743
|
* console.log('Share', payload)
|
|
@@ -2698,7 +2748,7 @@ export declare enum EmbedEvent {
|
|
|
2698
2748
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
2699
2749
|
* console.log('Share', payload)
|
|
2700
2750
|
* })
|
|
2701
|
-
|
|
2751
|
+
* ```
|
|
2702
2752
|
*/
|
|
2703
2753
|
Share = "share",
|
|
2704
2754
|
/**
|
|
@@ -2706,11 +2756,11 @@ export declare enum EmbedEvent {
|
|
|
2706
2756
|
* data on a chart or table.
|
|
2707
2757
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2708
2758
|
* @example
|
|
2709
|
-
|
|
2759
|
+
* ```js
|
|
2710
2760
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
2711
2761
|
* console.log('Drill include', payload);
|
|
2712
2762
|
* })
|
|
2713
|
-
|
|
2763
|
+
* ```
|
|
2714
2764
|
*/
|
|
2715
2765
|
DrillInclude = "context-menu-item-include",
|
|
2716
2766
|
/**
|
|
@@ -2718,22 +2768,22 @@ export declare enum EmbedEvent {
|
|
|
2718
2768
|
* data on a chart or table
|
|
2719
2769
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2720
2770
|
* @example
|
|
2721
|
-
|
|
2771
|
+
* ```js
|
|
2722
2772
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
2723
2773
|
* console.log('Drill exclude', payload);
|
|
2724
2774
|
* })
|
|
2725
|
-
|
|
2775
|
+
* ```
|
|
2726
2776
|
*/
|
|
2727
2777
|
DrillExclude = "context-menu-item-exclude",
|
|
2728
2778
|
/**
|
|
2729
2779
|
* Emitted when a column value is copied in the embedded app.
|
|
2730
2780
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2731
2781
|
* @example
|
|
2732
|
-
|
|
2733
|
-
*
|
|
2782
|
+
* ```js
|
|
2783
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
2734
2784
|
* console.log('copy to clipboard', payload);
|
|
2735
2785
|
* })
|
|
2736
|
-
|
|
2786
|
+
* ```
|
|
2737
2787
|
*/
|
|
2738
2788
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
2739
2789
|
/**
|
|
@@ -2741,10 +2791,10 @@ export declare enum EmbedEvent {
|
|
|
2741
2791
|
* embedded Liveboard.
|
|
2742
2792
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2743
2793
|
* @example
|
|
2744
|
-
|
|
2794
|
+
* ```js
|
|
2745
2795
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
2746
2796
|
* })
|
|
2747
|
-
|
|
2797
|
+
* ```
|
|
2748
2798
|
*/
|
|
2749
2799
|
UpdateTML = "updateTSL",
|
|
2750
2800
|
/**
|
|
@@ -2752,75 +2802,77 @@ export declare enum EmbedEvent {
|
|
|
2752
2802
|
* on an embedded Liveboard.
|
|
2753
2803
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2754
2804
|
* @example
|
|
2755
|
-
|
|
2805
|
+
* ```js
|
|
2756
2806
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
2757
2807
|
* console.log('Edit TML', payload);
|
|
2758
2808
|
* })
|
|
2759
|
-
|
|
2809
|
+
* ```
|
|
2760
2810
|
*/
|
|
2761
2811
|
EditTML = "editTSL",
|
|
2762
2812
|
/**
|
|
2763
2813
|
* Emitted when the **Export TML** action is triggered on an
|
|
2764
2814
|
* an embedded object in the app
|
|
2765
|
-
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
2815
|
+
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
2816
|
+
* to when export is completed. Default is end:true.
|
|
2766
2817
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2767
2818
|
* @example
|
|
2768
|
-
|
|
2819
|
+
* ```js
|
|
2769
2820
|
* //emit when action starts
|
|
2770
2821
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
2771
2822
|
* console.log('Export TML', payload)}, { start: true })
|
|
2772
2823
|
* //emit when action ends
|
|
2773
2824
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
2774
2825
|
* console.log('Export TML', payload)})
|
|
2775
|
-
|
|
2826
|
+
* ```
|
|
2776
2827
|
*/
|
|
2777
2828
|
ExportTML = "exportTSL",
|
|
2778
2829
|
/**
|
|
2779
2830
|
* Emitted when an Answer is saved as a View.
|
|
2780
2831
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2781
2832
|
* @example
|
|
2782
|
-
|
|
2833
|
+
* ```js
|
|
2783
2834
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
2784
2835
|
* console.log('View', payload);
|
|
2785
2836
|
* })
|
|
2786
|
-
|
|
2837
|
+
* ```
|
|
2787
2838
|
*/
|
|
2788
2839
|
SaveAsView = "saveAsView",
|
|
2789
2840
|
/**
|
|
2790
2841
|
* Emitted when the user creates a copy of an Answer.
|
|
2791
|
-
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
2842
|
+
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
2843
|
+
* subscribe to when copy and edit is completed. Default is end:true.
|
|
2792
2844
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2793
2845
|
* @example
|
|
2794
|
-
|
|
2846
|
+
* ```js
|
|
2795
2847
|
* //emit when action starts
|
|
2796
2848
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
2797
2849
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
2798
2850
|
* //emit when action ends
|
|
2799
2851
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
2800
2852
|
* console.log('Copy and edit', payload)})
|
|
2801
|
-
|
|
2853
|
+
* ```
|
|
2802
2854
|
*/
|
|
2803
2855
|
CopyAEdit = "copyAEdit",
|
|
2804
2856
|
/**
|
|
2805
2857
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
2806
2858
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2807
2859
|
* @example
|
|
2808
|
-
|
|
2860
|
+
* ```js
|
|
2809
2861
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
2810
2862
|
* console.log('show data', payload);
|
|
2811
2863
|
* })
|
|
2812
|
-
|
|
2864
|
+
* ```
|
|
2813
2865
|
*/
|
|
2814
2866
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2815
2867
|
/**
|
|
2816
2868
|
* Emitted when an Answer is switched to a chart or table view.
|
|
2817
2869
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2818
2870
|
* @example
|
|
2819
|
-
|
|
2871
|
+
* ```js
|
|
2820
2872
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
2821
2873
|
* console.log('switch view', payload);
|
|
2822
2874
|
* })
|
|
2823
|
-
|
|
2875
|
+
* ```
|
|
2824
2876
|
*/
|
|
2825
2877
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
2826
2878
|
/**
|
|
@@ -2837,118 +2889,118 @@ export declare enum EmbedEvent {
|
|
|
2837
2889
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
2838
2890
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2839
2891
|
* @example
|
|
2840
|
-
|
|
2892
|
+
* ```js
|
|
2841
2893
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
2842
2894
|
* console.log('Liveboard details', payload);
|
|
2843
2895
|
* })
|
|
2844
|
-
|
|
2896
|
+
* ```
|
|
2845
2897
|
*/
|
|
2846
2898
|
LiveboardInfo = "pinboardInfo",
|
|
2847
2899
|
/**
|
|
2848
2900
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
2849
2901
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2850
2902
|
* @example
|
|
2851
|
-
|
|
2903
|
+
* ```js
|
|
2852
2904
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
2853
2905
|
* console.log('favorites', payload);
|
|
2854
2906
|
* })
|
|
2855
|
-
|
|
2907
|
+
* ```
|
|
2856
2908
|
*/
|
|
2857
2909
|
AddToFavorites = "addToFavorites",
|
|
2858
2910
|
/**
|
|
2859
2911
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
2860
2912
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2861
2913
|
* @example
|
|
2862
|
-
|
|
2914
|
+
* ```js
|
|
2863
2915
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
2864
|
-
* console.log(
|
|
2916
|
+
* console.log('Liveboard schedule', payload);
|
|
2865
2917
|
* })
|
|
2866
|
-
|
|
2918
|
+
* ```
|
|
2867
2919
|
*/
|
|
2868
2920
|
Schedule = "subscription",
|
|
2869
2921
|
/**
|
|
2870
2922
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
2871
2923
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2872
2924
|
* @example
|
|
2873
|
-
|
|
2925
|
+
* ```js
|
|
2874
2926
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
2875
|
-
* console.log(
|
|
2927
|
+
* console.log('Liveboard edit', payload);
|
|
2876
2928
|
* })
|
|
2877
|
-
|
|
2929
|
+
* ```
|
|
2878
2930
|
*/
|
|
2879
2931
|
Edit = "edit",
|
|
2880
2932
|
/**
|
|
2881
2933
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
2882
2934
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2883
2935
|
* @example
|
|
2884
|
-
|
|
2936
|
+
* ```js
|
|
2885
2937
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
2886
|
-
* console.log(
|
|
2938
|
+
* console.log('Copy', payload);
|
|
2887
2939
|
* })
|
|
2888
|
-
|
|
2940
|
+
* ```
|
|
2889
2941
|
*/
|
|
2890
2942
|
MakeACopy = "makeACopy",
|
|
2891
2943
|
/**
|
|
2892
2944
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
2893
2945
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2894
2946
|
* @example
|
|
2895
|
-
|
|
2947
|
+
* ```js
|
|
2896
2948
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
2897
|
-
|
|
2949
|
+
* ```
|
|
2898
2950
|
* @example
|
|
2899
|
-
|
|
2951
|
+
* ```js
|
|
2900
2952
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
2901
2953
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2902
2954
|
* })
|
|
2903
|
-
|
|
2955
|
+
* ```
|
|
2904
2956
|
*/
|
|
2905
2957
|
Present = "present",
|
|
2906
2958
|
/**
|
|
2907
2959
|
* Emitted when a user clicks **Delete** on a visualization
|
|
2908
2960
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2909
2961
|
* @example
|
|
2910
|
-
|
|
2962
|
+
* ```js
|
|
2911
2963
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
2912
2964
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2913
|
-
|
|
2965
|
+
* ```
|
|
2914
2966
|
*/
|
|
2915
2967
|
Delete = "delete",
|
|
2916
2968
|
/**
|
|
2917
2969
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
2918
2970
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2919
2971
|
* @example
|
|
2920
|
-
|
|
2972
|
+
* ```js
|
|
2921
2973
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
2922
|
-
|
|
2974
|
+
* ```
|
|
2923
2975
|
*/
|
|
2924
2976
|
SchedulesList = "schedule-list",
|
|
2925
2977
|
/**
|
|
2926
2978
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
2927
2979
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2928
2980
|
* @example
|
|
2929
|
-
|
|
2981
|
+
* ```js
|
|
2930
2982
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
2931
|
-
|
|
2983
|
+
* ```
|
|
2932
2984
|
*/
|
|
2933
2985
|
Cancel = "cancel",
|
|
2934
2986
|
/**
|
|
2935
2987
|
* Emitted when a user clicks **Explore** on a visualization
|
|
2936
2988
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2937
2989
|
* @example
|
|
2938
|
-
|
|
2990
|
+
* ```js
|
|
2939
2991
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
2940
2992
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2941
|
-
|
|
2993
|
+
* ```
|
|
2942
2994
|
*/
|
|
2943
2995
|
Explore = "explore",
|
|
2944
2996
|
/**
|
|
2945
2997
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
2946
2998
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2947
2999
|
* @example
|
|
2948
|
-
|
|
3000
|
+
* ```js
|
|
2949
3001
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
2950
3002
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2951
|
-
|
|
3003
|
+
* ```
|
|
2952
3004
|
*/
|
|
2953
3005
|
CopyLink = "embedDocument",
|
|
2954
3006
|
/**
|
|
@@ -2956,21 +3008,21 @@ export declare enum EmbedEvent {
|
|
|
2956
3008
|
* visualization or Liveboard.
|
|
2957
3009
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2958
3010
|
* @example
|
|
2959
|
-
|
|
3011
|
+
* ```js
|
|
2960
3012
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
2961
3013
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2962
|
-
|
|
3014
|
+
* ```
|
|
2963
3015
|
*/
|
|
2964
3016
|
CrossFilterChanged = "cross-filter-changed",
|
|
2965
3017
|
/**
|
|
2966
3018
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
2967
3019
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2968
3020
|
* @example
|
|
2969
|
-
|
|
3021
|
+
* ```js
|
|
2970
3022
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
2971
3023
|
* console.log('VizPointClick', payload)
|
|
2972
3024
|
* })
|
|
2973
|
-
|
|
3025
|
+
* ```
|
|
2974
3026
|
*/
|
|
2975
3027
|
VizPointRightClick = "vizPointRightClick",
|
|
2976
3028
|
/**
|
|
@@ -2984,35 +3036,35 @@ export declare enum EmbedEvent {
|
|
|
2984
3036
|
* filter details.
|
|
2985
3037
|
* @example
|
|
2986
3038
|
*
|
|
2987
|
-
|
|
3039
|
+
* ```js
|
|
2988
3040
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
2989
3041
|
* console.log('payload', payload);
|
|
2990
3042
|
* })
|
|
2991
|
-
*
|
|
3043
|
+
* ```
|
|
2992
3044
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
2993
3045
|
*/
|
|
2994
3046
|
FilterChanged = "filterChanged",
|
|
2995
3047
|
/**
|
|
2996
3048
|
* Emitted when a user clicks the **Go** button to initiate
|
|
2997
3049
|
* a Natural Language Search query
|
|
2998
|
-
* @version SDK
|
|
3050
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2999
3051
|
*/
|
|
3000
3052
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3001
3053
|
/**
|
|
3002
3054
|
* Emitted when a user selects a data source on the embedded
|
|
3003
3055
|
* Natural Language Search interface.
|
|
3004
3056
|
*
|
|
3005
|
-
* @version SDK
|
|
3057
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3006
3058
|
*/
|
|
3007
3059
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3008
3060
|
/**
|
|
3009
3061
|
* Emitted when a user updates a connection on the **Data** page
|
|
3010
|
-
* @version SDK
|
|
3062
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3011
3063
|
*/
|
|
3012
3064
|
UpdateConnection = "updateConnection",
|
|
3013
3065
|
/**
|
|
3014
3066
|
* Emitted when a user updates a connection on the **Data** page
|
|
3015
|
-
* @version SDK
|
|
3067
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3016
3068
|
*/
|
|
3017
3069
|
CreateConnection = "createConnection",
|
|
3018
3070
|
/**
|
|
@@ -3022,7 +3074,7 @@ export declare enum EmbedEvent {
|
|
|
3022
3074
|
* @returns viewId: string
|
|
3023
3075
|
* @returns liveboardId: string
|
|
3024
3076
|
* @returns isPublic: boolean
|
|
3025
|
-
* @version SDK
|
|
3077
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3026
3078
|
*/
|
|
3027
3079
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3028
3080
|
/**
|
|
@@ -3031,7 +3083,7 @@ export declare enum EmbedEvent {
|
|
|
3031
3083
|
* @returns viewId: string
|
|
3032
3084
|
* @returns liveboardId: string
|
|
3033
3085
|
* @returns isPublic: boolean
|
|
3034
|
-
* @version SDK
|
|
3086
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3035
3087
|
*/
|
|
3036
3088
|
SavePersonalisedView = "savePersonalisedView",
|
|
3037
3089
|
/**
|
|
@@ -3040,19 +3092,19 @@ export declare enum EmbedEvent {
|
|
|
3040
3092
|
* @returns viewId: string
|
|
3041
3093
|
* @returns liveboardId: string
|
|
3042
3094
|
* @returns isPublic: boolean
|
|
3043
|
-
* @version SDK
|
|
3095
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3044
3096
|
*/
|
|
3045
3097
|
ResetLiveboard = "resetLiveboard",
|
|
3046
3098
|
/**
|
|
3047
3099
|
* Emitted when a PersonalisedView is deleted.
|
|
3048
3100
|
* @returns views: string[]
|
|
3049
3101
|
* @returns liveboardId: string
|
|
3050
|
-
* @version SDK
|
|
3102
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3051
3103
|
*/
|
|
3052
3104
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3053
3105
|
/**
|
|
3054
3106
|
* Emitted when a user creates a Worksheet.
|
|
3055
|
-
* @version SDK
|
|
3107
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3056
3108
|
*/
|
|
3057
3109
|
CreateWorksheet = "createWorksheet",
|
|
3058
3110
|
/**
|
|
@@ -3061,12 +3113,12 @@ export declare enum EmbedEvent {
|
|
|
3061
3113
|
* @returns viewId: string
|
|
3062
3114
|
* @returns liveboardId: string
|
|
3063
3115
|
* @returns isPublic: boolean
|
|
3064
|
-
* @version SDK
|
|
3116
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3065
3117
|
*/
|
|
3066
3118
|
AskSageInit = "AskSageInit",
|
|
3067
3119
|
/**
|
|
3068
3120
|
* Emitted when a Liveboard or visualization is renamed.
|
|
3069
|
-
* @version SDK
|
|
3121
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
3070
3122
|
*/
|
|
3071
3123
|
Rename = "rename",
|
|
3072
3124
|
/**
|
|
@@ -3089,7 +3141,7 @@ export declare enum EmbedEvent {
|
|
|
3089
3141
|
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
3090
3142
|
* is `false` by using the `error` parameters in `responder`.
|
|
3091
3143
|
* - `errorText` - The error message text shown to the user.
|
|
3092
|
-
* @version SDK
|
|
3144
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
3093
3145
|
* @example
|
|
3094
3146
|
*
|
|
3095
3147
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -3141,8 +3193,8 @@ export declare enum EmbedEvent {
|
|
|
3141
3193
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
3142
3194
|
* console.log('payload', payload);
|
|
3143
3195
|
* })
|
|
3144
|
-
|
|
3145
|
-
* @version SDK
|
|
3196
|
+
* ```
|
|
3197
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
3146
3198
|
*/
|
|
3147
3199
|
ParameterChanged = "parameterChanged",
|
|
3148
3200
|
/**
|
|
@@ -3197,24 +3249,24 @@ export declare enum EmbedEvent {
|
|
|
3197
3249
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
3198
3250
|
* console.log('payload', payload);
|
|
3199
3251
|
* })
|
|
3200
|
-
|
|
3201
|
-
* @version SDK
|
|
3252
|
+
* ```
|
|
3253
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
3202
3254
|
*/
|
|
3203
3255
|
CreateLiveboard = "createLiveboard",
|
|
3204
3256
|
/**
|
|
3205
3257
|
* Emitted when a user creates a Model.
|
|
3206
|
-
* @version SDK
|
|
3258
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
3207
3259
|
*/
|
|
3208
3260
|
CreateModel = "createModel",
|
|
3209
3261
|
/**
|
|
3210
3262
|
* @hidden
|
|
3211
3263
|
* Emitted when a user exits present mode.
|
|
3212
|
-
* @version SDK
|
|
3264
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3213
3265
|
*/
|
|
3214
3266
|
ExitPresentMode = "exitPresentMode",
|
|
3215
3267
|
/**
|
|
3216
3268
|
* Emitted when a user requests the full height lazy load data.
|
|
3217
|
-
* @version SDK
|
|
3269
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3218
3270
|
* @hidden
|
|
3219
3271
|
*/
|
|
3220
3272
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
@@ -3225,7 +3277,7 @@ export declare enum EmbedEvent {
|
|
|
3225
3277
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
3226
3278
|
* console.log('payload', payload);
|
|
3227
3279
|
* })
|
|
3228
|
-
|
|
3280
|
+
* ```
|
|
3229
3281
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3230
3282
|
*/
|
|
3231
3283
|
SpotterData = "SpotterData",
|
|
@@ -3236,7 +3288,7 @@ export declare enum EmbedEvent {
|
|
|
3236
3288
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
3237
3289
|
* console.log('payload', payload);
|
|
3238
3290
|
* })
|
|
3239
|
-
|
|
3291
|
+
* ```
|
|
3240
3292
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3241
3293
|
*/
|
|
3242
3294
|
PreviewSpotterData = "PreviewSpotterData",
|
|
@@ -3247,7 +3299,7 @@ export declare enum EmbedEvent {
|
|
|
3247
3299
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
3248
3300
|
* console.log('payload', payload);
|
|
3249
3301
|
* })
|
|
3250
|
-
|
|
3302
|
+
* ```
|
|
3251
3303
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3252
3304
|
*/
|
|
3253
3305
|
AddToCoaching = "addToCoaching",
|
|
@@ -3269,7 +3321,7 @@ export declare enum EmbedEvent {
|
|
|
3269
3321
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
3270
3322
|
* console.log('payload', payload);
|
|
3271
3323
|
* })
|
|
3272
|
-
|
|
3324
|
+
* ```
|
|
3273
3325
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3274
3326
|
*/
|
|
3275
3327
|
SpotterQueryTriggered = "SpotterQueryTriggered",
|
|
@@ -3280,7 +3332,7 @@ export declare enum EmbedEvent {
|
|
|
3280
3332
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
3281
3333
|
* console.log('payload', payload);
|
|
3282
3334
|
* })
|
|
3283
|
-
|
|
3335
|
+
* ```
|
|
3284
3336
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3285
3337
|
*/
|
|
3286
3338
|
LastPromptEdited = "LastPromptEdited",
|
|
@@ -3291,18 +3343,18 @@ export declare enum EmbedEvent {
|
|
|
3291
3343
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
3292
3344
|
* console.log('payload', payload);
|
|
3293
3345
|
* })
|
|
3294
|
-
|
|
3346
|
+
* ```
|
|
3295
3347
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3296
3348
|
*/
|
|
3297
3349
|
LastPromptDeleted = "LastPromptDeleted",
|
|
3298
3350
|
/**
|
|
3299
|
-
* Emitted when the
|
|
3351
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
3300
3352
|
* @example
|
|
3301
3353
|
* ```js
|
|
3302
3354
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
3303
3355
|
* console.log('payload', payload);
|
|
3304
3356
|
* })
|
|
3305
|
-
|
|
3357
|
+
* ```
|
|
3306
3358
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3307
3359
|
*/
|
|
3308
3360
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
@@ -3313,7 +3365,7 @@ export declare enum EmbedEvent {
|
|
|
3313
3365
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
3314
3366
|
* console.log('payload', payload);
|
|
3315
3367
|
* })
|
|
3316
|
-
|
|
3368
|
+
* ```
|
|
3317
3369
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
3318
3370
|
*/
|
|
3319
3371
|
SpotterInit = "spotterInit",
|
|
@@ -3324,7 +3376,7 @@ export declare enum EmbedEvent {
|
|
|
3324
3376
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
3325
3377
|
* console.log('payload', payload);
|
|
3326
3378
|
* })
|
|
3327
|
-
|
|
3379
|
+
* ```
|
|
3328
3380
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
3329
3381
|
*/
|
|
3330
3382
|
SpotterLoadComplete = "spotterLoadComplete",
|
|
@@ -3551,7 +3603,8 @@ export declare enum HostEvent {
|
|
|
3551
3603
|
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
3552
3604
|
* on the most popular column.
|
|
3553
3605
|
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
3554
|
-
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
3606
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
3607
|
+
* **required**.
|
|
3555
3608
|
* @example
|
|
3556
3609
|
* ```js
|
|
3557
3610
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -3678,7 +3731,7 @@ export declare enum HostEvent {
|
|
|
3678
3731
|
* ```js
|
|
3679
3732
|
* appEmbed.navigateToPage(-1)
|
|
3680
3733
|
* ```
|
|
3681
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
3734
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
3682
3735
|
*/
|
|
3683
3736
|
Navigate = "Navigate",
|
|
3684
3737
|
/**
|
|
@@ -3747,7 +3800,8 @@ export declare enum HostEvent {
|
|
|
3747
3800
|
* the following parameters:
|
|
3748
3801
|
*
|
|
3749
3802
|
* @param - Includes the following keys:
|
|
3750
|
-
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
3803
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
3804
|
+
* Liveboard.
|
|
3751
3805
|
* Optional when pinning a new chart or table generated from a Search query.
|
|
3752
3806
|
* **Required** in Spotter Embed.
|
|
3753
3807
|
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
@@ -3811,9 +3865,9 @@ export declare enum HostEvent {
|
|
|
3811
3865
|
* Trigger the **Show Liveboard details** action
|
|
3812
3866
|
* on an embedded Liveboard.
|
|
3813
3867
|
* @example
|
|
3814
|
-
|
|
3868
|
+
* ```js
|
|
3815
3869
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
3816
|
-
|
|
3870
|
+
* ```
|
|
3817
3871
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3818
3872
|
*/
|
|
3819
3873
|
LiveboardInfo = "pinboardInfo",
|
|
@@ -3941,7 +3995,7 @@ export declare enum HostEvent {
|
|
|
3941
3995
|
* appEmbed.trigger(HostEvent.Remove)
|
|
3942
3996
|
* ```
|
|
3943
3997
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3944
|
-
*
|
|
3998
|
+
* @example
|
|
3945
3999
|
* ```js
|
|
3946
4000
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
3947
4001
|
* ```
|
|
@@ -4003,7 +4057,8 @@ export declare enum HostEvent {
|
|
|
4003
4057
|
* This event is not supported in visualization embed and search embed.
|
|
4004
4058
|
* @param - Object parameter. Includes the following keys:
|
|
4005
4059
|
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
4006
|
-
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4060
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4061
|
+
* is **required**.
|
|
4007
4062
|
*
|
|
4008
4063
|
* @example
|
|
4009
4064
|
* ```js
|
|
@@ -4032,7 +4087,7 @@ export declare enum HostEvent {
|
|
|
4032
4087
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4033
4088
|
* ```
|
|
4034
4089
|
* ```js
|
|
4035
|
-
* vizEmbed.trigger(
|
|
4090
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
4036
4091
|
* ```
|
|
4037
4092
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4038
4093
|
*/
|
|
@@ -4049,7 +4104,7 @@ export declare enum HostEvent {
|
|
|
4049
4104
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4050
4105
|
* ```
|
|
4051
4106
|
* ```js
|
|
4052
|
-
* vizEmbed.trigger(
|
|
4107
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
4053
4108
|
* ```
|
|
4054
4109
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4055
4110
|
*/
|
|
@@ -4064,23 +4119,22 @@ export declare enum HostEvent {
|
|
|
4064
4119
|
* );
|
|
4065
4120
|
* })
|
|
4066
4121
|
* ```
|
|
4067
|
-
*
|
|
4122
|
+
* @example
|
|
4068
4123
|
* ```js
|
|
4069
|
-
|
|
4070
|
-
|
|
4071
|
-
|
|
4072
|
-
|
|
4073
|
-
|
|
4074
|
-
|
|
4075
|
-
|
|
4076
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
4124
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
4125
|
+
* let latestSpotterVizId = '';
|
|
4126
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
4127
|
+
* latestSpotterVizId = payload.data.id;
|
|
4128
|
+
* });
|
|
4129
|
+
*
|
|
4130
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
4077
4131
|
* vizId: latestSpotterVizId
|
|
4078
4132
|
* }).then((tml) => {
|
|
4079
4133
|
* console.log(
|
|
4080
4134
|
* tml.answer.search_query // TML representation of the search query
|
|
4081
4135
|
* );
|
|
4082
4136
|
* })
|
|
4083
|
-
|
|
4137
|
+
* ```
|
|
4084
4138
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4085
4139
|
* @important
|
|
4086
4140
|
*/
|
|
@@ -4144,6 +4198,11 @@ export declare enum HostEvent {
|
|
|
4144
4198
|
/**
|
|
4145
4199
|
* Trigger the **Download** action on charts in
|
|
4146
4200
|
* the embedded view.
|
|
4201
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
4202
|
+
*
|
|
4203
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
4204
|
+
*
|
|
4205
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
4147
4206
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
4148
4207
|
* @example
|
|
4149
4208
|
* ```js
|
|
@@ -4162,9 +4221,6 @@ export declare enum HostEvent {
|
|
|
4162
4221
|
*
|
|
4163
4222
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
4164
4223
|
* ```
|
|
4165
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
4166
|
-
* Use {@link DownloadAsPng}
|
|
4167
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
4168
4224
|
*/
|
|
4169
4225
|
Download = "downloadAsPng",
|
|
4170
4226
|
/**
|
|
@@ -4371,8 +4427,9 @@ export declare enum HostEvent {
|
|
|
4371
4427
|
/**
|
|
4372
4428
|
* Update one or several filters applied on a Liveboard.
|
|
4373
4429
|
* @param - Includes the following keys:
|
|
4374
|
-
* - `filter`: A single filter object containing column name, filter operator, and
|
|
4375
|
-
* - `filters`: Multiple filter objects with column name, filter operator,
|
|
4430
|
+
* - `filter`: A single filter object containing column name, filter operator, and
|
|
4431
|
+
* values. - `filters`: Multiple filter objects with column name, filter operator,
|
|
4432
|
+
* and values for each.
|
|
4376
4433
|
*
|
|
4377
4434
|
* Each filter object must include the following attributes:
|
|
4378
4435
|
*
|
|
@@ -4602,8 +4659,8 @@ export declare enum HostEvent {
|
|
|
4602
4659
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
4603
4660
|
* console.log('parameters', parameter);
|
|
4604
4661
|
* });
|
|
4605
|
-
|
|
4606
|
-
|
|
4662
|
+
* ```
|
|
4663
|
+
* ```js
|
|
4607
4664
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
4608
4665
|
* let latestSpotterVizId = '';
|
|
4609
4666
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -4611,7 +4668,7 @@ export declare enum HostEvent {
|
|
|
4611
4668
|
* });
|
|
4612
4669
|
*
|
|
4613
4670
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
4614
|
-
|
|
4671
|
+
* ```
|
|
4615
4672
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
4616
4673
|
*/
|
|
4617
4674
|
GetParameters = "GetParameters",
|
|
@@ -4628,7 +4685,7 @@ export declare enum HostEvent {
|
|
|
4628
4685
|
* Notify when info call is completed successfully
|
|
4629
4686
|
* ```js
|
|
4630
4687
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
4631
|
-
|
|
4688
|
+
* ```
|
|
4632
4689
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
4633
4690
|
*/
|
|
4634
4691
|
InfoSuccess = "InfoSuccess",
|
|
@@ -4641,8 +4698,8 @@ export declare enum HostEvent {
|
|
|
4641
4698
|
* triggered with a modal to prompt users to
|
|
4642
4699
|
* add a name and description for the Answer.
|
|
4643
4700
|
* @param - Includes the following keys:
|
|
4644
|
-
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
4645
|
-
* - `name`: Optional. Name string for the Answer.
|
|
4701
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
4702
|
+
* embed. - `name`: Optional. Name string for the Answer.
|
|
4646
4703
|
* - `description`: Optional. Description text for the Answer.
|
|
4647
4704
|
* @example
|
|
4648
4705
|
* ```js
|
|
@@ -4731,7 +4788,7 @@ export declare enum HostEvent {
|
|
|
4731
4788
|
* ```js
|
|
4732
4789
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
4733
4790
|
*
|
|
4734
|
-
|
|
4791
|
+
* ```
|
|
4735
4792
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
4736
4793
|
*/
|
|
4737
4794
|
AddToCoaching = "addToCoaching",
|
|
@@ -4773,7 +4830,7 @@ export declare enum HostEvent {
|
|
|
4773
4830
|
* });
|
|
4774
4831
|
*
|
|
4775
4832
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
4776
|
-
|
|
4833
|
+
* ```
|
|
4777
4834
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4778
4835
|
*/
|
|
4779
4836
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
@@ -4783,7 +4840,7 @@ export declare enum HostEvent {
|
|
|
4783
4840
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
4784
4841
|
* ```js
|
|
4785
4842
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
4786
|
-
|
|
4843
|
+
* ```
|
|
4787
4844
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4788
4845
|
*/
|
|
4789
4846
|
ExitPresentMode = "exitPresentMode",
|
|
@@ -4837,8 +4894,9 @@ export declare enum HostEvent {
|
|
|
4837
4894
|
/**
|
|
4838
4895
|
* Triggers a new conversation in Spotter embed.
|
|
4839
4896
|
*
|
|
4840
|
-
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
4841
|
-
* Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
4897
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
4898
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
4899
|
+
* instance.
|
|
4842
4900
|
*
|
|
4843
4901
|
* @example
|
|
4844
4902
|
* ```js
|
|
@@ -4882,6 +4940,7 @@ export declare enum DataSourceVisualMode {
|
|
|
4882
4940
|
* containing configuration and/or visual information.
|
|
4883
4941
|
*/
|
|
4884
4942
|
export declare enum Param {
|
|
4943
|
+
Tsmcp = "tsmcp",
|
|
4885
4944
|
EmbedApp = "embedApp",
|
|
4886
4945
|
DataSources = "dataSources",
|
|
4887
4946
|
DataSourceMode = "dataSourceMode",
|
|
@@ -4925,6 +4984,7 @@ export declare enum Param {
|
|
|
4925
4984
|
cookieless = "cookieless",
|
|
4926
4985
|
ContextMenuTrigger = "contextMenuEnabledOnWhichClick",
|
|
4927
4986
|
LinkOverride = "linkOverride",
|
|
4987
|
+
EnableLinkOverridesV2 = "enableLinkOverridesV2",
|
|
4928
4988
|
blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
|
|
4929
4989
|
ShowInsertToSlide = "insertInToSlide",
|
|
4930
4990
|
PrimaryNavHidden = "primaryNavHidden",
|
|
@@ -5018,7 +5078,8 @@ export declare enum Param {
|
|
|
5018
5078
|
SpotterNewChatButtonTitle = "spotterNewChatButtonTitle",
|
|
5019
5079
|
IsThisPeriodInDateFiltersEnabled = "isThisPeriodInDateFiltersEnabled",
|
|
5020
5080
|
HideToolResponseCardBranding = "hideToolResponseCardBranding",
|
|
5021
|
-
ToolResponseCardBrandingLabel = "toolResponseCardBrandingLabel"
|
|
5081
|
+
ToolResponseCardBrandingLabel = "toolResponseCardBrandingLabel",
|
|
5082
|
+
EnableHomepageAnnouncement = "enableHomepageAnnouncement"
|
|
5022
5083
|
}
|
|
5023
5084
|
/**
|
|
5024
5085
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -5177,14 +5238,14 @@ export declare enum Action {
|
|
|
5177
5238
|
* ```js
|
|
5178
5239
|
* disabledActions: [Action.CollapseDataPanel]
|
|
5179
5240
|
* ```
|
|
5180
|
-
* @version
|
|
5241
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5181
5242
|
*/
|
|
5182
5243
|
CollapseDataSources = "collapseDataSources",
|
|
5183
5244
|
/**
|
|
5184
5245
|
* The **Collapse data panel** icon on the Search page.
|
|
5185
5246
|
* Collapses the data panel view.
|
|
5186
5247
|
*
|
|
5187
|
-
* @version
|
|
5248
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5188
5249
|
*
|
|
5189
5250
|
* @example
|
|
5190
5251
|
* ```js
|
|
@@ -5631,13 +5692,12 @@ export declare enum Action {
|
|
|
5631
5692
|
*/
|
|
5632
5693
|
CreateMonitor = "createMonitor",
|
|
5633
5694
|
/**
|
|
5634
|
-
* @
|
|
5635
|
-
*
|
|
5695
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
5696
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
5636
5697
|
* @example
|
|
5637
5698
|
* ```js
|
|
5638
5699
|
* disabledActions: [Action.ReportError]
|
|
5639
5700
|
* ```
|
|
5640
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
5641
5701
|
*/
|
|
5642
5702
|
ReportError = "reportError",
|
|
5643
5703
|
/**
|
|
@@ -5647,7 +5707,7 @@ export declare enum Action {
|
|
|
5647
5707
|
* ```js
|
|
5648
5708
|
* disabledActions: [Action.SyncToSheets]
|
|
5649
5709
|
* ```
|
|
5650
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5710
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5651
5711
|
*/
|
|
5652
5712
|
SyncToSheets = "sync-to-sheets",
|
|
5653
5713
|
/**
|
|
@@ -5658,7 +5718,7 @@ export declare enum Action {
|
|
|
5658
5718
|
* ```js
|
|
5659
5719
|
* disabledActions: [Action.SyncToOtherApps]
|
|
5660
5720
|
* ```
|
|
5661
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5721
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5662
5722
|
*/
|
|
5663
5723
|
SyncToOtherApps = "sync-to-other-apps",
|
|
5664
5724
|
/**
|
|
@@ -5668,7 +5728,7 @@ export declare enum Action {
|
|
|
5668
5728
|
* ```js
|
|
5669
5729
|
* disabledActions: [Action.ManagePipelines]
|
|
5670
5730
|
* ```
|
|
5671
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5731
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5672
5732
|
*/
|
|
5673
5733
|
ManagePipelines = "manage-pipeline",
|
|
5674
5734
|
/**
|
|
@@ -5980,7 +6040,7 @@ export declare enum Action {
|
|
|
5980
6040
|
* ```js
|
|
5981
6041
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
5982
6042
|
* ```
|
|
5983
|
-
* @version SDK
|
|
6043
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
5984
6044
|
*/
|
|
5985
6045
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
5986
6046
|
/**
|
|
@@ -5990,7 +6050,7 @@ export declare enum Action {
|
|
|
5990
6050
|
* ```js
|
|
5991
6051
|
* disabledActions: [Action.LiveboardUsers]
|
|
5992
6052
|
* ```
|
|
5993
|
-
* @version SDK
|
|
6053
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
5994
6054
|
*/
|
|
5995
6055
|
LiveboardUsers = "liveboardUsers",
|
|
5996
6056
|
/**
|
|
@@ -6008,7 +6068,7 @@ export declare enum Action {
|
|
|
6008
6068
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
6009
6069
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
6010
6070
|
* ```
|
|
6011
|
-
* @version SDK
|
|
6071
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
6012
6072
|
*/
|
|
6013
6073
|
TML = "tml",
|
|
6014
6074
|
/**
|
|
@@ -6054,7 +6114,7 @@ export declare enum Action {
|
|
|
6054
6114
|
* ```js
|
|
6055
6115
|
* disabledActions: [Action.AddToWatchlist]
|
|
6056
6116
|
* ```
|
|
6057
|
-
* @version SDK
|
|
6117
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6058
6118
|
*/
|
|
6059
6119
|
AddToWatchlist = "addToWatchlist",
|
|
6060
6120
|
/**
|
|
@@ -6064,7 +6124,7 @@ export declare enum Action {
|
|
|
6064
6124
|
* ```js
|
|
6065
6125
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6066
6126
|
* ```
|
|
6067
|
-
* @version SDK
|
|
6127
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6068
6128
|
*/
|
|
6069
6129
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6070
6130
|
/**
|
|
@@ -6075,7 +6135,7 @@ export declare enum Action {
|
|
|
6075
6135
|
* ```js
|
|
6076
6136
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6077
6137
|
* ```
|
|
6078
|
-
* @version SDK
|
|
6138
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6079
6139
|
*/
|
|
6080
6140
|
OrganiseFavourites = "organiseFavourites",
|
|
6081
6141
|
/**
|
|
@@ -6136,7 +6196,7 @@ export declare enum Action {
|
|
|
6136
6196
|
* ```js
|
|
6137
6197
|
* disabledActions: [Action.ManageTags]
|
|
6138
6198
|
* ```
|
|
6139
|
-
* @version SDK
|
|
6199
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6140
6200
|
*/
|
|
6141
6201
|
ManageTags = "manageTags",
|
|
6142
6202
|
/**
|
|
@@ -6823,7 +6883,9 @@ export declare enum ErrorDetailsTypes {
|
|
|
6823
6883
|
NETWORK = "NETWORK"
|
|
6824
6884
|
}
|
|
6825
6885
|
/**
|
|
6826
|
-
* Error codes for identifying specific issues in embedded ThoughtSpot components. Use
|
|
6886
|
+
* Error codes for identifying specific issues in embedded ThoughtSpot components. Use
|
|
6887
|
+
* {@link EmbedErrorDetailsEvent} and {@link ErrorDetailsTypes} codes for precise error
|
|
6888
|
+
* handling and debugging.
|
|
6827
6889
|
*
|
|
6828
6890
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
6829
6891
|
* @group Error Handling
|
|
@@ -6882,15 +6944,16 @@ export declare enum EmbedErrorCodes {
|
|
|
6882
6944
|
/**
|
|
6883
6945
|
* Error event object emitted when an error occurs in an embedded component.
|
|
6884
6946
|
*
|
|
6885
|
-
* This interface defines the structure of error objects returned by the {@link
|
|
6886
|
-
* event. It provides detailed information about what went wrong,
|
|
6887
|
-
* a human-readable message, and a machine-readable error code.
|
|
6947
|
+
* This interface defines the structure of error objects returned by the {@link
|
|
6948
|
+
* EmbedEvent.Error} event. It provides detailed information about what went wrong,
|
|
6949
|
+
* including the error type, a human-readable message, and a machine-readable error code.
|
|
6888
6950
|
*
|
|
6889
6951
|
* ## Properties
|
|
6890
6952
|
*
|
|
6891
6953
|
* - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
|
|
6892
|
-
* - **message**: Human-readable error description (string or array of strings for
|
|
6893
|
-
* - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
6954
|
+
* - **message**: Human-readable error description (string or array of strings for
|
|
6955
|
+
* multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
6956
|
+
* values
|
|
6894
6957
|
* - **[key: string]**: Additional context-specific for backward compatibility
|
|
6895
6958
|
*
|
|
6896
6959
|
* ## Usage
|
|
@@ -6991,14 +7054,14 @@ export type ApiInterceptFlags = {
|
|
|
6991
7054
|
/**
|
|
6992
7055
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
6993
7056
|
*
|
|
6994
|
-
* Can be used for
|
|
7057
|
+
* Can be used for Search and App Embed from SDK 1.29.0
|
|
6995
7058
|
*
|
|
6996
|
-
* @version SDK
|
|
7059
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
6997
7060
|
*/
|
|
6998
7061
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
6999
7062
|
/**
|
|
7000
7063
|
* This allows to intercept the urls passed, once intercepted the api will only
|
|
7001
|
-
* run based on the
|
|
7064
|
+
* run based on the response from the responder of ApiIntercept event.
|
|
7002
7065
|
*
|
|
7003
7066
|
* @example
|
|
7004
7067
|
* ```js
|
|
@@ -7009,7 +7072,7 @@ export type ApiInterceptFlags = {
|
|
|
7009
7072
|
* })
|
|
7010
7073
|
* ```
|
|
7011
7074
|
*
|
|
7012
|
-
* @version SDK
|
|
7075
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7013
7076
|
*/
|
|
7014
7077
|
interceptUrls?: (string | InterceptedApiType)[];
|
|
7015
7078
|
/**
|
|
@@ -7026,7 +7089,7 @@ export type ApiInterceptFlags = {
|
|
|
7026
7089
|
* })
|
|
7027
7090
|
* ```
|
|
7028
7091
|
*
|
|
7029
|
-
* @version SDK
|
|
7092
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7030
7093
|
*/
|
|
7031
7094
|
interceptTimeout?: number;
|
|
7032
7095
|
};
|