@thoughtspot/visual-embed-sdk 1.46.0 → 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/README.md +1 -1
- package/cjs/package.json +2 -2
- package/cjs/src/auth.d.ts +29 -4
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +30 -5
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/css-variables.d.ts +17 -17
- package/cjs/src/embed/app.d.ts +61 -33
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +11 -4
- 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 +42 -36
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +3 -3
- 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 +16 -14
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +3 -2
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +4 -4
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +13 -7
- 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 +653 -276
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +274 -208
- 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-BQvLEoxp.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 +61 -33
- 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 +42 -36
- 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 +16 -14
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +4 -4
- 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 +653 -276
- 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 +383 -290
- package/dist/tsembed-react.js +382 -289
- package/dist/tsembed.es.js +375 -282
- package/dist/tsembed.js +374 -281
- package/dist/visual-embed-sdk-react-full.d.ts +880 -431
- package/dist/visual-embed-sdk-react.d.ts +873 -427
- package/dist/visual-embed-sdk.d.ts +879 -430
- package/lib/package.json +2 -2
- package/lib/src/auth.d.ts +29 -4
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +30 -5
- package/lib/src/auth.js.map +1 -1
- package/lib/src/css-variables.d.ts +17 -17
- package/lib/src/embed/app.d.ts +61 -33
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +12 -5
- 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 +42 -36
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +3 -3
- 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 +16 -14
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +3 -2
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +4 -4
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +13 -7
- 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 +653 -276
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +274 -208
- 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 +2 -2
- package/src/auth.ts +30 -5
- package/src/css-variables.ts +17 -17
- package/src/embed/app.spec.ts +46 -1
- package/src/embed/app.ts +73 -36
- 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 +42 -36
- package/src/embed/sage.ts +5 -5
- package/src/embed/search-bar.tsx +7 -7
- package/src/embed/search.ts +16 -14
- package/src/embed/ts-embed.spec.ts +42 -0
- package/src/embed/ts-embed.ts +12 -7
- package/src/react/index.tsx +15 -15
- package/src/tokenizedFetch.ts +1 -1
- package/src/types.ts +652 -275
- 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-react.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/* @thoughtspot/visual-embed-sdk version 1.46.
|
|
1
|
+
/* @thoughtspot/visual-embed-sdk version 1.46.2 */
|
|
2
2
|
'use client';
|
|
3
3
|
(function (global, factory) {
|
|
4
4
|
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react')) :
|
|
@@ -213,7 +213,7 @@
|
|
|
213
213
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
214
214
|
*/
|
|
215
215
|
/**
|
|
216
|
-
* The authentication mechanism for allowing access to
|
|
216
|
+
* The authentication mechanism for allowing access to
|
|
217
217
|
* the embedded app
|
|
218
218
|
* @group Authentication / Init
|
|
219
219
|
*/
|
|
@@ -239,6 +239,7 @@
|
|
|
239
239
|
* To use this:
|
|
240
240
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
241
241
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
242
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
242
243
|
* @example
|
|
243
244
|
* ```js
|
|
244
245
|
* init({
|
|
@@ -246,18 +247,17 @@
|
|
|
246
247
|
* authType: AuthType.EmbeddedSSO,
|
|
247
248
|
* });
|
|
248
249
|
* ```
|
|
249
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
250
250
|
*/
|
|
251
251
|
AuthType["EmbeddedSSO"] = "EmbeddedSSO";
|
|
252
252
|
/**
|
|
253
|
-
* SSO using SAML
|
|
254
|
-
* @deprecated
|
|
253
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
254
|
+
* @deprecated This option is deprecated.
|
|
255
255
|
* @hidden
|
|
256
256
|
*/
|
|
257
257
|
AuthType["SSO"] = "SSO_SAML";
|
|
258
258
|
/**
|
|
259
|
-
* SSO using SAML
|
|
260
|
-
* @deprecated
|
|
259
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
260
|
+
* @deprecated This option is deprecated.
|
|
261
261
|
* @hidden
|
|
262
262
|
*/
|
|
263
263
|
AuthType["SAML"] = "SSO_SAML";
|
|
@@ -308,8 +308,9 @@
|
|
|
308
308
|
AuthType["SAMLRedirect"] = "SSO_SAML";
|
|
309
309
|
/**
|
|
310
310
|
* SSO using OIDC
|
|
311
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
312
|
+
* @deprecated This option is deprecated.
|
|
311
313
|
* @hidden
|
|
312
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
313
314
|
*/
|
|
314
315
|
AuthType["OIDC"] = "SSO_OIDC";
|
|
315
316
|
/**
|
|
@@ -320,8 +321,9 @@
|
|
|
320
321
|
AuthType["OIDCRedirect"] = "SSO_OIDC";
|
|
321
322
|
/**
|
|
322
323
|
* Trusted authentication server
|
|
324
|
+
* Use {@link TrustedAuth} instead
|
|
325
|
+
* @deprecated This option is deprecated.
|
|
323
326
|
* @hidden
|
|
324
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
325
327
|
*/
|
|
326
328
|
AuthType["AuthServer"] = "AuthServer";
|
|
327
329
|
/**
|
|
@@ -348,6 +350,7 @@
|
|
|
348
350
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
349
351
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
350
352
|
* implemented by some browsers.
|
|
353
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
351
354
|
* @example
|
|
352
355
|
* ```js
|
|
353
356
|
* init({
|
|
@@ -358,8 +361,8 @@
|
|
|
358
361
|
* .then((response) => response.json())
|
|
359
362
|
* .then((data) => data.token);
|
|
360
363
|
* }
|
|
364
|
+
* });
|
|
361
365
|
* ```
|
|
362
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
363
366
|
*/
|
|
364
367
|
AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
|
|
365
368
|
/**
|
|
@@ -380,43 +383,43 @@
|
|
|
380
383
|
/**
|
|
381
384
|
* The *Search data* option in
|
|
382
385
|
* the *Insights* left navigation panel.
|
|
383
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
386
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
384
387
|
*/
|
|
385
388
|
HomeLeftNavItem["SearchData"] = "search-data";
|
|
386
389
|
/**
|
|
387
390
|
* The *Home* menu option in
|
|
388
391
|
* the *Insights* left navigation panel.
|
|
389
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
392
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
390
393
|
*/
|
|
391
394
|
HomeLeftNavItem["Home"] = "insights-home";
|
|
392
395
|
/**
|
|
393
396
|
* The *Liveboards* menu option in
|
|
394
397
|
* the *Insights* left navigation panel.
|
|
395
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
398
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
396
399
|
*/
|
|
397
400
|
HomeLeftNavItem["Liveboards"] = "liveboards";
|
|
398
401
|
/**
|
|
399
402
|
* The *Answers* menu option in
|
|
400
403
|
* the *Insights* left navigation panel.
|
|
401
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
404
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
402
405
|
*/
|
|
403
406
|
HomeLeftNavItem["Answers"] = "answers";
|
|
404
407
|
/**
|
|
405
408
|
* The *Monitor subscriptions* menu option in
|
|
406
409
|
* the *Insights* left navigation panel.
|
|
407
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
410
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
408
411
|
*/
|
|
409
412
|
HomeLeftNavItem["MonitorSubscription"] = "monitor-alerts";
|
|
410
413
|
/**
|
|
411
414
|
* The *SpotIQ analysis* menu option in
|
|
412
415
|
* the *Insights* left navigation panel.
|
|
413
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
416
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
414
417
|
*/
|
|
415
418
|
HomeLeftNavItem["SpotIQAnalysis"] = "spotiq-analysis";
|
|
416
419
|
/**
|
|
417
420
|
* The *Liveboard schedules* menu option in
|
|
418
421
|
* the *Insights* left navigation panel.
|
|
419
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
422
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
420
423
|
*/
|
|
421
424
|
HomeLeftNavItem["LiveboardSchedules"] = "liveboard-schedules";
|
|
422
425
|
/**
|
|
@@ -522,7 +525,7 @@
|
|
|
522
525
|
*/
|
|
523
526
|
HomepageModule["Search"] = "SEARCH";
|
|
524
527
|
/**
|
|
525
|
-
*
|
|
528
|
+
* KPI watchlist module
|
|
526
529
|
*/
|
|
527
530
|
HomepageModule["Watchlist"] = "WATCHLIST";
|
|
528
531
|
/**
|
|
@@ -554,7 +557,8 @@
|
|
|
554
557
|
*/
|
|
555
558
|
ListPageColumns["Favorites"] = "FAVOURITE";
|
|
556
559
|
/**
|
|
557
|
-
*
|
|
560
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
561
|
+
* @deprecated This option is deprecated.
|
|
558
562
|
*/
|
|
559
563
|
ListPageColumns["Favourite"] = "FAVOURITE";
|
|
560
564
|
/**
|
|
@@ -622,13 +626,13 @@
|
|
|
622
626
|
/**
|
|
623
627
|
* Rendering has initialized.
|
|
624
628
|
* @example
|
|
625
|
-
|
|
629
|
+
* ```js
|
|
626
630
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
627
631
|
* //show a loader
|
|
628
632
|
* function showLoader() {
|
|
629
633
|
* document.getElementById("loader");
|
|
630
634
|
* }
|
|
631
|
-
|
|
635
|
+
* ```
|
|
632
636
|
* @returns timestamp - The timestamp when the event was generated.
|
|
633
637
|
*/
|
|
634
638
|
EmbedEvent["Init"] = "init";
|
|
@@ -636,11 +640,11 @@
|
|
|
636
640
|
* Authentication has either succeeded or failed.
|
|
637
641
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
638
642
|
* @example
|
|
639
|
-
|
|
643
|
+
* ```js
|
|
640
644
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
641
645
|
* console.log('AuthInit', payload);
|
|
642
646
|
* })
|
|
643
|
-
|
|
647
|
+
* ```
|
|
644
648
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
645
649
|
*/
|
|
646
650
|
EmbedEvent["AuthInit"] = "authInit";
|
|
@@ -649,13 +653,13 @@
|
|
|
649
653
|
* @returns timestamp - The timestamp when the event was generated.
|
|
650
654
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
651
655
|
* @example
|
|
652
|
-
|
|
656
|
+
* ```js
|
|
653
657
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
654
658
|
* //hide loader
|
|
655
659
|
* function hideLoader() {
|
|
656
660
|
* document.getElementById("loader");
|
|
657
661
|
* }
|
|
658
|
-
|
|
662
|
+
* ```
|
|
659
663
|
*/
|
|
660
664
|
EmbedEvent["Load"] = "load";
|
|
661
665
|
/**
|
|
@@ -664,11 +668,11 @@
|
|
|
664
668
|
* @return data - Answer of Liveboard data
|
|
665
669
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
666
670
|
* @example
|
|
667
|
-
|
|
671
|
+
* ```js
|
|
668
672
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
669
673
|
* console.log('data', payload);
|
|
670
674
|
* })
|
|
671
|
-
|
|
675
|
+
* ```
|
|
672
676
|
* @important
|
|
673
677
|
*/
|
|
674
678
|
EmbedEvent["Data"] = "data";
|
|
@@ -676,9 +680,9 @@
|
|
|
676
680
|
* Search query has been updated by the user.
|
|
677
681
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
678
682
|
* @example
|
|
679
|
-
|
|
683
|
+
* ```js
|
|
680
684
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
681
|
-
|
|
685
|
+
* ```
|
|
682
686
|
*/
|
|
683
687
|
EmbedEvent["QueryChanged"] = "queryChanged";
|
|
684
688
|
/**
|
|
@@ -688,7 +692,7 @@
|
|
|
688
692
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
689
693
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
690
694
|
* @example
|
|
691
|
-
|
|
695
|
+
* ```js
|
|
692
696
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
693
697
|
* points: {
|
|
694
698
|
* clickedPoint,
|
|
@@ -696,12 +700,12 @@
|
|
|
696
700
|
* },
|
|
697
701
|
* autoDrillDown: true,
|
|
698
702
|
* })
|
|
699
|
-
|
|
703
|
+
* ```
|
|
700
704
|
* In this example, `VizPointDoubleClick` event is used for
|
|
701
705
|
* triggering the `DrillDown` event when an area or specific
|
|
702
706
|
* data point on a table or chart is double-clicked.
|
|
703
707
|
* @example
|
|
704
|
-
|
|
708
|
+
* ```js
|
|
705
709
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
706
710
|
* console.log(payload);
|
|
707
711
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -715,7 +719,7 @@
|
|
|
715
719
|
* autoDrillDown: true,
|
|
716
720
|
* })
|
|
717
721
|
* })
|
|
718
|
-
|
|
722
|
+
* ```
|
|
719
723
|
*/
|
|
720
724
|
EmbedEvent["Drilldown"] = "drillDown";
|
|
721
725
|
/**
|
|
@@ -840,13 +844,13 @@
|
|
|
840
844
|
* The ThoughtSpot authentication session has expired.
|
|
841
845
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
842
846
|
* @example
|
|
843
|
-
|
|
847
|
+
* ```js
|
|
844
848
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
845
849
|
* //show auth expired banner
|
|
846
850
|
* function showAuthExpired() {
|
|
847
851
|
* document.getElementById("authExpiredBanner");
|
|
848
852
|
* }
|
|
849
|
-
|
|
853
|
+
* ```
|
|
850
854
|
*/
|
|
851
855
|
EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
|
|
852
856
|
/**
|
|
@@ -881,22 +885,22 @@
|
|
|
881
885
|
* Applicable to `SearchBarEmbed` only.
|
|
882
886
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
883
887
|
* @example
|
|
884
|
-
|
|
888
|
+
* ```js
|
|
885
889
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
886
890
|
* .then(data => {
|
|
887
891
|
* console.log('Answer Data:', data);
|
|
888
892
|
* })
|
|
889
|
-
|
|
893
|
+
* ```
|
|
890
894
|
*/
|
|
891
895
|
EmbedEvent["GetDataClick"] = "getDataClick";
|
|
892
896
|
/**
|
|
893
897
|
* Detects the route change.
|
|
894
898
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
895
899
|
* @example
|
|
896
|
-
|
|
900
|
+
* ```js
|
|
897
901
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
898
902
|
* console.log('data', payload))
|
|
899
|
-
|
|
903
|
+
* ```
|
|
900
904
|
*/
|
|
901
905
|
EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
|
|
902
906
|
/**
|
|
@@ -906,12 +910,12 @@
|
|
|
906
910
|
EmbedEvent["V1Data"] = "exportVizDataToParent";
|
|
907
911
|
/**
|
|
908
912
|
* Emitted when the embed does not have cookie access. This happens
|
|
909
|
-
* when
|
|
910
|
-
*
|
|
913
|
+
* when third-party cookies are blocked by Safari or other
|
|
914
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
911
915
|
* @example
|
|
912
|
-
|
|
916
|
+
* ```js
|
|
913
917
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
914
|
-
|
|
918
|
+
* ```
|
|
915
919
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
916
920
|
*/
|
|
917
921
|
EmbedEvent["NoCookieAccess"] = "noCookieAccess";
|
|
@@ -925,22 +929,22 @@
|
|
|
925
929
|
* Emitted when any modal is opened in the app
|
|
926
930
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
927
931
|
* @example
|
|
928
|
-
|
|
932
|
+
* ```js
|
|
929
933
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
930
934
|
* console.log('dialog open', payload);
|
|
931
935
|
* })
|
|
932
|
-
|
|
936
|
+
* ```
|
|
933
937
|
*/
|
|
934
938
|
EmbedEvent["DialogOpen"] = "dialog-open";
|
|
935
939
|
/**
|
|
936
940
|
* Emitted when any modal is closed in the app
|
|
937
941
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
938
942
|
* @example
|
|
939
|
-
|
|
943
|
+
* ```js
|
|
940
944
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
941
945
|
* console.log('dialog close', payload);
|
|
942
946
|
* })
|
|
943
|
-
|
|
947
|
+
* ```
|
|
944
948
|
*/
|
|
945
949
|
EmbedEvent["DialogClose"] = "dialog-close";
|
|
946
950
|
/**
|
|
@@ -949,39 +953,39 @@
|
|
|
949
953
|
* other events on the rendered Liveboard.
|
|
950
954
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
951
955
|
* @example
|
|
952
|
-
|
|
956
|
+
* ```js
|
|
953
957
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
954
958
|
console.log('Liveboard is rendered', payload);
|
|
955
959
|
})
|
|
956
|
-
|
|
960
|
+
* ```
|
|
957
961
|
* The following example shows how to trigger
|
|
958
962
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
959
963
|
* @example
|
|
960
|
-
|
|
964
|
+
* ```js
|
|
961
965
|
* const embedRef = useEmbedRef();
|
|
962
966
|
* const onLiveboardRendered = () => {
|
|
963
967
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
964
968
|
* };
|
|
965
|
-
|
|
969
|
+
* ```
|
|
966
970
|
*/
|
|
967
971
|
EmbedEvent["LiveboardRendered"] = "PinboardRendered";
|
|
968
972
|
/**
|
|
969
973
|
* Emits all events.
|
|
970
|
-
* @
|
|
974
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
971
975
|
* @example
|
|
972
|
-
|
|
976
|
+
* ```js
|
|
973
977
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
974
978
|
* console.log('Embed Events', payload)
|
|
975
979
|
* })
|
|
976
|
-
|
|
980
|
+
* ```
|
|
977
981
|
*/
|
|
978
982
|
EmbedEvent["ALL"] = "*";
|
|
979
983
|
/**
|
|
980
984
|
* Emitted when an Answer is saved in the app.
|
|
981
985
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
982
|
-
* @
|
|
986
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
983
987
|
* @example
|
|
984
|
-
|
|
988
|
+
* ```js
|
|
985
989
|
* //Emit when action starts
|
|
986
990
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
987
991
|
* console.log('Save', payload)
|
|
@@ -992,7 +996,7 @@
|
|
|
992
996
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
993
997
|
* console.log('Save', payload)
|
|
994
998
|
* })
|
|
995
|
-
|
|
999
|
+
* ```
|
|
996
1000
|
*/
|
|
997
1001
|
EmbedEvent["Save"] = "save";
|
|
998
1002
|
/**
|
|
@@ -1004,11 +1008,11 @@
|
|
|
1004
1008
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
1005
1009
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1006
1010
|
* @example
|
|
1007
|
-
|
|
1011
|
+
* ```js
|
|
1008
1012
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
1009
1013
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1010
1014
|
* })
|
|
1011
|
-
|
|
1015
|
+
* ```
|
|
1012
1016
|
*/
|
|
1013
1017
|
EmbedEvent["Download"] = "download";
|
|
1014
1018
|
/**
|
|
@@ -1016,14 +1020,14 @@
|
|
|
1016
1020
|
* Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
|
|
1017
1021
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
1018
1022
|
* @example
|
|
1019
|
-
|
|
1023
|
+
* ```js
|
|
1020
1024
|
* //emit when action starts
|
|
1021
1025
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1022
1026
|
* console.log('download PNG', payload)}, {start: true })
|
|
1023
1027
|
* //emit when action ends
|
|
1024
1028
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1025
1029
|
* console.log('download PNG', payload)})
|
|
1026
|
-
|
|
1030
|
+
* ```
|
|
1027
1031
|
*/
|
|
1028
1032
|
EmbedEvent["DownloadAsPng"] = "downloadAsPng";
|
|
1029
1033
|
/**
|
|
@@ -1031,14 +1035,14 @@
|
|
|
1031
1035
|
* 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.
|
|
1032
1036
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1033
1037
|
* @example
|
|
1034
|
-
|
|
1038
|
+
* ```js
|
|
1035
1039
|
* //emit when action starts
|
|
1036
1040
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1037
1041
|
* console.log('download PDF', payload)}, {start: true })
|
|
1038
1042
|
* //emit when action ends
|
|
1039
1043
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1040
1044
|
* console.log('download PDF', payload)})
|
|
1041
|
-
|
|
1045
|
+
* ```
|
|
1042
1046
|
*/
|
|
1043
1047
|
EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
|
|
1044
1048
|
/**
|
|
@@ -1046,14 +1050,14 @@
|
|
|
1046
1050
|
* 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.
|
|
1047
1051
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1048
1052
|
* @example
|
|
1049
|
-
|
|
1053
|
+
* ```js
|
|
1050
1054
|
* //emit when action starts
|
|
1051
1055
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1052
1056
|
* console.log('download CSV', payload)}, {start: true })
|
|
1053
1057
|
* //emit when action ends
|
|
1054
1058
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1055
1059
|
* console.log('download CSV', payload)})
|
|
1056
|
-
|
|
1060
|
+
* ```
|
|
1057
1061
|
*/
|
|
1058
1062
|
EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
|
|
1059
1063
|
/**
|
|
@@ -1061,14 +1065,14 @@
|
|
|
1061
1065
|
* 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.
|
|
1062
1066
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1063
1067
|
* @example
|
|
1064
|
-
|
|
1068
|
+
* ```js
|
|
1065
1069
|
* //emit when action starts
|
|
1066
1070
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1067
1071
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
1068
1072
|
* //emit when action ends
|
|
1069
1073
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1070
1074
|
* console.log('download Xlsx', payload)})
|
|
1071
|
-
|
|
1075
|
+
* ```
|
|
1072
1076
|
*/
|
|
1073
1077
|
EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
|
|
1074
1078
|
/**
|
|
@@ -1076,25 +1080,25 @@
|
|
|
1076
1080
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
|
|
1077
1081
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1078
1082
|
* @example
|
|
1079
|
-
|
|
1083
|
+
* ```js
|
|
1080
1084
|
* //emit when action starts
|
|
1081
1085
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1082
1086
|
* console.log('delete answer', payload)}, {start: true })
|
|
1083
1087
|
* //trigger when action is completed
|
|
1084
1088
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1085
1089
|
* console.log('delete answer', payload)})
|
|
1086
|
-
|
|
1090
|
+
* ```
|
|
1087
1091
|
*/
|
|
1088
1092
|
EmbedEvent["AnswerDelete"] = "answerDelete";
|
|
1089
1093
|
/**
|
|
1090
1094
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
1091
1095
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
1092
1096
|
* @example
|
|
1093
|
-
|
|
1097
|
+
* ```js
|
|
1094
1098
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
1095
1099
|
* console.log('AI Highlights', payload);
|
|
1096
1100
|
* })
|
|
1097
|
-
|
|
1101
|
+
* ```
|
|
1098
1102
|
*/
|
|
1099
1103
|
EmbedEvent["AIHighlights"] = "AIHighlights";
|
|
1100
1104
|
/**
|
|
@@ -1103,7 +1107,7 @@
|
|
|
1103
1107
|
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
|
|
1104
1108
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1105
1109
|
* @example
|
|
1106
|
-
|
|
1110
|
+
* ```js
|
|
1107
1111
|
* //emit when action starts
|
|
1108
1112
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1109
1113
|
* console.log('pin', payload)
|
|
@@ -1114,14 +1118,14 @@
|
|
|
1114
1118
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1115
1119
|
* console.log('pin', payload)
|
|
1116
1120
|
* })
|
|
1117
|
-
|
|
1121
|
+
* ```
|
|
1118
1122
|
*/
|
|
1119
1123
|
EmbedEvent["Pin"] = "pin";
|
|
1120
1124
|
/**
|
|
1121
1125
|
* Emitted when SpotIQ analysis is triggered
|
|
1122
1126
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1123
1127
|
* @example
|
|
1124
|
-
|
|
1128
|
+
* ```js
|
|
1125
1129
|
* //emit when action starts
|
|
1126
1130
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1127
1131
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -1132,14 +1136,14 @@
|
|
|
1132
1136
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1133
1137
|
* console.log('SpotIQ analyze', payload)
|
|
1134
1138
|
* })
|
|
1135
|
-
|
|
1139
|
+
* ```
|
|
1136
1140
|
*/
|
|
1137
1141
|
EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
|
|
1138
1142
|
/**
|
|
1139
1143
|
* Emitted when a user shares an object with another user or group
|
|
1140
1144
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1141
1145
|
* @example
|
|
1142
|
-
|
|
1146
|
+
* ```js
|
|
1143
1147
|
* //emit when action starts
|
|
1144
1148
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1145
1149
|
* console.log('Share', payload)
|
|
@@ -1150,7 +1154,7 @@
|
|
|
1150
1154
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1151
1155
|
* console.log('Share', payload)
|
|
1152
1156
|
* })
|
|
1153
|
-
|
|
1157
|
+
* ```
|
|
1154
1158
|
*/
|
|
1155
1159
|
EmbedEvent["Share"] = "share";
|
|
1156
1160
|
/**
|
|
@@ -1158,11 +1162,11 @@
|
|
|
1158
1162
|
* data on a chart or table.
|
|
1159
1163
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1160
1164
|
* @example
|
|
1161
|
-
|
|
1165
|
+
* ```js
|
|
1162
1166
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
1163
1167
|
* console.log('Drill include', payload);
|
|
1164
1168
|
* })
|
|
1165
|
-
|
|
1169
|
+
* ```
|
|
1166
1170
|
*/
|
|
1167
1171
|
EmbedEvent["DrillInclude"] = "context-menu-item-include";
|
|
1168
1172
|
/**
|
|
@@ -1170,22 +1174,22 @@
|
|
|
1170
1174
|
* data on a chart or table
|
|
1171
1175
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1172
1176
|
* @example
|
|
1173
|
-
|
|
1177
|
+
* ```js
|
|
1174
1178
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
1175
1179
|
* console.log('Drill exclude', payload);
|
|
1176
1180
|
* })
|
|
1177
|
-
|
|
1181
|
+
* ```
|
|
1178
1182
|
*/
|
|
1179
1183
|
EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
|
|
1180
1184
|
/**
|
|
1181
1185
|
* Emitted when a column value is copied in the embedded app.
|
|
1182
1186
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1183
1187
|
* @example
|
|
1184
|
-
|
|
1185
|
-
*
|
|
1188
|
+
* ```js
|
|
1189
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
1186
1190
|
* console.log('copy to clipboard', payload);
|
|
1187
1191
|
* })
|
|
1188
|
-
|
|
1192
|
+
* ```
|
|
1189
1193
|
*/
|
|
1190
1194
|
EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
|
|
1191
1195
|
/**
|
|
@@ -1193,10 +1197,10 @@
|
|
|
1193
1197
|
* embedded Liveboard.
|
|
1194
1198
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1195
1199
|
* @example
|
|
1196
|
-
|
|
1200
|
+
* ```js
|
|
1197
1201
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
1198
1202
|
* })
|
|
1199
|
-
|
|
1203
|
+
* ```
|
|
1200
1204
|
*/
|
|
1201
1205
|
EmbedEvent["UpdateTML"] = "updateTSL";
|
|
1202
1206
|
/**
|
|
@@ -1204,11 +1208,11 @@
|
|
|
1204
1208
|
* on an embedded Liveboard.
|
|
1205
1209
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1206
1210
|
* @example
|
|
1207
|
-
|
|
1211
|
+
* ```js
|
|
1208
1212
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
1209
1213
|
* console.log('Edit TML', payload);
|
|
1210
1214
|
* })
|
|
1211
|
-
|
|
1215
|
+
* ```
|
|
1212
1216
|
*/
|
|
1213
1217
|
EmbedEvent["EditTML"] = "editTSL";
|
|
1214
1218
|
/**
|
|
@@ -1217,25 +1221,25 @@
|
|
|
1217
1221
|
* Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
|
|
1218
1222
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1219
1223
|
* @example
|
|
1220
|
-
|
|
1224
|
+
* ```js
|
|
1221
1225
|
* //emit when action starts
|
|
1222
1226
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1223
1227
|
* console.log('Export TML', payload)}, { start: true })
|
|
1224
1228
|
* //emit when action ends
|
|
1225
1229
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1226
1230
|
* console.log('Export TML', payload)})
|
|
1227
|
-
|
|
1231
|
+
* ```
|
|
1228
1232
|
*/
|
|
1229
1233
|
EmbedEvent["ExportTML"] = "exportTSL";
|
|
1230
1234
|
/**
|
|
1231
1235
|
* Emitted when an Answer is saved as a View.
|
|
1232
1236
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1233
1237
|
* @example
|
|
1234
|
-
|
|
1238
|
+
* ```js
|
|
1235
1239
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
1236
1240
|
* console.log('View', payload);
|
|
1237
1241
|
* })
|
|
1238
|
-
|
|
1242
|
+
* ```
|
|
1239
1243
|
*/
|
|
1240
1244
|
EmbedEvent["SaveAsView"] = "saveAsView";
|
|
1241
1245
|
/**
|
|
@@ -1243,36 +1247,36 @@
|
|
|
1243
1247
|
* 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.
|
|
1244
1248
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1245
1249
|
* @example
|
|
1246
|
-
|
|
1250
|
+
* ```js
|
|
1247
1251
|
* //emit when action starts
|
|
1248
1252
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1249
1253
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
1250
1254
|
* //emit when action ends
|
|
1251
1255
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1252
1256
|
* console.log('Copy and edit', payload)})
|
|
1253
|
-
|
|
1257
|
+
* ```
|
|
1254
1258
|
*/
|
|
1255
1259
|
EmbedEvent["CopyAEdit"] = "copyAEdit";
|
|
1256
1260
|
/**
|
|
1257
1261
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
1258
1262
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1259
1263
|
* @example
|
|
1260
|
-
|
|
1264
|
+
* ```js
|
|
1261
1265
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
1262
1266
|
* console.log('show data', payload);
|
|
1263
1267
|
* })
|
|
1264
|
-
|
|
1268
|
+
* ```
|
|
1265
1269
|
*/
|
|
1266
1270
|
EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
|
|
1267
1271
|
/**
|
|
1268
1272
|
* Emitted when an Answer is switched to a chart or table view.
|
|
1269
1273
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1270
1274
|
* @example
|
|
1271
|
-
|
|
1275
|
+
* ```js
|
|
1272
1276
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
1273
1277
|
* console.log('switch view', payload);
|
|
1274
1278
|
* })
|
|
1275
|
-
|
|
1279
|
+
* ```
|
|
1276
1280
|
*/
|
|
1277
1281
|
EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
1278
1282
|
/**
|
|
@@ -1289,118 +1293,118 @@
|
|
|
1289
1293
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
1290
1294
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1291
1295
|
* @example
|
|
1292
|
-
|
|
1296
|
+
* ```js
|
|
1293
1297
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
1294
1298
|
* console.log('Liveboard details', payload);
|
|
1295
1299
|
* })
|
|
1296
|
-
|
|
1300
|
+
* ```
|
|
1297
1301
|
*/
|
|
1298
1302
|
EmbedEvent["LiveboardInfo"] = "pinboardInfo";
|
|
1299
1303
|
/**
|
|
1300
1304
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1301
1305
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1302
1306
|
* @example
|
|
1303
|
-
|
|
1307
|
+
* ```js
|
|
1304
1308
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
1305
1309
|
* console.log('favorites', payload);
|
|
1306
1310
|
* })
|
|
1307
|
-
|
|
1311
|
+
* ```
|
|
1308
1312
|
*/
|
|
1309
1313
|
EmbedEvent["AddToFavorites"] = "addToFavorites";
|
|
1310
1314
|
/**
|
|
1311
1315
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
1312
1316
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1313
1317
|
* @example
|
|
1314
|
-
|
|
1318
|
+
* ```js
|
|
1315
1319
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
1316
|
-
* console.log(
|
|
1320
|
+
* console.log('Liveboard schedule', payload);
|
|
1317
1321
|
* })
|
|
1318
|
-
|
|
1322
|
+
* ```
|
|
1319
1323
|
*/
|
|
1320
1324
|
EmbedEvent["Schedule"] = "subscription";
|
|
1321
1325
|
/**
|
|
1322
1326
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
1323
1327
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1324
1328
|
* @example
|
|
1325
|
-
|
|
1329
|
+
* ```js
|
|
1326
1330
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
1327
|
-
* console.log(
|
|
1331
|
+
* console.log('Liveboard edit', payload);
|
|
1328
1332
|
* })
|
|
1329
|
-
|
|
1333
|
+
* ```
|
|
1330
1334
|
*/
|
|
1331
1335
|
EmbedEvent["Edit"] = "edit";
|
|
1332
1336
|
/**
|
|
1333
1337
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
1334
1338
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1335
1339
|
* @example
|
|
1336
|
-
|
|
1340
|
+
* ```js
|
|
1337
1341
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
1338
|
-
* console.log(
|
|
1342
|
+
* console.log('Copy', payload);
|
|
1339
1343
|
* })
|
|
1340
|
-
|
|
1344
|
+
* ```
|
|
1341
1345
|
*/
|
|
1342
1346
|
EmbedEvent["MakeACopy"] = "makeACopy";
|
|
1343
1347
|
/**
|
|
1344
1348
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
1345
1349
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1346
1350
|
* @example
|
|
1347
|
-
|
|
1351
|
+
* ```js
|
|
1348
1352
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
1349
|
-
|
|
1353
|
+
* ```
|
|
1350
1354
|
* @example
|
|
1351
|
-
|
|
1355
|
+
* ```js
|
|
1352
1356
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
1353
1357
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1354
1358
|
* })
|
|
1355
|
-
|
|
1359
|
+
* ```
|
|
1356
1360
|
*/
|
|
1357
1361
|
EmbedEvent["Present"] = "present";
|
|
1358
1362
|
/**
|
|
1359
1363
|
* Emitted when a user clicks **Delete** on a visualization
|
|
1360
1364
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1361
1365
|
* @example
|
|
1362
|
-
|
|
1366
|
+
* ```js
|
|
1363
1367
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
1364
1368
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1365
|
-
|
|
1369
|
+
* ```
|
|
1366
1370
|
*/
|
|
1367
1371
|
EmbedEvent["Delete"] = "delete";
|
|
1368
1372
|
/**
|
|
1369
1373
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1370
1374
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1371
1375
|
* @example
|
|
1372
|
-
|
|
1376
|
+
* ```js
|
|
1373
1377
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
1374
|
-
|
|
1378
|
+
* ```
|
|
1375
1379
|
*/
|
|
1376
1380
|
EmbedEvent["SchedulesList"] = "schedule-list";
|
|
1377
1381
|
/**
|
|
1378
1382
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
1379
1383
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1380
1384
|
* @example
|
|
1381
|
-
|
|
1385
|
+
* ```js
|
|
1382
1386
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
1383
|
-
|
|
1387
|
+
* ```
|
|
1384
1388
|
*/
|
|
1385
1389
|
EmbedEvent["Cancel"] = "cancel";
|
|
1386
1390
|
/**
|
|
1387
1391
|
* Emitted when a user clicks **Explore** on a visualization
|
|
1388
1392
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1389
1393
|
* @example
|
|
1390
|
-
|
|
1394
|
+
* ```js
|
|
1391
1395
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
1392
1396
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1393
|
-
|
|
1397
|
+
* ```
|
|
1394
1398
|
*/
|
|
1395
1399
|
EmbedEvent["Explore"] = "explore";
|
|
1396
1400
|
/**
|
|
1397
1401
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
1398
1402
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1399
1403
|
* @example
|
|
1400
|
-
|
|
1404
|
+
* ```js
|
|
1401
1405
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
1402
1406
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1403
|
-
|
|
1407
|
+
* ```
|
|
1404
1408
|
*/
|
|
1405
1409
|
EmbedEvent["CopyLink"] = "embedDocument";
|
|
1406
1410
|
/**
|
|
@@ -1408,21 +1412,21 @@
|
|
|
1408
1412
|
* visualization or Liveboard.
|
|
1409
1413
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1410
1414
|
* @example
|
|
1411
|
-
|
|
1415
|
+
* ```js
|
|
1412
1416
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
1413
1417
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1414
|
-
|
|
1418
|
+
* ```
|
|
1415
1419
|
*/
|
|
1416
1420
|
EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
|
|
1417
1421
|
/**
|
|
1418
1422
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
1419
1423
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1420
1424
|
* @example
|
|
1421
|
-
|
|
1425
|
+
* ```js
|
|
1422
1426
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
1423
1427
|
* console.log('VizPointClick', payload)
|
|
1424
1428
|
* })
|
|
1425
|
-
|
|
1429
|
+
* ```
|
|
1426
1430
|
*/
|
|
1427
1431
|
EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
|
|
1428
1432
|
/**
|
|
@@ -1436,35 +1440,35 @@
|
|
|
1436
1440
|
* filter details.
|
|
1437
1441
|
* @example
|
|
1438
1442
|
*
|
|
1439
|
-
|
|
1443
|
+
* ```js
|
|
1440
1444
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1441
1445
|
* console.log('payload', payload);
|
|
1442
1446
|
* })
|
|
1443
|
-
*
|
|
1447
|
+
* ```
|
|
1444
1448
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
1445
1449
|
*/
|
|
1446
1450
|
EmbedEvent["FilterChanged"] = "filterChanged";
|
|
1447
1451
|
/**
|
|
1448
1452
|
* Emitted when a user clicks the **Go** button to initiate
|
|
1449
1453
|
* a Natural Language Search query
|
|
1450
|
-
* @version SDK
|
|
1454
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1451
1455
|
*/
|
|
1452
1456
|
EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
|
|
1453
1457
|
/**
|
|
1454
1458
|
* Emitted when a user selects a data source on the embedded
|
|
1455
1459
|
* Natural Language Search interface.
|
|
1456
1460
|
*
|
|
1457
|
-
* @version SDK
|
|
1461
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1458
1462
|
*/
|
|
1459
1463
|
EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
|
|
1460
1464
|
/**
|
|
1461
1465
|
* Emitted when a user updates a connection on the **Data** page
|
|
1462
|
-
* @version SDK
|
|
1466
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1463
1467
|
*/
|
|
1464
1468
|
EmbedEvent["UpdateConnection"] = "updateConnection";
|
|
1465
1469
|
/**
|
|
1466
1470
|
* Emitted when a user updates a connection on the **Data** page
|
|
1467
|
-
* @version SDK
|
|
1471
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1468
1472
|
*/
|
|
1469
1473
|
EmbedEvent["CreateConnection"] = "createConnection";
|
|
1470
1474
|
/**
|
|
@@ -1474,7 +1478,7 @@
|
|
|
1474
1478
|
* @returns viewId: string
|
|
1475
1479
|
* @returns liveboardId: string
|
|
1476
1480
|
* @returns isPublic: boolean
|
|
1477
|
-
* @version SDK
|
|
1481
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1478
1482
|
*/
|
|
1479
1483
|
EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
|
|
1480
1484
|
/**
|
|
@@ -1483,7 +1487,7 @@
|
|
|
1483
1487
|
* @returns viewId: string
|
|
1484
1488
|
* @returns liveboardId: string
|
|
1485
1489
|
* @returns isPublic: boolean
|
|
1486
|
-
* @version SDK
|
|
1490
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1487
1491
|
*/
|
|
1488
1492
|
EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
|
|
1489
1493
|
/**
|
|
@@ -1492,19 +1496,19 @@
|
|
|
1492
1496
|
* @returns viewId: string
|
|
1493
1497
|
* @returns liveboardId: string
|
|
1494
1498
|
* @returns isPublic: boolean
|
|
1495
|
-
* @version SDK
|
|
1499
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1496
1500
|
*/
|
|
1497
1501
|
EmbedEvent["ResetLiveboard"] = "resetLiveboard";
|
|
1498
1502
|
/**
|
|
1499
1503
|
* Emitted when a PersonalisedView is deleted.
|
|
1500
1504
|
* @returns views: string[]
|
|
1501
1505
|
* @returns liveboardId: string
|
|
1502
|
-
* @version SDK
|
|
1506
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1503
1507
|
*/
|
|
1504
1508
|
EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
|
|
1505
1509
|
/**
|
|
1506
1510
|
* Emitted when a user creates a Worksheet.
|
|
1507
|
-
* @version SDK
|
|
1511
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1508
1512
|
*/
|
|
1509
1513
|
EmbedEvent["CreateWorksheet"] = "createWorksheet";
|
|
1510
1514
|
/**
|
|
@@ -1513,12 +1517,12 @@
|
|
|
1513
1517
|
* @returns viewId: string
|
|
1514
1518
|
* @returns liveboardId: string
|
|
1515
1519
|
* @returns isPublic: boolean
|
|
1516
|
-
* @version SDK
|
|
1520
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
1517
1521
|
*/
|
|
1518
1522
|
EmbedEvent["AskSageInit"] = "AskSageInit";
|
|
1519
1523
|
/**
|
|
1520
1524
|
* Emitted when a Liveboard or visualization is renamed.
|
|
1521
|
-
* @version SDK
|
|
1525
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
1522
1526
|
*/
|
|
1523
1527
|
EmbedEvent["Rename"] = "rename";
|
|
1524
1528
|
/**
|
|
@@ -1536,14 +1540,12 @@
|
|
|
1536
1540
|
* - `payload`: The payload received from the embed related to the Data API call.
|
|
1537
1541
|
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
1538
1542
|
* will run or block the search operation, and if blocked, which error message to provide.
|
|
1539
|
-
*
|
|
1540
|
-
* `execute` - When `execute` returns `true`, the search is run.
|
|
1543
|
+
* - `execute` - When `execute` returns `true`, the search is run.
|
|
1541
1544
|
* When `execute` returns `false`, the search is not executed.
|
|
1542
|
-
*
|
|
1543
|
-
* `error` - Developers can customize the user-facing error message when `execute`
|
|
1545
|
+
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
1544
1546
|
* is `false` by using the `error` parameters in `responder`.
|
|
1545
|
-
* `errorText` - The error message text shown to the user.
|
|
1546
|
-
* @version SDK
|
|
1547
|
+
* - `errorText` - The error message text shown to the user.
|
|
1548
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1547
1549
|
* @example
|
|
1548
1550
|
*
|
|
1549
1551
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -1558,7 +1560,7 @@
|
|
|
1558
1560
|
* },
|
|
1559
1561
|
* },
|
|
1560
1562
|
* });
|
|
1561
|
-
* })
|
|
1563
|
+
* })
|
|
1562
1564
|
* ```
|
|
1563
1565
|
* @example
|
|
1564
1566
|
*
|
|
@@ -1584,7 +1586,7 @@
|
|
|
1584
1586
|
* },
|
|
1585
1587
|
* },
|
|
1586
1588
|
* });
|
|
1587
|
-
* })
|
|
1589
|
+
* })
|
|
1588
1590
|
* ```
|
|
1589
1591
|
*/
|
|
1590
1592
|
EmbedEvent["OnBeforeGetVizDataIntercept"] = "onBeforeGetVizDataIntercept";
|
|
@@ -1595,8 +1597,8 @@
|
|
|
1595
1597
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
1596
1598
|
* console.log('payload', payload);
|
|
1597
1599
|
* })
|
|
1598
|
-
|
|
1599
|
-
* @version SDK
|
|
1600
|
+
* ```
|
|
1601
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1600
1602
|
*/
|
|
1601
1603
|
EmbedEvent["ParameterChanged"] = "parameterChanged";
|
|
1602
1604
|
/**
|
|
@@ -1651,24 +1653,24 @@
|
|
|
1651
1653
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
1652
1654
|
* console.log('payload', payload);
|
|
1653
1655
|
* })
|
|
1654
|
-
|
|
1655
|
-
* @version SDK
|
|
1656
|
+
* ```
|
|
1657
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1656
1658
|
*/
|
|
1657
1659
|
EmbedEvent["CreateLiveboard"] = "createLiveboard";
|
|
1658
1660
|
/**
|
|
1659
1661
|
* Emitted when a user creates a Model.
|
|
1660
|
-
* @version SDK
|
|
1662
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1661
1663
|
*/
|
|
1662
1664
|
EmbedEvent["CreateModel"] = "createModel";
|
|
1663
1665
|
/**
|
|
1664
1666
|
* @hidden
|
|
1665
1667
|
* Emitted when a user exits present mode.
|
|
1666
|
-
* @version SDK
|
|
1668
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1667
1669
|
*/
|
|
1668
1670
|
EmbedEvent["ExitPresentMode"] = "exitPresentMode";
|
|
1669
1671
|
/**
|
|
1670
1672
|
* Emitted when a user requests the full height lazy load data.
|
|
1671
|
-
* @version SDK
|
|
1673
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1672
1674
|
* @hidden
|
|
1673
1675
|
*/
|
|
1674
1676
|
EmbedEvent["RequestVisibleEmbedCoordinates"] = "requestVisibleEmbedCoordinates";
|
|
@@ -1679,7 +1681,7 @@
|
|
|
1679
1681
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
1680
1682
|
* console.log('payload', payload);
|
|
1681
1683
|
* })
|
|
1682
|
-
|
|
1684
|
+
* ```
|
|
1683
1685
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1684
1686
|
*/
|
|
1685
1687
|
EmbedEvent["SpotterData"] = "SpotterData";
|
|
@@ -1690,7 +1692,7 @@
|
|
|
1690
1692
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
1691
1693
|
* console.log('payload', payload);
|
|
1692
1694
|
* })
|
|
1693
|
-
|
|
1695
|
+
* ```
|
|
1694
1696
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1695
1697
|
*/
|
|
1696
1698
|
EmbedEvent["PreviewSpotterData"] = "PreviewSpotterData";
|
|
@@ -1701,7 +1703,7 @@
|
|
|
1701
1703
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
1702
1704
|
* console.log('payload', payload);
|
|
1703
1705
|
* })
|
|
1704
|
-
|
|
1706
|
+
* ```
|
|
1705
1707
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
1706
1708
|
*/
|
|
1707
1709
|
EmbedEvent["AddToCoaching"] = "addToCoaching";
|
|
@@ -1723,7 +1725,7 @@
|
|
|
1723
1725
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
1724
1726
|
* console.log('payload', payload);
|
|
1725
1727
|
* })
|
|
1726
|
-
|
|
1728
|
+
* ```
|
|
1727
1729
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1728
1730
|
*/
|
|
1729
1731
|
EmbedEvent["SpotterQueryTriggered"] = "SpotterQueryTriggered";
|
|
@@ -1734,7 +1736,7 @@
|
|
|
1734
1736
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
1735
1737
|
* console.log('payload', payload);
|
|
1736
1738
|
* })
|
|
1737
|
-
|
|
1739
|
+
* ```
|
|
1738
1740
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1739
1741
|
*/
|
|
1740
1742
|
EmbedEvent["LastPromptEdited"] = "LastPromptEdited";
|
|
@@ -1745,18 +1747,18 @@
|
|
|
1745
1747
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
1746
1748
|
* console.log('payload', payload);
|
|
1747
1749
|
* })
|
|
1748
|
-
|
|
1750
|
+
* ```
|
|
1749
1751
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1750
1752
|
*/
|
|
1751
1753
|
EmbedEvent["LastPromptDeleted"] = "LastPromptDeleted";
|
|
1752
1754
|
/**
|
|
1753
|
-
* Emitted when the
|
|
1755
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
1754
1756
|
* @example
|
|
1755
1757
|
* ```js
|
|
1756
1758
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
1757
1759
|
* console.log('payload', payload);
|
|
1758
1760
|
* })
|
|
1759
|
-
|
|
1761
|
+
* ```
|
|
1760
1762
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1761
1763
|
*/
|
|
1762
1764
|
EmbedEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
|
|
@@ -1767,7 +1769,7 @@
|
|
|
1767
1769
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
1768
1770
|
* console.log('payload', payload);
|
|
1769
1771
|
* })
|
|
1770
|
-
|
|
1772
|
+
* ```
|
|
1771
1773
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
1772
1774
|
*/
|
|
1773
1775
|
EmbedEvent["SpotterInit"] = "spotterInit";
|
|
@@ -1778,7 +1780,7 @@
|
|
|
1778
1780
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
1779
1781
|
* console.log('payload', payload);
|
|
1780
1782
|
* })
|
|
1781
|
-
|
|
1783
|
+
* ```
|
|
1782
1784
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
1783
1785
|
*/
|
|
1784
1786
|
EmbedEvent["SpotterLoadComplete"] = "spotterLoadComplete";
|
|
@@ -2133,7 +2135,7 @@
|
|
|
2133
2135
|
* ```js
|
|
2134
2136
|
* appEmbed.navigateToPage(-1)
|
|
2135
2137
|
* ```
|
|
2136
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
2138
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
2137
2139
|
*/
|
|
2138
2140
|
HostEvent["Navigate"] = "Navigate";
|
|
2139
2141
|
/**
|
|
@@ -2266,9 +2268,9 @@
|
|
|
2266
2268
|
* Trigger the **Show Liveboard details** action
|
|
2267
2269
|
* on an embedded Liveboard.
|
|
2268
2270
|
* @example
|
|
2269
|
-
|
|
2271
|
+
* ```js
|
|
2270
2272
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
2271
|
-
|
|
2273
|
+
* ```
|
|
2272
2274
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2273
2275
|
*/
|
|
2274
2276
|
HostEvent["LiveboardInfo"] = "pinboardInfo";
|
|
@@ -2396,7 +2398,7 @@
|
|
|
2396
2398
|
* appEmbed.trigger(HostEvent.Remove)
|
|
2397
2399
|
* ```
|
|
2398
2400
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2399
|
-
*
|
|
2401
|
+
* @example
|
|
2400
2402
|
* ```js
|
|
2401
2403
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
2402
2404
|
* ```
|
|
@@ -2487,7 +2489,7 @@
|
|
|
2487
2489
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2488
2490
|
* ```
|
|
2489
2491
|
* ```js
|
|
2490
|
-
* vizEmbed.trigger(
|
|
2492
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
2491
2493
|
* ```
|
|
2492
2494
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2493
2495
|
*/
|
|
@@ -2504,7 +2506,7 @@
|
|
|
2504
2506
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2505
2507
|
* ```
|
|
2506
2508
|
* ```js
|
|
2507
|
-
* vizEmbed.trigger(
|
|
2509
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
2508
2510
|
* ```
|
|
2509
2511
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2510
2512
|
*/
|
|
@@ -2519,23 +2521,22 @@
|
|
|
2519
2521
|
* );
|
|
2520
2522
|
* })
|
|
2521
2523
|
* ```
|
|
2522
|
-
*
|
|
2524
|
+
* @example
|
|
2523
2525
|
* ```js
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
|
|
2529
|
-
|
|
2530
|
-
|
|
2531
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
2526
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
2527
|
+
* let latestSpotterVizId = '';
|
|
2528
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
2529
|
+
* latestSpotterVizId = payload.data.id;
|
|
2530
|
+
* });
|
|
2531
|
+
*
|
|
2532
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
2532
2533
|
* vizId: latestSpotterVizId
|
|
2533
2534
|
* }).then((tml) => {
|
|
2534
2535
|
* console.log(
|
|
2535
2536
|
* tml.answer.search_query // TML representation of the search query
|
|
2536
2537
|
* );
|
|
2537
2538
|
* })
|
|
2538
|
-
|
|
2539
|
+
* ```
|
|
2539
2540
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2540
2541
|
* @important
|
|
2541
2542
|
*/
|
|
@@ -2599,6 +2600,11 @@
|
|
|
2599
2600
|
/**
|
|
2600
2601
|
* Trigger the **Download** action on charts in
|
|
2601
2602
|
* the embedded view.
|
|
2603
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
2604
|
+
*
|
|
2605
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2606
|
+
*
|
|
2607
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2602
2608
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
2603
2609
|
* @example
|
|
2604
2610
|
* ```js
|
|
@@ -2617,9 +2623,6 @@
|
|
|
2617
2623
|
*
|
|
2618
2624
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
2619
2625
|
* ```
|
|
2620
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2621
|
-
* Use {@link DownloadAsPng}
|
|
2622
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2623
2626
|
*/
|
|
2624
2627
|
HostEvent["Download"] = "downloadAsPng";
|
|
2625
2628
|
/**
|
|
@@ -3057,8 +3060,8 @@
|
|
|
3057
3060
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
3058
3061
|
* console.log('parameters', parameter);
|
|
3059
3062
|
* });
|
|
3060
|
-
|
|
3061
|
-
|
|
3063
|
+
* ```
|
|
3064
|
+
* ```js
|
|
3062
3065
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
3063
3066
|
* let latestSpotterVizId = '';
|
|
3064
3067
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -3066,7 +3069,7 @@
|
|
|
3066
3069
|
* });
|
|
3067
3070
|
*
|
|
3068
3071
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
3069
|
-
|
|
3072
|
+
* ```
|
|
3070
3073
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
3071
3074
|
*/
|
|
3072
3075
|
HostEvent["GetParameters"] = "GetParameters";
|
|
@@ -3083,7 +3086,7 @@
|
|
|
3083
3086
|
* Notify when info call is completed successfully
|
|
3084
3087
|
* ```js
|
|
3085
3088
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
3086
|
-
|
|
3089
|
+
* ```
|
|
3087
3090
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
3088
3091
|
*/
|
|
3089
3092
|
HostEvent["InfoSuccess"] = "InfoSuccess";
|
|
@@ -3186,7 +3189,7 @@
|
|
|
3186
3189
|
* ```js
|
|
3187
3190
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
3188
3191
|
*
|
|
3189
|
-
|
|
3192
|
+
* ```
|
|
3190
3193
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3191
3194
|
*/
|
|
3192
3195
|
HostEvent["AddToCoaching"] = "addToCoaching";
|
|
@@ -3228,7 +3231,7 @@
|
|
|
3228
3231
|
* });
|
|
3229
3232
|
*
|
|
3230
3233
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
3231
|
-
|
|
3234
|
+
* ```
|
|
3232
3235
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3233
3236
|
*/
|
|
3234
3237
|
HostEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
@@ -3238,7 +3241,7 @@
|
|
|
3238
3241
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
3239
3242
|
* ```js
|
|
3240
3243
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
3241
|
-
|
|
3244
|
+
* ```
|
|
3242
3245
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3243
3246
|
*/
|
|
3244
3247
|
HostEvent["ExitPresentMode"] = "exitPresentMode";
|
|
@@ -3388,6 +3391,7 @@
|
|
|
3388
3391
|
// 'both' clicks in `contextMenuTrigger` configuration.
|
|
3389
3392
|
Param["ContextMenuTrigger"] = "contextMenuEnabledOnWhichClick";
|
|
3390
3393
|
Param["LinkOverride"] = "linkOverride";
|
|
3394
|
+
Param["EnableLinkOverridesV2"] = "enableLinkOverridesV2";
|
|
3391
3395
|
Param["blockNonEmbedFullAppAccess"] = "blockNonEmbedFullAppAccess";
|
|
3392
3396
|
Param["ShowInsertToSlide"] = "insertInToSlide";
|
|
3393
3397
|
Param["PrimaryNavHidden"] = "primaryNavHidden";
|
|
@@ -3482,6 +3486,7 @@
|
|
|
3482
3486
|
Param["IsThisPeriodInDateFiltersEnabled"] = "isThisPeriodInDateFiltersEnabled";
|
|
3483
3487
|
Param["HideToolResponseCardBranding"] = "hideToolResponseCardBranding";
|
|
3484
3488
|
Param["ToolResponseCardBrandingLabel"] = "toolResponseCardBrandingLabel";
|
|
3489
|
+
Param["EnableHomepageAnnouncement"] = "enableHomepageAnnouncement";
|
|
3485
3490
|
})(Param || (Param = {}));
|
|
3486
3491
|
/**
|
|
3487
3492
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3641,14 +3646,14 @@
|
|
|
3641
3646
|
* ```js
|
|
3642
3647
|
* disabledActions: [Action.CollapseDataPanel]
|
|
3643
3648
|
* ```
|
|
3644
|
-
* @version
|
|
3649
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
3645
3650
|
*/
|
|
3646
3651
|
Action["CollapseDataSources"] = "collapseDataSources";
|
|
3647
3652
|
/**
|
|
3648
3653
|
* The **Collapse data panel** icon on the Search page.
|
|
3649
3654
|
* Collapses the data panel view.
|
|
3650
3655
|
*
|
|
3651
|
-
* @version
|
|
3656
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
3652
3657
|
*
|
|
3653
3658
|
* @example
|
|
3654
3659
|
* ```js
|
|
@@ -4095,13 +4100,12 @@
|
|
|
4095
4100
|
*/
|
|
4096
4101
|
Action["CreateMonitor"] = "createMonitor";
|
|
4097
4102
|
/**
|
|
4098
|
-
* @
|
|
4099
|
-
*
|
|
4103
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
4104
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
4100
4105
|
* @example
|
|
4101
4106
|
* ```js
|
|
4102
4107
|
* disabledActions: [Action.ReportError]
|
|
4103
4108
|
* ```
|
|
4104
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
4105
4109
|
*/
|
|
4106
4110
|
Action["ReportError"] = "reportError";
|
|
4107
4111
|
/**
|
|
@@ -4111,7 +4115,7 @@
|
|
|
4111
4115
|
* ```js
|
|
4112
4116
|
* disabledActions: [Action.SyncToSheets]
|
|
4113
4117
|
* ```
|
|
4114
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4118
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4115
4119
|
*/
|
|
4116
4120
|
Action["SyncToSheets"] = "sync-to-sheets";
|
|
4117
4121
|
/**
|
|
@@ -4122,7 +4126,7 @@
|
|
|
4122
4126
|
* ```js
|
|
4123
4127
|
* disabledActions: [Action.SyncToOtherApps]
|
|
4124
4128
|
* ```
|
|
4125
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4129
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4126
4130
|
*/
|
|
4127
4131
|
Action["SyncToOtherApps"] = "sync-to-other-apps";
|
|
4128
4132
|
/**
|
|
@@ -4132,7 +4136,7 @@
|
|
|
4132
4136
|
* ```js
|
|
4133
4137
|
* disabledActions: [Action.ManagePipelines]
|
|
4134
4138
|
* ```
|
|
4135
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4139
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4136
4140
|
*/
|
|
4137
4141
|
Action["ManagePipelines"] = "manage-pipeline";
|
|
4138
4142
|
/**
|
|
@@ -4444,7 +4448,7 @@
|
|
|
4444
4448
|
* ```js
|
|
4445
4449
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
4446
4450
|
* ```
|
|
4447
|
-
* @version SDK
|
|
4451
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4448
4452
|
*/
|
|
4449
4453
|
Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
|
|
4450
4454
|
/**
|
|
@@ -4454,7 +4458,7 @@
|
|
|
4454
4458
|
* ```js
|
|
4455
4459
|
* disabledActions: [Action.LiveboardUsers]
|
|
4456
4460
|
* ```
|
|
4457
|
-
* @version SDK
|
|
4461
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4458
4462
|
*/
|
|
4459
4463
|
Action["LiveboardUsers"] = "liveboardUsers";
|
|
4460
4464
|
/**
|
|
@@ -4472,7 +4476,7 @@
|
|
|
4472
4476
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
4473
4477
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
4474
4478
|
* ```
|
|
4475
|
-
* @version SDK
|
|
4479
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
4476
4480
|
*/
|
|
4477
4481
|
Action["TML"] = "tml";
|
|
4478
4482
|
/**
|
|
@@ -4518,7 +4522,7 @@
|
|
|
4518
4522
|
* ```js
|
|
4519
4523
|
* disabledActions: [Action.AddToWatchlist]
|
|
4520
4524
|
* ```
|
|
4521
|
-
* @version SDK
|
|
4525
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
4522
4526
|
*/
|
|
4523
4527
|
Action["AddToWatchlist"] = "addToWatchlist";
|
|
4524
4528
|
/**
|
|
@@ -4528,7 +4532,7 @@
|
|
|
4528
4532
|
* ```js
|
|
4529
4533
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
4530
4534
|
* ```
|
|
4531
|
-
* @version SDK
|
|
4535
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
4532
4536
|
*/
|
|
4533
4537
|
Action["RemoveFromWatchlist"] = "removeFromWatchlist";
|
|
4534
4538
|
/**
|
|
@@ -4539,7 +4543,7 @@
|
|
|
4539
4543
|
* ```js
|
|
4540
4544
|
* disabledActions: [Action.OrganiseFavourites]
|
|
4541
4545
|
* ```
|
|
4542
|
-
* @version SDK
|
|
4546
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
4543
4547
|
*/
|
|
4544
4548
|
Action["OrganiseFavourites"] = "organiseFavourites";
|
|
4545
4549
|
/**
|
|
@@ -4600,7 +4604,7 @@
|
|
|
4600
4604
|
* ```js
|
|
4601
4605
|
* disabledActions: [Action.ManageTags]
|
|
4602
4606
|
* ```
|
|
4603
|
-
* @version SDK
|
|
4607
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4604
4608
|
*/
|
|
4605
4609
|
Action["ManageTags"] = "manageTags";
|
|
4606
4610
|
/**
|
|
@@ -5033,18 +5037,80 @@
|
|
|
5033
5037
|
*/
|
|
5034
5038
|
exports.CustomActionsPosition = void 0;
|
|
5035
5039
|
(function (CustomActionsPosition) {
|
|
5040
|
+
/**
|
|
5041
|
+
* Shows the action as a primary button
|
|
5042
|
+
* in the toolbar area of the embed.
|
|
5043
|
+
*/
|
|
5036
5044
|
CustomActionsPosition["PRIMARY"] = "PRIMARY";
|
|
5045
|
+
/**
|
|
5046
|
+
* Shows the action inside the "More" menu
|
|
5047
|
+
* (three-dot overflow menu).
|
|
5048
|
+
*/
|
|
5037
5049
|
CustomActionsPosition["MENU"] = "MENU";
|
|
5050
|
+
/**
|
|
5051
|
+
* Shows the action in the right-click
|
|
5052
|
+
* context menu. Only supported for
|
|
5053
|
+
* {@link CustomActionTarget.VIZ},
|
|
5054
|
+
* {@link CustomActionTarget.ANSWER}, and
|
|
5055
|
+
* {@link CustomActionTarget.SPOTTER} targets.
|
|
5056
|
+
*/
|
|
5038
5057
|
CustomActionsPosition["CONTEXTMENU"] = "CONTEXTMENU";
|
|
5039
5058
|
})(exports.CustomActionsPosition || (exports.CustomActionsPosition = {}));
|
|
5040
5059
|
/**
|
|
5041
|
-
* Enum options to mention the target of the custom action.
|
|
5060
|
+
* Enum options to mention the target of the code-based custom action.
|
|
5061
|
+
* The target determines which type of ThoughtSpot object the action is
|
|
5062
|
+
* associated with, and also controls which positions and scoping options
|
|
5063
|
+
* are available.
|
|
5042
5064
|
*/
|
|
5043
5065
|
var CustomActionTarget;
|
|
5044
5066
|
(function (CustomActionTarget) {
|
|
5067
|
+
/**
|
|
5068
|
+
* Action applies at the Liveboard level.
|
|
5069
|
+
* Supported positions:
|
|
5070
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
5071
|
+
* {@link CustomActionsPosition.MENU}.
|
|
5072
|
+
* Can be scoped with
|
|
5073
|
+
* `metadataIds.liveboardIds`,
|
|
5074
|
+
* `orgIds`, and `groupIds`.
|
|
5075
|
+
*/
|
|
5045
5076
|
CustomActionTarget["LIVEBOARD"] = "LIVEBOARD";
|
|
5077
|
+
/**
|
|
5078
|
+
* Action applies to individual
|
|
5079
|
+
* visualizations (charts/tables).
|
|
5080
|
+
* Supported positions:
|
|
5081
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
5082
|
+
* {@link CustomActionsPosition.MENU},
|
|
5083
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
5084
|
+
* Can be scoped with `metadataIds`
|
|
5085
|
+
* (answerIds, liveboardIds, vizIds),
|
|
5086
|
+
* `dataModelIds` (modelIds,
|
|
5087
|
+
* modelColumnNames), `orgIds`,
|
|
5088
|
+
* and `groupIds`.
|
|
5089
|
+
*/
|
|
5046
5090
|
CustomActionTarget["VIZ"] = "VIZ";
|
|
5091
|
+
/**
|
|
5092
|
+
* Action applies to saved or unsaved
|
|
5093
|
+
* Answers. Supported positions:
|
|
5094
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
5095
|
+
* {@link CustomActionsPosition.MENU},
|
|
5096
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
5097
|
+
* Can be scoped with
|
|
5098
|
+
* `metadataIds.answerIds`,
|
|
5099
|
+
* `dataModelIds` (modelIds,
|
|
5100
|
+
* modelColumnNames), `orgIds`,
|
|
5101
|
+
* and `groupIds`.
|
|
5102
|
+
*/
|
|
5047
5103
|
CustomActionTarget["ANSWER"] = "ANSWER";
|
|
5104
|
+
/**
|
|
5105
|
+
* Action applies to Spotter
|
|
5106
|
+
* (AI-powered search).
|
|
5107
|
+
* Supported positions:
|
|
5108
|
+
* {@link CustomActionsPosition.MENU},
|
|
5109
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
5110
|
+
* Can be scoped with
|
|
5111
|
+
* `dataModelIds.modelIds`,
|
|
5112
|
+
* `orgIds`, and `groupIds`.
|
|
5113
|
+
*/
|
|
5048
5114
|
CustomActionTarget["SPOTTER"] = "SPOTTER";
|
|
5049
5115
|
})(CustomActionTarget || (CustomActionTarget = {}));
|
|
5050
5116
|
/**
|
|
@@ -5485,7 +5551,7 @@
|
|
|
5485
5551
|
* @returns true if the value is a valid CSS margin value, false otherwise
|
|
5486
5552
|
*/
|
|
5487
5553
|
const isValidCssMargin = (value) => {
|
|
5488
|
-
if (isUndefined
|
|
5554
|
+
if (isUndefined(value)) {
|
|
5489
5555
|
return false;
|
|
5490
5556
|
}
|
|
5491
5557
|
if (typeof value !== 'string') {
|
|
@@ -5673,7 +5739,7 @@
|
|
|
5673
5739
|
element.style.removeProperty(styleProperty);
|
|
5674
5740
|
});
|
|
5675
5741
|
};
|
|
5676
|
-
const isUndefined
|
|
5742
|
+
const isUndefined = (value) => value === undefined;
|
|
5677
5743
|
// Return if the value is a string, double or boolean.
|
|
5678
5744
|
const getTypeFromValue = (value) => {
|
|
5679
5745
|
if (typeof value === 'string') {
|
|
@@ -5870,6 +5936,14 @@
|
|
|
5870
5936
|
return [false, error instanceof Error ? error : new Error(String(error))];
|
|
5871
5937
|
}
|
|
5872
5938
|
};
|
|
5939
|
+
/**
|
|
5940
|
+
* Resolves enablePastConversationsSidebar with
|
|
5941
|
+
* spotterSidebarConfig taking precedence over the
|
|
5942
|
+
* standalone flag.
|
|
5943
|
+
*/
|
|
5944
|
+
const resolveEnablePastConversationsSidebar = (params) => (params.spotterSidebarConfigValue !== undefined
|
|
5945
|
+
? params.spotterSidebarConfigValue
|
|
5946
|
+
: params.standaloneValue);
|
|
5873
5947
|
/**
|
|
5874
5948
|
* Sets a query parameter if the value is defined.
|
|
5875
5949
|
* @param queryParams - The query params object to modify
|
|
@@ -8450,7 +8524,7 @@
|
|
|
8450
8524
|
* tokenizedFetch("<TS_ORIGIN>/api/rest/2.0/auth/session/user", {
|
|
8451
8525
|
* // .. fetch options ..
|
|
8452
8526
|
* });
|
|
8453
|
-
|
|
8527
|
+
* ```
|
|
8454
8528
|
* @version SDK: 1.28.0
|
|
8455
8529
|
* @group Global methods
|
|
8456
8530
|
*/
|
|
@@ -8790,6 +8864,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
8790
8864
|
OperationType["GetChartWithData"] = "GetChartWithData";
|
|
8791
8865
|
OperationType["GetTableWithHeadlineData"] = "GetTableWithHeadlineData";
|
|
8792
8866
|
})(OperationType || (OperationType = {}));
|
|
8867
|
+
const DATA_TYPES = ['DATE', 'DATE_TIME', 'TIME'];
|
|
8793
8868
|
/**
|
|
8794
8869
|
* AnswerService provides a simple way to work with ThoughtSpot Answers.
|
|
8795
8870
|
*
|
|
@@ -8835,7 +8910,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
8835
8910
|
* });
|
|
8836
8911
|
* ```
|
|
8837
8912
|
*
|
|
8838
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
8913
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
8839
8914
|
* @group Events
|
|
8840
8915
|
*/
|
|
8841
8916
|
class AnswerService {
|
|
@@ -8896,6 +8971,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
8896
8971
|
* ]);
|
|
8897
8972
|
* console.log(await service.fetchData());
|
|
8898
8973
|
* });
|
|
8974
|
+
* ```
|
|
8899
8975
|
*/
|
|
8900
8976
|
async addColumnsByName(columnNames) {
|
|
8901
8977
|
const sourceDetail = await this.getSourceDetail();
|
|
@@ -9026,7 +9102,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
9026
9102
|
* const data = await underlying.fetchData(0, 100);
|
|
9027
9103
|
* })
|
|
9028
9104
|
* ```
|
|
9029
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
9105
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
9030
9106
|
*/
|
|
9031
9107
|
async getUnderlyingDataForPoint(outputColumnNames, selectedPoints) {
|
|
9032
9108
|
if (!selectedPoints && !this.selectedPoints) {
|
|
@@ -9145,7 +9221,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
9145
9221
|
const dataType = colVal.column.dataType;
|
|
9146
9222
|
colVal.column.id;
|
|
9147
9223
|
let dataValue;
|
|
9148
|
-
if (dataType
|
|
9224
|
+
if (DATA_TYPES.includes(dataType)) {
|
|
9149
9225
|
if (Number.isFinite(colVal.value)) {
|
|
9150
9226
|
dataValue = [{
|
|
9151
9227
|
epochRange: {
|
|
@@ -17585,20 +17661,45 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
17585
17661
|
var AuthStatus;
|
|
17586
17662
|
(function (AuthStatus) {
|
|
17587
17663
|
/**
|
|
17588
|
-
* Emits when the SDK fails to authenticate
|
|
17664
|
+
* Emits when the SDK fails to authenticate.
|
|
17589
17665
|
*/
|
|
17590
17666
|
AuthStatus["FAILURE"] = "FAILURE";
|
|
17591
17667
|
/**
|
|
17592
|
-
* Emits when the SDK
|
|
17668
|
+
* Emits when the SDK authentication step completes
|
|
17669
|
+
* successfully (e.g., token exchange, cookie set).
|
|
17670
|
+
* This fires before any iframe is rendered. Use
|
|
17671
|
+
* this to know that auth passed and it is safe to
|
|
17672
|
+
* proceed with rendering. The callback receives no
|
|
17673
|
+
* arguments.
|
|
17674
|
+
* @example
|
|
17675
|
+
* ```js
|
|
17676
|
+
* const authEE = init({ ... });
|
|
17677
|
+
* authEE.on(AuthStatus.SDK_SUCCESS, () => {
|
|
17678
|
+
* // Auth done, iframe not loaded yet
|
|
17679
|
+
* });
|
|
17680
|
+
* ```
|
|
17593
17681
|
*/
|
|
17594
17682
|
AuthStatus["SDK_SUCCESS"] = "SDK_SUCCESS";
|
|
17595
17683
|
/**
|
|
17596
17684
|
* @hidden
|
|
17597
|
-
* Emits when iframe is loaded and session
|
|
17685
|
+
* Emits when iframe is loaded and session
|
|
17686
|
+
* information is available.
|
|
17598
17687
|
*/
|
|
17599
17688
|
AuthStatus["SESSION_INFO_SUCCESS"] = "SESSION_INFO_SUCCESS";
|
|
17600
17689
|
/**
|
|
17601
|
-
* Emits when the app
|
|
17690
|
+
* Emits when the ThoughtSpot app inside the
|
|
17691
|
+
* embedded iframe confirms its session is active.
|
|
17692
|
+
* This fires after the iframe loads and sends back an `AuthInit` event.
|
|
17693
|
+
* @param sessionInfo Information about the user session, with details like `userGUID`.
|
|
17694
|
+
* @see EmbedEvent.AuthInit
|
|
17695
|
+
* @example
|
|
17696
|
+
* ```js
|
|
17697
|
+
* const authEE = init({ ... });
|
|
17698
|
+
* authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
|
|
17699
|
+
* // App is loaded and authenticated
|
|
17700
|
+
* console.log(sessionInfo.userGUID);
|
|
17701
|
+
* });
|
|
17702
|
+
* ```
|
|
17602
17703
|
*/
|
|
17603
17704
|
AuthStatus["SUCCESS"] = "SUCCESS";
|
|
17604
17705
|
/**
|
|
@@ -17744,7 +17845,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
17744
17845
|
// reload the page which we don't want. We'll live with adding an
|
|
17745
17846
|
// unnecessary hash to the parent page URL until we find any use case where
|
|
17746
17847
|
// that creates an issue.
|
|
17747
|
-
// Replace any
|
|
17848
|
+
// Replace any occurrences of ?ssoMarker=guid or &ssoMarker=guid.
|
|
17748
17849
|
let updatedHash = window.location.hash.replace(`?${getSSOMarker(SSO_REDIRECTION_MARKER_GUID)}`, '');
|
|
17749
17850
|
updatedHash = updatedHash.replace(`&${getSSOMarker(SSO_REDIRECTION_MARKER_GUID)}`, '');
|
|
17750
17851
|
window.location.hash = updatedHash;
|
|
@@ -18386,7 +18487,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
18386
18487
|
return eventData;
|
|
18387
18488
|
}
|
|
18388
18489
|
|
|
18389
|
-
var name="@thoughtspot/visual-embed-sdk";var version$1="1.46.
|
|
18490
|
+
var name="@thoughtspot/visual-embed-sdk";var version$1="1.46.2";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports$1={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/all-types-export.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p tsconfig.build.json --incremental false; tsc -p tsconfig.build.json --incremental false --module commonjs --outDir cjs","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle-generator --config ./dts-config/dts-bundle-file.config.js","bundle-dts":"dts-bundle-generator --config ./dts-config/dts-bundle.config.js","bundle-dts-react":"dts-bundle-generator --config ./dts-config/dts-bundle-react.config.js","bundle-dts-react-full":"dts-bundle-generator --config ./dts-config/dts-bundle-react-full.config.js",build:"rollup -c",watch:"rollup -cw",docgen:"typedoc --tsconfig tsconfig.build.json --theme typedoc-theme --json static/typedoc/typedoc.json --disableOutputCheck","test-sdk":"jest -c jest.config.sdk.js --runInBand",test:"npm run test-sdk",posttest:"cat ./coverage/sdk/lcov.info | npx coveralls-next || echo 'Warning: Coveralls upload failed but not breaking the build.'","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","check-size":"npm run build && size-limit","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest",dev:"vite -c vite.local.config.ts"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={classnames:"^2.3.1",eventemitter3:"^4.0.7",lodash:"^4.17.23","mixpanel-browser":"2.47.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1",yaml:"^2.5.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@size-limit/preset-big-lib":"^11.2.0","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^30.0.0","@types/lodash":"^4.17.0","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^8.28.0","@typescript-eslint/parser":"^8.28.0",ajv:"^8.17.1",asciidoctor:"^2.2.1","babel-jest":"^30.2.0","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1","coveralls-next":"^5.0.0",crypto:"^1.0.1","current-git-branch":"^1.1.0","dts-bundle-generator":"^9.5.1",eslint:"^9.23.0","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^10.1.1","eslint-import-resolver-typescript":"^4.2.5","eslint-plugin-comment-length":"2.2.1","eslint-plugin-import":"^2.31.0","eslint-plugin-jsdoc":"^50.6.9","eslint-plugin-prettier":"^5.2.5","eslint-plugin-react":"^7.37.5","eslint-plugin-react-hooks":"^5.2.0","fs-extra":"^10.0.0","gh-pages":"6.3.0",globals:"^16.0.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^2.0.0",jest:"^30.2.0","jest-environment-jsdom":"^29.7.0","jest-fetch-mock":"^3.0.3",jsdom:"^17.0.0",prettier:"2.1.2",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"4.24.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^29.4.6","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","typescript-eslint":"^8.29.1","url-search-params-polyfill":"^8.1.0",util:"^0.12.4",vite:"^6.3.5"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embedded","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version$1,description:description,module:module,main:main,types:types,files:files,exports:exports$1,typesVersions:typesVersions,"size-limit":[{path:"dist/tsembed.es.js",limit:"32 kB"}],scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
|
|
18390
18491
|
|
|
18391
18492
|
class HostEventClient {
|
|
18392
18493
|
constructor(iFrame) {
|
|
@@ -18660,7 +18761,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
18660
18761
|
*/
|
|
18661
18762
|
const { version } = pkgInfo;
|
|
18662
18763
|
/**
|
|
18663
|
-
* Global prefix for all
|
|
18764
|
+
* Global prefix for all ThoughtSpot postHash Params.
|
|
18664
18765
|
*/
|
|
18665
18766
|
const THOUGHTSPOT_PARAM_PREFIX = 'ts-';
|
|
18666
18767
|
const TS_EMBED_ID = '_thoughtspot-embed';
|
|
@@ -18692,9 +18793,9 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
18692
18793
|
this.embedNodeKey = '__tsEmbed';
|
|
18693
18794
|
this.isAppInitialized = false;
|
|
18694
18795
|
/**
|
|
18695
|
-
* Should we encode URL Query Params using base64 encoding which
|
|
18796
|
+
* Should we encode URL Query Params using base64 encoding which ThoughtSpot
|
|
18696
18797
|
* will generate for embedding. This provides additional security to
|
|
18697
|
-
*
|
|
18798
|
+
* ThoughtSpot clusters against Cross site scripting attacks.
|
|
18698
18799
|
* @default false
|
|
18699
18800
|
*/
|
|
18700
18801
|
this.shouldEncodeUrlQueryParams = false;
|
|
@@ -18870,7 +18971,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
18870
18971
|
if (viewConfig.preRenderId) {
|
|
18871
18972
|
const allOtherKeys = Object.keys(viewConfig).filter((key) => !preRenderAllowedKeys.includes(key) && !key.startsWith('on'));
|
|
18872
18973
|
allOtherKeys.forEach((key) => {
|
|
18873
|
-
if (!isUndefined
|
|
18974
|
+
if (!isUndefined(viewConfig[key])
|
|
18874
18975
|
&& !isEqual_1(viewConfig[key], preRenderedObject.viewConfig[key])) {
|
|
18875
18976
|
logger$3.warn(`${viewConfig.embedComponentType || 'Component'} was pre-rendered with `
|
|
18876
18977
|
+ `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
|
|
@@ -19206,7 +19307,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
19206
19307
|
if (this.embedConfig.currencyFormat) {
|
|
19207
19308
|
queryParams[Param.CurrencyFormat] = this.embedConfig.currencyFormat;
|
|
19208
19309
|
}
|
|
19209
|
-
const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags: additionalFlagsFromView, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, disableRedirectionLinksInNewTab, overrideOrgId, exposeTranslationIDs, primaryAction, } = this.viewConfig;
|
|
19310
|
+
const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags: additionalFlagsFromView, locale, customizations, contextMenuTrigger, linkOverride, enableLinkOverridesV2, insertInToSlide, disableRedirectionLinksInNewTab, overrideOrgId, exposeTranslationIDs, primaryAction, } = this.viewConfig;
|
|
19210
19311
|
const { additionalFlags: additionalFlagsFromInit } = this.embedConfig;
|
|
19211
19312
|
const additionalFlags = {
|
|
19212
19313
|
...additionalFlagsFromInit,
|
|
@@ -19282,7 +19383,13 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
19282
19383
|
if (locale !== undefined) {
|
|
19283
19384
|
queryParams[Param.Locale] = locale;
|
|
19284
19385
|
}
|
|
19285
|
-
|
|
19386
|
+
// TODO: Once V2 is stable, send both flags when
|
|
19387
|
+
// linkOverride is true (remove the else-if).
|
|
19388
|
+
if (enableLinkOverridesV2) {
|
|
19389
|
+
queryParams[Param.EnableLinkOverridesV2] = true;
|
|
19390
|
+
queryParams[Param.LinkOverride] = true;
|
|
19391
|
+
}
|
|
19392
|
+
else if (linkOverride) {
|
|
19286
19393
|
queryParams[Param.LinkOverride] = linkOverride;
|
|
19287
19394
|
}
|
|
19288
19395
|
if (insertInToSlide) {
|
|
@@ -19350,7 +19457,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
19350
19457
|
iFrame.mozallowfullscreen = true;
|
|
19351
19458
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
19352
19459
|
// @ts-ignore
|
|
19353
|
-
iFrame.allow = 'clipboard-read; clipboard-write; fullscreen;';
|
|
19460
|
+
iFrame.allow = 'clipboard-read; clipboard-write; fullscreen; local-network-access;';
|
|
19354
19461
|
const frameParams = this.viewConfig.frameParams;
|
|
19355
19462
|
const { height: frameHeight, width: frameWidth, ...restParams } = frameParams || {};
|
|
19356
19463
|
const width = getCssDimension(frameWidth || DEFAULT_EMBED_WIDTH);
|
|
@@ -20052,7 +20159,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20052
20159
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
20053
20160
|
* session.
|
|
20054
20161
|
* @param vizId [Optional] to get for a specific viz in case of a Liveboard.
|
|
20055
|
-
* @version SDK: 1.25.0
|
|
20162
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
|
|
20056
20163
|
*/
|
|
20057
20164
|
async getAnswerService(vizId) {
|
|
20058
20165
|
const { session } = await this.trigger(exports.HostEvent.GetAnswerSession, vizId ? { vizId } : {});
|
|
@@ -20167,7 +20274,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20167
20274
|
|
|
20168
20275
|
/**
|
|
20169
20276
|
* Embed ThoughtSpot search bar
|
|
20170
|
-
* @version
|
|
20277
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
20171
20278
|
* @group Embed components
|
|
20172
20279
|
*/
|
|
20173
20280
|
let SearchBarEmbed$1 = class SearchBarEmbed extends TsEmbed {
|
|
@@ -20249,7 +20356,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20249
20356
|
*/
|
|
20250
20357
|
/**
|
|
20251
20358
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
20252
|
-
* @version
|
|
20359
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
20253
20360
|
*
|
|
20254
20361
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
20255
20362
|
* @group Embed components
|
|
@@ -20325,12 +20432,13 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20325
20432
|
/**
|
|
20326
20433
|
* Copyright (c) 2022
|
|
20327
20434
|
*
|
|
20328
|
-
* Embed ThoughtSpot search or a saved answer
|
|
20435
|
+
* Embed ThoughtSpot search or a saved answer.
|
|
20436
|
+
* https://developers.thoughtspot.com/docs/search-embed
|
|
20329
20437
|
* @summary Search embed
|
|
20330
20438
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
20331
20439
|
*/
|
|
20332
20440
|
/**
|
|
20333
|
-
* Define the initial state
|
|
20441
|
+
* Define the initial state of column custom group accordions
|
|
20334
20442
|
* in data panel v2.
|
|
20335
20443
|
*/
|
|
20336
20444
|
var DataPanelCustomColumnGroupsAccordionState$1;
|
|
@@ -20553,7 +20661,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20553
20661
|
Page["Monitor"] = "monitor";
|
|
20554
20662
|
})(exports.Page || (exports.Page = {}));
|
|
20555
20663
|
/**
|
|
20556
|
-
* Define the initial state
|
|
20664
|
+
* Define the initial state of column custom group accordions
|
|
20557
20665
|
* in data panel v2.
|
|
20558
20666
|
*/
|
|
20559
20667
|
var DataPanelCustomColumnGroupsAccordionState;
|
|
@@ -20692,7 +20800,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20692
20800
|
* embedded Liveboard or visualization.
|
|
20693
20801
|
*/
|
|
20694
20802
|
getEmbedParams() {
|
|
20695
|
-
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.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;
|
|
20803
|
+
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.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;
|
|
20696
20804
|
let params = {};
|
|
20697
20805
|
params[Param.PrimaryNavHidden] = !showPrimaryNavbar;
|
|
20698
20806
|
params[Param.HideProfleAndHelp] = !!disableProfileAndHelp;
|
|
@@ -20713,13 +20821,17 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20713
20821
|
params[Param.IsUnifiedSearchExperienceEnabled] = isUnifiedSearchExperienceEnabled;
|
|
20714
20822
|
params[Param.CoverAndFilterOptionInPDF] = !!coverAndFilterOptionInPDF;
|
|
20715
20823
|
params = this.getBaseQueryParams(params);
|
|
20716
|
-
if (!isUndefined
|
|
20824
|
+
if (!isUndefined(updatedSpotterChatPrompt)) {
|
|
20717
20825
|
params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
|
|
20718
20826
|
}
|
|
20827
|
+
const resolvedEnablePastConversationsSidebar = resolveEnablePastConversationsSidebar({
|
|
20828
|
+
spotterSidebarConfigValue: spotterSidebarConfig === null || spotterSidebarConfig === void 0 ? void 0 : spotterSidebarConfig.enablePastConversationsSidebar,
|
|
20829
|
+
standaloneValue: this.viewConfig.enablePastConversationsSidebar,
|
|
20830
|
+
});
|
|
20831
|
+
setParamIfDefined(params, Param.EnablePastConversationsSidebar, resolvedEnablePastConversationsSidebar, true);
|
|
20719
20832
|
// Handle spotterSidebarConfig params
|
|
20720
20833
|
if (spotterSidebarConfig) {
|
|
20721
|
-
const {
|
|
20722
|
-
setParamIfDefined(params, Param.EnablePastConversationsSidebar, enablePastConversationsSidebar, true);
|
|
20834
|
+
const { spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig;
|
|
20723
20835
|
setParamIfDefined(params, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
|
|
20724
20836
|
setParamIfDefined(params, Param.SpotterSidebarTitle, spotterSidebarTitle);
|
|
20725
20837
|
setParamIfDefined(params, Param.SpotterChatRenameLabel, spotterChatRenameLabel);
|
|
@@ -20817,6 +20929,9 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
20817
20929
|
if (isThisPeriodInDateFiltersEnabled !== undefined) {
|
|
20818
20930
|
params[Param.IsThisPeriodInDateFiltersEnabled] = isThisPeriodInDateFiltersEnabled;
|
|
20819
20931
|
}
|
|
20932
|
+
if (enableHomepageAnnouncement !== undefined) {
|
|
20933
|
+
params[Param.EnableHomepageAnnouncement] = enableHomepageAnnouncement;
|
|
20934
|
+
}
|
|
20820
20935
|
this.defaultHeight = minimumHeight || this.defaultHeight;
|
|
20821
20936
|
params[Param.DataPanelV2Enabled] = dataPanelV2;
|
|
20822
20937
|
params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
|
|
@@ -21066,8 +21181,8 @@ query GetEurekaVizSnapshots(
|
|
|
21066
21181
|
* Copyright (c) 2022
|
|
21067
21182
|
*
|
|
21068
21183
|
* Embed a ThoughtSpot Liveboard or visualization
|
|
21069
|
-
* https://developers.thoughtspot.com/docs
|
|
21070
|
-
* https://developers.thoughtspot.com/docs
|
|
21184
|
+
* https://developers.thoughtspot.com/docs/embed-liveboard
|
|
21185
|
+
* https://developers.thoughtspot.com/docs/embed-a-viz
|
|
21071
21186
|
* @summary Liveboard & visualization embed
|
|
21072
21187
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
21073
21188
|
*/
|
|
@@ -21075,6 +21190,7 @@ query GetEurekaVizSnapshots(
|
|
|
21075
21190
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
21076
21191
|
* waits for the authentication to complete, so you need not wait for
|
|
21077
21192
|
* `AuthStatus.SUCCESS`.
|
|
21193
|
+
* @group Embed components
|
|
21078
21194
|
* @example
|
|
21079
21195
|
* ```js
|
|
21080
21196
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -21084,7 +21200,6 @@ query GetEurekaVizSnapshots(
|
|
|
21084
21200
|
* // .. other params here.
|
|
21085
21201
|
* })
|
|
21086
21202
|
* ```
|
|
21087
|
-
* @group Embed components
|
|
21088
21203
|
*/
|
|
21089
21204
|
let LiveboardEmbed$1 = class LiveboardEmbed extends V1Embed {
|
|
21090
21205
|
constructor(domSelector, viewConfig) {
|
|
@@ -21192,7 +21307,7 @@ query GetEurekaVizSnapshots(
|
|
|
21192
21307
|
if (preventLiveboardFilterRemoval) {
|
|
21193
21308
|
params[Param.preventLiveboardFilterRemoval] = true;
|
|
21194
21309
|
}
|
|
21195
|
-
if (!isUndefined
|
|
21310
|
+
if (!isUndefined(updatedSpotterChatPrompt)) {
|
|
21196
21311
|
params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
|
|
21197
21312
|
}
|
|
21198
21313
|
if (visibleVizs) {
|
|
@@ -21371,7 +21486,7 @@ query GetEurekaVizSnapshots(
|
|
|
21371
21486
|
});
|
|
21372
21487
|
}
|
|
21373
21488
|
async handleRenderForPrerender() {
|
|
21374
|
-
if (isUndefined
|
|
21489
|
+
if (isUndefined(this.viewConfig.liveboardId)) {
|
|
21375
21490
|
return this.prerenderGeneric();
|
|
21376
21491
|
}
|
|
21377
21492
|
return super.handleRenderForPrerender();
|
|
@@ -21894,6 +22009,8 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
21894
22009
|
/**
|
|
21895
22010
|
* Create a conversation embed, which can be integrated inside
|
|
21896
22011
|
* chatbots or other conversational interfaces.
|
|
22012
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22013
|
+
* @group Embed components
|
|
21897
22014
|
* @example
|
|
21898
22015
|
* ```js
|
|
21899
22016
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -21907,8 +22024,6 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
21907
22024
|
* // append the container to the DOM
|
|
21908
22025
|
* document.body.appendChild(container); // or to any other element
|
|
21909
22026
|
* ```
|
|
21910
|
-
* @group Embed components
|
|
21911
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
21912
22027
|
*/
|
|
21913
22028
|
class SpotterAgentEmbed {
|
|
21914
22029
|
constructor(viewConfig) {
|
|
@@ -21980,31 +22095,9 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
21980
22095
|
});
|
|
21981
22096
|
}
|
|
21982
22097
|
|
|
21983
|
-
/**
|
|
21984
|
-
* Checks if `value` is `undefined`.
|
|
21985
|
-
*
|
|
21986
|
-
* @static
|
|
21987
|
-
* @since 0.1.0
|
|
21988
|
-
* @memberOf _
|
|
21989
|
-
* @category Lang
|
|
21990
|
-
* @param {*} value The value to check.
|
|
21991
|
-
* @returns {boolean} Returns `true` if `value` is `undefined`, else `false`.
|
|
21992
|
-
* @example
|
|
21993
|
-
*
|
|
21994
|
-
* _.isUndefined(void 0);
|
|
21995
|
-
* // => true
|
|
21996
|
-
*
|
|
21997
|
-
* _.isUndefined(null);
|
|
21998
|
-
* // => false
|
|
21999
|
-
*/
|
|
22000
|
-
function isUndefined(value) {
|
|
22001
|
-
return value === undefined;
|
|
22002
|
-
}
|
|
22003
|
-
|
|
22004
|
-
var isUndefined_1 = isUndefined;
|
|
22005
|
-
|
|
22006
22098
|
/**
|
|
22007
22099
|
* Embed ThoughtSpot AI Conversation.
|
|
22100
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22008
22101
|
* @group Embed components
|
|
22009
22102
|
* @example
|
|
22010
22103
|
* ```js
|
|
@@ -22016,7 +22109,6 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22016
22109
|
* });
|
|
22017
22110
|
* conversation.render();
|
|
22018
22111
|
* ```
|
|
22019
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22020
22112
|
*/
|
|
22021
22113
|
let SpotterEmbed$1 = class SpotterEmbed extends TsEmbed {
|
|
22022
22114
|
constructor(container, viewConfig) {
|
|
@@ -22032,7 +22124,11 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22032
22124
|
getEmbedParamsObject() {
|
|
22033
22125
|
const { worksheetId, searchOptions, disableSourceSelection, hideSourceSelection, dataPanelV2, showSpotterLimitations, hideSampleQuestions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, updatedSpotterChatPrompt, spotterSidebarConfig, spotterChatConfig, } = this.viewConfig;
|
|
22034
22126
|
// Extract sidebar config properties
|
|
22035
|
-
const { enablePastConversationsSidebar, spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig || {};
|
|
22127
|
+
const { enablePastConversationsSidebar: sidebarEnablePastConversationsSidebar, spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig || {};
|
|
22128
|
+
const resolvedEnablePastConversationsSidebar = resolveEnablePastConversationsSidebar({
|
|
22129
|
+
spotterSidebarConfigValue: sidebarEnablePastConversationsSidebar,
|
|
22130
|
+
standaloneValue: this.viewConfig.enablePastConversationsSidebar,
|
|
22131
|
+
});
|
|
22036
22132
|
if (!worksheetId) {
|
|
22037
22133
|
this.handleError({
|
|
22038
22134
|
errorType: ErrorDetailsTypes.VALIDATION_ERROR,
|
|
@@ -22050,6 +22146,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22050
22146
|
setParamIfDefined(queryParams, Param.ShowSpotterLimitations, showSpotterLimitations, true);
|
|
22051
22147
|
setParamIfDefined(queryParams, Param.HideSampleQuestions, hideSampleQuestions, true);
|
|
22052
22148
|
setParamIfDefined(queryParams, Param.UpdatedSpotterChatPrompt, updatedSpotterChatPrompt, true);
|
|
22149
|
+
setParamIfDefined(queryParams, Param.EnablePastConversationsSidebar, resolvedEnablePastConversationsSidebar, true);
|
|
22053
22150
|
setParamIfDefined(queryParams, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
|
|
22054
22151
|
// String params
|
|
22055
22152
|
setParamIfDefined(queryParams, Param.SpotterSidebarTitle, spotterSidebarTitle);
|
|
@@ -22084,13 +22181,9 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22084
22181
|
return queryParams;
|
|
22085
22182
|
}
|
|
22086
22183
|
getIframeSrc() {
|
|
22087
|
-
const { worksheetId, searchOptions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL,
|
|
22184
|
+
const { worksheetId, searchOptions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, } = this.viewConfig;
|
|
22088
22185
|
const path = 'insights/conv-assist';
|
|
22089
22186
|
const queryParams = this.getEmbedParamsObject();
|
|
22090
|
-
const enablePastConversationsSidebar = spotterSidebarConfig === null || spotterSidebarConfig === void 0 ? void 0 : spotterSidebarConfig.enablePastConversationsSidebar;
|
|
22091
|
-
if (!isUndefined_1(enablePastConversationsSidebar)) {
|
|
22092
|
-
queryParams[Param.EnablePastConversationsSidebar] = !!enablePastConversationsSidebar;
|
|
22093
|
-
}
|
|
22094
22187
|
let query = '';
|
|
22095
22188
|
const queryParamsString = getQueryParamString(queryParams, true);
|
|
22096
22189
|
if (queryParamsString) {
|
|
@@ -22119,8 +22212,9 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22119
22212
|
};
|
|
22120
22213
|
/**
|
|
22121
22214
|
* Embed ThoughtSpot AI Conversation.
|
|
22122
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22123
22215
|
* Use {@link SpotterEmbed} instead
|
|
22216
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22217
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22124
22218
|
* @group Embed components
|
|
22125
22219
|
* @example
|
|
22126
22220
|
* ```js
|
|
@@ -22132,7 +22226,6 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22132
22226
|
* });
|
|
22133
22227
|
* conversation.render();
|
|
22134
22228
|
* ```
|
|
22135
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22136
22229
|
*/
|
|
22137
22230
|
let ConversationEmbed$1 = class ConversationEmbed extends SpotterEmbed$1 {
|
|
22138
22231
|
constructor(container, viewConfig) {
|
|
@@ -22225,7 +22318,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22225
22318
|
* React component for Full app Embed.
|
|
22226
22319
|
* @example
|
|
22227
22320
|
* ```tsx
|
|
22228
|
-
* function
|
|
22321
|
+
* function App() {
|
|
22229
22322
|
* return <AppEmbed
|
|
22230
22323
|
* showPrimaryNavbar={false}
|
|
22231
22324
|
* pageId={Page.Liveboards}
|
|
@@ -22236,9 +22329,9 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22236
22329
|
*/
|
|
22237
22330
|
const AppEmbed = componentFactory(AppEmbed$1);
|
|
22238
22331
|
/**
|
|
22239
|
-
* React component for PreRendered
|
|
22332
|
+
* React component for PreRendered App embed.
|
|
22240
22333
|
*
|
|
22241
|
-
* PreRenderedAppEmbed will preRender the
|
|
22334
|
+
* PreRenderedAppEmbed will preRender the AppEmbed and will be hidden by
|
|
22242
22335
|
* default.
|
|
22243
22336
|
*
|
|
22244
22337
|
* AppEmbed with preRenderId passed will call showPreRender on the embed.
|
|
@@ -22278,7 +22371,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22278
22371
|
* LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
|
|
22279
22372
|
*
|
|
22280
22373
|
* If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
|
|
22281
|
-
* tries to preRender the LiveboardEmbed, so it is recommended to
|
|
22374
|
+
* tries to preRender the LiveboardEmbed, so it is recommended to pass the
|
|
22282
22375
|
* liveboardId to both the components.
|
|
22283
22376
|
* @example
|
|
22284
22377
|
* ```tsx
|
|
@@ -22307,7 +22400,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22307
22400
|
*/
|
|
22308
22401
|
const SearchBarEmbed = componentFactory(SearchBarEmbed$1);
|
|
22309
22402
|
/**
|
|
22310
|
-
* React component for PreRendered
|
|
22403
|
+
* React component for PreRendered SearchBar embed.
|
|
22311
22404
|
*
|
|
22312
22405
|
* PreRenderedSearchBarEmbed will preRender the SearchBarEmbed and will be hidden by
|
|
22313
22406
|
* default.
|
|
@@ -22339,9 +22432,9 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22339
22432
|
*/
|
|
22340
22433
|
const SageEmbed = componentFactory(SageEmbed$1);
|
|
22341
22434
|
/**
|
|
22342
|
-
* React component for PreRendered
|
|
22435
|
+
* React component for PreRendered Sage embed.
|
|
22343
22436
|
*
|
|
22344
|
-
* PreRenderedSageEmbed will preRender the
|
|
22437
|
+
* PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
|
|
22345
22438
|
* default.
|
|
22346
22439
|
*
|
|
22347
22440
|
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
@@ -22375,8 +22468,8 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22375
22468
|
const SpotterEmbed = componentFactory(SpotterEmbed$1);
|
|
22376
22469
|
/**
|
|
22377
22470
|
* React component for LLM based conversation BI.
|
|
22378
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22379
22471
|
* Use {@link SpotterEmbed} instead
|
|
22472
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22380
22473
|
* @example
|
|
22381
22474
|
* ```tsx
|
|
22382
22475
|
* function Sage() {
|
|
@@ -22398,6 +22491,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22398
22491
|
* This component renders a single message response from your ThoughtSpot conversation,
|
|
22399
22492
|
* showing charts, visualizations, or text responses based on the user's query.
|
|
22400
22493
|
*
|
|
22494
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
22401
22495
|
* @example
|
|
22402
22496
|
* ```tsx
|
|
22403
22497
|
* const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
|
|
@@ -22414,7 +22508,6 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22414
22508
|
* />
|
|
22415
22509
|
* }
|
|
22416
22510
|
* ```
|
|
22417
|
-
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
22418
22511
|
*/
|
|
22419
22512
|
const SpotterMessage = React.forwardRef((props, ref) => {
|
|
22420
22513
|
const { message, query: _, ...otherProps } = props;
|
|
@@ -22426,7 +22519,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22426
22519
|
* PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
|
|
22427
22520
|
* default.
|
|
22428
22521
|
*
|
|
22429
|
-
*
|
|
22522
|
+
* SpotterEmbed with preRenderId passed will call showPreRender on the embed.
|
|
22430
22523
|
* @example
|
|
22431
22524
|
* ```tsx
|
|
22432
22525
|
* function LandingPageComponent() {
|
|
@@ -22460,6 +22553,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22460
22553
|
}
|
|
22461
22554
|
/**
|
|
22462
22555
|
*
|
|
22556
|
+
* @version SDK: 1.36.2 | ThoughtSpot: *
|
|
22463
22557
|
* @param config - EmbedConfig
|
|
22464
22558
|
* @returns AuthEventEmitter
|
|
22465
22559
|
* @example
|
|
@@ -22469,7 +22563,6 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22469
22563
|
* return <LiveboardEmbed ref={ref} liveboardId={<id>} />
|
|
22470
22564
|
* }
|
|
22471
22565
|
* ```
|
|
22472
|
-
* @version SDK: 1.36.2 | ThoughtSpot: *
|
|
22473
22566
|
*/
|
|
22474
22567
|
function useInit(config) {
|
|
22475
22568
|
const ref = React.useRef(null);
|
|
@@ -22485,6 +22578,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22485
22578
|
* This hook provides a sendMessage function that allows you to send natural language
|
|
22486
22579
|
* queries to your data and get back AI-generated responses with visualizations.
|
|
22487
22580
|
*
|
|
22581
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
22488
22582
|
* @param config - Configuration object containing worksheetId and other options
|
|
22489
22583
|
* @returns Object with sendMessage function that returns conversation results
|
|
22490
22584
|
* @example
|
|
@@ -22502,7 +22596,6 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
22502
22596
|
* }
|
|
22503
22597
|
* };
|
|
22504
22598
|
* ```
|
|
22505
|
-
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
22506
22599
|
*/
|
|
22507
22600
|
function useSpotterAgent(config) {
|
|
22508
22601
|
const serviceRef = React.useRef(null);
|