@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/src/types.ts
CHANGED
|
@@ -10,7 +10,7 @@ import { CustomCssVariables } from './css-variables';
|
|
|
10
10
|
import type { SessionInterface } from './utils/graphql/answerService/answerService';
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
|
-
* The authentication mechanism for allowing access to
|
|
13
|
+
* The authentication mechanism for allowing access to
|
|
14
14
|
* the embedded app
|
|
15
15
|
* @group Authentication / Init
|
|
16
16
|
*/
|
|
@@ -36,6 +36,7 @@ export enum AuthType {
|
|
|
36
36
|
* To use this:
|
|
37
37
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
38
38
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
39
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
39
40
|
* @example
|
|
40
41
|
* ```js
|
|
41
42
|
* init({
|
|
@@ -43,18 +44,17 @@ export enum AuthType {
|
|
|
43
44
|
* authType: AuthType.EmbeddedSSO,
|
|
44
45
|
* });
|
|
45
46
|
* ```
|
|
46
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
47
47
|
*/
|
|
48
48
|
EmbeddedSSO = 'EmbeddedSSO',
|
|
49
49
|
/**
|
|
50
|
-
* SSO using SAML
|
|
51
|
-
* @deprecated
|
|
50
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
51
|
+
* @deprecated This option is deprecated.
|
|
52
52
|
* @hidden
|
|
53
53
|
*/
|
|
54
54
|
SSO = 'SSO_SAML',
|
|
55
55
|
/**
|
|
56
|
-
* SSO using SAML
|
|
57
|
-
* @deprecated
|
|
56
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
57
|
+
* @deprecated This option is deprecated.
|
|
58
58
|
* @hidden
|
|
59
59
|
*/
|
|
60
60
|
SAML = 'SSO_SAML',
|
|
@@ -105,8 +105,9 @@ export enum AuthType {
|
|
|
105
105
|
SAMLRedirect = 'SSO_SAML',
|
|
106
106
|
/**
|
|
107
107
|
* SSO using OIDC
|
|
108
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
109
|
+
* @deprecated This option is deprecated.
|
|
108
110
|
* @hidden
|
|
109
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
110
111
|
*/
|
|
111
112
|
OIDC = 'SSO_OIDC',
|
|
112
113
|
/**
|
|
@@ -117,8 +118,9 @@ export enum AuthType {
|
|
|
117
118
|
OIDCRedirect = 'SSO_OIDC',
|
|
118
119
|
/**
|
|
119
120
|
* Trusted authentication server
|
|
121
|
+
* Use {@link TrustedAuth} instead
|
|
122
|
+
* @deprecated This option is deprecated.
|
|
120
123
|
* @hidden
|
|
121
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
122
124
|
*/
|
|
123
125
|
AuthServer = 'AuthServer',
|
|
124
126
|
/**
|
|
@@ -145,6 +147,7 @@ export enum AuthType {
|
|
|
145
147
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
146
148
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
147
149
|
* implemented by some browsers.
|
|
150
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
148
151
|
* @example
|
|
149
152
|
* ```js
|
|
150
153
|
* init({
|
|
@@ -155,8 +158,8 @@ export enum AuthType {
|
|
|
155
158
|
* .then((response) => response.json())
|
|
156
159
|
* .then((data) => data.token);
|
|
157
160
|
* }
|
|
161
|
+
* });
|
|
158
162
|
* ```
|
|
159
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
160
163
|
*/
|
|
161
164
|
TrustedAuthTokenCookieless = 'AuthServerCookieless',
|
|
162
165
|
/**
|
|
@@ -177,43 +180,43 @@ export enum HomeLeftNavItem {
|
|
|
177
180
|
/**
|
|
178
181
|
* The *Search data* option in
|
|
179
182
|
* the *Insights* left navigation panel.
|
|
180
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
183
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
181
184
|
*/
|
|
182
185
|
SearchData = 'search-data',
|
|
183
186
|
/**
|
|
184
187
|
* The *Home* menu option in
|
|
185
188
|
* the *Insights* left navigation panel.
|
|
186
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
189
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
187
190
|
*/
|
|
188
191
|
Home = 'insights-home',
|
|
189
192
|
/**
|
|
190
193
|
* The *Liveboards* menu option in
|
|
191
194
|
* the *Insights* left navigation panel.
|
|
192
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
195
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
193
196
|
*/
|
|
194
197
|
Liveboards = 'liveboards',
|
|
195
198
|
/**
|
|
196
199
|
* The *Answers* menu option in
|
|
197
200
|
* the *Insights* left navigation panel.
|
|
198
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
201
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
199
202
|
*/
|
|
200
203
|
Answers = 'answers',
|
|
201
204
|
/**
|
|
202
205
|
* The *Monitor subscriptions* menu option in
|
|
203
206
|
* the *Insights* left navigation panel.
|
|
204
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
207
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
205
208
|
*/
|
|
206
209
|
MonitorSubscription = 'monitor-alerts',
|
|
207
210
|
/**
|
|
208
211
|
* The *SpotIQ analysis* menu option in
|
|
209
212
|
* the *Insights* left navigation panel.
|
|
210
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
213
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
211
214
|
*/
|
|
212
215
|
SpotIQAnalysis = 'spotiq-analysis',
|
|
213
216
|
/**
|
|
214
217
|
* The *Liveboard schedules* menu option in
|
|
215
218
|
* the *Insights* left navigation panel.
|
|
216
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
219
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
217
220
|
*/
|
|
218
221
|
LiveboardSchedules = 'liveboard-schedules',
|
|
219
222
|
/**
|
|
@@ -390,8 +393,8 @@ export interface EmbedConfig {
|
|
|
390
393
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
391
394
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
392
395
|
* place.
|
|
396
|
+
* @deprecated This option is deprecated.
|
|
393
397
|
* @default false
|
|
394
|
-
* @deprecated
|
|
395
398
|
*/
|
|
396
399
|
noRedirect?: boolean;
|
|
397
400
|
|
|
@@ -401,8 +404,8 @@ export interface EmbedConfig {
|
|
|
401
404
|
*
|
|
402
405
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
403
406
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
404
|
-
* @default false
|
|
405
407
|
* @version SDK: 1.18.0
|
|
408
|
+
* @default false
|
|
406
409
|
*/
|
|
407
410
|
inPopup?: boolean;
|
|
408
411
|
|
|
@@ -412,7 +415,7 @@ export interface EmbedConfig {
|
|
|
412
415
|
* terminated.
|
|
413
416
|
*
|
|
414
417
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
415
|
-
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
418
|
+
* @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
416
419
|
*/
|
|
417
420
|
redirectPath?: string;
|
|
418
421
|
|
|
@@ -495,7 +498,7 @@ export interface EmbedConfig {
|
|
|
495
498
|
detectCookieAccessSlow?: boolean;
|
|
496
499
|
/**
|
|
497
500
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
498
|
-
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
501
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
499
502
|
*/
|
|
500
503
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
501
504
|
/**
|
|
@@ -512,6 +515,7 @@ export interface EmbedConfig {
|
|
|
512
515
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
513
516
|
* button that the user can click to trigger the flow.
|
|
514
517
|
* This attribute sets a containing element for that button.
|
|
518
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
515
519
|
* @example
|
|
516
520
|
* ```js
|
|
517
521
|
* init({
|
|
@@ -520,7 +524,6 @@ export interface EmbedConfig {
|
|
|
520
524
|
* authTriggerContainer: '#auth-trigger-container'
|
|
521
525
|
* })
|
|
522
526
|
* ```
|
|
523
|
-
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
524
527
|
*/
|
|
525
528
|
authTriggerContainer?: string | HTMLElement;
|
|
526
529
|
/**
|
|
@@ -537,11 +540,10 @@ export interface EmbedConfig {
|
|
|
537
540
|
*/
|
|
538
541
|
authTriggerText?: string;
|
|
539
542
|
/**
|
|
540
|
-
* Prevent users from accessing
|
|
541
|
-
*
|
|
542
|
-
* outside of the iframe.
|
|
543
|
-
* @default true
|
|
543
|
+
* Prevent embedded application users from accessing ThoughtSpot
|
|
544
|
+
* application pages outside of the iframe.
|
|
544
545
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
546
|
+
* @default true
|
|
545
547
|
*/
|
|
546
548
|
blockNonEmbedFullAppAccess?: boolean;
|
|
547
549
|
|
|
@@ -575,6 +577,7 @@ export interface EmbedConfig {
|
|
|
575
577
|
* other logs such as warnings, information alerts,
|
|
576
578
|
* and debug messages in the console output.
|
|
577
579
|
*
|
|
580
|
+
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
578
581
|
* @default LogLevel.ERROR
|
|
579
582
|
* @example
|
|
580
583
|
* ```js
|
|
@@ -583,7 +586,6 @@ export interface EmbedConfig {
|
|
|
583
586
|
* logLevel: LogLevel.SILENT
|
|
584
587
|
* })
|
|
585
588
|
* ```
|
|
586
|
-
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
587
589
|
*/
|
|
588
590
|
logLevel?: LogLevel;
|
|
589
591
|
/**
|
|
@@ -611,6 +613,7 @@ export interface EmbedConfig {
|
|
|
611
613
|
* This flag is used to disable the token verification in the SDK.
|
|
612
614
|
* Enabling this flag will also disable the caching of the token.
|
|
613
615
|
* @hidden
|
|
616
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
614
617
|
* @example
|
|
615
618
|
* ```js
|
|
616
619
|
* init({
|
|
@@ -618,13 +621,12 @@ export interface EmbedConfig {
|
|
|
618
621
|
* disableTokenVerification : true
|
|
619
622
|
* })
|
|
620
623
|
* ```
|
|
621
|
-
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
622
624
|
*/
|
|
623
625
|
disableTokenVerification?: boolean;
|
|
624
626
|
|
|
625
627
|
/**
|
|
626
628
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
627
|
-
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
629
|
+
* @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
628
630
|
*/
|
|
629
631
|
disableLoginFailurePage?: boolean;
|
|
630
632
|
/**
|
|
@@ -634,6 +636,7 @@ export interface EmbedConfig {
|
|
|
634
636
|
* Warning: This option is for advanced use only and is used internally
|
|
635
637
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
636
638
|
* list of supported keys and values associated with each.
|
|
639
|
+
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
637
640
|
* @example
|
|
638
641
|
* ```js
|
|
639
642
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -644,12 +647,12 @@ export interface EmbedConfig {
|
|
|
644
647
|
* }
|
|
645
648
|
* });
|
|
646
649
|
* ```
|
|
647
|
-
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
648
650
|
*/
|
|
649
651
|
additionalFlags?: { [key: string]: string | number | boolean };
|
|
650
652
|
/**
|
|
651
653
|
* This is an object (key/val) for customVariables being
|
|
652
654
|
* used by the third party tool's script.
|
|
655
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
653
656
|
* @example
|
|
654
657
|
* ```js
|
|
655
658
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -660,7 +663,6 @@ export interface EmbedConfig {
|
|
|
660
663
|
* }
|
|
661
664
|
* });
|
|
662
665
|
* ```
|
|
663
|
-
* @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
664
666
|
*/
|
|
665
667
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
666
668
|
|
|
@@ -669,8 +671,8 @@ export interface EmbedConfig {
|
|
|
669
671
|
/**
|
|
670
672
|
* Disable fullscreen presentation mode functionality. When enabled, prevents entering
|
|
671
673
|
* and exiting fullscreen mode for embedded visualizations during presentations.
|
|
672
|
-
* @default true (feature is disabled by default)
|
|
673
674
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
675
|
+
* @default true (feature is disabled by default)
|
|
674
676
|
* @example
|
|
675
677
|
* ```js
|
|
676
678
|
* init({
|
|
@@ -880,7 +882,7 @@ export interface FrameParams {
|
|
|
880
882
|
*/
|
|
881
883
|
loading?: 'lazy' | 'eager' | 'auto';
|
|
882
884
|
/**
|
|
883
|
-
*
|
|
885
|
+
* These parameters will be passed to the iframe
|
|
884
886
|
* as is.
|
|
885
887
|
*/
|
|
886
888
|
[key: string]: string | number | boolean | undefined;
|
|
@@ -957,8 +959,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
957
959
|
*/
|
|
958
960
|
disabledActionReason?: string;
|
|
959
961
|
/**
|
|
960
|
-
* The list of actions to hide from the embedded.
|
|
961
|
-
*
|
|
962
|
+
* The list of actions to hide from the embedded view.
|
|
963
|
+
* These actions will be hidden from the user.
|
|
962
964
|
* Use this to hide an action.
|
|
963
965
|
*
|
|
964
966
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
@@ -999,7 +1001,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
999
1001
|
* The locale settings to apply to the embedded view.
|
|
1000
1002
|
*
|
|
1001
1003
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1002
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
1004
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1003
1005
|
* @example
|
|
1004
1006
|
* ```js
|
|
1005
1007
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1014,12 +1016,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1014
1016
|
* This is an object (key/val) of override flags which will be applied
|
|
1015
1017
|
* to the internal embedded object. This can be used to add any
|
|
1016
1018
|
* URL flag.
|
|
1017
|
-
* If the same flags are passed in init, they will be
|
|
1019
|
+
* If the same flags are passed in init, they will be overridden by the values here.
|
|
1018
1020
|
* Warning: This option is for advanced use only and is used internally
|
|
1019
1021
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1020
1022
|
* list of supported keys and values associated with each.
|
|
1021
1023
|
*
|
|
1022
1024
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1025
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1023
1026
|
* @example
|
|
1024
1027
|
* ```js
|
|
1025
1028
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1031,7 +1034,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1031
1034
|
* },
|
|
1032
1035
|
* });
|
|
1033
1036
|
* ```
|
|
1034
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1035
1037
|
*/
|
|
1036
1038
|
additionalFlags?: { [key: string]: string | number | boolean };
|
|
1037
1039
|
/**
|
|
@@ -1072,6 +1074,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1072
1074
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1073
1075
|
*
|
|
1074
1076
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1077
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1075
1078
|
* @example
|
|
1076
1079
|
* ```js
|
|
1077
1080
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1081,7 +1084,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1081
1084
|
* });
|
|
1082
1085
|
* embed.showPreRender();
|
|
1083
1086
|
* ```
|
|
1084
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1085
1087
|
*/
|
|
1086
1088
|
preRenderId?: string;
|
|
1087
1089
|
|
|
@@ -1092,7 +1094,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1092
1094
|
* its dimensions based on changes to the size of the embedding element.
|
|
1093
1095
|
* @type {boolean}
|
|
1094
1096
|
* @default false
|
|
1095
|
-
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
1097
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
|
|
1096
1098
|
* @example
|
|
1097
1099
|
* ```js
|
|
1098
1100
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -1107,9 +1109,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1107
1109
|
doNotTrackPreRenderSize?: boolean;
|
|
1108
1110
|
/**
|
|
1109
1111
|
* Enable the V2 shell. This can provide performance benefits
|
|
1110
|
-
* due to a
|
|
1112
|
+
* due to a lighter-weight shell.
|
|
1111
1113
|
*
|
|
1112
1114
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1115
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1113
1116
|
* @example
|
|
1114
1117
|
* ```js
|
|
1115
1118
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1118,7 +1121,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1118
1121
|
* enableV2Shell_experimental: true,
|
|
1119
1122
|
* });
|
|
1120
1123
|
* ```
|
|
1121
|
-
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1122
1124
|
*/
|
|
1123
1125
|
|
|
1124
1126
|
enableV2Shell_experimental?: boolean;
|
|
@@ -1138,6 +1140,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1138
1140
|
* and disable redirection of links in a new tab.
|
|
1139
1141
|
*
|
|
1140
1142
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1143
|
+
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1141
1144
|
* @example
|
|
1142
1145
|
* ```js
|
|
1143
1146
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1146,7 +1149,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1146
1149
|
* disableRedirectionLinksInNewTab: true,
|
|
1147
1150
|
* });
|
|
1148
1151
|
* ```
|
|
1149
|
-
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1150
1152
|
*/
|
|
1151
1153
|
disableRedirectionLinksInNewTab?: boolean;
|
|
1152
1154
|
/**
|
|
@@ -1157,6 +1159,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1157
1159
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
1158
1160
|
*
|
|
1159
1161
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1162
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
1160
1163
|
* @example
|
|
1161
1164
|
* ```js
|
|
1162
1165
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1165,24 +1168,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1165
1168
|
* overrideOrgId: 142536,
|
|
1166
1169
|
* });
|
|
1167
1170
|
* ```
|
|
1168
|
-
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
1169
1171
|
*/
|
|
1170
1172
|
overrideOrgId?: number;
|
|
1171
1173
|
/**
|
|
1172
|
-
* Flag to override the *Open Link in New Tab* context
|
|
1174
|
+
* Flag to override the *Open Link in New Tab* context
|
|
1175
|
+
* menu option.
|
|
1173
1176
|
*
|
|
1174
|
-
*
|
|
1177
|
+
* For improved link override handling, use
|
|
1178
|
+
* {@link enableLinkOverridesV2} instead.
|
|
1179
|
+
*
|
|
1180
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
1181
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
1182
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
1175
1183
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1176
1184
|
* @example
|
|
1177
1185
|
* ```js
|
|
1178
|
-
*
|
|
1179
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1186
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1180
1187
|
* ... // other embed view config
|
|
1181
|
-
* linkOverride:
|
|
1188
|
+
* linkOverride: true,
|
|
1182
1189
|
* })
|
|
1183
1190
|
* ```
|
|
1184
1191
|
*/
|
|
1185
1192
|
linkOverride?: boolean;
|
|
1193
|
+
/**
|
|
1194
|
+
* Enables the V2 link override mechanism with improved
|
|
1195
|
+
* handling. When enabled, navigation links within the
|
|
1196
|
+
* embedded ThoughtSpot app are intercepted and routed
|
|
1197
|
+
* through the SDK via the `EmbedEvent.DialogOpen`
|
|
1198
|
+
* event.
|
|
1199
|
+
*
|
|
1200
|
+
* The SDK automatically sends {@link linkOverride}
|
|
1201
|
+
* alongside this flag for backward compatibility with
|
|
1202
|
+
* older ThoughtSpot versions.
|
|
1203
|
+
*
|
|
1204
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
1205
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
1206
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
1207
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
|
|
1208
|
+
* @example
|
|
1209
|
+
* ```js
|
|
1210
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1211
|
+
* ... // other embed view config
|
|
1212
|
+
* enableLinkOverridesV2: true,
|
|
1213
|
+
* });
|
|
1214
|
+
*
|
|
1215
|
+
* embed.on(EmbedEvent.DialogOpen, (payload) => {
|
|
1216
|
+
* console.log('Link clicked:', payload);
|
|
1217
|
+
* });
|
|
1218
|
+
* ```
|
|
1219
|
+
*/
|
|
1220
|
+
enableLinkOverridesV2?: boolean;
|
|
1186
1221
|
/**
|
|
1187
1222
|
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
1188
1223
|
* Use this to set the primary action.
|
|
@@ -1207,7 +1242,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1207
1242
|
insertInToSlide?: boolean;
|
|
1208
1243
|
/**
|
|
1209
1244
|
* Show alert messages and toast messages in the embed.
|
|
1210
|
-
* Supported
|
|
1245
|
+
* Supported in all embed types.
|
|
1211
1246
|
*
|
|
1212
1247
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1213
1248
|
* @example
|
|
@@ -1441,6 +1476,9 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1441
1476
|
useHostEventsV2?: boolean;
|
|
1442
1477
|
}
|
|
1443
1478
|
|
|
1479
|
+
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
|
1480
|
+
export interface AutoMCPFrameRendererViewConfig extends BaseViewConfig {}
|
|
1481
|
+
|
|
1444
1482
|
/**
|
|
1445
1483
|
* The configuration object for Home page embeds configs.
|
|
1446
1484
|
*/
|
|
@@ -1450,8 +1488,9 @@ export interface HomePageConfig {
|
|
|
1450
1488
|
* *Liveboards* and *Answers*.
|
|
1451
1489
|
* For example: `hiddenListColumns = [ListPageColumns.Author]`
|
|
1452
1490
|
*
|
|
1453
|
-
* **Note**: This option is available only in full app embedding and requires
|
|
1454
|
-
* Starting with version 10.14.0.cl, you can
|
|
1491
|
+
* **Note**: This option is available only in full app embedding and requires
|
|
1492
|
+
* importing the `ListPageColumns` enum. Starting with version 10.14.0.cl, you can
|
|
1493
|
+
* use this attribute to
|
|
1455
1494
|
* hide the columns on all list pages in the *Insights* section.
|
|
1456
1495
|
*
|
|
1457
1496
|
* Supported embed types: `AppEmbed`
|
|
@@ -1491,11 +1530,12 @@ export interface HomePageConfig {
|
|
|
1491
1530
|
/**
|
|
1492
1531
|
* Reorder home page modules.
|
|
1493
1532
|
* To specify the modules, import the `HomepageModule` enum.
|
|
1494
|
-
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
1495
|
-
* **Note**: This attribute is not supported in the
|
|
1533
|
+
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
1534
|
+
* HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
|
|
1535
|
+
* classic (v1) homepage.
|
|
1496
1536
|
*
|
|
1497
1537
|
* Supported embed types: `AppEmbed`
|
|
1498
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
1538
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
1499
1539
|
* @example
|
|
1500
1540
|
* ```js
|
|
1501
1541
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1516,6 +1556,7 @@ export interface HomePageConfig {
|
|
|
1516
1556
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
1517
1557
|
*
|
|
1518
1558
|
* Supported embed types: `AppEmbed`
|
|
1559
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
1519
1560
|
* @example
|
|
1520
1561
|
* ```js
|
|
1521
1562
|
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1526,7 +1567,6 @@ export interface HomePageConfig {
|
|
|
1526
1567
|
* ... //other embed view configuration attributes
|
|
1527
1568
|
* })
|
|
1528
1569
|
* ```
|
|
1529
|
-
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
1530
1570
|
*/
|
|
1531
1571
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
1532
1572
|
}
|
|
@@ -1540,7 +1580,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1540
1580
|
* visualization, or Liveboard.
|
|
1541
1581
|
*
|
|
1542
1582
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1543
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
1583
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1544
1584
|
* @example
|
|
1545
1585
|
* ```js
|
|
1546
1586
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1558,11 +1598,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1558
1598
|
*/
|
|
1559
1599
|
runtimeFilters?: RuntimeFilter[];
|
|
1560
1600
|
/**
|
|
1561
|
-
* The list of parameter
|
|
1601
|
+
* The list of parameter overrides to apply to a search Answer,
|
|
1562
1602
|
* visualization, or Liveboard.
|
|
1563
1603
|
*
|
|
1564
1604
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1565
|
-
* @version SDK
|
|
1605
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1566
1606
|
* @example
|
|
1567
1607
|
* ```js
|
|
1568
1608
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1582,6 +1622,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1582
1622
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
1583
1623
|
*
|
|
1584
1624
|
* Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
|
|
1625
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1585
1626
|
* @example
|
|
1586
1627
|
* ```js
|
|
1587
1628
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
|
|
@@ -1590,7 +1631,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1590
1631
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
1591
1632
|
* })
|
|
1592
1633
|
* ```
|
|
1593
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1594
1634
|
*/
|
|
1595
1635
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
1596
1636
|
/**
|
|
@@ -1613,7 +1653,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1613
1653
|
* when set to false, runtime parameters will be included in the URL
|
|
1614
1654
|
* (default behavior before SDK 1.45.0).
|
|
1615
1655
|
*
|
|
1616
|
-
* Irrespective of this flag, runtime
|
|
1656
|
+
* Irrespective of this flag, runtime parameters (if passed) will be applied to the
|
|
1617
1657
|
* embedded view.
|
|
1618
1658
|
* @default true
|
|
1619
1659
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
@@ -1632,14 +1672,15 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1632
1672
|
* ... // other embed view config
|
|
1633
1673
|
* collapseSearchBar: true,
|
|
1634
1674
|
* });
|
|
1675
|
+
* ```
|
|
1635
1676
|
*/
|
|
1636
1677
|
collapseSearchBar?: boolean;
|
|
1637
1678
|
/**
|
|
1638
1679
|
* Flag to control Data panel experience
|
|
1639
1680
|
*
|
|
1640
1681
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1682
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
1641
1683
|
* @default true
|
|
1642
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
1643
1684
|
* @example
|
|
1644
1685
|
* ```js
|
|
1645
1686
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -1672,6 +1713,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1672
1713
|
* the current time period in filter results.
|
|
1673
1714
|
*
|
|
1674
1715
|
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1716
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
1675
1717
|
* @example
|
|
1676
1718
|
* ```js
|
|
1677
1719
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
@@ -1679,7 +1721,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1679
1721
|
* isThisPeriodInDateFiltersEnabled: true,
|
|
1680
1722
|
* })
|
|
1681
1723
|
* ```
|
|
1682
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
1683
1724
|
*/
|
|
1684
1725
|
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
1685
1726
|
}
|
|
@@ -1740,6 +1781,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1740
1781
|
* Boolean to control if Liveboard header is sticky or not.
|
|
1741
1782
|
*
|
|
1742
1783
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1784
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1743
1785
|
* @example
|
|
1744
1786
|
* ```js
|
|
1745
1787
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -1748,7 +1790,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1748
1790
|
* isLiveboardHeaderSticky: true,
|
|
1749
1791
|
* });
|
|
1750
1792
|
* ```
|
|
1751
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1752
1793
|
*/
|
|
1753
1794
|
isLiveboardHeaderSticky?: boolean;
|
|
1754
1795
|
/**
|
|
@@ -1756,8 +1797,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1756
1797
|
*
|
|
1757
1798
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1758
1799
|
* @type {boolean}
|
|
1800
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
|
|
1759
1801
|
* @default false
|
|
1760
|
-
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1761
1802
|
* @example
|
|
1762
1803
|
* ```js
|
|
1763
1804
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -1773,8 +1814,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1773
1814
|
*
|
|
1774
1815
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1775
1816
|
* @type {boolean}
|
|
1817
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
|
|
1776
1818
|
* @default false
|
|
1777
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
|
|
1778
1819
|
* @example
|
|
1779
1820
|
* ```js
|
|
1780
1821
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -1790,7 +1831,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1790
1831
|
* header.
|
|
1791
1832
|
*
|
|
1792
1833
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1793
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
1834
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
1794
1835
|
* @default true
|
|
1795
1836
|
* @example
|
|
1796
1837
|
* ```js
|
|
@@ -1805,10 +1846,12 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1805
1846
|
/**
|
|
1806
1847
|
* This flag is used to enable/disable hide irrelevant filters in Liveboard tab
|
|
1807
1848
|
*
|
|
1808
|
-
* **Note**: This feature is supported only if compact header is enabled on your
|
|
1849
|
+
* **Note**: This feature is supported only if compact header is enabled on your
|
|
1850
|
+
* Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled`
|
|
1851
|
+
* attribute.
|
|
1809
1852
|
*
|
|
1810
1853
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1811
|
-
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
1854
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
1812
1855
|
* @default false
|
|
1813
1856
|
* @example
|
|
1814
1857
|
* ```js
|
|
@@ -1826,7 +1869,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1826
1869
|
* compact header
|
|
1827
1870
|
*
|
|
1828
1871
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1829
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
1872
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
1830
1873
|
* @default true
|
|
1831
1874
|
* @example
|
|
1832
1875
|
* ```js
|
|
@@ -1859,7 +1902,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1859
1902
|
* the cover and filters pages in the Liveboard PDF.
|
|
1860
1903
|
*
|
|
1861
1904
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1862
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
1905
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
|
|
1863
1906
|
* @example
|
|
1864
1907
|
* ```js
|
|
1865
1908
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -1871,9 +1914,9 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1871
1914
|
*/
|
|
1872
1915
|
coverAndFilterOptionInPDF?: boolean;
|
|
1873
1916
|
/**
|
|
1874
|
-
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
1875
|
-
* When enabled, a unified modal is used to manage and update multiple filters
|
|
1876
|
-
* replacing the older individual filter interactions.
|
|
1917
|
+
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
1918
|
+
* (v2). When enabled, a unified modal is used to manage and update multiple filters
|
|
1919
|
+
* at once, replacing the older individual filter interactions.
|
|
1877
1920
|
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
1878
1921
|
*
|
|
1879
1922
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
@@ -1905,7 +1948,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1905
1948
|
isLinkParametersEnabled?: boolean;
|
|
1906
1949
|
|
|
1907
1950
|
/**
|
|
1908
|
-
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
1951
|
+
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
1952
|
+
* liveboard.
|
|
1909
1953
|
*
|
|
1910
1954
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1911
1955
|
* @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
|
|
@@ -2097,7 +2141,7 @@ export enum HomepageModule {
|
|
|
2097
2141
|
*/
|
|
2098
2142
|
Search = 'SEARCH',
|
|
2099
2143
|
/**
|
|
2100
|
-
*
|
|
2144
|
+
* KPI watchlist module
|
|
2101
2145
|
*/
|
|
2102
2146
|
Watchlist = 'WATCHLIST',
|
|
2103
2147
|
/**
|
|
@@ -2130,7 +2174,8 @@ export enum ListPageColumns {
|
|
|
2130
2174
|
*/
|
|
2131
2175
|
Favorites = 'FAVOURITE',
|
|
2132
2176
|
/**
|
|
2133
|
-
*
|
|
2177
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
2178
|
+
* @deprecated This option is deprecated.
|
|
2134
2179
|
*/
|
|
2135
2180
|
Favourite = Favorites,
|
|
2136
2181
|
/**
|
|
@@ -2234,13 +2279,13 @@ export enum EmbedEvent {
|
|
|
2234
2279
|
/**
|
|
2235
2280
|
* Rendering has initialized.
|
|
2236
2281
|
* @example
|
|
2237
|
-
|
|
2282
|
+
* ```js
|
|
2238
2283
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
2239
2284
|
* //show a loader
|
|
2240
2285
|
* function showLoader() {
|
|
2241
2286
|
* document.getElementById("loader");
|
|
2242
2287
|
* }
|
|
2243
|
-
|
|
2288
|
+
* ```
|
|
2244
2289
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2245
2290
|
*/
|
|
2246
2291
|
Init = 'init',
|
|
@@ -2248,11 +2293,11 @@ export enum EmbedEvent {
|
|
|
2248
2293
|
* Authentication has either succeeded or failed.
|
|
2249
2294
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2250
2295
|
* @example
|
|
2251
|
-
|
|
2296
|
+
* ```js
|
|
2252
2297
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
2253
2298
|
* console.log('AuthInit', payload);
|
|
2254
2299
|
* })
|
|
2255
|
-
|
|
2300
|
+
* ```
|
|
2256
2301
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
2257
2302
|
*/
|
|
2258
2303
|
AuthInit = 'authInit',
|
|
@@ -2261,13 +2306,13 @@ export enum EmbedEvent {
|
|
|
2261
2306
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2262
2307
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2263
2308
|
* @example
|
|
2264
|
-
|
|
2309
|
+
* ```js
|
|
2265
2310
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
2266
2311
|
* //hide loader
|
|
2267
2312
|
* function hideLoader() {
|
|
2268
2313
|
* document.getElementById("loader");
|
|
2269
2314
|
* }
|
|
2270
|
-
|
|
2315
|
+
* ```
|
|
2271
2316
|
*/
|
|
2272
2317
|
Load = 'load',
|
|
2273
2318
|
/**
|
|
@@ -2276,11 +2321,11 @@ export enum EmbedEvent {
|
|
|
2276
2321
|
* @return data - Answer of Liveboard data
|
|
2277
2322
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2278
2323
|
* @example
|
|
2279
|
-
|
|
2324
|
+
* ```js
|
|
2280
2325
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
2281
2326
|
* console.log('data', payload);
|
|
2282
2327
|
* })
|
|
2283
|
-
|
|
2328
|
+
* ```
|
|
2284
2329
|
* @important
|
|
2285
2330
|
*/
|
|
2286
2331
|
Data = 'data',
|
|
@@ -2288,9 +2333,9 @@ export enum EmbedEvent {
|
|
|
2288
2333
|
* Search query has been updated by the user.
|
|
2289
2334
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2290
2335
|
* @example
|
|
2291
|
-
|
|
2336
|
+
* ```js
|
|
2292
2337
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
2293
|
-
|
|
2338
|
+
* ```
|
|
2294
2339
|
*/
|
|
2295
2340
|
QueryChanged = 'queryChanged',
|
|
2296
2341
|
/**
|
|
@@ -2300,7 +2345,7 @@ export enum EmbedEvent {
|
|
|
2300
2345
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2301
2346
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
2302
2347
|
* @example
|
|
2303
|
-
|
|
2348
|
+
* ```js
|
|
2304
2349
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
2305
2350
|
* points: {
|
|
2306
2351
|
* clickedPoint,
|
|
@@ -2308,12 +2353,12 @@ export enum EmbedEvent {
|
|
|
2308
2353
|
* },
|
|
2309
2354
|
* autoDrillDown: true,
|
|
2310
2355
|
* })
|
|
2311
|
-
|
|
2356
|
+
* ```
|
|
2312
2357
|
* In this example, `VizPointDoubleClick` event is used for
|
|
2313
2358
|
* triggering the `DrillDown` event when an area or specific
|
|
2314
2359
|
* data point on a table or chart is double-clicked.
|
|
2315
2360
|
* @example
|
|
2316
|
-
|
|
2361
|
+
* ```js
|
|
2317
2362
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
2318
2363
|
* console.log(payload);
|
|
2319
2364
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -2327,7 +2372,7 @@ export enum EmbedEvent {
|
|
|
2327
2372
|
* autoDrillDown: true,
|
|
2328
2373
|
* })
|
|
2329
2374
|
* })
|
|
2330
|
-
|
|
2375
|
+
* ```
|
|
2331
2376
|
*/
|
|
2332
2377
|
Drilldown = 'drillDown',
|
|
2333
2378
|
/**
|
|
@@ -2452,13 +2497,13 @@ export enum EmbedEvent {
|
|
|
2452
2497
|
* The ThoughtSpot authentication session has expired.
|
|
2453
2498
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2454
2499
|
* @example
|
|
2455
|
-
|
|
2500
|
+
* ```js
|
|
2456
2501
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
2457
2502
|
* //show auth expired banner
|
|
2458
2503
|
* function showAuthExpired() {
|
|
2459
2504
|
* document.getElementById("authExpiredBanner");
|
|
2460
2505
|
* }
|
|
2461
|
-
|
|
2506
|
+
* ```
|
|
2462
2507
|
*/
|
|
2463
2508
|
AuthExpire = 'ThoughtspotAuthExpired',
|
|
2464
2509
|
/**
|
|
@@ -2495,22 +2540,22 @@ export enum EmbedEvent {
|
|
|
2495
2540
|
* Applicable to `SearchBarEmbed` only.
|
|
2496
2541
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2497
2542
|
* @example
|
|
2498
|
-
|
|
2543
|
+
* ```js
|
|
2499
2544
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
2500
2545
|
* .then(data => {
|
|
2501
2546
|
* console.log('Answer Data:', data);
|
|
2502
2547
|
* })
|
|
2503
|
-
|
|
2548
|
+
* ```
|
|
2504
2549
|
*/
|
|
2505
2550
|
GetDataClick = 'getDataClick',
|
|
2506
2551
|
/**
|
|
2507
2552
|
* Detects the route change.
|
|
2508
2553
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
2509
2554
|
* @example
|
|
2510
|
-
|
|
2555
|
+
* ```js
|
|
2511
2556
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
2512
2557
|
* console.log('data', payload))
|
|
2513
|
-
|
|
2558
|
+
* ```
|
|
2514
2559
|
*/
|
|
2515
2560
|
RouteChange = 'ROUTE_CHANGE',
|
|
2516
2561
|
/**
|
|
@@ -2520,12 +2565,12 @@ export enum EmbedEvent {
|
|
|
2520
2565
|
V1Data = 'exportVizDataToParent',
|
|
2521
2566
|
/**
|
|
2522
2567
|
* Emitted when the embed does not have cookie access. This happens
|
|
2523
|
-
* when
|
|
2524
|
-
*
|
|
2568
|
+
* when third-party cookies are blocked by Safari or other
|
|
2569
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
2525
2570
|
* @example
|
|
2526
|
-
|
|
2571
|
+
* ```js
|
|
2527
2572
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
2528
|
-
|
|
2573
|
+
* ```
|
|
2529
2574
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
2530
2575
|
*/
|
|
2531
2576
|
NoCookieAccess = 'noCookieAccess',
|
|
@@ -2539,22 +2584,22 @@ export enum EmbedEvent {
|
|
|
2539
2584
|
* Emitted when any modal is opened in the app
|
|
2540
2585
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2541
2586
|
* @example
|
|
2542
|
-
|
|
2587
|
+
* ```js
|
|
2543
2588
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
2544
2589
|
* console.log('dialog open', payload);
|
|
2545
2590
|
* })
|
|
2546
|
-
|
|
2591
|
+
* ```
|
|
2547
2592
|
*/
|
|
2548
2593
|
DialogOpen = 'dialog-open',
|
|
2549
2594
|
/**
|
|
2550
2595
|
* Emitted when any modal is closed in the app
|
|
2551
2596
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2552
2597
|
* @example
|
|
2553
|
-
|
|
2598
|
+
* ```js
|
|
2554
2599
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
2555
2600
|
* console.log('dialog close', payload);
|
|
2556
2601
|
* })
|
|
2557
|
-
|
|
2602
|
+
* ```
|
|
2558
2603
|
*/
|
|
2559
2604
|
DialogClose = 'dialog-close',
|
|
2560
2605
|
/**
|
|
@@ -2563,39 +2608,39 @@ export enum EmbedEvent {
|
|
|
2563
2608
|
* other events on the rendered Liveboard.
|
|
2564
2609
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2565
2610
|
* @example
|
|
2566
|
-
|
|
2611
|
+
* ```js
|
|
2567
2612
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
2568
2613
|
console.log('Liveboard is rendered', payload);
|
|
2569
2614
|
})
|
|
2570
|
-
|
|
2615
|
+
* ```
|
|
2571
2616
|
* The following example shows how to trigger
|
|
2572
2617
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
2573
2618
|
* @example
|
|
2574
|
-
|
|
2619
|
+
* ```js
|
|
2575
2620
|
* const embedRef = useEmbedRef();
|
|
2576
2621
|
* const onLiveboardRendered = () => {
|
|
2577
2622
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
2578
2623
|
* };
|
|
2579
|
-
|
|
2624
|
+
* ```
|
|
2580
2625
|
*/
|
|
2581
2626
|
LiveboardRendered = 'PinboardRendered',
|
|
2582
2627
|
/**
|
|
2583
2628
|
* Emits all events.
|
|
2584
|
-
* @
|
|
2629
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2585
2630
|
* @example
|
|
2586
|
-
|
|
2631
|
+
* ```js
|
|
2587
2632
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
2588
2633
|
* console.log('Embed Events', payload)
|
|
2589
2634
|
* })
|
|
2590
|
-
|
|
2635
|
+
* ```
|
|
2591
2636
|
*/
|
|
2592
2637
|
ALL = '*',
|
|
2593
2638
|
/**
|
|
2594
2639
|
* Emitted when an Answer is saved in the app.
|
|
2595
2640
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
2596
|
-
* @
|
|
2641
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2597
2642
|
* @example
|
|
2598
|
-
|
|
2643
|
+
* ```js
|
|
2599
2644
|
* //Emit when action starts
|
|
2600
2645
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
2601
2646
|
* console.log('Save', payload)
|
|
@@ -2606,7 +2651,7 @@ export enum EmbedEvent {
|
|
|
2606
2651
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
2607
2652
|
* console.log('Save', payload)
|
|
2608
2653
|
* })
|
|
2609
|
-
|
|
2654
|
+
* ```
|
|
2610
2655
|
*/
|
|
2611
2656
|
Save = 'save',
|
|
2612
2657
|
/**
|
|
@@ -2618,106 +2663,112 @@ export enum EmbedEvent {
|
|
|
2618
2663
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
2619
2664
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2620
2665
|
* @example
|
|
2621
|
-
|
|
2666
|
+
* ```js
|
|
2622
2667
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
2623
2668
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2624
2669
|
* })
|
|
2625
|
-
|
|
2670
|
+
* ```
|
|
2626
2671
|
*/
|
|
2627
2672
|
Download = 'download',
|
|
2628
2673
|
/**
|
|
2629
2674
|
* Emitted when the download action is triggered on an Answer.
|
|
2630
|
-
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
2675
|
+
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
2676
|
+
* subscribe to when download is completed. Default is end:true.
|
|
2631
2677
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
2632
2678
|
* @example
|
|
2633
|
-
|
|
2679
|
+
* ```js
|
|
2634
2680
|
* //emit when action starts
|
|
2635
2681
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
2636
2682
|
* console.log('download PNG', payload)}, {start: true })
|
|
2637
2683
|
* //emit when action ends
|
|
2638
2684
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
2639
2685
|
* console.log('download PNG', payload)})
|
|
2640
|
-
|
|
2686
|
+
* ```
|
|
2641
2687
|
*/
|
|
2642
2688
|
DownloadAsPng = 'downloadAsPng',
|
|
2643
2689
|
/**
|
|
2644
2690
|
* Emitted when the Download as PDF action is triggered on an Answer
|
|
2645
|
-
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
2691
|
+
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
2692
|
+
* subscribe to when download as PDF is completed. Default is end:true.
|
|
2646
2693
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2647
2694
|
* @example
|
|
2648
|
-
|
|
2695
|
+
* ```js
|
|
2649
2696
|
* //emit when action starts
|
|
2650
2697
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
2651
2698
|
* console.log('download PDF', payload)}, {start: true })
|
|
2652
2699
|
* //emit when action ends
|
|
2653
2700
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
2654
2701
|
* console.log('download PDF', payload)})
|
|
2655
|
-
|
|
2702
|
+
* ```
|
|
2656
2703
|
*/
|
|
2657
2704
|
DownloadAsPdf = 'downloadAsPdf',
|
|
2658
2705
|
/**
|
|
2659
2706
|
* Emitted when the Download as CSV action is triggered on an Answer.
|
|
2660
|
-
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
2707
|
+
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
2708
|
+
* subscribe to when download as CSV is completed. Default is end:true.
|
|
2661
2709
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2662
2710
|
* @example
|
|
2663
|
-
|
|
2711
|
+
* ```js
|
|
2664
2712
|
* //emit when action starts
|
|
2665
2713
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
2666
2714
|
* console.log('download CSV', payload)}, {start: true })
|
|
2667
2715
|
* //emit when action ends
|
|
2668
2716
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
2669
2717
|
* console.log('download CSV', payload)})
|
|
2670
|
-
|
|
2718
|
+
* ```
|
|
2671
2719
|
*/
|
|
2672
2720
|
DownloadAsCsv = 'downloadAsCsv',
|
|
2673
2721
|
/**
|
|
2674
2722
|
* Emitted when the Download as XLSX action is triggered on an Answer.
|
|
2675
|
-
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
2723
|
+
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
2724
|
+
* subscribe to when download as XLSX is completed. Default is end:true.
|
|
2676
2725
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2677
2726
|
* @example
|
|
2678
|
-
|
|
2727
|
+
* ```js
|
|
2679
2728
|
* //emit when action starts
|
|
2680
2729
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
2681
2730
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
2682
2731
|
* //emit when action ends
|
|
2683
2732
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
2684
2733
|
* console.log('download Xlsx', payload)})
|
|
2685
|
-
|
|
2734
|
+
* ```
|
|
2686
2735
|
*/
|
|
2687
2736
|
DownloadAsXlsx = 'downloadAsXlsx',
|
|
2688
2737
|
/**
|
|
2689
2738
|
* Emitted when an Answer is deleted in the app
|
|
2690
|
-
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
2739
|
+
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
2740
|
+
* to when delete is completed. Default is end:true.
|
|
2691
2741
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2692
2742
|
* @example
|
|
2693
|
-
|
|
2743
|
+
* ```js
|
|
2694
2744
|
* //emit when action starts
|
|
2695
2745
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
2696
2746
|
* console.log('delete answer', payload)}, {start: true })
|
|
2697
2747
|
* //trigger when action is completed
|
|
2698
2748
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
2699
2749
|
* console.log('delete answer', payload)})
|
|
2700
|
-
|
|
2750
|
+
* ```
|
|
2701
2751
|
*/
|
|
2702
2752
|
AnswerDelete = 'answerDelete',
|
|
2703
2753
|
/**
|
|
2704
2754
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
2705
2755
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
2706
2756
|
* @example
|
|
2707
|
-
|
|
2757
|
+
* ```js
|
|
2708
2758
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
2709
2759
|
* console.log('AI Highlights', payload);
|
|
2710
2760
|
* })
|
|
2711
|
-
|
|
2761
|
+
* ```
|
|
2712
2762
|
*/
|
|
2713
2763
|
AIHighlights = 'AIHighlights',
|
|
2714
2764
|
/**
|
|
2715
2765
|
* Emitted when a user initiates the Pin action to
|
|
2716
2766
|
* add an Answer to a Liveboard.
|
|
2717
|
-
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
2767
|
+
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
2768
|
+
* when pin is completed. Default is end:true.
|
|
2718
2769
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2719
2770
|
* @example
|
|
2720
|
-
|
|
2771
|
+
* ```js
|
|
2721
2772
|
* //emit when action starts
|
|
2722
2773
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
2723
2774
|
* console.log('pin', payload)
|
|
@@ -2728,14 +2779,14 @@ export enum EmbedEvent {
|
|
|
2728
2779
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
2729
2780
|
* console.log('pin', payload)
|
|
2730
2781
|
* })
|
|
2731
|
-
|
|
2782
|
+
* ```
|
|
2732
2783
|
*/
|
|
2733
2784
|
Pin = 'pin',
|
|
2734
2785
|
/**
|
|
2735
2786
|
* Emitted when SpotIQ analysis is triggered
|
|
2736
2787
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2737
2788
|
* @example
|
|
2738
|
-
|
|
2789
|
+
* ```js
|
|
2739
2790
|
* //emit when action starts
|
|
2740
2791
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
2741
2792
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -2746,14 +2797,14 @@ export enum EmbedEvent {
|
|
|
2746
2797
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
2747
2798
|
* console.log('SpotIQ analyze', payload)
|
|
2748
2799
|
* })
|
|
2749
|
-
|
|
2800
|
+
* ```
|
|
2750
2801
|
*/
|
|
2751
2802
|
SpotIQAnalyze = 'spotIQAnalyze',
|
|
2752
2803
|
/**
|
|
2753
2804
|
* Emitted when a user shares an object with another user or group
|
|
2754
2805
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2755
2806
|
* @example
|
|
2756
|
-
|
|
2807
|
+
* ```js
|
|
2757
2808
|
* //emit when action starts
|
|
2758
2809
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
2759
2810
|
* console.log('Share', payload)
|
|
@@ -2764,7 +2815,7 @@ export enum EmbedEvent {
|
|
|
2764
2815
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
2765
2816
|
* console.log('Share', payload)
|
|
2766
2817
|
* })
|
|
2767
|
-
|
|
2818
|
+
* ```
|
|
2768
2819
|
*/
|
|
2769
2820
|
Share = 'share',
|
|
2770
2821
|
/**
|
|
@@ -2772,11 +2823,11 @@ export enum EmbedEvent {
|
|
|
2772
2823
|
* data on a chart or table.
|
|
2773
2824
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2774
2825
|
* @example
|
|
2775
|
-
|
|
2826
|
+
* ```js
|
|
2776
2827
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
2777
2828
|
* console.log('Drill include', payload);
|
|
2778
2829
|
* })
|
|
2779
|
-
|
|
2830
|
+
* ```
|
|
2780
2831
|
*/
|
|
2781
2832
|
DrillInclude = 'context-menu-item-include',
|
|
2782
2833
|
/**
|
|
@@ -2784,22 +2835,22 @@ export enum EmbedEvent {
|
|
|
2784
2835
|
* data on a chart or table
|
|
2785
2836
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2786
2837
|
* @example
|
|
2787
|
-
|
|
2838
|
+
* ```js
|
|
2788
2839
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
2789
2840
|
* console.log('Drill exclude', payload);
|
|
2790
2841
|
* })
|
|
2791
|
-
|
|
2842
|
+
* ```
|
|
2792
2843
|
*/
|
|
2793
2844
|
DrillExclude = 'context-menu-item-exclude',
|
|
2794
2845
|
/**
|
|
2795
2846
|
* Emitted when a column value is copied in the embedded app.
|
|
2796
2847
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2797
2848
|
* @example
|
|
2798
|
-
|
|
2799
|
-
*
|
|
2849
|
+
* ```js
|
|
2850
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
2800
2851
|
* console.log('copy to clipboard', payload);
|
|
2801
2852
|
* })
|
|
2802
|
-
|
|
2853
|
+
* ```
|
|
2803
2854
|
*/
|
|
2804
2855
|
CopyToClipboard = 'context-menu-item-copy-to-clipboard',
|
|
2805
2856
|
/**
|
|
@@ -2807,10 +2858,10 @@ export enum EmbedEvent {
|
|
|
2807
2858
|
* embedded Liveboard.
|
|
2808
2859
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2809
2860
|
* @example
|
|
2810
|
-
|
|
2861
|
+
* ```js
|
|
2811
2862
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
2812
2863
|
* })
|
|
2813
|
-
|
|
2864
|
+
* ```
|
|
2814
2865
|
*/
|
|
2815
2866
|
UpdateTML = 'updateTSL',
|
|
2816
2867
|
/**
|
|
@@ -2818,75 +2869,77 @@ export enum EmbedEvent {
|
|
|
2818
2869
|
* on an embedded Liveboard.
|
|
2819
2870
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2820
2871
|
* @example
|
|
2821
|
-
|
|
2872
|
+
* ```js
|
|
2822
2873
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
2823
2874
|
* console.log('Edit TML', payload);
|
|
2824
2875
|
* })
|
|
2825
|
-
|
|
2876
|
+
* ```
|
|
2826
2877
|
*/
|
|
2827
2878
|
EditTML = 'editTSL',
|
|
2828
2879
|
/**
|
|
2829
2880
|
* Emitted when the **Export TML** action is triggered on an
|
|
2830
2881
|
* an embedded object in the app
|
|
2831
|
-
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
2882
|
+
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
2883
|
+
* to when export is completed. Default is end:true.
|
|
2832
2884
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2833
2885
|
* @example
|
|
2834
|
-
|
|
2886
|
+
* ```js
|
|
2835
2887
|
* //emit when action starts
|
|
2836
2888
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
2837
2889
|
* console.log('Export TML', payload)}, { start: true })
|
|
2838
2890
|
* //emit when action ends
|
|
2839
2891
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
2840
2892
|
* console.log('Export TML', payload)})
|
|
2841
|
-
|
|
2893
|
+
* ```
|
|
2842
2894
|
*/
|
|
2843
2895
|
ExportTML = 'exportTSL',
|
|
2844
2896
|
/**
|
|
2845
2897
|
* Emitted when an Answer is saved as a View.
|
|
2846
2898
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2847
2899
|
* @example
|
|
2848
|
-
|
|
2900
|
+
* ```js
|
|
2849
2901
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
2850
2902
|
* console.log('View', payload);
|
|
2851
2903
|
* })
|
|
2852
|
-
|
|
2904
|
+
* ```
|
|
2853
2905
|
*/
|
|
2854
2906
|
SaveAsView = 'saveAsView',
|
|
2855
2907
|
/**
|
|
2856
2908
|
* Emitted when the user creates a copy of an Answer.
|
|
2857
|
-
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
2909
|
+
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
2910
|
+
* subscribe to when copy and edit is completed. Default is end:true.
|
|
2858
2911
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2859
2912
|
* @example
|
|
2860
|
-
|
|
2913
|
+
* ```js
|
|
2861
2914
|
* //emit when action starts
|
|
2862
2915
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
2863
2916
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
2864
2917
|
* //emit when action ends
|
|
2865
2918
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
2866
2919
|
* console.log('Copy and edit', payload)})
|
|
2867
|
-
|
|
2920
|
+
* ```
|
|
2868
2921
|
*/
|
|
2869
2922
|
CopyAEdit = 'copyAEdit',
|
|
2870
2923
|
/**
|
|
2871
2924
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
2872
2925
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2873
2926
|
* @example
|
|
2874
|
-
|
|
2927
|
+
* ```js
|
|
2875
2928
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
2876
2929
|
* console.log('show data', payload);
|
|
2877
2930
|
* })
|
|
2878
|
-
|
|
2931
|
+
* ```
|
|
2879
2932
|
*/
|
|
2880
2933
|
ShowUnderlyingData = 'showUnderlyingData',
|
|
2881
2934
|
/**
|
|
2882
2935
|
* Emitted when an Answer is switched to a chart or table view.
|
|
2883
2936
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2884
2937
|
* @example
|
|
2885
|
-
|
|
2938
|
+
* ```js
|
|
2886
2939
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
2887
2940
|
* console.log('switch view', payload);
|
|
2888
2941
|
* })
|
|
2889
|
-
|
|
2942
|
+
* ```
|
|
2890
2943
|
*/
|
|
2891
2944
|
AnswerChartSwitcher = 'answerChartSwitcher',
|
|
2892
2945
|
/**
|
|
@@ -2903,118 +2956,118 @@ export enum EmbedEvent {
|
|
|
2903
2956
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
2904
2957
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2905
2958
|
* @example
|
|
2906
|
-
|
|
2959
|
+
* ```js
|
|
2907
2960
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
2908
2961
|
* console.log('Liveboard details', payload);
|
|
2909
2962
|
* })
|
|
2910
|
-
|
|
2963
|
+
* ```
|
|
2911
2964
|
*/
|
|
2912
2965
|
LiveboardInfo = 'pinboardInfo',
|
|
2913
2966
|
/**
|
|
2914
2967
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
2915
2968
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2916
2969
|
* @example
|
|
2917
|
-
|
|
2970
|
+
* ```js
|
|
2918
2971
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
2919
2972
|
* console.log('favorites', payload);
|
|
2920
2973
|
* })
|
|
2921
|
-
|
|
2974
|
+
* ```
|
|
2922
2975
|
*/
|
|
2923
2976
|
AddToFavorites = 'addToFavorites',
|
|
2924
2977
|
/**
|
|
2925
2978
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
2926
2979
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2927
2980
|
* @example
|
|
2928
|
-
|
|
2981
|
+
* ```js
|
|
2929
2982
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
2930
|
-
* console.log(
|
|
2983
|
+
* console.log('Liveboard schedule', payload);
|
|
2931
2984
|
* })
|
|
2932
|
-
|
|
2985
|
+
* ```
|
|
2933
2986
|
*/
|
|
2934
2987
|
Schedule = 'subscription',
|
|
2935
2988
|
/**
|
|
2936
2989
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
2937
2990
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2938
2991
|
* @example
|
|
2939
|
-
|
|
2992
|
+
* ```js
|
|
2940
2993
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
2941
|
-
* console.log(
|
|
2994
|
+
* console.log('Liveboard edit', payload);
|
|
2942
2995
|
* })
|
|
2943
|
-
|
|
2996
|
+
* ```
|
|
2944
2997
|
*/
|
|
2945
2998
|
Edit = 'edit',
|
|
2946
2999
|
/**
|
|
2947
3000
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
2948
3001
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2949
3002
|
* @example
|
|
2950
|
-
|
|
3003
|
+
* ```js
|
|
2951
3004
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
2952
|
-
* console.log(
|
|
3005
|
+
* console.log('Copy', payload);
|
|
2953
3006
|
* })
|
|
2954
|
-
|
|
3007
|
+
* ```
|
|
2955
3008
|
*/
|
|
2956
3009
|
MakeACopy = 'makeACopy',
|
|
2957
3010
|
/**
|
|
2958
3011
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
2959
3012
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2960
3013
|
* @example
|
|
2961
|
-
|
|
3014
|
+
* ```js
|
|
2962
3015
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
2963
|
-
|
|
3016
|
+
* ```
|
|
2964
3017
|
* @example
|
|
2965
|
-
|
|
3018
|
+
* ```js
|
|
2966
3019
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
2967
3020
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2968
3021
|
* })
|
|
2969
|
-
|
|
3022
|
+
* ```
|
|
2970
3023
|
*/
|
|
2971
3024
|
Present = 'present',
|
|
2972
3025
|
/**
|
|
2973
3026
|
* Emitted when a user clicks **Delete** on a visualization
|
|
2974
3027
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2975
3028
|
* @example
|
|
2976
|
-
|
|
3029
|
+
* ```js
|
|
2977
3030
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
2978
3031
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2979
|
-
|
|
3032
|
+
* ```
|
|
2980
3033
|
*/
|
|
2981
3034
|
Delete = 'delete',
|
|
2982
3035
|
/**
|
|
2983
3036
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
2984
3037
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2985
3038
|
* @example
|
|
2986
|
-
|
|
3039
|
+
* ```js
|
|
2987
3040
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
2988
|
-
|
|
3041
|
+
* ```
|
|
2989
3042
|
*/
|
|
2990
3043
|
SchedulesList = 'schedule-list',
|
|
2991
3044
|
/**
|
|
2992
3045
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
2993
3046
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2994
3047
|
* @example
|
|
2995
|
-
|
|
3048
|
+
* ```js
|
|
2996
3049
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
2997
|
-
|
|
3050
|
+
* ```
|
|
2998
3051
|
*/
|
|
2999
3052
|
Cancel = 'cancel',
|
|
3000
3053
|
/**
|
|
3001
3054
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3002
3055
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3003
3056
|
* @example
|
|
3004
|
-
|
|
3057
|
+
* ```js
|
|
3005
3058
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3006
3059
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3007
|
-
|
|
3060
|
+
* ```
|
|
3008
3061
|
*/
|
|
3009
3062
|
Explore = 'explore',
|
|
3010
3063
|
/**
|
|
3011
3064
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
3012
3065
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3013
3066
|
* @example
|
|
3014
|
-
|
|
3067
|
+
* ```js
|
|
3015
3068
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3016
3069
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3017
|
-
|
|
3070
|
+
* ```
|
|
3018
3071
|
*/
|
|
3019
3072
|
CopyLink = 'embedDocument',
|
|
3020
3073
|
/**
|
|
@@ -3022,21 +3075,21 @@ export enum EmbedEvent {
|
|
|
3022
3075
|
* visualization or Liveboard.
|
|
3023
3076
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3024
3077
|
* @example
|
|
3025
|
-
|
|
3078
|
+
* ```js
|
|
3026
3079
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3027
3080
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3028
|
-
|
|
3081
|
+
* ```
|
|
3029
3082
|
*/
|
|
3030
3083
|
CrossFilterChanged = 'cross-filter-changed',
|
|
3031
3084
|
/**
|
|
3032
3085
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3033
3086
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3034
3087
|
* @example
|
|
3035
|
-
|
|
3088
|
+
* ```js
|
|
3036
3089
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
3037
3090
|
* console.log('VizPointClick', payload)
|
|
3038
3091
|
* })
|
|
3039
|
-
|
|
3092
|
+
* ```
|
|
3040
3093
|
*/
|
|
3041
3094
|
VizPointRightClick = 'vizPointRightClick',
|
|
3042
3095
|
/**
|
|
@@ -3050,35 +3103,35 @@ export enum EmbedEvent {
|
|
|
3050
3103
|
* filter details.
|
|
3051
3104
|
* @example
|
|
3052
3105
|
*
|
|
3053
|
-
|
|
3106
|
+
* ```js
|
|
3054
3107
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3055
3108
|
* console.log('payload', payload);
|
|
3056
3109
|
* })
|
|
3057
|
-
*
|
|
3110
|
+
* ```
|
|
3058
3111
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3059
3112
|
*/
|
|
3060
3113
|
FilterChanged = 'filterChanged',
|
|
3061
3114
|
/**
|
|
3062
3115
|
* Emitted when a user clicks the **Go** button to initiate
|
|
3063
3116
|
* a Natural Language Search query
|
|
3064
|
-
* @version SDK
|
|
3117
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3065
3118
|
*/
|
|
3066
3119
|
SageEmbedQuery = 'sageEmbedQuery',
|
|
3067
3120
|
/**
|
|
3068
3121
|
* Emitted when a user selects a data source on the embedded
|
|
3069
3122
|
* Natural Language Search interface.
|
|
3070
3123
|
*
|
|
3071
|
-
* @version SDK
|
|
3124
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3072
3125
|
*/
|
|
3073
3126
|
SageWorksheetUpdated = 'sageWorksheetUpdated',
|
|
3074
3127
|
/**
|
|
3075
3128
|
* Emitted when a user updates a connection on the **Data** page
|
|
3076
|
-
* @version SDK
|
|
3129
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3077
3130
|
*/
|
|
3078
3131
|
UpdateConnection = 'updateConnection',
|
|
3079
3132
|
/**
|
|
3080
3133
|
* Emitted when a user updates a connection on the **Data** page
|
|
3081
|
-
* @version SDK
|
|
3134
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3082
3135
|
*/
|
|
3083
3136
|
CreateConnection = 'createConnection',
|
|
3084
3137
|
/**
|
|
@@ -3088,7 +3141,7 @@ export enum EmbedEvent {
|
|
|
3088
3141
|
* @returns viewId: string
|
|
3089
3142
|
* @returns liveboardId: string
|
|
3090
3143
|
* @returns isPublic: boolean
|
|
3091
|
-
* @version SDK
|
|
3144
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3092
3145
|
*/
|
|
3093
3146
|
UpdatePersonalisedView = 'updatePersonalisedView',
|
|
3094
3147
|
/**
|
|
@@ -3097,7 +3150,7 @@ export enum EmbedEvent {
|
|
|
3097
3150
|
* @returns viewId: string
|
|
3098
3151
|
* @returns liveboardId: string
|
|
3099
3152
|
* @returns isPublic: boolean
|
|
3100
|
-
* @version SDK
|
|
3153
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3101
3154
|
*/
|
|
3102
3155
|
SavePersonalisedView = 'savePersonalisedView',
|
|
3103
3156
|
/**
|
|
@@ -3106,19 +3159,19 @@ export enum EmbedEvent {
|
|
|
3106
3159
|
* @returns viewId: string
|
|
3107
3160
|
* @returns liveboardId: string
|
|
3108
3161
|
* @returns isPublic: boolean
|
|
3109
|
-
* @version SDK
|
|
3162
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3110
3163
|
*/
|
|
3111
3164
|
ResetLiveboard = 'resetLiveboard',
|
|
3112
3165
|
/**
|
|
3113
3166
|
* Emitted when a PersonalisedView is deleted.
|
|
3114
3167
|
* @returns views: string[]
|
|
3115
3168
|
* @returns liveboardId: string
|
|
3116
|
-
* @version SDK
|
|
3169
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3117
3170
|
*/
|
|
3118
3171
|
DeletePersonalisedView = 'deletePersonalisedView',
|
|
3119
3172
|
/**
|
|
3120
3173
|
* Emitted when a user creates a Worksheet.
|
|
3121
|
-
* @version SDK
|
|
3174
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3122
3175
|
*/
|
|
3123
3176
|
CreateWorksheet = 'createWorksheet',
|
|
3124
3177
|
/**
|
|
@@ -3127,12 +3180,12 @@ export enum EmbedEvent {
|
|
|
3127
3180
|
* @returns viewId: string
|
|
3128
3181
|
* @returns liveboardId: string
|
|
3129
3182
|
* @returns isPublic: boolean
|
|
3130
|
-
* @version SDK
|
|
3183
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3131
3184
|
*/
|
|
3132
3185
|
AskSageInit = 'AskSageInit',
|
|
3133
3186
|
/**
|
|
3134
3187
|
* Emitted when a Liveboard or visualization is renamed.
|
|
3135
|
-
* @version SDK
|
|
3188
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
3136
3189
|
*/
|
|
3137
3190
|
Rename = 'rename',
|
|
3138
3191
|
/**
|
|
@@ -3155,7 +3208,7 @@ export enum EmbedEvent {
|
|
|
3155
3208
|
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
3156
3209
|
* is `false` by using the `error` parameters in `responder`.
|
|
3157
3210
|
* - `errorText` - The error message text shown to the user.
|
|
3158
|
-
* @version SDK
|
|
3211
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
3159
3212
|
* @example
|
|
3160
3213
|
*
|
|
3161
3214
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -3207,8 +3260,8 @@ export enum EmbedEvent {
|
|
|
3207
3260
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
3208
3261
|
* console.log('payload', payload);
|
|
3209
3262
|
* })
|
|
3210
|
-
|
|
3211
|
-
* @version SDK
|
|
3263
|
+
* ```
|
|
3264
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
3212
3265
|
*/
|
|
3213
3266
|
ParameterChanged = 'parameterChanged',
|
|
3214
3267
|
/**
|
|
@@ -3263,24 +3316,24 @@ export enum EmbedEvent {
|
|
|
3263
3316
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
3264
3317
|
* console.log('payload', payload);
|
|
3265
3318
|
* })
|
|
3266
|
-
|
|
3267
|
-
* @version SDK
|
|
3319
|
+
* ```
|
|
3320
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
3268
3321
|
*/
|
|
3269
3322
|
CreateLiveboard = 'createLiveboard',
|
|
3270
3323
|
/**
|
|
3271
3324
|
* Emitted when a user creates a Model.
|
|
3272
|
-
* @version SDK
|
|
3325
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
3273
3326
|
*/
|
|
3274
3327
|
CreateModel = 'createModel',
|
|
3275
3328
|
/**
|
|
3276
3329
|
* @hidden
|
|
3277
3330
|
* Emitted when a user exits present mode.
|
|
3278
|
-
* @version SDK
|
|
3331
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3279
3332
|
*/
|
|
3280
3333
|
ExitPresentMode = 'exitPresentMode',
|
|
3281
3334
|
/**
|
|
3282
3335
|
* Emitted when a user requests the full height lazy load data.
|
|
3283
|
-
* @version SDK
|
|
3336
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3284
3337
|
* @hidden
|
|
3285
3338
|
*/
|
|
3286
3339
|
RequestVisibleEmbedCoordinates = 'requestVisibleEmbedCoordinates',
|
|
@@ -3291,7 +3344,7 @@ export enum EmbedEvent {
|
|
|
3291
3344
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
3292
3345
|
* console.log('payload', payload);
|
|
3293
3346
|
* })
|
|
3294
|
-
|
|
3347
|
+
* ```
|
|
3295
3348
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3296
3349
|
*/
|
|
3297
3350
|
SpotterData = 'SpotterData',
|
|
@@ -3302,7 +3355,7 @@ export enum EmbedEvent {
|
|
|
3302
3355
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
3303
3356
|
* console.log('payload', payload);
|
|
3304
3357
|
* })
|
|
3305
|
-
|
|
3358
|
+
* ```
|
|
3306
3359
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3307
3360
|
*/
|
|
3308
3361
|
PreviewSpotterData = 'PreviewSpotterData',
|
|
@@ -3313,7 +3366,7 @@ export enum EmbedEvent {
|
|
|
3313
3366
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
3314
3367
|
* console.log('payload', payload);
|
|
3315
3368
|
* })
|
|
3316
|
-
|
|
3369
|
+
* ```
|
|
3317
3370
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3318
3371
|
*/
|
|
3319
3372
|
AddToCoaching = 'addToCoaching',
|
|
@@ -3335,7 +3388,7 @@ export enum EmbedEvent {
|
|
|
3335
3388
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
3336
3389
|
* console.log('payload', payload);
|
|
3337
3390
|
* })
|
|
3338
|
-
|
|
3391
|
+
* ```
|
|
3339
3392
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3340
3393
|
*/
|
|
3341
3394
|
SpotterQueryTriggered = 'SpotterQueryTriggered',
|
|
@@ -3346,7 +3399,7 @@ export enum EmbedEvent {
|
|
|
3346
3399
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
3347
3400
|
* console.log('payload', payload);
|
|
3348
3401
|
* })
|
|
3349
|
-
|
|
3402
|
+
* ```
|
|
3350
3403
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3351
3404
|
*/
|
|
3352
3405
|
LastPromptEdited = 'LastPromptEdited',
|
|
@@ -3357,18 +3410,18 @@ export enum EmbedEvent {
|
|
|
3357
3410
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
3358
3411
|
* console.log('payload', payload);
|
|
3359
3412
|
* })
|
|
3360
|
-
|
|
3413
|
+
* ```
|
|
3361
3414
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3362
3415
|
*/
|
|
3363
3416
|
LastPromptDeleted = 'LastPromptDeleted',
|
|
3364
3417
|
/**
|
|
3365
|
-
* Emitted when the
|
|
3418
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
3366
3419
|
* @example
|
|
3367
3420
|
* ```js
|
|
3368
3421
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
3369
3422
|
* console.log('payload', payload);
|
|
3370
3423
|
* })
|
|
3371
|
-
|
|
3424
|
+
* ```
|
|
3372
3425
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3373
3426
|
*/
|
|
3374
3427
|
ResetSpotterConversation = 'ResetSpotterConversation',
|
|
@@ -3379,7 +3432,7 @@ export enum EmbedEvent {
|
|
|
3379
3432
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
3380
3433
|
* console.log('payload', payload);
|
|
3381
3434
|
* })
|
|
3382
|
-
|
|
3435
|
+
* ```
|
|
3383
3436
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
3384
3437
|
*/
|
|
3385
3438
|
SpotterInit = 'spotterInit',
|
|
@@ -3390,7 +3443,7 @@ export enum EmbedEvent {
|
|
|
3390
3443
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
3391
3444
|
* console.log('payload', payload);
|
|
3392
3445
|
* })
|
|
3393
|
-
|
|
3446
|
+
* ```
|
|
3394
3447
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
3395
3448
|
*/
|
|
3396
3449
|
SpotterLoadComplete = 'spotterLoadComplete',
|
|
@@ -3620,7 +3673,8 @@ export enum HostEvent {
|
|
|
3620
3673
|
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
3621
3674
|
* on the most popular column.
|
|
3622
3675
|
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
3623
|
-
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
3676
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
3677
|
+
* **required**.
|
|
3624
3678
|
* @example
|
|
3625
3679
|
* ```js
|
|
3626
3680
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -3747,7 +3801,7 @@ export enum HostEvent {
|
|
|
3747
3801
|
* ```js
|
|
3748
3802
|
* appEmbed.navigateToPage(-1)
|
|
3749
3803
|
* ```
|
|
3750
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
3804
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
3751
3805
|
*/
|
|
3752
3806
|
Navigate = 'Navigate',
|
|
3753
3807
|
/**
|
|
@@ -3816,7 +3870,8 @@ export enum HostEvent {
|
|
|
3816
3870
|
* the following parameters:
|
|
3817
3871
|
*
|
|
3818
3872
|
* @param - Includes the following keys:
|
|
3819
|
-
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
3873
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
3874
|
+
* Liveboard.
|
|
3820
3875
|
* Optional when pinning a new chart or table generated from a Search query.
|
|
3821
3876
|
* **Required** in Spotter Embed.
|
|
3822
3877
|
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
@@ -3880,9 +3935,9 @@ export enum HostEvent {
|
|
|
3880
3935
|
* Trigger the **Show Liveboard details** action
|
|
3881
3936
|
* on an embedded Liveboard.
|
|
3882
3937
|
* @example
|
|
3883
|
-
|
|
3938
|
+
* ```js
|
|
3884
3939
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
3885
|
-
|
|
3940
|
+
* ```
|
|
3886
3941
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3887
3942
|
*/
|
|
3888
3943
|
LiveboardInfo = 'pinboardInfo',
|
|
@@ -4010,7 +4065,7 @@ export enum HostEvent {
|
|
|
4010
4065
|
* appEmbed.trigger(HostEvent.Remove)
|
|
4011
4066
|
* ```
|
|
4012
4067
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4013
|
-
*
|
|
4068
|
+
* @example
|
|
4014
4069
|
* ```js
|
|
4015
4070
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
4016
4071
|
* ```
|
|
@@ -4072,7 +4127,8 @@ export enum HostEvent {
|
|
|
4072
4127
|
* This event is not supported in visualization embed and search embed.
|
|
4073
4128
|
* @param - Object parameter. Includes the following keys:
|
|
4074
4129
|
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
4075
|
-
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4130
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4131
|
+
* is **required**.
|
|
4076
4132
|
*
|
|
4077
4133
|
* @example
|
|
4078
4134
|
* ```js
|
|
@@ -4101,7 +4157,7 @@ export enum HostEvent {
|
|
|
4101
4157
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4102
4158
|
* ```
|
|
4103
4159
|
* ```js
|
|
4104
|
-
* vizEmbed.trigger(
|
|
4160
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
4105
4161
|
* ```
|
|
4106
4162
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4107
4163
|
*/
|
|
@@ -4118,7 +4174,7 @@ export enum HostEvent {
|
|
|
4118
4174
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4119
4175
|
* ```
|
|
4120
4176
|
* ```js
|
|
4121
|
-
* vizEmbed.trigger(
|
|
4177
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
4122
4178
|
* ```
|
|
4123
4179
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4124
4180
|
*/
|
|
@@ -4133,23 +4189,22 @@ export enum HostEvent {
|
|
|
4133
4189
|
* );
|
|
4134
4190
|
* })
|
|
4135
4191
|
* ```
|
|
4136
|
-
*
|
|
4192
|
+
* @example
|
|
4137
4193
|
* ```js
|
|
4138
|
-
|
|
4139
|
-
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
|
-
|
|
4143
|
-
|
|
4144
|
-
|
|
4145
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
4194
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
4195
|
+
* let latestSpotterVizId = '';
|
|
4196
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
4197
|
+
* latestSpotterVizId = payload.data.id;
|
|
4198
|
+
* });
|
|
4199
|
+
*
|
|
4200
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
4146
4201
|
* vizId: latestSpotterVizId
|
|
4147
4202
|
* }).then((tml) => {
|
|
4148
4203
|
* console.log(
|
|
4149
4204
|
* tml.answer.search_query // TML representation of the search query
|
|
4150
4205
|
* );
|
|
4151
4206
|
* })
|
|
4152
|
-
|
|
4207
|
+
* ```
|
|
4153
4208
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4154
4209
|
* @important
|
|
4155
4210
|
*/
|
|
@@ -4213,6 +4268,11 @@ export enum HostEvent {
|
|
|
4213
4268
|
/**
|
|
4214
4269
|
* Trigger the **Download** action on charts in
|
|
4215
4270
|
* the embedded view.
|
|
4271
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
4272
|
+
*
|
|
4273
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
4274
|
+
*
|
|
4275
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
4216
4276
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
4217
4277
|
* @example
|
|
4218
4278
|
* ```js
|
|
@@ -4231,9 +4291,6 @@ export enum HostEvent {
|
|
|
4231
4291
|
*
|
|
4232
4292
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
4233
4293
|
* ```
|
|
4234
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
4235
|
-
* Use {@link DownloadAsPng}
|
|
4236
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
4237
4294
|
*/
|
|
4238
4295
|
Download = 'downloadAsPng',
|
|
4239
4296
|
/**
|
|
@@ -4440,8 +4497,9 @@ export enum HostEvent {
|
|
|
4440
4497
|
/**
|
|
4441
4498
|
* Update one or several filters applied on a Liveboard.
|
|
4442
4499
|
* @param - Includes the following keys:
|
|
4443
|
-
* - `filter`: A single filter object containing column name, filter operator, and
|
|
4444
|
-
* - `filters`: Multiple filter objects with column name, filter operator,
|
|
4500
|
+
* - `filter`: A single filter object containing column name, filter operator, and
|
|
4501
|
+
* values. - `filters`: Multiple filter objects with column name, filter operator,
|
|
4502
|
+
* and values for each.
|
|
4445
4503
|
*
|
|
4446
4504
|
* Each filter object must include the following attributes:
|
|
4447
4505
|
*
|
|
@@ -4671,8 +4729,8 @@ export enum HostEvent {
|
|
|
4671
4729
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
4672
4730
|
* console.log('parameters', parameter);
|
|
4673
4731
|
* });
|
|
4674
|
-
|
|
4675
|
-
|
|
4732
|
+
* ```
|
|
4733
|
+
* ```js
|
|
4676
4734
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
4677
4735
|
* let latestSpotterVizId = '';
|
|
4678
4736
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -4680,7 +4738,7 @@ export enum HostEvent {
|
|
|
4680
4738
|
* });
|
|
4681
4739
|
*
|
|
4682
4740
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
4683
|
-
|
|
4741
|
+
* ```
|
|
4684
4742
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
4685
4743
|
*/
|
|
4686
4744
|
GetParameters = 'GetParameters',
|
|
@@ -4697,7 +4755,7 @@ export enum HostEvent {
|
|
|
4697
4755
|
* Notify when info call is completed successfully
|
|
4698
4756
|
* ```js
|
|
4699
4757
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
4700
|
-
|
|
4758
|
+
* ```
|
|
4701
4759
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
4702
4760
|
*/
|
|
4703
4761
|
InfoSuccess = 'InfoSuccess',
|
|
@@ -4710,8 +4768,8 @@ export enum HostEvent {
|
|
|
4710
4768
|
* triggered with a modal to prompt users to
|
|
4711
4769
|
* add a name and description for the Answer.
|
|
4712
4770
|
* @param - Includes the following keys:
|
|
4713
|
-
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
4714
|
-
* - `name`: Optional. Name string for the Answer.
|
|
4771
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
4772
|
+
* embed. - `name`: Optional. Name string for the Answer.
|
|
4715
4773
|
* - `description`: Optional. Description text for the Answer.
|
|
4716
4774
|
* @example
|
|
4717
4775
|
* ```js
|
|
@@ -4800,7 +4858,7 @@ export enum HostEvent {
|
|
|
4800
4858
|
* ```js
|
|
4801
4859
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
4802
4860
|
*
|
|
4803
|
-
|
|
4861
|
+
* ```
|
|
4804
4862
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
4805
4863
|
*/
|
|
4806
4864
|
AddToCoaching = 'addToCoaching',
|
|
@@ -4842,7 +4900,7 @@ export enum HostEvent {
|
|
|
4842
4900
|
* });
|
|
4843
4901
|
*
|
|
4844
4902
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
4845
|
-
|
|
4903
|
+
* ```
|
|
4846
4904
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4847
4905
|
*/
|
|
4848
4906
|
AnswerChartSwitcher = 'answerChartSwitcher',
|
|
@@ -4852,7 +4910,7 @@ export enum HostEvent {
|
|
|
4852
4910
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
4853
4911
|
* ```js
|
|
4854
4912
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
4855
|
-
|
|
4913
|
+
* ```
|
|
4856
4914
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4857
4915
|
*/
|
|
4858
4916
|
ExitPresentMode = 'exitPresentMode',
|
|
@@ -4907,8 +4965,9 @@ export enum HostEvent {
|
|
|
4907
4965
|
/**
|
|
4908
4966
|
* Triggers a new conversation in Spotter embed.
|
|
4909
4967
|
*
|
|
4910
|
-
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
4911
|
-
* Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
4968
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
4969
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
4970
|
+
* instance.
|
|
4912
4971
|
*
|
|
4913
4972
|
* @example
|
|
4914
4973
|
* ```js
|
|
@@ -4957,6 +5016,7 @@ export enum DataSourceVisualMode {
|
|
|
4957
5016
|
*/
|
|
4958
5017
|
|
|
4959
5018
|
export enum Param {
|
|
5019
|
+
Tsmcp = 'tsmcp',
|
|
4960
5020
|
EmbedApp = 'embedApp',
|
|
4961
5021
|
DataSources = 'dataSources',
|
|
4962
5022
|
DataSourceMode = 'dataSourceMode',
|
|
@@ -5006,6 +5066,7 @@ export enum Param {
|
|
|
5006
5066
|
// 'both' clicks in `contextMenuTrigger` configuration.
|
|
5007
5067
|
ContextMenuTrigger = 'contextMenuEnabledOnWhichClick',
|
|
5008
5068
|
LinkOverride = 'linkOverride',
|
|
5069
|
+
EnableLinkOverridesV2 = 'enableLinkOverridesV2',
|
|
5009
5070
|
blockNonEmbedFullAppAccess = 'blockNonEmbedFullAppAccess',
|
|
5010
5071
|
ShowInsertToSlide = 'insertInToSlide',
|
|
5011
5072
|
PrimaryNavHidden = 'primaryNavHidden',
|
|
@@ -5100,6 +5161,7 @@ export enum Param {
|
|
|
5100
5161
|
IsThisPeriodInDateFiltersEnabled = 'isThisPeriodInDateFiltersEnabled',
|
|
5101
5162
|
HideToolResponseCardBranding = 'hideToolResponseCardBranding',
|
|
5102
5163
|
ToolResponseCardBrandingLabel = 'toolResponseCardBrandingLabel',
|
|
5164
|
+
EnableHomepageAnnouncement = 'enableHomepageAnnouncement',
|
|
5103
5165
|
}
|
|
5104
5166
|
|
|
5105
5167
|
/**
|
|
@@ -5260,14 +5322,14 @@ export enum Action {
|
|
|
5260
5322
|
* ```js
|
|
5261
5323
|
* disabledActions: [Action.CollapseDataPanel]
|
|
5262
5324
|
* ```
|
|
5263
|
-
* @version
|
|
5325
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5264
5326
|
*/
|
|
5265
5327
|
CollapseDataSources = 'collapseDataSources',
|
|
5266
5328
|
/**
|
|
5267
5329
|
* The **Collapse data panel** icon on the Search page.
|
|
5268
5330
|
* Collapses the data panel view.
|
|
5269
5331
|
*
|
|
5270
|
-
* @version
|
|
5332
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5271
5333
|
*
|
|
5272
5334
|
* @example
|
|
5273
5335
|
* ```js
|
|
@@ -5715,13 +5777,12 @@ export enum Action {
|
|
|
5715
5777
|
*/
|
|
5716
5778
|
CreateMonitor = 'createMonitor',
|
|
5717
5779
|
/**
|
|
5718
|
-
* @
|
|
5719
|
-
*
|
|
5780
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
5781
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
5720
5782
|
* @example
|
|
5721
5783
|
* ```js
|
|
5722
5784
|
* disabledActions: [Action.ReportError]
|
|
5723
5785
|
* ```
|
|
5724
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
5725
5786
|
*/
|
|
5726
5787
|
ReportError = 'reportError',
|
|
5727
5788
|
/**
|
|
@@ -5731,7 +5792,7 @@ export enum Action {
|
|
|
5731
5792
|
* ```js
|
|
5732
5793
|
* disabledActions: [Action.SyncToSheets]
|
|
5733
5794
|
* ```
|
|
5734
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5795
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5735
5796
|
*/
|
|
5736
5797
|
SyncToSheets = 'sync-to-sheets',
|
|
5737
5798
|
/**
|
|
@@ -5742,7 +5803,7 @@ export enum Action {
|
|
|
5742
5803
|
* ```js
|
|
5743
5804
|
* disabledActions: [Action.SyncToOtherApps]
|
|
5744
5805
|
* ```
|
|
5745
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5806
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5746
5807
|
*/
|
|
5747
5808
|
SyncToOtherApps = 'sync-to-other-apps',
|
|
5748
5809
|
/**
|
|
@@ -5752,7 +5813,7 @@ export enum Action {
|
|
|
5752
5813
|
* ```js
|
|
5753
5814
|
* disabledActions: [Action.ManagePipelines]
|
|
5754
5815
|
* ```
|
|
5755
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5816
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5756
5817
|
*/
|
|
5757
5818
|
ManagePipelines = 'manage-pipeline',
|
|
5758
5819
|
/**
|
|
@@ -6064,7 +6125,7 @@ export enum Action {
|
|
|
6064
6125
|
* ```js
|
|
6065
6126
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
6066
6127
|
* ```
|
|
6067
|
-
* @version SDK
|
|
6128
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6068
6129
|
*/
|
|
6069
6130
|
PersonalisedViewsDropdown = 'personalisedViewsDropdown',
|
|
6070
6131
|
/**
|
|
@@ -6074,7 +6135,7 @@ export enum Action {
|
|
|
6074
6135
|
* ```js
|
|
6075
6136
|
* disabledActions: [Action.LiveboardUsers]
|
|
6076
6137
|
* ```
|
|
6077
|
-
* @version SDK
|
|
6138
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6078
6139
|
*/
|
|
6079
6140
|
LiveboardUsers = 'liveboardUsers',
|
|
6080
6141
|
|
|
@@ -6093,7 +6154,7 @@ export enum Action {
|
|
|
6093
6154
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
6094
6155
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
6095
6156
|
* ```
|
|
6096
|
-
* @version SDK
|
|
6157
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
6097
6158
|
*/
|
|
6098
6159
|
TML = 'tml',
|
|
6099
6160
|
/**
|
|
@@ -6142,7 +6203,7 @@ export enum Action {
|
|
|
6142
6203
|
* ```js
|
|
6143
6204
|
* disabledActions: [Action.AddToWatchlist]
|
|
6144
6205
|
* ```
|
|
6145
|
-
* @version SDK
|
|
6206
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6146
6207
|
*/
|
|
6147
6208
|
AddToWatchlist = 'addToWatchlist',
|
|
6148
6209
|
|
|
@@ -6153,7 +6214,7 @@ export enum Action {
|
|
|
6153
6214
|
* ```js
|
|
6154
6215
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6155
6216
|
* ```
|
|
6156
|
-
* @version SDK
|
|
6217
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6157
6218
|
*/
|
|
6158
6219
|
RemoveFromWatchlist = 'removeFromWatchlist',
|
|
6159
6220
|
/**
|
|
@@ -6164,7 +6225,7 @@ export enum Action {
|
|
|
6164
6225
|
* ```js
|
|
6165
6226
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6166
6227
|
* ```
|
|
6167
|
-
* @version SDK
|
|
6228
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6168
6229
|
*/
|
|
6169
6230
|
OrganiseFavourites = 'organiseFavourites',
|
|
6170
6231
|
|
|
@@ -6231,7 +6292,7 @@ export enum Action {
|
|
|
6231
6292
|
* ```js
|
|
6232
6293
|
* disabledActions: [Action.ManageTags]
|
|
6233
6294
|
* ```
|
|
6234
|
-
* @version SDK
|
|
6295
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6235
6296
|
*/
|
|
6236
6297
|
ManageTags = 'manageTags',
|
|
6237
6298
|
|
|
@@ -6941,7 +7002,9 @@ export enum ErrorDetailsTypes {
|
|
|
6941
7002
|
}
|
|
6942
7003
|
|
|
6943
7004
|
/**
|
|
6944
|
-
* Error codes for identifying specific issues in embedded ThoughtSpot components. Use
|
|
7005
|
+
* Error codes for identifying specific issues in embedded ThoughtSpot components. Use
|
|
7006
|
+
* {@link EmbedErrorDetailsEvent} and {@link ErrorDetailsTypes} codes for precise error
|
|
7007
|
+
* handling and debugging.
|
|
6945
7008
|
*
|
|
6946
7009
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
6947
7010
|
* @group Error Handling
|
|
@@ -7013,15 +7076,16 @@ export enum EmbedErrorCodes {
|
|
|
7013
7076
|
/**
|
|
7014
7077
|
* Error event object emitted when an error occurs in an embedded component.
|
|
7015
7078
|
*
|
|
7016
|
-
* This interface defines the structure of error objects returned by the {@link
|
|
7017
|
-
* event. It provides detailed information about what went wrong,
|
|
7018
|
-
* a human-readable message, and a machine-readable error code.
|
|
7079
|
+
* This interface defines the structure of error objects returned by the {@link
|
|
7080
|
+
* EmbedEvent.Error} event. It provides detailed information about what went wrong,
|
|
7081
|
+
* including the error type, a human-readable message, and a machine-readable error code.
|
|
7019
7082
|
*
|
|
7020
7083
|
* ## Properties
|
|
7021
7084
|
*
|
|
7022
7085
|
* - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
|
|
7023
|
-
* - **message**: Human-readable error description (string or array of strings for
|
|
7024
|
-
* - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
7086
|
+
* - **message**: Human-readable error description (string or array of strings for
|
|
7087
|
+
* multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
7088
|
+
* values
|
|
7025
7089
|
* - **[key: string]**: Additional context-specific for backward compatibility
|
|
7026
7090
|
*
|
|
7027
7091
|
* ## Usage
|
|
@@ -7126,14 +7190,14 @@ export type ApiInterceptFlags = {
|
|
|
7126
7190
|
/**
|
|
7127
7191
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
7128
7192
|
*
|
|
7129
|
-
* Can be used for
|
|
7193
|
+
* Can be used for Search and App Embed from SDK 1.29.0
|
|
7130
7194
|
*
|
|
7131
|
-
* @version SDK
|
|
7195
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7132
7196
|
*/
|
|
7133
7197
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
7134
7198
|
/**
|
|
7135
7199
|
* This allows to intercept the urls passed, once intercepted the api will only
|
|
7136
|
-
* run based on the
|
|
7200
|
+
* run based on the response from the responder of ApiIntercept event.
|
|
7137
7201
|
*
|
|
7138
7202
|
* @example
|
|
7139
7203
|
* ```js
|
|
@@ -7144,7 +7208,7 @@ export type ApiInterceptFlags = {
|
|
|
7144
7208
|
* })
|
|
7145
7209
|
* ```
|
|
7146
7210
|
*
|
|
7147
|
-
* @version SDK
|
|
7211
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7148
7212
|
*/
|
|
7149
7213
|
interceptUrls?: (string | InterceptedApiType)[];
|
|
7150
7214
|
/**
|
|
@@ -7161,7 +7225,7 @@ export type ApiInterceptFlags = {
|
|
|
7161
7225
|
* })
|
|
7162
7226
|
* ```
|
|
7163
7227
|
*
|
|
7164
|
-
* @version SDK
|
|
7228
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7165
7229
|
*/
|
|
7166
7230
|
interceptTimeout?: number;
|
|
7167
7231
|
};
|