@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
|
@@ -428,37 +428,37 @@ export interface CustomCssVariables {
|
|
|
428
428
|
/**
|
|
429
429
|
* Padding of the groups in the Liveboard.
|
|
430
430
|
*
|
|
431
|
-
* Please enable the Liveboard
|
|
431
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
432
432
|
*/
|
|
433
433
|
"--ts-var-liveboard-group-padding"?: string;
|
|
434
434
|
/**
|
|
435
435
|
* Font size of the title of the groups in the Liveboard.
|
|
436
436
|
*
|
|
437
|
-
* Please enable the Liveboard
|
|
437
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
438
438
|
*/
|
|
439
439
|
"--ts-var-liveboard-group-title-font-size"?: string;
|
|
440
440
|
/**
|
|
441
441
|
* Font weight of the title of the groups in the Liveboard.
|
|
442
442
|
*
|
|
443
|
-
* Please enable the Liveboard
|
|
443
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
444
444
|
*/
|
|
445
445
|
"--ts-var-liveboard-group-title-font-weight"?: string;
|
|
446
446
|
/**
|
|
447
447
|
* Font size of the title of the tiles inside the groups in the Liveboard.
|
|
448
448
|
*
|
|
449
|
-
* Please enable the Liveboard
|
|
449
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
450
450
|
*/
|
|
451
451
|
"--ts-var-liveboard-group-tile-title-font-size"?: string;
|
|
452
452
|
/**
|
|
453
453
|
* Font weight of the title of the tiles inside the groups in the Liveboard.
|
|
454
454
|
*
|
|
455
|
-
* Please enable the Liveboard
|
|
455
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
456
456
|
*/
|
|
457
457
|
"--ts-var-liveboard-group-tile-title-font-weight"?: string;
|
|
458
458
|
/**
|
|
459
459
|
* Padding of the group tiles in the Liveboard.
|
|
460
460
|
*
|
|
461
|
-
* Please enable the Liveboard
|
|
461
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
462
462
|
*/
|
|
463
463
|
"--ts-var-liveboard-group-tile-padding"?: string;
|
|
464
464
|
/**
|
|
@@ -468,13 +468,13 @@ export interface CustomCssVariables {
|
|
|
468
468
|
/**
|
|
469
469
|
* Background color of the groups in the Liveboard.
|
|
470
470
|
*
|
|
471
|
-
* Please enable the Liveboard
|
|
471
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
472
472
|
*/
|
|
473
473
|
"--ts-var-liveboard-group-background"?: string;
|
|
474
474
|
/**
|
|
475
475
|
* Border color of the groups in the Liveboard.
|
|
476
476
|
*
|
|
477
|
-
* Please enable the Liveboard
|
|
477
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
478
478
|
*/
|
|
479
479
|
"--ts-var-liveboard-group-border-color"?: string;
|
|
480
480
|
/**
|
|
@@ -488,55 +488,55 @@ export interface CustomCssVariables {
|
|
|
488
488
|
/**
|
|
489
489
|
* Font color of the title of the groups in the Liveboard.
|
|
490
490
|
*
|
|
491
|
-
* Please enable the Liveboard
|
|
491
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
492
492
|
*/
|
|
493
493
|
"--ts-var-liveboard-group-title-font-color"?: string;
|
|
494
494
|
/**
|
|
495
495
|
* Font color of the description of the groups in the Liveboard.
|
|
496
496
|
*
|
|
497
|
-
* Please enable the Liveboard
|
|
497
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
498
498
|
*/
|
|
499
499
|
"--ts-var-liveboard-group-description-font-color"?: string;
|
|
500
500
|
/**
|
|
501
501
|
* Font color of the title of the tiles inside the groups in the Liveboard.
|
|
502
502
|
*
|
|
503
|
-
* Please enable the Liveboard
|
|
503
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
504
504
|
*/
|
|
505
505
|
"--ts-var-liveboard-group-tile-title-font-color"?: string;
|
|
506
506
|
/**
|
|
507
507
|
* Font color of the description of the tiles inside the groups in the Liveboard.
|
|
508
508
|
*
|
|
509
|
-
* Please enable the Liveboard
|
|
509
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
510
510
|
*/
|
|
511
511
|
"--ts-var-liveboard-group-tile-description-font-color"?: string;
|
|
512
512
|
/**
|
|
513
513
|
* Background color of the tiles inside the groups in the Liveboard.
|
|
514
514
|
*
|
|
515
|
-
* Please enable the Liveboard
|
|
515
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
516
516
|
*/
|
|
517
517
|
"--ts-var-liveboard-group-tile-background"?: string;
|
|
518
518
|
/**
|
|
519
519
|
* Background color of the filter chips in the Liveboard.
|
|
520
520
|
*
|
|
521
|
-
* Please enable the Liveboard
|
|
521
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
522
522
|
*/
|
|
523
523
|
"--ts-var-liveboard-chip-background"?: string;
|
|
524
524
|
/**
|
|
525
525
|
* Font color of the filter chips in the Liveboard.
|
|
526
526
|
*
|
|
527
|
-
* Please enable the Liveboard
|
|
527
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
528
528
|
*/
|
|
529
529
|
"--ts-var-liveboard-chip-color"?: string;
|
|
530
530
|
/**
|
|
531
531
|
* Background color of the filter chips in the Liveboard on hover.
|
|
532
532
|
*
|
|
533
|
-
* Please enable the Liveboard
|
|
533
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
534
534
|
*/
|
|
535
535
|
"--ts-var-liveboard-chip--hover-background"?: string;
|
|
536
536
|
/**
|
|
537
537
|
* Background color of the filter chips in the Liveboard on active.
|
|
538
538
|
*
|
|
539
|
-
* Please enable the Liveboard
|
|
539
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
540
540
|
*/
|
|
541
541
|
"--ts-var-liveboard-chip--active-background"?: string;
|
|
542
542
|
/**
|
|
@@ -809,6 +809,7 @@ declare class AnswerService {
|
|
|
809
809
|
* ]);
|
|
810
810
|
* console.log(await service.fetchData());
|
|
811
811
|
* });
|
|
812
|
+
* ```
|
|
812
813
|
*/
|
|
813
814
|
addColumnsByName(columnNames: string[]): Promise<any>;
|
|
814
815
|
/**
|
|
@@ -880,7 +881,7 @@ declare class AnswerService {
|
|
|
880
881
|
* const data = await underlying.fetchData(0, 100);
|
|
881
882
|
* })
|
|
882
883
|
* ```
|
|
883
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
884
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
884
885
|
*/
|
|
885
886
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
886
887
|
/**
|
|
@@ -921,6 +922,7 @@ declare enum AuthType {
|
|
|
921
922
|
* To use this:
|
|
922
923
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
923
924
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
925
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
924
926
|
* @example
|
|
925
927
|
* ```js
|
|
926
928
|
* init({
|
|
@@ -928,18 +930,17 @@ declare enum AuthType {
|
|
|
928
930
|
* authType: AuthType.EmbeddedSSO,
|
|
929
931
|
* });
|
|
930
932
|
* ```
|
|
931
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
932
933
|
*/
|
|
933
934
|
EmbeddedSSO = "EmbeddedSSO",
|
|
934
935
|
/**
|
|
935
|
-
* SSO using SAML
|
|
936
|
-
* @deprecated
|
|
936
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
937
|
+
* @deprecated This option is deprecated.
|
|
937
938
|
* @hidden
|
|
938
939
|
*/
|
|
939
940
|
SSO = "SSO_SAML",
|
|
940
941
|
/**
|
|
941
|
-
* SSO using SAML
|
|
942
|
-
* @deprecated
|
|
942
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
943
|
+
* @deprecated This option is deprecated.
|
|
943
944
|
* @hidden
|
|
944
945
|
*/
|
|
945
946
|
SAML = "SSO_SAML",
|
|
@@ -990,8 +991,9 @@ declare enum AuthType {
|
|
|
990
991
|
SAMLRedirect = "SSO_SAML",
|
|
991
992
|
/**
|
|
992
993
|
* SSO using OIDC
|
|
994
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
995
|
+
* @deprecated This option is deprecated.
|
|
993
996
|
* @hidden
|
|
994
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
995
997
|
*/
|
|
996
998
|
OIDC = "SSO_OIDC",
|
|
997
999
|
/**
|
|
@@ -1002,8 +1004,9 @@ declare enum AuthType {
|
|
|
1002
1004
|
OIDCRedirect = "SSO_OIDC",
|
|
1003
1005
|
/**
|
|
1004
1006
|
* Trusted authentication server
|
|
1007
|
+
* Use {@link TrustedAuth} instead
|
|
1008
|
+
* @deprecated This option is deprecated.
|
|
1005
1009
|
* @hidden
|
|
1006
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
1007
1010
|
*/
|
|
1008
1011
|
AuthServer = "AuthServer",
|
|
1009
1012
|
/**
|
|
@@ -1030,6 +1033,7 @@ declare enum AuthType {
|
|
|
1030
1033
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1031
1034
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1032
1035
|
* implemented by some browsers.
|
|
1036
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1033
1037
|
* @example
|
|
1034
1038
|
* ```js
|
|
1035
1039
|
* init({
|
|
@@ -1040,8 +1044,8 @@ declare enum AuthType {
|
|
|
1040
1044
|
* .then((response) => response.json())
|
|
1041
1045
|
* .then((data) => data.token);
|
|
1042
1046
|
* }
|
|
1047
|
+
* });
|
|
1043
1048
|
* ```
|
|
1044
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1045
1049
|
*/
|
|
1046
1050
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
1047
1051
|
/**
|
|
@@ -1061,43 +1065,43 @@ export declare enum HomeLeftNavItem {
|
|
|
1061
1065
|
/**
|
|
1062
1066
|
* The *Search data* option in
|
|
1063
1067
|
* the *Insights* left navigation panel.
|
|
1064
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1068
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1065
1069
|
*/
|
|
1066
1070
|
SearchData = "search-data",
|
|
1067
1071
|
/**
|
|
1068
1072
|
* The *Home* menu option in
|
|
1069
1073
|
* the *Insights* left navigation panel.
|
|
1070
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1074
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1071
1075
|
*/
|
|
1072
1076
|
Home = "insights-home",
|
|
1073
1077
|
/**
|
|
1074
1078
|
* The *Liveboards* menu option in
|
|
1075
1079
|
* the *Insights* left navigation panel.
|
|
1076
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1080
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1077
1081
|
*/
|
|
1078
1082
|
Liveboards = "liveboards",
|
|
1079
1083
|
/**
|
|
1080
1084
|
* The *Answers* menu option in
|
|
1081
1085
|
* the *Insights* left navigation panel.
|
|
1082
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1086
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1083
1087
|
*/
|
|
1084
1088
|
Answers = "answers",
|
|
1085
1089
|
/**
|
|
1086
1090
|
* The *Monitor subscriptions* menu option in
|
|
1087
1091
|
* the *Insights* left navigation panel.
|
|
1088
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1092
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1089
1093
|
*/
|
|
1090
1094
|
MonitorSubscription = "monitor-alerts",
|
|
1091
1095
|
/**
|
|
1092
1096
|
* The *SpotIQ analysis* menu option in
|
|
1093
1097
|
* the *Insights* left navigation panel.
|
|
1094
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1098
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1095
1099
|
*/
|
|
1096
1100
|
SpotIQAnalysis = "spotiq-analysis",
|
|
1097
1101
|
/**
|
|
1098
1102
|
* The *Liveboard schedules* menu option in
|
|
1099
1103
|
* the *Insights* left navigation panel.
|
|
1100
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
1104
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
1101
1105
|
*/
|
|
1102
1106
|
LiveboardSchedules = "liveboard-schedules",
|
|
1103
1107
|
/**
|
|
@@ -1268,8 +1272,8 @@ export interface EmbedConfig {
|
|
|
1268
1272
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1269
1273
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1270
1274
|
* place.
|
|
1275
|
+
* @deprecated This option is deprecated.
|
|
1271
1276
|
* @default false
|
|
1272
|
-
* @deprecated
|
|
1273
1277
|
*/
|
|
1274
1278
|
noRedirect?: boolean;
|
|
1275
1279
|
/**
|
|
@@ -1278,8 +1282,8 @@ export interface EmbedConfig {
|
|
|
1278
1282
|
*
|
|
1279
1283
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1280
1284
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1281
|
-
* @default false
|
|
1282
1285
|
* @version SDK: 1.18.0
|
|
1286
|
+
* @default false
|
|
1283
1287
|
*/
|
|
1284
1288
|
inPopup?: boolean;
|
|
1285
1289
|
/**
|
|
@@ -1288,7 +1292,7 @@ export interface EmbedConfig {
|
|
|
1288
1292
|
* terminated.
|
|
1289
1293
|
*
|
|
1290
1294
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1291
|
-
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1295
|
+
* @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1292
1296
|
*/
|
|
1293
1297
|
redirectPath?: string;
|
|
1294
1298
|
/** @internal */
|
|
@@ -1361,7 +1365,7 @@ export interface EmbedConfig {
|
|
|
1361
1365
|
detectCookieAccessSlow?: boolean;
|
|
1362
1366
|
/**
|
|
1363
1367
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
1364
|
-
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1368
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1365
1369
|
*/
|
|
1366
1370
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
1367
1371
|
/**
|
|
@@ -1378,6 +1382,7 @@ export interface EmbedConfig {
|
|
|
1378
1382
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
1379
1383
|
* button that the user can click to trigger the flow.
|
|
1380
1384
|
* This attribute sets a containing element for that button.
|
|
1385
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1381
1386
|
* @example
|
|
1382
1387
|
* ```js
|
|
1383
1388
|
* init({
|
|
@@ -1386,7 +1391,6 @@ export interface EmbedConfig {
|
|
|
1386
1391
|
* authTriggerContainer: '#auth-trigger-container'
|
|
1387
1392
|
* })
|
|
1388
1393
|
* ```
|
|
1389
|
-
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1390
1394
|
*/
|
|
1391
1395
|
authTriggerContainer?: string | HTMLElement;
|
|
1392
1396
|
/**
|
|
@@ -1403,11 +1407,10 @@ export interface EmbedConfig {
|
|
|
1403
1407
|
*/
|
|
1404
1408
|
authTriggerText?: string;
|
|
1405
1409
|
/**
|
|
1406
|
-
* Prevent users from accessing
|
|
1407
|
-
*
|
|
1408
|
-
* outside of the iframe.
|
|
1409
|
-
* @default true
|
|
1410
|
+
* Prevent embedded application users from accessing ThoughtSpot
|
|
1411
|
+
* application pages outside of the iframe.
|
|
1410
1412
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1413
|
+
* @default true
|
|
1411
1414
|
*/
|
|
1412
1415
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1413
1416
|
/**
|
|
@@ -1437,6 +1440,7 @@ export interface EmbedConfig {
|
|
|
1437
1440
|
* other logs such as warnings, information alerts,
|
|
1438
1441
|
* and debug messages in the console output.
|
|
1439
1442
|
*
|
|
1443
|
+
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
1440
1444
|
* @default LogLevel.ERROR
|
|
1441
1445
|
* @example
|
|
1442
1446
|
* ```js
|
|
@@ -1445,7 +1449,6 @@ export interface EmbedConfig {
|
|
|
1445
1449
|
* logLevel: LogLevel.SILENT
|
|
1446
1450
|
* })
|
|
1447
1451
|
* ```
|
|
1448
|
-
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
1449
1452
|
*/
|
|
1450
1453
|
logLevel?: LogLevel;
|
|
1451
1454
|
/**
|
|
@@ -1472,6 +1475,7 @@ export interface EmbedConfig {
|
|
|
1472
1475
|
* This flag is used to disable the token verification in the SDK.
|
|
1473
1476
|
* Enabling this flag will also disable the caching of the token.
|
|
1474
1477
|
* @hidden
|
|
1478
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
1475
1479
|
* @example
|
|
1476
1480
|
* ```js
|
|
1477
1481
|
* init({
|
|
@@ -1479,12 +1483,11 @@ export interface EmbedConfig {
|
|
|
1479
1483
|
* disableTokenVerification : true
|
|
1480
1484
|
* })
|
|
1481
1485
|
* ```
|
|
1482
|
-
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
1483
1486
|
*/
|
|
1484
1487
|
disableTokenVerification?: boolean;
|
|
1485
1488
|
/**
|
|
1486
1489
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
1487
|
-
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
1490
|
+
* @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
1488
1491
|
*/
|
|
1489
1492
|
disableLoginFailurePage?: boolean;
|
|
1490
1493
|
/**
|
|
@@ -1494,6 +1497,7 @@ export interface EmbedConfig {
|
|
|
1494
1497
|
* Warning: This option is for advanced use only and is used internally
|
|
1495
1498
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1496
1499
|
* list of supported keys and values associated with each.
|
|
1500
|
+
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
1497
1501
|
* @example
|
|
1498
1502
|
* ```js
|
|
1499
1503
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1504,7 +1508,6 @@ export interface EmbedConfig {
|
|
|
1504
1508
|
* }
|
|
1505
1509
|
* });
|
|
1506
1510
|
* ```
|
|
1507
|
-
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
1508
1511
|
*/
|
|
1509
1512
|
additionalFlags?: {
|
|
1510
1513
|
[key: string]: string | number | boolean;
|
|
@@ -1512,6 +1515,7 @@ export interface EmbedConfig {
|
|
|
1512
1515
|
/**
|
|
1513
1516
|
* This is an object (key/val) for customVariables being
|
|
1514
1517
|
* used by the third party tool's script.
|
|
1518
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1515
1519
|
* @example
|
|
1516
1520
|
* ```js
|
|
1517
1521
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1522,15 +1526,14 @@ export interface EmbedConfig {
|
|
|
1522
1526
|
* }
|
|
1523
1527
|
* });
|
|
1524
1528
|
* ```
|
|
1525
|
-
* @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1526
1529
|
*/
|
|
1527
1530
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
1528
1531
|
disablePreauthCache?: boolean;
|
|
1529
1532
|
/**
|
|
1530
1533
|
* Disable fullscreen presentation mode functionality. When enabled, prevents entering
|
|
1531
1534
|
* and exiting fullscreen mode for embedded visualizations during presentations.
|
|
1532
|
-
* @default true (feature is disabled by default)
|
|
1533
1535
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1536
|
+
* @default true (feature is disabled by default)
|
|
1534
1537
|
* @example
|
|
1535
1538
|
* ```js
|
|
1536
1539
|
* init({
|
|
@@ -1549,18 +1552,154 @@ export interface EmbedConfig {
|
|
|
1549
1552
|
* @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
|
|
1550
1553
|
* @example
|
|
1551
1554
|
* ```js
|
|
1552
|
-
* import {
|
|
1555
|
+
* import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
|
|
1556
|
+
* init({
|
|
1557
|
+
* ... // other embed config options
|
|
1558
|
+
* customActions: [
|
|
1559
|
+
* {
|
|
1560
|
+
* // Unique identifier for the custom action
|
|
1561
|
+
* id: 'my-custom-action',
|
|
1562
|
+
*
|
|
1563
|
+
* // Display name shown to users in the UI
|
|
1564
|
+
* name: 'My Custom Action',
|
|
1565
|
+
*
|
|
1566
|
+
* // Where the action appears in the UI
|
|
1567
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
1568
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
1569
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
1570
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
1571
|
+
*
|
|
1572
|
+
* // What type of content this action applies to
|
|
1573
|
+
* // ANSWER: Available on answer pages
|
|
1574
|
+
* target: CustomActionTarget.ANSWER,
|
|
1575
|
+
*
|
|
1576
|
+
* // Optional: Restrict where this action appears based on data models
|
|
1577
|
+
* // dataModelIds: {
|
|
1578
|
+
* // // Restrict to specific data models
|
|
1579
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
1580
|
+
* // // Restrict to specific columns within models
|
|
1581
|
+
* // modelColumnNames: ['model-id::column-name']
|
|
1582
|
+
* // },
|
|
1583
|
+
*
|
|
1584
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
1585
|
+
* // metadataIds: {
|
|
1586
|
+
* // // Restrict to specific answers
|
|
1587
|
+
* // answerIds: ['answer-id-1', 'answer-id-2'],
|
|
1588
|
+
* // },
|
|
1589
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
1590
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
1591
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
1592
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
1593
|
+
* }
|
|
1594
|
+
* ],
|
|
1595
|
+
* })
|
|
1596
|
+
* ```
|
|
1597
|
+
* @example
|
|
1598
|
+
* ```js
|
|
1599
|
+
* import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
|
|
1600
|
+
* init({
|
|
1601
|
+
* ... // other embed config options
|
|
1602
|
+
* customActions: [
|
|
1603
|
+
* {
|
|
1604
|
+
* // Unique identifier for the custom action
|
|
1605
|
+
* id: 'my-custom-action',
|
|
1606
|
+
*
|
|
1607
|
+
* // Display name shown to users in the UI
|
|
1608
|
+
* name: 'My Custom Action',
|
|
1609
|
+
*
|
|
1610
|
+
* // Where the action appears in the UI
|
|
1611
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
1612
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
1613
|
+
* position: CustomActionsPosition.MENU,
|
|
1614
|
+
*
|
|
1615
|
+
* // What type of content this action applies to
|
|
1616
|
+
* // SPOTTER: Available in Spotter (AI-powered search)
|
|
1617
|
+
* target: CustomActionTarget.SPOTTER,
|
|
1618
|
+
*
|
|
1619
|
+
* // Optional: Restrict where this action appears based on data models
|
|
1620
|
+
* // dataModelIds: {
|
|
1621
|
+
* // // Restrict to specific data models
|
|
1622
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
1623
|
+
* // },
|
|
1624
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
1625
|
+
* // groupIds: ['group-id-1'],
|
|
1626
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
1627
|
+
* // orgIds: ['org-id-1'],
|
|
1628
|
+
* }
|
|
1629
|
+
* ],
|
|
1630
|
+
* })
|
|
1631
|
+
* ```
|
|
1632
|
+
* @example
|
|
1633
|
+
* ```js
|
|
1634
|
+
* import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
|
|
1553
1635
|
* init({
|
|
1554
1636
|
* ... // other embed config options
|
|
1555
1637
|
* customActions: [
|
|
1556
1638
|
* {
|
|
1557
|
-
*
|
|
1558
|
-
* id: '
|
|
1639
|
+
* // Unique identifier for the custom action
|
|
1640
|
+
* id: 'my-liveboard-custom-action',
|
|
1641
|
+
*
|
|
1642
|
+
* // Display name shown to users in the UI
|
|
1643
|
+
* name: 'My Liveboard Custom Action',
|
|
1644
|
+
*
|
|
1645
|
+
* // Where the action appears in the UI
|
|
1646
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
1647
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
1648
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
1649
|
+
*
|
|
1650
|
+
* // What type of content this action applies to
|
|
1651
|
+
* // LIVEBOARD: Available on liveboard pages
|
|
1652
|
+
* target: CustomActionTarget.LIVEBOARD,
|
|
1653
|
+
*
|
|
1654
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
1655
|
+
* // metadataIds: {
|
|
1656
|
+
* // // Restrict to specific liveboards
|
|
1657
|
+
* // liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
|
|
1658
|
+
* // },
|
|
1659
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
1660
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
1661
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
1662
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
1663
|
+
* },
|
|
1664
|
+
* {
|
|
1665
|
+
* // Unique identifier for the custom action
|
|
1666
|
+
* id: 'my-viz-custom-action',
|
|
1667
|
+
*
|
|
1668
|
+
* // Display name shown to users in the UI
|
|
1669
|
+
* name: 'My Viz Custom Action',
|
|
1670
|
+
*
|
|
1671
|
+
* // Where the action appears in the UI
|
|
1672
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
1673
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
1674
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
1675
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
1676
|
+
*
|
|
1677
|
+
* // What type of content this action applies to
|
|
1678
|
+
* // VIZ: Available on individual visualizations
|
|
1559
1679
|
* target: CustomActionTarget.VIZ,
|
|
1560
|
-
*
|
|
1561
|
-
*
|
|
1680
|
+
*
|
|
1681
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
1682
|
+
* // metadataIds: {
|
|
1683
|
+
* // // Restrict to specific answers
|
|
1684
|
+
* // answerIds: ['answer-id-1', 'answer-id-2'],
|
|
1685
|
+
* // // Restrict to specific liveboard. If liveboardId is
|
|
1686
|
+
* // // passed, custom actions will appear on all vizzes of liveboard
|
|
1687
|
+
* // liveboardIds: ['liveboard-id-1'],
|
|
1688
|
+
* // // Restrict to specific vizIds
|
|
1689
|
+
* // vizIds: ['viz-id-1']
|
|
1690
|
+
* // },
|
|
1691
|
+
* // dataModelIds: {
|
|
1692
|
+
* // // Restrict to specific data models
|
|
1693
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
1694
|
+
* // // Restrict to specific columns within models
|
|
1695
|
+
* // modelColumnNames: ['model-id::column-name']
|
|
1696
|
+
* // },
|
|
1697
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
1698
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
1699
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
1700
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
1562
1701
|
* }
|
|
1563
|
-
* ]
|
|
1702
|
+
* ],
|
|
1564
1703
|
* })
|
|
1565
1704
|
* ```
|
|
1566
1705
|
*/
|
|
@@ -1600,7 +1739,7 @@ export interface FrameParams {
|
|
|
1600
1739
|
*/
|
|
1601
1740
|
loading?: "lazy" | "eager" | "auto";
|
|
1602
1741
|
/**
|
|
1603
|
-
*
|
|
1742
|
+
* These parameters will be passed to the iframe
|
|
1604
1743
|
* as is.
|
|
1605
1744
|
*/
|
|
1606
1745
|
[key: string]: string | number | boolean | undefined;
|
|
@@ -1675,8 +1814,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1675
1814
|
*/
|
|
1676
1815
|
disabledActionReason?: string;
|
|
1677
1816
|
/**
|
|
1678
|
-
* The list of actions to hide from the embedded.
|
|
1679
|
-
*
|
|
1817
|
+
* The list of actions to hide from the embedded view.
|
|
1818
|
+
* These actions will be hidden from the user.
|
|
1680
1819
|
* Use this to hide an action.
|
|
1681
1820
|
*
|
|
1682
1821
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
@@ -1717,7 +1856,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1717
1856
|
* The locale settings to apply to the embedded view.
|
|
1718
1857
|
*
|
|
1719
1858
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1720
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
1859
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1721
1860
|
* @example
|
|
1722
1861
|
* ```js
|
|
1723
1862
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1732,12 +1871,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1732
1871
|
* This is an object (key/val) of override flags which will be applied
|
|
1733
1872
|
* to the internal embedded object. This can be used to add any
|
|
1734
1873
|
* URL flag.
|
|
1735
|
-
* If the same flags are passed in init, they will be
|
|
1874
|
+
* If the same flags are passed in init, they will be overridden by the values here.
|
|
1736
1875
|
* Warning: This option is for advanced use only and is used internally
|
|
1737
1876
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1738
1877
|
* list of supported keys and values associated with each.
|
|
1739
1878
|
*
|
|
1740
1879
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1880
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1741
1881
|
* @example
|
|
1742
1882
|
* ```js
|
|
1743
1883
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1749,7 +1889,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1749
1889
|
* },
|
|
1750
1890
|
* });
|
|
1751
1891
|
* ```
|
|
1752
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1753
1892
|
*/
|
|
1754
1893
|
additionalFlags?: {
|
|
1755
1894
|
[key: string]: string | number | boolean;
|
|
@@ -1792,6 +1931,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1792
1931
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1793
1932
|
*
|
|
1794
1933
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1934
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1795
1935
|
* @example
|
|
1796
1936
|
* ```js
|
|
1797
1937
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1801,7 +1941,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1801
1941
|
* });
|
|
1802
1942
|
* embed.showPreRender();
|
|
1803
1943
|
* ```
|
|
1804
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1805
1944
|
*/
|
|
1806
1945
|
preRenderId?: string;
|
|
1807
1946
|
/**
|
|
@@ -1811,7 +1950,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1811
1950
|
* its dimensions based on changes to the size of the embedding element.
|
|
1812
1951
|
* @type {boolean}
|
|
1813
1952
|
* @default false
|
|
1814
|
-
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
1953
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
|
|
1815
1954
|
* @example
|
|
1816
1955
|
* ```js
|
|
1817
1956
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -1826,9 +1965,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1826
1965
|
doNotTrackPreRenderSize?: boolean;
|
|
1827
1966
|
/**
|
|
1828
1967
|
* Enable the V2 shell. This can provide performance benefits
|
|
1829
|
-
* due to a
|
|
1968
|
+
* due to a lighter-weight shell.
|
|
1830
1969
|
*
|
|
1831
1970
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1971
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1832
1972
|
* @example
|
|
1833
1973
|
* ```js
|
|
1834
1974
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1837,7 +1977,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1837
1977
|
* enableV2Shell_experimental: true,
|
|
1838
1978
|
* });
|
|
1839
1979
|
* ```
|
|
1840
|
-
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1841
1980
|
*/
|
|
1842
1981
|
enableV2Shell_experimental?: boolean;
|
|
1843
1982
|
/**
|
|
@@ -1856,6 +1995,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1856
1995
|
* and disable redirection of links in a new tab.
|
|
1857
1996
|
*
|
|
1858
1997
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1998
|
+
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1859
1999
|
* @example
|
|
1860
2000
|
* ```js
|
|
1861
2001
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1864,7 +2004,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1864
2004
|
* disableRedirectionLinksInNewTab: true,
|
|
1865
2005
|
* });
|
|
1866
2006
|
* ```
|
|
1867
|
-
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1868
2007
|
*/
|
|
1869
2008
|
disableRedirectionLinksInNewTab?: boolean;
|
|
1870
2009
|
/**
|
|
@@ -1875,6 +2014,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1875
2014
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
1876
2015
|
*
|
|
1877
2016
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2017
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
1878
2018
|
* @example
|
|
1879
2019
|
* ```js
|
|
1880
2020
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1883,24 +2023,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1883
2023
|
* overrideOrgId: 142536,
|
|
1884
2024
|
* });
|
|
1885
2025
|
* ```
|
|
1886
|
-
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
1887
2026
|
*/
|
|
1888
2027
|
overrideOrgId?: number;
|
|
1889
2028
|
/**
|
|
1890
|
-
* Flag to override the *Open Link in New Tab* context
|
|
2029
|
+
* Flag to override the *Open Link in New Tab* context
|
|
2030
|
+
* menu option.
|
|
1891
2031
|
*
|
|
1892
|
-
*
|
|
2032
|
+
* For improved link override handling, use
|
|
2033
|
+
* {@link enableLinkOverridesV2} instead.
|
|
2034
|
+
*
|
|
2035
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2036
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2037
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
1893
2038
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1894
2039
|
* @example
|
|
1895
2040
|
* ```js
|
|
1896
|
-
*
|
|
1897
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2041
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1898
2042
|
* ... // other embed view config
|
|
1899
|
-
* linkOverride:
|
|
2043
|
+
* linkOverride: true,
|
|
1900
2044
|
* })
|
|
1901
2045
|
* ```
|
|
1902
2046
|
*/
|
|
1903
2047
|
linkOverride?: boolean;
|
|
2048
|
+
/**
|
|
2049
|
+
* Enables the V2 link override mechanism with improved
|
|
2050
|
+
* handling. When enabled, navigation links within the
|
|
2051
|
+
* embedded ThoughtSpot app are intercepted and routed
|
|
2052
|
+
* through the SDK via the `EmbedEvent.DialogOpen`
|
|
2053
|
+
* event.
|
|
2054
|
+
*
|
|
2055
|
+
* The SDK automatically sends {@link linkOverride}
|
|
2056
|
+
* alongside this flag for backward compatibility with
|
|
2057
|
+
* older ThoughtSpot versions.
|
|
2058
|
+
*
|
|
2059
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2060
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2061
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2062
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
|
|
2063
|
+
* @example
|
|
2064
|
+
* ```js
|
|
2065
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2066
|
+
* ... // other embed view config
|
|
2067
|
+
* enableLinkOverridesV2: true,
|
|
2068
|
+
* });
|
|
2069
|
+
*
|
|
2070
|
+
* embed.on(EmbedEvent.DialogOpen, (payload) => {
|
|
2071
|
+
* console.log('Link clicked:', payload);
|
|
2072
|
+
* });
|
|
2073
|
+
* ```
|
|
2074
|
+
*/
|
|
2075
|
+
enableLinkOverridesV2?: boolean;
|
|
1904
2076
|
/**
|
|
1905
2077
|
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
1906
2078
|
* Use this to set the primary action.
|
|
@@ -1925,7 +2097,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1925
2097
|
insertInToSlide?: boolean;
|
|
1926
2098
|
/**
|
|
1927
2099
|
* Show alert messages and toast messages in the embed.
|
|
1928
|
-
* Supported
|
|
2100
|
+
* Supported in all embed types.
|
|
1929
2101
|
*
|
|
1930
2102
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1931
2103
|
* @example
|
|
@@ -1950,7 +2122,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1950
2122
|
* ```ts
|
|
1951
2123
|
* import {
|
|
1952
2124
|
* CustomActionPayload,
|
|
1953
|
-
*
|
|
2125
|
+
* CustomActionsPosition,
|
|
1954
2126
|
* CustomActionTarget,
|
|
1955
2127
|
* } from '@thoughtspot/visual-embed-sdk';
|
|
1956
2128
|
* // Use supported embed types such as AppEmbed or LiveboardEmbed
|
|
@@ -1958,13 +2130,41 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1958
2130
|
* ... // other embed config options
|
|
1959
2131
|
* customActions: [
|
|
1960
2132
|
* {
|
|
1961
|
-
*
|
|
1962
|
-
* id: '
|
|
1963
|
-
*
|
|
1964
|
-
*
|
|
1965
|
-
*
|
|
2133
|
+
* // Unique identifier for the custom action
|
|
2134
|
+
* id: 'my-custom-action',
|
|
2135
|
+
*
|
|
2136
|
+
* // Display name shown to users in the UI
|
|
2137
|
+
* name: 'My Custom Action',
|
|
2138
|
+
*
|
|
2139
|
+
* // Where the action appears in the UI
|
|
2140
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
2141
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
2142
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
2143
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
2144
|
+
*
|
|
2145
|
+
* // What type of content this action applies to
|
|
2146
|
+
* // ANSWER: Available on answer pages
|
|
2147
|
+
* target: CustomActionTarget.ANSWER,
|
|
2148
|
+
*
|
|
2149
|
+
* // Optional: Restrict where this action appears based on data models
|
|
2150
|
+
* // dataModelIds: {
|
|
2151
|
+
* // // Restrict to specific data models
|
|
2152
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
2153
|
+
* // // Restrict to specific columns within models
|
|
2154
|
+
* // modelColumnNames: ['model-id::column-name']
|
|
2155
|
+
* // },
|
|
2156
|
+
*
|
|
2157
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
2158
|
+
* // metadataIds: {
|
|
2159
|
+
* // // Restrict to specific answers
|
|
2160
|
+
* // answerIds: ['answer-id-1', 'answer-id-2'],
|
|
2161
|
+
* // },
|
|
2162
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
2163
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
2164
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
2165
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
1966
2166
|
* }
|
|
1967
|
-
* ]
|
|
2167
|
+
* ],
|
|
1968
2168
|
* })
|
|
1969
2169
|
*
|
|
1970
2170
|
* // to trigger a custom flow on custom action click listen to Custom action embed event
|
|
@@ -1972,6 +2172,120 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1972
2172
|
* console.log('Custom Action event:', payload);
|
|
1973
2173
|
* })
|
|
1974
2174
|
* ```
|
|
2175
|
+
* @example
|
|
2176
|
+
* ```ts
|
|
2177
|
+
* import {
|
|
2178
|
+
* CustomActionsPosition,
|
|
2179
|
+
* CustomActionTarget,
|
|
2180
|
+
* } from '@thoughtspot/visual-embed-sdk';
|
|
2181
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2182
|
+
* ... // other embed config options
|
|
2183
|
+
* customActions: [
|
|
2184
|
+
* {
|
|
2185
|
+
* // Unique identifier for the custom action
|
|
2186
|
+
* id: 'my-custom-action',
|
|
2187
|
+
*
|
|
2188
|
+
* // Display name shown to users in the UI
|
|
2189
|
+
* name: 'My Custom Action',
|
|
2190
|
+
*
|
|
2191
|
+
* // Where the action appears in the UI
|
|
2192
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
2193
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
2194
|
+
* position: CustomActionsPosition.MENU,
|
|
2195
|
+
*
|
|
2196
|
+
* // What type of content this action applies to
|
|
2197
|
+
* // SPOTTER: Available in Spotter (AI-powered search)
|
|
2198
|
+
* target: CustomActionTarget.SPOTTER,
|
|
2199
|
+
*
|
|
2200
|
+
* // Optional: Restrict where this action appears based on data models
|
|
2201
|
+
* // dataModelIds: {
|
|
2202
|
+
* // // Restrict to specific data models
|
|
2203
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
2204
|
+
* // },
|
|
2205
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
2206
|
+
* // groupIds: ['group-id-1'],
|
|
2207
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
2208
|
+
* // orgIds: ['org-id-1'],
|
|
2209
|
+
* }
|
|
2210
|
+
* ],
|
|
2211
|
+
* })
|
|
2212
|
+
* ```
|
|
2213
|
+
* @example
|
|
2214
|
+
* ```ts
|
|
2215
|
+
* import {
|
|
2216
|
+
* CustomActionsPosition,
|
|
2217
|
+
* CustomActionTarget,
|
|
2218
|
+
* } from '@thoughtspot/visual-embed-sdk';
|
|
2219
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2220
|
+
* ... // other embed config options
|
|
2221
|
+
* customActions: [
|
|
2222
|
+
* {
|
|
2223
|
+
* // Unique identifier for the custom action
|
|
2224
|
+
* id: 'my-liveboard-custom-action',
|
|
2225
|
+
*
|
|
2226
|
+
* // Display name shown to users in the UI
|
|
2227
|
+
* name: 'My Liveboard Custom Action',
|
|
2228
|
+
*
|
|
2229
|
+
* // Where the action appears in the UI
|
|
2230
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
2231
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
2232
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
2233
|
+
*
|
|
2234
|
+
* // What type of content this action applies to
|
|
2235
|
+
* // LIVEBOARD: Available on liveboard pages
|
|
2236
|
+
* target: CustomActionTarget.LIVEBOARD,
|
|
2237
|
+
*
|
|
2238
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
2239
|
+
* // metadataIds: {
|
|
2240
|
+
* // // Restrict to specific liveboards
|
|
2241
|
+
* // liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
|
|
2242
|
+
* // },
|
|
2243
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
2244
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
2245
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
2246
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
2247
|
+
* },
|
|
2248
|
+
* {
|
|
2249
|
+
* // Unique identifier for the custom action
|
|
2250
|
+
* id: 'my-viz-custom-action',
|
|
2251
|
+
*
|
|
2252
|
+
* // Display name shown to users in the UI
|
|
2253
|
+
* name: 'My Viz Custom Action',
|
|
2254
|
+
*
|
|
2255
|
+
* // Where the action appears in the UI
|
|
2256
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
2257
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
2258
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
2259
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
2260
|
+
*
|
|
2261
|
+
* // What type of content this action applies to
|
|
2262
|
+
* // VIZ: Available on individual visualizations
|
|
2263
|
+
* target: CustomActionTarget.VIZ,
|
|
2264
|
+
*
|
|
2265
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
2266
|
+
* // metadataIds: {
|
|
2267
|
+
* // // Restrict to specific answers
|
|
2268
|
+
* // answerIds: ['answer-id-1', 'answer-id-2'],
|
|
2269
|
+
* // // Restrict to specific liveboard. If liveboardId is
|
|
2270
|
+
* // // passed, custom actions will appear on all vizzes of liveboard
|
|
2271
|
+
* // liveboardIds: ['liveboard-id-1'],
|
|
2272
|
+
* // // Restrict to specific vizIds
|
|
2273
|
+
* // vizIds: ['viz-id-1']
|
|
2274
|
+
* // },
|
|
2275
|
+
* // dataModelIds: {
|
|
2276
|
+
* // // Restrict to specific data models
|
|
2277
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
2278
|
+
* // // Restrict to specific columns within models
|
|
2279
|
+
* // modelColumnNames: ['model-id::column-name']
|
|
2280
|
+
* // },
|
|
2281
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
2282
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
2283
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
2284
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
2285
|
+
* }
|
|
2286
|
+
* ],
|
|
2287
|
+
* })
|
|
2288
|
+
* ```
|
|
1975
2289
|
*/
|
|
1976
2290
|
customActions?: CustomAction[];
|
|
1977
2291
|
/**
|
|
@@ -2067,7 +2381,7 @@ export interface HomePageConfig {
|
|
|
2067
2381
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
2068
2382
|
*
|
|
2069
2383
|
* Supported embed types: `AppEmbed`
|
|
2070
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2384
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2071
2385
|
* @example
|
|
2072
2386
|
* ```js
|
|
2073
2387
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2088,6 +2402,7 @@ export interface HomePageConfig {
|
|
|
2088
2402
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
2089
2403
|
*
|
|
2090
2404
|
* Supported embed types: `AppEmbed`
|
|
2405
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2091
2406
|
* @example
|
|
2092
2407
|
* ```js
|
|
2093
2408
|
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2098,7 +2413,6 @@ export interface HomePageConfig {
|
|
|
2098
2413
|
* ... //other embed view configuration attributes
|
|
2099
2414
|
* })
|
|
2100
2415
|
* ```
|
|
2101
|
-
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2102
2416
|
*/
|
|
2103
2417
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2104
2418
|
}
|
|
@@ -2111,7 +2425,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2111
2425
|
* visualization, or Liveboard.
|
|
2112
2426
|
*
|
|
2113
2427
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2114
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2428
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2115
2429
|
* @example
|
|
2116
2430
|
* ```js
|
|
2117
2431
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2129,11 +2443,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2129
2443
|
*/
|
|
2130
2444
|
runtimeFilters?: RuntimeFilter[];
|
|
2131
2445
|
/**
|
|
2132
|
-
* The list of parameter
|
|
2446
|
+
* The list of parameter overrides to apply to a search Answer,
|
|
2133
2447
|
* visualization, or Liveboard.
|
|
2134
2448
|
*
|
|
2135
2449
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2136
|
-
* @version SDK
|
|
2450
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2137
2451
|
* @example
|
|
2138
2452
|
* ```js
|
|
2139
2453
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2153,6 +2467,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2153
2467
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2154
2468
|
*
|
|
2155
2469
|
* Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
|
|
2470
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2156
2471
|
* @example
|
|
2157
2472
|
* ```js
|
|
2158
2473
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
|
|
@@ -2161,7 +2476,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2161
2476
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
2162
2477
|
* })
|
|
2163
2478
|
* ```
|
|
2164
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2165
2479
|
*/
|
|
2166
2480
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2167
2481
|
/**
|
|
@@ -2184,7 +2498,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2184
2498
|
* when set to false, runtime parameters will be included in the URL
|
|
2185
2499
|
* (default behavior before SDK 1.45.0).
|
|
2186
2500
|
*
|
|
2187
|
-
* Irrespective of this flag, runtime
|
|
2501
|
+
* Irrespective of this flag, runtime parameters (if passed) will be applied to the
|
|
2188
2502
|
* embedded view.
|
|
2189
2503
|
* @default true
|
|
2190
2504
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
@@ -2203,14 +2517,15 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2203
2517
|
* ... // other embed view config
|
|
2204
2518
|
* collapseSearchBar: true,
|
|
2205
2519
|
* });
|
|
2520
|
+
* ```
|
|
2206
2521
|
*/
|
|
2207
2522
|
collapseSearchBar?: boolean;
|
|
2208
2523
|
/**
|
|
2209
2524
|
* Flag to control Data panel experience
|
|
2210
2525
|
*
|
|
2211
2526
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2527
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2212
2528
|
* @default true
|
|
2213
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2214
2529
|
* @example
|
|
2215
2530
|
* ```js
|
|
2216
2531
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -2243,6 +2558,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2243
2558
|
* the current time period in filter results.
|
|
2244
2559
|
*
|
|
2245
2560
|
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2561
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2246
2562
|
* @example
|
|
2247
2563
|
* ```js
|
|
2248
2564
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
@@ -2250,7 +2566,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2250
2566
|
* isThisPeriodInDateFiltersEnabled: true,
|
|
2251
2567
|
* })
|
|
2252
2568
|
* ```
|
|
2253
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2254
2569
|
*/
|
|
2255
2570
|
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
2256
2571
|
}
|
|
@@ -2310,6 +2625,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2310
2625
|
* Boolean to control if Liveboard header is sticky or not.
|
|
2311
2626
|
*
|
|
2312
2627
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2628
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2313
2629
|
* @example
|
|
2314
2630
|
* ```js
|
|
2315
2631
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2318,7 +2634,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2318
2634
|
* isLiveboardHeaderSticky: true,
|
|
2319
2635
|
* });
|
|
2320
2636
|
* ```
|
|
2321
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2322
2637
|
*/
|
|
2323
2638
|
isLiveboardHeaderSticky?: boolean;
|
|
2324
2639
|
/**
|
|
@@ -2326,8 +2641,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2326
2641
|
*
|
|
2327
2642
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2328
2643
|
* @type {boolean}
|
|
2644
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
|
|
2329
2645
|
* @default false
|
|
2330
|
-
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
2331
2646
|
* @example
|
|
2332
2647
|
* ```js
|
|
2333
2648
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2343,8 +2658,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2343
2658
|
*
|
|
2344
2659
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2345
2660
|
* @type {boolean}
|
|
2661
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
|
|
2346
2662
|
* @default false
|
|
2347
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
|
|
2348
2663
|
* @example
|
|
2349
2664
|
* ```js
|
|
2350
2665
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2360,7 +2675,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2360
2675
|
* header.
|
|
2361
2676
|
*
|
|
2362
2677
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2363
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2678
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2364
2679
|
* @default true
|
|
2365
2680
|
* @example
|
|
2366
2681
|
* ```js
|
|
@@ -2378,7 +2693,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2378
2693
|
* **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
|
|
2379
2694
|
*
|
|
2380
2695
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2381
|
-
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
2696
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2382
2697
|
* @default false
|
|
2383
2698
|
* @example
|
|
2384
2699
|
* ```js
|
|
@@ -2396,7 +2711,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2396
2711
|
* compact header
|
|
2397
2712
|
*
|
|
2398
2713
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2399
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2714
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2400
2715
|
* @default true
|
|
2401
2716
|
* @example
|
|
2402
2717
|
* ```js
|
|
@@ -2429,7 +2744,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2429
2744
|
* the cover and filters pages in the Liveboard PDF.
|
|
2430
2745
|
*
|
|
2431
2746
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2432
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
2747
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
|
|
2433
2748
|
* @example
|
|
2434
2749
|
* ```js
|
|
2435
2750
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2633,7 +2948,7 @@ export declare enum HomepageModule {
|
|
|
2633
2948
|
*/
|
|
2634
2949
|
Search = "SEARCH",
|
|
2635
2950
|
/**
|
|
2636
|
-
*
|
|
2951
|
+
* KPI watchlist module
|
|
2637
2952
|
*/
|
|
2638
2953
|
Watchlist = "WATCHLIST",
|
|
2639
2954
|
/**
|
|
@@ -2664,7 +2979,8 @@ export declare enum ListPageColumns {
|
|
|
2664
2979
|
*/
|
|
2665
2980
|
Favorites = "FAVOURITE",
|
|
2666
2981
|
/**
|
|
2667
|
-
*
|
|
2982
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
2983
|
+
* @deprecated This option is deprecated.
|
|
2668
2984
|
*/
|
|
2669
2985
|
Favourite = "FAVOURITE",
|
|
2670
2986
|
/**
|
|
@@ -2765,13 +3081,13 @@ export declare enum EmbedEvent {
|
|
|
2765
3081
|
/**
|
|
2766
3082
|
* Rendering has initialized.
|
|
2767
3083
|
* @example
|
|
2768
|
-
|
|
3084
|
+
* ```js
|
|
2769
3085
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
2770
3086
|
* //show a loader
|
|
2771
3087
|
* function showLoader() {
|
|
2772
3088
|
* document.getElementById("loader");
|
|
2773
3089
|
* }
|
|
2774
|
-
|
|
3090
|
+
* ```
|
|
2775
3091
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2776
3092
|
*/
|
|
2777
3093
|
Init = "init",
|
|
@@ -2779,11 +3095,11 @@ export declare enum EmbedEvent {
|
|
|
2779
3095
|
* Authentication has either succeeded or failed.
|
|
2780
3096
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2781
3097
|
* @example
|
|
2782
|
-
|
|
3098
|
+
* ```js
|
|
2783
3099
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
2784
3100
|
* console.log('AuthInit', payload);
|
|
2785
3101
|
* })
|
|
2786
|
-
|
|
3102
|
+
* ```
|
|
2787
3103
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
2788
3104
|
*/
|
|
2789
3105
|
AuthInit = "authInit",
|
|
@@ -2792,13 +3108,13 @@ export declare enum EmbedEvent {
|
|
|
2792
3108
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2793
3109
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2794
3110
|
* @example
|
|
2795
|
-
|
|
3111
|
+
* ```js
|
|
2796
3112
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
2797
3113
|
* //hide loader
|
|
2798
3114
|
* function hideLoader() {
|
|
2799
3115
|
* document.getElementById("loader");
|
|
2800
3116
|
* }
|
|
2801
|
-
|
|
3117
|
+
* ```
|
|
2802
3118
|
*/
|
|
2803
3119
|
Load = "load",
|
|
2804
3120
|
/**
|
|
@@ -2807,11 +3123,11 @@ export declare enum EmbedEvent {
|
|
|
2807
3123
|
* @return data - Answer of Liveboard data
|
|
2808
3124
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2809
3125
|
* @example
|
|
2810
|
-
|
|
3126
|
+
* ```js
|
|
2811
3127
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
2812
3128
|
* console.log('data', payload);
|
|
2813
3129
|
* })
|
|
2814
|
-
|
|
3130
|
+
* ```
|
|
2815
3131
|
* @important
|
|
2816
3132
|
*/
|
|
2817
3133
|
Data = "data",
|
|
@@ -2819,9 +3135,9 @@ export declare enum EmbedEvent {
|
|
|
2819
3135
|
* Search query has been updated by the user.
|
|
2820
3136
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2821
3137
|
* @example
|
|
2822
|
-
|
|
3138
|
+
* ```js
|
|
2823
3139
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
2824
|
-
|
|
3140
|
+
* ```
|
|
2825
3141
|
*/
|
|
2826
3142
|
QueryChanged = "queryChanged",
|
|
2827
3143
|
/**
|
|
@@ -2831,7 +3147,7 @@ export declare enum EmbedEvent {
|
|
|
2831
3147
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2832
3148
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
2833
3149
|
* @example
|
|
2834
|
-
|
|
3150
|
+
* ```js
|
|
2835
3151
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
2836
3152
|
* points: {
|
|
2837
3153
|
* clickedPoint,
|
|
@@ -2839,12 +3155,12 @@ export declare enum EmbedEvent {
|
|
|
2839
3155
|
* },
|
|
2840
3156
|
* autoDrillDown: true,
|
|
2841
3157
|
* })
|
|
2842
|
-
|
|
3158
|
+
* ```
|
|
2843
3159
|
* In this example, `VizPointDoubleClick` event is used for
|
|
2844
3160
|
* triggering the `DrillDown` event when an area or specific
|
|
2845
3161
|
* data point on a table or chart is double-clicked.
|
|
2846
3162
|
* @example
|
|
2847
|
-
|
|
3163
|
+
* ```js
|
|
2848
3164
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
2849
3165
|
* console.log(payload);
|
|
2850
3166
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -2858,7 +3174,7 @@ export declare enum EmbedEvent {
|
|
|
2858
3174
|
* autoDrillDown: true,
|
|
2859
3175
|
* })
|
|
2860
3176
|
* })
|
|
2861
|
-
|
|
3177
|
+
* ```
|
|
2862
3178
|
*/
|
|
2863
3179
|
Drilldown = "drillDown",
|
|
2864
3180
|
/**
|
|
@@ -2983,13 +3299,13 @@ export declare enum EmbedEvent {
|
|
|
2983
3299
|
* The ThoughtSpot authentication session has expired.
|
|
2984
3300
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2985
3301
|
* @example
|
|
2986
|
-
|
|
3302
|
+
* ```js
|
|
2987
3303
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
2988
3304
|
* //show auth expired banner
|
|
2989
3305
|
* function showAuthExpired() {
|
|
2990
3306
|
* document.getElementById("authExpiredBanner");
|
|
2991
3307
|
* }
|
|
2992
|
-
|
|
3308
|
+
* ```
|
|
2993
3309
|
*/
|
|
2994
3310
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
2995
3311
|
/**
|
|
@@ -3024,22 +3340,22 @@ export declare enum EmbedEvent {
|
|
|
3024
3340
|
* Applicable to `SearchBarEmbed` only.
|
|
3025
3341
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3026
3342
|
* @example
|
|
3027
|
-
|
|
3343
|
+
* ```js
|
|
3028
3344
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
3029
3345
|
* .then(data => {
|
|
3030
3346
|
* console.log('Answer Data:', data);
|
|
3031
3347
|
* })
|
|
3032
|
-
|
|
3348
|
+
* ```
|
|
3033
3349
|
*/
|
|
3034
3350
|
GetDataClick = "getDataClick",
|
|
3035
3351
|
/**
|
|
3036
3352
|
* Detects the route change.
|
|
3037
3353
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3038
3354
|
* @example
|
|
3039
|
-
|
|
3355
|
+
* ```js
|
|
3040
3356
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
3041
3357
|
* console.log('data', payload))
|
|
3042
|
-
|
|
3358
|
+
* ```
|
|
3043
3359
|
*/
|
|
3044
3360
|
RouteChange = "ROUTE_CHANGE",
|
|
3045
3361
|
/**
|
|
@@ -3049,12 +3365,12 @@ export declare enum EmbedEvent {
|
|
|
3049
3365
|
V1Data = "exportVizDataToParent",
|
|
3050
3366
|
/**
|
|
3051
3367
|
* Emitted when the embed does not have cookie access. This happens
|
|
3052
|
-
* when
|
|
3053
|
-
*
|
|
3368
|
+
* when third-party cookies are blocked by Safari or other
|
|
3369
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
3054
3370
|
* @example
|
|
3055
|
-
|
|
3371
|
+
* ```js
|
|
3056
3372
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
3057
|
-
|
|
3373
|
+
* ```
|
|
3058
3374
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
3059
3375
|
*/
|
|
3060
3376
|
NoCookieAccess = "noCookieAccess",
|
|
@@ -3068,22 +3384,22 @@ export declare enum EmbedEvent {
|
|
|
3068
3384
|
* Emitted when any modal is opened in the app
|
|
3069
3385
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3070
3386
|
* @example
|
|
3071
|
-
|
|
3387
|
+
* ```js
|
|
3072
3388
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
3073
3389
|
* console.log('dialog open', payload);
|
|
3074
3390
|
* })
|
|
3075
|
-
|
|
3391
|
+
* ```
|
|
3076
3392
|
*/
|
|
3077
3393
|
DialogOpen = "dialog-open",
|
|
3078
3394
|
/**
|
|
3079
3395
|
* Emitted when any modal is closed in the app
|
|
3080
3396
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3081
3397
|
* @example
|
|
3082
|
-
|
|
3398
|
+
* ```js
|
|
3083
3399
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
3084
3400
|
* console.log('dialog close', payload);
|
|
3085
3401
|
* })
|
|
3086
|
-
|
|
3402
|
+
* ```
|
|
3087
3403
|
*/
|
|
3088
3404
|
DialogClose = "dialog-close",
|
|
3089
3405
|
/**
|
|
@@ -3092,39 +3408,39 @@ export declare enum EmbedEvent {
|
|
|
3092
3408
|
* other events on the rendered Liveboard.
|
|
3093
3409
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3094
3410
|
* @example
|
|
3095
|
-
|
|
3411
|
+
* ```js
|
|
3096
3412
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
3097
3413
|
console.log('Liveboard is rendered', payload);
|
|
3098
3414
|
})
|
|
3099
|
-
|
|
3415
|
+
* ```
|
|
3100
3416
|
* The following example shows how to trigger
|
|
3101
3417
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
3102
3418
|
* @example
|
|
3103
|
-
|
|
3419
|
+
* ```js
|
|
3104
3420
|
* const embedRef = useEmbedRef();
|
|
3105
3421
|
* const onLiveboardRendered = () => {
|
|
3106
3422
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
3107
3423
|
* };
|
|
3108
|
-
|
|
3424
|
+
* ```
|
|
3109
3425
|
*/
|
|
3110
3426
|
LiveboardRendered = "PinboardRendered",
|
|
3111
3427
|
/**
|
|
3112
3428
|
* Emits all events.
|
|
3113
|
-
* @
|
|
3429
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3114
3430
|
* @example
|
|
3115
|
-
|
|
3431
|
+
* ```js
|
|
3116
3432
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
3117
3433
|
* console.log('Embed Events', payload)
|
|
3118
3434
|
* })
|
|
3119
|
-
|
|
3435
|
+
* ```
|
|
3120
3436
|
*/
|
|
3121
3437
|
ALL = "*",
|
|
3122
3438
|
/**
|
|
3123
3439
|
* Emitted when an Answer is saved in the app.
|
|
3124
3440
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
3125
|
-
* @
|
|
3441
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3126
3442
|
* @example
|
|
3127
|
-
|
|
3443
|
+
* ```js
|
|
3128
3444
|
* //Emit when action starts
|
|
3129
3445
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3130
3446
|
* console.log('Save', payload)
|
|
@@ -3135,7 +3451,7 @@ export declare enum EmbedEvent {
|
|
|
3135
3451
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3136
3452
|
* console.log('Save', payload)
|
|
3137
3453
|
* })
|
|
3138
|
-
|
|
3454
|
+
* ```
|
|
3139
3455
|
*/
|
|
3140
3456
|
Save = "save",
|
|
3141
3457
|
/**
|
|
@@ -3147,11 +3463,11 @@ export declare enum EmbedEvent {
|
|
|
3147
3463
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
3148
3464
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3149
3465
|
* @example
|
|
3150
|
-
|
|
3466
|
+
* ```js
|
|
3151
3467
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
3152
3468
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3153
3469
|
* })
|
|
3154
|
-
|
|
3470
|
+
* ```
|
|
3155
3471
|
*/
|
|
3156
3472
|
Download = "download",
|
|
3157
3473
|
/**
|
|
@@ -3159,14 +3475,14 @@ export declare enum EmbedEvent {
|
|
|
3159
3475
|
* Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
|
|
3160
3476
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3161
3477
|
* @example
|
|
3162
|
-
|
|
3478
|
+
* ```js
|
|
3163
3479
|
* //emit when action starts
|
|
3164
3480
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3165
3481
|
* console.log('download PNG', payload)}, {start: true })
|
|
3166
3482
|
* //emit when action ends
|
|
3167
3483
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3168
3484
|
* console.log('download PNG', payload)})
|
|
3169
|
-
|
|
3485
|
+
* ```
|
|
3170
3486
|
*/
|
|
3171
3487
|
DownloadAsPng = "downloadAsPng",
|
|
3172
3488
|
/**
|
|
@@ -3174,14 +3490,14 @@ export declare enum EmbedEvent {
|
|
|
3174
3490
|
* 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.
|
|
3175
3491
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3176
3492
|
* @example
|
|
3177
|
-
|
|
3493
|
+
* ```js
|
|
3178
3494
|
* //emit when action starts
|
|
3179
3495
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3180
3496
|
* console.log('download PDF', payload)}, {start: true })
|
|
3181
3497
|
* //emit when action ends
|
|
3182
3498
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3183
3499
|
* console.log('download PDF', payload)})
|
|
3184
|
-
|
|
3500
|
+
* ```
|
|
3185
3501
|
*/
|
|
3186
3502
|
DownloadAsPdf = "downloadAsPdf",
|
|
3187
3503
|
/**
|
|
@@ -3189,14 +3505,14 @@ export declare enum EmbedEvent {
|
|
|
3189
3505
|
* 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.
|
|
3190
3506
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3191
3507
|
* @example
|
|
3192
|
-
|
|
3508
|
+
* ```js
|
|
3193
3509
|
* //emit when action starts
|
|
3194
3510
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3195
3511
|
* console.log('download CSV', payload)}, {start: true })
|
|
3196
3512
|
* //emit when action ends
|
|
3197
3513
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3198
3514
|
* console.log('download CSV', payload)})
|
|
3199
|
-
|
|
3515
|
+
* ```
|
|
3200
3516
|
*/
|
|
3201
3517
|
DownloadAsCsv = "downloadAsCsv",
|
|
3202
3518
|
/**
|
|
@@ -3204,14 +3520,14 @@ export declare enum EmbedEvent {
|
|
|
3204
3520
|
* 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.
|
|
3205
3521
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3206
3522
|
* @example
|
|
3207
|
-
|
|
3523
|
+
* ```js
|
|
3208
3524
|
* //emit when action starts
|
|
3209
3525
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3210
3526
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
3211
3527
|
* //emit when action ends
|
|
3212
3528
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3213
3529
|
* console.log('download Xlsx', payload)})
|
|
3214
|
-
|
|
3530
|
+
* ```
|
|
3215
3531
|
*/
|
|
3216
3532
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3217
3533
|
/**
|
|
@@ -3219,25 +3535,25 @@ export declare enum EmbedEvent {
|
|
|
3219
3535
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
|
|
3220
3536
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3221
3537
|
* @example
|
|
3222
|
-
|
|
3538
|
+
* ```js
|
|
3223
3539
|
* //emit when action starts
|
|
3224
3540
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3225
3541
|
* console.log('delete answer', payload)}, {start: true })
|
|
3226
3542
|
* //trigger when action is completed
|
|
3227
3543
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3228
3544
|
* console.log('delete answer', payload)})
|
|
3229
|
-
|
|
3545
|
+
* ```
|
|
3230
3546
|
*/
|
|
3231
3547
|
AnswerDelete = "answerDelete",
|
|
3232
3548
|
/**
|
|
3233
3549
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
3234
3550
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
3235
3551
|
* @example
|
|
3236
|
-
|
|
3552
|
+
* ```js
|
|
3237
3553
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
3238
3554
|
* console.log('AI Highlights', payload);
|
|
3239
3555
|
* })
|
|
3240
|
-
|
|
3556
|
+
* ```
|
|
3241
3557
|
*/
|
|
3242
3558
|
AIHighlights = "AIHighlights",
|
|
3243
3559
|
/**
|
|
@@ -3246,7 +3562,7 @@ export declare enum EmbedEvent {
|
|
|
3246
3562
|
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
|
|
3247
3563
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3248
3564
|
* @example
|
|
3249
|
-
|
|
3565
|
+
* ```js
|
|
3250
3566
|
* //emit when action starts
|
|
3251
3567
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3252
3568
|
* console.log('pin', payload)
|
|
@@ -3257,14 +3573,14 @@ export declare enum EmbedEvent {
|
|
|
3257
3573
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3258
3574
|
* console.log('pin', payload)
|
|
3259
3575
|
* })
|
|
3260
|
-
|
|
3576
|
+
* ```
|
|
3261
3577
|
*/
|
|
3262
3578
|
Pin = "pin",
|
|
3263
3579
|
/**
|
|
3264
3580
|
* Emitted when SpotIQ analysis is triggered
|
|
3265
3581
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3266
3582
|
* @example
|
|
3267
|
-
|
|
3583
|
+
* ```js
|
|
3268
3584
|
* //emit when action starts
|
|
3269
3585
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3270
3586
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -3275,14 +3591,14 @@ export declare enum EmbedEvent {
|
|
|
3275
3591
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3276
3592
|
* console.log('SpotIQ analyze', payload)
|
|
3277
3593
|
* })
|
|
3278
|
-
|
|
3594
|
+
* ```
|
|
3279
3595
|
*/
|
|
3280
3596
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3281
3597
|
/**
|
|
3282
3598
|
* Emitted when a user shares an object with another user or group
|
|
3283
3599
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3284
3600
|
* @example
|
|
3285
|
-
|
|
3601
|
+
* ```js
|
|
3286
3602
|
* //emit when action starts
|
|
3287
3603
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3288
3604
|
* console.log('Share', payload)
|
|
@@ -3293,7 +3609,7 @@ export declare enum EmbedEvent {
|
|
|
3293
3609
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3294
3610
|
* console.log('Share', payload)
|
|
3295
3611
|
* })
|
|
3296
|
-
|
|
3612
|
+
* ```
|
|
3297
3613
|
*/
|
|
3298
3614
|
Share = "share",
|
|
3299
3615
|
/**
|
|
@@ -3301,11 +3617,11 @@ export declare enum EmbedEvent {
|
|
|
3301
3617
|
* data on a chart or table.
|
|
3302
3618
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3303
3619
|
* @example
|
|
3304
|
-
|
|
3620
|
+
* ```js
|
|
3305
3621
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
3306
3622
|
* console.log('Drill include', payload);
|
|
3307
3623
|
* })
|
|
3308
|
-
|
|
3624
|
+
* ```
|
|
3309
3625
|
*/
|
|
3310
3626
|
DrillInclude = "context-menu-item-include",
|
|
3311
3627
|
/**
|
|
@@ -3313,22 +3629,22 @@ export declare enum EmbedEvent {
|
|
|
3313
3629
|
* data on a chart or table
|
|
3314
3630
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3315
3631
|
* @example
|
|
3316
|
-
|
|
3632
|
+
* ```js
|
|
3317
3633
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
3318
3634
|
* console.log('Drill exclude', payload);
|
|
3319
3635
|
* })
|
|
3320
|
-
|
|
3636
|
+
* ```
|
|
3321
3637
|
*/
|
|
3322
3638
|
DrillExclude = "context-menu-item-exclude",
|
|
3323
3639
|
/**
|
|
3324
3640
|
* Emitted when a column value is copied in the embedded app.
|
|
3325
3641
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3326
3642
|
* @example
|
|
3327
|
-
|
|
3328
|
-
*
|
|
3643
|
+
* ```js
|
|
3644
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
3329
3645
|
* console.log('copy to clipboard', payload);
|
|
3330
3646
|
* })
|
|
3331
|
-
|
|
3647
|
+
* ```
|
|
3332
3648
|
*/
|
|
3333
3649
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3334
3650
|
/**
|
|
@@ -3336,10 +3652,10 @@ export declare enum EmbedEvent {
|
|
|
3336
3652
|
* embedded Liveboard.
|
|
3337
3653
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3338
3654
|
* @example
|
|
3339
|
-
|
|
3655
|
+
* ```js
|
|
3340
3656
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
3341
3657
|
* })
|
|
3342
|
-
|
|
3658
|
+
* ```
|
|
3343
3659
|
*/
|
|
3344
3660
|
UpdateTML = "updateTSL",
|
|
3345
3661
|
/**
|
|
@@ -3347,11 +3663,11 @@ export declare enum EmbedEvent {
|
|
|
3347
3663
|
* on an embedded Liveboard.
|
|
3348
3664
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3349
3665
|
* @example
|
|
3350
|
-
|
|
3666
|
+
* ```js
|
|
3351
3667
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
3352
3668
|
* console.log('Edit TML', payload);
|
|
3353
3669
|
* })
|
|
3354
|
-
|
|
3670
|
+
* ```
|
|
3355
3671
|
*/
|
|
3356
3672
|
EditTML = "editTSL",
|
|
3357
3673
|
/**
|
|
@@ -3360,25 +3676,25 @@ export declare enum EmbedEvent {
|
|
|
3360
3676
|
* Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
|
|
3361
3677
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3362
3678
|
* @example
|
|
3363
|
-
|
|
3679
|
+
* ```js
|
|
3364
3680
|
* //emit when action starts
|
|
3365
3681
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3366
3682
|
* console.log('Export TML', payload)}, { start: true })
|
|
3367
3683
|
* //emit when action ends
|
|
3368
3684
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3369
3685
|
* console.log('Export TML', payload)})
|
|
3370
|
-
|
|
3686
|
+
* ```
|
|
3371
3687
|
*/
|
|
3372
3688
|
ExportTML = "exportTSL",
|
|
3373
3689
|
/**
|
|
3374
3690
|
* Emitted when an Answer is saved as a View.
|
|
3375
3691
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3376
3692
|
* @example
|
|
3377
|
-
|
|
3693
|
+
* ```js
|
|
3378
3694
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
3379
3695
|
* console.log('View', payload);
|
|
3380
3696
|
* })
|
|
3381
|
-
|
|
3697
|
+
* ```
|
|
3382
3698
|
*/
|
|
3383
3699
|
SaveAsView = "saveAsView",
|
|
3384
3700
|
/**
|
|
@@ -3386,36 +3702,36 @@ export declare enum EmbedEvent {
|
|
|
3386
3702
|
* 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.
|
|
3387
3703
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3388
3704
|
* @example
|
|
3389
|
-
|
|
3705
|
+
* ```js
|
|
3390
3706
|
* //emit when action starts
|
|
3391
3707
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3392
3708
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
3393
3709
|
* //emit when action ends
|
|
3394
3710
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3395
3711
|
* console.log('Copy and edit', payload)})
|
|
3396
|
-
|
|
3712
|
+
* ```
|
|
3397
3713
|
*/
|
|
3398
3714
|
CopyAEdit = "copyAEdit",
|
|
3399
3715
|
/**
|
|
3400
3716
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
3401
3717
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3402
3718
|
* @example
|
|
3403
|
-
|
|
3719
|
+
* ```js
|
|
3404
3720
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
3405
3721
|
* console.log('show data', payload);
|
|
3406
3722
|
* })
|
|
3407
|
-
|
|
3723
|
+
* ```
|
|
3408
3724
|
*/
|
|
3409
3725
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3410
3726
|
/**
|
|
3411
3727
|
* Emitted when an Answer is switched to a chart or table view.
|
|
3412
3728
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3413
3729
|
* @example
|
|
3414
|
-
|
|
3730
|
+
* ```js
|
|
3415
3731
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
3416
3732
|
* console.log('switch view', payload);
|
|
3417
3733
|
* })
|
|
3418
|
-
|
|
3734
|
+
* ```
|
|
3419
3735
|
*/
|
|
3420
3736
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3421
3737
|
/**
|
|
@@ -3432,118 +3748,118 @@ export declare enum EmbedEvent {
|
|
|
3432
3748
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3433
3749
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3434
3750
|
* @example
|
|
3435
|
-
|
|
3751
|
+
* ```js
|
|
3436
3752
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
3437
3753
|
* console.log('Liveboard details', payload);
|
|
3438
3754
|
* })
|
|
3439
|
-
|
|
3755
|
+
* ```
|
|
3440
3756
|
*/
|
|
3441
3757
|
LiveboardInfo = "pinboardInfo",
|
|
3442
3758
|
/**
|
|
3443
3759
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3444
3760
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3445
3761
|
* @example
|
|
3446
|
-
|
|
3762
|
+
* ```js
|
|
3447
3763
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
3448
3764
|
* console.log('favorites', payload);
|
|
3449
3765
|
* })
|
|
3450
|
-
|
|
3766
|
+
* ```
|
|
3451
3767
|
*/
|
|
3452
3768
|
AddToFavorites = "addToFavorites",
|
|
3453
3769
|
/**
|
|
3454
3770
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3455
3771
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3456
3772
|
* @example
|
|
3457
|
-
|
|
3773
|
+
* ```js
|
|
3458
3774
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
3459
|
-
* console.log(
|
|
3775
|
+
* console.log('Liveboard schedule', payload);
|
|
3460
3776
|
* })
|
|
3461
|
-
|
|
3777
|
+
* ```
|
|
3462
3778
|
*/
|
|
3463
3779
|
Schedule = "subscription",
|
|
3464
3780
|
/**
|
|
3465
3781
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3466
3782
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3467
3783
|
* @example
|
|
3468
|
-
|
|
3784
|
+
* ```js
|
|
3469
3785
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
3470
|
-
* console.log(
|
|
3786
|
+
* console.log('Liveboard edit', payload);
|
|
3471
3787
|
* })
|
|
3472
|
-
|
|
3788
|
+
* ```
|
|
3473
3789
|
*/
|
|
3474
3790
|
Edit = "edit",
|
|
3475
3791
|
/**
|
|
3476
3792
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3477
3793
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3478
3794
|
* @example
|
|
3479
|
-
|
|
3795
|
+
* ```js
|
|
3480
3796
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
3481
|
-
* console.log(
|
|
3797
|
+
* console.log('Copy', payload);
|
|
3482
3798
|
* })
|
|
3483
|
-
|
|
3799
|
+
* ```
|
|
3484
3800
|
*/
|
|
3485
3801
|
MakeACopy = "makeACopy",
|
|
3486
3802
|
/**
|
|
3487
3803
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3488
3804
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3489
3805
|
* @example
|
|
3490
|
-
|
|
3806
|
+
* ```js
|
|
3491
3807
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
3492
|
-
|
|
3808
|
+
* ```
|
|
3493
3809
|
* @example
|
|
3494
|
-
|
|
3810
|
+
* ```js
|
|
3495
3811
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
3496
3812
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3497
3813
|
* })
|
|
3498
|
-
|
|
3814
|
+
* ```
|
|
3499
3815
|
*/
|
|
3500
3816
|
Present = "present",
|
|
3501
3817
|
/**
|
|
3502
3818
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3503
3819
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3504
3820
|
* @example
|
|
3505
|
-
|
|
3821
|
+
* ```js
|
|
3506
3822
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
3507
3823
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3508
|
-
|
|
3824
|
+
* ```
|
|
3509
3825
|
*/
|
|
3510
3826
|
Delete = "delete",
|
|
3511
3827
|
/**
|
|
3512
3828
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3513
3829
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3514
3830
|
* @example
|
|
3515
|
-
|
|
3831
|
+
* ```js
|
|
3516
3832
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
3517
|
-
|
|
3833
|
+
* ```
|
|
3518
3834
|
*/
|
|
3519
3835
|
SchedulesList = "schedule-list",
|
|
3520
3836
|
/**
|
|
3521
3837
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3522
3838
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3523
3839
|
* @example
|
|
3524
|
-
|
|
3840
|
+
* ```js
|
|
3525
3841
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
3526
|
-
|
|
3842
|
+
* ```
|
|
3527
3843
|
*/
|
|
3528
3844
|
Cancel = "cancel",
|
|
3529
3845
|
/**
|
|
3530
3846
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3531
3847
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3532
3848
|
* @example
|
|
3533
|
-
|
|
3849
|
+
* ```js
|
|
3534
3850
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3535
3851
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3536
|
-
|
|
3852
|
+
* ```
|
|
3537
3853
|
*/
|
|
3538
3854
|
Explore = "explore",
|
|
3539
3855
|
/**
|
|
3540
3856
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
3541
3857
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3542
3858
|
* @example
|
|
3543
|
-
|
|
3859
|
+
* ```js
|
|
3544
3860
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3545
3861
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3546
|
-
|
|
3862
|
+
* ```
|
|
3547
3863
|
*/
|
|
3548
3864
|
CopyLink = "embedDocument",
|
|
3549
3865
|
/**
|
|
@@ -3551,21 +3867,21 @@ export declare enum EmbedEvent {
|
|
|
3551
3867
|
* visualization or Liveboard.
|
|
3552
3868
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3553
3869
|
* @example
|
|
3554
|
-
|
|
3870
|
+
* ```js
|
|
3555
3871
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3556
3872
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3557
|
-
|
|
3873
|
+
* ```
|
|
3558
3874
|
*/
|
|
3559
3875
|
CrossFilterChanged = "cross-filter-changed",
|
|
3560
3876
|
/**
|
|
3561
3877
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3562
3878
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3563
3879
|
* @example
|
|
3564
|
-
|
|
3880
|
+
* ```js
|
|
3565
3881
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
3566
3882
|
* console.log('VizPointClick', payload)
|
|
3567
3883
|
* })
|
|
3568
|
-
|
|
3884
|
+
* ```
|
|
3569
3885
|
*/
|
|
3570
3886
|
VizPointRightClick = "vizPointRightClick",
|
|
3571
3887
|
/**
|
|
@@ -3579,35 +3895,35 @@ export declare enum EmbedEvent {
|
|
|
3579
3895
|
* filter details.
|
|
3580
3896
|
* @example
|
|
3581
3897
|
*
|
|
3582
|
-
|
|
3898
|
+
* ```js
|
|
3583
3899
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3584
3900
|
* console.log('payload', payload);
|
|
3585
3901
|
* })
|
|
3586
|
-
*
|
|
3902
|
+
* ```
|
|
3587
3903
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3588
3904
|
*/
|
|
3589
3905
|
FilterChanged = "filterChanged",
|
|
3590
3906
|
/**
|
|
3591
3907
|
* Emitted when a user clicks the **Go** button to initiate
|
|
3592
3908
|
* a Natural Language Search query
|
|
3593
|
-
* @version SDK
|
|
3909
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3594
3910
|
*/
|
|
3595
3911
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3596
3912
|
/**
|
|
3597
3913
|
* Emitted when a user selects a data source on the embedded
|
|
3598
3914
|
* Natural Language Search interface.
|
|
3599
3915
|
*
|
|
3600
|
-
* @version SDK
|
|
3916
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3601
3917
|
*/
|
|
3602
3918
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3603
3919
|
/**
|
|
3604
3920
|
* Emitted when a user updates a connection on the **Data** page
|
|
3605
|
-
* @version SDK
|
|
3921
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3606
3922
|
*/
|
|
3607
3923
|
UpdateConnection = "updateConnection",
|
|
3608
3924
|
/**
|
|
3609
3925
|
* Emitted when a user updates a connection on the **Data** page
|
|
3610
|
-
* @version SDK
|
|
3926
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3611
3927
|
*/
|
|
3612
3928
|
CreateConnection = "createConnection",
|
|
3613
3929
|
/**
|
|
@@ -3617,7 +3933,7 @@ export declare enum EmbedEvent {
|
|
|
3617
3933
|
* @returns viewId: string
|
|
3618
3934
|
* @returns liveboardId: string
|
|
3619
3935
|
* @returns isPublic: boolean
|
|
3620
|
-
* @version SDK
|
|
3936
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3621
3937
|
*/
|
|
3622
3938
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3623
3939
|
/**
|
|
@@ -3626,7 +3942,7 @@ export declare enum EmbedEvent {
|
|
|
3626
3942
|
* @returns viewId: string
|
|
3627
3943
|
* @returns liveboardId: string
|
|
3628
3944
|
* @returns isPublic: boolean
|
|
3629
|
-
* @version SDK
|
|
3945
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3630
3946
|
*/
|
|
3631
3947
|
SavePersonalisedView = "savePersonalisedView",
|
|
3632
3948
|
/**
|
|
@@ -3635,19 +3951,19 @@ export declare enum EmbedEvent {
|
|
|
3635
3951
|
* @returns viewId: string
|
|
3636
3952
|
* @returns liveboardId: string
|
|
3637
3953
|
* @returns isPublic: boolean
|
|
3638
|
-
* @version SDK
|
|
3954
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3639
3955
|
*/
|
|
3640
3956
|
ResetLiveboard = "resetLiveboard",
|
|
3641
3957
|
/**
|
|
3642
3958
|
* Emitted when a PersonalisedView is deleted.
|
|
3643
3959
|
* @returns views: string[]
|
|
3644
3960
|
* @returns liveboardId: string
|
|
3645
|
-
* @version SDK
|
|
3961
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3646
3962
|
*/
|
|
3647
3963
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3648
3964
|
/**
|
|
3649
3965
|
* Emitted when a user creates a Worksheet.
|
|
3650
|
-
* @version SDK
|
|
3966
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3651
3967
|
*/
|
|
3652
3968
|
CreateWorksheet = "createWorksheet",
|
|
3653
3969
|
/**
|
|
@@ -3656,12 +3972,12 @@ export declare enum EmbedEvent {
|
|
|
3656
3972
|
* @returns viewId: string
|
|
3657
3973
|
* @returns liveboardId: string
|
|
3658
3974
|
* @returns isPublic: boolean
|
|
3659
|
-
* @version SDK
|
|
3975
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3660
3976
|
*/
|
|
3661
3977
|
AskSageInit = "AskSageInit",
|
|
3662
3978
|
/**
|
|
3663
3979
|
* Emitted when a Liveboard or visualization is renamed.
|
|
3664
|
-
* @version SDK
|
|
3980
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
3665
3981
|
*/
|
|
3666
3982
|
Rename = "rename",
|
|
3667
3983
|
/**
|
|
@@ -3679,14 +3995,12 @@ export declare enum EmbedEvent {
|
|
|
3679
3995
|
* - `payload`: The payload received from the embed related to the Data API call.
|
|
3680
3996
|
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
3681
3997
|
* will run or block the search operation, and if blocked, which error message to provide.
|
|
3682
|
-
*
|
|
3683
|
-
* `execute` - When `execute` returns `true`, the search is run.
|
|
3998
|
+
* - `execute` - When `execute` returns `true`, the search is run.
|
|
3684
3999
|
* When `execute` returns `false`, the search is not executed.
|
|
3685
|
-
*
|
|
3686
|
-
* `error` - Developers can customize the user-facing error message when `execute`
|
|
4000
|
+
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
3687
4001
|
* is `false` by using the `error` parameters in `responder`.
|
|
3688
|
-
* `errorText` - The error message text shown to the user.
|
|
3689
|
-
* @version SDK
|
|
4002
|
+
* - `errorText` - The error message text shown to the user.
|
|
4003
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
3690
4004
|
* @example
|
|
3691
4005
|
*
|
|
3692
4006
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -3701,7 +4015,7 @@ export declare enum EmbedEvent {
|
|
|
3701
4015
|
* },
|
|
3702
4016
|
* },
|
|
3703
4017
|
* });
|
|
3704
|
-
* })
|
|
4018
|
+
* })
|
|
3705
4019
|
* ```
|
|
3706
4020
|
* @example
|
|
3707
4021
|
*
|
|
@@ -3727,7 +4041,7 @@ export declare enum EmbedEvent {
|
|
|
3727
4041
|
* },
|
|
3728
4042
|
* },
|
|
3729
4043
|
* });
|
|
3730
|
-
* })
|
|
4044
|
+
* })
|
|
3731
4045
|
* ```
|
|
3732
4046
|
*/
|
|
3733
4047
|
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
@@ -3738,8 +4052,8 @@ export declare enum EmbedEvent {
|
|
|
3738
4052
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
3739
4053
|
* console.log('payload', payload);
|
|
3740
4054
|
* })
|
|
3741
|
-
|
|
3742
|
-
* @version SDK
|
|
4055
|
+
* ```
|
|
4056
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
3743
4057
|
*/
|
|
3744
4058
|
ParameterChanged = "parameterChanged",
|
|
3745
4059
|
/**
|
|
@@ -3794,24 +4108,24 @@ export declare enum EmbedEvent {
|
|
|
3794
4108
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
3795
4109
|
* console.log('payload', payload);
|
|
3796
4110
|
* })
|
|
3797
|
-
|
|
3798
|
-
* @version SDK
|
|
4111
|
+
* ```
|
|
4112
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
3799
4113
|
*/
|
|
3800
4114
|
CreateLiveboard = "createLiveboard",
|
|
3801
4115
|
/**
|
|
3802
4116
|
* Emitted when a user creates a Model.
|
|
3803
|
-
* @version SDK
|
|
4117
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
3804
4118
|
*/
|
|
3805
4119
|
CreateModel = "createModel",
|
|
3806
4120
|
/**
|
|
3807
4121
|
* @hidden
|
|
3808
4122
|
* Emitted when a user exits present mode.
|
|
3809
|
-
* @version SDK
|
|
4123
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3810
4124
|
*/
|
|
3811
4125
|
ExitPresentMode = "exitPresentMode",
|
|
3812
4126
|
/**
|
|
3813
4127
|
* Emitted when a user requests the full height lazy load data.
|
|
3814
|
-
* @version SDK
|
|
4128
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3815
4129
|
* @hidden
|
|
3816
4130
|
*/
|
|
3817
4131
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
@@ -3822,7 +4136,7 @@ export declare enum EmbedEvent {
|
|
|
3822
4136
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
3823
4137
|
* console.log('payload', payload);
|
|
3824
4138
|
* })
|
|
3825
|
-
|
|
4139
|
+
* ```
|
|
3826
4140
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3827
4141
|
*/
|
|
3828
4142
|
SpotterData = "SpotterData",
|
|
@@ -3833,7 +4147,7 @@ export declare enum EmbedEvent {
|
|
|
3833
4147
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
3834
4148
|
* console.log('payload', payload);
|
|
3835
4149
|
* })
|
|
3836
|
-
|
|
4150
|
+
* ```
|
|
3837
4151
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3838
4152
|
*/
|
|
3839
4153
|
PreviewSpotterData = "PreviewSpotterData",
|
|
@@ -3844,7 +4158,7 @@ export declare enum EmbedEvent {
|
|
|
3844
4158
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
3845
4159
|
* console.log('payload', payload);
|
|
3846
4160
|
* })
|
|
3847
|
-
|
|
4161
|
+
* ```
|
|
3848
4162
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3849
4163
|
*/
|
|
3850
4164
|
AddToCoaching = "addToCoaching",
|
|
@@ -3866,7 +4180,7 @@ export declare enum EmbedEvent {
|
|
|
3866
4180
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
3867
4181
|
* console.log('payload', payload);
|
|
3868
4182
|
* })
|
|
3869
|
-
|
|
4183
|
+
* ```
|
|
3870
4184
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3871
4185
|
*/
|
|
3872
4186
|
SpotterQueryTriggered = "SpotterQueryTriggered",
|
|
@@ -3877,7 +4191,7 @@ export declare enum EmbedEvent {
|
|
|
3877
4191
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
3878
4192
|
* console.log('payload', payload);
|
|
3879
4193
|
* })
|
|
3880
|
-
|
|
4194
|
+
* ```
|
|
3881
4195
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3882
4196
|
*/
|
|
3883
4197
|
LastPromptEdited = "LastPromptEdited",
|
|
@@ -3888,18 +4202,18 @@ export declare enum EmbedEvent {
|
|
|
3888
4202
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
3889
4203
|
* console.log('payload', payload);
|
|
3890
4204
|
* })
|
|
3891
|
-
|
|
4205
|
+
* ```
|
|
3892
4206
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3893
4207
|
*/
|
|
3894
4208
|
LastPromptDeleted = "LastPromptDeleted",
|
|
3895
4209
|
/**
|
|
3896
|
-
* Emitted when the
|
|
4210
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
3897
4211
|
* @example
|
|
3898
4212
|
* ```js
|
|
3899
4213
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
3900
4214
|
* console.log('payload', payload);
|
|
3901
4215
|
* })
|
|
3902
|
-
|
|
4216
|
+
* ```
|
|
3903
4217
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3904
4218
|
*/
|
|
3905
4219
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
@@ -3910,7 +4224,7 @@ export declare enum EmbedEvent {
|
|
|
3910
4224
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
3911
4225
|
* console.log('payload', payload);
|
|
3912
4226
|
* })
|
|
3913
|
-
|
|
4227
|
+
* ```
|
|
3914
4228
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
3915
4229
|
*/
|
|
3916
4230
|
SpotterInit = "spotterInit",
|
|
@@ -3921,7 +4235,7 @@ export declare enum EmbedEvent {
|
|
|
3921
4235
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
3922
4236
|
* console.log('payload', payload);
|
|
3923
4237
|
* })
|
|
3924
|
-
|
|
4238
|
+
* ```
|
|
3925
4239
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
3926
4240
|
*/
|
|
3927
4241
|
SpotterLoadComplete = "spotterLoadComplete",
|
|
@@ -4275,7 +4589,7 @@ export declare enum HostEvent {
|
|
|
4275
4589
|
* ```js
|
|
4276
4590
|
* appEmbed.navigateToPage(-1)
|
|
4277
4591
|
* ```
|
|
4278
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
4592
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
4279
4593
|
*/
|
|
4280
4594
|
Navigate = "Navigate",
|
|
4281
4595
|
/**
|
|
@@ -4408,9 +4722,9 @@ export declare enum HostEvent {
|
|
|
4408
4722
|
* Trigger the **Show Liveboard details** action
|
|
4409
4723
|
* on an embedded Liveboard.
|
|
4410
4724
|
* @example
|
|
4411
|
-
|
|
4725
|
+
* ```js
|
|
4412
4726
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
4413
|
-
|
|
4727
|
+
* ```
|
|
4414
4728
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4415
4729
|
*/
|
|
4416
4730
|
LiveboardInfo = "pinboardInfo",
|
|
@@ -4538,7 +4852,7 @@ export declare enum HostEvent {
|
|
|
4538
4852
|
* appEmbed.trigger(HostEvent.Remove)
|
|
4539
4853
|
* ```
|
|
4540
4854
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4541
|
-
*
|
|
4855
|
+
* @example
|
|
4542
4856
|
* ```js
|
|
4543
4857
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
4544
4858
|
* ```
|
|
@@ -4629,7 +4943,7 @@ export declare enum HostEvent {
|
|
|
4629
4943
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4630
4944
|
* ```
|
|
4631
4945
|
* ```js
|
|
4632
|
-
* vizEmbed.trigger(
|
|
4946
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
4633
4947
|
* ```
|
|
4634
4948
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4635
4949
|
*/
|
|
@@ -4646,7 +4960,7 @@ export declare enum HostEvent {
|
|
|
4646
4960
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4647
4961
|
* ```
|
|
4648
4962
|
* ```js
|
|
4649
|
-
* vizEmbed.trigger(
|
|
4963
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
4650
4964
|
* ```
|
|
4651
4965
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4652
4966
|
*/
|
|
@@ -4661,23 +4975,22 @@ export declare enum HostEvent {
|
|
|
4661
4975
|
* );
|
|
4662
4976
|
* })
|
|
4663
4977
|
* ```
|
|
4664
|
-
*
|
|
4978
|
+
* @example
|
|
4665
4979
|
* ```js
|
|
4666
|
-
|
|
4667
|
-
|
|
4668
|
-
|
|
4669
|
-
|
|
4670
|
-
|
|
4671
|
-
|
|
4672
|
-
|
|
4673
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
4980
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
4981
|
+
* let latestSpotterVizId = '';
|
|
4982
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
4983
|
+
* latestSpotterVizId = payload.data.id;
|
|
4984
|
+
* });
|
|
4985
|
+
*
|
|
4986
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
4674
4987
|
* vizId: latestSpotterVizId
|
|
4675
4988
|
* }).then((tml) => {
|
|
4676
4989
|
* console.log(
|
|
4677
4990
|
* tml.answer.search_query // TML representation of the search query
|
|
4678
4991
|
* );
|
|
4679
4992
|
* })
|
|
4680
|
-
|
|
4993
|
+
* ```
|
|
4681
4994
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4682
4995
|
* @important
|
|
4683
4996
|
*/
|
|
@@ -4741,6 +5054,11 @@ export declare enum HostEvent {
|
|
|
4741
5054
|
/**
|
|
4742
5055
|
* Trigger the **Download** action on charts in
|
|
4743
5056
|
* the embedded view.
|
|
5057
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
5058
|
+
*
|
|
5059
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
5060
|
+
*
|
|
5061
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
4744
5062
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
4745
5063
|
* @example
|
|
4746
5064
|
* ```js
|
|
@@ -4759,9 +5077,6 @@ export declare enum HostEvent {
|
|
|
4759
5077
|
*
|
|
4760
5078
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
4761
5079
|
* ```
|
|
4762
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
4763
|
-
* Use {@link DownloadAsPng}
|
|
4764
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
4765
5080
|
*/
|
|
4766
5081
|
Download = "downloadAsPng",
|
|
4767
5082
|
/**
|
|
@@ -5199,8 +5514,8 @@ export declare enum HostEvent {
|
|
|
5199
5514
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
5200
5515
|
* console.log('parameters', parameter);
|
|
5201
5516
|
* });
|
|
5202
|
-
|
|
5203
|
-
|
|
5517
|
+
* ```
|
|
5518
|
+
* ```js
|
|
5204
5519
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
5205
5520
|
* let latestSpotterVizId = '';
|
|
5206
5521
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -5208,7 +5523,7 @@ export declare enum HostEvent {
|
|
|
5208
5523
|
* });
|
|
5209
5524
|
*
|
|
5210
5525
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
5211
|
-
|
|
5526
|
+
* ```
|
|
5212
5527
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
5213
5528
|
*/
|
|
5214
5529
|
GetParameters = "GetParameters",
|
|
@@ -5225,7 +5540,7 @@ export declare enum HostEvent {
|
|
|
5225
5540
|
* Notify when info call is completed successfully
|
|
5226
5541
|
* ```js
|
|
5227
5542
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
5228
|
-
|
|
5543
|
+
* ```
|
|
5229
5544
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5230
5545
|
*/
|
|
5231
5546
|
InfoSuccess = "InfoSuccess",
|
|
@@ -5328,7 +5643,7 @@ export declare enum HostEvent {
|
|
|
5328
5643
|
* ```js
|
|
5329
5644
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
5330
5645
|
*
|
|
5331
|
-
|
|
5646
|
+
* ```
|
|
5332
5647
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5333
5648
|
*/
|
|
5334
5649
|
AddToCoaching = "addToCoaching",
|
|
@@ -5370,7 +5685,7 @@ export declare enum HostEvent {
|
|
|
5370
5685
|
* });
|
|
5371
5686
|
*
|
|
5372
5687
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
5373
|
-
|
|
5688
|
+
* ```
|
|
5374
5689
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5375
5690
|
*/
|
|
5376
5691
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
@@ -5380,7 +5695,7 @@ export declare enum HostEvent {
|
|
|
5380
5695
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
5381
5696
|
* ```js
|
|
5382
5697
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
5383
|
-
|
|
5698
|
+
* ```
|
|
5384
5699
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5385
5700
|
*/
|
|
5386
5701
|
ExitPresentMode = "exitPresentMode",
|
|
@@ -5613,14 +5928,14 @@ export declare enum Action {
|
|
|
5613
5928
|
* ```js
|
|
5614
5929
|
* disabledActions: [Action.CollapseDataPanel]
|
|
5615
5930
|
* ```
|
|
5616
|
-
* @version
|
|
5931
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5617
5932
|
*/
|
|
5618
5933
|
CollapseDataSources = "collapseDataSources",
|
|
5619
5934
|
/**
|
|
5620
5935
|
* The **Collapse data panel** icon on the Search page.
|
|
5621
5936
|
* Collapses the data panel view.
|
|
5622
5937
|
*
|
|
5623
|
-
* @version
|
|
5938
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5624
5939
|
*
|
|
5625
5940
|
* @example
|
|
5626
5941
|
* ```js
|
|
@@ -6067,13 +6382,12 @@ export declare enum Action {
|
|
|
6067
6382
|
*/
|
|
6068
6383
|
CreateMonitor = "createMonitor",
|
|
6069
6384
|
/**
|
|
6070
|
-
* @
|
|
6071
|
-
*
|
|
6385
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6386
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
6072
6387
|
* @example
|
|
6073
6388
|
* ```js
|
|
6074
6389
|
* disabledActions: [Action.ReportError]
|
|
6075
6390
|
* ```
|
|
6076
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6077
6391
|
*/
|
|
6078
6392
|
ReportError = "reportError",
|
|
6079
6393
|
/**
|
|
@@ -6083,7 +6397,7 @@ export declare enum Action {
|
|
|
6083
6397
|
* ```js
|
|
6084
6398
|
* disabledActions: [Action.SyncToSheets]
|
|
6085
6399
|
* ```
|
|
6086
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6400
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6087
6401
|
*/
|
|
6088
6402
|
SyncToSheets = "sync-to-sheets",
|
|
6089
6403
|
/**
|
|
@@ -6094,7 +6408,7 @@ export declare enum Action {
|
|
|
6094
6408
|
* ```js
|
|
6095
6409
|
* disabledActions: [Action.SyncToOtherApps]
|
|
6096
6410
|
* ```
|
|
6097
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6411
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6098
6412
|
*/
|
|
6099
6413
|
SyncToOtherApps = "sync-to-other-apps",
|
|
6100
6414
|
/**
|
|
@@ -6104,7 +6418,7 @@ export declare enum Action {
|
|
|
6104
6418
|
* ```js
|
|
6105
6419
|
* disabledActions: [Action.ManagePipelines]
|
|
6106
6420
|
* ```
|
|
6107
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6421
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6108
6422
|
*/
|
|
6109
6423
|
ManagePipelines = "manage-pipeline",
|
|
6110
6424
|
/**
|
|
@@ -6416,7 +6730,7 @@ export declare enum Action {
|
|
|
6416
6730
|
* ```js
|
|
6417
6731
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
6418
6732
|
* ```
|
|
6419
|
-
* @version SDK
|
|
6733
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6420
6734
|
*/
|
|
6421
6735
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
6422
6736
|
/**
|
|
@@ -6426,7 +6740,7 @@ export declare enum Action {
|
|
|
6426
6740
|
* ```js
|
|
6427
6741
|
* disabledActions: [Action.LiveboardUsers]
|
|
6428
6742
|
* ```
|
|
6429
|
-
* @version SDK
|
|
6743
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6430
6744
|
*/
|
|
6431
6745
|
LiveboardUsers = "liveboardUsers",
|
|
6432
6746
|
/**
|
|
@@ -6444,7 +6758,7 @@ export declare enum Action {
|
|
|
6444
6758
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
6445
6759
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
6446
6760
|
* ```
|
|
6447
|
-
* @version SDK
|
|
6761
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
6448
6762
|
*/
|
|
6449
6763
|
TML = "tml",
|
|
6450
6764
|
/**
|
|
@@ -6490,7 +6804,7 @@ export declare enum Action {
|
|
|
6490
6804
|
* ```js
|
|
6491
6805
|
* disabledActions: [Action.AddToWatchlist]
|
|
6492
6806
|
* ```
|
|
6493
|
-
* @version SDK
|
|
6807
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6494
6808
|
*/
|
|
6495
6809
|
AddToWatchlist = "addToWatchlist",
|
|
6496
6810
|
/**
|
|
@@ -6500,7 +6814,7 @@ export declare enum Action {
|
|
|
6500
6814
|
* ```js
|
|
6501
6815
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6502
6816
|
* ```
|
|
6503
|
-
* @version SDK
|
|
6817
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6504
6818
|
*/
|
|
6505
6819
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6506
6820
|
/**
|
|
@@ -6511,7 +6825,7 @@ export declare enum Action {
|
|
|
6511
6825
|
* ```js
|
|
6512
6826
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6513
6827
|
* ```
|
|
6514
|
-
* @version SDK
|
|
6828
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6515
6829
|
*/
|
|
6516
6830
|
OrganiseFavourites = "organiseFavourites",
|
|
6517
6831
|
/**
|
|
@@ -6572,7 +6886,7 @@ export declare enum Action {
|
|
|
6572
6886
|
* ```js
|
|
6573
6887
|
* disabledActions: [Action.ManageTags]
|
|
6574
6888
|
* ```
|
|
6575
|
-
* @version SDK
|
|
6889
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6576
6890
|
*/
|
|
6577
6891
|
ManageTags = "manageTags",
|
|
6578
6892
|
/**
|
|
@@ -7027,14 +7341,73 @@ export interface CustomAction {
|
|
|
7027
7341
|
* positions in the application.
|
|
7028
7342
|
*/
|
|
7029
7343
|
export declare enum CustomActionsPosition {
|
|
7344
|
+
/**
|
|
7345
|
+
* Shows the action as a primary button
|
|
7346
|
+
* in the toolbar area of the embed.
|
|
7347
|
+
*/
|
|
7030
7348
|
PRIMARY = "PRIMARY",
|
|
7349
|
+
/**
|
|
7350
|
+
* Shows the action inside the "More" menu
|
|
7351
|
+
* (three-dot overflow menu).
|
|
7352
|
+
*/
|
|
7031
7353
|
MENU = "MENU",
|
|
7354
|
+
/**
|
|
7355
|
+
* Shows the action in the right-click
|
|
7356
|
+
* context menu. Only supported for
|
|
7357
|
+
* {@link CustomActionTarget.VIZ},
|
|
7358
|
+
* {@link CustomActionTarget.ANSWER}, and
|
|
7359
|
+
* {@link CustomActionTarget.SPOTTER} targets.
|
|
7360
|
+
*/
|
|
7032
7361
|
CONTEXTMENU = "CONTEXTMENU"
|
|
7033
7362
|
}
|
|
7034
7363
|
declare enum CustomActionTarget {
|
|
7364
|
+
/**
|
|
7365
|
+
* Action applies at the Liveboard level.
|
|
7366
|
+
* Supported positions:
|
|
7367
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
7368
|
+
* {@link CustomActionsPosition.MENU}.
|
|
7369
|
+
* Can be scoped with
|
|
7370
|
+
* `metadataIds.liveboardIds`,
|
|
7371
|
+
* `orgIds`, and `groupIds`.
|
|
7372
|
+
*/
|
|
7035
7373
|
LIVEBOARD = "LIVEBOARD",
|
|
7374
|
+
/**
|
|
7375
|
+
* Action applies to individual
|
|
7376
|
+
* visualizations (charts/tables).
|
|
7377
|
+
* Supported positions:
|
|
7378
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
7379
|
+
* {@link CustomActionsPosition.MENU},
|
|
7380
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
7381
|
+
* Can be scoped with `metadataIds`
|
|
7382
|
+
* (answerIds, liveboardIds, vizIds),
|
|
7383
|
+
* `dataModelIds` (modelIds,
|
|
7384
|
+
* modelColumnNames), `orgIds`,
|
|
7385
|
+
* and `groupIds`.
|
|
7386
|
+
*/
|
|
7036
7387
|
VIZ = "VIZ",
|
|
7388
|
+
/**
|
|
7389
|
+
* Action applies to saved or unsaved
|
|
7390
|
+
* Answers. Supported positions:
|
|
7391
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
7392
|
+
* {@link CustomActionsPosition.MENU},
|
|
7393
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
7394
|
+
* Can be scoped with
|
|
7395
|
+
* `metadataIds.answerIds`,
|
|
7396
|
+
* `dataModelIds` (modelIds,
|
|
7397
|
+
* modelColumnNames), `orgIds`,
|
|
7398
|
+
* and `groupIds`.
|
|
7399
|
+
*/
|
|
7037
7400
|
ANSWER = "ANSWER",
|
|
7401
|
+
/**
|
|
7402
|
+
* Action applies to Spotter
|
|
7403
|
+
* (AI-powered search).
|
|
7404
|
+
* Supported positions:
|
|
7405
|
+
* {@link CustomActionsPosition.MENU},
|
|
7406
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
7407
|
+
* Can be scoped with
|
|
7408
|
+
* `dataModelIds.modelIds`,
|
|
7409
|
+
* `orgIds`, and `groupIds`.
|
|
7410
|
+
*/
|
|
7038
7411
|
SPOTTER = "SPOTTER"
|
|
7039
7412
|
}
|
|
7040
7413
|
/**
|
|
@@ -7265,14 +7638,14 @@ export type ApiInterceptFlags = {
|
|
|
7265
7638
|
/**
|
|
7266
7639
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
7267
7640
|
*
|
|
7268
|
-
* Can be used for
|
|
7641
|
+
* Can be used for Search and App Embed from SDK 1.29.0
|
|
7269
7642
|
*
|
|
7270
|
-
* @version SDK
|
|
7643
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7271
7644
|
*/
|
|
7272
7645
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
7273
7646
|
/**
|
|
7274
7647
|
* This allows to intercept the urls passed, once intercepted the api will only
|
|
7275
|
-
* run based on the
|
|
7648
|
+
* run based on the response from the responder of ApiIntercept event.
|
|
7276
7649
|
*
|
|
7277
7650
|
* @example
|
|
7278
7651
|
* ```js
|
|
@@ -7283,7 +7656,7 @@ export type ApiInterceptFlags = {
|
|
|
7283
7656
|
* })
|
|
7284
7657
|
* ```
|
|
7285
7658
|
*
|
|
7286
|
-
* @version SDK
|
|
7659
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7287
7660
|
*/
|
|
7288
7661
|
interceptUrls?: (string | InterceptedApiType)[];
|
|
7289
7662
|
/**
|
|
@@ -7300,7 +7673,7 @@ export type ApiInterceptFlags = {
|
|
|
7300
7673
|
* })
|
|
7301
7674
|
* ```
|
|
7302
7675
|
*
|
|
7303
|
-
* @version SDK
|
|
7676
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7304
7677
|
*/
|
|
7305
7678
|
interceptTimeout?: number;
|
|
7306
7679
|
};
|
|
@@ -7430,20 +7803,45 @@ declare enum AuthFailureType {
|
|
|
7430
7803
|
}
|
|
7431
7804
|
declare enum AuthStatus {
|
|
7432
7805
|
/**
|
|
7433
|
-
* Emits when the SDK fails to authenticate
|
|
7806
|
+
* Emits when the SDK fails to authenticate.
|
|
7434
7807
|
*/
|
|
7435
7808
|
FAILURE = "FAILURE",
|
|
7436
7809
|
/**
|
|
7437
|
-
* Emits when the SDK
|
|
7810
|
+
* Emits when the SDK authentication step completes
|
|
7811
|
+
* successfully (e.g., token exchange, cookie set).
|
|
7812
|
+
* This fires before any iframe is rendered. Use
|
|
7813
|
+
* this to know that auth passed and it is safe to
|
|
7814
|
+
* proceed with rendering. The callback receives no
|
|
7815
|
+
* arguments.
|
|
7816
|
+
* @example
|
|
7817
|
+
* ```js
|
|
7818
|
+
* const authEE = init({ ... });
|
|
7819
|
+
* authEE.on(AuthStatus.SDK_SUCCESS, () => {
|
|
7820
|
+
* // Auth done, iframe not loaded yet
|
|
7821
|
+
* });
|
|
7822
|
+
* ```
|
|
7438
7823
|
*/
|
|
7439
7824
|
SDK_SUCCESS = "SDK_SUCCESS",
|
|
7440
7825
|
/**
|
|
7441
7826
|
* @hidden
|
|
7442
|
-
* Emits when iframe is loaded and session
|
|
7827
|
+
* Emits when iframe is loaded and session
|
|
7828
|
+
* information is available.
|
|
7443
7829
|
*/
|
|
7444
7830
|
SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS",
|
|
7445
7831
|
/**
|
|
7446
|
-
* Emits when the app
|
|
7832
|
+
* Emits when the ThoughtSpot app inside the
|
|
7833
|
+
* embedded iframe confirms its session is active.
|
|
7834
|
+
* This fires after the iframe loads and sends back an `AuthInit` event.
|
|
7835
|
+
* @param sessionInfo Information about the user session, with details like `userGUID`.
|
|
7836
|
+
* @see EmbedEvent.AuthInit
|
|
7837
|
+
* @example
|
|
7838
|
+
* ```js
|
|
7839
|
+
* const authEE = init({ ... });
|
|
7840
|
+
* authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
|
|
7841
|
+
* // App is loaded and authenticated
|
|
7842
|
+
* console.log(sessionInfo.userGUID);
|
|
7843
|
+
* });
|
|
7844
|
+
* ```
|
|
7447
7845
|
*/
|
|
7448
7846
|
SUCCESS = "SUCCESS",
|
|
7449
7847
|
/**
|
|
@@ -7675,9 +8073,9 @@ declare class TsEmbed {
|
|
|
7675
8073
|
*/
|
|
7676
8074
|
private isPreRendered;
|
|
7677
8075
|
/**
|
|
7678
|
-
* Should we encode URL Query Params using base64 encoding which
|
|
8076
|
+
* Should we encode URL Query Params using base64 encoding which ThoughtSpot
|
|
7679
8077
|
* will generate for embedding. This provides additional security to
|
|
7680
|
-
*
|
|
8078
|
+
* ThoughtSpot clusters against Cross site scripting attacks.
|
|
7681
8079
|
* @default false
|
|
7682
8080
|
*/
|
|
7683
8081
|
private shouldEncodeUrlQueryParams;
|
|
@@ -8043,7 +8441,7 @@ declare class TsEmbed {
|
|
|
8043
8441
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
8044
8442
|
* session.
|
|
8045
8443
|
* @param vizId [Optional] to get for a specific viz in case of a Liveboard.
|
|
8046
|
-
* @version SDK: 1.25.0
|
|
8444
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
|
|
8047
8445
|
*/
|
|
8048
8446
|
getAnswerService(vizId?: string): Promise<AnswerService>;
|
|
8049
8447
|
/**
|
|
@@ -8130,7 +8528,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8130
8528
|
* but can be expanded manually.
|
|
8131
8529
|
*
|
|
8132
8530
|
* Supported embed types: `SearchEmbed`
|
|
8133
|
-
* @version
|
|
8531
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
8134
8532
|
* @example
|
|
8135
8533
|
* ```js
|
|
8136
8534
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8145,7 +8543,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8145
8543
|
* but can be expanded manually.
|
|
8146
8544
|
*
|
|
8147
8545
|
* Supported embed types: `SearchEmbed`
|
|
8148
|
-
* @version
|
|
8546
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
8149
8547
|
* @example
|
|
8150
8548
|
* ```js
|
|
8151
8549
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8159,7 +8557,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8159
8557
|
* Show or hide the data sources panel.
|
|
8160
8558
|
*
|
|
8161
8559
|
* Supported embed types: `SearchEmbed`
|
|
8162
|
-
* @version
|
|
8560
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
8163
8561
|
* @example
|
|
8164
8562
|
* ```js
|
|
8165
8563
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8175,7 +8573,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8175
8573
|
* using raw answer data.
|
|
8176
8574
|
*
|
|
8177
8575
|
* Supported embed types: `SearchEmbed`
|
|
8178
|
-
* @version
|
|
8576
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
8179
8577
|
* @example
|
|
8180
8578
|
* ```js
|
|
8181
8579
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8204,7 +8602,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8204
8602
|
* format for presenting search data.
|
|
8205
8603
|
*
|
|
8206
8604
|
* Supported embed types: `SearchEmbed`
|
|
8207
|
-
* @version
|
|
8605
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
8208
8606
|
* @example
|
|
8209
8607
|
* ```js
|
|
8210
8608
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8217,6 +8615,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8217
8615
|
/**
|
|
8218
8616
|
* The array of data source GUIDs to set on load.
|
|
8219
8617
|
* Only a single data source is supported currently.
|
|
8618
|
+
* Use {@link dataSource} instead.
|
|
8220
8619
|
* @deprecated Use `dataSource` instead.
|
|
8221
8620
|
*
|
|
8222
8621
|
* Supported embed types: `SearchEmbed`
|
|
@@ -8230,10 +8629,10 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8230
8629
|
*/
|
|
8231
8630
|
dataSources?: string[];
|
|
8232
8631
|
/**
|
|
8233
|
-
* The
|
|
8632
|
+
* The data source GUID to set on load.
|
|
8234
8633
|
*
|
|
8235
8634
|
* Supported embed types: `SearchEmbed`
|
|
8236
|
-
* @version
|
|
8635
|
+
* @version SDK: 1.19.0
|
|
8237
8636
|
* @example
|
|
8238
8637
|
* ```js
|
|
8239
8638
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8245,9 +8644,9 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8245
8644
|
dataSource?: string;
|
|
8246
8645
|
/**
|
|
8247
8646
|
* The initial search query to load the answer with.
|
|
8647
|
+
* Use {@link searchOptions} instead.
|
|
8248
8648
|
* @deprecated
|
|
8249
8649
|
*
|
|
8250
|
-
* Use {@link searchOptions} instead.
|
|
8251
8650
|
*/
|
|
8252
8651
|
searchQuery?: string;
|
|
8253
8652
|
/**
|
|
@@ -8276,7 +8675,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8276
8675
|
* If set to true, the search token string is not appended to the URL.
|
|
8277
8676
|
*
|
|
8278
8677
|
* Supported embed types: `SearchEmbed`
|
|
8279
|
-
* @version
|
|
8678
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
8280
8679
|
* @example
|
|
8281
8680
|
* ```js
|
|
8282
8681
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8293,7 +8692,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8293
8692
|
* The GUID of a saved answer to load initially.
|
|
8294
8693
|
*
|
|
8295
8694
|
* Supported embed types: `SearchEmbed`
|
|
8296
|
-
* @version
|
|
8695
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
8297
8696
|
* @example
|
|
8298
8697
|
* ```js
|
|
8299
8698
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8322,14 +8721,14 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8322
8721
|
* Flag to set if last selected dataSource should be used
|
|
8323
8722
|
*
|
|
8324
8723
|
* Supported embed types: `SearchEmbed`
|
|
8325
|
-
* @version
|
|
8724
|
+
* @version SDK: 1.24.0
|
|
8326
8725
|
*/
|
|
8327
8726
|
useLastSelectedSources?: boolean;
|
|
8328
8727
|
/**
|
|
8329
8728
|
* To set the initial state of the search bar in case of saved-answers.
|
|
8330
|
-
* @default false
|
|
8331
8729
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
8332
8730
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
8731
|
+
* @default false
|
|
8333
8732
|
*/
|
|
8334
8733
|
collapseSearchBarInitially?: boolean;
|
|
8335
8734
|
/**
|
|
@@ -8413,8 +8812,8 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8413
8812
|
* Only a single data source is supported currently.
|
|
8414
8813
|
*
|
|
8415
8814
|
* Supported embed types: `SearchBarEmbed`
|
|
8815
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
8416
8816
|
* @deprecated Use `dataSource` instead
|
|
8417
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
8418
8817
|
* @example
|
|
8419
8818
|
* ```js
|
|
8420
8819
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8428,7 +8827,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8428
8827
|
* Pass the ID of the source to be selected.
|
|
8429
8828
|
*
|
|
8430
8829
|
* Supported embed types: `SearchBarEmbed`
|
|
8431
|
-
* @version
|
|
8830
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
8432
8831
|
* @example
|
|
8433
8832
|
* ```js
|
|
8434
8833
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8442,7 +8841,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8442
8841
|
* Boolean to define if the last selected data source should be used
|
|
8443
8842
|
*
|
|
8444
8843
|
* Supported embed types: `SearchBarEmbed`
|
|
8445
|
-
* @version
|
|
8844
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.0.sw
|
|
8446
8845
|
* @example
|
|
8447
8846
|
* ```js
|
|
8448
8847
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8464,7 +8863,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8464
8863
|
* the token string in the search bar.
|
|
8465
8864
|
*
|
|
8466
8865
|
* Supported embed types: `SearchBarEmbed`
|
|
8467
|
-
* @version
|
|
8866
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
8468
8867
|
* @example
|
|
8469
8868
|
* ```js
|
|
8470
8869
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8482,10 +8881,10 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8482
8881
|
* If set to true, the search token string is not appended to the URL.
|
|
8483
8882
|
*
|
|
8484
8883
|
* Supported embed types: `SearchBarEmbed`
|
|
8485
|
-
* @version
|
|
8884
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
8486
8885
|
* @example
|
|
8487
8886
|
* ```js
|
|
8488
|
-
* const embed = new
|
|
8887
|
+
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
8489
8888
|
* searchOptions: {
|
|
8490
8889
|
* searchTokenString: '[quantity purchased] [region]',
|
|
8491
8890
|
* executeSearch: true,
|
|
@@ -8538,7 +8937,7 @@ interface SearchOptions$1 {
|
|
|
8538
8937
|
/**
|
|
8539
8938
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
8540
8939
|
* GPT and LLM.
|
|
8541
|
-
* @version
|
|
8940
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
8542
8941
|
*
|
|
8543
8942
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
8544
8943
|
* @group Embed components
|
|
@@ -8592,14 +8991,14 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
8592
8991
|
hideAutocompleteSuggestions?: boolean;
|
|
8593
8992
|
/**
|
|
8594
8993
|
* Show or hide autocomplete suggestions for the search query string.
|
|
8994
|
+
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
8595
8995
|
* @deprecated
|
|
8596
8996
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
8597
|
-
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
8598
8997
|
*/
|
|
8599
8998
|
showObjectSuggestions?: boolean;
|
|
8600
8999
|
/**
|
|
8601
9000
|
* Show or hide sample questions.
|
|
8602
|
-
* The sample questions are autogenerated based on the data
|
|
9001
|
+
* The sample questions are autogenerated based on the data model
|
|
8603
9002
|
* selected for the search operation.
|
|
8604
9003
|
*
|
|
8605
9004
|
* Supported embed types: `SageEmbed`
|
|
@@ -8629,6 +9028,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
8629
9028
|
* the token string in the search bar.
|
|
8630
9029
|
*
|
|
8631
9030
|
* Supported embed types: `SageEmbed`
|
|
9031
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
8632
9032
|
* @example
|
|
8633
9033
|
* ```js
|
|
8634
9034
|
* searchOptions: {
|
|
@@ -8636,7 +9036,6 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
8636
9036
|
* executeSearch: true,
|
|
8637
9037
|
* }
|
|
8638
9038
|
* ```
|
|
8639
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
8640
9039
|
*/
|
|
8641
9040
|
searchOptions?: SearchOptions$1;
|
|
8642
9041
|
}
|
|
@@ -8676,81 +9075,81 @@ interface SearchOptions$2 {
|
|
|
8676
9075
|
* Configuration for the Spotter sidebar.
|
|
8677
9076
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
8678
9077
|
* @group Embed components
|
|
8679
|
-
* @version SDK: 1.
|
|
9078
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8680
9079
|
*/
|
|
8681
9080
|
export interface SpotterSidebarViewConfig {
|
|
8682
9081
|
/**
|
|
8683
9082
|
* Controls the visibility of the past conversations sidebar.
|
|
8684
9083
|
* @default false
|
|
8685
|
-
* @version SDK: 1.
|
|
9084
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8686
9085
|
*/
|
|
8687
9086
|
enablePastConversationsSidebar?: boolean;
|
|
8688
9087
|
/**
|
|
8689
9088
|
* Custom title text for the sidebar header.
|
|
8690
9089
|
* Defaults to translated "Spotter" text.
|
|
8691
|
-
* @version SDK: 1.
|
|
9090
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8692
9091
|
*/
|
|
8693
9092
|
spotterSidebarTitle?: string;
|
|
8694
9093
|
/**
|
|
8695
9094
|
* Boolean to set the default expanded state of the sidebar.
|
|
8696
9095
|
* @default false
|
|
8697
|
-
* @version SDK: 1.
|
|
9096
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8698
9097
|
*/
|
|
8699
9098
|
spotterSidebarDefaultExpanded?: boolean;
|
|
8700
9099
|
/**
|
|
8701
9100
|
* Custom label text for the rename action in the conversation edit menu.
|
|
8702
9101
|
* Defaults to translated "Rename" text.
|
|
8703
|
-
* @version SDK: 1.
|
|
9102
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8704
9103
|
*/
|
|
8705
9104
|
spotterChatRenameLabel?: string;
|
|
8706
9105
|
/**
|
|
8707
9106
|
* Custom label text for the delete action in the conversation edit menu.
|
|
8708
9107
|
* Defaults to translated "DELETE" text.
|
|
8709
|
-
* @version SDK: 1.
|
|
9108
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8710
9109
|
*/
|
|
8711
9110
|
spotterChatDeleteLabel?: string;
|
|
8712
9111
|
/**
|
|
8713
9112
|
* Custom title text for the delete conversation confirmation modal.
|
|
8714
9113
|
* Defaults to translated "Delete chat" text.
|
|
8715
|
-
* @version SDK: 1.
|
|
9114
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8716
9115
|
*/
|
|
8717
9116
|
spotterDeleteConversationModalTitle?: string;
|
|
8718
9117
|
/**
|
|
8719
9118
|
* Custom message text for the past conversation banner alert.
|
|
8720
9119
|
* Defaults to translated alert message.
|
|
8721
|
-
* @version SDK: 1.
|
|
9120
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8722
9121
|
*/
|
|
8723
9122
|
spotterPastConversationAlertMessage?: string;
|
|
8724
9123
|
/**
|
|
8725
9124
|
* Custom URL for the documentation/best practices link.
|
|
8726
9125
|
* Defaults to ThoughtSpot docs URL based on release version.
|
|
8727
9126
|
* Note: URL must include the protocol (e.g., `https://www.example.com`).
|
|
8728
|
-
* @version SDK: 1.
|
|
9127
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8729
9128
|
*/
|
|
8730
9129
|
spotterDocumentationUrl?: string;
|
|
8731
9130
|
/**
|
|
8732
9131
|
* Custom label text for the best practices button in the footer.
|
|
8733
9132
|
* Defaults to translated "Best Practices" text.
|
|
8734
|
-
* @version SDK: 1.
|
|
9133
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8735
9134
|
*/
|
|
8736
9135
|
spotterBestPracticesLabel?: string;
|
|
8737
9136
|
/**
|
|
8738
9137
|
* Number of conversations to fetch per batch when loading conversation history.
|
|
8739
9138
|
* @default 30
|
|
8740
|
-
* @version SDK: 1.
|
|
9139
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8741
9140
|
*/
|
|
8742
9141
|
spotterConversationsBatchSize?: number;
|
|
8743
9142
|
/**
|
|
8744
9143
|
* Custom title text for the "New Chat" button in the sidebar.
|
|
8745
9144
|
* Defaults to translated "New Chat" text.
|
|
8746
|
-
* @version SDK: 1.
|
|
9145
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8747
9146
|
*/
|
|
8748
9147
|
spotterNewChatButtonTitle?: string;
|
|
8749
9148
|
}
|
|
8750
9149
|
/**
|
|
8751
9150
|
* Configuration for customizing Spotter chat UI branding.
|
|
8752
|
-
* @group Embed components
|
|
8753
9151
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9152
|
+
* @group Embed components
|
|
8754
9153
|
*/
|
|
8755
9154
|
export interface SpotterChatViewConfig {
|
|
8756
9155
|
/**
|
|
@@ -8789,6 +9188,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8789
9188
|
* but still display the selected data source.
|
|
8790
9189
|
*
|
|
8791
9190
|
* Supported embed types: `SpotterEmbed`
|
|
9191
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8792
9192
|
* @example
|
|
8793
9193
|
* ```js
|
|
8794
9194
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8796,13 +9196,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8796
9196
|
* disableSourceSelection : true,
|
|
8797
9197
|
* })
|
|
8798
9198
|
* ```
|
|
8799
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8800
9199
|
*/
|
|
8801
9200
|
disableSourceSelection?: boolean;
|
|
8802
9201
|
/**
|
|
8803
9202
|
* hideSourceSelection : Hide data source selection
|
|
8804
9203
|
*
|
|
8805
9204
|
* Supported embed types: `SpotterEmbed`
|
|
9205
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8806
9206
|
* @example
|
|
8807
9207
|
* ```js
|
|
8808
9208
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8810,15 +9210,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8810
9210
|
* hideSourceSelection : true,
|
|
8811
9211
|
* })
|
|
8812
9212
|
* ```
|
|
8813
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8814
9213
|
*/
|
|
8815
9214
|
hideSourceSelection?: boolean;
|
|
8816
9215
|
/**
|
|
8817
9216
|
* Flag to control Data panel experience
|
|
8818
9217
|
*
|
|
8819
9218
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
9219
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8820
9220
|
* @default true
|
|
8821
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8822
9221
|
* @example
|
|
8823
9222
|
* ```js
|
|
8824
9223
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -8835,6 +9234,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8835
9234
|
* default is false.
|
|
8836
9235
|
*
|
|
8837
9236
|
* Supported embed types: `SpotterEmbed`
|
|
9237
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
8838
9238
|
* @example
|
|
8839
9239
|
* ```js
|
|
8840
9240
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8842,7 +9242,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8842
9242
|
* showSpotterLimitations : true,
|
|
8843
9243
|
* })
|
|
8844
9244
|
* ```
|
|
8845
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
8846
9245
|
*/
|
|
8847
9246
|
showSpotterLimitations?: boolean;
|
|
8848
9247
|
/**
|
|
@@ -8850,6 +9249,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8850
9249
|
* the initial screen of the conversation.
|
|
8851
9250
|
*
|
|
8852
9251
|
* Supported embed types: `SpotterEmbed`
|
|
9252
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8853
9253
|
* @example
|
|
8854
9254
|
* ```js
|
|
8855
9255
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8857,7 +9257,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8857
9257
|
* hideSampleQuestions : true,
|
|
8858
9258
|
* })
|
|
8859
9259
|
* ```
|
|
8860
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8861
9260
|
*/
|
|
8862
9261
|
hideSampleQuestions?: boolean;
|
|
8863
9262
|
/**
|
|
@@ -8865,6 +9264,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8865
9264
|
* visualization, or Liveboard.
|
|
8866
9265
|
*
|
|
8867
9266
|
* Supported embed types: `SpotterEmbed`
|
|
9267
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8868
9268
|
* @example
|
|
8869
9269
|
* ```js
|
|
8870
9270
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8878,7 +9278,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8878
9278
|
* ],
|
|
8879
9279
|
* })
|
|
8880
9280
|
* ```
|
|
8881
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8882
9281
|
*/
|
|
8883
9282
|
runtimeFilters?: RuntimeFilter[];
|
|
8884
9283
|
/**
|
|
@@ -8889,14 +9288,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8889
9288
|
* (default behavior before SDK 1.45.0).
|
|
8890
9289
|
*
|
|
8891
9290
|
* Supported embed types: `SpotterEmbed`
|
|
8892
|
-
* @default true
|
|
8893
9291
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9292
|
+
* @default true
|
|
8894
9293
|
*/
|
|
8895
9294
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
8896
9295
|
/**
|
|
8897
9296
|
* The list of runtime parameters to apply to the conversation.
|
|
8898
9297
|
*
|
|
8899
9298
|
* Supported embed types: `SpotterEmbed`
|
|
9299
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8900
9300
|
* @example
|
|
8901
9301
|
* ```js
|
|
8902
9302
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8909,7 +9309,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8909
9309
|
* ],
|
|
8910
9310
|
* })
|
|
8911
9311
|
* ```
|
|
8912
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8913
9312
|
*/
|
|
8914
9313
|
runtimeParameters?: RuntimeParameter[];
|
|
8915
9314
|
/**
|
|
@@ -8920,14 +9319,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8920
9319
|
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
8921
9320
|
*
|
|
8922
9321
|
* Supported embed types: `SpotterEmbed`
|
|
8923
|
-
* @default true
|
|
8924
9322
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9323
|
+
* @default true
|
|
8925
9324
|
*/
|
|
8926
9325
|
excludeRuntimeParametersfromURL?: boolean;
|
|
8927
9326
|
/**
|
|
8928
9327
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
8929
9328
|
*
|
|
8930
9329
|
* Supported embed types: `SpotterEmbed`
|
|
9330
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8931
9331
|
* @default false
|
|
8932
9332
|
* @example
|
|
8933
9333
|
* ```js
|
|
@@ -8936,17 +9336,30 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8936
9336
|
* updatedSpotterChatPrompt : true,
|
|
8937
9337
|
* })
|
|
8938
9338
|
* ```
|
|
8939
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8940
9339
|
*/
|
|
8941
9340
|
updatedSpotterChatPrompt?: boolean;
|
|
9341
|
+
/**
|
|
9342
|
+
* Controls the visibility of the past conversations sidebar.
|
|
9343
|
+
*
|
|
9344
|
+
* Supported embed types: `SpotterEmbed`
|
|
9345
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9346
|
+
* @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9347
|
+
* Use `spotterSidebarConfig.enablePastConversationsSidebar`.
|
|
9348
|
+
* @default false
|
|
9349
|
+
*/
|
|
9350
|
+
enablePastConversationsSidebar?: boolean;
|
|
8942
9351
|
/**
|
|
8943
9352
|
* Configuration for the Spotter sidebar UI customization.
|
|
8944
9353
|
*
|
|
8945
9354
|
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
9355
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8946
9356
|
* @example
|
|
8947
9357
|
* ```js
|
|
8948
9358
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8949
|
-
*
|
|
9359
|
+
* worksheetId: 'worksheet-id',
|
|
9360
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
9361
|
+
* enablePastConversationsSidebar: false,
|
|
9362
|
+
* // Recommended config; this value takes precedence
|
|
8950
9363
|
* spotterSidebarConfig: {
|
|
8951
9364
|
* enablePastConversationsSidebar: true,
|
|
8952
9365
|
* spotterSidebarTitle: 'My Conversations',
|
|
@@ -8954,7 +9367,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8954
9367
|
* },
|
|
8955
9368
|
* })
|
|
8956
9369
|
* ```
|
|
8957
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8958
9370
|
*/
|
|
8959
9371
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
8960
9372
|
/**
|
|
@@ -8962,6 +9374,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8962
9374
|
* branding in tool response cards.
|
|
8963
9375
|
*
|
|
8964
9376
|
* Supported embed types: `SpotterEmbed`
|
|
9377
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8965
9378
|
* @example
|
|
8966
9379
|
* ```js
|
|
8967
9380
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8972,14 +9385,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8972
9385
|
* },
|
|
8973
9386
|
* })
|
|
8974
9387
|
* ```
|
|
8975
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8976
9388
|
*/
|
|
8977
9389
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
8978
9390
|
}
|
|
8979
9391
|
/**
|
|
8980
9392
|
* The configuration for the embedded spotterEmbed options.
|
|
8981
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8982
9393
|
* Use {@link SpotterEmbedViewConfig} instead
|
|
9394
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8983
9395
|
* @group Embed components
|
|
8984
9396
|
*/
|
|
8985
9397
|
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
@@ -9088,7 +9500,7 @@ declare enum ListPage {
|
|
|
9088
9500
|
*/
|
|
9089
9501
|
export interface DiscoveryExperience {
|
|
9090
9502
|
/**
|
|
9091
|
-
* primaryNavbarVersion determines the version of the navigation
|
|
9503
|
+
* primaryNavbarVersion determines the version of the primary navigation bar.
|
|
9092
9504
|
*/
|
|
9093
9505
|
primaryNavbarVersion?: PrimaryNavbarVersion;
|
|
9094
9506
|
/**
|
|
@@ -9111,8 +9523,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9111
9523
|
* This flag also controls the homepage left navigation bar.
|
|
9112
9524
|
*
|
|
9113
9525
|
* Supported embed types: `AppEmbed`
|
|
9114
|
-
* @default true
|
|
9115
9526
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9527
|
+
* @default true
|
|
9116
9528
|
* @example
|
|
9117
9529
|
* ```js
|
|
9118
9530
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9133,8 +9545,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9133
9545
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
9134
9546
|
*
|
|
9135
9547
|
* Supported embed types: `AppEmbed`
|
|
9136
|
-
* @default false
|
|
9137
9548
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9549
|
+
* @default false
|
|
9138
9550
|
* @example
|
|
9139
9551
|
* ```js
|
|
9140
9552
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9151,8 +9563,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9151
9563
|
* navigation bar is not hidden via `showPrimaryNavbar`.
|
|
9152
9564
|
*
|
|
9153
9565
|
* Supported embed types: `AppEmbed`
|
|
9154
|
-
* @default false
|
|
9155
9566
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9567
|
+
* @default false
|
|
9156
9568
|
* @example
|
|
9157
9569
|
* ```js
|
|
9158
9570
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9163,12 +9575,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9163
9575
|
*/
|
|
9164
9576
|
disableProfileAndHelp?: boolean;
|
|
9165
9577
|
/**
|
|
9166
|
-
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9167
|
-
* @default true
|
|
9168
9578
|
* Whether the help menu in the top navigation bar should be served
|
|
9169
9579
|
* from Pendo or ThoughtSpot's internal help items.
|
|
9170
9580
|
*
|
|
9171
9581
|
* Supported embed types: `AppEmbed`
|
|
9582
|
+
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9583
|
+
* @default true
|
|
9172
9584
|
* @example
|
|
9173
9585
|
* ```js
|
|
9174
9586
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9183,8 +9595,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9183
9595
|
* the top navigation bar in the V3 navigation experience.
|
|
9184
9596
|
*
|
|
9185
9597
|
* Supported embed types: `AppEmbed`
|
|
9186
|
-
* @default false
|
|
9187
9598
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9599
|
+
* @default false
|
|
9188
9600
|
* @example
|
|
9189
9601
|
* ```js
|
|
9190
9602
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9203,8 +9615,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9203
9615
|
* in the classic (V1) experience.
|
|
9204
9616
|
*
|
|
9205
9617
|
* Supported embed types: `AppEmbed`
|
|
9206
|
-
* @default true
|
|
9207
9618
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9619
|
+
* @default true
|
|
9208
9620
|
* @example
|
|
9209
9621
|
* ```js
|
|
9210
9622
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9222,8 +9634,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9222
9634
|
* in the classic (V1) and V2 experience modes.
|
|
9223
9635
|
*
|
|
9224
9636
|
* Supported embed types: `AppEmbed`
|
|
9225
|
-
* @default true
|
|
9226
9637
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9638
|
+
* @default true
|
|
9227
9639
|
* @example
|
|
9228
9640
|
* ```js
|
|
9229
9641
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9239,7 +9651,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9239
9651
|
* In the V3 experience, it shows or hides application selection
|
|
9240
9652
|
* icons on the left navigation panel.
|
|
9241
9653
|
* By default, the application selection menu and icons are
|
|
9242
|
-
* shown in the UI
|
|
9654
|
+
* shown in the UI.
|
|
9243
9655
|
*
|
|
9244
9656
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
9245
9657
|
*
|
|
@@ -9279,7 +9691,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9279
9691
|
* takes precedence. This is the path post the `#/` in the URL of the standalone
|
|
9280
9692
|
* ThoughtSpot app. Use this to open the embedded view to a specific path.
|
|
9281
9693
|
*
|
|
9282
|
-
* For
|
|
9694
|
+
* For example, if you want the component to open to a specific Liveboard
|
|
9283
9695
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
9284
9696
|
*
|
|
9285
9697
|
* Supported embed types: `AppEmbed`
|
|
@@ -9297,7 +9709,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9297
9709
|
* The application page to set as the start page
|
|
9298
9710
|
* in the embedded view.
|
|
9299
9711
|
*
|
|
9300
|
-
* Use this to open to particular page in the app. To open to a specific
|
|
9712
|
+
* Use this to open to a particular page in the app. To open to a specific
|
|
9301
9713
|
* path within the app, use the `path` attribute which is more flexible.
|
|
9302
9714
|
*
|
|
9303
9715
|
* Supported embed types: `AppEmbed`
|
|
@@ -9377,8 +9789,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9377
9789
|
* If set to true, the Search Assist feature is enabled.
|
|
9378
9790
|
*
|
|
9379
9791
|
* Supported embed types: `AppEmbed`
|
|
9380
|
-
* @default true
|
|
9381
9792
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
9793
|
+
* @default true
|
|
9382
9794
|
* @example
|
|
9383
9795
|
* ```js
|
|
9384
9796
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9416,8 +9828,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9416
9828
|
* For more information,
|
|
9417
9829
|
* see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
9418
9830
|
* Supported embed types: `AppEmbed`
|
|
9419
|
-
* @default false
|
|
9420
9831
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9832
|
+
* @default false
|
|
9421
9833
|
* @example
|
|
9422
9834
|
* ```js
|
|
9423
9835
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9432,8 +9844,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9432
9844
|
* For more information, see
|
|
9433
9845
|
* link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
9434
9846
|
* Supported embed types: `AppEmbed`
|
|
9435
|
-
* @default false
|
|
9436
9847
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9848
|
+
* @default false
|
|
9437
9849
|
* @example
|
|
9438
9850
|
* ```js
|
|
9439
9851
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9448,10 +9860,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9448
9860
|
*/
|
|
9449
9861
|
discoveryExperience?: DiscoveryExperience;
|
|
9450
9862
|
/**
|
|
9451
|
-
* To set the initial state of the search bar in case of saved-answers.
|
|
9863
|
+
* To set the initial state of the search bar in case of saved-answers. Use {@link collapseSearchBar} instead.
|
|
9452
9864
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
9865
|
+
* @deprecated This flag is deprecated.
|
|
9453
9866
|
* @default false
|
|
9454
|
-
* @deprecated Use {@link collapseSearchBar} instead
|
|
9455
9867
|
*/
|
|
9456
9868
|
collapseSearchBarInitially?: boolean;
|
|
9457
9869
|
/**
|
|
@@ -9479,14 +9891,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9479
9891
|
* Flag to use home page search bar mode
|
|
9480
9892
|
*
|
|
9481
9893
|
* Supported embed types: `AppEmbed`
|
|
9482
|
-
* @version SDK
|
|
9894
|
+
* @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
9483
9895
|
*/
|
|
9484
9896
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
9485
9897
|
/**
|
|
9486
9898
|
* This flag is used to enable unified search experience for full app embed.
|
|
9487
9899
|
*
|
|
9488
9900
|
* Supported embed types: `AppEmbed`
|
|
9489
|
-
* @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
|
|
9901
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
|
|
9490
9902
|
* @default true
|
|
9491
9903
|
* @example
|
|
9492
9904
|
* ```js
|
|
@@ -9498,7 +9910,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9498
9910
|
*/
|
|
9499
9911
|
isUnifiedSearchExperienceEnabled?: boolean;
|
|
9500
9912
|
/**
|
|
9501
|
-
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
9913
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
9914
|
+
* @deprecated This flag is deprecated.
|
|
9502
9915
|
*
|
|
9503
9916
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9504
9917
|
* @type {boolean}
|
|
@@ -9564,6 +9977,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9564
9977
|
/**
|
|
9565
9978
|
* This flag is used to enable the full height lazy load data.
|
|
9566
9979
|
*
|
|
9980
|
+
* @type {boolean}
|
|
9981
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9982
|
+
* @default false
|
|
9567
9983
|
* @example
|
|
9568
9984
|
* ```js
|
|
9569
9985
|
* const embed = new AppEmbed('#embed-container', {
|
|
@@ -9572,39 +9988,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9572
9988
|
* lazyLoadingForFullHeight: true,
|
|
9573
9989
|
* })
|
|
9574
9990
|
* ```
|
|
9575
|
-
*
|
|
9576
|
-
* @type {boolean}
|
|
9577
|
-
* @default false
|
|
9578
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9579
9991
|
*/
|
|
9580
9992
|
lazyLoadingForFullHeight?: boolean;
|
|
9581
9993
|
/**
|
|
9582
9994
|
* The margin to be used for lazy loading.
|
|
9583
9995
|
*
|
|
9584
9996
|
* For example, if the margin is set to '10px',
|
|
9585
|
-
* the visualization will be loaded 10px before
|
|
9997
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
9586
9998
|
* viewport.
|
|
9587
9999
|
*
|
|
9588
10000
|
* The format is similar to CSS margin.
|
|
9589
10001
|
*
|
|
10002
|
+
* @type {string}
|
|
10003
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9590
10004
|
* @example
|
|
9591
10005
|
* ```js
|
|
9592
10006
|
* const embed = new AppEmbed('#embed-container', {
|
|
9593
10007
|
* // ...other options
|
|
9594
10008
|
* fullHeight: true,
|
|
9595
10009
|
* lazyLoadingForFullHeight: true,
|
|
9596
|
-
* // Using 0px, the visualization will be only loaded when
|
|
10010
|
+
* // Using 0px, the visualization will be only loaded when it's visible in the viewport.
|
|
9597
10011
|
* lazyLoadingMargin: '0px',
|
|
9598
10012
|
* })
|
|
9599
10013
|
* ```
|
|
9600
|
-
* @type {string}
|
|
9601
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9602
10014
|
*/
|
|
9603
10015
|
lazyLoadingMargin?: string;
|
|
9604
10016
|
/**
|
|
9605
10017
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9606
10018
|
*
|
|
9607
10019
|
* Supported embed types: `AppEmbed`
|
|
10020
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9608
10021
|
* @default false
|
|
9609
10022
|
* @example
|
|
9610
10023
|
* ```js
|
|
@@ -9613,25 +10026,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9613
10026
|
* updatedSpotterChatPrompt : true,
|
|
9614
10027
|
* })
|
|
9615
10028
|
* ```
|
|
9616
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9617
10029
|
*/
|
|
9618
10030
|
updatedSpotterChatPrompt?: boolean;
|
|
10031
|
+
/**
|
|
10032
|
+
* Controls the visibility of the past conversations sidebar.
|
|
10033
|
+
*
|
|
10034
|
+
* Supported embed types: `AppEmbed`
|
|
10035
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
10036
|
+
* @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
10037
|
+
* Use `spotterSidebarConfig.enablePastConversationsSidebar`.
|
|
10038
|
+
* @default false
|
|
10039
|
+
*/
|
|
10040
|
+
enablePastConversationsSidebar?: boolean;
|
|
9619
10041
|
/**
|
|
9620
10042
|
* Configuration for the Spotter sidebar UI customization.
|
|
9621
10043
|
* Only applicable when navigating to Spotter within the app.
|
|
9622
10044
|
*
|
|
9623
10045
|
* Supported embed types: `AppEmbed`
|
|
10046
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9624
10047
|
* @example
|
|
9625
10048
|
* ```js
|
|
9626
10049
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
9627
|
-
*
|
|
10050
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
10051
|
+
* enablePastConversationsSidebar: false,
|
|
10052
|
+
* // Recommended config; this value takes precedence
|
|
9628
10053
|
* spotterSidebarConfig: {
|
|
9629
10054
|
* enablePastConversationsSidebar: true,
|
|
9630
10055
|
* spotterSidebarTitle: 'My Conversations',
|
|
9631
10056
|
* },
|
|
9632
10057
|
* })
|
|
9633
10058
|
* ```
|
|
9634
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9635
10059
|
*/
|
|
9636
10060
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
9637
10061
|
/**
|
|
@@ -9639,6 +10063,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9639
10063
|
* branding in tool response cards.
|
|
9640
10064
|
*
|
|
9641
10065
|
* Supported embed types: `AppEmbed`
|
|
10066
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9642
10067
|
* @example
|
|
9643
10068
|
* ```js
|
|
9644
10069
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9649,7 +10074,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9649
10074
|
* },
|
|
9650
10075
|
* })
|
|
9651
10076
|
* ```
|
|
9652
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9653
10077
|
*/
|
|
9654
10078
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
9655
10079
|
/**
|
|
@@ -9669,6 +10093,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9669
10093
|
* ```
|
|
9670
10094
|
*/
|
|
9671
10095
|
minimumHeight?: number;
|
|
10096
|
+
/**
|
|
10097
|
+
* To enable the homepage announcement banner.
|
|
10098
|
+
* Controls the visibility of the announcement section
|
|
10099
|
+
* on the homepage.
|
|
10100
|
+
*
|
|
10101
|
+
* Supported embed types: `AppEmbed`
|
|
10102
|
+
* @example
|
|
10103
|
+
* ```js
|
|
10104
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
10105
|
+
* ... // other embed view config
|
|
10106
|
+
* enableHomepageAnnouncement: true,
|
|
10107
|
+
* })
|
|
10108
|
+
* ```
|
|
10109
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
10110
|
+
*/
|
|
10111
|
+
enableHomepageAnnouncement?: boolean;
|
|
9672
10112
|
}
|
|
9673
10113
|
declare class AppEmbed extends V1Embed {
|
|
9674
10114
|
protected viewConfig: AppViewConfig;
|
|
@@ -9755,9 +10195,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9755
10195
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
9756
10196
|
* incrementally as users scroll the page to view the charts and tables.
|
|
9757
10197
|
*
|
|
9758
|
-
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
9759
10198
|
*
|
|
9760
10199
|
* Supported embed types: `LiveboardEmbed`
|
|
10200
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
9761
10201
|
* @example
|
|
9762
10202
|
* ```js
|
|
9763
10203
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -9768,14 +10208,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9768
10208
|
*/
|
|
9769
10209
|
fullHeight?: boolean;
|
|
9770
10210
|
/**
|
|
9771
|
-
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
10211
|
+
* This is the minimum height (in pixels) for a full-height Liveboard.
|
|
9772
10212
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
9773
10213
|
* other screens navigable from a Liveboard.
|
|
9774
10214
|
*
|
|
9775
10215
|
* Supported embed types: `LiveboardEmbed`
|
|
9776
10216
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
9777
|
-
* @default 500
|
|
9778
10217
|
* @deprecated Use `minimumHeight` instead.
|
|
10218
|
+
* @default 500
|
|
9779
10219
|
* @example
|
|
9780
10220
|
* ```js
|
|
9781
10221
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -9804,7 +10244,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9804
10244
|
*/
|
|
9805
10245
|
minimumHeight?: number;
|
|
9806
10246
|
/**
|
|
9807
|
-
*
|
|
10247
|
+
* If set to true, the context menu in visualizations will be enabled.
|
|
10248
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10249
|
+
* @deprecated this option is deprecated.
|
|
9808
10250
|
* @example
|
|
9809
10251
|
* ```js
|
|
9810
10252
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9812,7 +10254,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9812
10254
|
* enableVizTransformations:true,
|
|
9813
10255
|
* })
|
|
9814
10256
|
* ```
|
|
9815
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
9816
10257
|
*/
|
|
9817
10258
|
enableVizTransformations?: boolean;
|
|
9818
10259
|
/**
|
|
@@ -9825,8 +10266,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9825
10266
|
* ```js
|
|
9826
10267
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9827
10268
|
* ... //other embed view config
|
|
9828
|
-
* liveboardId:id of liveboard,
|
|
10269
|
+
* liveboardId:'id of liveboard',
|
|
9829
10270
|
* })
|
|
10271
|
+
* ```
|
|
9830
10272
|
*/
|
|
9831
10273
|
liveboardId?: string;
|
|
9832
10274
|
/**
|
|
@@ -9879,6 +10321,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9879
10321
|
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
9880
10322
|
* ]
|
|
9881
10323
|
* })
|
|
10324
|
+
* ```
|
|
9882
10325
|
*/
|
|
9883
10326
|
visibleVizs?: string[];
|
|
9884
10327
|
/**
|
|
@@ -9906,6 +10349,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9906
10349
|
* Specify the tab ID.
|
|
9907
10350
|
*
|
|
9908
10351
|
* Supported embed types: `LiveboardEmbed`
|
|
10352
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
9909
10353
|
* @example
|
|
9910
10354
|
* ```js
|
|
9911
10355
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9913,7 +10357,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9913
10357
|
* activeTabId:'id-1234',
|
|
9914
10358
|
* })
|
|
9915
10359
|
* ```
|
|
9916
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
9917
10360
|
*/
|
|
9918
10361
|
activeTabId?: string;
|
|
9919
10362
|
/**
|
|
@@ -9922,6 +10365,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9922
10365
|
* that includes specific filter selections.
|
|
9923
10366
|
*
|
|
9924
10367
|
* Supported embed types: `LiveboardEmbed`
|
|
10368
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9925
10369
|
* @example
|
|
9926
10370
|
* ```js
|
|
9927
10371
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9930,7 +10374,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9930
10374
|
* activeTabId: 'tab-guid',
|
|
9931
10375
|
* })
|
|
9932
10376
|
* ```
|
|
9933
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9934
10377
|
*/
|
|
9935
10378
|
personalizedViewId?: string;
|
|
9936
10379
|
/**
|
|
@@ -9951,13 +10394,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9951
10394
|
* Show a preview image of the visualization before the visualization loads.
|
|
9952
10395
|
* Only works for visualizations embeds with a viz id.
|
|
9953
10396
|
*
|
|
9954
|
-
* Also, viz
|
|
10397
|
+
* Also, viz snapshot should be enabled in the ThoughtSpot instance.
|
|
9955
10398
|
* Contact ThoughtSpot support to enable this feature.
|
|
9956
10399
|
*
|
|
9957
|
-
* Since
|
|
10400
|
+
* Since this will show preview images, be careful that it may show
|
|
9958
10401
|
* undesired data to the user when using row level security.
|
|
9959
10402
|
*
|
|
9960
10403
|
* Supported embed types: `LiveboardEmbed`
|
|
10404
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
9961
10405
|
* @example
|
|
9962
10406
|
* ```js
|
|
9963
10407
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9967,7 +10411,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9967
10411
|
* });
|
|
9968
10412
|
* embed.render();
|
|
9969
10413
|
* ```
|
|
9970
|
-
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
9971
10414
|
*/
|
|
9972
10415
|
showPreviewLoader?: boolean;
|
|
9973
10416
|
/**
|
|
@@ -9975,13 +10418,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9975
10418
|
*
|
|
9976
10419
|
* Supported embed types: `LiveboardEmbed`
|
|
9977
10420
|
* @hidden
|
|
9978
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10421
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
9979
10422
|
* @example
|
|
9980
10423
|
* ```js
|
|
9981
10424
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9982
10425
|
* ... //other embed view config
|
|
9983
|
-
* oAuthPollingInterval:
|
|
10426
|
+
* oAuthPollingInterval: 30000,
|
|
9984
10427
|
* })
|
|
10428
|
+
* ```
|
|
9985
10429
|
*/
|
|
9986
10430
|
oAuthPollingInterval?: number;
|
|
9987
10431
|
/**
|
|
@@ -9989,35 +10433,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9989
10433
|
*
|
|
9990
10434
|
* Supported embed types: `LiveboardEmbed`
|
|
9991
10435
|
* @hidden
|
|
9992
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10436
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
9993
10437
|
* @example
|
|
9994
10438
|
* ```js
|
|
9995
10439
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9996
10440
|
* ... //other embed view config
|
|
9997
10441
|
* isForceRedirect: false,
|
|
9998
10442
|
* })
|
|
10443
|
+
* ```
|
|
9999
10444
|
*/
|
|
10000
10445
|
isForceRedirect?: boolean;
|
|
10001
10446
|
/**
|
|
10002
10447
|
* The source connection ID for authentication.
|
|
10003
|
-
* @hidden
|
|
10004
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10005
10448
|
*
|
|
10006
10449
|
* Supported embed types: `LiveboardEmbed`
|
|
10450
|
+
* @hidden
|
|
10451
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10007
10452
|
* @example
|
|
10008
10453
|
* ```js
|
|
10009
10454
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10010
10455
|
* ... //other embed view config
|
|
10011
10456
|
* dataSourceId: '',
|
|
10012
10457
|
* })
|
|
10458
|
+
* ```
|
|
10013
10459
|
*/
|
|
10014
10460
|
dataSourceId?: string;
|
|
10015
10461
|
/**
|
|
10016
|
-
* The list of tab IDs to hide from the embedded.
|
|
10017
|
-
*
|
|
10018
|
-
* Use this to hide
|
|
10462
|
+
* The list of tab IDs to hide from the embedded Liveboard.
|
|
10463
|
+
* These tabs will be hidden from their respective Liveboards.
|
|
10464
|
+
* Use this to hide a tab ID.
|
|
10019
10465
|
*
|
|
10020
10466
|
* Supported embed types: `LiveboardEmbed`
|
|
10467
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
10021
10468
|
* @example
|
|
10022
10469
|
* ```js
|
|
10023
10470
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10028,7 +10475,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10028
10475
|
* ]
|
|
10029
10476
|
* });
|
|
10030
10477
|
* ```
|
|
10031
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
10032
10478
|
*/
|
|
10033
10479
|
hiddenTabs?: string[];
|
|
10034
10480
|
/**
|
|
@@ -10052,7 +10498,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10052
10498
|
*/
|
|
10053
10499
|
visibleTabs?: string[];
|
|
10054
10500
|
/**
|
|
10055
|
-
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
10501
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
10502
|
+
* @deprecated This flag is deprecated.
|
|
10056
10503
|
*
|
|
10057
10504
|
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
|
|
10058
10505
|
* @type {boolean}
|
|
@@ -10118,6 +10565,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10118
10565
|
/**
|
|
10119
10566
|
* This flag is used to enable the full height lazy load data.
|
|
10120
10567
|
*
|
|
10568
|
+
* @type {boolean}
|
|
10569
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10570
|
+
* @default false
|
|
10121
10571
|
* @example
|
|
10122
10572
|
* ```js
|
|
10123
10573
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -10126,33 +10576,29 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10126
10576
|
* lazyLoadingForFullHeight: true,
|
|
10127
10577
|
* })
|
|
10128
10578
|
* ```
|
|
10129
|
-
*
|
|
10130
|
-
* @type {boolean}
|
|
10131
|
-
* @default false
|
|
10132
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
10133
10579
|
*/
|
|
10134
10580
|
lazyLoadingForFullHeight?: boolean;
|
|
10135
10581
|
/**
|
|
10136
10582
|
* The margin to be used for lazy loading.
|
|
10137
10583
|
*
|
|
10138
10584
|
* For example, if the margin is set to '10px',
|
|
10139
|
-
* the visualization will be loaded 10px before
|
|
10585
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
10140
10586
|
* viewport.
|
|
10141
10587
|
*
|
|
10142
10588
|
* The format is similar to CSS margin.
|
|
10143
10589
|
*
|
|
10590
|
+
* @type {string}
|
|
10591
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10144
10592
|
* @example
|
|
10145
10593
|
* ```js
|
|
10146
10594
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
10147
10595
|
* // ...other options
|
|
10148
10596
|
* fullHeight: true,
|
|
10149
10597
|
* lazyLoadingForFullHeight: true,
|
|
10150
|
-
* // Using 0px, the visualization will be only loaded when
|
|
10598
|
+
* // Using 0px, the visualization will be only loaded when it's visible in the viewport.
|
|
10151
10599
|
* lazyLoadingMargin: '0px',
|
|
10152
10600
|
* })
|
|
10153
10601
|
* ```
|
|
10154
|
-
* @type {string}
|
|
10155
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
10156
10602
|
*/
|
|
10157
10603
|
lazyLoadingMargin?: string;
|
|
10158
10604
|
/**
|
|
@@ -10160,6 +10606,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10160
10606
|
* of the spotter underneath the chat input.
|
|
10161
10607
|
* default is false.
|
|
10162
10608
|
*
|
|
10609
|
+
* @type {boolean}
|
|
10610
|
+
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
10163
10611
|
* @example
|
|
10164
10612
|
* ```js
|
|
10165
10613
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -10167,14 +10615,13 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10167
10615
|
* showSpotterLimitations: true,
|
|
10168
10616
|
* })
|
|
10169
10617
|
* ```
|
|
10170
|
-
* @type {boolean}
|
|
10171
|
-
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
10172
10618
|
*/
|
|
10173
10619
|
showSpotterLimitations?: boolean;
|
|
10174
10620
|
/**
|
|
10175
10621
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
10176
10622
|
*
|
|
10177
10623
|
* Supported embed types: `LiveboardEmbed`
|
|
10624
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10178
10625
|
* @default false
|
|
10179
10626
|
* @example
|
|
10180
10627
|
* ```js
|
|
@@ -10183,7 +10630,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10183
10630
|
* updatedSpotterChatPrompt : true,
|
|
10184
10631
|
* })
|
|
10185
10632
|
* ```
|
|
10186
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10187
10633
|
*/
|
|
10188
10634
|
updatedSpotterChatPrompt?: boolean;
|
|
10189
10635
|
/**
|
|
@@ -10191,6 +10637,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10191
10637
|
* branding in tool response cards.
|
|
10192
10638
|
*
|
|
10193
10639
|
* Supported embed types: `LiveboardEmbed`
|
|
10640
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10194
10641
|
* @example
|
|
10195
10642
|
* ```js
|
|
10196
10643
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10201,7 +10648,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10201
10648
|
* },
|
|
10202
10649
|
* })
|
|
10203
10650
|
* ```
|
|
10204
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10205
10651
|
*/
|
|
10206
10652
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
10207
10653
|
}
|
|
@@ -10346,6 +10792,9 @@ export interface PreRenderProps {
|
|
|
10346
10792
|
* PreRender id to be used for PreRendering the embed.
|
|
10347
10793
|
* Use PreRender to render the embed in the background and then
|
|
10348
10794
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
10795
|
+
*
|
|
10796
|
+
* Use PreRendered react component for pre rendering embed components.
|
|
10797
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
|
|
10349
10798
|
* @example
|
|
10350
10799
|
* ```js
|
|
10351
10800
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -10354,8 +10803,6 @@ export interface PreRenderProps {
|
|
|
10354
10803
|
* });
|
|
10355
10804
|
* embed.showPreRender();
|
|
10356
10805
|
* ```
|
|
10357
|
-
*
|
|
10358
|
-
* Use PreRendered react component for pre rendering embed components.
|
|
10359
10806
|
* @example
|
|
10360
10807
|
* ```tsx
|
|
10361
10808
|
* function LandingPageComponent() {
|
|
@@ -10366,7 +10813,6 @@ export interface PreRenderProps {
|
|
|
10366
10813
|
* return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
|
|
10367
10814
|
* }
|
|
10368
10815
|
* ```
|
|
10369
|
-
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
10370
10816
|
*/
|
|
10371
10817
|
preRenderId: string;
|
|
10372
10818
|
}
|
|
@@ -10390,7 +10836,7 @@ export interface AppProps extends EmbedProps, AppViewConfig {
|
|
|
10390
10836
|
* React component for Full app Embed.
|
|
10391
10837
|
* @example
|
|
10392
10838
|
* ```tsx
|
|
10393
|
-
* function
|
|
10839
|
+
* function App() {
|
|
10394
10840
|
* return <AppEmbed
|
|
10395
10841
|
* showPrimaryNavbar={false}
|
|
10396
10842
|
* pageId={Page.Liveboards}
|
|
@@ -10401,9 +10847,9 @@ export interface AppProps extends EmbedProps, AppViewConfig {
|
|
|
10401
10847
|
*/
|
|
10402
10848
|
declare const AppEmbed$1: React$1.ForwardRefExoticComponent<AppProps & React$1.RefAttributes<AppEmbed>>;
|
|
10403
10849
|
/**
|
|
10404
|
-
* React component for PreRendered
|
|
10850
|
+
* React component for PreRendered App embed.
|
|
10405
10851
|
*
|
|
10406
|
-
* PreRenderedAppEmbed will preRender the
|
|
10852
|
+
* PreRenderedAppEmbed will preRender the AppEmbed and will be hidden by
|
|
10407
10853
|
* default.
|
|
10408
10854
|
*
|
|
10409
10855
|
* AppEmbed with preRenderId passed will call showPreRender on the embed.
|
|
@@ -10445,7 +10891,7 @@ export declare const PinboardEmbed: React$1.ForwardRefExoticComponent<LiveboardP
|
|
|
10445
10891
|
* LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
|
|
10446
10892
|
*
|
|
10447
10893
|
* If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
|
|
10448
|
-
* tries to preRender the LiveboardEmbed, so it is recommended to
|
|
10894
|
+
* tries to preRender the LiveboardEmbed, so it is recommended to pass the
|
|
10449
10895
|
* liveboardId to both the components.
|
|
10450
10896
|
* @example
|
|
10451
10897
|
* ```tsx
|
|
@@ -10476,7 +10922,7 @@ export interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
|
|
|
10476
10922
|
*/
|
|
10477
10923
|
declare const SearchBarEmbed$1: React$1.ForwardRefExoticComponent<SearchBarEmbedProps & React$1.RefAttributes<SearchBarEmbed>>;
|
|
10478
10924
|
/**
|
|
10479
|
-
* React component for PreRendered
|
|
10925
|
+
* React component for PreRendered SearchBar embed.
|
|
10480
10926
|
*
|
|
10481
10927
|
* PreRenderedSearchBarEmbed will preRender the SearchBarEmbed and will be hidden by
|
|
10482
10928
|
* default.
|
|
@@ -10510,9 +10956,9 @@ export interface SageEmbedProps extends EmbedProps, SageViewConfig {
|
|
|
10510
10956
|
*/
|
|
10511
10957
|
declare const SageEmbed$1: React$1.ForwardRefExoticComponent<SageEmbedProps & React$1.RefAttributes<SageEmbed>>;
|
|
10512
10958
|
/**
|
|
10513
|
-
* React component for PreRendered
|
|
10959
|
+
* React component for PreRendered Sage embed.
|
|
10514
10960
|
*
|
|
10515
|
-
* PreRenderedSageEmbed will preRender the
|
|
10961
|
+
* PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
|
|
10516
10962
|
* default.
|
|
10517
10963
|
*
|
|
10518
10964
|
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
@@ -10550,8 +10996,8 @@ export interface ConversationEmbedProps extends EmbedProps, ConversationViewConf
|
|
|
10550
10996
|
declare const SpotterEmbed$1: React$1.ForwardRefExoticComponent<SpotterEmbedProps & React$1.RefAttributes<SpotterEmbed>>;
|
|
10551
10997
|
/**
|
|
10552
10998
|
* React component for LLM based conversation BI.
|
|
10553
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10554
10999
|
* Use {@link SpotterEmbed} instead
|
|
11000
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10555
11001
|
* @example
|
|
10556
11002
|
* ```tsx
|
|
10557
11003
|
* function Sage() {
|
|
@@ -10580,6 +11026,7 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
|
|
|
10580
11026
|
* This component renders a single message response from your ThoughtSpot conversation,
|
|
10581
11027
|
* showing charts, visualizations, or text responses based on the user's query.
|
|
10582
11028
|
*
|
|
11029
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
10583
11030
|
* @example
|
|
10584
11031
|
* ```tsx
|
|
10585
11032
|
* const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
|
|
@@ -10596,7 +11043,6 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
|
|
|
10596
11043
|
* />
|
|
10597
11044
|
* }
|
|
10598
11045
|
* ```
|
|
10599
|
-
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
10600
11046
|
*/
|
|
10601
11047
|
export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
|
|
10602
11048
|
message: SpotterAgentMessageViewConfig;
|
|
@@ -10608,7 +11054,7 @@ export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
|
|
|
10608
11054
|
* PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
|
|
10609
11055
|
* default.
|
|
10610
11056
|
*
|
|
10611
|
-
*
|
|
11057
|
+
* SpotterEmbed with preRenderId passed will call showPreRender on the embed.
|
|
10612
11058
|
* @example
|
|
10613
11059
|
* ```tsx
|
|
10614
11060
|
* function LandingPageComponent() {
|
|
@@ -10641,6 +11087,7 @@ export type EmbedComponent = typeof SearchEmbed$1 | typeof AppEmbed$1 | typeof L
|
|
|
10641
11087
|
export declare function useEmbedRef<T extends EmbedComponent>(): React$1.MutableRefObject<React$1.ComponentRef<T>>;
|
|
10642
11088
|
/**
|
|
10643
11089
|
*
|
|
11090
|
+
* @version SDK: 1.36.2 | ThoughtSpot: *
|
|
10644
11091
|
* @param config - EmbedConfig
|
|
10645
11092
|
* @returns AuthEventEmitter
|
|
10646
11093
|
* @example
|
|
@@ -10650,7 +11097,6 @@ export declare function useEmbedRef<T extends EmbedComponent>(): React$1.Mutable
|
|
|
10650
11097
|
* return <LiveboardEmbed ref={ref} liveboardId={<id>} />
|
|
10651
11098
|
* }
|
|
10652
11099
|
* ```
|
|
10653
|
-
* @version SDK: 1.36.2 | ThoughtSpot: *
|
|
10654
11100
|
*/
|
|
10655
11101
|
export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<AuthEventEmitter>;
|
|
10656
11102
|
/**
|
|
@@ -10659,6 +11105,7 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
|
|
|
10659
11105
|
* This hook provides a sendMessage function that allows you to send natural language
|
|
10660
11106
|
* queries to your data and get back AI-generated responses with visualizations.
|
|
10661
11107
|
*
|
|
11108
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
10662
11109
|
* @param config - Configuration object containing worksheetId and other options
|
|
10663
11110
|
* @returns Object with sendMessage function that returns conversation results
|
|
10664
11111
|
* @example
|
|
@@ -10676,7 +11123,6 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
|
|
|
10676
11123
|
* }
|
|
10677
11124
|
* };
|
|
10678
11125
|
* ```
|
|
10679
|
-
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
10680
11126
|
*/
|
|
10681
11127
|
export declare function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
|
|
10682
11128
|
sendMessage: (query: string) => Promise<{
|