@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.2
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 -4
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/css-variables.d.ts +17 -17
- package/cjs/src/embed/app.d.ts +60 -32
- 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/base.d.ts +2 -2
- package/cjs/src/embed/base.js +2 -2
- 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/liveboard.d.ts +40 -34
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +1 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +1 -1
- 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 -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/ts-embed.d.ts +3 -3
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +12 -6
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +35 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/react/index.d.ts +15 -15
- package/cjs/src/react/index.js +12 -12
- package/cjs/src/tokenizedFetch.d.ts +1 -1
- package/cjs/src/tokenizedFetch.js +1 -1
- package/cjs/src/types.d.ts +294 -255
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +206 -200
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +6 -4
- 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.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-DkizS4xM.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 +60 -32
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +2 -2
- 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 +40 -34
- 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/react/index.d.ts +15 -15
- package/dist/src/tokenizedFetch.d.ts +1 -1
- package/dist/src/types.d.ts +294 -255
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
- 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 +307 -275
- package/dist/tsembed-react.js +306 -274
- package/dist/tsembed.es.js +299 -267
- package/dist/tsembed.js +298 -266
- package/dist/visual-embed-sdk-react-full.d.ts +520 -409
- package/dist/visual-embed-sdk-react.d.ts +518 -407
- package/dist/visual-embed-sdk.d.ts +519 -408
- 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 -4
- package/lib/src/auth.js.map +1 -1
- package/lib/src/css-variables.d.ts +17 -17
- package/lib/src/embed/app.d.ts +60 -32
- 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/base.d.ts +2 -2
- package/lib/src/embed/base.js +2 -2
- 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/liveboard.d.ts +40 -34
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +1 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +1 -1
- 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 -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/ts-embed.d.ts +3 -3
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +12 -6
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +35 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/react/index.d.ts +15 -15
- package/lib/src/react/index.js +12 -12
- package/lib/src/tokenizedFetch.d.ts +1 -1
- package/lib/src/tokenizedFetch.js +1 -1
- package/lib/src/types.d.ts +294 -255
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +206 -200
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +5 -3
- 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.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/package.json +1 -1
- package/src/auth.ts +29 -4
- package/src/css-variables.ts +17 -17
- package/src/embed/app.spec.ts +46 -1
- package/src/embed/app.ts +72 -35
- package/src/embed/base.ts +2 -2
- 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/liveboard.spec.ts +1 -1
- package/src/embed/liveboard.ts +40 -34
- package/src/embed/sage.ts +5 -5
- package/src/embed/search-bar.tsx +7 -7
- package/src/embed/search.ts +13 -12
- package/src/embed/ts-embed.spec.ts +42 -0
- package/src/embed/ts-embed.ts +11 -6
- package/src/react/index.tsx +15 -15
- package/src/tokenizedFetch.ts +1 -1
- package/src/types.ts +293 -254
- package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
- package/src/utils/graphql/answerService/answerService.ts +6 -3
- package/src/utils.ts +14 -0
package/dist/tsembed.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/* @thoughtspot/visual-embed-sdk version 1.46.
|
|
1
|
+
/* @thoughtspot/visual-embed-sdk version 1.46.2 */
|
|
2
2
|
'use client';
|
|
3
3
|
(function (global, factory) {
|
|
4
4
|
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
30
30
|
*/
|
|
31
31
|
/**
|
|
32
|
-
* The authentication mechanism for allowing access to
|
|
32
|
+
* The authentication mechanism for allowing access to
|
|
33
33
|
* the embedded app
|
|
34
34
|
* @group Authentication / Init
|
|
35
35
|
*/
|
|
@@ -55,6 +55,7 @@
|
|
|
55
55
|
* To use this:
|
|
56
56
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
57
57
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
58
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
58
59
|
* @example
|
|
59
60
|
* ```js
|
|
60
61
|
* init({
|
|
@@ -62,18 +63,17 @@
|
|
|
62
63
|
* authType: AuthType.EmbeddedSSO,
|
|
63
64
|
* });
|
|
64
65
|
* ```
|
|
65
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
66
66
|
*/
|
|
67
67
|
AuthType["EmbeddedSSO"] = "EmbeddedSSO";
|
|
68
68
|
/**
|
|
69
|
-
* SSO using SAML
|
|
70
|
-
* @deprecated
|
|
69
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
70
|
+
* @deprecated This option is deprecated.
|
|
71
71
|
* @hidden
|
|
72
72
|
*/
|
|
73
73
|
AuthType["SSO"] = "SSO_SAML";
|
|
74
74
|
/**
|
|
75
|
-
* SSO using SAML
|
|
76
|
-
* @deprecated
|
|
75
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
76
|
+
* @deprecated This option is deprecated.
|
|
77
77
|
* @hidden
|
|
78
78
|
*/
|
|
79
79
|
AuthType["SAML"] = "SSO_SAML";
|
|
@@ -124,8 +124,9 @@
|
|
|
124
124
|
AuthType["SAMLRedirect"] = "SSO_SAML";
|
|
125
125
|
/**
|
|
126
126
|
* SSO using OIDC
|
|
127
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
128
|
+
* @deprecated This option is deprecated.
|
|
127
129
|
* @hidden
|
|
128
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
129
130
|
*/
|
|
130
131
|
AuthType["OIDC"] = "SSO_OIDC";
|
|
131
132
|
/**
|
|
@@ -136,8 +137,9 @@
|
|
|
136
137
|
AuthType["OIDCRedirect"] = "SSO_OIDC";
|
|
137
138
|
/**
|
|
138
139
|
* Trusted authentication server
|
|
140
|
+
* Use {@link TrustedAuth} instead
|
|
141
|
+
* @deprecated This option is deprecated.
|
|
139
142
|
* @hidden
|
|
140
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
141
143
|
*/
|
|
142
144
|
AuthType["AuthServer"] = "AuthServer";
|
|
143
145
|
/**
|
|
@@ -164,6 +166,7 @@
|
|
|
164
166
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
165
167
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
166
168
|
* implemented by some browsers.
|
|
169
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
167
170
|
* @example
|
|
168
171
|
* ```js
|
|
169
172
|
* init({
|
|
@@ -174,8 +177,8 @@
|
|
|
174
177
|
* .then((response) => response.json())
|
|
175
178
|
* .then((data) => data.token);
|
|
176
179
|
* }
|
|
180
|
+
* });
|
|
177
181
|
* ```
|
|
178
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
179
182
|
*/
|
|
180
183
|
AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
|
|
181
184
|
/**
|
|
@@ -196,43 +199,43 @@
|
|
|
196
199
|
/**
|
|
197
200
|
* The *Search data* option in
|
|
198
201
|
* the *Insights* left navigation panel.
|
|
199
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
202
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
200
203
|
*/
|
|
201
204
|
HomeLeftNavItem["SearchData"] = "search-data";
|
|
202
205
|
/**
|
|
203
206
|
* The *Home* menu option in
|
|
204
207
|
* the *Insights* left navigation panel.
|
|
205
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
208
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
206
209
|
*/
|
|
207
210
|
HomeLeftNavItem["Home"] = "insights-home";
|
|
208
211
|
/**
|
|
209
212
|
* The *Liveboards* menu option in
|
|
210
213
|
* the *Insights* left navigation panel.
|
|
211
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
214
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
212
215
|
*/
|
|
213
216
|
HomeLeftNavItem["Liveboards"] = "liveboards";
|
|
214
217
|
/**
|
|
215
218
|
* The *Answers* menu option in
|
|
216
219
|
* the *Insights* left navigation panel.
|
|
217
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
220
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
218
221
|
*/
|
|
219
222
|
HomeLeftNavItem["Answers"] = "answers";
|
|
220
223
|
/**
|
|
221
224
|
* The *Monitor subscriptions* menu option in
|
|
222
225
|
* the *Insights* left navigation panel.
|
|
223
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
226
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
224
227
|
*/
|
|
225
228
|
HomeLeftNavItem["MonitorSubscription"] = "monitor-alerts";
|
|
226
229
|
/**
|
|
227
230
|
* The *SpotIQ analysis* menu option in
|
|
228
231
|
* the *Insights* left navigation panel.
|
|
229
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
232
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
230
233
|
*/
|
|
231
234
|
HomeLeftNavItem["SpotIQAnalysis"] = "spotiq-analysis";
|
|
232
235
|
/**
|
|
233
236
|
* The *Liveboard schedules* menu option in
|
|
234
237
|
* the *Insights* left navigation panel.
|
|
235
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
238
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
236
239
|
*/
|
|
237
240
|
HomeLeftNavItem["LiveboardSchedules"] = "liveboard-schedules";
|
|
238
241
|
/**
|
|
@@ -338,7 +341,7 @@
|
|
|
338
341
|
*/
|
|
339
342
|
HomepageModule["Search"] = "SEARCH";
|
|
340
343
|
/**
|
|
341
|
-
*
|
|
344
|
+
* KPI watchlist module
|
|
342
345
|
*/
|
|
343
346
|
HomepageModule["Watchlist"] = "WATCHLIST";
|
|
344
347
|
/**
|
|
@@ -370,7 +373,8 @@
|
|
|
370
373
|
*/
|
|
371
374
|
ListPageColumns["Favorites"] = "FAVOURITE";
|
|
372
375
|
/**
|
|
373
|
-
*
|
|
376
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
377
|
+
* @deprecated This option is deprecated.
|
|
374
378
|
*/
|
|
375
379
|
ListPageColumns["Favourite"] = "FAVOURITE";
|
|
376
380
|
/**
|
|
@@ -438,13 +442,13 @@
|
|
|
438
442
|
/**
|
|
439
443
|
* Rendering has initialized.
|
|
440
444
|
* @example
|
|
441
|
-
|
|
445
|
+
* ```js
|
|
442
446
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
443
447
|
* //show a loader
|
|
444
448
|
* function showLoader() {
|
|
445
449
|
* document.getElementById("loader");
|
|
446
450
|
* }
|
|
447
|
-
|
|
451
|
+
* ```
|
|
448
452
|
* @returns timestamp - The timestamp when the event was generated.
|
|
449
453
|
*/
|
|
450
454
|
EmbedEvent["Init"] = "init";
|
|
@@ -452,11 +456,11 @@
|
|
|
452
456
|
* Authentication has either succeeded or failed.
|
|
453
457
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
454
458
|
* @example
|
|
455
|
-
|
|
459
|
+
* ```js
|
|
456
460
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
457
461
|
* console.log('AuthInit', payload);
|
|
458
462
|
* })
|
|
459
|
-
|
|
463
|
+
* ```
|
|
460
464
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
461
465
|
*/
|
|
462
466
|
EmbedEvent["AuthInit"] = "authInit";
|
|
@@ -465,13 +469,13 @@
|
|
|
465
469
|
* @returns timestamp - The timestamp when the event was generated.
|
|
466
470
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
467
471
|
* @example
|
|
468
|
-
|
|
472
|
+
* ```js
|
|
469
473
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
470
474
|
* //hide loader
|
|
471
475
|
* function hideLoader() {
|
|
472
476
|
* document.getElementById("loader");
|
|
473
477
|
* }
|
|
474
|
-
|
|
478
|
+
* ```
|
|
475
479
|
*/
|
|
476
480
|
EmbedEvent["Load"] = "load";
|
|
477
481
|
/**
|
|
@@ -480,11 +484,11 @@
|
|
|
480
484
|
* @return data - Answer of Liveboard data
|
|
481
485
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
482
486
|
* @example
|
|
483
|
-
|
|
487
|
+
* ```js
|
|
484
488
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
485
489
|
* console.log('data', payload);
|
|
486
490
|
* })
|
|
487
|
-
|
|
491
|
+
* ```
|
|
488
492
|
* @important
|
|
489
493
|
*/
|
|
490
494
|
EmbedEvent["Data"] = "data";
|
|
@@ -492,9 +496,9 @@
|
|
|
492
496
|
* Search query has been updated by the user.
|
|
493
497
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
494
498
|
* @example
|
|
495
|
-
|
|
499
|
+
* ```js
|
|
496
500
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
497
|
-
|
|
501
|
+
* ```
|
|
498
502
|
*/
|
|
499
503
|
EmbedEvent["QueryChanged"] = "queryChanged";
|
|
500
504
|
/**
|
|
@@ -504,7 +508,7 @@
|
|
|
504
508
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
505
509
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
506
510
|
* @example
|
|
507
|
-
|
|
511
|
+
* ```js
|
|
508
512
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
509
513
|
* points: {
|
|
510
514
|
* clickedPoint,
|
|
@@ -512,12 +516,12 @@
|
|
|
512
516
|
* },
|
|
513
517
|
* autoDrillDown: true,
|
|
514
518
|
* })
|
|
515
|
-
|
|
519
|
+
* ```
|
|
516
520
|
* In this example, `VizPointDoubleClick` event is used for
|
|
517
521
|
* triggering the `DrillDown` event when an area or specific
|
|
518
522
|
* data point on a table or chart is double-clicked.
|
|
519
523
|
* @example
|
|
520
|
-
|
|
524
|
+
* ```js
|
|
521
525
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
522
526
|
* console.log(payload);
|
|
523
527
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -531,7 +535,7 @@
|
|
|
531
535
|
* autoDrillDown: true,
|
|
532
536
|
* })
|
|
533
537
|
* })
|
|
534
|
-
|
|
538
|
+
* ```
|
|
535
539
|
*/
|
|
536
540
|
EmbedEvent["Drilldown"] = "drillDown";
|
|
537
541
|
/**
|
|
@@ -656,13 +660,13 @@
|
|
|
656
660
|
* The ThoughtSpot authentication session has expired.
|
|
657
661
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
658
662
|
* @example
|
|
659
|
-
|
|
663
|
+
* ```js
|
|
660
664
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
661
665
|
* //show auth expired banner
|
|
662
666
|
* function showAuthExpired() {
|
|
663
667
|
* document.getElementById("authExpiredBanner");
|
|
664
668
|
* }
|
|
665
|
-
|
|
669
|
+
* ```
|
|
666
670
|
*/
|
|
667
671
|
EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
|
|
668
672
|
/**
|
|
@@ -697,22 +701,22 @@
|
|
|
697
701
|
* Applicable to `SearchBarEmbed` only.
|
|
698
702
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
699
703
|
* @example
|
|
700
|
-
|
|
704
|
+
* ```js
|
|
701
705
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
702
706
|
* .then(data => {
|
|
703
707
|
* console.log('Answer Data:', data);
|
|
704
708
|
* })
|
|
705
|
-
|
|
709
|
+
* ```
|
|
706
710
|
*/
|
|
707
711
|
EmbedEvent["GetDataClick"] = "getDataClick";
|
|
708
712
|
/**
|
|
709
713
|
* Detects the route change.
|
|
710
714
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
711
715
|
* @example
|
|
712
|
-
|
|
716
|
+
* ```js
|
|
713
717
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
714
718
|
* console.log('data', payload))
|
|
715
|
-
|
|
719
|
+
* ```
|
|
716
720
|
*/
|
|
717
721
|
EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
|
|
718
722
|
/**
|
|
@@ -722,12 +726,12 @@
|
|
|
722
726
|
EmbedEvent["V1Data"] = "exportVizDataToParent";
|
|
723
727
|
/**
|
|
724
728
|
* Emitted when the embed does not have cookie access. This happens
|
|
725
|
-
* when
|
|
726
|
-
*
|
|
729
|
+
* when third-party cookies are blocked by Safari or other
|
|
730
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
727
731
|
* @example
|
|
728
|
-
|
|
732
|
+
* ```js
|
|
729
733
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
730
|
-
|
|
734
|
+
* ```
|
|
731
735
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
732
736
|
*/
|
|
733
737
|
EmbedEvent["NoCookieAccess"] = "noCookieAccess";
|
|
@@ -741,22 +745,22 @@
|
|
|
741
745
|
* Emitted when any modal is opened in the app
|
|
742
746
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
743
747
|
* @example
|
|
744
|
-
|
|
748
|
+
* ```js
|
|
745
749
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
746
750
|
* console.log('dialog open', payload);
|
|
747
751
|
* })
|
|
748
|
-
|
|
752
|
+
* ```
|
|
749
753
|
*/
|
|
750
754
|
EmbedEvent["DialogOpen"] = "dialog-open";
|
|
751
755
|
/**
|
|
752
756
|
* Emitted when any modal is closed in the app
|
|
753
757
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
754
758
|
* @example
|
|
755
|
-
|
|
759
|
+
* ```js
|
|
756
760
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
757
761
|
* console.log('dialog close', payload);
|
|
758
762
|
* })
|
|
759
|
-
|
|
763
|
+
* ```
|
|
760
764
|
*/
|
|
761
765
|
EmbedEvent["DialogClose"] = "dialog-close";
|
|
762
766
|
/**
|
|
@@ -765,39 +769,39 @@
|
|
|
765
769
|
* other events on the rendered Liveboard.
|
|
766
770
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
767
771
|
* @example
|
|
768
|
-
|
|
772
|
+
* ```js
|
|
769
773
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
770
774
|
console.log('Liveboard is rendered', payload);
|
|
771
775
|
})
|
|
772
|
-
|
|
776
|
+
* ```
|
|
773
777
|
* The following example shows how to trigger
|
|
774
778
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
775
779
|
* @example
|
|
776
|
-
|
|
780
|
+
* ```js
|
|
777
781
|
* const embedRef = useEmbedRef();
|
|
778
782
|
* const onLiveboardRendered = () => {
|
|
779
783
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
780
784
|
* };
|
|
781
|
-
|
|
785
|
+
* ```
|
|
782
786
|
*/
|
|
783
787
|
EmbedEvent["LiveboardRendered"] = "PinboardRendered";
|
|
784
788
|
/**
|
|
785
789
|
* Emits all events.
|
|
786
|
-
* @
|
|
790
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
787
791
|
* @example
|
|
788
|
-
|
|
792
|
+
* ```js
|
|
789
793
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
790
794
|
* console.log('Embed Events', payload)
|
|
791
795
|
* })
|
|
792
|
-
|
|
796
|
+
* ```
|
|
793
797
|
*/
|
|
794
798
|
EmbedEvent["ALL"] = "*";
|
|
795
799
|
/**
|
|
796
800
|
* Emitted when an Answer is saved in the app.
|
|
797
801
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
798
|
-
* @
|
|
802
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
799
803
|
* @example
|
|
800
|
-
|
|
804
|
+
* ```js
|
|
801
805
|
* //Emit when action starts
|
|
802
806
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
803
807
|
* console.log('Save', payload)
|
|
@@ -808,7 +812,7 @@
|
|
|
808
812
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
809
813
|
* console.log('Save', payload)
|
|
810
814
|
* })
|
|
811
|
-
|
|
815
|
+
* ```
|
|
812
816
|
*/
|
|
813
817
|
EmbedEvent["Save"] = "save";
|
|
814
818
|
/**
|
|
@@ -820,11 +824,11 @@
|
|
|
820
824
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
821
825
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
822
826
|
* @example
|
|
823
|
-
|
|
827
|
+
* ```js
|
|
824
828
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
825
829
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
826
830
|
* })
|
|
827
|
-
|
|
831
|
+
* ```
|
|
828
832
|
*/
|
|
829
833
|
EmbedEvent["Download"] = "download";
|
|
830
834
|
/**
|
|
@@ -832,14 +836,14 @@
|
|
|
832
836
|
* Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
|
|
833
837
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
834
838
|
* @example
|
|
835
|
-
|
|
839
|
+
* ```js
|
|
836
840
|
* //emit when action starts
|
|
837
841
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
838
842
|
* console.log('download PNG', payload)}, {start: true })
|
|
839
843
|
* //emit when action ends
|
|
840
844
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
841
845
|
* console.log('download PNG', payload)})
|
|
842
|
-
|
|
846
|
+
* ```
|
|
843
847
|
*/
|
|
844
848
|
EmbedEvent["DownloadAsPng"] = "downloadAsPng";
|
|
845
849
|
/**
|
|
@@ -847,14 +851,14 @@
|
|
|
847
851
|
* Use start:true to subscribe to when download as PDF is initiated, or end:true to subscribe to when download as PDF is completed. Default is end:true.
|
|
848
852
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
849
853
|
* @example
|
|
850
|
-
|
|
854
|
+
* ```js
|
|
851
855
|
* //emit when action starts
|
|
852
856
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
853
857
|
* console.log('download PDF', payload)}, {start: true })
|
|
854
858
|
* //emit when action ends
|
|
855
859
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
856
860
|
* console.log('download PDF', payload)})
|
|
857
|
-
|
|
861
|
+
* ```
|
|
858
862
|
*/
|
|
859
863
|
EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
|
|
860
864
|
/**
|
|
@@ -862,14 +866,14 @@
|
|
|
862
866
|
* Use start:true to subscribe to when download as CSV is initiated, or end:true to subscribe to when download as CSV is completed. Default is end:true.
|
|
863
867
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
864
868
|
* @example
|
|
865
|
-
|
|
869
|
+
* ```js
|
|
866
870
|
* //emit when action starts
|
|
867
871
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
868
872
|
* console.log('download CSV', payload)}, {start: true })
|
|
869
873
|
* //emit when action ends
|
|
870
874
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
871
875
|
* console.log('download CSV', payload)})
|
|
872
|
-
|
|
876
|
+
* ```
|
|
873
877
|
*/
|
|
874
878
|
EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
|
|
875
879
|
/**
|
|
@@ -877,14 +881,14 @@
|
|
|
877
881
|
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to subscribe to when download as XLSX is completed. Default is end:true.
|
|
878
882
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
879
883
|
* @example
|
|
880
|
-
|
|
884
|
+
* ```js
|
|
881
885
|
* //emit when action starts
|
|
882
886
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
883
887
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
884
888
|
* //emit when action ends
|
|
885
889
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
886
890
|
* console.log('download Xlsx', payload)})
|
|
887
|
-
|
|
891
|
+
* ```
|
|
888
892
|
*/
|
|
889
893
|
EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
|
|
890
894
|
/**
|
|
@@ -892,25 +896,25 @@
|
|
|
892
896
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
|
|
893
897
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
894
898
|
* @example
|
|
895
|
-
|
|
899
|
+
* ```js
|
|
896
900
|
* //emit when action starts
|
|
897
901
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
898
902
|
* console.log('delete answer', payload)}, {start: true })
|
|
899
903
|
* //trigger when action is completed
|
|
900
904
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
901
905
|
* console.log('delete answer', payload)})
|
|
902
|
-
|
|
906
|
+
* ```
|
|
903
907
|
*/
|
|
904
908
|
EmbedEvent["AnswerDelete"] = "answerDelete";
|
|
905
909
|
/**
|
|
906
910
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
907
911
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
908
912
|
* @example
|
|
909
|
-
|
|
913
|
+
* ```js
|
|
910
914
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
911
915
|
* console.log('AI Highlights', payload);
|
|
912
916
|
* })
|
|
913
|
-
|
|
917
|
+
* ```
|
|
914
918
|
*/
|
|
915
919
|
EmbedEvent["AIHighlights"] = "AIHighlights";
|
|
916
920
|
/**
|
|
@@ -919,7 +923,7 @@
|
|
|
919
923
|
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
|
|
920
924
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
921
925
|
* @example
|
|
922
|
-
|
|
926
|
+
* ```js
|
|
923
927
|
* //emit when action starts
|
|
924
928
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
925
929
|
* console.log('pin', payload)
|
|
@@ -930,14 +934,14 @@
|
|
|
930
934
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
931
935
|
* console.log('pin', payload)
|
|
932
936
|
* })
|
|
933
|
-
|
|
937
|
+
* ```
|
|
934
938
|
*/
|
|
935
939
|
EmbedEvent["Pin"] = "pin";
|
|
936
940
|
/**
|
|
937
941
|
* Emitted when SpotIQ analysis is triggered
|
|
938
942
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
939
943
|
* @example
|
|
940
|
-
|
|
944
|
+
* ```js
|
|
941
945
|
* //emit when action starts
|
|
942
946
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
943
947
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -948,14 +952,14 @@
|
|
|
948
952
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
949
953
|
* console.log('SpotIQ analyze', payload)
|
|
950
954
|
* })
|
|
951
|
-
|
|
955
|
+
* ```
|
|
952
956
|
*/
|
|
953
957
|
EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
|
|
954
958
|
/**
|
|
955
959
|
* Emitted when a user shares an object with another user or group
|
|
956
960
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
957
961
|
* @example
|
|
958
|
-
|
|
962
|
+
* ```js
|
|
959
963
|
* //emit when action starts
|
|
960
964
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
961
965
|
* console.log('Share', payload)
|
|
@@ -966,7 +970,7 @@
|
|
|
966
970
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
967
971
|
* console.log('Share', payload)
|
|
968
972
|
* })
|
|
969
|
-
|
|
973
|
+
* ```
|
|
970
974
|
*/
|
|
971
975
|
EmbedEvent["Share"] = "share";
|
|
972
976
|
/**
|
|
@@ -974,11 +978,11 @@
|
|
|
974
978
|
* data on a chart or table.
|
|
975
979
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
976
980
|
* @example
|
|
977
|
-
|
|
981
|
+
* ```js
|
|
978
982
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
979
983
|
* console.log('Drill include', payload);
|
|
980
984
|
* })
|
|
981
|
-
|
|
985
|
+
* ```
|
|
982
986
|
*/
|
|
983
987
|
EmbedEvent["DrillInclude"] = "context-menu-item-include";
|
|
984
988
|
/**
|
|
@@ -986,22 +990,22 @@
|
|
|
986
990
|
* data on a chart or table
|
|
987
991
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
988
992
|
* @example
|
|
989
|
-
|
|
993
|
+
* ```js
|
|
990
994
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
991
995
|
* console.log('Drill exclude', payload);
|
|
992
996
|
* })
|
|
993
|
-
|
|
997
|
+
* ```
|
|
994
998
|
*/
|
|
995
999
|
EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
|
|
996
1000
|
/**
|
|
997
1001
|
* Emitted when a column value is copied in the embedded app.
|
|
998
1002
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
999
1003
|
* @example
|
|
1000
|
-
|
|
1001
|
-
*
|
|
1004
|
+
* ```js
|
|
1005
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
1002
1006
|
* console.log('copy to clipboard', payload);
|
|
1003
1007
|
* })
|
|
1004
|
-
|
|
1008
|
+
* ```
|
|
1005
1009
|
*/
|
|
1006
1010
|
EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
|
|
1007
1011
|
/**
|
|
@@ -1009,10 +1013,10 @@
|
|
|
1009
1013
|
* embedded Liveboard.
|
|
1010
1014
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1011
1015
|
* @example
|
|
1012
|
-
|
|
1016
|
+
* ```js
|
|
1013
1017
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
1014
1018
|
* })
|
|
1015
|
-
|
|
1019
|
+
* ```
|
|
1016
1020
|
*/
|
|
1017
1021
|
EmbedEvent["UpdateTML"] = "updateTSL";
|
|
1018
1022
|
/**
|
|
@@ -1020,11 +1024,11 @@
|
|
|
1020
1024
|
* on an embedded Liveboard.
|
|
1021
1025
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1022
1026
|
* @example
|
|
1023
|
-
|
|
1027
|
+
* ```js
|
|
1024
1028
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
1025
1029
|
* console.log('Edit TML', payload);
|
|
1026
1030
|
* })
|
|
1027
|
-
|
|
1031
|
+
* ```
|
|
1028
1032
|
*/
|
|
1029
1033
|
EmbedEvent["EditTML"] = "editTSL";
|
|
1030
1034
|
/**
|
|
@@ -1033,25 +1037,25 @@
|
|
|
1033
1037
|
* Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
|
|
1034
1038
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1035
1039
|
* @example
|
|
1036
|
-
|
|
1040
|
+
* ```js
|
|
1037
1041
|
* //emit when action starts
|
|
1038
1042
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1039
1043
|
* console.log('Export TML', payload)}, { start: true })
|
|
1040
1044
|
* //emit when action ends
|
|
1041
1045
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1042
1046
|
* console.log('Export TML', payload)})
|
|
1043
|
-
|
|
1047
|
+
* ```
|
|
1044
1048
|
*/
|
|
1045
1049
|
EmbedEvent["ExportTML"] = "exportTSL";
|
|
1046
1050
|
/**
|
|
1047
1051
|
* Emitted when an Answer is saved as a View.
|
|
1048
1052
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1049
1053
|
* @example
|
|
1050
|
-
|
|
1054
|
+
* ```js
|
|
1051
1055
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
1052
1056
|
* console.log('View', payload);
|
|
1053
1057
|
* })
|
|
1054
|
-
|
|
1058
|
+
* ```
|
|
1055
1059
|
*/
|
|
1056
1060
|
EmbedEvent["SaveAsView"] = "saveAsView";
|
|
1057
1061
|
/**
|
|
@@ -1059,36 +1063,36 @@
|
|
|
1059
1063
|
* Use start:true to subscribe to when copy and edit is initiated, or end:true to subscribe to when copy and edit is completed. Default is end:true.
|
|
1060
1064
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1061
1065
|
* @example
|
|
1062
|
-
|
|
1066
|
+
* ```js
|
|
1063
1067
|
* //emit when action starts
|
|
1064
1068
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1065
1069
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
1066
1070
|
* //emit when action ends
|
|
1067
1071
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1068
1072
|
* console.log('Copy and edit', payload)})
|
|
1069
|
-
|
|
1073
|
+
* ```
|
|
1070
1074
|
*/
|
|
1071
1075
|
EmbedEvent["CopyAEdit"] = "copyAEdit";
|
|
1072
1076
|
/**
|
|
1073
1077
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
1074
1078
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1075
1079
|
* @example
|
|
1076
|
-
|
|
1080
|
+
* ```js
|
|
1077
1081
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
1078
1082
|
* console.log('show data', payload);
|
|
1079
1083
|
* })
|
|
1080
|
-
|
|
1084
|
+
* ```
|
|
1081
1085
|
*/
|
|
1082
1086
|
EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
|
|
1083
1087
|
/**
|
|
1084
1088
|
* Emitted when an Answer is switched to a chart or table view.
|
|
1085
1089
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1086
1090
|
* @example
|
|
1087
|
-
|
|
1091
|
+
* ```js
|
|
1088
1092
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
1089
1093
|
* console.log('switch view', payload);
|
|
1090
1094
|
* })
|
|
1091
|
-
|
|
1095
|
+
* ```
|
|
1092
1096
|
*/
|
|
1093
1097
|
EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
1094
1098
|
/**
|
|
@@ -1105,118 +1109,118 @@
|
|
|
1105
1109
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
1106
1110
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1107
1111
|
* @example
|
|
1108
|
-
|
|
1112
|
+
* ```js
|
|
1109
1113
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
1110
1114
|
* console.log('Liveboard details', payload);
|
|
1111
1115
|
* })
|
|
1112
|
-
|
|
1116
|
+
* ```
|
|
1113
1117
|
*/
|
|
1114
1118
|
EmbedEvent["LiveboardInfo"] = "pinboardInfo";
|
|
1115
1119
|
/**
|
|
1116
1120
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1117
1121
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1118
1122
|
* @example
|
|
1119
|
-
|
|
1123
|
+
* ```js
|
|
1120
1124
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
1121
1125
|
* console.log('favorites', payload);
|
|
1122
1126
|
* })
|
|
1123
|
-
|
|
1127
|
+
* ```
|
|
1124
1128
|
*/
|
|
1125
1129
|
EmbedEvent["AddToFavorites"] = "addToFavorites";
|
|
1126
1130
|
/**
|
|
1127
1131
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
1128
1132
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1129
1133
|
* @example
|
|
1130
|
-
|
|
1134
|
+
* ```js
|
|
1131
1135
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
1132
|
-
* console.log(
|
|
1136
|
+
* console.log('Liveboard schedule', payload);
|
|
1133
1137
|
* })
|
|
1134
|
-
|
|
1138
|
+
* ```
|
|
1135
1139
|
*/
|
|
1136
1140
|
EmbedEvent["Schedule"] = "subscription";
|
|
1137
1141
|
/**
|
|
1138
1142
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
1139
1143
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1140
1144
|
* @example
|
|
1141
|
-
|
|
1145
|
+
* ```js
|
|
1142
1146
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
1143
|
-
* console.log(
|
|
1147
|
+
* console.log('Liveboard edit', payload);
|
|
1144
1148
|
* })
|
|
1145
|
-
|
|
1149
|
+
* ```
|
|
1146
1150
|
*/
|
|
1147
1151
|
EmbedEvent["Edit"] = "edit";
|
|
1148
1152
|
/**
|
|
1149
1153
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
1150
1154
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1151
1155
|
* @example
|
|
1152
|
-
|
|
1156
|
+
* ```js
|
|
1153
1157
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
1154
|
-
* console.log(
|
|
1158
|
+
* console.log('Copy', payload);
|
|
1155
1159
|
* })
|
|
1156
|
-
|
|
1160
|
+
* ```
|
|
1157
1161
|
*/
|
|
1158
1162
|
EmbedEvent["MakeACopy"] = "makeACopy";
|
|
1159
1163
|
/**
|
|
1160
1164
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
1161
1165
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1162
1166
|
* @example
|
|
1163
|
-
|
|
1167
|
+
* ```js
|
|
1164
1168
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
1165
|
-
|
|
1169
|
+
* ```
|
|
1166
1170
|
* @example
|
|
1167
|
-
|
|
1171
|
+
* ```js
|
|
1168
1172
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
1169
1173
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1170
1174
|
* })
|
|
1171
|
-
|
|
1175
|
+
* ```
|
|
1172
1176
|
*/
|
|
1173
1177
|
EmbedEvent["Present"] = "present";
|
|
1174
1178
|
/**
|
|
1175
1179
|
* Emitted when a user clicks **Delete** on a visualization
|
|
1176
1180
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1177
1181
|
* @example
|
|
1178
|
-
|
|
1182
|
+
* ```js
|
|
1179
1183
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
1180
1184
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1181
|
-
|
|
1185
|
+
* ```
|
|
1182
1186
|
*/
|
|
1183
1187
|
EmbedEvent["Delete"] = "delete";
|
|
1184
1188
|
/**
|
|
1185
1189
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1186
1190
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1187
1191
|
* @example
|
|
1188
|
-
|
|
1192
|
+
* ```js
|
|
1189
1193
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
1190
|
-
|
|
1194
|
+
* ```
|
|
1191
1195
|
*/
|
|
1192
1196
|
EmbedEvent["SchedulesList"] = "schedule-list";
|
|
1193
1197
|
/**
|
|
1194
1198
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
1195
1199
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1196
1200
|
* @example
|
|
1197
|
-
|
|
1201
|
+
* ```js
|
|
1198
1202
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
1199
|
-
|
|
1203
|
+
* ```
|
|
1200
1204
|
*/
|
|
1201
1205
|
EmbedEvent["Cancel"] = "cancel";
|
|
1202
1206
|
/**
|
|
1203
1207
|
* Emitted when a user clicks **Explore** on a visualization
|
|
1204
1208
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1205
1209
|
* @example
|
|
1206
|
-
|
|
1210
|
+
* ```js
|
|
1207
1211
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
1208
1212
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1209
|
-
|
|
1213
|
+
* ```
|
|
1210
1214
|
*/
|
|
1211
1215
|
EmbedEvent["Explore"] = "explore";
|
|
1212
1216
|
/**
|
|
1213
1217
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
1214
1218
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1215
1219
|
* @example
|
|
1216
|
-
|
|
1220
|
+
* ```js
|
|
1217
1221
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
1218
1222
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1219
|
-
|
|
1223
|
+
* ```
|
|
1220
1224
|
*/
|
|
1221
1225
|
EmbedEvent["CopyLink"] = "embedDocument";
|
|
1222
1226
|
/**
|
|
@@ -1224,21 +1228,21 @@
|
|
|
1224
1228
|
* visualization or Liveboard.
|
|
1225
1229
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1226
1230
|
* @example
|
|
1227
|
-
|
|
1231
|
+
* ```js
|
|
1228
1232
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
1229
1233
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1230
|
-
|
|
1234
|
+
* ```
|
|
1231
1235
|
*/
|
|
1232
1236
|
EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
|
|
1233
1237
|
/**
|
|
1234
1238
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
1235
1239
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1236
1240
|
* @example
|
|
1237
|
-
|
|
1241
|
+
* ```js
|
|
1238
1242
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
1239
1243
|
* console.log('VizPointClick', payload)
|
|
1240
1244
|
* })
|
|
1241
|
-
|
|
1245
|
+
* ```
|
|
1242
1246
|
*/
|
|
1243
1247
|
EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
|
|
1244
1248
|
/**
|
|
@@ -1252,35 +1256,35 @@
|
|
|
1252
1256
|
* filter details.
|
|
1253
1257
|
* @example
|
|
1254
1258
|
*
|
|
1255
|
-
|
|
1259
|
+
* ```js
|
|
1256
1260
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1257
1261
|
* console.log('payload', payload);
|
|
1258
1262
|
* })
|
|
1259
|
-
*
|
|
1263
|
+
* ```
|
|
1260
1264
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
1261
1265
|
*/
|
|
1262
1266
|
EmbedEvent["FilterChanged"] = "filterChanged";
|
|
1263
1267
|
/**
|
|
1264
1268
|
* Emitted when a user clicks the **Go** button to initiate
|
|
1265
1269
|
* a Natural Language Search query
|
|
1266
|
-
* @version SDK
|
|
1270
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1267
1271
|
*/
|
|
1268
1272
|
EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
|
|
1269
1273
|
/**
|
|
1270
1274
|
* Emitted when a user selects a data source on the embedded
|
|
1271
1275
|
* Natural Language Search interface.
|
|
1272
1276
|
*
|
|
1273
|
-
* @version SDK
|
|
1277
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1274
1278
|
*/
|
|
1275
1279
|
EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
|
|
1276
1280
|
/**
|
|
1277
1281
|
* Emitted when a user updates a connection on the **Data** page
|
|
1278
|
-
* @version SDK
|
|
1282
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1279
1283
|
*/
|
|
1280
1284
|
EmbedEvent["UpdateConnection"] = "updateConnection";
|
|
1281
1285
|
/**
|
|
1282
1286
|
* Emitted when a user updates a connection on the **Data** page
|
|
1283
|
-
* @version SDK
|
|
1287
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1284
1288
|
*/
|
|
1285
1289
|
EmbedEvent["CreateConnection"] = "createConnection";
|
|
1286
1290
|
/**
|
|
@@ -1290,7 +1294,7 @@
|
|
|
1290
1294
|
* @returns viewId: string
|
|
1291
1295
|
* @returns liveboardId: string
|
|
1292
1296
|
* @returns isPublic: boolean
|
|
1293
|
-
* @version SDK
|
|
1297
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1294
1298
|
*/
|
|
1295
1299
|
EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
|
|
1296
1300
|
/**
|
|
@@ -1299,7 +1303,7 @@
|
|
|
1299
1303
|
* @returns viewId: string
|
|
1300
1304
|
* @returns liveboardId: string
|
|
1301
1305
|
* @returns isPublic: boolean
|
|
1302
|
-
* @version SDK
|
|
1306
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1303
1307
|
*/
|
|
1304
1308
|
EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
|
|
1305
1309
|
/**
|
|
@@ -1308,19 +1312,19 @@
|
|
|
1308
1312
|
* @returns viewId: string
|
|
1309
1313
|
* @returns liveboardId: string
|
|
1310
1314
|
* @returns isPublic: boolean
|
|
1311
|
-
* @version SDK
|
|
1315
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1312
1316
|
*/
|
|
1313
1317
|
EmbedEvent["ResetLiveboard"] = "resetLiveboard";
|
|
1314
1318
|
/**
|
|
1315
1319
|
* Emitted when a PersonalisedView is deleted.
|
|
1316
1320
|
* @returns views: string[]
|
|
1317
1321
|
* @returns liveboardId: string
|
|
1318
|
-
* @version SDK
|
|
1322
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1319
1323
|
*/
|
|
1320
1324
|
EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
|
|
1321
1325
|
/**
|
|
1322
1326
|
* Emitted when a user creates a Worksheet.
|
|
1323
|
-
* @version SDK
|
|
1327
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1324
1328
|
*/
|
|
1325
1329
|
EmbedEvent["CreateWorksheet"] = "createWorksheet";
|
|
1326
1330
|
/**
|
|
@@ -1329,12 +1333,12 @@
|
|
|
1329
1333
|
* @returns viewId: string
|
|
1330
1334
|
* @returns liveboardId: string
|
|
1331
1335
|
* @returns isPublic: boolean
|
|
1332
|
-
* @version SDK
|
|
1336
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
1333
1337
|
*/
|
|
1334
1338
|
EmbedEvent["AskSageInit"] = "AskSageInit";
|
|
1335
1339
|
/**
|
|
1336
1340
|
* Emitted when a Liveboard or visualization is renamed.
|
|
1337
|
-
* @version SDK
|
|
1341
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
1338
1342
|
*/
|
|
1339
1343
|
EmbedEvent["Rename"] = "rename";
|
|
1340
1344
|
/**
|
|
@@ -1357,7 +1361,7 @@
|
|
|
1357
1361
|
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
1358
1362
|
* is `false` by using the `error` parameters in `responder`.
|
|
1359
1363
|
* - `errorText` - The error message text shown to the user.
|
|
1360
|
-
* @version SDK
|
|
1364
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1361
1365
|
* @example
|
|
1362
1366
|
*
|
|
1363
1367
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -1409,8 +1413,8 @@
|
|
|
1409
1413
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
1410
1414
|
* console.log('payload', payload);
|
|
1411
1415
|
* })
|
|
1412
|
-
|
|
1413
|
-
* @version SDK
|
|
1416
|
+
* ```
|
|
1417
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1414
1418
|
*/
|
|
1415
1419
|
EmbedEvent["ParameterChanged"] = "parameterChanged";
|
|
1416
1420
|
/**
|
|
@@ -1465,24 +1469,24 @@
|
|
|
1465
1469
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
1466
1470
|
* console.log('payload', payload);
|
|
1467
1471
|
* })
|
|
1468
|
-
|
|
1469
|
-
* @version SDK
|
|
1472
|
+
* ```
|
|
1473
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1470
1474
|
*/
|
|
1471
1475
|
EmbedEvent["CreateLiveboard"] = "createLiveboard";
|
|
1472
1476
|
/**
|
|
1473
1477
|
* Emitted when a user creates a Model.
|
|
1474
|
-
* @version SDK
|
|
1478
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1475
1479
|
*/
|
|
1476
1480
|
EmbedEvent["CreateModel"] = "createModel";
|
|
1477
1481
|
/**
|
|
1478
1482
|
* @hidden
|
|
1479
1483
|
* Emitted when a user exits present mode.
|
|
1480
|
-
* @version SDK
|
|
1484
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1481
1485
|
*/
|
|
1482
1486
|
EmbedEvent["ExitPresentMode"] = "exitPresentMode";
|
|
1483
1487
|
/**
|
|
1484
1488
|
* Emitted when a user requests the full height lazy load data.
|
|
1485
|
-
* @version SDK
|
|
1489
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1486
1490
|
* @hidden
|
|
1487
1491
|
*/
|
|
1488
1492
|
EmbedEvent["RequestVisibleEmbedCoordinates"] = "requestVisibleEmbedCoordinates";
|
|
@@ -1493,7 +1497,7 @@
|
|
|
1493
1497
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
1494
1498
|
* console.log('payload', payload);
|
|
1495
1499
|
* })
|
|
1496
|
-
|
|
1500
|
+
* ```
|
|
1497
1501
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1498
1502
|
*/
|
|
1499
1503
|
EmbedEvent["SpotterData"] = "SpotterData";
|
|
@@ -1504,7 +1508,7 @@
|
|
|
1504
1508
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
1505
1509
|
* console.log('payload', payload);
|
|
1506
1510
|
* })
|
|
1507
|
-
|
|
1511
|
+
* ```
|
|
1508
1512
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1509
1513
|
*/
|
|
1510
1514
|
EmbedEvent["PreviewSpotterData"] = "PreviewSpotterData";
|
|
@@ -1515,7 +1519,7 @@
|
|
|
1515
1519
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
1516
1520
|
* console.log('payload', payload);
|
|
1517
1521
|
* })
|
|
1518
|
-
|
|
1522
|
+
* ```
|
|
1519
1523
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
1520
1524
|
*/
|
|
1521
1525
|
EmbedEvent["AddToCoaching"] = "addToCoaching";
|
|
@@ -1537,7 +1541,7 @@
|
|
|
1537
1541
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
1538
1542
|
* console.log('payload', payload);
|
|
1539
1543
|
* })
|
|
1540
|
-
|
|
1544
|
+
* ```
|
|
1541
1545
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1542
1546
|
*/
|
|
1543
1547
|
EmbedEvent["SpotterQueryTriggered"] = "SpotterQueryTriggered";
|
|
@@ -1548,7 +1552,7 @@
|
|
|
1548
1552
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
1549
1553
|
* console.log('payload', payload);
|
|
1550
1554
|
* })
|
|
1551
|
-
|
|
1555
|
+
* ```
|
|
1552
1556
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1553
1557
|
*/
|
|
1554
1558
|
EmbedEvent["LastPromptEdited"] = "LastPromptEdited";
|
|
@@ -1559,18 +1563,18 @@
|
|
|
1559
1563
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
1560
1564
|
* console.log('payload', payload);
|
|
1561
1565
|
* })
|
|
1562
|
-
|
|
1566
|
+
* ```
|
|
1563
1567
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1564
1568
|
*/
|
|
1565
1569
|
EmbedEvent["LastPromptDeleted"] = "LastPromptDeleted";
|
|
1566
1570
|
/**
|
|
1567
|
-
* Emitted when the
|
|
1571
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
1568
1572
|
* @example
|
|
1569
1573
|
* ```js
|
|
1570
1574
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
1571
1575
|
* console.log('payload', payload);
|
|
1572
1576
|
* })
|
|
1573
|
-
|
|
1577
|
+
* ```
|
|
1574
1578
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1575
1579
|
*/
|
|
1576
1580
|
EmbedEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
|
|
@@ -1581,7 +1585,7 @@
|
|
|
1581
1585
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
1582
1586
|
* console.log('payload', payload);
|
|
1583
1587
|
* })
|
|
1584
|
-
|
|
1588
|
+
* ```
|
|
1585
1589
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
1586
1590
|
*/
|
|
1587
1591
|
EmbedEvent["SpotterInit"] = "spotterInit";
|
|
@@ -1592,7 +1596,7 @@
|
|
|
1592
1596
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
1593
1597
|
* console.log('payload', payload);
|
|
1594
1598
|
* })
|
|
1595
|
-
|
|
1599
|
+
* ```
|
|
1596
1600
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
1597
1601
|
*/
|
|
1598
1602
|
EmbedEvent["SpotterLoadComplete"] = "spotterLoadComplete";
|
|
@@ -1947,7 +1951,7 @@
|
|
|
1947
1951
|
* ```js
|
|
1948
1952
|
* appEmbed.navigateToPage(-1)
|
|
1949
1953
|
* ```
|
|
1950
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
1954
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1951
1955
|
*/
|
|
1952
1956
|
HostEvent["Navigate"] = "Navigate";
|
|
1953
1957
|
/**
|
|
@@ -2080,9 +2084,9 @@
|
|
|
2080
2084
|
* Trigger the **Show Liveboard details** action
|
|
2081
2085
|
* on an embedded Liveboard.
|
|
2082
2086
|
* @example
|
|
2083
|
-
|
|
2087
|
+
* ```js
|
|
2084
2088
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
2085
|
-
|
|
2089
|
+
* ```
|
|
2086
2090
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2087
2091
|
*/
|
|
2088
2092
|
HostEvent["LiveboardInfo"] = "pinboardInfo";
|
|
@@ -2210,7 +2214,7 @@
|
|
|
2210
2214
|
* appEmbed.trigger(HostEvent.Remove)
|
|
2211
2215
|
* ```
|
|
2212
2216
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2213
|
-
*
|
|
2217
|
+
* @example
|
|
2214
2218
|
* ```js
|
|
2215
2219
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
2216
2220
|
* ```
|
|
@@ -2301,7 +2305,7 @@
|
|
|
2301
2305
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2302
2306
|
* ```
|
|
2303
2307
|
* ```js
|
|
2304
|
-
* vizEmbed.trigger(
|
|
2308
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
2305
2309
|
* ```
|
|
2306
2310
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2307
2311
|
*/
|
|
@@ -2318,7 +2322,7 @@
|
|
|
2318
2322
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2319
2323
|
* ```
|
|
2320
2324
|
* ```js
|
|
2321
|
-
* vizEmbed.trigger(
|
|
2325
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
2322
2326
|
* ```
|
|
2323
2327
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2324
2328
|
*/
|
|
@@ -2333,23 +2337,22 @@
|
|
|
2333
2337
|
* );
|
|
2334
2338
|
* })
|
|
2335
2339
|
* ```
|
|
2336
|
-
*
|
|
2340
|
+
* @example
|
|
2337
2341
|
* ```js
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
2342
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
2343
|
+
* let latestSpotterVizId = '';
|
|
2344
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
2345
|
+
* latestSpotterVizId = payload.data.id;
|
|
2346
|
+
* });
|
|
2347
|
+
*
|
|
2348
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
2346
2349
|
* vizId: latestSpotterVizId
|
|
2347
2350
|
* }).then((tml) => {
|
|
2348
2351
|
* console.log(
|
|
2349
2352
|
* tml.answer.search_query // TML representation of the search query
|
|
2350
2353
|
* );
|
|
2351
2354
|
* })
|
|
2352
|
-
|
|
2355
|
+
* ```
|
|
2353
2356
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2354
2357
|
* @important
|
|
2355
2358
|
*/
|
|
@@ -2413,6 +2416,11 @@
|
|
|
2413
2416
|
/**
|
|
2414
2417
|
* Trigger the **Download** action on charts in
|
|
2415
2418
|
* the embedded view.
|
|
2419
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
2420
|
+
*
|
|
2421
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2422
|
+
*
|
|
2423
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2416
2424
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
2417
2425
|
* @example
|
|
2418
2426
|
* ```js
|
|
@@ -2431,9 +2439,6 @@
|
|
|
2431
2439
|
*
|
|
2432
2440
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
2433
2441
|
* ```
|
|
2434
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2435
|
-
* Use {@link DownloadAsPng}
|
|
2436
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2437
2442
|
*/
|
|
2438
2443
|
HostEvent["Download"] = "downloadAsPng";
|
|
2439
2444
|
/**
|
|
@@ -2871,8 +2876,8 @@
|
|
|
2871
2876
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
2872
2877
|
* console.log('parameters', parameter);
|
|
2873
2878
|
* });
|
|
2874
|
-
|
|
2875
|
-
|
|
2879
|
+
* ```
|
|
2880
|
+
* ```js
|
|
2876
2881
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
2877
2882
|
* let latestSpotterVizId = '';
|
|
2878
2883
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -2880,7 +2885,7 @@
|
|
|
2880
2885
|
* });
|
|
2881
2886
|
*
|
|
2882
2887
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
2883
|
-
|
|
2888
|
+
* ```
|
|
2884
2889
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
2885
2890
|
*/
|
|
2886
2891
|
HostEvent["GetParameters"] = "GetParameters";
|
|
@@ -2897,7 +2902,7 @@
|
|
|
2897
2902
|
* Notify when info call is completed successfully
|
|
2898
2903
|
* ```js
|
|
2899
2904
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
2900
|
-
|
|
2905
|
+
* ```
|
|
2901
2906
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2902
2907
|
*/
|
|
2903
2908
|
HostEvent["InfoSuccess"] = "InfoSuccess";
|
|
@@ -3000,7 +3005,7 @@
|
|
|
3000
3005
|
* ```js
|
|
3001
3006
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
3002
3007
|
*
|
|
3003
|
-
|
|
3008
|
+
* ```
|
|
3004
3009
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3005
3010
|
*/
|
|
3006
3011
|
HostEvent["AddToCoaching"] = "addToCoaching";
|
|
@@ -3042,7 +3047,7 @@
|
|
|
3042
3047
|
* });
|
|
3043
3048
|
*
|
|
3044
3049
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
3045
|
-
|
|
3050
|
+
* ```
|
|
3046
3051
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3047
3052
|
*/
|
|
3048
3053
|
HostEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
@@ -3052,7 +3057,7 @@
|
|
|
3052
3057
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
3053
3058
|
* ```js
|
|
3054
3059
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
3055
|
-
|
|
3060
|
+
* ```
|
|
3056
3061
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3057
3062
|
*/
|
|
3058
3063
|
HostEvent["ExitPresentMode"] = "exitPresentMode";
|
|
@@ -3202,6 +3207,7 @@
|
|
|
3202
3207
|
// 'both' clicks in `contextMenuTrigger` configuration.
|
|
3203
3208
|
Param["ContextMenuTrigger"] = "contextMenuEnabledOnWhichClick";
|
|
3204
3209
|
Param["LinkOverride"] = "linkOverride";
|
|
3210
|
+
Param["EnableLinkOverridesV2"] = "enableLinkOverridesV2";
|
|
3205
3211
|
Param["blockNonEmbedFullAppAccess"] = "blockNonEmbedFullAppAccess";
|
|
3206
3212
|
Param["ShowInsertToSlide"] = "insertInToSlide";
|
|
3207
3213
|
Param["PrimaryNavHidden"] = "primaryNavHidden";
|
|
@@ -3296,6 +3302,7 @@
|
|
|
3296
3302
|
Param["IsThisPeriodInDateFiltersEnabled"] = "isThisPeriodInDateFiltersEnabled";
|
|
3297
3303
|
Param["HideToolResponseCardBranding"] = "hideToolResponseCardBranding";
|
|
3298
3304
|
Param["ToolResponseCardBrandingLabel"] = "toolResponseCardBrandingLabel";
|
|
3305
|
+
Param["EnableHomepageAnnouncement"] = "enableHomepageAnnouncement";
|
|
3299
3306
|
})(Param || (Param = {}));
|
|
3300
3307
|
/**
|
|
3301
3308
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3455,14 +3462,14 @@
|
|
|
3455
3462
|
* ```js
|
|
3456
3463
|
* disabledActions: [Action.CollapseDataPanel]
|
|
3457
3464
|
* ```
|
|
3458
|
-
* @version
|
|
3465
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
3459
3466
|
*/
|
|
3460
3467
|
Action["CollapseDataSources"] = "collapseDataSources";
|
|
3461
3468
|
/**
|
|
3462
3469
|
* The **Collapse data panel** icon on the Search page.
|
|
3463
3470
|
* Collapses the data panel view.
|
|
3464
3471
|
*
|
|
3465
|
-
* @version
|
|
3472
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
3466
3473
|
*
|
|
3467
3474
|
* @example
|
|
3468
3475
|
* ```js
|
|
@@ -3909,13 +3916,12 @@
|
|
|
3909
3916
|
*/
|
|
3910
3917
|
Action["CreateMonitor"] = "createMonitor";
|
|
3911
3918
|
/**
|
|
3912
|
-
* @
|
|
3913
|
-
*
|
|
3919
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3920
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
3914
3921
|
* @example
|
|
3915
3922
|
* ```js
|
|
3916
3923
|
* disabledActions: [Action.ReportError]
|
|
3917
3924
|
* ```
|
|
3918
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3919
3925
|
*/
|
|
3920
3926
|
Action["ReportError"] = "reportError";
|
|
3921
3927
|
/**
|
|
@@ -3925,7 +3931,7 @@
|
|
|
3925
3931
|
* ```js
|
|
3926
3932
|
* disabledActions: [Action.SyncToSheets]
|
|
3927
3933
|
* ```
|
|
3928
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3934
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3929
3935
|
*/
|
|
3930
3936
|
Action["SyncToSheets"] = "sync-to-sheets";
|
|
3931
3937
|
/**
|
|
@@ -3936,7 +3942,7 @@
|
|
|
3936
3942
|
* ```js
|
|
3937
3943
|
* disabledActions: [Action.SyncToOtherApps]
|
|
3938
3944
|
* ```
|
|
3939
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3945
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3940
3946
|
*/
|
|
3941
3947
|
Action["SyncToOtherApps"] = "sync-to-other-apps";
|
|
3942
3948
|
/**
|
|
@@ -3946,7 +3952,7 @@
|
|
|
3946
3952
|
* ```js
|
|
3947
3953
|
* disabledActions: [Action.ManagePipelines]
|
|
3948
3954
|
* ```
|
|
3949
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3955
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3950
3956
|
*/
|
|
3951
3957
|
Action["ManagePipelines"] = "manage-pipeline";
|
|
3952
3958
|
/**
|
|
@@ -4258,7 +4264,7 @@
|
|
|
4258
4264
|
* ```js
|
|
4259
4265
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
4260
4266
|
* ```
|
|
4261
|
-
* @version SDK
|
|
4267
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4262
4268
|
*/
|
|
4263
4269
|
Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
|
|
4264
4270
|
/**
|
|
@@ -4268,7 +4274,7 @@
|
|
|
4268
4274
|
* ```js
|
|
4269
4275
|
* disabledActions: [Action.LiveboardUsers]
|
|
4270
4276
|
* ```
|
|
4271
|
-
* @version SDK
|
|
4277
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4272
4278
|
*/
|
|
4273
4279
|
Action["LiveboardUsers"] = "liveboardUsers";
|
|
4274
4280
|
/**
|
|
@@ -4286,7 +4292,7 @@
|
|
|
4286
4292
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
4287
4293
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
4288
4294
|
* ```
|
|
4289
|
-
* @version SDK
|
|
4295
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
4290
4296
|
*/
|
|
4291
4297
|
Action["TML"] = "tml";
|
|
4292
4298
|
/**
|
|
@@ -4332,7 +4338,7 @@
|
|
|
4332
4338
|
* ```js
|
|
4333
4339
|
* disabledActions: [Action.AddToWatchlist]
|
|
4334
4340
|
* ```
|
|
4335
|
-
* @version SDK
|
|
4341
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
4336
4342
|
*/
|
|
4337
4343
|
Action["AddToWatchlist"] = "addToWatchlist";
|
|
4338
4344
|
/**
|
|
@@ -4342,7 +4348,7 @@
|
|
|
4342
4348
|
* ```js
|
|
4343
4349
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
4344
4350
|
* ```
|
|
4345
|
-
* @version SDK
|
|
4351
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
4346
4352
|
*/
|
|
4347
4353
|
Action["RemoveFromWatchlist"] = "removeFromWatchlist";
|
|
4348
4354
|
/**
|
|
@@ -4353,7 +4359,7 @@
|
|
|
4353
4359
|
* ```js
|
|
4354
4360
|
* disabledActions: [Action.OrganiseFavourites]
|
|
4355
4361
|
* ```
|
|
4356
|
-
* @version SDK
|
|
4362
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
4357
4363
|
*/
|
|
4358
4364
|
Action["OrganiseFavourites"] = "organiseFavourites";
|
|
4359
4365
|
/**
|
|
@@ -4414,7 +4420,7 @@
|
|
|
4414
4420
|
* ```js
|
|
4415
4421
|
* disabledActions: [Action.ManageTags]
|
|
4416
4422
|
* ```
|
|
4417
|
-
* @version SDK
|
|
4423
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4418
4424
|
*/
|
|
4419
4425
|
Action["ManageTags"] = "manageTags";
|
|
4420
4426
|
/**
|
|
@@ -5414,7 +5420,7 @@
|
|
|
5414
5420
|
* @returns true if the value is a valid CSS margin value, false otherwise
|
|
5415
5421
|
*/
|
|
5416
5422
|
const isValidCssMargin = (value) => {
|
|
5417
|
-
if (isUndefined
|
|
5423
|
+
if (isUndefined(value)) {
|
|
5418
5424
|
return false;
|
|
5419
5425
|
}
|
|
5420
5426
|
if (typeof value !== 'string') {
|
|
@@ -5602,7 +5608,7 @@
|
|
|
5602
5608
|
element.style.removeProperty(styleProperty);
|
|
5603
5609
|
});
|
|
5604
5610
|
};
|
|
5605
|
-
const isUndefined
|
|
5611
|
+
const isUndefined = (value) => value === undefined;
|
|
5606
5612
|
// Return if the value is a string, double or boolean.
|
|
5607
5613
|
const getTypeFromValue = (value) => {
|
|
5608
5614
|
if (typeof value === 'string') {
|
|
@@ -5799,6 +5805,14 @@
|
|
|
5799
5805
|
return [false, error instanceof Error ? error : new Error(String(error))];
|
|
5800
5806
|
}
|
|
5801
5807
|
};
|
|
5808
|
+
/**
|
|
5809
|
+
* Resolves enablePastConversationsSidebar with
|
|
5810
|
+
* spotterSidebarConfig taking precedence over the
|
|
5811
|
+
* standalone flag.
|
|
5812
|
+
*/
|
|
5813
|
+
const resolveEnablePastConversationsSidebar = (params) => (params.spotterSidebarConfigValue !== undefined
|
|
5814
|
+
? params.spotterSidebarConfigValue
|
|
5815
|
+
: params.standaloneValue);
|
|
5802
5816
|
/**
|
|
5803
5817
|
* Sets a query parameter if the value is defined.
|
|
5804
5818
|
* @param queryParams - The query params object to modify
|
|
@@ -8379,7 +8393,7 @@
|
|
|
8379
8393
|
* tokenizedFetch("<TS_ORIGIN>/api/rest/2.0/auth/session/user", {
|
|
8380
8394
|
* // .. fetch options ..
|
|
8381
8395
|
* });
|
|
8382
|
-
|
|
8396
|
+
* ```
|
|
8383
8397
|
* @version SDK: 1.28.0
|
|
8384
8398
|
* @group Global methods
|
|
8385
8399
|
*/
|
|
@@ -8719,6 +8733,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
8719
8733
|
OperationType["GetChartWithData"] = "GetChartWithData";
|
|
8720
8734
|
OperationType["GetTableWithHeadlineData"] = "GetTableWithHeadlineData";
|
|
8721
8735
|
})(OperationType || (OperationType = {}));
|
|
8736
|
+
const DATA_TYPES = ['DATE', 'DATE_TIME', 'TIME'];
|
|
8722
8737
|
/**
|
|
8723
8738
|
* AnswerService provides a simple way to work with ThoughtSpot Answers.
|
|
8724
8739
|
*
|
|
@@ -8764,7 +8779,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
8764
8779
|
* });
|
|
8765
8780
|
* ```
|
|
8766
8781
|
*
|
|
8767
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
8782
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
8768
8783
|
* @group Events
|
|
8769
8784
|
*/
|
|
8770
8785
|
class AnswerService {
|
|
@@ -8825,6 +8840,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
8825
8840
|
* ]);
|
|
8826
8841
|
* console.log(await service.fetchData());
|
|
8827
8842
|
* });
|
|
8843
|
+
* ```
|
|
8828
8844
|
*/
|
|
8829
8845
|
async addColumnsByName(columnNames) {
|
|
8830
8846
|
const sourceDetail = await this.getSourceDetail();
|
|
@@ -8955,7 +8971,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
8955
8971
|
* const data = await underlying.fetchData(0, 100);
|
|
8956
8972
|
* })
|
|
8957
8973
|
* ```
|
|
8958
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
8974
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
8959
8975
|
*/
|
|
8960
8976
|
async getUnderlyingDataForPoint(outputColumnNames, selectedPoints) {
|
|
8961
8977
|
if (!selectedPoints && !this.selectedPoints) {
|
|
@@ -9074,7 +9090,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
9074
9090
|
const dataType = colVal.column.dataType;
|
|
9075
9091
|
colVal.column.id;
|
|
9076
9092
|
let dataValue;
|
|
9077
|
-
if (dataType
|
|
9093
|
+
if (DATA_TYPES.includes(dataType)) {
|
|
9078
9094
|
if (Number.isFinite(colVal.value)) {
|
|
9079
9095
|
dataValue = [{
|
|
9080
9096
|
epochRange: {
|
|
@@ -17527,20 +17543,45 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
17527
17543
|
exports.AuthStatus = void 0;
|
|
17528
17544
|
(function (AuthStatus) {
|
|
17529
17545
|
/**
|
|
17530
|
-
* Emits when the SDK fails to authenticate
|
|
17546
|
+
* Emits when the SDK fails to authenticate.
|
|
17531
17547
|
*/
|
|
17532
17548
|
AuthStatus["FAILURE"] = "FAILURE";
|
|
17533
17549
|
/**
|
|
17534
|
-
* Emits when the SDK
|
|
17550
|
+
* Emits when the SDK authentication step completes
|
|
17551
|
+
* successfully (e.g., token exchange, cookie set).
|
|
17552
|
+
* This fires before any iframe is rendered. Use
|
|
17553
|
+
* this to know that auth passed and it is safe to
|
|
17554
|
+
* proceed with rendering. The callback receives no
|
|
17555
|
+
* arguments.
|
|
17556
|
+
* @example
|
|
17557
|
+
* ```js
|
|
17558
|
+
* const authEE = init({ ... });
|
|
17559
|
+
* authEE.on(AuthStatus.SDK_SUCCESS, () => {
|
|
17560
|
+
* // Auth done, iframe not loaded yet
|
|
17561
|
+
* });
|
|
17562
|
+
* ```
|
|
17535
17563
|
*/
|
|
17536
17564
|
AuthStatus["SDK_SUCCESS"] = "SDK_SUCCESS";
|
|
17537
17565
|
/**
|
|
17538
17566
|
* @hidden
|
|
17539
|
-
* Emits when iframe is loaded and session
|
|
17567
|
+
* Emits when iframe is loaded and session
|
|
17568
|
+
* information is available.
|
|
17540
17569
|
*/
|
|
17541
17570
|
AuthStatus["SESSION_INFO_SUCCESS"] = "SESSION_INFO_SUCCESS";
|
|
17542
17571
|
/**
|
|
17543
|
-
* Emits when the app
|
|
17572
|
+
* Emits when the ThoughtSpot app inside the
|
|
17573
|
+
* embedded iframe confirms its session is active.
|
|
17574
|
+
* This fires after the iframe loads and sends back an `AuthInit` event.
|
|
17575
|
+
* @param sessionInfo Information about the user session, with details like `userGUID`.
|
|
17576
|
+
* @see EmbedEvent.AuthInit
|
|
17577
|
+
* @example
|
|
17578
|
+
* ```js
|
|
17579
|
+
* const authEE = init({ ... });
|
|
17580
|
+
* authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
|
|
17581
|
+
* // App is loaded and authenticated
|
|
17582
|
+
* console.log(sessionInfo.userGUID);
|
|
17583
|
+
* });
|
|
17584
|
+
* ```
|
|
17544
17585
|
*/
|
|
17545
17586
|
AuthStatus["SUCCESS"] = "SUCCESS";
|
|
17546
17587
|
/**
|
|
@@ -18248,7 +18289,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
18248
18289
|
* }).catch(error => {
|
|
18249
18290
|
* console.error(error);
|
|
18250
18291
|
* });
|
|
18251
|
-
|
|
18292
|
+
* ```
|
|
18252
18293
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
18253
18294
|
* @group Global methods
|
|
18254
18295
|
*/
|
|
@@ -18351,9 +18392,9 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
18351
18392
|
};
|
|
18352
18393
|
/**
|
|
18353
18394
|
* Reloads the ThoughtSpot iframe.
|
|
18395
|
+
* @version SDK: 1.43.1
|
|
18354
18396
|
* @param iFrame
|
|
18355
18397
|
* @group Global methods
|
|
18356
|
-
* @version SDK: 1.43.1
|
|
18357
18398
|
*/
|
|
18358
18399
|
const reloadIframe = (iFrame) => {
|
|
18359
18400
|
if (!iFrame) {
|
|
@@ -18494,7 +18535,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
18494
18535
|
return eventData;
|
|
18495
18536
|
}
|
|
18496
18537
|
|
|
18497
|
-
var name="@thoughtspot/visual-embed-sdk";var version$1="1.46.
|
|
18538
|
+
var name="@thoughtspot/visual-embed-sdk";var version$1="1.46.2";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports$1={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/all-types-export.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p tsconfig.build.json --incremental false; tsc -p tsconfig.build.json --incremental false --module commonjs --outDir cjs","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle-generator --config ./dts-config/dts-bundle-file.config.js","bundle-dts":"dts-bundle-generator --config ./dts-config/dts-bundle.config.js","bundle-dts-react":"dts-bundle-generator --config ./dts-config/dts-bundle-react.config.js","bundle-dts-react-full":"dts-bundle-generator --config ./dts-config/dts-bundle-react-full.config.js",build:"rollup -c",watch:"rollup -cw",docgen:"typedoc --tsconfig tsconfig.build.json --theme typedoc-theme --json static/typedoc/typedoc.json --disableOutputCheck","test-sdk":"jest -c jest.config.sdk.js --runInBand",test:"npm run test-sdk",posttest:"cat ./coverage/sdk/lcov.info | npx coveralls-next || echo 'Warning: Coveralls upload failed but not breaking the build.'","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","check-size":"npm run build && size-limit","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest",dev:"vite -c vite.local.config.ts"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={classnames:"^2.3.1",eventemitter3:"^4.0.7",lodash:"^4.17.23","mixpanel-browser":"2.47.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1",yaml:"^2.5.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@size-limit/preset-big-lib":"^11.2.0","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^30.0.0","@types/lodash":"^4.17.0","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^8.28.0","@typescript-eslint/parser":"^8.28.0",ajv:"^8.17.1",asciidoctor:"^2.2.1","babel-jest":"^30.2.0","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1","coveralls-next":"^5.0.0",crypto:"^1.0.1","current-git-branch":"^1.1.0","dts-bundle-generator":"^9.5.1",eslint:"^9.23.0","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^10.1.1","eslint-import-resolver-typescript":"^4.2.5","eslint-plugin-comment-length":"2.2.1","eslint-plugin-import":"^2.31.0","eslint-plugin-jsdoc":"^50.6.9","eslint-plugin-prettier":"^5.2.5","eslint-plugin-react":"^7.37.5","eslint-plugin-react-hooks":"^5.2.0","fs-extra":"^10.0.0","gh-pages":"6.3.0",globals:"^16.0.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^2.0.0",jest:"^30.2.0","jest-environment-jsdom":"^29.7.0","jest-fetch-mock":"^3.0.3",jsdom:"^17.0.0",prettier:"2.1.2",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"4.24.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^29.4.6","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","typescript-eslint":"^8.29.1","url-search-params-polyfill":"^8.1.0",util:"^0.12.4",vite:"^6.3.5"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embedded","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version$1,description:description,module:module,main:main,types:types,files:files,exports:exports$1,typesVersions:typesVersions,"size-limit":[{path:"dist/tsembed.es.js",limit:"32 kB"}],scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
|
|
18498
18539
|
|
|
18499
18540
|
class HostEventClient {
|
|
18500
18541
|
constructor(iFrame) {
|
|
@@ -18800,9 +18841,9 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
18800
18841
|
this.embedNodeKey = '__tsEmbed';
|
|
18801
18842
|
this.isAppInitialized = false;
|
|
18802
18843
|
/**
|
|
18803
|
-
* Should we encode URL Query Params using base64 encoding which
|
|
18844
|
+
* Should we encode URL Query Params using base64 encoding which ThoughtSpot
|
|
18804
18845
|
* will generate for embedding. This provides additional security to
|
|
18805
|
-
*
|
|
18846
|
+
* ThoughtSpot clusters against Cross site scripting attacks.
|
|
18806
18847
|
* @default false
|
|
18807
18848
|
*/
|
|
18808
18849
|
this.shouldEncodeUrlQueryParams = false;
|
|
@@ -18978,7 +19019,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
18978
19019
|
if (viewConfig.preRenderId) {
|
|
18979
19020
|
const allOtherKeys = Object.keys(viewConfig).filter((key) => !preRenderAllowedKeys.includes(key) && !key.startsWith('on'));
|
|
18980
19021
|
allOtherKeys.forEach((key) => {
|
|
18981
|
-
if (!isUndefined
|
|
19022
|
+
if (!isUndefined(viewConfig[key])
|
|
18982
19023
|
&& !isEqual_1(viewConfig[key], preRenderedObject.viewConfig[key])) {
|
|
18983
19024
|
logger$3.warn(`${viewConfig.embedComponentType || 'Component'} was pre-rendered with `
|
|
18984
19025
|
+ `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
|
|
@@ -19314,7 +19355,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
19314
19355
|
if (this.embedConfig.currencyFormat) {
|
|
19315
19356
|
queryParams[Param.CurrencyFormat] = this.embedConfig.currencyFormat;
|
|
19316
19357
|
}
|
|
19317
|
-
const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags: additionalFlagsFromView, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, disableRedirectionLinksInNewTab, overrideOrgId, exposeTranslationIDs, primaryAction, } = this.viewConfig;
|
|
19358
|
+
const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags: additionalFlagsFromView, locale, customizations, contextMenuTrigger, linkOverride, enableLinkOverridesV2, insertInToSlide, disableRedirectionLinksInNewTab, overrideOrgId, exposeTranslationIDs, primaryAction, } = this.viewConfig;
|
|
19318
19359
|
const { additionalFlags: additionalFlagsFromInit } = this.embedConfig;
|
|
19319
19360
|
const additionalFlags = {
|
|
19320
19361
|
...additionalFlagsFromInit,
|
|
@@ -19390,7 +19431,13 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
19390
19431
|
if (locale !== undefined) {
|
|
19391
19432
|
queryParams[Param.Locale] = locale;
|
|
19392
19433
|
}
|
|
19393
|
-
|
|
19434
|
+
// TODO: Once V2 is stable, send both flags when
|
|
19435
|
+
// linkOverride is true (remove the else-if).
|
|
19436
|
+
if (enableLinkOverridesV2) {
|
|
19437
|
+
queryParams[Param.EnableLinkOverridesV2] = true;
|
|
19438
|
+
queryParams[Param.LinkOverride] = true;
|
|
19439
|
+
}
|
|
19440
|
+
else if (linkOverride) {
|
|
19394
19441
|
queryParams[Param.LinkOverride] = linkOverride;
|
|
19395
19442
|
}
|
|
19396
19443
|
if (insertInToSlide) {
|
|
@@ -19458,7 +19505,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
19458
19505
|
iFrame.mozallowfullscreen = true;
|
|
19459
19506
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
19460
19507
|
// @ts-ignore
|
|
19461
|
-
iFrame.allow = 'clipboard-read; clipboard-write; fullscreen;';
|
|
19508
|
+
iFrame.allow = 'clipboard-read; clipboard-write; fullscreen; local-network-access;';
|
|
19462
19509
|
const frameParams = this.viewConfig.frameParams;
|
|
19463
19510
|
const { height: frameHeight, width: frameWidth, ...restParams } = frameParams || {};
|
|
19464
19511
|
const width = getCssDimension(frameWidth || DEFAULT_EMBED_WIDTH);
|
|
@@ -20160,7 +20207,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20160
20207
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
20161
20208
|
* session.
|
|
20162
20209
|
* @param vizId [Optional] to get for a specific viz in case of a Liveboard.
|
|
20163
|
-
* @version SDK: 1.25.0
|
|
20210
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
|
|
20164
20211
|
*/
|
|
20165
20212
|
async getAnswerService(vizId) {
|
|
20166
20213
|
const { session } = await this.trigger(exports.HostEvent.GetAnswerSession, vizId ? { vizId } : {});
|
|
@@ -20460,7 +20507,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20460
20507
|
* embedded Liveboard or visualization.
|
|
20461
20508
|
*/
|
|
20462
20509
|
getEmbedParams() {
|
|
20463
|
-
const { tag, hideTagFilterChips, hideObjects, liveboardV2, showPrimaryNavbar, disableProfileAndHelp, hideHamburger, hideObjectSearch, hideNotification, hideApplicationSwitcher, hideOrgSwitcher, enableSearchAssist, fullHeight, dataPanelV2 = true, hideLiveboardHeader = false, showLiveboardTitle = true, showLiveboardDescription = true, showMaskedFilterChip = false, isLiveboardMasterpiecesEnabled = false, hideHomepageLeftNav = false, modularHomeExperience = false, isLiveboardHeaderSticky = true, enableAskSage, collapseSearchBarInitially = false, enable2ColumnLayout, enableCustomColumnGroups = false, dataPanelCustomGroupsAccordionInitialState = exports.DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, collapseSearchBar = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, isEnhancedFilterInteractivityEnabled = false, homePageSearchBarMode, isUnifiedSearchExperienceEnabled = true, enablePendoHelp = true, discoveryExperience, coverAndFilterOptionInPDF = false, isLiveboardStylingAndGroupingEnabled, isPNGInScheduledEmailsEnabled = false, isLiveboardXLSXCSVDownloadEnabled = false, isGranularXLSXCSVSchedulesEnabled = false, isCentralizedLiveboardFilterUXEnabled = false, isLinkParametersEnabled, updatedSpotterChatPrompt, spotterSidebarConfig, spotterChatConfig, minimumHeight, isThisPeriodInDateFiltersEnabled, } = this.viewConfig;
|
|
20510
|
+
const { tag, hideTagFilterChips, hideObjects, liveboardV2, showPrimaryNavbar, disableProfileAndHelp, hideHamburger, hideObjectSearch, hideNotification, hideApplicationSwitcher, hideOrgSwitcher, enableSearchAssist, fullHeight, dataPanelV2 = true, hideLiveboardHeader = false, showLiveboardTitle = true, showLiveboardDescription = true, showMaskedFilterChip = false, isLiveboardMasterpiecesEnabled = false, hideHomepageLeftNav = false, modularHomeExperience = false, isLiveboardHeaderSticky = true, enableAskSage, collapseSearchBarInitially = false, enable2ColumnLayout, enableCustomColumnGroups = false, dataPanelCustomGroupsAccordionInitialState = exports.DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, collapseSearchBar = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, isEnhancedFilterInteractivityEnabled = false, homePageSearchBarMode, isUnifiedSearchExperienceEnabled = true, enablePendoHelp = true, discoveryExperience, coverAndFilterOptionInPDF = false, isLiveboardStylingAndGroupingEnabled, isPNGInScheduledEmailsEnabled = false, isLiveboardXLSXCSVDownloadEnabled = false, isGranularXLSXCSVSchedulesEnabled = false, isCentralizedLiveboardFilterUXEnabled = false, isLinkParametersEnabled, updatedSpotterChatPrompt, spotterSidebarConfig, spotterChatConfig, minimumHeight, isThisPeriodInDateFiltersEnabled, enableHomepageAnnouncement, } = this.viewConfig;
|
|
20464
20511
|
let params = {};
|
|
20465
20512
|
params[Param.PrimaryNavHidden] = !showPrimaryNavbar;
|
|
20466
20513
|
params[Param.HideProfleAndHelp] = !!disableProfileAndHelp;
|
|
@@ -20481,13 +20528,17 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20481
20528
|
params[Param.IsUnifiedSearchExperienceEnabled] = isUnifiedSearchExperienceEnabled;
|
|
20482
20529
|
params[Param.CoverAndFilterOptionInPDF] = !!coverAndFilterOptionInPDF;
|
|
20483
20530
|
params = this.getBaseQueryParams(params);
|
|
20484
|
-
if (!isUndefined
|
|
20531
|
+
if (!isUndefined(updatedSpotterChatPrompt)) {
|
|
20485
20532
|
params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
|
|
20486
20533
|
}
|
|
20534
|
+
const resolvedEnablePastConversationsSidebar = resolveEnablePastConversationsSidebar({
|
|
20535
|
+
spotterSidebarConfigValue: spotterSidebarConfig === null || spotterSidebarConfig === void 0 ? void 0 : spotterSidebarConfig.enablePastConversationsSidebar,
|
|
20536
|
+
standaloneValue: this.viewConfig.enablePastConversationsSidebar,
|
|
20537
|
+
});
|
|
20538
|
+
setParamIfDefined(params, Param.EnablePastConversationsSidebar, resolvedEnablePastConversationsSidebar, true);
|
|
20487
20539
|
// Handle spotterSidebarConfig params
|
|
20488
20540
|
if (spotterSidebarConfig) {
|
|
20489
|
-
const {
|
|
20490
|
-
setParamIfDefined(params, Param.EnablePastConversationsSidebar, enablePastConversationsSidebar, true);
|
|
20541
|
+
const { spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig;
|
|
20491
20542
|
setParamIfDefined(params, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
|
|
20492
20543
|
setParamIfDefined(params, Param.SpotterSidebarTitle, spotterSidebarTitle);
|
|
20493
20544
|
setParamIfDefined(params, Param.SpotterChatRenameLabel, spotterChatRenameLabel);
|
|
@@ -20585,6 +20636,9 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20585
20636
|
if (isThisPeriodInDateFiltersEnabled !== undefined) {
|
|
20586
20637
|
params[Param.IsThisPeriodInDateFiltersEnabled] = isThisPeriodInDateFiltersEnabled;
|
|
20587
20638
|
}
|
|
20639
|
+
if (enableHomepageAnnouncement !== undefined) {
|
|
20640
|
+
params[Param.EnableHomepageAnnouncement] = enableHomepageAnnouncement;
|
|
20641
|
+
}
|
|
20588
20642
|
this.defaultHeight = minimumHeight || this.defaultHeight;
|
|
20589
20643
|
params[Param.DataPanelV2Enabled] = dataPanelV2;
|
|
20590
20644
|
params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
|
|
@@ -20843,6 +20897,7 @@ query GetEurekaVizSnapshots(
|
|
|
20843
20897
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
20844
20898
|
* waits for the authentication to complete, so you need not wait for
|
|
20845
20899
|
* `AuthStatus.SUCCESS`.
|
|
20900
|
+
* @group Embed components
|
|
20846
20901
|
* @example
|
|
20847
20902
|
* ```js
|
|
20848
20903
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -20852,7 +20907,6 @@ query GetEurekaVizSnapshots(
|
|
|
20852
20907
|
* // .. other params here.
|
|
20853
20908
|
* })
|
|
20854
20909
|
* ```
|
|
20855
|
-
* @group Embed components
|
|
20856
20910
|
*/
|
|
20857
20911
|
class LiveboardEmbed extends V1Embed {
|
|
20858
20912
|
constructor(domSelector, viewConfig) {
|
|
@@ -20960,7 +21014,7 @@ query GetEurekaVizSnapshots(
|
|
|
20960
21014
|
if (preventLiveboardFilterRemoval) {
|
|
20961
21015
|
params[Param.preventLiveboardFilterRemoval] = true;
|
|
20962
21016
|
}
|
|
20963
|
-
if (!isUndefined
|
|
21017
|
+
if (!isUndefined(updatedSpotterChatPrompt)) {
|
|
20964
21018
|
params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
|
|
20965
21019
|
}
|
|
20966
21020
|
if (visibleVizs) {
|
|
@@ -21139,7 +21193,7 @@ query GetEurekaVizSnapshots(
|
|
|
21139
21193
|
});
|
|
21140
21194
|
}
|
|
21141
21195
|
async handleRenderForPrerender() {
|
|
21142
|
-
if (isUndefined
|
|
21196
|
+
if (isUndefined(this.viewConfig.liveboardId)) {
|
|
21143
21197
|
return this.prerenderGeneric();
|
|
21144
21198
|
}
|
|
21145
21199
|
return super.handleRenderForPrerender();
|
|
@@ -21425,7 +21479,7 @@ query GetEurekaVizSnapshots(
|
|
|
21425
21479
|
|
|
21426
21480
|
/**
|
|
21427
21481
|
* Embed ThoughtSpot search bar
|
|
21428
|
-
* @version
|
|
21482
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
21429
21483
|
* @group Embed components
|
|
21430
21484
|
*/
|
|
21431
21485
|
class SearchBarEmbed extends TsEmbed {
|
|
@@ -21926,6 +21980,8 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
21926
21980
|
/**
|
|
21927
21981
|
* Create a conversation embed, which can be integrated inside
|
|
21928
21982
|
* chatbots or other conversational interfaces.
|
|
21983
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
21984
|
+
* @group Embed components
|
|
21929
21985
|
* @example
|
|
21930
21986
|
* ```js
|
|
21931
21987
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -21939,8 +21995,6 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
21939
21995
|
* // append the container to the DOM
|
|
21940
21996
|
* document.body.appendChild(container); // or to any other element
|
|
21941
21997
|
* ```
|
|
21942
|
-
* @group Embed components
|
|
21943
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
21944
21998
|
*/
|
|
21945
21999
|
class SpotterAgentEmbed {
|
|
21946
22000
|
constructor(viewConfig) {
|
|
@@ -21994,8 +22048,9 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
21994
22048
|
/**
|
|
21995
22049
|
* Create a conversation embed, which can be integrated inside
|
|
21996
22050
|
* chatbots or other conversational interfaces.
|
|
21997
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
21998
22051
|
* Use {@link SpotterAgentEmbed} instead
|
|
22052
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22053
|
+
* @group Embed components
|
|
21999
22054
|
* @example
|
|
22000
22055
|
* ```js
|
|
22001
22056
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -22009,7 +22064,6 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22009
22064
|
* // append the container to the DOM
|
|
22010
22065
|
* document.body.appendChild(container); // or to any other element
|
|
22011
22066
|
* ```
|
|
22012
|
-
* @group Embed components
|
|
22013
22067
|
*/
|
|
22014
22068
|
class BodylessConversation extends SpotterAgentEmbed {
|
|
22015
22069
|
constructor(viewConfig) {
|
|
@@ -22017,31 +22071,9 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22017
22071
|
}
|
|
22018
22072
|
}
|
|
22019
22073
|
|
|
22020
|
-
/**
|
|
22021
|
-
* Checks if `value` is `undefined`.
|
|
22022
|
-
*
|
|
22023
|
-
* @static
|
|
22024
|
-
* @since 0.1.0
|
|
22025
|
-
* @memberOf _
|
|
22026
|
-
* @category Lang
|
|
22027
|
-
* @param {*} value The value to check.
|
|
22028
|
-
* @returns {boolean} Returns `true` if `value` is `undefined`, else `false`.
|
|
22029
|
-
* @example
|
|
22030
|
-
*
|
|
22031
|
-
* _.isUndefined(void 0);
|
|
22032
|
-
* // => true
|
|
22033
|
-
*
|
|
22034
|
-
* _.isUndefined(null);
|
|
22035
|
-
* // => false
|
|
22036
|
-
*/
|
|
22037
|
-
function isUndefined(value) {
|
|
22038
|
-
return value === undefined;
|
|
22039
|
-
}
|
|
22040
|
-
|
|
22041
|
-
var isUndefined_1 = isUndefined;
|
|
22042
|
-
|
|
22043
22074
|
/**
|
|
22044
22075
|
* Embed ThoughtSpot AI Conversation.
|
|
22076
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22045
22077
|
* @group Embed components
|
|
22046
22078
|
* @example
|
|
22047
22079
|
* ```js
|
|
@@ -22053,7 +22085,6 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22053
22085
|
* });
|
|
22054
22086
|
* conversation.render();
|
|
22055
22087
|
* ```
|
|
22056
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22057
22088
|
*/
|
|
22058
22089
|
class SpotterEmbed extends TsEmbed {
|
|
22059
22090
|
constructor(container, viewConfig) {
|
|
@@ -22069,7 +22100,11 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22069
22100
|
getEmbedParamsObject() {
|
|
22070
22101
|
const { worksheetId, searchOptions, disableSourceSelection, hideSourceSelection, dataPanelV2, showSpotterLimitations, hideSampleQuestions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, updatedSpotterChatPrompt, spotterSidebarConfig, spotterChatConfig, } = this.viewConfig;
|
|
22071
22102
|
// Extract sidebar config properties
|
|
22072
|
-
const { enablePastConversationsSidebar, spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig || {};
|
|
22103
|
+
const { enablePastConversationsSidebar: sidebarEnablePastConversationsSidebar, spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig || {};
|
|
22104
|
+
const resolvedEnablePastConversationsSidebar = resolveEnablePastConversationsSidebar({
|
|
22105
|
+
spotterSidebarConfigValue: sidebarEnablePastConversationsSidebar,
|
|
22106
|
+
standaloneValue: this.viewConfig.enablePastConversationsSidebar,
|
|
22107
|
+
});
|
|
22073
22108
|
if (!worksheetId) {
|
|
22074
22109
|
this.handleError({
|
|
22075
22110
|
errorType: exports.ErrorDetailsTypes.VALIDATION_ERROR,
|
|
@@ -22087,6 +22122,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22087
22122
|
setParamIfDefined(queryParams, Param.ShowSpotterLimitations, showSpotterLimitations, true);
|
|
22088
22123
|
setParamIfDefined(queryParams, Param.HideSampleQuestions, hideSampleQuestions, true);
|
|
22089
22124
|
setParamIfDefined(queryParams, Param.UpdatedSpotterChatPrompt, updatedSpotterChatPrompt, true);
|
|
22125
|
+
setParamIfDefined(queryParams, Param.EnablePastConversationsSidebar, resolvedEnablePastConversationsSidebar, true);
|
|
22090
22126
|
setParamIfDefined(queryParams, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
|
|
22091
22127
|
// String params
|
|
22092
22128
|
setParamIfDefined(queryParams, Param.SpotterSidebarTitle, spotterSidebarTitle);
|
|
@@ -22121,13 +22157,9 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22121
22157
|
return queryParams;
|
|
22122
22158
|
}
|
|
22123
22159
|
getIframeSrc() {
|
|
22124
|
-
const { worksheetId, searchOptions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL,
|
|
22160
|
+
const { worksheetId, searchOptions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, } = this.viewConfig;
|
|
22125
22161
|
const path = 'insights/conv-assist';
|
|
22126
22162
|
const queryParams = this.getEmbedParamsObject();
|
|
22127
|
-
const enablePastConversationsSidebar = spotterSidebarConfig === null || spotterSidebarConfig === void 0 ? void 0 : spotterSidebarConfig.enablePastConversationsSidebar;
|
|
22128
|
-
if (!isUndefined_1(enablePastConversationsSidebar)) {
|
|
22129
|
-
queryParams[Param.EnablePastConversationsSidebar] = !!enablePastConversationsSidebar;
|
|
22130
|
-
}
|
|
22131
22163
|
let query = '';
|
|
22132
22164
|
const queryParamsString = getQueryParamString(queryParams, true);
|
|
22133
22165
|
if (queryParamsString) {
|
|
@@ -22156,8 +22188,9 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22156
22188
|
}
|
|
22157
22189
|
/**
|
|
22158
22190
|
* Embed ThoughtSpot AI Conversation.
|
|
22159
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22160
22191
|
* Use {@link SpotterEmbed} instead
|
|
22192
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22193
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22161
22194
|
* @group Embed components
|
|
22162
22195
|
* @example
|
|
22163
22196
|
* ```js
|
|
@@ -22169,7 +22202,6 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22169
22202
|
* });
|
|
22170
22203
|
* conversation.render();
|
|
22171
22204
|
* ```
|
|
22172
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22173
22205
|
*/
|
|
22174
22206
|
class ConversationEmbed extends SpotterEmbed {
|
|
22175
22207
|
constructor(container, viewConfig) {
|
|
@@ -22193,7 +22225,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22193
22225
|
*/
|
|
22194
22226
|
/**
|
|
22195
22227
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
22196
|
-
* @version
|
|
22228
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
22197
22229
|
*
|
|
22198
22230
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
22199
22231
|
* @group Embed components
|