@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.es.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 _mergeNamespaces(n, m) {
|
|
4
4
|
m.forEach(function (e) {
|
|
@@ -23,7 +23,7 @@ function _mergeNamespaces(n, m) {
|
|
|
23
23
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
24
24
|
*/
|
|
25
25
|
/**
|
|
26
|
-
* The authentication mechanism for allowing access to
|
|
26
|
+
* The authentication mechanism for allowing access to
|
|
27
27
|
* the embedded app
|
|
28
28
|
* @group Authentication / Init
|
|
29
29
|
*/
|
|
@@ -49,6 +49,7 @@ var AuthType;
|
|
|
49
49
|
* To use this:
|
|
50
50
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
51
51
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
52
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
52
53
|
* @example
|
|
53
54
|
* ```js
|
|
54
55
|
* init({
|
|
@@ -56,18 +57,17 @@ var AuthType;
|
|
|
56
57
|
* authType: AuthType.EmbeddedSSO,
|
|
57
58
|
* });
|
|
58
59
|
* ```
|
|
59
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
60
60
|
*/
|
|
61
61
|
AuthType["EmbeddedSSO"] = "EmbeddedSSO";
|
|
62
62
|
/**
|
|
63
|
-
* SSO using SAML
|
|
64
|
-
* @deprecated
|
|
63
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
64
|
+
* @deprecated This option is deprecated.
|
|
65
65
|
* @hidden
|
|
66
66
|
*/
|
|
67
67
|
AuthType["SSO"] = "SSO_SAML";
|
|
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["SAML"] = "SSO_SAML";
|
|
@@ -118,8 +118,9 @@ var AuthType;
|
|
|
118
118
|
AuthType["SAMLRedirect"] = "SSO_SAML";
|
|
119
119
|
/**
|
|
120
120
|
* SSO using OIDC
|
|
121
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
122
|
+
* @deprecated This option is deprecated.
|
|
121
123
|
* @hidden
|
|
122
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
123
124
|
*/
|
|
124
125
|
AuthType["OIDC"] = "SSO_OIDC";
|
|
125
126
|
/**
|
|
@@ -130,8 +131,9 @@ var AuthType;
|
|
|
130
131
|
AuthType["OIDCRedirect"] = "SSO_OIDC";
|
|
131
132
|
/**
|
|
132
133
|
* Trusted authentication server
|
|
134
|
+
* Use {@link TrustedAuth} instead
|
|
135
|
+
* @deprecated This option is deprecated.
|
|
133
136
|
* @hidden
|
|
134
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
135
137
|
*/
|
|
136
138
|
AuthType["AuthServer"] = "AuthServer";
|
|
137
139
|
/**
|
|
@@ -158,6 +160,7 @@ var AuthType;
|
|
|
158
160
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
159
161
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
160
162
|
* implemented by some browsers.
|
|
163
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
161
164
|
* @example
|
|
162
165
|
* ```js
|
|
163
166
|
* init({
|
|
@@ -168,8 +171,8 @@ var AuthType;
|
|
|
168
171
|
* .then((response) => response.json())
|
|
169
172
|
* .then((data) => data.token);
|
|
170
173
|
* }
|
|
174
|
+
* });
|
|
171
175
|
* ```
|
|
172
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
173
176
|
*/
|
|
174
177
|
AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
|
|
175
178
|
/**
|
|
@@ -190,43 +193,43 @@ var HomeLeftNavItem;
|
|
|
190
193
|
/**
|
|
191
194
|
* The *Search data* option in
|
|
192
195
|
* the *Insights* left navigation panel.
|
|
193
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
196
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
194
197
|
*/
|
|
195
198
|
HomeLeftNavItem["SearchData"] = "search-data";
|
|
196
199
|
/**
|
|
197
200
|
* The *Home* menu 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["Home"] = "insights-home";
|
|
202
205
|
/**
|
|
203
206
|
* The *Liveboards* 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["Liveboards"] = "liveboards";
|
|
208
211
|
/**
|
|
209
212
|
* The *Answers* 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["Answers"] = "answers";
|
|
214
217
|
/**
|
|
215
218
|
* The *Monitor subscriptions* 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["MonitorSubscription"] = "monitor-alerts";
|
|
220
223
|
/**
|
|
221
224
|
* The *SpotIQ analysis* 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["SpotIQAnalysis"] = "spotiq-analysis";
|
|
226
229
|
/**
|
|
227
230
|
* The *Liveboard schedules* menu option in
|
|
228
231
|
* the *Insights* left navigation panel.
|
|
229
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
232
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
230
233
|
*/
|
|
231
234
|
HomeLeftNavItem["LiveboardSchedules"] = "liveboard-schedules";
|
|
232
235
|
/**
|
|
@@ -332,7 +335,7 @@ var HomepageModule;
|
|
|
332
335
|
*/
|
|
333
336
|
HomepageModule["Search"] = "SEARCH";
|
|
334
337
|
/**
|
|
335
|
-
*
|
|
338
|
+
* KPI watchlist module
|
|
336
339
|
*/
|
|
337
340
|
HomepageModule["Watchlist"] = "WATCHLIST";
|
|
338
341
|
/**
|
|
@@ -364,7 +367,8 @@ var ListPageColumns;
|
|
|
364
367
|
*/
|
|
365
368
|
ListPageColumns["Favorites"] = "FAVOURITE";
|
|
366
369
|
/**
|
|
367
|
-
*
|
|
370
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
371
|
+
* @deprecated This option is deprecated.
|
|
368
372
|
*/
|
|
369
373
|
ListPageColumns["Favourite"] = "FAVOURITE";
|
|
370
374
|
/**
|
|
@@ -432,13 +436,13 @@ var EmbedEvent;
|
|
|
432
436
|
/**
|
|
433
437
|
* Rendering has initialized.
|
|
434
438
|
* @example
|
|
435
|
-
|
|
439
|
+
* ```js
|
|
436
440
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
437
441
|
* //show a loader
|
|
438
442
|
* function showLoader() {
|
|
439
443
|
* document.getElementById("loader");
|
|
440
444
|
* }
|
|
441
|
-
|
|
445
|
+
* ```
|
|
442
446
|
* @returns timestamp - The timestamp when the event was generated.
|
|
443
447
|
*/
|
|
444
448
|
EmbedEvent["Init"] = "init";
|
|
@@ -446,11 +450,11 @@ var EmbedEvent;
|
|
|
446
450
|
* Authentication has either succeeded or failed.
|
|
447
451
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
448
452
|
* @example
|
|
449
|
-
|
|
453
|
+
* ```js
|
|
450
454
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
451
455
|
* console.log('AuthInit', payload);
|
|
452
456
|
* })
|
|
453
|
-
|
|
457
|
+
* ```
|
|
454
458
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
455
459
|
*/
|
|
456
460
|
EmbedEvent["AuthInit"] = "authInit";
|
|
@@ -459,13 +463,13 @@ var EmbedEvent;
|
|
|
459
463
|
* @returns timestamp - The timestamp when the event was generated.
|
|
460
464
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
461
465
|
* @example
|
|
462
|
-
|
|
466
|
+
* ```js
|
|
463
467
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
464
468
|
* //hide loader
|
|
465
469
|
* function hideLoader() {
|
|
466
470
|
* document.getElementById("loader");
|
|
467
471
|
* }
|
|
468
|
-
|
|
472
|
+
* ```
|
|
469
473
|
*/
|
|
470
474
|
EmbedEvent["Load"] = "load";
|
|
471
475
|
/**
|
|
@@ -474,11 +478,11 @@ var EmbedEvent;
|
|
|
474
478
|
* @return data - Answer of Liveboard data
|
|
475
479
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
476
480
|
* @example
|
|
477
|
-
|
|
481
|
+
* ```js
|
|
478
482
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
479
483
|
* console.log('data', payload);
|
|
480
484
|
* })
|
|
481
|
-
|
|
485
|
+
* ```
|
|
482
486
|
* @important
|
|
483
487
|
*/
|
|
484
488
|
EmbedEvent["Data"] = "data";
|
|
@@ -486,9 +490,9 @@ var EmbedEvent;
|
|
|
486
490
|
* Search query has been updated by the user.
|
|
487
491
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
488
492
|
* @example
|
|
489
|
-
|
|
493
|
+
* ```js
|
|
490
494
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
491
|
-
|
|
495
|
+
* ```
|
|
492
496
|
*/
|
|
493
497
|
EmbedEvent["QueryChanged"] = "queryChanged";
|
|
494
498
|
/**
|
|
@@ -498,7 +502,7 @@ var EmbedEvent;
|
|
|
498
502
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
499
503
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
500
504
|
* @example
|
|
501
|
-
|
|
505
|
+
* ```js
|
|
502
506
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
503
507
|
* points: {
|
|
504
508
|
* clickedPoint,
|
|
@@ -506,12 +510,12 @@ var EmbedEvent;
|
|
|
506
510
|
* },
|
|
507
511
|
* autoDrillDown: true,
|
|
508
512
|
* })
|
|
509
|
-
|
|
513
|
+
* ```
|
|
510
514
|
* In this example, `VizPointDoubleClick` event is used for
|
|
511
515
|
* triggering the `DrillDown` event when an area or specific
|
|
512
516
|
* data point on a table or chart is double-clicked.
|
|
513
517
|
* @example
|
|
514
|
-
|
|
518
|
+
* ```js
|
|
515
519
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
516
520
|
* console.log(payload);
|
|
517
521
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -525,7 +529,7 @@ var EmbedEvent;
|
|
|
525
529
|
* autoDrillDown: true,
|
|
526
530
|
* })
|
|
527
531
|
* })
|
|
528
|
-
|
|
532
|
+
* ```
|
|
529
533
|
*/
|
|
530
534
|
EmbedEvent["Drilldown"] = "drillDown";
|
|
531
535
|
/**
|
|
@@ -650,13 +654,13 @@ var EmbedEvent;
|
|
|
650
654
|
* The ThoughtSpot authentication session has expired.
|
|
651
655
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
652
656
|
* @example
|
|
653
|
-
|
|
657
|
+
* ```js
|
|
654
658
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
655
659
|
* //show auth expired banner
|
|
656
660
|
* function showAuthExpired() {
|
|
657
661
|
* document.getElementById("authExpiredBanner");
|
|
658
662
|
* }
|
|
659
|
-
|
|
663
|
+
* ```
|
|
660
664
|
*/
|
|
661
665
|
EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
|
|
662
666
|
/**
|
|
@@ -691,22 +695,22 @@ var EmbedEvent;
|
|
|
691
695
|
* Applicable to `SearchBarEmbed` only.
|
|
692
696
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
693
697
|
* @example
|
|
694
|
-
|
|
698
|
+
* ```js
|
|
695
699
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
696
700
|
* .then(data => {
|
|
697
701
|
* console.log('Answer Data:', data);
|
|
698
702
|
* })
|
|
699
|
-
|
|
703
|
+
* ```
|
|
700
704
|
*/
|
|
701
705
|
EmbedEvent["GetDataClick"] = "getDataClick";
|
|
702
706
|
/**
|
|
703
707
|
* Detects the route change.
|
|
704
708
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
705
709
|
* @example
|
|
706
|
-
|
|
710
|
+
* ```js
|
|
707
711
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
708
712
|
* console.log('data', payload))
|
|
709
|
-
|
|
713
|
+
* ```
|
|
710
714
|
*/
|
|
711
715
|
EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
|
|
712
716
|
/**
|
|
@@ -716,12 +720,12 @@ var EmbedEvent;
|
|
|
716
720
|
EmbedEvent["V1Data"] = "exportVizDataToParent";
|
|
717
721
|
/**
|
|
718
722
|
* Emitted when the embed does not have cookie access. This happens
|
|
719
|
-
* when
|
|
720
|
-
*
|
|
723
|
+
* when third-party cookies are blocked by Safari or other
|
|
724
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
721
725
|
* @example
|
|
722
|
-
|
|
726
|
+
* ```js
|
|
723
727
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
724
|
-
|
|
728
|
+
* ```
|
|
725
729
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
726
730
|
*/
|
|
727
731
|
EmbedEvent["NoCookieAccess"] = "noCookieAccess";
|
|
@@ -735,22 +739,22 @@ var EmbedEvent;
|
|
|
735
739
|
* Emitted when any modal is opened in the app
|
|
736
740
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
737
741
|
* @example
|
|
738
|
-
|
|
742
|
+
* ```js
|
|
739
743
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
740
744
|
* console.log('dialog open', payload);
|
|
741
745
|
* })
|
|
742
|
-
|
|
746
|
+
* ```
|
|
743
747
|
*/
|
|
744
748
|
EmbedEvent["DialogOpen"] = "dialog-open";
|
|
745
749
|
/**
|
|
746
750
|
* Emitted when any modal is closed in the app
|
|
747
751
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
748
752
|
* @example
|
|
749
|
-
|
|
753
|
+
* ```js
|
|
750
754
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
751
755
|
* console.log('dialog close', payload);
|
|
752
756
|
* })
|
|
753
|
-
|
|
757
|
+
* ```
|
|
754
758
|
*/
|
|
755
759
|
EmbedEvent["DialogClose"] = "dialog-close";
|
|
756
760
|
/**
|
|
@@ -759,39 +763,39 @@ var EmbedEvent;
|
|
|
759
763
|
* other events on the rendered Liveboard.
|
|
760
764
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
761
765
|
* @example
|
|
762
|
-
|
|
766
|
+
* ```js
|
|
763
767
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
764
768
|
console.log('Liveboard is rendered', payload);
|
|
765
769
|
})
|
|
766
|
-
|
|
770
|
+
* ```
|
|
767
771
|
* The following example shows how to trigger
|
|
768
772
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
769
773
|
* @example
|
|
770
|
-
|
|
774
|
+
* ```js
|
|
771
775
|
* const embedRef = useEmbedRef();
|
|
772
776
|
* const onLiveboardRendered = () => {
|
|
773
777
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
774
778
|
* };
|
|
775
|
-
|
|
779
|
+
* ```
|
|
776
780
|
*/
|
|
777
781
|
EmbedEvent["LiveboardRendered"] = "PinboardRendered";
|
|
778
782
|
/**
|
|
779
783
|
* Emits all events.
|
|
780
|
-
* @
|
|
784
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
781
785
|
* @example
|
|
782
|
-
|
|
786
|
+
* ```js
|
|
783
787
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
784
788
|
* console.log('Embed Events', payload)
|
|
785
789
|
* })
|
|
786
|
-
|
|
790
|
+
* ```
|
|
787
791
|
*/
|
|
788
792
|
EmbedEvent["ALL"] = "*";
|
|
789
793
|
/**
|
|
790
794
|
* Emitted when an Answer is saved in the app.
|
|
791
795
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
792
|
-
* @
|
|
796
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
793
797
|
* @example
|
|
794
|
-
|
|
798
|
+
* ```js
|
|
795
799
|
* //Emit when action starts
|
|
796
800
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
797
801
|
* console.log('Save', payload)
|
|
@@ -802,7 +806,7 @@ var EmbedEvent;
|
|
|
802
806
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
803
807
|
* console.log('Save', payload)
|
|
804
808
|
* })
|
|
805
|
-
|
|
809
|
+
* ```
|
|
806
810
|
*/
|
|
807
811
|
EmbedEvent["Save"] = "save";
|
|
808
812
|
/**
|
|
@@ -814,11 +818,11 @@ var EmbedEvent;
|
|
|
814
818
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
815
819
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
816
820
|
* @example
|
|
817
|
-
|
|
821
|
+
* ```js
|
|
818
822
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
819
823
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
820
824
|
* })
|
|
821
|
-
|
|
825
|
+
* ```
|
|
822
826
|
*/
|
|
823
827
|
EmbedEvent["Download"] = "download";
|
|
824
828
|
/**
|
|
@@ -826,14 +830,14 @@ var EmbedEvent;
|
|
|
826
830
|
* Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
|
|
827
831
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
828
832
|
* @example
|
|
829
|
-
|
|
833
|
+
* ```js
|
|
830
834
|
* //emit when action starts
|
|
831
835
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
832
836
|
* console.log('download PNG', payload)}, {start: true })
|
|
833
837
|
* //emit when action ends
|
|
834
838
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
835
839
|
* console.log('download PNG', payload)})
|
|
836
|
-
|
|
840
|
+
* ```
|
|
837
841
|
*/
|
|
838
842
|
EmbedEvent["DownloadAsPng"] = "downloadAsPng";
|
|
839
843
|
/**
|
|
@@ -841,14 +845,14 @@ var EmbedEvent;
|
|
|
841
845
|
* 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.
|
|
842
846
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
843
847
|
* @example
|
|
844
|
-
|
|
848
|
+
* ```js
|
|
845
849
|
* //emit when action starts
|
|
846
850
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
847
851
|
* console.log('download PDF', payload)}, {start: true })
|
|
848
852
|
* //emit when action ends
|
|
849
853
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
850
854
|
* console.log('download PDF', payload)})
|
|
851
|
-
|
|
855
|
+
* ```
|
|
852
856
|
*/
|
|
853
857
|
EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
|
|
854
858
|
/**
|
|
@@ -856,14 +860,14 @@ var EmbedEvent;
|
|
|
856
860
|
* 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.
|
|
857
861
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
858
862
|
* @example
|
|
859
|
-
|
|
863
|
+
* ```js
|
|
860
864
|
* //emit when action starts
|
|
861
865
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
862
866
|
* console.log('download CSV', payload)}, {start: true })
|
|
863
867
|
* //emit when action ends
|
|
864
868
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
865
869
|
* console.log('download CSV', payload)})
|
|
866
|
-
|
|
870
|
+
* ```
|
|
867
871
|
*/
|
|
868
872
|
EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
|
|
869
873
|
/**
|
|
@@ -871,14 +875,14 @@ var EmbedEvent;
|
|
|
871
875
|
* 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.
|
|
872
876
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
873
877
|
* @example
|
|
874
|
-
|
|
878
|
+
* ```js
|
|
875
879
|
* //emit when action starts
|
|
876
880
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
877
881
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
878
882
|
* //emit when action ends
|
|
879
883
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
880
884
|
* console.log('download Xlsx', payload)})
|
|
881
|
-
|
|
885
|
+
* ```
|
|
882
886
|
*/
|
|
883
887
|
EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
|
|
884
888
|
/**
|
|
@@ -886,25 +890,25 @@ var EmbedEvent;
|
|
|
886
890
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
|
|
887
891
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
888
892
|
* @example
|
|
889
|
-
|
|
893
|
+
* ```js
|
|
890
894
|
* //emit when action starts
|
|
891
895
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
892
896
|
* console.log('delete answer', payload)}, {start: true })
|
|
893
897
|
* //trigger when action is completed
|
|
894
898
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
895
899
|
* console.log('delete answer', payload)})
|
|
896
|
-
|
|
900
|
+
* ```
|
|
897
901
|
*/
|
|
898
902
|
EmbedEvent["AnswerDelete"] = "answerDelete";
|
|
899
903
|
/**
|
|
900
904
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
901
905
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
902
906
|
* @example
|
|
903
|
-
|
|
907
|
+
* ```js
|
|
904
908
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
905
909
|
* console.log('AI Highlights', payload);
|
|
906
910
|
* })
|
|
907
|
-
|
|
911
|
+
* ```
|
|
908
912
|
*/
|
|
909
913
|
EmbedEvent["AIHighlights"] = "AIHighlights";
|
|
910
914
|
/**
|
|
@@ -913,7 +917,7 @@ var EmbedEvent;
|
|
|
913
917
|
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
|
|
914
918
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
915
919
|
* @example
|
|
916
|
-
|
|
920
|
+
* ```js
|
|
917
921
|
* //emit when action starts
|
|
918
922
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
919
923
|
* console.log('pin', payload)
|
|
@@ -924,14 +928,14 @@ var EmbedEvent;
|
|
|
924
928
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
925
929
|
* console.log('pin', payload)
|
|
926
930
|
* })
|
|
927
|
-
|
|
931
|
+
* ```
|
|
928
932
|
*/
|
|
929
933
|
EmbedEvent["Pin"] = "pin";
|
|
930
934
|
/**
|
|
931
935
|
* Emitted when SpotIQ analysis is triggered
|
|
932
936
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
933
937
|
* @example
|
|
934
|
-
|
|
938
|
+
* ```js
|
|
935
939
|
* //emit when action starts
|
|
936
940
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
937
941
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -942,14 +946,14 @@ var EmbedEvent;
|
|
|
942
946
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
943
947
|
* console.log('SpotIQ analyze', payload)
|
|
944
948
|
* })
|
|
945
|
-
|
|
949
|
+
* ```
|
|
946
950
|
*/
|
|
947
951
|
EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
|
|
948
952
|
/**
|
|
949
953
|
* Emitted when a user shares an object with another user or group
|
|
950
954
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
951
955
|
* @example
|
|
952
|
-
|
|
956
|
+
* ```js
|
|
953
957
|
* //emit when action starts
|
|
954
958
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
955
959
|
* console.log('Share', payload)
|
|
@@ -960,7 +964,7 @@ var EmbedEvent;
|
|
|
960
964
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
961
965
|
* console.log('Share', payload)
|
|
962
966
|
* })
|
|
963
|
-
|
|
967
|
+
* ```
|
|
964
968
|
*/
|
|
965
969
|
EmbedEvent["Share"] = "share";
|
|
966
970
|
/**
|
|
@@ -968,11 +972,11 @@ var EmbedEvent;
|
|
|
968
972
|
* data on a chart or table.
|
|
969
973
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
970
974
|
* @example
|
|
971
|
-
|
|
975
|
+
* ```js
|
|
972
976
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
973
977
|
* console.log('Drill include', payload);
|
|
974
978
|
* })
|
|
975
|
-
|
|
979
|
+
* ```
|
|
976
980
|
*/
|
|
977
981
|
EmbedEvent["DrillInclude"] = "context-menu-item-include";
|
|
978
982
|
/**
|
|
@@ -980,22 +984,22 @@ var EmbedEvent;
|
|
|
980
984
|
* data on a chart or table
|
|
981
985
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
982
986
|
* @example
|
|
983
|
-
|
|
987
|
+
* ```js
|
|
984
988
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
985
989
|
* console.log('Drill exclude', payload);
|
|
986
990
|
* })
|
|
987
|
-
|
|
991
|
+
* ```
|
|
988
992
|
*/
|
|
989
993
|
EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
|
|
990
994
|
/**
|
|
991
995
|
* Emitted when a column value is copied in the embedded app.
|
|
992
996
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
993
997
|
* @example
|
|
994
|
-
|
|
995
|
-
*
|
|
998
|
+
* ```js
|
|
999
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
996
1000
|
* console.log('copy to clipboard', payload);
|
|
997
1001
|
* })
|
|
998
|
-
|
|
1002
|
+
* ```
|
|
999
1003
|
*/
|
|
1000
1004
|
EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
|
|
1001
1005
|
/**
|
|
@@ -1003,10 +1007,10 @@ var EmbedEvent;
|
|
|
1003
1007
|
* embedded Liveboard.
|
|
1004
1008
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1005
1009
|
* @example
|
|
1006
|
-
|
|
1010
|
+
* ```js
|
|
1007
1011
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
1008
1012
|
* })
|
|
1009
|
-
|
|
1013
|
+
* ```
|
|
1010
1014
|
*/
|
|
1011
1015
|
EmbedEvent["UpdateTML"] = "updateTSL";
|
|
1012
1016
|
/**
|
|
@@ -1014,11 +1018,11 @@ var EmbedEvent;
|
|
|
1014
1018
|
* on an embedded Liveboard.
|
|
1015
1019
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1016
1020
|
* @example
|
|
1017
|
-
|
|
1021
|
+
* ```js
|
|
1018
1022
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
1019
1023
|
* console.log('Edit TML', payload);
|
|
1020
1024
|
* })
|
|
1021
|
-
|
|
1025
|
+
* ```
|
|
1022
1026
|
*/
|
|
1023
1027
|
EmbedEvent["EditTML"] = "editTSL";
|
|
1024
1028
|
/**
|
|
@@ -1027,25 +1031,25 @@ var EmbedEvent;
|
|
|
1027
1031
|
* Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
|
|
1028
1032
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1029
1033
|
* @example
|
|
1030
|
-
|
|
1034
|
+
* ```js
|
|
1031
1035
|
* //emit when action starts
|
|
1032
1036
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1033
1037
|
* console.log('Export TML', payload)}, { start: true })
|
|
1034
1038
|
* //emit when action ends
|
|
1035
1039
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1036
1040
|
* console.log('Export TML', payload)})
|
|
1037
|
-
|
|
1041
|
+
* ```
|
|
1038
1042
|
*/
|
|
1039
1043
|
EmbedEvent["ExportTML"] = "exportTSL";
|
|
1040
1044
|
/**
|
|
1041
1045
|
* Emitted when an Answer is saved as a View.
|
|
1042
1046
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1043
1047
|
* @example
|
|
1044
|
-
|
|
1048
|
+
* ```js
|
|
1045
1049
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
1046
1050
|
* console.log('View', payload);
|
|
1047
1051
|
* })
|
|
1048
|
-
|
|
1052
|
+
* ```
|
|
1049
1053
|
*/
|
|
1050
1054
|
EmbedEvent["SaveAsView"] = "saveAsView";
|
|
1051
1055
|
/**
|
|
@@ -1053,36 +1057,36 @@ var EmbedEvent;
|
|
|
1053
1057
|
* 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.
|
|
1054
1058
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1055
1059
|
* @example
|
|
1056
|
-
|
|
1060
|
+
* ```js
|
|
1057
1061
|
* //emit when action starts
|
|
1058
1062
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1059
1063
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
1060
1064
|
* //emit when action ends
|
|
1061
1065
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1062
1066
|
* console.log('Copy and edit', payload)})
|
|
1063
|
-
|
|
1067
|
+
* ```
|
|
1064
1068
|
*/
|
|
1065
1069
|
EmbedEvent["CopyAEdit"] = "copyAEdit";
|
|
1066
1070
|
/**
|
|
1067
1071
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
1068
1072
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1069
1073
|
* @example
|
|
1070
|
-
|
|
1074
|
+
* ```js
|
|
1071
1075
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
1072
1076
|
* console.log('show data', payload);
|
|
1073
1077
|
* })
|
|
1074
|
-
|
|
1078
|
+
* ```
|
|
1075
1079
|
*/
|
|
1076
1080
|
EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
|
|
1077
1081
|
/**
|
|
1078
1082
|
* Emitted when an Answer is switched to a chart or table view.
|
|
1079
1083
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1080
1084
|
* @example
|
|
1081
|
-
|
|
1085
|
+
* ```js
|
|
1082
1086
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
1083
1087
|
* console.log('switch view', payload);
|
|
1084
1088
|
* })
|
|
1085
|
-
|
|
1089
|
+
* ```
|
|
1086
1090
|
*/
|
|
1087
1091
|
EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
1088
1092
|
/**
|
|
@@ -1099,118 +1103,118 @@ var EmbedEvent;
|
|
|
1099
1103
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
1100
1104
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1101
1105
|
* @example
|
|
1102
|
-
|
|
1106
|
+
* ```js
|
|
1103
1107
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
1104
1108
|
* console.log('Liveboard details', payload);
|
|
1105
1109
|
* })
|
|
1106
|
-
|
|
1110
|
+
* ```
|
|
1107
1111
|
*/
|
|
1108
1112
|
EmbedEvent["LiveboardInfo"] = "pinboardInfo";
|
|
1109
1113
|
/**
|
|
1110
1114
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1111
1115
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1112
1116
|
* @example
|
|
1113
|
-
|
|
1117
|
+
* ```js
|
|
1114
1118
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
1115
1119
|
* console.log('favorites', payload);
|
|
1116
1120
|
* })
|
|
1117
|
-
|
|
1121
|
+
* ```
|
|
1118
1122
|
*/
|
|
1119
1123
|
EmbedEvent["AddToFavorites"] = "addToFavorites";
|
|
1120
1124
|
/**
|
|
1121
1125
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
1122
1126
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1123
1127
|
* @example
|
|
1124
|
-
|
|
1128
|
+
* ```js
|
|
1125
1129
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
1126
|
-
* console.log(
|
|
1130
|
+
* console.log('Liveboard schedule', payload);
|
|
1127
1131
|
* })
|
|
1128
|
-
|
|
1132
|
+
* ```
|
|
1129
1133
|
*/
|
|
1130
1134
|
EmbedEvent["Schedule"] = "subscription";
|
|
1131
1135
|
/**
|
|
1132
1136
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
1133
1137
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1134
1138
|
* @example
|
|
1135
|
-
|
|
1139
|
+
* ```js
|
|
1136
1140
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
1137
|
-
* console.log(
|
|
1141
|
+
* console.log('Liveboard edit', payload);
|
|
1138
1142
|
* })
|
|
1139
|
-
|
|
1143
|
+
* ```
|
|
1140
1144
|
*/
|
|
1141
1145
|
EmbedEvent["Edit"] = "edit";
|
|
1142
1146
|
/**
|
|
1143
1147
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
1144
1148
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1145
1149
|
* @example
|
|
1146
|
-
|
|
1150
|
+
* ```js
|
|
1147
1151
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
1148
|
-
* console.log(
|
|
1152
|
+
* console.log('Copy', payload);
|
|
1149
1153
|
* })
|
|
1150
|
-
|
|
1154
|
+
* ```
|
|
1151
1155
|
*/
|
|
1152
1156
|
EmbedEvent["MakeACopy"] = "makeACopy";
|
|
1153
1157
|
/**
|
|
1154
1158
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
1155
1159
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1156
1160
|
* @example
|
|
1157
|
-
|
|
1161
|
+
* ```js
|
|
1158
1162
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
1159
|
-
|
|
1163
|
+
* ```
|
|
1160
1164
|
* @example
|
|
1161
|
-
|
|
1165
|
+
* ```js
|
|
1162
1166
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
1163
1167
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1164
1168
|
* })
|
|
1165
|
-
|
|
1169
|
+
* ```
|
|
1166
1170
|
*/
|
|
1167
1171
|
EmbedEvent["Present"] = "present";
|
|
1168
1172
|
/**
|
|
1169
1173
|
* Emitted when a user clicks **Delete** on a visualization
|
|
1170
1174
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1171
1175
|
* @example
|
|
1172
|
-
|
|
1176
|
+
* ```js
|
|
1173
1177
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
1174
1178
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1175
|
-
|
|
1179
|
+
* ```
|
|
1176
1180
|
*/
|
|
1177
1181
|
EmbedEvent["Delete"] = "delete";
|
|
1178
1182
|
/**
|
|
1179
1183
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1180
1184
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1181
1185
|
* @example
|
|
1182
|
-
|
|
1186
|
+
* ```js
|
|
1183
1187
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
1184
|
-
|
|
1188
|
+
* ```
|
|
1185
1189
|
*/
|
|
1186
1190
|
EmbedEvent["SchedulesList"] = "schedule-list";
|
|
1187
1191
|
/**
|
|
1188
1192
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
1189
1193
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1190
1194
|
* @example
|
|
1191
|
-
|
|
1195
|
+
* ```js
|
|
1192
1196
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
1193
|
-
|
|
1197
|
+
* ```
|
|
1194
1198
|
*/
|
|
1195
1199
|
EmbedEvent["Cancel"] = "cancel";
|
|
1196
1200
|
/**
|
|
1197
1201
|
* Emitted when a user clicks **Explore** on a visualization
|
|
1198
1202
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1199
1203
|
* @example
|
|
1200
|
-
|
|
1204
|
+
* ```js
|
|
1201
1205
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
1202
1206
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1203
|
-
|
|
1207
|
+
* ```
|
|
1204
1208
|
*/
|
|
1205
1209
|
EmbedEvent["Explore"] = "explore";
|
|
1206
1210
|
/**
|
|
1207
1211
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
1208
1212
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1209
1213
|
* @example
|
|
1210
|
-
|
|
1214
|
+
* ```js
|
|
1211
1215
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
1212
1216
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1213
|
-
|
|
1217
|
+
* ```
|
|
1214
1218
|
*/
|
|
1215
1219
|
EmbedEvent["CopyLink"] = "embedDocument";
|
|
1216
1220
|
/**
|
|
@@ -1218,21 +1222,21 @@ var EmbedEvent;
|
|
|
1218
1222
|
* visualization or Liveboard.
|
|
1219
1223
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1220
1224
|
* @example
|
|
1221
|
-
|
|
1225
|
+
* ```js
|
|
1222
1226
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
1223
1227
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1224
|
-
|
|
1228
|
+
* ```
|
|
1225
1229
|
*/
|
|
1226
1230
|
EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
|
|
1227
1231
|
/**
|
|
1228
1232
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
1229
1233
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1230
1234
|
* @example
|
|
1231
|
-
|
|
1235
|
+
* ```js
|
|
1232
1236
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
1233
1237
|
* console.log('VizPointClick', payload)
|
|
1234
1238
|
* })
|
|
1235
|
-
|
|
1239
|
+
* ```
|
|
1236
1240
|
*/
|
|
1237
1241
|
EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
|
|
1238
1242
|
/**
|
|
@@ -1246,35 +1250,35 @@ var EmbedEvent;
|
|
|
1246
1250
|
* filter details.
|
|
1247
1251
|
* @example
|
|
1248
1252
|
*
|
|
1249
|
-
|
|
1253
|
+
* ```js
|
|
1250
1254
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1251
1255
|
* console.log('payload', payload);
|
|
1252
1256
|
* })
|
|
1253
|
-
*
|
|
1257
|
+
* ```
|
|
1254
1258
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
1255
1259
|
*/
|
|
1256
1260
|
EmbedEvent["FilterChanged"] = "filterChanged";
|
|
1257
1261
|
/**
|
|
1258
1262
|
* Emitted when a user clicks the **Go** button to initiate
|
|
1259
1263
|
* a Natural Language Search query
|
|
1260
|
-
* @version SDK
|
|
1264
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1261
1265
|
*/
|
|
1262
1266
|
EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
|
|
1263
1267
|
/**
|
|
1264
1268
|
* Emitted when a user selects a data source on the embedded
|
|
1265
1269
|
* Natural Language Search interface.
|
|
1266
1270
|
*
|
|
1267
|
-
* @version SDK
|
|
1271
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1268
1272
|
*/
|
|
1269
1273
|
EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
|
|
1270
1274
|
/**
|
|
1271
1275
|
* Emitted when a user updates a connection on the **Data** page
|
|
1272
|
-
* @version SDK
|
|
1276
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1273
1277
|
*/
|
|
1274
1278
|
EmbedEvent["UpdateConnection"] = "updateConnection";
|
|
1275
1279
|
/**
|
|
1276
1280
|
* Emitted when a user updates a connection on the **Data** page
|
|
1277
|
-
* @version SDK
|
|
1281
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1278
1282
|
*/
|
|
1279
1283
|
EmbedEvent["CreateConnection"] = "createConnection";
|
|
1280
1284
|
/**
|
|
@@ -1284,7 +1288,7 @@ var EmbedEvent;
|
|
|
1284
1288
|
* @returns viewId: string
|
|
1285
1289
|
* @returns liveboardId: string
|
|
1286
1290
|
* @returns isPublic: boolean
|
|
1287
|
-
* @version SDK
|
|
1291
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1288
1292
|
*/
|
|
1289
1293
|
EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
|
|
1290
1294
|
/**
|
|
@@ -1293,7 +1297,7 @@ var EmbedEvent;
|
|
|
1293
1297
|
* @returns viewId: string
|
|
1294
1298
|
* @returns liveboardId: string
|
|
1295
1299
|
* @returns isPublic: boolean
|
|
1296
|
-
* @version SDK
|
|
1300
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1297
1301
|
*/
|
|
1298
1302
|
EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
|
|
1299
1303
|
/**
|
|
@@ -1302,19 +1306,19 @@ var EmbedEvent;
|
|
|
1302
1306
|
* @returns viewId: string
|
|
1303
1307
|
* @returns liveboardId: string
|
|
1304
1308
|
* @returns isPublic: boolean
|
|
1305
|
-
* @version SDK
|
|
1309
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1306
1310
|
*/
|
|
1307
1311
|
EmbedEvent["ResetLiveboard"] = "resetLiveboard";
|
|
1308
1312
|
/**
|
|
1309
1313
|
* Emitted when a PersonalisedView is deleted.
|
|
1310
1314
|
* @returns views: string[]
|
|
1311
1315
|
* @returns liveboardId: string
|
|
1312
|
-
* @version SDK
|
|
1316
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1313
1317
|
*/
|
|
1314
1318
|
EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
|
|
1315
1319
|
/**
|
|
1316
1320
|
* Emitted when a user creates a Worksheet.
|
|
1317
|
-
* @version SDK
|
|
1321
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1318
1322
|
*/
|
|
1319
1323
|
EmbedEvent["CreateWorksheet"] = "createWorksheet";
|
|
1320
1324
|
/**
|
|
@@ -1323,12 +1327,12 @@ var EmbedEvent;
|
|
|
1323
1327
|
* @returns viewId: string
|
|
1324
1328
|
* @returns liveboardId: string
|
|
1325
1329
|
* @returns isPublic: boolean
|
|
1326
|
-
* @version SDK
|
|
1330
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
1327
1331
|
*/
|
|
1328
1332
|
EmbedEvent["AskSageInit"] = "AskSageInit";
|
|
1329
1333
|
/**
|
|
1330
1334
|
* Emitted when a Liveboard or visualization is renamed.
|
|
1331
|
-
* @version SDK
|
|
1335
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
1332
1336
|
*/
|
|
1333
1337
|
EmbedEvent["Rename"] = "rename";
|
|
1334
1338
|
/**
|
|
@@ -1351,7 +1355,7 @@ var EmbedEvent;
|
|
|
1351
1355
|
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
1352
1356
|
* is `false` by using the `error` parameters in `responder`.
|
|
1353
1357
|
* - `errorText` - The error message text shown to the user.
|
|
1354
|
-
* @version SDK
|
|
1358
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1355
1359
|
* @example
|
|
1356
1360
|
*
|
|
1357
1361
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -1403,8 +1407,8 @@ var EmbedEvent;
|
|
|
1403
1407
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
1404
1408
|
* console.log('payload', payload);
|
|
1405
1409
|
* })
|
|
1406
|
-
|
|
1407
|
-
* @version SDK
|
|
1410
|
+
* ```
|
|
1411
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1408
1412
|
*/
|
|
1409
1413
|
EmbedEvent["ParameterChanged"] = "parameterChanged";
|
|
1410
1414
|
/**
|
|
@@ -1459,24 +1463,24 @@ var EmbedEvent;
|
|
|
1459
1463
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
1460
1464
|
* console.log('payload', payload);
|
|
1461
1465
|
* })
|
|
1462
|
-
|
|
1463
|
-
* @version SDK
|
|
1466
|
+
* ```
|
|
1467
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1464
1468
|
*/
|
|
1465
1469
|
EmbedEvent["CreateLiveboard"] = "createLiveboard";
|
|
1466
1470
|
/**
|
|
1467
1471
|
* Emitted when a user creates a Model.
|
|
1468
|
-
* @version SDK
|
|
1472
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1469
1473
|
*/
|
|
1470
1474
|
EmbedEvent["CreateModel"] = "createModel";
|
|
1471
1475
|
/**
|
|
1472
1476
|
* @hidden
|
|
1473
1477
|
* Emitted when a user exits present mode.
|
|
1474
|
-
* @version SDK
|
|
1478
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1475
1479
|
*/
|
|
1476
1480
|
EmbedEvent["ExitPresentMode"] = "exitPresentMode";
|
|
1477
1481
|
/**
|
|
1478
1482
|
* Emitted when a user requests the full height lazy load data.
|
|
1479
|
-
* @version SDK
|
|
1483
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1480
1484
|
* @hidden
|
|
1481
1485
|
*/
|
|
1482
1486
|
EmbedEvent["RequestVisibleEmbedCoordinates"] = "requestVisibleEmbedCoordinates";
|
|
@@ -1487,7 +1491,7 @@ var EmbedEvent;
|
|
|
1487
1491
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
1488
1492
|
* console.log('payload', payload);
|
|
1489
1493
|
* })
|
|
1490
|
-
|
|
1494
|
+
* ```
|
|
1491
1495
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1492
1496
|
*/
|
|
1493
1497
|
EmbedEvent["SpotterData"] = "SpotterData";
|
|
@@ -1498,7 +1502,7 @@ var EmbedEvent;
|
|
|
1498
1502
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
1499
1503
|
* console.log('payload', payload);
|
|
1500
1504
|
* })
|
|
1501
|
-
|
|
1505
|
+
* ```
|
|
1502
1506
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1503
1507
|
*/
|
|
1504
1508
|
EmbedEvent["PreviewSpotterData"] = "PreviewSpotterData";
|
|
@@ -1509,7 +1513,7 @@ var EmbedEvent;
|
|
|
1509
1513
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
1510
1514
|
* console.log('payload', payload);
|
|
1511
1515
|
* })
|
|
1512
|
-
|
|
1516
|
+
* ```
|
|
1513
1517
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
1514
1518
|
*/
|
|
1515
1519
|
EmbedEvent["AddToCoaching"] = "addToCoaching";
|
|
@@ -1531,7 +1535,7 @@ var EmbedEvent;
|
|
|
1531
1535
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
1532
1536
|
* console.log('payload', payload);
|
|
1533
1537
|
* })
|
|
1534
|
-
|
|
1538
|
+
* ```
|
|
1535
1539
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1536
1540
|
*/
|
|
1537
1541
|
EmbedEvent["SpotterQueryTriggered"] = "SpotterQueryTriggered";
|
|
@@ -1542,7 +1546,7 @@ var EmbedEvent;
|
|
|
1542
1546
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
1543
1547
|
* console.log('payload', payload);
|
|
1544
1548
|
* })
|
|
1545
|
-
|
|
1549
|
+
* ```
|
|
1546
1550
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1547
1551
|
*/
|
|
1548
1552
|
EmbedEvent["LastPromptEdited"] = "LastPromptEdited";
|
|
@@ -1553,18 +1557,18 @@ var EmbedEvent;
|
|
|
1553
1557
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
1554
1558
|
* console.log('payload', payload);
|
|
1555
1559
|
* })
|
|
1556
|
-
|
|
1560
|
+
* ```
|
|
1557
1561
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1558
1562
|
*/
|
|
1559
1563
|
EmbedEvent["LastPromptDeleted"] = "LastPromptDeleted";
|
|
1560
1564
|
/**
|
|
1561
|
-
* Emitted when the
|
|
1565
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
1562
1566
|
* @example
|
|
1563
1567
|
* ```js
|
|
1564
1568
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
1565
1569
|
* console.log('payload', payload);
|
|
1566
1570
|
* })
|
|
1567
|
-
|
|
1571
|
+
* ```
|
|
1568
1572
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1569
1573
|
*/
|
|
1570
1574
|
EmbedEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
|
|
@@ -1575,7 +1579,7 @@ var EmbedEvent;
|
|
|
1575
1579
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
1576
1580
|
* console.log('payload', payload);
|
|
1577
1581
|
* })
|
|
1578
|
-
|
|
1582
|
+
* ```
|
|
1579
1583
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
1580
1584
|
*/
|
|
1581
1585
|
EmbedEvent["SpotterInit"] = "spotterInit";
|
|
@@ -1586,7 +1590,7 @@ var EmbedEvent;
|
|
|
1586
1590
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
1587
1591
|
* console.log('payload', payload);
|
|
1588
1592
|
* })
|
|
1589
|
-
|
|
1593
|
+
* ```
|
|
1590
1594
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
1591
1595
|
*/
|
|
1592
1596
|
EmbedEvent["SpotterLoadComplete"] = "spotterLoadComplete";
|
|
@@ -1941,7 +1945,7 @@ var HostEvent;
|
|
|
1941
1945
|
* ```js
|
|
1942
1946
|
* appEmbed.navigateToPage(-1)
|
|
1943
1947
|
* ```
|
|
1944
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
1948
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1945
1949
|
*/
|
|
1946
1950
|
HostEvent["Navigate"] = "Navigate";
|
|
1947
1951
|
/**
|
|
@@ -2074,9 +2078,9 @@ var HostEvent;
|
|
|
2074
2078
|
* Trigger the **Show Liveboard details** action
|
|
2075
2079
|
* on an embedded Liveboard.
|
|
2076
2080
|
* @example
|
|
2077
|
-
|
|
2081
|
+
* ```js
|
|
2078
2082
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
2079
|
-
|
|
2083
|
+
* ```
|
|
2080
2084
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2081
2085
|
*/
|
|
2082
2086
|
HostEvent["LiveboardInfo"] = "pinboardInfo";
|
|
@@ -2204,7 +2208,7 @@ var HostEvent;
|
|
|
2204
2208
|
* appEmbed.trigger(HostEvent.Remove)
|
|
2205
2209
|
* ```
|
|
2206
2210
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2207
|
-
*
|
|
2211
|
+
* @example
|
|
2208
2212
|
* ```js
|
|
2209
2213
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
2210
2214
|
* ```
|
|
@@ -2295,7 +2299,7 @@ var HostEvent;
|
|
|
2295
2299
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2296
2300
|
* ```
|
|
2297
2301
|
* ```js
|
|
2298
|
-
* vizEmbed.trigger(
|
|
2302
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
2299
2303
|
* ```
|
|
2300
2304
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2301
2305
|
*/
|
|
@@ -2312,7 +2316,7 @@ var HostEvent;
|
|
|
2312
2316
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2313
2317
|
* ```
|
|
2314
2318
|
* ```js
|
|
2315
|
-
* vizEmbed.trigger(
|
|
2319
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
2316
2320
|
* ```
|
|
2317
2321
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2318
2322
|
*/
|
|
@@ -2327,23 +2331,22 @@ var HostEvent;
|
|
|
2327
2331
|
* );
|
|
2328
2332
|
* })
|
|
2329
2333
|
* ```
|
|
2330
|
-
*
|
|
2334
|
+
* @example
|
|
2331
2335
|
* ```js
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
|
-
|
|
2339
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
2336
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
2337
|
+
* let latestSpotterVizId = '';
|
|
2338
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
2339
|
+
* latestSpotterVizId = payload.data.id;
|
|
2340
|
+
* });
|
|
2341
|
+
*
|
|
2342
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
2340
2343
|
* vizId: latestSpotterVizId
|
|
2341
2344
|
* }).then((tml) => {
|
|
2342
2345
|
* console.log(
|
|
2343
2346
|
* tml.answer.search_query // TML representation of the search query
|
|
2344
2347
|
* );
|
|
2345
2348
|
* })
|
|
2346
|
-
|
|
2349
|
+
* ```
|
|
2347
2350
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2348
2351
|
* @important
|
|
2349
2352
|
*/
|
|
@@ -2407,6 +2410,11 @@ var HostEvent;
|
|
|
2407
2410
|
/**
|
|
2408
2411
|
* Trigger the **Download** action on charts in
|
|
2409
2412
|
* the embedded view.
|
|
2413
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
2414
|
+
*
|
|
2415
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2416
|
+
*
|
|
2417
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2410
2418
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
2411
2419
|
* @example
|
|
2412
2420
|
* ```js
|
|
@@ -2425,9 +2433,6 @@ var HostEvent;
|
|
|
2425
2433
|
*
|
|
2426
2434
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
2427
2435
|
* ```
|
|
2428
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2429
|
-
* Use {@link DownloadAsPng}
|
|
2430
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2431
2436
|
*/
|
|
2432
2437
|
HostEvent["Download"] = "downloadAsPng";
|
|
2433
2438
|
/**
|
|
@@ -2865,8 +2870,8 @@ var HostEvent;
|
|
|
2865
2870
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
2866
2871
|
* console.log('parameters', parameter);
|
|
2867
2872
|
* });
|
|
2868
|
-
|
|
2869
|
-
|
|
2873
|
+
* ```
|
|
2874
|
+
* ```js
|
|
2870
2875
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
2871
2876
|
* let latestSpotterVizId = '';
|
|
2872
2877
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -2874,7 +2879,7 @@ var HostEvent;
|
|
|
2874
2879
|
* });
|
|
2875
2880
|
*
|
|
2876
2881
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
2877
|
-
|
|
2882
|
+
* ```
|
|
2878
2883
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
2879
2884
|
*/
|
|
2880
2885
|
HostEvent["GetParameters"] = "GetParameters";
|
|
@@ -2891,7 +2896,7 @@ var HostEvent;
|
|
|
2891
2896
|
* Notify when info call is completed successfully
|
|
2892
2897
|
* ```js
|
|
2893
2898
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
2894
|
-
|
|
2899
|
+
* ```
|
|
2895
2900
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2896
2901
|
*/
|
|
2897
2902
|
HostEvent["InfoSuccess"] = "InfoSuccess";
|
|
@@ -2994,7 +2999,7 @@ var HostEvent;
|
|
|
2994
2999
|
* ```js
|
|
2995
3000
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
2996
3001
|
*
|
|
2997
|
-
|
|
3002
|
+
* ```
|
|
2998
3003
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
2999
3004
|
*/
|
|
3000
3005
|
HostEvent["AddToCoaching"] = "addToCoaching";
|
|
@@ -3036,7 +3041,7 @@ var HostEvent;
|
|
|
3036
3041
|
* });
|
|
3037
3042
|
*
|
|
3038
3043
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
3039
|
-
|
|
3044
|
+
* ```
|
|
3040
3045
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3041
3046
|
*/
|
|
3042
3047
|
HostEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
@@ -3046,7 +3051,7 @@ var HostEvent;
|
|
|
3046
3051
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
3047
3052
|
* ```js
|
|
3048
3053
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
3049
|
-
|
|
3054
|
+
* ```
|
|
3050
3055
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3051
3056
|
*/
|
|
3052
3057
|
HostEvent["ExitPresentMode"] = "exitPresentMode";
|
|
@@ -3196,6 +3201,7 @@ var Param;
|
|
|
3196
3201
|
// 'both' clicks in `contextMenuTrigger` configuration.
|
|
3197
3202
|
Param["ContextMenuTrigger"] = "contextMenuEnabledOnWhichClick";
|
|
3198
3203
|
Param["LinkOverride"] = "linkOverride";
|
|
3204
|
+
Param["EnableLinkOverridesV2"] = "enableLinkOverridesV2";
|
|
3199
3205
|
Param["blockNonEmbedFullAppAccess"] = "blockNonEmbedFullAppAccess";
|
|
3200
3206
|
Param["ShowInsertToSlide"] = "insertInToSlide";
|
|
3201
3207
|
Param["PrimaryNavHidden"] = "primaryNavHidden";
|
|
@@ -3290,6 +3296,7 @@ var Param;
|
|
|
3290
3296
|
Param["IsThisPeriodInDateFiltersEnabled"] = "isThisPeriodInDateFiltersEnabled";
|
|
3291
3297
|
Param["HideToolResponseCardBranding"] = "hideToolResponseCardBranding";
|
|
3292
3298
|
Param["ToolResponseCardBrandingLabel"] = "toolResponseCardBrandingLabel";
|
|
3299
|
+
Param["EnableHomepageAnnouncement"] = "enableHomepageAnnouncement";
|
|
3293
3300
|
})(Param || (Param = {}));
|
|
3294
3301
|
/**
|
|
3295
3302
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3449,14 +3456,14 @@ var Action;
|
|
|
3449
3456
|
* ```js
|
|
3450
3457
|
* disabledActions: [Action.CollapseDataPanel]
|
|
3451
3458
|
* ```
|
|
3452
|
-
* @version
|
|
3459
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
3453
3460
|
*/
|
|
3454
3461
|
Action["CollapseDataSources"] = "collapseDataSources";
|
|
3455
3462
|
/**
|
|
3456
3463
|
* The **Collapse data panel** icon on the Search page.
|
|
3457
3464
|
* Collapses the data panel view.
|
|
3458
3465
|
*
|
|
3459
|
-
* @version
|
|
3466
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
3460
3467
|
*
|
|
3461
3468
|
* @example
|
|
3462
3469
|
* ```js
|
|
@@ -3903,13 +3910,12 @@ var Action;
|
|
|
3903
3910
|
*/
|
|
3904
3911
|
Action["CreateMonitor"] = "createMonitor";
|
|
3905
3912
|
/**
|
|
3906
|
-
* @
|
|
3907
|
-
*
|
|
3913
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3914
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
3908
3915
|
* @example
|
|
3909
3916
|
* ```js
|
|
3910
3917
|
* disabledActions: [Action.ReportError]
|
|
3911
3918
|
* ```
|
|
3912
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3913
3919
|
*/
|
|
3914
3920
|
Action["ReportError"] = "reportError";
|
|
3915
3921
|
/**
|
|
@@ -3919,7 +3925,7 @@ var Action;
|
|
|
3919
3925
|
* ```js
|
|
3920
3926
|
* disabledActions: [Action.SyncToSheets]
|
|
3921
3927
|
* ```
|
|
3922
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3928
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3923
3929
|
*/
|
|
3924
3930
|
Action["SyncToSheets"] = "sync-to-sheets";
|
|
3925
3931
|
/**
|
|
@@ -3930,7 +3936,7 @@ var Action;
|
|
|
3930
3936
|
* ```js
|
|
3931
3937
|
* disabledActions: [Action.SyncToOtherApps]
|
|
3932
3938
|
* ```
|
|
3933
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3939
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3934
3940
|
*/
|
|
3935
3941
|
Action["SyncToOtherApps"] = "sync-to-other-apps";
|
|
3936
3942
|
/**
|
|
@@ -3940,7 +3946,7 @@ var Action;
|
|
|
3940
3946
|
* ```js
|
|
3941
3947
|
* disabledActions: [Action.ManagePipelines]
|
|
3942
3948
|
* ```
|
|
3943
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3949
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3944
3950
|
*/
|
|
3945
3951
|
Action["ManagePipelines"] = "manage-pipeline";
|
|
3946
3952
|
/**
|
|
@@ -4252,7 +4258,7 @@ var Action;
|
|
|
4252
4258
|
* ```js
|
|
4253
4259
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
4254
4260
|
* ```
|
|
4255
|
-
* @version SDK
|
|
4261
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4256
4262
|
*/
|
|
4257
4263
|
Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
|
|
4258
4264
|
/**
|
|
@@ -4262,7 +4268,7 @@ var Action;
|
|
|
4262
4268
|
* ```js
|
|
4263
4269
|
* disabledActions: [Action.LiveboardUsers]
|
|
4264
4270
|
* ```
|
|
4265
|
-
* @version SDK
|
|
4271
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4266
4272
|
*/
|
|
4267
4273
|
Action["LiveboardUsers"] = "liveboardUsers";
|
|
4268
4274
|
/**
|
|
@@ -4280,7 +4286,7 @@ var Action;
|
|
|
4280
4286
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
4281
4287
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
4282
4288
|
* ```
|
|
4283
|
-
* @version SDK
|
|
4289
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
4284
4290
|
*/
|
|
4285
4291
|
Action["TML"] = "tml";
|
|
4286
4292
|
/**
|
|
@@ -4326,7 +4332,7 @@ var Action;
|
|
|
4326
4332
|
* ```js
|
|
4327
4333
|
* disabledActions: [Action.AddToWatchlist]
|
|
4328
4334
|
* ```
|
|
4329
|
-
* @version SDK
|
|
4335
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
4330
4336
|
*/
|
|
4331
4337
|
Action["AddToWatchlist"] = "addToWatchlist";
|
|
4332
4338
|
/**
|
|
@@ -4336,7 +4342,7 @@ var Action;
|
|
|
4336
4342
|
* ```js
|
|
4337
4343
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
4338
4344
|
* ```
|
|
4339
|
-
* @version SDK
|
|
4345
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
4340
4346
|
*/
|
|
4341
4347
|
Action["RemoveFromWatchlist"] = "removeFromWatchlist";
|
|
4342
4348
|
/**
|
|
@@ -4347,7 +4353,7 @@ var Action;
|
|
|
4347
4353
|
* ```js
|
|
4348
4354
|
* disabledActions: [Action.OrganiseFavourites]
|
|
4349
4355
|
* ```
|
|
4350
|
-
* @version SDK
|
|
4356
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
4351
4357
|
*/
|
|
4352
4358
|
Action["OrganiseFavourites"] = "organiseFavourites";
|
|
4353
4359
|
/**
|
|
@@ -4408,7 +4414,7 @@ var Action;
|
|
|
4408
4414
|
* ```js
|
|
4409
4415
|
* disabledActions: [Action.ManageTags]
|
|
4410
4416
|
* ```
|
|
4411
|
-
* @version SDK
|
|
4417
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4412
4418
|
*/
|
|
4413
4419
|
Action["ManageTags"] = "manageTags";
|
|
4414
4420
|
/**
|
|
@@ -5408,7 +5414,7 @@ const getCssDimension = (value) => {
|
|
|
5408
5414
|
* @returns true if the value is a valid CSS margin value, false otherwise
|
|
5409
5415
|
*/
|
|
5410
5416
|
const isValidCssMargin = (value) => {
|
|
5411
|
-
if (isUndefined
|
|
5417
|
+
if (isUndefined(value)) {
|
|
5412
5418
|
return false;
|
|
5413
5419
|
}
|
|
5414
5420
|
if (typeof value !== 'string') {
|
|
@@ -5596,7 +5602,7 @@ const removeStyleProperties = (element, styleProperties) => {
|
|
|
5596
5602
|
element.style.removeProperty(styleProperty);
|
|
5597
5603
|
});
|
|
5598
5604
|
};
|
|
5599
|
-
const isUndefined
|
|
5605
|
+
const isUndefined = (value) => value === undefined;
|
|
5600
5606
|
// Return if the value is a string, double or boolean.
|
|
5601
5607
|
const getTypeFromValue = (value) => {
|
|
5602
5608
|
if (typeof value === 'string') {
|
|
@@ -5793,6 +5799,14 @@ const validateHttpUrl = (url) => {
|
|
|
5793
5799
|
return [false, error instanceof Error ? error : new Error(String(error))];
|
|
5794
5800
|
}
|
|
5795
5801
|
};
|
|
5802
|
+
/**
|
|
5803
|
+
* Resolves enablePastConversationsSidebar with
|
|
5804
|
+
* spotterSidebarConfig taking precedence over the
|
|
5805
|
+
* standalone flag.
|
|
5806
|
+
*/
|
|
5807
|
+
const resolveEnablePastConversationsSidebar = (params) => (params.spotterSidebarConfigValue !== undefined
|
|
5808
|
+
? params.spotterSidebarConfigValue
|
|
5809
|
+
: params.standaloneValue);
|
|
5796
5810
|
/**
|
|
5797
5811
|
* Sets a query parameter if the value is defined.
|
|
5798
5812
|
* @param queryParams - The query params object to modify
|
|
@@ -8373,7 +8387,7 @@ const setEmbedConfig = (newConfig) => {
|
|
|
8373
8387
|
* tokenizedFetch("<TS_ORIGIN>/api/rest/2.0/auth/session/user", {
|
|
8374
8388
|
* // .. fetch options ..
|
|
8375
8389
|
* });
|
|
8376
|
-
|
|
8390
|
+
* ```
|
|
8377
8391
|
* @version SDK: 1.28.0
|
|
8378
8392
|
* @group Global methods
|
|
8379
8393
|
*/
|
|
@@ -8713,6 +8727,7 @@ var OperationType;
|
|
|
8713
8727
|
OperationType["GetChartWithData"] = "GetChartWithData";
|
|
8714
8728
|
OperationType["GetTableWithHeadlineData"] = "GetTableWithHeadlineData";
|
|
8715
8729
|
})(OperationType || (OperationType = {}));
|
|
8730
|
+
const DATA_TYPES = ['DATE', 'DATE_TIME', 'TIME'];
|
|
8716
8731
|
/**
|
|
8717
8732
|
* AnswerService provides a simple way to work with ThoughtSpot Answers.
|
|
8718
8733
|
*
|
|
@@ -8758,7 +8773,7 @@ var OperationType;
|
|
|
8758
8773
|
* });
|
|
8759
8774
|
* ```
|
|
8760
8775
|
*
|
|
8761
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
8776
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
8762
8777
|
* @group Events
|
|
8763
8778
|
*/
|
|
8764
8779
|
class AnswerService {
|
|
@@ -8819,6 +8834,7 @@ class AnswerService {
|
|
|
8819
8834
|
* ]);
|
|
8820
8835
|
* console.log(await service.fetchData());
|
|
8821
8836
|
* });
|
|
8837
|
+
* ```
|
|
8822
8838
|
*/
|
|
8823
8839
|
async addColumnsByName(columnNames) {
|
|
8824
8840
|
const sourceDetail = await this.getSourceDetail();
|
|
@@ -8949,7 +8965,7 @@ class AnswerService {
|
|
|
8949
8965
|
* const data = await underlying.fetchData(0, 100);
|
|
8950
8966
|
* })
|
|
8951
8967
|
* ```
|
|
8952
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
8968
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
8953
8969
|
*/
|
|
8954
8970
|
async getUnderlyingDataForPoint(outputColumnNames, selectedPoints) {
|
|
8955
8971
|
if (!selectedPoints && !this.selectedPoints) {
|
|
@@ -9017,7 +9033,7 @@ class AnswerService {
|
|
|
9017
9033
|
async getTML() {
|
|
9018
9034
|
const { object } = await this.executeQuery(getAnswerTML, {});
|
|
9019
9035
|
const edoc = object[0].edoc;
|
|
9020
|
-
const YAML = await import('./index-
|
|
9036
|
+
const YAML = await import('./index-DkizS4xM.js');
|
|
9021
9037
|
const parsedDoc = YAML.parse(edoc);
|
|
9022
9038
|
return {
|
|
9023
9039
|
answer: {
|
|
@@ -9068,7 +9084,7 @@ function getSelectedPointsForUnderlyingDataQuery(selectedPoints) {
|
|
|
9068
9084
|
const dataType = colVal.column.dataType;
|
|
9069
9085
|
colVal.column.id;
|
|
9070
9086
|
let dataValue;
|
|
9071
|
-
if (dataType
|
|
9087
|
+
if (DATA_TYPES.includes(dataType)) {
|
|
9072
9088
|
if (Number.isFinite(colVal.value)) {
|
|
9073
9089
|
dataValue = [{
|
|
9074
9090
|
epochRange: {
|
|
@@ -17521,20 +17537,45 @@ var AuthFailureType;
|
|
|
17521
17537
|
var AuthStatus;
|
|
17522
17538
|
(function (AuthStatus) {
|
|
17523
17539
|
/**
|
|
17524
|
-
* Emits when the SDK fails to authenticate
|
|
17540
|
+
* Emits when the SDK fails to authenticate.
|
|
17525
17541
|
*/
|
|
17526
17542
|
AuthStatus["FAILURE"] = "FAILURE";
|
|
17527
17543
|
/**
|
|
17528
|
-
* Emits when the SDK
|
|
17544
|
+
* Emits when the SDK authentication step completes
|
|
17545
|
+
* successfully (e.g., token exchange, cookie set).
|
|
17546
|
+
* This fires before any iframe is rendered. Use
|
|
17547
|
+
* this to know that auth passed and it is safe to
|
|
17548
|
+
* proceed with rendering. The callback receives no
|
|
17549
|
+
* arguments.
|
|
17550
|
+
* @example
|
|
17551
|
+
* ```js
|
|
17552
|
+
* const authEE = init({ ... });
|
|
17553
|
+
* authEE.on(AuthStatus.SDK_SUCCESS, () => {
|
|
17554
|
+
* // Auth done, iframe not loaded yet
|
|
17555
|
+
* });
|
|
17556
|
+
* ```
|
|
17529
17557
|
*/
|
|
17530
17558
|
AuthStatus["SDK_SUCCESS"] = "SDK_SUCCESS";
|
|
17531
17559
|
/**
|
|
17532
17560
|
* @hidden
|
|
17533
|
-
* Emits when iframe is loaded and session
|
|
17561
|
+
* Emits when iframe is loaded and session
|
|
17562
|
+
* information is available.
|
|
17534
17563
|
*/
|
|
17535
17564
|
AuthStatus["SESSION_INFO_SUCCESS"] = "SESSION_INFO_SUCCESS";
|
|
17536
17565
|
/**
|
|
17537
|
-
* Emits when the app
|
|
17566
|
+
* Emits when the ThoughtSpot app inside the
|
|
17567
|
+
* embedded iframe confirms its session is active.
|
|
17568
|
+
* This fires after the iframe loads and sends back an `AuthInit` event.
|
|
17569
|
+
* @param sessionInfo Information about the user session, with details like `userGUID`.
|
|
17570
|
+
* @see EmbedEvent.AuthInit
|
|
17571
|
+
* @example
|
|
17572
|
+
* ```js
|
|
17573
|
+
* const authEE = init({ ... });
|
|
17574
|
+
* authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
|
|
17575
|
+
* // App is loaded and authenticated
|
|
17576
|
+
* console.log(sessionInfo.userGUID);
|
|
17577
|
+
* });
|
|
17578
|
+
* ```
|
|
17538
17579
|
*/
|
|
17539
17580
|
AuthStatus["SUCCESS"] = "SUCCESS";
|
|
17540
17581
|
/**
|
|
@@ -18242,7 +18283,7 @@ const renderInQueue = (fn) => {
|
|
|
18242
18283
|
* }).catch(error => {
|
|
18243
18284
|
* console.error(error);
|
|
18244
18285
|
* });
|
|
18245
|
-
|
|
18286
|
+
* ```
|
|
18246
18287
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
18247
18288
|
* @group Global methods
|
|
18248
18289
|
*/
|
|
@@ -18345,9 +18386,9 @@ const exportTML = async (data) => {
|
|
|
18345
18386
|
};
|
|
18346
18387
|
/**
|
|
18347
18388
|
* Reloads the ThoughtSpot iframe.
|
|
18389
|
+
* @version SDK: 1.43.1
|
|
18348
18390
|
* @param iFrame
|
|
18349
18391
|
* @group Global methods
|
|
18350
|
-
* @version SDK: 1.43.1
|
|
18351
18392
|
*/
|
|
18352
18393
|
const reloadIframe = (iFrame) => {
|
|
18353
18394
|
if (!iFrame) {
|
|
@@ -18488,7 +18529,7 @@ function processEventData(type, eventData, thoughtSpotHost, containerEl) {
|
|
|
18488
18529
|
return eventData;
|
|
18489
18530
|
}
|
|
18490
18531
|
|
|
18491
|
-
var name="@thoughtspot/visual-embed-sdk";var version$1="1.46.
|
|
18532
|
+
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={".":{"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,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};
|
|
18492
18533
|
|
|
18493
18534
|
class HostEventClient {
|
|
18494
18535
|
constructor(iFrame) {
|
|
@@ -18794,9 +18835,9 @@ class TsEmbed {
|
|
|
18794
18835
|
this.embedNodeKey = '__tsEmbed';
|
|
18795
18836
|
this.isAppInitialized = false;
|
|
18796
18837
|
/**
|
|
18797
|
-
* Should we encode URL Query Params using base64 encoding which
|
|
18838
|
+
* Should we encode URL Query Params using base64 encoding which ThoughtSpot
|
|
18798
18839
|
* will generate for embedding. This provides additional security to
|
|
18799
|
-
*
|
|
18840
|
+
* ThoughtSpot clusters against Cross site scripting attacks.
|
|
18800
18841
|
* @default false
|
|
18801
18842
|
*/
|
|
18802
18843
|
this.shouldEncodeUrlQueryParams = false;
|
|
@@ -18972,7 +19013,7 @@ class TsEmbed {
|
|
|
18972
19013
|
if (viewConfig.preRenderId) {
|
|
18973
19014
|
const allOtherKeys = Object.keys(viewConfig).filter((key) => !preRenderAllowedKeys.includes(key) && !key.startsWith('on'));
|
|
18974
19015
|
allOtherKeys.forEach((key) => {
|
|
18975
|
-
if (!isUndefined
|
|
19016
|
+
if (!isUndefined(viewConfig[key])
|
|
18976
19017
|
&& !isEqual_1(viewConfig[key], preRenderedObject.viewConfig[key])) {
|
|
18977
19018
|
logger$3.warn(`${viewConfig.embedComponentType || 'Component'} was pre-rendered with `
|
|
18978
19019
|
+ `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
|
|
@@ -19308,7 +19349,7 @@ class TsEmbed {
|
|
|
19308
19349
|
if (this.embedConfig.currencyFormat) {
|
|
19309
19350
|
queryParams[Param.CurrencyFormat] = this.embedConfig.currencyFormat;
|
|
19310
19351
|
}
|
|
19311
|
-
const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags: additionalFlagsFromView, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, disableRedirectionLinksInNewTab, overrideOrgId, exposeTranslationIDs, primaryAction, } = this.viewConfig;
|
|
19352
|
+
const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags: additionalFlagsFromView, locale, customizations, contextMenuTrigger, linkOverride, enableLinkOverridesV2, insertInToSlide, disableRedirectionLinksInNewTab, overrideOrgId, exposeTranslationIDs, primaryAction, } = this.viewConfig;
|
|
19312
19353
|
const { additionalFlags: additionalFlagsFromInit } = this.embedConfig;
|
|
19313
19354
|
const additionalFlags = {
|
|
19314
19355
|
...additionalFlagsFromInit,
|
|
@@ -19384,7 +19425,13 @@ class TsEmbed {
|
|
|
19384
19425
|
if (locale !== undefined) {
|
|
19385
19426
|
queryParams[Param.Locale] = locale;
|
|
19386
19427
|
}
|
|
19387
|
-
|
|
19428
|
+
// TODO: Once V2 is stable, send both flags when
|
|
19429
|
+
// linkOverride is true (remove the else-if).
|
|
19430
|
+
if (enableLinkOverridesV2) {
|
|
19431
|
+
queryParams[Param.EnableLinkOverridesV2] = true;
|
|
19432
|
+
queryParams[Param.LinkOverride] = true;
|
|
19433
|
+
}
|
|
19434
|
+
else if (linkOverride) {
|
|
19388
19435
|
queryParams[Param.LinkOverride] = linkOverride;
|
|
19389
19436
|
}
|
|
19390
19437
|
if (insertInToSlide) {
|
|
@@ -19452,7 +19499,7 @@ class TsEmbed {
|
|
|
19452
19499
|
iFrame.mozallowfullscreen = true;
|
|
19453
19500
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
19454
19501
|
// @ts-ignore
|
|
19455
|
-
iFrame.allow = 'clipboard-read; clipboard-write; fullscreen;';
|
|
19502
|
+
iFrame.allow = 'clipboard-read; clipboard-write; fullscreen; local-network-access;';
|
|
19456
19503
|
const frameParams = this.viewConfig.frameParams;
|
|
19457
19504
|
const { height: frameHeight, width: frameWidth, ...restParams } = frameParams || {};
|
|
19458
19505
|
const width = getCssDimension(frameWidth || DEFAULT_EMBED_WIDTH);
|
|
@@ -20154,7 +20201,7 @@ class TsEmbed {
|
|
|
20154
20201
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
20155
20202
|
* session.
|
|
20156
20203
|
* @param vizId [Optional] to get for a specific viz in case of a Liveboard.
|
|
20157
|
-
* @version SDK: 1.25.0
|
|
20204
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
|
|
20158
20205
|
*/
|
|
20159
20206
|
async getAnswerService(vizId) {
|
|
20160
20207
|
const { session } = await this.trigger(HostEvent.GetAnswerSession, vizId ? { vizId } : {});
|
|
@@ -20454,7 +20501,7 @@ class AppEmbed extends V1Embed {
|
|
|
20454
20501
|
* embedded Liveboard or visualization.
|
|
20455
20502
|
*/
|
|
20456
20503
|
getEmbedParams() {
|
|
20457
|
-
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 = DataPanelCustomColumnGroupsAccordionState$1.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;
|
|
20504
|
+
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 = DataPanelCustomColumnGroupsAccordionState$1.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;
|
|
20458
20505
|
let params = {};
|
|
20459
20506
|
params[Param.PrimaryNavHidden] = !showPrimaryNavbar;
|
|
20460
20507
|
params[Param.HideProfleAndHelp] = !!disableProfileAndHelp;
|
|
@@ -20475,13 +20522,17 @@ class AppEmbed extends V1Embed {
|
|
|
20475
20522
|
params[Param.IsUnifiedSearchExperienceEnabled] = isUnifiedSearchExperienceEnabled;
|
|
20476
20523
|
params[Param.CoverAndFilterOptionInPDF] = !!coverAndFilterOptionInPDF;
|
|
20477
20524
|
params = this.getBaseQueryParams(params);
|
|
20478
|
-
if (!isUndefined
|
|
20525
|
+
if (!isUndefined(updatedSpotterChatPrompt)) {
|
|
20479
20526
|
params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
|
|
20480
20527
|
}
|
|
20528
|
+
const resolvedEnablePastConversationsSidebar = resolveEnablePastConversationsSidebar({
|
|
20529
|
+
spotterSidebarConfigValue: spotterSidebarConfig === null || spotterSidebarConfig === void 0 ? void 0 : spotterSidebarConfig.enablePastConversationsSidebar,
|
|
20530
|
+
standaloneValue: this.viewConfig.enablePastConversationsSidebar,
|
|
20531
|
+
});
|
|
20532
|
+
setParamIfDefined(params, Param.EnablePastConversationsSidebar, resolvedEnablePastConversationsSidebar, true);
|
|
20481
20533
|
// Handle spotterSidebarConfig params
|
|
20482
20534
|
if (spotterSidebarConfig) {
|
|
20483
|
-
const {
|
|
20484
|
-
setParamIfDefined(params, Param.EnablePastConversationsSidebar, enablePastConversationsSidebar, true);
|
|
20535
|
+
const { spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig;
|
|
20485
20536
|
setParamIfDefined(params, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
|
|
20486
20537
|
setParamIfDefined(params, Param.SpotterSidebarTitle, spotterSidebarTitle);
|
|
20487
20538
|
setParamIfDefined(params, Param.SpotterChatRenameLabel, spotterChatRenameLabel);
|
|
@@ -20579,6 +20630,9 @@ class AppEmbed extends V1Embed {
|
|
|
20579
20630
|
if (isThisPeriodInDateFiltersEnabled !== undefined) {
|
|
20580
20631
|
params[Param.IsThisPeriodInDateFiltersEnabled] = isThisPeriodInDateFiltersEnabled;
|
|
20581
20632
|
}
|
|
20633
|
+
if (enableHomepageAnnouncement !== undefined) {
|
|
20634
|
+
params[Param.EnableHomepageAnnouncement] = enableHomepageAnnouncement;
|
|
20635
|
+
}
|
|
20582
20636
|
this.defaultHeight = minimumHeight || this.defaultHeight;
|
|
20583
20637
|
params[Param.DataPanelV2Enabled] = dataPanelV2;
|
|
20584
20638
|
params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
|
|
@@ -20837,6 +20891,7 @@ const addPreviewStylesIfNotPresent = () => {
|
|
|
20837
20891
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
20838
20892
|
* waits for the authentication to complete, so you need not wait for
|
|
20839
20893
|
* `AuthStatus.SUCCESS`.
|
|
20894
|
+
* @group Embed components
|
|
20840
20895
|
* @example
|
|
20841
20896
|
* ```js
|
|
20842
20897
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -20846,7 +20901,6 @@ const addPreviewStylesIfNotPresent = () => {
|
|
|
20846
20901
|
* // .. other params here.
|
|
20847
20902
|
* })
|
|
20848
20903
|
* ```
|
|
20849
|
-
* @group Embed components
|
|
20850
20904
|
*/
|
|
20851
20905
|
class LiveboardEmbed extends V1Embed {
|
|
20852
20906
|
constructor(domSelector, viewConfig) {
|
|
@@ -20954,7 +21008,7 @@ class LiveboardEmbed extends V1Embed {
|
|
|
20954
21008
|
if (preventLiveboardFilterRemoval) {
|
|
20955
21009
|
params[Param.preventLiveboardFilterRemoval] = true;
|
|
20956
21010
|
}
|
|
20957
|
-
if (!isUndefined
|
|
21011
|
+
if (!isUndefined(updatedSpotterChatPrompt)) {
|
|
20958
21012
|
params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
|
|
20959
21013
|
}
|
|
20960
21014
|
if (visibleVizs) {
|
|
@@ -21133,7 +21187,7 @@ class LiveboardEmbed extends V1Embed {
|
|
|
21133
21187
|
});
|
|
21134
21188
|
}
|
|
21135
21189
|
async handleRenderForPrerender() {
|
|
21136
|
-
if (isUndefined
|
|
21190
|
+
if (isUndefined(this.viewConfig.liveboardId)) {
|
|
21137
21191
|
return this.prerenderGeneric();
|
|
21138
21192
|
}
|
|
21139
21193
|
return super.handleRenderForPrerender();
|
|
@@ -21419,7 +21473,7 @@ class SearchEmbed extends TsEmbed {
|
|
|
21419
21473
|
|
|
21420
21474
|
/**
|
|
21421
21475
|
* Embed ThoughtSpot search bar
|
|
21422
|
-
* @version
|
|
21476
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
21423
21477
|
* @group Embed components
|
|
21424
21478
|
*/
|
|
21425
21479
|
class SearchBarEmbed extends TsEmbed {
|
|
@@ -21920,6 +21974,8 @@ class ConversationMessage extends TsEmbed {
|
|
|
21920
21974
|
/**
|
|
21921
21975
|
* Create a conversation embed, which can be integrated inside
|
|
21922
21976
|
* chatbots or other conversational interfaces.
|
|
21977
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
21978
|
+
* @group Embed components
|
|
21923
21979
|
* @example
|
|
21924
21980
|
* ```js
|
|
21925
21981
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -21933,8 +21989,6 @@ class ConversationMessage extends TsEmbed {
|
|
|
21933
21989
|
* // append the container to the DOM
|
|
21934
21990
|
* document.body.appendChild(container); // or to any other element
|
|
21935
21991
|
* ```
|
|
21936
|
-
* @group Embed components
|
|
21937
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
21938
21992
|
*/
|
|
21939
21993
|
class SpotterAgentEmbed {
|
|
21940
21994
|
constructor(viewConfig) {
|
|
@@ -21988,8 +22042,9 @@ class SpotterAgentEmbed {
|
|
|
21988
22042
|
/**
|
|
21989
22043
|
* Create a conversation embed, which can be integrated inside
|
|
21990
22044
|
* chatbots or other conversational interfaces.
|
|
21991
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
21992
22045
|
* Use {@link SpotterAgentEmbed} instead
|
|
22046
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22047
|
+
* @group Embed components
|
|
21993
22048
|
* @example
|
|
21994
22049
|
* ```js
|
|
21995
22050
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -22003,7 +22058,6 @@ class SpotterAgentEmbed {
|
|
|
22003
22058
|
* // append the container to the DOM
|
|
22004
22059
|
* document.body.appendChild(container); // or to any other element
|
|
22005
22060
|
* ```
|
|
22006
|
-
* @group Embed components
|
|
22007
22061
|
*/
|
|
22008
22062
|
class BodylessConversation extends SpotterAgentEmbed {
|
|
22009
22063
|
constructor(viewConfig) {
|
|
@@ -22011,31 +22065,9 @@ class BodylessConversation extends SpotterAgentEmbed {
|
|
|
22011
22065
|
}
|
|
22012
22066
|
}
|
|
22013
22067
|
|
|
22014
|
-
/**
|
|
22015
|
-
* Checks if `value` is `undefined`.
|
|
22016
|
-
*
|
|
22017
|
-
* @static
|
|
22018
|
-
* @since 0.1.0
|
|
22019
|
-
* @memberOf _
|
|
22020
|
-
* @category Lang
|
|
22021
|
-
* @param {*} value The value to check.
|
|
22022
|
-
* @returns {boolean} Returns `true` if `value` is `undefined`, else `false`.
|
|
22023
|
-
* @example
|
|
22024
|
-
*
|
|
22025
|
-
* _.isUndefined(void 0);
|
|
22026
|
-
* // => true
|
|
22027
|
-
*
|
|
22028
|
-
* _.isUndefined(null);
|
|
22029
|
-
* // => false
|
|
22030
|
-
*/
|
|
22031
|
-
function isUndefined(value) {
|
|
22032
|
-
return value === undefined;
|
|
22033
|
-
}
|
|
22034
|
-
|
|
22035
|
-
var isUndefined_1 = isUndefined;
|
|
22036
|
-
|
|
22037
22068
|
/**
|
|
22038
22069
|
* Embed ThoughtSpot AI Conversation.
|
|
22070
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22039
22071
|
* @group Embed components
|
|
22040
22072
|
* @example
|
|
22041
22073
|
* ```js
|
|
@@ -22047,7 +22079,6 @@ var isUndefined_1 = isUndefined;
|
|
|
22047
22079
|
* });
|
|
22048
22080
|
* conversation.render();
|
|
22049
22081
|
* ```
|
|
22050
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22051
22082
|
*/
|
|
22052
22083
|
class SpotterEmbed extends TsEmbed {
|
|
22053
22084
|
constructor(container, viewConfig) {
|
|
@@ -22063,7 +22094,11 @@ class SpotterEmbed extends TsEmbed {
|
|
|
22063
22094
|
getEmbedParamsObject() {
|
|
22064
22095
|
const { worksheetId, searchOptions, disableSourceSelection, hideSourceSelection, dataPanelV2, showSpotterLimitations, hideSampleQuestions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, updatedSpotterChatPrompt, spotterSidebarConfig, spotterChatConfig, } = this.viewConfig;
|
|
22065
22096
|
// Extract sidebar config properties
|
|
22066
|
-
const { enablePastConversationsSidebar, spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig || {};
|
|
22097
|
+
const { enablePastConversationsSidebar: sidebarEnablePastConversationsSidebar, spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig || {};
|
|
22098
|
+
const resolvedEnablePastConversationsSidebar = resolveEnablePastConversationsSidebar({
|
|
22099
|
+
spotterSidebarConfigValue: sidebarEnablePastConversationsSidebar,
|
|
22100
|
+
standaloneValue: this.viewConfig.enablePastConversationsSidebar,
|
|
22101
|
+
});
|
|
22067
22102
|
if (!worksheetId) {
|
|
22068
22103
|
this.handleError({
|
|
22069
22104
|
errorType: ErrorDetailsTypes.VALIDATION_ERROR,
|
|
@@ -22081,6 +22116,7 @@ class SpotterEmbed extends TsEmbed {
|
|
|
22081
22116
|
setParamIfDefined(queryParams, Param.ShowSpotterLimitations, showSpotterLimitations, true);
|
|
22082
22117
|
setParamIfDefined(queryParams, Param.HideSampleQuestions, hideSampleQuestions, true);
|
|
22083
22118
|
setParamIfDefined(queryParams, Param.UpdatedSpotterChatPrompt, updatedSpotterChatPrompt, true);
|
|
22119
|
+
setParamIfDefined(queryParams, Param.EnablePastConversationsSidebar, resolvedEnablePastConversationsSidebar, true);
|
|
22084
22120
|
setParamIfDefined(queryParams, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
|
|
22085
22121
|
// String params
|
|
22086
22122
|
setParamIfDefined(queryParams, Param.SpotterSidebarTitle, spotterSidebarTitle);
|
|
@@ -22115,13 +22151,9 @@ class SpotterEmbed extends TsEmbed {
|
|
|
22115
22151
|
return queryParams;
|
|
22116
22152
|
}
|
|
22117
22153
|
getIframeSrc() {
|
|
22118
|
-
const { worksheetId, searchOptions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL,
|
|
22154
|
+
const { worksheetId, searchOptions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, } = this.viewConfig;
|
|
22119
22155
|
const path = 'insights/conv-assist';
|
|
22120
22156
|
const queryParams = this.getEmbedParamsObject();
|
|
22121
|
-
const enablePastConversationsSidebar = spotterSidebarConfig === null || spotterSidebarConfig === void 0 ? void 0 : spotterSidebarConfig.enablePastConversationsSidebar;
|
|
22122
|
-
if (!isUndefined_1(enablePastConversationsSidebar)) {
|
|
22123
|
-
queryParams[Param.EnablePastConversationsSidebar] = !!enablePastConversationsSidebar;
|
|
22124
|
-
}
|
|
22125
22157
|
let query = '';
|
|
22126
22158
|
const queryParamsString = getQueryParamString(queryParams, true);
|
|
22127
22159
|
if (queryParamsString) {
|
|
@@ -22150,8 +22182,9 @@ class SpotterEmbed extends TsEmbed {
|
|
|
22150
22182
|
}
|
|
22151
22183
|
/**
|
|
22152
22184
|
* Embed ThoughtSpot AI Conversation.
|
|
22153
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22154
22185
|
* Use {@link SpotterEmbed} instead
|
|
22186
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22187
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22155
22188
|
* @group Embed components
|
|
22156
22189
|
* @example
|
|
22157
22190
|
* ```js
|
|
@@ -22163,7 +22196,6 @@ class SpotterEmbed extends TsEmbed {
|
|
|
22163
22196
|
* });
|
|
22164
22197
|
* conversation.render();
|
|
22165
22198
|
* ```
|
|
22166
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22167
22199
|
*/
|
|
22168
22200
|
class ConversationEmbed extends SpotterEmbed {
|
|
22169
22201
|
constructor(container, viewConfig) {
|
|
@@ -22187,7 +22219,7 @@ class ConversationEmbed extends SpotterEmbed {
|
|
|
22187
22219
|
*/
|
|
22188
22220
|
/**
|
|
22189
22221
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
22190
|
-
* @version
|
|
22222
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
22191
22223
|
*
|
|
22192
22224
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
22193
22225
|
* @group Embed components
|