@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts +29 -4
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +29 -4
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/css-variables.d.ts +17 -17
- package/cjs/src/embed/app.d.ts +60 -32
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +10 -3
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +34 -1
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +2 -2
- package/cjs/src/embed/base.js +2 -2
- package/cjs/src/embed/bodyless-conversation.d.ts +5 -5
- package/cjs/src/embed/bodyless-conversation.js +4 -4
- package/cjs/src/embed/conversation.d.ts +43 -30
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +10 -11
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +27 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +40 -34
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +1 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +1 -1
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +5 -5
- package/cjs/src/embed/sage.js +1 -1
- package/cjs/src/embed/search-bar.d.ts +7 -7
- package/cjs/src/embed/search-bar.js +1 -1
- package/cjs/src/embed/search.d.ts +13 -12
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +3 -3
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +12 -6
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +35 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/react/index.d.ts +15 -15
- package/cjs/src/react/index.js +12 -12
- package/cjs/src/tokenizedFetch.d.ts +1 -1
- package/cjs/src/tokenizedFetch.js +1 -1
- package/cjs/src/types.d.ts +294 -255
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +206 -200
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +6 -4
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +55 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils.d.ts +9 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +10 -1
- package/cjs/src/utils.js.map +1 -1
- package/dist/{index-Vyh6Ha5f.js → index-DkizS4xM.js} +1 -1
- package/dist/src/auth.d.ts +29 -4
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/css-variables.d.ts +17 -17
- package/dist/src/embed/app.d.ts +60 -32
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +2 -2
- package/dist/src/embed/bodyless-conversation.d.ts +5 -5
- package/dist/src/embed/conversation.d.ts +43 -30
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +40 -34
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +5 -5
- package/dist/src/embed/search-bar.d.ts +7 -7
- package/dist/src/embed/search.d.ts +13 -12
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +3 -3
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +15 -15
- package/dist/src/tokenizedFetch.d.ts +1 -1
- package/dist/src/types.d.ts +294 -255
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils.d.ts +9 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +307 -275
- package/dist/tsembed-react.js +306 -274
- package/dist/tsembed.es.js +299 -267
- package/dist/tsembed.js +298 -266
- package/dist/visual-embed-sdk-react-full.d.ts +520 -409
- package/dist/visual-embed-sdk-react.d.ts +518 -407
- package/dist/visual-embed-sdk.d.ts +519 -408
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +29 -4
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +29 -4
- package/lib/src/auth.js.map +1 -1
- package/lib/src/css-variables.d.ts +17 -17
- package/lib/src/embed/app.d.ts +60 -32
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +11 -4
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +34 -1
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +2 -2
- package/lib/src/embed/base.js +2 -2
- package/lib/src/embed/bodyless-conversation.d.ts +5 -5
- package/lib/src/embed/bodyless-conversation.js +4 -4
- package/lib/src/embed/conversation.d.ts +43 -30
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +11 -11
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +27 -0
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +40 -34
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +1 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +1 -1
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +5 -5
- package/lib/src/embed/sage.js +1 -1
- package/lib/src/embed/search-bar.d.ts +7 -7
- package/lib/src/embed/search-bar.js +1 -1
- package/lib/src/embed/search.d.ts +13 -12
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +3 -3
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +12 -6
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +35 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/react/index.d.ts +15 -15
- package/lib/src/react/index.js +12 -12
- package/lib/src/tokenizedFetch.d.ts +1 -1
- package/lib/src/tokenizedFetch.js +1 -1
- package/lib/src/types.d.ts +294 -255
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +206 -200
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +5 -3
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +55 -0
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils.d.ts +9 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +8 -0
- package/lib/src/utils.js.map +1 -1
- package/package.json +1 -1
- package/src/auth.ts +29 -4
- package/src/css-variables.ts +17 -17
- package/src/embed/app.spec.ts +46 -1
- package/src/embed/app.ts +72 -35
- package/src/embed/base.ts +2 -2
- package/src/embed/bodyless-conversation.ts +5 -5
- package/src/embed/conversation.spec.ts +37 -0
- package/src/embed/conversation.ts +55 -38
- package/src/embed/liveboard.spec.ts +1 -1
- package/src/embed/liveboard.ts +40 -34
- package/src/embed/sage.ts +5 -5
- package/src/embed/search-bar.tsx +7 -7
- package/src/embed/search.ts +13 -12
- package/src/embed/ts-embed.spec.ts +42 -0
- package/src/embed/ts-embed.ts +11 -6
- package/src/react/index.tsx +15 -15
- package/src/tokenizedFetch.ts +1 -1
- package/src/types.ts +293 -254
- package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
- package/src/utils/graphql/answerService/answerService.ts +6 -3
- package/src/utils.ts +14 -0
|
@@ -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
|
/**
|
|
@@ -901,7 +902,7 @@ declare class AnswerService {
|
|
|
901
902
|
setTMLOverride(override: any): void;
|
|
902
903
|
}
|
|
903
904
|
/**
|
|
904
|
-
* The authentication mechanism for allowing access to
|
|
905
|
+
* The authentication mechanism for allowing access to
|
|
905
906
|
* the embedded app
|
|
906
907
|
* @group Authentication / Init
|
|
907
908
|
*/
|
|
@@ -926,6 +927,7 @@ export declare enum AuthType {
|
|
|
926
927
|
* To use this:
|
|
927
928
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
928
929
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
930
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
929
931
|
* @example
|
|
930
932
|
* ```js
|
|
931
933
|
* init({
|
|
@@ -933,18 +935,17 @@ export declare enum AuthType {
|
|
|
933
935
|
* authType: AuthType.EmbeddedSSO,
|
|
934
936
|
* });
|
|
935
937
|
* ```
|
|
936
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
937
938
|
*/
|
|
938
939
|
EmbeddedSSO = "EmbeddedSSO",
|
|
939
940
|
/**
|
|
940
|
-
* SSO using SAML
|
|
941
|
-
* @deprecated
|
|
941
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
942
|
+
* @deprecated This option is deprecated.
|
|
942
943
|
* @hidden
|
|
943
944
|
*/
|
|
944
945
|
SSO = "SSO_SAML",
|
|
945
946
|
/**
|
|
946
|
-
* SSO using SAML
|
|
947
|
-
* @deprecated
|
|
947
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
948
|
+
* @deprecated This option is deprecated.
|
|
948
949
|
* @hidden
|
|
949
950
|
*/
|
|
950
951
|
SAML = "SSO_SAML",
|
|
@@ -995,8 +996,9 @@ export declare enum AuthType {
|
|
|
995
996
|
SAMLRedirect = "SSO_SAML",
|
|
996
997
|
/**
|
|
997
998
|
* SSO using OIDC
|
|
999
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
1000
|
+
* @deprecated This option is deprecated.
|
|
998
1001
|
* @hidden
|
|
999
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
1000
1002
|
*/
|
|
1001
1003
|
OIDC = "SSO_OIDC",
|
|
1002
1004
|
/**
|
|
@@ -1007,8 +1009,9 @@ export declare enum AuthType {
|
|
|
1007
1009
|
OIDCRedirect = "SSO_OIDC",
|
|
1008
1010
|
/**
|
|
1009
1011
|
* Trusted authentication server
|
|
1012
|
+
* Use {@link TrustedAuth} instead
|
|
1013
|
+
* @deprecated This option is deprecated.
|
|
1010
1014
|
* @hidden
|
|
1011
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
1012
1015
|
*/
|
|
1013
1016
|
AuthServer = "AuthServer",
|
|
1014
1017
|
/**
|
|
@@ -1035,6 +1038,7 @@ export declare enum AuthType {
|
|
|
1035
1038
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1036
1039
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1037
1040
|
* implemented by some browsers.
|
|
1041
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1038
1042
|
* @example
|
|
1039
1043
|
* ```js
|
|
1040
1044
|
* init({
|
|
@@ -1045,8 +1049,8 @@ export declare enum AuthType {
|
|
|
1045
1049
|
* .then((response) => response.json())
|
|
1046
1050
|
* .then((data) => data.token);
|
|
1047
1051
|
* }
|
|
1052
|
+
* });
|
|
1048
1053
|
* ```
|
|
1049
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1050
1054
|
*/
|
|
1051
1055
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
1052
1056
|
/**
|
|
@@ -1061,43 +1065,43 @@ 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({
|
|
@@ -1736,7 +1739,7 @@ export interface FrameParams {
|
|
|
1736
1739
|
*/
|
|
1737
1740
|
loading?: "lazy" | "eager" | "auto";
|
|
1738
1741
|
/**
|
|
1739
|
-
*
|
|
1742
|
+
* These parameters will be passed to the iframe
|
|
1740
1743
|
* as is.
|
|
1741
1744
|
*/
|
|
1742
1745
|
[key: string]: string | number | boolean | undefined;
|
|
@@ -1811,8 +1814,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1811
1814
|
*/
|
|
1812
1815
|
disabledActionReason?: string;
|
|
1813
1816
|
/**
|
|
1814
|
-
* The list of actions to hide from the embedded.
|
|
1815
|
-
*
|
|
1817
|
+
* The list of actions to hide from the embedded view.
|
|
1818
|
+
* These actions will be hidden from the user.
|
|
1816
1819
|
* Use this to hide an action.
|
|
1817
1820
|
*
|
|
1818
1821
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
@@ -1853,7 +1856,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1853
1856
|
* The locale settings to apply to the embedded view.
|
|
1854
1857
|
*
|
|
1855
1858
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1856
|
-
* @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
|
|
1857
1860
|
* @example
|
|
1858
1861
|
* ```js
|
|
1859
1862
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1868,12 +1871,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1868
1871
|
* This is an object (key/val) of override flags which will be applied
|
|
1869
1872
|
* to the internal embedded object. This can be used to add any
|
|
1870
1873
|
* URL flag.
|
|
1871
|
-
* 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.
|
|
1872
1875
|
* Warning: This option is for advanced use only and is used internally
|
|
1873
1876
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1874
1877
|
* list of supported keys and values associated with each.
|
|
1875
1878
|
*
|
|
1876
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
|
|
1877
1881
|
* @example
|
|
1878
1882
|
* ```js
|
|
1879
1883
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1885,7 +1889,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1885
1889
|
* },
|
|
1886
1890
|
* });
|
|
1887
1891
|
* ```
|
|
1888
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1889
1892
|
*/
|
|
1890
1893
|
additionalFlags?: {
|
|
1891
1894
|
[key: string]: string | number | boolean;
|
|
@@ -1928,6 +1931,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1928
1931
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1929
1932
|
*
|
|
1930
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
|
|
1931
1935
|
* @example
|
|
1932
1936
|
* ```js
|
|
1933
1937
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1937,7 +1941,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1937
1941
|
* });
|
|
1938
1942
|
* embed.showPreRender();
|
|
1939
1943
|
* ```
|
|
1940
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1941
1944
|
*/
|
|
1942
1945
|
preRenderId?: string;
|
|
1943
1946
|
/**
|
|
@@ -1947,7 +1950,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1947
1950
|
* its dimensions based on changes to the size of the embedding element.
|
|
1948
1951
|
* @type {boolean}
|
|
1949
1952
|
* @default false
|
|
1950
|
-
* @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
|
|
1951
1954
|
* @example
|
|
1952
1955
|
* ```js
|
|
1953
1956
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -1962,9 +1965,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1962
1965
|
doNotTrackPreRenderSize?: boolean;
|
|
1963
1966
|
/**
|
|
1964
1967
|
* Enable the V2 shell. This can provide performance benefits
|
|
1965
|
-
* due to a
|
|
1968
|
+
* due to a lighter-weight shell.
|
|
1966
1969
|
*
|
|
1967
1970
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1971
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1968
1972
|
* @example
|
|
1969
1973
|
* ```js
|
|
1970
1974
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1973,7 +1977,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1973
1977
|
* enableV2Shell_experimental: true,
|
|
1974
1978
|
* });
|
|
1975
1979
|
* ```
|
|
1976
|
-
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1977
1980
|
*/
|
|
1978
1981
|
enableV2Shell_experimental?: boolean;
|
|
1979
1982
|
/**
|
|
@@ -1992,6 +1995,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1992
1995
|
* and disable redirection of links in a new tab.
|
|
1993
1996
|
*
|
|
1994
1997
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1998
|
+
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1995
1999
|
* @example
|
|
1996
2000
|
* ```js
|
|
1997
2001
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2000,7 +2004,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2000
2004
|
* disableRedirectionLinksInNewTab: true,
|
|
2001
2005
|
* });
|
|
2002
2006
|
* ```
|
|
2003
|
-
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
2004
2007
|
*/
|
|
2005
2008
|
disableRedirectionLinksInNewTab?: boolean;
|
|
2006
2009
|
/**
|
|
@@ -2011,6 +2014,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2011
2014
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
2012
2015
|
*
|
|
2013
2016
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2017
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
2014
2018
|
* @example
|
|
2015
2019
|
* ```js
|
|
2016
2020
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2019,24 +2023,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2019
2023
|
* overrideOrgId: 142536,
|
|
2020
2024
|
* });
|
|
2021
2025
|
* ```
|
|
2022
|
-
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
2023
2026
|
*/
|
|
2024
2027
|
overrideOrgId?: number;
|
|
2025
2028
|
/**
|
|
2026
|
-
* Flag to override the *Open Link in New Tab* context
|
|
2029
|
+
* Flag to override the *Open Link in New Tab* context
|
|
2030
|
+
* menu option.
|
|
2027
2031
|
*
|
|
2028
|
-
*
|
|
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`
|
|
2029
2038
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2030
2039
|
* @example
|
|
2031
2040
|
* ```js
|
|
2032
|
-
*
|
|
2033
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2041
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2034
2042
|
* ... // other embed view config
|
|
2035
|
-
* linkOverride:
|
|
2043
|
+
* linkOverride: true,
|
|
2036
2044
|
* })
|
|
2037
2045
|
* ```
|
|
2038
2046
|
*/
|
|
2039
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;
|
|
2040
2076
|
/**
|
|
2041
2077
|
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
2042
2078
|
* Use this to set the primary action.
|
|
@@ -2061,7 +2097,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2061
2097
|
insertInToSlide?: boolean;
|
|
2062
2098
|
/**
|
|
2063
2099
|
* Show alert messages and toast messages in the embed.
|
|
2064
|
-
* Supported
|
|
2100
|
+
* Supported in all embed types.
|
|
2065
2101
|
*
|
|
2066
2102
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2067
2103
|
* @example
|
|
@@ -2345,7 +2381,7 @@ export interface HomePageConfig {
|
|
|
2345
2381
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
2346
2382
|
*
|
|
2347
2383
|
* Supported embed types: `AppEmbed`
|
|
2348
|
-
* @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
|
|
2349
2385
|
* @example
|
|
2350
2386
|
* ```js
|
|
2351
2387
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2366,6 +2402,7 @@ export interface HomePageConfig {
|
|
|
2366
2402
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
2367
2403
|
*
|
|
2368
2404
|
* Supported embed types: `AppEmbed`
|
|
2405
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2369
2406
|
* @example
|
|
2370
2407
|
* ```js
|
|
2371
2408
|
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2376,7 +2413,6 @@ export interface HomePageConfig {
|
|
|
2376
2413
|
* ... //other embed view configuration attributes
|
|
2377
2414
|
* })
|
|
2378
2415
|
* ```
|
|
2379
|
-
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2380
2416
|
*/
|
|
2381
2417
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2382
2418
|
}
|
|
@@ -2389,7 +2425,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2389
2425
|
* visualization, or Liveboard.
|
|
2390
2426
|
*
|
|
2391
2427
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2392
|
-
* @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
|
|
2393
2429
|
* @example
|
|
2394
2430
|
* ```js
|
|
2395
2431
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2407,11 +2443,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2407
2443
|
*/
|
|
2408
2444
|
runtimeFilters?: RuntimeFilter[];
|
|
2409
2445
|
/**
|
|
2410
|
-
* The list of parameter
|
|
2446
|
+
* The list of parameter overrides to apply to a search Answer,
|
|
2411
2447
|
* visualization, or Liveboard.
|
|
2412
2448
|
*
|
|
2413
2449
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2414
|
-
* @version SDK
|
|
2450
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2415
2451
|
* @example
|
|
2416
2452
|
* ```js
|
|
2417
2453
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2431,6 +2467,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2431
2467
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2432
2468
|
*
|
|
2433
2469
|
* Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
|
|
2470
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2434
2471
|
* @example
|
|
2435
2472
|
* ```js
|
|
2436
2473
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
|
|
@@ -2439,7 +2476,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2439
2476
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
2440
2477
|
* })
|
|
2441
2478
|
* ```
|
|
2442
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2443
2479
|
*/
|
|
2444
2480
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2445
2481
|
/**
|
|
@@ -2462,7 +2498,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2462
2498
|
* when set to false, runtime parameters will be included in the URL
|
|
2463
2499
|
* (default behavior before SDK 1.45.0).
|
|
2464
2500
|
*
|
|
2465
|
-
* Irrespective of this flag, runtime
|
|
2501
|
+
* Irrespective of this flag, runtime parameters (if passed) will be applied to the
|
|
2466
2502
|
* embedded view.
|
|
2467
2503
|
* @default true
|
|
2468
2504
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
@@ -2481,14 +2517,15 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2481
2517
|
* ... // other embed view config
|
|
2482
2518
|
* collapseSearchBar: true,
|
|
2483
2519
|
* });
|
|
2520
|
+
* ```
|
|
2484
2521
|
*/
|
|
2485
2522
|
collapseSearchBar?: boolean;
|
|
2486
2523
|
/**
|
|
2487
2524
|
* Flag to control Data panel experience
|
|
2488
2525
|
*
|
|
2489
2526
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2527
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2490
2528
|
* @default true
|
|
2491
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2492
2529
|
* @example
|
|
2493
2530
|
* ```js
|
|
2494
2531
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -2521,6 +2558,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2521
2558
|
* the current time period in filter results.
|
|
2522
2559
|
*
|
|
2523
2560
|
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2561
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2524
2562
|
* @example
|
|
2525
2563
|
* ```js
|
|
2526
2564
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
@@ -2528,7 +2566,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2528
2566
|
* isThisPeriodInDateFiltersEnabled: true,
|
|
2529
2567
|
* })
|
|
2530
2568
|
* ```
|
|
2531
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2532
2569
|
*/
|
|
2533
2570
|
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
2534
2571
|
}
|
|
@@ -2588,6 +2625,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2588
2625
|
* Boolean to control if Liveboard header is sticky or not.
|
|
2589
2626
|
*
|
|
2590
2627
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2628
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2591
2629
|
* @example
|
|
2592
2630
|
* ```js
|
|
2593
2631
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2596,7 +2634,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2596
2634
|
* isLiveboardHeaderSticky: true,
|
|
2597
2635
|
* });
|
|
2598
2636
|
* ```
|
|
2599
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2600
2637
|
*/
|
|
2601
2638
|
isLiveboardHeaderSticky?: boolean;
|
|
2602
2639
|
/**
|
|
@@ -2604,8 +2641,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2604
2641
|
*
|
|
2605
2642
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2606
2643
|
* @type {boolean}
|
|
2644
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
|
|
2607
2645
|
* @default false
|
|
2608
|
-
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
2609
2646
|
* @example
|
|
2610
2647
|
* ```js
|
|
2611
2648
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2621,8 +2658,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2621
2658
|
*
|
|
2622
2659
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2623
2660
|
* @type {boolean}
|
|
2661
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
|
|
2624
2662
|
* @default false
|
|
2625
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
|
|
2626
2663
|
* @example
|
|
2627
2664
|
* ```js
|
|
2628
2665
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2638,7 +2675,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2638
2675
|
* header.
|
|
2639
2676
|
*
|
|
2640
2677
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2641
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2678
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2642
2679
|
* @default true
|
|
2643
2680
|
* @example
|
|
2644
2681
|
* ```js
|
|
@@ -2656,7 +2693,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2656
2693
|
* **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
|
|
2657
2694
|
*
|
|
2658
2695
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2659
|
-
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
2696
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2660
2697
|
* @default false
|
|
2661
2698
|
* @example
|
|
2662
2699
|
* ```js
|
|
@@ -2674,7 +2711,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2674
2711
|
* compact header
|
|
2675
2712
|
*
|
|
2676
2713
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2677
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2714
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2678
2715
|
* @default true
|
|
2679
2716
|
* @example
|
|
2680
2717
|
* ```js
|
|
@@ -2707,7 +2744,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2707
2744
|
* the cover and filters pages in the Liveboard PDF.
|
|
2708
2745
|
*
|
|
2709
2746
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2710
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
2747
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
|
|
2711
2748
|
* @example
|
|
2712
2749
|
* ```js
|
|
2713
2750
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2903,7 +2940,7 @@ declare enum HomepageModule {
|
|
|
2903
2940
|
*/
|
|
2904
2941
|
Search = "SEARCH",
|
|
2905
2942
|
/**
|
|
2906
|
-
*
|
|
2943
|
+
* KPI watchlist module
|
|
2907
2944
|
*/
|
|
2908
2945
|
Watchlist = "WATCHLIST",
|
|
2909
2946
|
/**
|
|
@@ -2929,7 +2966,8 @@ declare enum ListPageColumns {
|
|
|
2929
2966
|
*/
|
|
2930
2967
|
Favorites = "FAVOURITE",
|
|
2931
2968
|
/**
|
|
2932
|
-
*
|
|
2969
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
2970
|
+
* @deprecated This option is deprecated.
|
|
2933
2971
|
*/
|
|
2934
2972
|
Favourite = "FAVOURITE",
|
|
2935
2973
|
/**
|
|
@@ -3030,13 +3068,13 @@ export declare enum EmbedEvent {
|
|
|
3030
3068
|
/**
|
|
3031
3069
|
* Rendering has initialized.
|
|
3032
3070
|
* @example
|
|
3033
|
-
|
|
3071
|
+
* ```js
|
|
3034
3072
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
3035
3073
|
* //show a loader
|
|
3036
3074
|
* function showLoader() {
|
|
3037
3075
|
* document.getElementById("loader");
|
|
3038
3076
|
* }
|
|
3039
|
-
|
|
3077
|
+
* ```
|
|
3040
3078
|
* @returns timestamp - The timestamp when the event was generated.
|
|
3041
3079
|
*/
|
|
3042
3080
|
Init = "init",
|
|
@@ -3044,11 +3082,11 @@ export declare enum EmbedEvent {
|
|
|
3044
3082
|
* Authentication has either succeeded or failed.
|
|
3045
3083
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3046
3084
|
* @example
|
|
3047
|
-
|
|
3085
|
+
* ```js
|
|
3048
3086
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
3049
3087
|
* console.log('AuthInit', payload);
|
|
3050
3088
|
* })
|
|
3051
|
-
|
|
3089
|
+
* ```
|
|
3052
3090
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
3053
3091
|
*/
|
|
3054
3092
|
AuthInit = "authInit",
|
|
@@ -3057,13 +3095,13 @@ export declare enum EmbedEvent {
|
|
|
3057
3095
|
* @returns timestamp - The timestamp when the event was generated.
|
|
3058
3096
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3059
3097
|
* @example
|
|
3060
|
-
|
|
3098
|
+
* ```js
|
|
3061
3099
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
3062
3100
|
* //hide loader
|
|
3063
3101
|
* function hideLoader() {
|
|
3064
3102
|
* document.getElementById("loader");
|
|
3065
3103
|
* }
|
|
3066
|
-
|
|
3104
|
+
* ```
|
|
3067
3105
|
*/
|
|
3068
3106
|
Load = "load",
|
|
3069
3107
|
/**
|
|
@@ -3072,11 +3110,11 @@ export declare enum EmbedEvent {
|
|
|
3072
3110
|
* @return data - Answer of Liveboard data
|
|
3073
3111
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3074
3112
|
* @example
|
|
3075
|
-
|
|
3113
|
+
* ```js
|
|
3076
3114
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
3077
3115
|
* console.log('data', payload);
|
|
3078
3116
|
* })
|
|
3079
|
-
|
|
3117
|
+
* ```
|
|
3080
3118
|
* @important
|
|
3081
3119
|
*/
|
|
3082
3120
|
Data = "data",
|
|
@@ -3084,9 +3122,9 @@ export declare enum EmbedEvent {
|
|
|
3084
3122
|
* Search query has been updated by the user.
|
|
3085
3123
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3086
3124
|
* @example
|
|
3087
|
-
|
|
3125
|
+
* ```js
|
|
3088
3126
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
3089
|
-
|
|
3127
|
+
* ```
|
|
3090
3128
|
*/
|
|
3091
3129
|
QueryChanged = "queryChanged",
|
|
3092
3130
|
/**
|
|
@@ -3096,7 +3134,7 @@ export declare enum EmbedEvent {
|
|
|
3096
3134
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
3097
3135
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
3098
3136
|
* @example
|
|
3099
|
-
|
|
3137
|
+
* ```js
|
|
3100
3138
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
3101
3139
|
* points: {
|
|
3102
3140
|
* clickedPoint,
|
|
@@ -3104,12 +3142,12 @@ export declare enum EmbedEvent {
|
|
|
3104
3142
|
* },
|
|
3105
3143
|
* autoDrillDown: true,
|
|
3106
3144
|
* })
|
|
3107
|
-
|
|
3145
|
+
* ```
|
|
3108
3146
|
* In this example, `VizPointDoubleClick` event is used for
|
|
3109
3147
|
* triggering the `DrillDown` event when an area or specific
|
|
3110
3148
|
* data point on a table or chart is double-clicked.
|
|
3111
3149
|
* @example
|
|
3112
|
-
|
|
3150
|
+
* ```js
|
|
3113
3151
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
3114
3152
|
* console.log(payload);
|
|
3115
3153
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -3123,7 +3161,7 @@ export declare enum EmbedEvent {
|
|
|
3123
3161
|
* autoDrillDown: true,
|
|
3124
3162
|
* })
|
|
3125
3163
|
* })
|
|
3126
|
-
|
|
3164
|
+
* ```
|
|
3127
3165
|
*/
|
|
3128
3166
|
Drilldown = "drillDown",
|
|
3129
3167
|
/**
|
|
@@ -3248,13 +3286,13 @@ export declare enum EmbedEvent {
|
|
|
3248
3286
|
* The ThoughtSpot authentication session has expired.
|
|
3249
3287
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3250
3288
|
* @example
|
|
3251
|
-
|
|
3289
|
+
* ```js
|
|
3252
3290
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
3253
3291
|
* //show auth expired banner
|
|
3254
3292
|
* function showAuthExpired() {
|
|
3255
3293
|
* document.getElementById("authExpiredBanner");
|
|
3256
3294
|
* }
|
|
3257
|
-
|
|
3295
|
+
* ```
|
|
3258
3296
|
*/
|
|
3259
3297
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
3260
3298
|
/**
|
|
@@ -3289,22 +3327,22 @@ export declare enum EmbedEvent {
|
|
|
3289
3327
|
* Applicable to `SearchBarEmbed` only.
|
|
3290
3328
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3291
3329
|
* @example
|
|
3292
|
-
|
|
3330
|
+
* ```js
|
|
3293
3331
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
3294
3332
|
* .then(data => {
|
|
3295
3333
|
* console.log('Answer Data:', data);
|
|
3296
3334
|
* })
|
|
3297
|
-
|
|
3335
|
+
* ```
|
|
3298
3336
|
*/
|
|
3299
3337
|
GetDataClick = "getDataClick",
|
|
3300
3338
|
/**
|
|
3301
3339
|
* Detects the route change.
|
|
3302
3340
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3303
3341
|
* @example
|
|
3304
|
-
|
|
3342
|
+
* ```js
|
|
3305
3343
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
3306
3344
|
* console.log('data', payload))
|
|
3307
|
-
|
|
3345
|
+
* ```
|
|
3308
3346
|
*/
|
|
3309
3347
|
RouteChange = "ROUTE_CHANGE",
|
|
3310
3348
|
/**
|
|
@@ -3314,12 +3352,12 @@ export declare enum EmbedEvent {
|
|
|
3314
3352
|
V1Data = "exportVizDataToParent",
|
|
3315
3353
|
/**
|
|
3316
3354
|
* Emitted when the embed does not have cookie access. This happens
|
|
3317
|
-
* when
|
|
3318
|
-
*
|
|
3355
|
+
* when third-party cookies are blocked by Safari or other
|
|
3356
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
3319
3357
|
* @example
|
|
3320
|
-
|
|
3358
|
+
* ```js
|
|
3321
3359
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
3322
|
-
|
|
3360
|
+
* ```
|
|
3323
3361
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
3324
3362
|
*/
|
|
3325
3363
|
NoCookieAccess = "noCookieAccess",
|
|
@@ -3333,22 +3371,22 @@ export declare enum EmbedEvent {
|
|
|
3333
3371
|
* Emitted when any modal is opened in the app
|
|
3334
3372
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3335
3373
|
* @example
|
|
3336
|
-
|
|
3374
|
+
* ```js
|
|
3337
3375
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
3338
3376
|
* console.log('dialog open', payload);
|
|
3339
3377
|
* })
|
|
3340
|
-
|
|
3378
|
+
* ```
|
|
3341
3379
|
*/
|
|
3342
3380
|
DialogOpen = "dialog-open",
|
|
3343
3381
|
/**
|
|
3344
3382
|
* Emitted when any modal is closed in the app
|
|
3345
3383
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3346
3384
|
* @example
|
|
3347
|
-
|
|
3385
|
+
* ```js
|
|
3348
3386
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
3349
3387
|
* console.log('dialog close', payload);
|
|
3350
3388
|
* })
|
|
3351
|
-
|
|
3389
|
+
* ```
|
|
3352
3390
|
*/
|
|
3353
3391
|
DialogClose = "dialog-close",
|
|
3354
3392
|
/**
|
|
@@ -3357,39 +3395,39 @@ export declare enum EmbedEvent {
|
|
|
3357
3395
|
* other events on the rendered Liveboard.
|
|
3358
3396
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3359
3397
|
* @example
|
|
3360
|
-
|
|
3398
|
+
* ```js
|
|
3361
3399
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
3362
3400
|
console.log('Liveboard is rendered', payload);
|
|
3363
3401
|
})
|
|
3364
|
-
|
|
3402
|
+
* ```
|
|
3365
3403
|
* The following example shows how to trigger
|
|
3366
3404
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
3367
3405
|
* @example
|
|
3368
|
-
|
|
3406
|
+
* ```js
|
|
3369
3407
|
* const embedRef = useEmbedRef();
|
|
3370
3408
|
* const onLiveboardRendered = () => {
|
|
3371
3409
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
3372
3410
|
* };
|
|
3373
|
-
|
|
3411
|
+
* ```
|
|
3374
3412
|
*/
|
|
3375
3413
|
LiveboardRendered = "PinboardRendered",
|
|
3376
3414
|
/**
|
|
3377
3415
|
* Emits all events.
|
|
3378
|
-
* @
|
|
3416
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3379
3417
|
* @example
|
|
3380
|
-
|
|
3418
|
+
* ```js
|
|
3381
3419
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
3382
3420
|
* console.log('Embed Events', payload)
|
|
3383
3421
|
* })
|
|
3384
|
-
|
|
3422
|
+
* ```
|
|
3385
3423
|
*/
|
|
3386
3424
|
ALL = "*",
|
|
3387
3425
|
/**
|
|
3388
3426
|
* Emitted when an Answer is saved in the app.
|
|
3389
3427
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
3390
|
-
* @
|
|
3428
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3391
3429
|
* @example
|
|
3392
|
-
|
|
3430
|
+
* ```js
|
|
3393
3431
|
* //Emit when action starts
|
|
3394
3432
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3395
3433
|
* console.log('Save', payload)
|
|
@@ -3400,7 +3438,7 @@ export declare enum EmbedEvent {
|
|
|
3400
3438
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3401
3439
|
* console.log('Save', payload)
|
|
3402
3440
|
* })
|
|
3403
|
-
|
|
3441
|
+
* ```
|
|
3404
3442
|
*/
|
|
3405
3443
|
Save = "save",
|
|
3406
3444
|
/**
|
|
@@ -3412,11 +3450,11 @@ export declare enum EmbedEvent {
|
|
|
3412
3450
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
3413
3451
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3414
3452
|
* @example
|
|
3415
|
-
|
|
3453
|
+
* ```js
|
|
3416
3454
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
3417
3455
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3418
3456
|
* })
|
|
3419
|
-
|
|
3457
|
+
* ```
|
|
3420
3458
|
*/
|
|
3421
3459
|
Download = "download",
|
|
3422
3460
|
/**
|
|
@@ -3424,14 +3462,14 @@ export declare enum EmbedEvent {
|
|
|
3424
3462
|
* Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
|
|
3425
3463
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3426
3464
|
* @example
|
|
3427
|
-
|
|
3465
|
+
* ```js
|
|
3428
3466
|
* //emit when action starts
|
|
3429
3467
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3430
3468
|
* console.log('download PNG', payload)}, {start: true })
|
|
3431
3469
|
* //emit when action ends
|
|
3432
3470
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3433
3471
|
* console.log('download PNG', payload)})
|
|
3434
|
-
|
|
3472
|
+
* ```
|
|
3435
3473
|
*/
|
|
3436
3474
|
DownloadAsPng = "downloadAsPng",
|
|
3437
3475
|
/**
|
|
@@ -3439,14 +3477,14 @@ export declare enum EmbedEvent {
|
|
|
3439
3477
|
* 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.
|
|
3440
3478
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3441
3479
|
* @example
|
|
3442
|
-
|
|
3480
|
+
* ```js
|
|
3443
3481
|
* //emit when action starts
|
|
3444
3482
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3445
3483
|
* console.log('download PDF', payload)}, {start: true })
|
|
3446
3484
|
* //emit when action ends
|
|
3447
3485
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3448
3486
|
* console.log('download PDF', payload)})
|
|
3449
|
-
|
|
3487
|
+
* ```
|
|
3450
3488
|
*/
|
|
3451
3489
|
DownloadAsPdf = "downloadAsPdf",
|
|
3452
3490
|
/**
|
|
@@ -3454,14 +3492,14 @@ export declare enum EmbedEvent {
|
|
|
3454
3492
|
* 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.
|
|
3455
3493
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3456
3494
|
* @example
|
|
3457
|
-
|
|
3495
|
+
* ```js
|
|
3458
3496
|
* //emit when action starts
|
|
3459
3497
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3460
3498
|
* console.log('download CSV', payload)}, {start: true })
|
|
3461
3499
|
* //emit when action ends
|
|
3462
3500
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3463
3501
|
* console.log('download CSV', payload)})
|
|
3464
|
-
|
|
3502
|
+
* ```
|
|
3465
3503
|
*/
|
|
3466
3504
|
DownloadAsCsv = "downloadAsCsv",
|
|
3467
3505
|
/**
|
|
@@ -3469,14 +3507,14 @@ export declare enum EmbedEvent {
|
|
|
3469
3507
|
* 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.
|
|
3470
3508
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3471
3509
|
* @example
|
|
3472
|
-
|
|
3510
|
+
* ```js
|
|
3473
3511
|
* //emit when action starts
|
|
3474
3512
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3475
3513
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
3476
3514
|
* //emit when action ends
|
|
3477
3515
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3478
3516
|
* console.log('download Xlsx', payload)})
|
|
3479
|
-
|
|
3517
|
+
* ```
|
|
3480
3518
|
*/
|
|
3481
3519
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3482
3520
|
/**
|
|
@@ -3484,25 +3522,25 @@ export declare enum EmbedEvent {
|
|
|
3484
3522
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
|
|
3485
3523
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3486
3524
|
* @example
|
|
3487
|
-
|
|
3525
|
+
* ```js
|
|
3488
3526
|
* //emit when action starts
|
|
3489
3527
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3490
3528
|
* console.log('delete answer', payload)}, {start: true })
|
|
3491
3529
|
* //trigger when action is completed
|
|
3492
3530
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3493
3531
|
* console.log('delete answer', payload)})
|
|
3494
|
-
|
|
3532
|
+
* ```
|
|
3495
3533
|
*/
|
|
3496
3534
|
AnswerDelete = "answerDelete",
|
|
3497
3535
|
/**
|
|
3498
3536
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
3499
3537
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
3500
3538
|
* @example
|
|
3501
|
-
|
|
3539
|
+
* ```js
|
|
3502
3540
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
3503
3541
|
* console.log('AI Highlights', payload);
|
|
3504
3542
|
* })
|
|
3505
|
-
|
|
3543
|
+
* ```
|
|
3506
3544
|
*/
|
|
3507
3545
|
AIHighlights = "AIHighlights",
|
|
3508
3546
|
/**
|
|
@@ -3511,7 +3549,7 @@ export declare enum EmbedEvent {
|
|
|
3511
3549
|
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
|
|
3512
3550
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3513
3551
|
* @example
|
|
3514
|
-
|
|
3552
|
+
* ```js
|
|
3515
3553
|
* //emit when action starts
|
|
3516
3554
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3517
3555
|
* console.log('pin', payload)
|
|
@@ -3522,14 +3560,14 @@ export declare enum EmbedEvent {
|
|
|
3522
3560
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3523
3561
|
* console.log('pin', payload)
|
|
3524
3562
|
* })
|
|
3525
|
-
|
|
3563
|
+
* ```
|
|
3526
3564
|
*/
|
|
3527
3565
|
Pin = "pin",
|
|
3528
3566
|
/**
|
|
3529
3567
|
* Emitted when SpotIQ analysis is triggered
|
|
3530
3568
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3531
3569
|
* @example
|
|
3532
|
-
|
|
3570
|
+
* ```js
|
|
3533
3571
|
* //emit when action starts
|
|
3534
3572
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3535
3573
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -3540,14 +3578,14 @@ export declare enum EmbedEvent {
|
|
|
3540
3578
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3541
3579
|
* console.log('SpotIQ analyze', payload)
|
|
3542
3580
|
* })
|
|
3543
|
-
|
|
3581
|
+
* ```
|
|
3544
3582
|
*/
|
|
3545
3583
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3546
3584
|
/**
|
|
3547
3585
|
* Emitted when a user shares an object with another user or group
|
|
3548
3586
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3549
3587
|
* @example
|
|
3550
|
-
|
|
3588
|
+
* ```js
|
|
3551
3589
|
* //emit when action starts
|
|
3552
3590
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3553
3591
|
* console.log('Share', payload)
|
|
@@ -3558,7 +3596,7 @@ export declare enum EmbedEvent {
|
|
|
3558
3596
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3559
3597
|
* console.log('Share', payload)
|
|
3560
3598
|
* })
|
|
3561
|
-
|
|
3599
|
+
* ```
|
|
3562
3600
|
*/
|
|
3563
3601
|
Share = "share",
|
|
3564
3602
|
/**
|
|
@@ -3566,11 +3604,11 @@ export declare enum EmbedEvent {
|
|
|
3566
3604
|
* data on a chart or table.
|
|
3567
3605
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3568
3606
|
* @example
|
|
3569
|
-
|
|
3607
|
+
* ```js
|
|
3570
3608
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
3571
3609
|
* console.log('Drill include', payload);
|
|
3572
3610
|
* })
|
|
3573
|
-
|
|
3611
|
+
* ```
|
|
3574
3612
|
*/
|
|
3575
3613
|
DrillInclude = "context-menu-item-include",
|
|
3576
3614
|
/**
|
|
@@ -3578,22 +3616,22 @@ export declare enum EmbedEvent {
|
|
|
3578
3616
|
* data on a chart or table
|
|
3579
3617
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3580
3618
|
* @example
|
|
3581
|
-
|
|
3619
|
+
* ```js
|
|
3582
3620
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
3583
3621
|
* console.log('Drill exclude', payload);
|
|
3584
3622
|
* })
|
|
3585
|
-
|
|
3623
|
+
* ```
|
|
3586
3624
|
*/
|
|
3587
3625
|
DrillExclude = "context-menu-item-exclude",
|
|
3588
3626
|
/**
|
|
3589
3627
|
* Emitted when a column value is copied in the embedded app.
|
|
3590
3628
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3591
3629
|
* @example
|
|
3592
|
-
|
|
3593
|
-
*
|
|
3630
|
+
* ```js
|
|
3631
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
3594
3632
|
* console.log('copy to clipboard', payload);
|
|
3595
3633
|
* })
|
|
3596
|
-
|
|
3634
|
+
* ```
|
|
3597
3635
|
*/
|
|
3598
3636
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3599
3637
|
/**
|
|
@@ -3601,10 +3639,10 @@ export declare enum EmbedEvent {
|
|
|
3601
3639
|
* embedded Liveboard.
|
|
3602
3640
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3603
3641
|
* @example
|
|
3604
|
-
|
|
3642
|
+
* ```js
|
|
3605
3643
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
3606
3644
|
* })
|
|
3607
|
-
|
|
3645
|
+
* ```
|
|
3608
3646
|
*/
|
|
3609
3647
|
UpdateTML = "updateTSL",
|
|
3610
3648
|
/**
|
|
@@ -3612,11 +3650,11 @@ export declare enum EmbedEvent {
|
|
|
3612
3650
|
* on an embedded Liveboard.
|
|
3613
3651
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3614
3652
|
* @example
|
|
3615
|
-
|
|
3653
|
+
* ```js
|
|
3616
3654
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
3617
3655
|
* console.log('Edit TML', payload);
|
|
3618
3656
|
* })
|
|
3619
|
-
|
|
3657
|
+
* ```
|
|
3620
3658
|
*/
|
|
3621
3659
|
EditTML = "editTSL",
|
|
3622
3660
|
/**
|
|
@@ -3625,25 +3663,25 @@ export declare enum EmbedEvent {
|
|
|
3625
3663
|
* Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
|
|
3626
3664
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3627
3665
|
* @example
|
|
3628
|
-
|
|
3666
|
+
* ```js
|
|
3629
3667
|
* //emit when action starts
|
|
3630
3668
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3631
3669
|
* console.log('Export TML', payload)}, { start: true })
|
|
3632
3670
|
* //emit when action ends
|
|
3633
3671
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3634
3672
|
* console.log('Export TML', payload)})
|
|
3635
|
-
|
|
3673
|
+
* ```
|
|
3636
3674
|
*/
|
|
3637
3675
|
ExportTML = "exportTSL",
|
|
3638
3676
|
/**
|
|
3639
3677
|
* Emitted when an Answer is saved as a View.
|
|
3640
3678
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3641
3679
|
* @example
|
|
3642
|
-
|
|
3680
|
+
* ```js
|
|
3643
3681
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
3644
3682
|
* console.log('View', payload);
|
|
3645
3683
|
* })
|
|
3646
|
-
|
|
3684
|
+
* ```
|
|
3647
3685
|
*/
|
|
3648
3686
|
SaveAsView = "saveAsView",
|
|
3649
3687
|
/**
|
|
@@ -3651,36 +3689,36 @@ export declare enum EmbedEvent {
|
|
|
3651
3689
|
* 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.
|
|
3652
3690
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3653
3691
|
* @example
|
|
3654
|
-
|
|
3692
|
+
* ```js
|
|
3655
3693
|
* //emit when action starts
|
|
3656
3694
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3657
3695
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
3658
3696
|
* //emit when action ends
|
|
3659
3697
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3660
3698
|
* console.log('Copy and edit', payload)})
|
|
3661
|
-
|
|
3699
|
+
* ```
|
|
3662
3700
|
*/
|
|
3663
3701
|
CopyAEdit = "copyAEdit",
|
|
3664
3702
|
/**
|
|
3665
3703
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
3666
3704
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3667
3705
|
* @example
|
|
3668
|
-
|
|
3706
|
+
* ```js
|
|
3669
3707
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
3670
3708
|
* console.log('show data', payload);
|
|
3671
3709
|
* })
|
|
3672
|
-
|
|
3710
|
+
* ```
|
|
3673
3711
|
*/
|
|
3674
3712
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3675
3713
|
/**
|
|
3676
3714
|
* Emitted when an Answer is switched to a chart or table view.
|
|
3677
3715
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3678
3716
|
* @example
|
|
3679
|
-
|
|
3717
|
+
* ```js
|
|
3680
3718
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
3681
3719
|
* console.log('switch view', payload);
|
|
3682
3720
|
* })
|
|
3683
|
-
|
|
3721
|
+
* ```
|
|
3684
3722
|
*/
|
|
3685
3723
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3686
3724
|
/**
|
|
@@ -3697,118 +3735,118 @@ export declare enum EmbedEvent {
|
|
|
3697
3735
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3698
3736
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3699
3737
|
* @example
|
|
3700
|
-
|
|
3738
|
+
* ```js
|
|
3701
3739
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
3702
3740
|
* console.log('Liveboard details', payload);
|
|
3703
3741
|
* })
|
|
3704
|
-
|
|
3742
|
+
* ```
|
|
3705
3743
|
*/
|
|
3706
3744
|
LiveboardInfo = "pinboardInfo",
|
|
3707
3745
|
/**
|
|
3708
3746
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3709
3747
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3710
3748
|
* @example
|
|
3711
|
-
|
|
3749
|
+
* ```js
|
|
3712
3750
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
3713
3751
|
* console.log('favorites', payload);
|
|
3714
3752
|
* })
|
|
3715
|
-
|
|
3753
|
+
* ```
|
|
3716
3754
|
*/
|
|
3717
3755
|
AddToFavorites = "addToFavorites",
|
|
3718
3756
|
/**
|
|
3719
3757
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3720
3758
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3721
3759
|
* @example
|
|
3722
|
-
|
|
3760
|
+
* ```js
|
|
3723
3761
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
3724
|
-
* console.log(
|
|
3762
|
+
* console.log('Liveboard schedule', payload);
|
|
3725
3763
|
* })
|
|
3726
|
-
|
|
3764
|
+
* ```
|
|
3727
3765
|
*/
|
|
3728
3766
|
Schedule = "subscription",
|
|
3729
3767
|
/**
|
|
3730
3768
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3731
3769
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3732
3770
|
* @example
|
|
3733
|
-
|
|
3771
|
+
* ```js
|
|
3734
3772
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
3735
|
-
* console.log(
|
|
3773
|
+
* console.log('Liveboard edit', payload);
|
|
3736
3774
|
* })
|
|
3737
|
-
|
|
3775
|
+
* ```
|
|
3738
3776
|
*/
|
|
3739
3777
|
Edit = "edit",
|
|
3740
3778
|
/**
|
|
3741
3779
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3742
3780
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3743
3781
|
* @example
|
|
3744
|
-
|
|
3782
|
+
* ```js
|
|
3745
3783
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
3746
|
-
* console.log(
|
|
3784
|
+
* console.log('Copy', payload);
|
|
3747
3785
|
* })
|
|
3748
|
-
|
|
3786
|
+
* ```
|
|
3749
3787
|
*/
|
|
3750
3788
|
MakeACopy = "makeACopy",
|
|
3751
3789
|
/**
|
|
3752
3790
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3753
3791
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3754
3792
|
* @example
|
|
3755
|
-
|
|
3793
|
+
* ```js
|
|
3756
3794
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
3757
|
-
|
|
3795
|
+
* ```
|
|
3758
3796
|
* @example
|
|
3759
|
-
|
|
3797
|
+
* ```js
|
|
3760
3798
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
3761
3799
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3762
3800
|
* })
|
|
3763
|
-
|
|
3801
|
+
* ```
|
|
3764
3802
|
*/
|
|
3765
3803
|
Present = "present",
|
|
3766
3804
|
/**
|
|
3767
3805
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3768
3806
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3769
3807
|
* @example
|
|
3770
|
-
|
|
3808
|
+
* ```js
|
|
3771
3809
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
3772
3810
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3773
|
-
|
|
3811
|
+
* ```
|
|
3774
3812
|
*/
|
|
3775
3813
|
Delete = "delete",
|
|
3776
3814
|
/**
|
|
3777
3815
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3778
3816
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3779
3817
|
* @example
|
|
3780
|
-
|
|
3818
|
+
* ```js
|
|
3781
3819
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
3782
|
-
|
|
3820
|
+
* ```
|
|
3783
3821
|
*/
|
|
3784
3822
|
SchedulesList = "schedule-list",
|
|
3785
3823
|
/**
|
|
3786
3824
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3787
3825
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3788
3826
|
* @example
|
|
3789
|
-
|
|
3827
|
+
* ```js
|
|
3790
3828
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
3791
|
-
|
|
3829
|
+
* ```
|
|
3792
3830
|
*/
|
|
3793
3831
|
Cancel = "cancel",
|
|
3794
3832
|
/**
|
|
3795
3833
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3796
3834
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3797
3835
|
* @example
|
|
3798
|
-
|
|
3836
|
+
* ```js
|
|
3799
3837
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3800
3838
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3801
|
-
|
|
3839
|
+
* ```
|
|
3802
3840
|
*/
|
|
3803
3841
|
Explore = "explore",
|
|
3804
3842
|
/**
|
|
3805
3843
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
3806
3844
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3807
3845
|
* @example
|
|
3808
|
-
|
|
3846
|
+
* ```js
|
|
3809
3847
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3810
3848
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3811
|
-
|
|
3849
|
+
* ```
|
|
3812
3850
|
*/
|
|
3813
3851
|
CopyLink = "embedDocument",
|
|
3814
3852
|
/**
|
|
@@ -3816,21 +3854,21 @@ export declare enum EmbedEvent {
|
|
|
3816
3854
|
* visualization or Liveboard.
|
|
3817
3855
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3818
3856
|
* @example
|
|
3819
|
-
|
|
3857
|
+
* ```js
|
|
3820
3858
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3821
3859
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3822
|
-
|
|
3860
|
+
* ```
|
|
3823
3861
|
*/
|
|
3824
3862
|
CrossFilterChanged = "cross-filter-changed",
|
|
3825
3863
|
/**
|
|
3826
3864
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3827
3865
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3828
3866
|
* @example
|
|
3829
|
-
|
|
3867
|
+
* ```js
|
|
3830
3868
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
3831
3869
|
* console.log('VizPointClick', payload)
|
|
3832
3870
|
* })
|
|
3833
|
-
|
|
3871
|
+
* ```
|
|
3834
3872
|
*/
|
|
3835
3873
|
VizPointRightClick = "vizPointRightClick",
|
|
3836
3874
|
/**
|
|
@@ -3844,35 +3882,35 @@ export declare enum EmbedEvent {
|
|
|
3844
3882
|
* filter details.
|
|
3845
3883
|
* @example
|
|
3846
3884
|
*
|
|
3847
|
-
|
|
3885
|
+
* ```js
|
|
3848
3886
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3849
3887
|
* console.log('payload', payload);
|
|
3850
3888
|
* })
|
|
3851
|
-
*
|
|
3889
|
+
* ```
|
|
3852
3890
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3853
3891
|
*/
|
|
3854
3892
|
FilterChanged = "filterChanged",
|
|
3855
3893
|
/**
|
|
3856
3894
|
* Emitted when a user clicks the **Go** button to initiate
|
|
3857
3895
|
* a Natural Language Search query
|
|
3858
|
-
* @version SDK
|
|
3896
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3859
3897
|
*/
|
|
3860
3898
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3861
3899
|
/**
|
|
3862
3900
|
* Emitted when a user selects a data source on the embedded
|
|
3863
3901
|
* Natural Language Search interface.
|
|
3864
3902
|
*
|
|
3865
|
-
* @version SDK
|
|
3903
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3866
3904
|
*/
|
|
3867
3905
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3868
3906
|
/**
|
|
3869
3907
|
* Emitted when a user updates a connection on the **Data** page
|
|
3870
|
-
* @version SDK
|
|
3908
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3871
3909
|
*/
|
|
3872
3910
|
UpdateConnection = "updateConnection",
|
|
3873
3911
|
/**
|
|
3874
3912
|
* Emitted when a user updates a connection on the **Data** page
|
|
3875
|
-
* @version SDK
|
|
3913
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3876
3914
|
*/
|
|
3877
3915
|
CreateConnection = "createConnection",
|
|
3878
3916
|
/**
|
|
@@ -3882,7 +3920,7 @@ export declare enum EmbedEvent {
|
|
|
3882
3920
|
* @returns viewId: string
|
|
3883
3921
|
* @returns liveboardId: string
|
|
3884
3922
|
* @returns isPublic: boolean
|
|
3885
|
-
* @version SDK
|
|
3923
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3886
3924
|
*/
|
|
3887
3925
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3888
3926
|
/**
|
|
@@ -3891,7 +3929,7 @@ export declare enum EmbedEvent {
|
|
|
3891
3929
|
* @returns viewId: string
|
|
3892
3930
|
* @returns liveboardId: string
|
|
3893
3931
|
* @returns isPublic: boolean
|
|
3894
|
-
* @version SDK
|
|
3932
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3895
3933
|
*/
|
|
3896
3934
|
SavePersonalisedView = "savePersonalisedView",
|
|
3897
3935
|
/**
|
|
@@ -3900,19 +3938,19 @@ export declare enum EmbedEvent {
|
|
|
3900
3938
|
* @returns viewId: string
|
|
3901
3939
|
* @returns liveboardId: string
|
|
3902
3940
|
* @returns isPublic: boolean
|
|
3903
|
-
* @version SDK
|
|
3941
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3904
3942
|
*/
|
|
3905
3943
|
ResetLiveboard = "resetLiveboard",
|
|
3906
3944
|
/**
|
|
3907
3945
|
* Emitted when a PersonalisedView is deleted.
|
|
3908
3946
|
* @returns views: string[]
|
|
3909
3947
|
* @returns liveboardId: string
|
|
3910
|
-
* @version SDK
|
|
3948
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3911
3949
|
*/
|
|
3912
3950
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3913
3951
|
/**
|
|
3914
3952
|
* Emitted when a user creates a Worksheet.
|
|
3915
|
-
* @version SDK
|
|
3953
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3916
3954
|
*/
|
|
3917
3955
|
CreateWorksheet = "createWorksheet",
|
|
3918
3956
|
/**
|
|
@@ -3921,12 +3959,12 @@ export declare enum EmbedEvent {
|
|
|
3921
3959
|
* @returns viewId: string
|
|
3922
3960
|
* @returns liveboardId: string
|
|
3923
3961
|
* @returns isPublic: boolean
|
|
3924
|
-
* @version SDK
|
|
3962
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3925
3963
|
*/
|
|
3926
3964
|
AskSageInit = "AskSageInit",
|
|
3927
3965
|
/**
|
|
3928
3966
|
* Emitted when a Liveboard or visualization is renamed.
|
|
3929
|
-
* @version SDK
|
|
3967
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
3930
3968
|
*/
|
|
3931
3969
|
Rename = "rename",
|
|
3932
3970
|
/**
|
|
@@ -3949,7 +3987,7 @@ export declare enum EmbedEvent {
|
|
|
3949
3987
|
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
3950
3988
|
* is `false` by using the `error` parameters in `responder`.
|
|
3951
3989
|
* - `errorText` - The error message text shown to the user.
|
|
3952
|
-
* @version SDK
|
|
3990
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
3953
3991
|
* @example
|
|
3954
3992
|
*
|
|
3955
3993
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -4001,8 +4039,8 @@ export declare enum EmbedEvent {
|
|
|
4001
4039
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
4002
4040
|
* console.log('payload', payload);
|
|
4003
4041
|
* })
|
|
4004
|
-
|
|
4005
|
-
* @version SDK
|
|
4042
|
+
* ```
|
|
4043
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4006
4044
|
*/
|
|
4007
4045
|
ParameterChanged = "parameterChanged",
|
|
4008
4046
|
/**
|
|
@@ -4057,24 +4095,24 @@ export declare enum EmbedEvent {
|
|
|
4057
4095
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
4058
4096
|
* console.log('payload', payload);
|
|
4059
4097
|
* })
|
|
4060
|
-
|
|
4061
|
-
* @version SDK
|
|
4098
|
+
* ```
|
|
4099
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4062
4100
|
*/
|
|
4063
4101
|
CreateLiveboard = "createLiveboard",
|
|
4064
4102
|
/**
|
|
4065
4103
|
* Emitted when a user creates a Model.
|
|
4066
|
-
* @version SDK
|
|
4104
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4067
4105
|
*/
|
|
4068
4106
|
CreateModel = "createModel",
|
|
4069
4107
|
/**
|
|
4070
4108
|
* @hidden
|
|
4071
4109
|
* Emitted when a user exits present mode.
|
|
4072
|
-
* @version SDK
|
|
4110
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4073
4111
|
*/
|
|
4074
4112
|
ExitPresentMode = "exitPresentMode",
|
|
4075
4113
|
/**
|
|
4076
4114
|
* Emitted when a user requests the full height lazy load data.
|
|
4077
|
-
* @version SDK
|
|
4115
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4078
4116
|
* @hidden
|
|
4079
4117
|
*/
|
|
4080
4118
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
@@ -4085,7 +4123,7 @@ export declare enum EmbedEvent {
|
|
|
4085
4123
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
4086
4124
|
* console.log('payload', payload);
|
|
4087
4125
|
* })
|
|
4088
|
-
|
|
4126
|
+
* ```
|
|
4089
4127
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4090
4128
|
*/
|
|
4091
4129
|
SpotterData = "SpotterData",
|
|
@@ -4096,7 +4134,7 @@ export declare enum EmbedEvent {
|
|
|
4096
4134
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
4097
4135
|
* console.log('payload', payload);
|
|
4098
4136
|
* })
|
|
4099
|
-
|
|
4137
|
+
* ```
|
|
4100
4138
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4101
4139
|
*/
|
|
4102
4140
|
PreviewSpotterData = "PreviewSpotterData",
|
|
@@ -4107,7 +4145,7 @@ export declare enum EmbedEvent {
|
|
|
4107
4145
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
4108
4146
|
* console.log('payload', payload);
|
|
4109
4147
|
* })
|
|
4110
|
-
|
|
4148
|
+
* ```
|
|
4111
4149
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
4112
4150
|
*/
|
|
4113
4151
|
AddToCoaching = "addToCoaching",
|
|
@@ -4129,7 +4167,7 @@ export declare enum EmbedEvent {
|
|
|
4129
4167
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
4130
4168
|
* console.log('payload', payload);
|
|
4131
4169
|
* })
|
|
4132
|
-
|
|
4170
|
+
* ```
|
|
4133
4171
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4134
4172
|
*/
|
|
4135
4173
|
SpotterQueryTriggered = "SpotterQueryTriggered",
|
|
@@ -4140,7 +4178,7 @@ export declare enum EmbedEvent {
|
|
|
4140
4178
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
4141
4179
|
* console.log('payload', payload);
|
|
4142
4180
|
* })
|
|
4143
|
-
|
|
4181
|
+
* ```
|
|
4144
4182
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4145
4183
|
*/
|
|
4146
4184
|
LastPromptEdited = "LastPromptEdited",
|
|
@@ -4151,18 +4189,18 @@ export declare enum EmbedEvent {
|
|
|
4151
4189
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
4152
4190
|
* console.log('payload', payload);
|
|
4153
4191
|
* })
|
|
4154
|
-
|
|
4192
|
+
* ```
|
|
4155
4193
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4156
4194
|
*/
|
|
4157
4195
|
LastPromptDeleted = "LastPromptDeleted",
|
|
4158
4196
|
/**
|
|
4159
|
-
* Emitted when the
|
|
4197
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
4160
4198
|
* @example
|
|
4161
4199
|
* ```js
|
|
4162
4200
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
4163
4201
|
* console.log('payload', payload);
|
|
4164
4202
|
* })
|
|
4165
|
-
|
|
4203
|
+
* ```
|
|
4166
4204
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4167
4205
|
*/
|
|
4168
4206
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
@@ -4173,7 +4211,7 @@ export declare enum EmbedEvent {
|
|
|
4173
4211
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
4174
4212
|
* console.log('payload', payload);
|
|
4175
4213
|
* })
|
|
4176
|
-
|
|
4214
|
+
* ```
|
|
4177
4215
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
4178
4216
|
*/
|
|
4179
4217
|
SpotterInit = "spotterInit",
|
|
@@ -4184,7 +4222,7 @@ export declare enum EmbedEvent {
|
|
|
4184
4222
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
4185
4223
|
* console.log('payload', payload);
|
|
4186
4224
|
* })
|
|
4187
|
-
|
|
4225
|
+
* ```
|
|
4188
4226
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
4189
4227
|
*/
|
|
4190
4228
|
SpotterLoadComplete = "spotterLoadComplete",
|
|
@@ -4538,7 +4576,7 @@ export declare enum HostEvent {
|
|
|
4538
4576
|
* ```js
|
|
4539
4577
|
* appEmbed.navigateToPage(-1)
|
|
4540
4578
|
* ```
|
|
4541
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
4579
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
4542
4580
|
*/
|
|
4543
4581
|
Navigate = "Navigate",
|
|
4544
4582
|
/**
|
|
@@ -4671,9 +4709,9 @@ export declare enum HostEvent {
|
|
|
4671
4709
|
* Trigger the **Show Liveboard details** action
|
|
4672
4710
|
* on an embedded Liveboard.
|
|
4673
4711
|
* @example
|
|
4674
|
-
|
|
4712
|
+
* ```js
|
|
4675
4713
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
4676
|
-
|
|
4714
|
+
* ```
|
|
4677
4715
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4678
4716
|
*/
|
|
4679
4717
|
LiveboardInfo = "pinboardInfo",
|
|
@@ -4801,7 +4839,7 @@ export declare enum HostEvent {
|
|
|
4801
4839
|
* appEmbed.trigger(HostEvent.Remove)
|
|
4802
4840
|
* ```
|
|
4803
4841
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4804
|
-
*
|
|
4842
|
+
* @example
|
|
4805
4843
|
* ```js
|
|
4806
4844
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
4807
4845
|
* ```
|
|
@@ -4892,7 +4930,7 @@ export declare enum HostEvent {
|
|
|
4892
4930
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4893
4931
|
* ```
|
|
4894
4932
|
* ```js
|
|
4895
|
-
* vizEmbed.trigger(
|
|
4933
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
4896
4934
|
* ```
|
|
4897
4935
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4898
4936
|
*/
|
|
@@ -4909,7 +4947,7 @@ export declare enum HostEvent {
|
|
|
4909
4947
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4910
4948
|
* ```
|
|
4911
4949
|
* ```js
|
|
4912
|
-
* vizEmbed.trigger(
|
|
4950
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
4913
4951
|
* ```
|
|
4914
4952
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4915
4953
|
*/
|
|
@@ -4924,23 +4962,22 @@ export declare enum HostEvent {
|
|
|
4924
4962
|
* );
|
|
4925
4963
|
* })
|
|
4926
4964
|
* ```
|
|
4927
|
-
*
|
|
4965
|
+
* @example
|
|
4928
4966
|
* ```js
|
|
4929
|
-
|
|
4930
|
-
|
|
4931
|
-
|
|
4932
|
-
|
|
4933
|
-
|
|
4934
|
-
|
|
4935
|
-
|
|
4936
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
4967
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
4968
|
+
* let latestSpotterVizId = '';
|
|
4969
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
4970
|
+
* latestSpotterVizId = payload.data.id;
|
|
4971
|
+
* });
|
|
4972
|
+
*
|
|
4973
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
4937
4974
|
* vizId: latestSpotterVizId
|
|
4938
4975
|
* }).then((tml) => {
|
|
4939
4976
|
* console.log(
|
|
4940
4977
|
* tml.answer.search_query // TML representation of the search query
|
|
4941
4978
|
* );
|
|
4942
4979
|
* })
|
|
4943
|
-
|
|
4980
|
+
* ```
|
|
4944
4981
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4945
4982
|
* @important
|
|
4946
4983
|
*/
|
|
@@ -5004,6 +5041,11 @@ export declare enum HostEvent {
|
|
|
5004
5041
|
/**
|
|
5005
5042
|
* Trigger the **Download** action on charts in
|
|
5006
5043
|
* the embedded view.
|
|
5044
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
5045
|
+
*
|
|
5046
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
5047
|
+
*
|
|
5048
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
5007
5049
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
5008
5050
|
* @example
|
|
5009
5051
|
* ```js
|
|
@@ -5022,9 +5064,6 @@ export declare enum HostEvent {
|
|
|
5022
5064
|
*
|
|
5023
5065
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
5024
5066
|
* ```
|
|
5025
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
5026
|
-
* Use {@link DownloadAsPng}
|
|
5027
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
5028
5067
|
*/
|
|
5029
5068
|
Download = "downloadAsPng",
|
|
5030
5069
|
/**
|
|
@@ -5462,8 +5501,8 @@ export declare enum HostEvent {
|
|
|
5462
5501
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
5463
5502
|
* console.log('parameters', parameter);
|
|
5464
5503
|
* });
|
|
5465
|
-
|
|
5466
|
-
|
|
5504
|
+
* ```
|
|
5505
|
+
* ```js
|
|
5467
5506
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
5468
5507
|
* let latestSpotterVizId = '';
|
|
5469
5508
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -5471,7 +5510,7 @@ export declare enum HostEvent {
|
|
|
5471
5510
|
* });
|
|
5472
5511
|
*
|
|
5473
5512
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
5474
|
-
|
|
5513
|
+
* ```
|
|
5475
5514
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
5476
5515
|
*/
|
|
5477
5516
|
GetParameters = "GetParameters",
|
|
@@ -5488,7 +5527,7 @@ export declare enum HostEvent {
|
|
|
5488
5527
|
* Notify when info call is completed successfully
|
|
5489
5528
|
* ```js
|
|
5490
5529
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
5491
|
-
|
|
5530
|
+
* ```
|
|
5492
5531
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5493
5532
|
*/
|
|
5494
5533
|
InfoSuccess = "InfoSuccess",
|
|
@@ -5591,7 +5630,7 @@ export declare enum HostEvent {
|
|
|
5591
5630
|
* ```js
|
|
5592
5631
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
5593
5632
|
*
|
|
5594
|
-
|
|
5633
|
+
* ```
|
|
5595
5634
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5596
5635
|
*/
|
|
5597
5636
|
AddToCoaching = "addToCoaching",
|
|
@@ -5633,7 +5672,7 @@ export declare enum HostEvent {
|
|
|
5633
5672
|
* });
|
|
5634
5673
|
*
|
|
5635
5674
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
5636
|
-
|
|
5675
|
+
* ```
|
|
5637
5676
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5638
5677
|
*/
|
|
5639
5678
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
@@ -5643,7 +5682,7 @@ export declare enum HostEvent {
|
|
|
5643
5682
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
5644
5683
|
* ```js
|
|
5645
5684
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
5646
|
-
|
|
5685
|
+
* ```
|
|
5647
5686
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5648
5687
|
*/
|
|
5649
5688
|
ExitPresentMode = "exitPresentMode",
|
|
@@ -5894,14 +5933,14 @@ export declare enum Action {
|
|
|
5894
5933
|
* ```js
|
|
5895
5934
|
* disabledActions: [Action.CollapseDataPanel]
|
|
5896
5935
|
* ```
|
|
5897
|
-
* @version
|
|
5936
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5898
5937
|
*/
|
|
5899
5938
|
CollapseDataSources = "collapseDataSources",
|
|
5900
5939
|
/**
|
|
5901
5940
|
* The **Collapse data panel** icon on the Search page.
|
|
5902
5941
|
* Collapses the data panel view.
|
|
5903
5942
|
*
|
|
5904
|
-
* @version
|
|
5943
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5905
5944
|
*
|
|
5906
5945
|
* @example
|
|
5907
5946
|
* ```js
|
|
@@ -6348,13 +6387,12 @@ export declare enum Action {
|
|
|
6348
6387
|
*/
|
|
6349
6388
|
CreateMonitor = "createMonitor",
|
|
6350
6389
|
/**
|
|
6351
|
-
* @
|
|
6352
|
-
*
|
|
6390
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6391
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
6353
6392
|
* @example
|
|
6354
6393
|
* ```js
|
|
6355
6394
|
* disabledActions: [Action.ReportError]
|
|
6356
6395
|
* ```
|
|
6357
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6358
6396
|
*/
|
|
6359
6397
|
ReportError = "reportError",
|
|
6360
6398
|
/**
|
|
@@ -6364,7 +6402,7 @@ export declare enum Action {
|
|
|
6364
6402
|
* ```js
|
|
6365
6403
|
* disabledActions: [Action.SyncToSheets]
|
|
6366
6404
|
* ```
|
|
6367
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6405
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6368
6406
|
*/
|
|
6369
6407
|
SyncToSheets = "sync-to-sheets",
|
|
6370
6408
|
/**
|
|
@@ -6375,7 +6413,7 @@ export declare enum Action {
|
|
|
6375
6413
|
* ```js
|
|
6376
6414
|
* disabledActions: [Action.SyncToOtherApps]
|
|
6377
6415
|
* ```
|
|
6378
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6416
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6379
6417
|
*/
|
|
6380
6418
|
SyncToOtherApps = "sync-to-other-apps",
|
|
6381
6419
|
/**
|
|
@@ -6385,7 +6423,7 @@ export declare enum Action {
|
|
|
6385
6423
|
* ```js
|
|
6386
6424
|
* disabledActions: [Action.ManagePipelines]
|
|
6387
6425
|
* ```
|
|
6388
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6426
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6389
6427
|
*/
|
|
6390
6428
|
ManagePipelines = "manage-pipeline",
|
|
6391
6429
|
/**
|
|
@@ -6697,7 +6735,7 @@ export declare enum Action {
|
|
|
6697
6735
|
* ```js
|
|
6698
6736
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
6699
6737
|
* ```
|
|
6700
|
-
* @version SDK
|
|
6738
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6701
6739
|
*/
|
|
6702
6740
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
6703
6741
|
/**
|
|
@@ -6707,7 +6745,7 @@ export declare enum Action {
|
|
|
6707
6745
|
* ```js
|
|
6708
6746
|
* disabledActions: [Action.LiveboardUsers]
|
|
6709
6747
|
* ```
|
|
6710
|
-
* @version SDK
|
|
6748
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6711
6749
|
*/
|
|
6712
6750
|
LiveboardUsers = "liveboardUsers",
|
|
6713
6751
|
/**
|
|
@@ -6725,7 +6763,7 @@ export declare enum Action {
|
|
|
6725
6763
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
6726
6764
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
6727
6765
|
* ```
|
|
6728
|
-
* @version SDK
|
|
6766
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
6729
6767
|
*/
|
|
6730
6768
|
TML = "tml",
|
|
6731
6769
|
/**
|
|
@@ -6771,7 +6809,7 @@ export declare enum Action {
|
|
|
6771
6809
|
* ```js
|
|
6772
6810
|
* disabledActions: [Action.AddToWatchlist]
|
|
6773
6811
|
* ```
|
|
6774
|
-
* @version SDK
|
|
6812
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6775
6813
|
*/
|
|
6776
6814
|
AddToWatchlist = "addToWatchlist",
|
|
6777
6815
|
/**
|
|
@@ -6781,7 +6819,7 @@ export declare enum Action {
|
|
|
6781
6819
|
* ```js
|
|
6782
6820
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6783
6821
|
* ```
|
|
6784
|
-
* @version SDK
|
|
6822
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6785
6823
|
*/
|
|
6786
6824
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6787
6825
|
/**
|
|
@@ -6792,7 +6830,7 @@ export declare enum Action {
|
|
|
6792
6830
|
* ```js
|
|
6793
6831
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6794
6832
|
* ```
|
|
6795
|
-
* @version SDK
|
|
6833
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6796
6834
|
*/
|
|
6797
6835
|
OrganiseFavourites = "organiseFavourites",
|
|
6798
6836
|
/**
|
|
@@ -6853,7 +6891,7 @@ export declare enum Action {
|
|
|
6853
6891
|
* ```js
|
|
6854
6892
|
* disabledActions: [Action.ManageTags]
|
|
6855
6893
|
* ```
|
|
6856
|
-
* @version SDK
|
|
6894
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6857
6895
|
*/
|
|
6858
6896
|
ManageTags = "manageTags",
|
|
6859
6897
|
/**
|
|
@@ -7614,14 +7652,14 @@ export type ApiInterceptFlags = {
|
|
|
7614
7652
|
/**
|
|
7615
7653
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
7616
7654
|
*
|
|
7617
|
-
* Can be used for
|
|
7655
|
+
* Can be used for Search and App Embed from SDK 1.29.0
|
|
7618
7656
|
*
|
|
7619
|
-
* @version SDK
|
|
7657
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7620
7658
|
*/
|
|
7621
7659
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
7622
7660
|
/**
|
|
7623
7661
|
* This allows to intercept the urls passed, once intercepted the api will only
|
|
7624
|
-
* run based on the
|
|
7662
|
+
* run based on the response from the responder of ApiIntercept event.
|
|
7625
7663
|
*
|
|
7626
7664
|
* @example
|
|
7627
7665
|
* ```js
|
|
@@ -7632,7 +7670,7 @@ export type ApiInterceptFlags = {
|
|
|
7632
7670
|
* })
|
|
7633
7671
|
* ```
|
|
7634
7672
|
*
|
|
7635
|
-
* @version SDK
|
|
7673
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7636
7674
|
*/
|
|
7637
7675
|
interceptUrls?: (string | InterceptedApiType)[];
|
|
7638
7676
|
/**
|
|
@@ -7649,7 +7687,7 @@ export type ApiInterceptFlags = {
|
|
|
7649
7687
|
* })
|
|
7650
7688
|
* ```
|
|
7651
7689
|
*
|
|
7652
|
-
* @version SDK
|
|
7690
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7653
7691
|
*/
|
|
7654
7692
|
interceptTimeout?: number;
|
|
7655
7693
|
};
|
|
@@ -7788,20 +7826,45 @@ export declare enum AuthFailureType {
|
|
|
7788
7826
|
*/
|
|
7789
7827
|
export declare enum AuthStatus {
|
|
7790
7828
|
/**
|
|
7791
|
-
* Emits when the SDK fails to authenticate
|
|
7829
|
+
* Emits when the SDK fails to authenticate.
|
|
7792
7830
|
*/
|
|
7793
7831
|
FAILURE = "FAILURE",
|
|
7794
7832
|
/**
|
|
7795
|
-
* Emits when the SDK
|
|
7833
|
+
* Emits when the SDK authentication step completes
|
|
7834
|
+
* successfully (e.g., token exchange, cookie set).
|
|
7835
|
+
* This fires before any iframe is rendered. Use
|
|
7836
|
+
* this to know that auth passed and it is safe to
|
|
7837
|
+
* proceed with rendering. The callback receives no
|
|
7838
|
+
* arguments.
|
|
7839
|
+
* @example
|
|
7840
|
+
* ```js
|
|
7841
|
+
* const authEE = init({ ... });
|
|
7842
|
+
* authEE.on(AuthStatus.SDK_SUCCESS, () => {
|
|
7843
|
+
* // Auth done, iframe not loaded yet
|
|
7844
|
+
* });
|
|
7845
|
+
* ```
|
|
7796
7846
|
*/
|
|
7797
7847
|
SDK_SUCCESS = "SDK_SUCCESS",
|
|
7798
7848
|
/**
|
|
7799
7849
|
* @hidden
|
|
7800
|
-
* Emits when iframe is loaded and session
|
|
7850
|
+
* Emits when iframe is loaded and session
|
|
7851
|
+
* information is available.
|
|
7801
7852
|
*/
|
|
7802
7853
|
SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS",
|
|
7803
7854
|
/**
|
|
7804
|
-
* Emits when the app
|
|
7855
|
+
* Emits when the ThoughtSpot app inside the
|
|
7856
|
+
* embedded iframe confirms its session is active.
|
|
7857
|
+
* This fires after the iframe loads and sends back an `AuthInit` event.
|
|
7858
|
+
* @param sessionInfo Information about the user session, with details like `userGUID`.
|
|
7859
|
+
* @see EmbedEvent.AuthInit
|
|
7860
|
+
* @example
|
|
7861
|
+
* ```js
|
|
7862
|
+
* const authEE = init({ ... });
|
|
7863
|
+
* authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
|
|
7864
|
+
* // App is loaded and authenticated
|
|
7865
|
+
* console.log(sessionInfo.userGUID);
|
|
7866
|
+
* });
|
|
7867
|
+
* ```
|
|
7805
7868
|
*/
|
|
7806
7869
|
SUCCESS = "SUCCESS",
|
|
7807
7870
|
/**
|
|
@@ -8037,9 +8100,9 @@ declare class TsEmbed {
|
|
|
8037
8100
|
*/
|
|
8038
8101
|
private isPreRendered;
|
|
8039
8102
|
/**
|
|
8040
|
-
* Should we encode URL Query Params using base64 encoding which
|
|
8103
|
+
* Should we encode URL Query Params using base64 encoding which ThoughtSpot
|
|
8041
8104
|
* will generate for embedding. This provides additional security to
|
|
8042
|
-
*
|
|
8105
|
+
* ThoughtSpot clusters against Cross site scripting attacks.
|
|
8043
8106
|
* @default false
|
|
8044
8107
|
*/
|
|
8045
8108
|
private shouldEncodeUrlQueryParams;
|
|
@@ -8405,7 +8468,7 @@ declare class TsEmbed {
|
|
|
8405
8468
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
8406
8469
|
* session.
|
|
8407
8470
|
* @param vizId [Optional] to get for a specific viz in case of a Liveboard.
|
|
8408
|
-
* @version SDK: 1.25.0
|
|
8471
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
|
|
8409
8472
|
*/
|
|
8410
8473
|
getAnswerService(vizId?: string): Promise<AnswerService>;
|
|
8411
8474
|
/**
|
|
@@ -8492,7 +8555,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8492
8555
|
* but can be expanded manually.
|
|
8493
8556
|
*
|
|
8494
8557
|
* Supported embed types: `SearchEmbed`
|
|
8495
|
-
* @version
|
|
8558
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
8496
8559
|
* @example
|
|
8497
8560
|
* ```js
|
|
8498
8561
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8507,7 +8570,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8507
8570
|
* but can be expanded manually.
|
|
8508
8571
|
*
|
|
8509
8572
|
* Supported embed types: `SearchEmbed`
|
|
8510
|
-
* @version
|
|
8573
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
8511
8574
|
* @example
|
|
8512
8575
|
* ```js
|
|
8513
8576
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8521,7 +8584,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8521
8584
|
* Show or hide the data sources panel.
|
|
8522
8585
|
*
|
|
8523
8586
|
* Supported embed types: `SearchEmbed`
|
|
8524
|
-
* @version
|
|
8587
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
8525
8588
|
* @example
|
|
8526
8589
|
* ```js
|
|
8527
8590
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8537,7 +8600,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8537
8600
|
* using raw answer data.
|
|
8538
8601
|
*
|
|
8539
8602
|
* Supported embed types: `SearchEmbed`
|
|
8540
|
-
* @version
|
|
8603
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
8541
8604
|
* @example
|
|
8542
8605
|
* ```js
|
|
8543
8606
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8566,7 +8629,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8566
8629
|
* format for presenting search data.
|
|
8567
8630
|
*
|
|
8568
8631
|
* Supported embed types: `SearchEmbed`
|
|
8569
|
-
* @version
|
|
8632
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
8570
8633
|
* @example
|
|
8571
8634
|
* ```js
|
|
8572
8635
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8579,6 +8642,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8579
8642
|
/**
|
|
8580
8643
|
* The array of data source GUIDs to set on load.
|
|
8581
8644
|
* Only a single data source is supported currently.
|
|
8645
|
+
* Use {@link dataSource} instead.
|
|
8582
8646
|
* @deprecated Use `dataSource` instead.
|
|
8583
8647
|
*
|
|
8584
8648
|
* Supported embed types: `SearchEmbed`
|
|
@@ -8592,10 +8656,10 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8592
8656
|
*/
|
|
8593
8657
|
dataSources?: string[];
|
|
8594
8658
|
/**
|
|
8595
|
-
* The
|
|
8659
|
+
* The data source GUID to set on load.
|
|
8596
8660
|
*
|
|
8597
8661
|
* Supported embed types: `SearchEmbed`
|
|
8598
|
-
* @version
|
|
8662
|
+
* @version SDK: 1.19.0
|
|
8599
8663
|
* @example
|
|
8600
8664
|
* ```js
|
|
8601
8665
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8607,9 +8671,9 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8607
8671
|
dataSource?: string;
|
|
8608
8672
|
/**
|
|
8609
8673
|
* The initial search query to load the answer with.
|
|
8674
|
+
* Use {@link searchOptions} instead.
|
|
8610
8675
|
* @deprecated
|
|
8611
8676
|
*
|
|
8612
|
-
* Use {@link searchOptions} instead.
|
|
8613
8677
|
*/
|
|
8614
8678
|
searchQuery?: string;
|
|
8615
8679
|
/**
|
|
@@ -8638,7 +8702,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8638
8702
|
* If set to true, the search token string is not appended to the URL.
|
|
8639
8703
|
*
|
|
8640
8704
|
* Supported embed types: `SearchEmbed`
|
|
8641
|
-
* @version
|
|
8705
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
8642
8706
|
* @example
|
|
8643
8707
|
* ```js
|
|
8644
8708
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8655,7 +8719,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8655
8719
|
* The GUID of a saved answer to load initially.
|
|
8656
8720
|
*
|
|
8657
8721
|
* Supported embed types: `SearchEmbed`
|
|
8658
|
-
* @version
|
|
8722
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
8659
8723
|
* @example
|
|
8660
8724
|
* ```js
|
|
8661
8725
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8684,14 +8748,14 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8684
8748
|
* Flag to set if last selected dataSource should be used
|
|
8685
8749
|
*
|
|
8686
8750
|
* Supported embed types: `SearchEmbed`
|
|
8687
|
-
* @version
|
|
8751
|
+
* @version SDK: 1.24.0
|
|
8688
8752
|
*/
|
|
8689
8753
|
useLastSelectedSources?: boolean;
|
|
8690
8754
|
/**
|
|
8691
8755
|
* To set the initial state of the search bar in case of saved-answers.
|
|
8692
|
-
* @default false
|
|
8693
8756
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
8694
8757
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
8758
|
+
* @default false
|
|
8695
8759
|
*/
|
|
8696
8760
|
collapseSearchBarInitially?: boolean;
|
|
8697
8761
|
/**
|
|
@@ -8775,8 +8839,8 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8775
8839
|
* Only a single data source is supported currently.
|
|
8776
8840
|
*
|
|
8777
8841
|
* Supported embed types: `SearchBarEmbed`
|
|
8842
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
8778
8843
|
* @deprecated Use `dataSource` instead
|
|
8779
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
8780
8844
|
* @example
|
|
8781
8845
|
* ```js
|
|
8782
8846
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8790,7 +8854,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8790
8854
|
* Pass the ID of the source to be selected.
|
|
8791
8855
|
*
|
|
8792
8856
|
* Supported embed types: `SearchBarEmbed`
|
|
8793
|
-
* @version
|
|
8857
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
8794
8858
|
* @example
|
|
8795
8859
|
* ```js
|
|
8796
8860
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8804,7 +8868,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8804
8868
|
* Boolean to define if the last selected data source should be used
|
|
8805
8869
|
*
|
|
8806
8870
|
* Supported embed types: `SearchBarEmbed`
|
|
8807
|
-
* @version
|
|
8871
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.0.sw
|
|
8808
8872
|
* @example
|
|
8809
8873
|
* ```js
|
|
8810
8874
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8826,7 +8890,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8826
8890
|
* the token string in the search bar.
|
|
8827
8891
|
*
|
|
8828
8892
|
* Supported embed types: `SearchBarEmbed`
|
|
8829
|
-
* @version
|
|
8893
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
8830
8894
|
* @example
|
|
8831
8895
|
* ```js
|
|
8832
8896
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8844,10 +8908,10 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8844
8908
|
* If set to true, the search token string is not appended to the URL.
|
|
8845
8909
|
*
|
|
8846
8910
|
* Supported embed types: `SearchBarEmbed`
|
|
8847
|
-
* @version
|
|
8911
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
8848
8912
|
* @example
|
|
8849
8913
|
* ```js
|
|
8850
|
-
* const embed = new
|
|
8914
|
+
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
8851
8915
|
* searchOptions: {
|
|
8852
8916
|
* searchTokenString: '[quantity purchased] [region]',
|
|
8853
8917
|
* executeSearch: true,
|
|
@@ -8900,7 +8964,7 @@ interface SearchOptions$1 {
|
|
|
8900
8964
|
/**
|
|
8901
8965
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
8902
8966
|
* GPT and LLM.
|
|
8903
|
-
* @version
|
|
8967
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
8904
8968
|
*
|
|
8905
8969
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
8906
8970
|
* @group Embed components
|
|
@@ -8954,14 +9018,14 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
8954
9018
|
hideAutocompleteSuggestions?: boolean;
|
|
8955
9019
|
/**
|
|
8956
9020
|
* Show or hide autocomplete suggestions for the search query string.
|
|
9021
|
+
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
8957
9022
|
* @deprecated
|
|
8958
9023
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
8959
|
-
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
8960
9024
|
*/
|
|
8961
9025
|
showObjectSuggestions?: boolean;
|
|
8962
9026
|
/**
|
|
8963
9027
|
* Show or hide sample questions.
|
|
8964
|
-
* The sample questions are autogenerated based on the data
|
|
9028
|
+
* The sample questions are autogenerated based on the data model
|
|
8965
9029
|
* selected for the search operation.
|
|
8966
9030
|
*
|
|
8967
9031
|
* Supported embed types: `SageEmbed`
|
|
@@ -8991,6 +9055,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
8991
9055
|
* the token string in the search bar.
|
|
8992
9056
|
*
|
|
8993
9057
|
* Supported embed types: `SageEmbed`
|
|
9058
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
8994
9059
|
* @example
|
|
8995
9060
|
* ```js
|
|
8996
9061
|
* searchOptions: {
|
|
@@ -8998,7 +9063,6 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
8998
9063
|
* executeSearch: true,
|
|
8999
9064
|
* }
|
|
9000
9065
|
* ```
|
|
9001
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
9002
9066
|
*/
|
|
9003
9067
|
searchOptions?: SearchOptions$1;
|
|
9004
9068
|
}
|
|
@@ -9038,81 +9102,81 @@ interface SearchOptions$2 {
|
|
|
9038
9102
|
* Configuration for the Spotter sidebar.
|
|
9039
9103
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
9040
9104
|
* @group Embed components
|
|
9041
|
-
* @version SDK: 1.
|
|
9105
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9042
9106
|
*/
|
|
9043
9107
|
export interface SpotterSidebarViewConfig {
|
|
9044
9108
|
/**
|
|
9045
9109
|
* Controls the visibility of the past conversations sidebar.
|
|
9046
9110
|
* @default false
|
|
9047
|
-
* @version SDK: 1.
|
|
9111
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9048
9112
|
*/
|
|
9049
9113
|
enablePastConversationsSidebar?: boolean;
|
|
9050
9114
|
/**
|
|
9051
9115
|
* Custom title text for the sidebar header.
|
|
9052
9116
|
* Defaults to translated "Spotter" text.
|
|
9053
|
-
* @version SDK: 1.
|
|
9117
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9054
9118
|
*/
|
|
9055
9119
|
spotterSidebarTitle?: string;
|
|
9056
9120
|
/**
|
|
9057
9121
|
* Boolean to set the default expanded state of the sidebar.
|
|
9058
9122
|
* @default false
|
|
9059
|
-
* @version SDK: 1.
|
|
9123
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9060
9124
|
*/
|
|
9061
9125
|
spotterSidebarDefaultExpanded?: boolean;
|
|
9062
9126
|
/**
|
|
9063
9127
|
* Custom label text for the rename action in the conversation edit menu.
|
|
9064
9128
|
* Defaults to translated "Rename" text.
|
|
9065
|
-
* @version SDK: 1.
|
|
9129
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9066
9130
|
*/
|
|
9067
9131
|
spotterChatRenameLabel?: string;
|
|
9068
9132
|
/**
|
|
9069
9133
|
* Custom label text for the delete action in the conversation edit menu.
|
|
9070
9134
|
* Defaults to translated "DELETE" text.
|
|
9071
|
-
* @version SDK: 1.
|
|
9135
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9072
9136
|
*/
|
|
9073
9137
|
spotterChatDeleteLabel?: string;
|
|
9074
9138
|
/**
|
|
9075
9139
|
* Custom title text for the delete conversation confirmation modal.
|
|
9076
9140
|
* Defaults to translated "Delete chat" text.
|
|
9077
|
-
* @version SDK: 1.
|
|
9141
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9078
9142
|
*/
|
|
9079
9143
|
spotterDeleteConversationModalTitle?: string;
|
|
9080
9144
|
/**
|
|
9081
9145
|
* Custom message text for the past conversation banner alert.
|
|
9082
9146
|
* Defaults to translated alert message.
|
|
9083
|
-
* @version SDK: 1.
|
|
9147
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9084
9148
|
*/
|
|
9085
9149
|
spotterPastConversationAlertMessage?: string;
|
|
9086
9150
|
/**
|
|
9087
9151
|
* Custom URL for the documentation/best practices link.
|
|
9088
9152
|
* Defaults to ThoughtSpot docs URL based on release version.
|
|
9089
9153
|
* Note: URL must include the protocol (e.g., `https://www.example.com`).
|
|
9090
|
-
* @version SDK: 1.
|
|
9154
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9091
9155
|
*/
|
|
9092
9156
|
spotterDocumentationUrl?: string;
|
|
9093
9157
|
/**
|
|
9094
9158
|
* Custom label text for the best practices button in the footer.
|
|
9095
9159
|
* Defaults to translated "Best Practices" text.
|
|
9096
|
-
* @version SDK: 1.
|
|
9160
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9097
9161
|
*/
|
|
9098
9162
|
spotterBestPracticesLabel?: string;
|
|
9099
9163
|
/**
|
|
9100
9164
|
* Number of conversations to fetch per batch when loading conversation history.
|
|
9101
9165
|
* @default 30
|
|
9102
|
-
* @version SDK: 1.
|
|
9166
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9103
9167
|
*/
|
|
9104
9168
|
spotterConversationsBatchSize?: number;
|
|
9105
9169
|
/**
|
|
9106
9170
|
* Custom title text for the "New Chat" button in the sidebar.
|
|
9107
9171
|
* Defaults to translated "New Chat" text.
|
|
9108
|
-
* @version SDK: 1.
|
|
9172
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9109
9173
|
*/
|
|
9110
9174
|
spotterNewChatButtonTitle?: string;
|
|
9111
9175
|
}
|
|
9112
9176
|
/**
|
|
9113
9177
|
* Configuration for customizing Spotter chat UI branding.
|
|
9114
|
-
* @group Embed components
|
|
9115
9178
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9179
|
+
* @group Embed components
|
|
9116
9180
|
*/
|
|
9117
9181
|
export interface SpotterChatViewConfig {
|
|
9118
9182
|
/**
|
|
@@ -9151,6 +9215,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9151
9215
|
* but still display the selected data source.
|
|
9152
9216
|
*
|
|
9153
9217
|
* Supported embed types: `SpotterEmbed`
|
|
9218
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9154
9219
|
* @example
|
|
9155
9220
|
* ```js
|
|
9156
9221
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9158,13 +9223,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9158
9223
|
* disableSourceSelection : true,
|
|
9159
9224
|
* })
|
|
9160
9225
|
* ```
|
|
9161
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9162
9226
|
*/
|
|
9163
9227
|
disableSourceSelection?: boolean;
|
|
9164
9228
|
/**
|
|
9165
9229
|
* hideSourceSelection : Hide data source selection
|
|
9166
9230
|
*
|
|
9167
9231
|
* Supported embed types: `SpotterEmbed`
|
|
9232
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9168
9233
|
* @example
|
|
9169
9234
|
* ```js
|
|
9170
9235
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9172,15 +9237,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9172
9237
|
* hideSourceSelection : true,
|
|
9173
9238
|
* })
|
|
9174
9239
|
* ```
|
|
9175
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9176
9240
|
*/
|
|
9177
9241
|
hideSourceSelection?: boolean;
|
|
9178
9242
|
/**
|
|
9179
9243
|
* Flag to control Data panel experience
|
|
9180
9244
|
*
|
|
9181
9245
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
9246
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
9182
9247
|
* @default true
|
|
9183
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
9184
9248
|
* @example
|
|
9185
9249
|
* ```js
|
|
9186
9250
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -9197,6 +9261,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9197
9261
|
* default is false.
|
|
9198
9262
|
*
|
|
9199
9263
|
* Supported embed types: `SpotterEmbed`
|
|
9264
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
9200
9265
|
* @example
|
|
9201
9266
|
* ```js
|
|
9202
9267
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9204,7 +9269,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9204
9269
|
* showSpotterLimitations : true,
|
|
9205
9270
|
* })
|
|
9206
9271
|
* ```
|
|
9207
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
9208
9272
|
*/
|
|
9209
9273
|
showSpotterLimitations?: boolean;
|
|
9210
9274
|
/**
|
|
@@ -9212,6 +9276,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9212
9276
|
* the initial screen of the conversation.
|
|
9213
9277
|
*
|
|
9214
9278
|
* Supported embed types: `SpotterEmbed`
|
|
9279
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9215
9280
|
* @example
|
|
9216
9281
|
* ```js
|
|
9217
9282
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9219,7 +9284,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9219
9284
|
* hideSampleQuestions : true,
|
|
9220
9285
|
* })
|
|
9221
9286
|
* ```
|
|
9222
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9223
9287
|
*/
|
|
9224
9288
|
hideSampleQuestions?: boolean;
|
|
9225
9289
|
/**
|
|
@@ -9227,6 +9291,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9227
9291
|
* visualization, or Liveboard.
|
|
9228
9292
|
*
|
|
9229
9293
|
* Supported embed types: `SpotterEmbed`
|
|
9294
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9230
9295
|
* @example
|
|
9231
9296
|
* ```js
|
|
9232
9297
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9240,7 +9305,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9240
9305
|
* ],
|
|
9241
9306
|
* })
|
|
9242
9307
|
* ```
|
|
9243
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9244
9308
|
*/
|
|
9245
9309
|
runtimeFilters?: RuntimeFilter[];
|
|
9246
9310
|
/**
|
|
@@ -9251,14 +9315,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9251
9315
|
* (default behavior before SDK 1.45.0).
|
|
9252
9316
|
*
|
|
9253
9317
|
* Supported embed types: `SpotterEmbed`
|
|
9254
|
-
* @default true
|
|
9255
9318
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9319
|
+
* @default true
|
|
9256
9320
|
*/
|
|
9257
9321
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
9258
9322
|
/**
|
|
9259
9323
|
* The list of runtime parameters to apply to the conversation.
|
|
9260
9324
|
*
|
|
9261
9325
|
* Supported embed types: `SpotterEmbed`
|
|
9326
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9262
9327
|
* @example
|
|
9263
9328
|
* ```js
|
|
9264
9329
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9271,7 +9336,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9271
9336
|
* ],
|
|
9272
9337
|
* })
|
|
9273
9338
|
* ```
|
|
9274
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9275
9339
|
*/
|
|
9276
9340
|
runtimeParameters?: RuntimeParameter[];
|
|
9277
9341
|
/**
|
|
@@ -9282,14 +9346,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9282
9346
|
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
9283
9347
|
*
|
|
9284
9348
|
* Supported embed types: `SpotterEmbed`
|
|
9285
|
-
* @default true
|
|
9286
9349
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9350
|
+
* @default true
|
|
9287
9351
|
*/
|
|
9288
9352
|
excludeRuntimeParametersfromURL?: boolean;
|
|
9289
9353
|
/**
|
|
9290
9354
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9291
9355
|
*
|
|
9292
9356
|
* Supported embed types: `SpotterEmbed`
|
|
9357
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9293
9358
|
* @default false
|
|
9294
9359
|
* @example
|
|
9295
9360
|
* ```js
|
|
@@ -9298,17 +9363,30 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9298
9363
|
* updatedSpotterChatPrompt : true,
|
|
9299
9364
|
* })
|
|
9300
9365
|
* ```
|
|
9301
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9302
9366
|
*/
|
|
9303
9367
|
updatedSpotterChatPrompt?: boolean;
|
|
9368
|
+
/**
|
|
9369
|
+
* Controls the visibility of the past conversations sidebar.
|
|
9370
|
+
*
|
|
9371
|
+
* Supported embed types: `SpotterEmbed`
|
|
9372
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9373
|
+
* @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9374
|
+
* Use `spotterSidebarConfig.enablePastConversationsSidebar`.
|
|
9375
|
+
* @default false
|
|
9376
|
+
*/
|
|
9377
|
+
enablePastConversationsSidebar?: boolean;
|
|
9304
9378
|
/**
|
|
9305
9379
|
* Configuration for the Spotter sidebar UI customization.
|
|
9306
9380
|
*
|
|
9307
9381
|
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
9382
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9308
9383
|
* @example
|
|
9309
9384
|
* ```js
|
|
9310
9385
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9311
|
-
*
|
|
9386
|
+
* worksheetId: 'worksheet-id',
|
|
9387
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
9388
|
+
* enablePastConversationsSidebar: false,
|
|
9389
|
+
* // Recommended config; this value takes precedence
|
|
9312
9390
|
* spotterSidebarConfig: {
|
|
9313
9391
|
* enablePastConversationsSidebar: true,
|
|
9314
9392
|
* spotterSidebarTitle: 'My Conversations',
|
|
@@ -9316,7 +9394,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9316
9394
|
* },
|
|
9317
9395
|
* })
|
|
9318
9396
|
* ```
|
|
9319
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9320
9397
|
*/
|
|
9321
9398
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
9322
9399
|
/**
|
|
@@ -9324,6 +9401,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9324
9401
|
* branding in tool response cards.
|
|
9325
9402
|
*
|
|
9326
9403
|
* Supported embed types: `SpotterEmbed`
|
|
9404
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9327
9405
|
* @example
|
|
9328
9406
|
* ```js
|
|
9329
9407
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9334,14 +9412,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9334
9412
|
* },
|
|
9335
9413
|
* })
|
|
9336
9414
|
* ```
|
|
9337
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9338
9415
|
*/
|
|
9339
9416
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
9340
9417
|
}
|
|
9341
9418
|
/**
|
|
9342
9419
|
* The configuration for the embedded spotterEmbed options.
|
|
9343
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
9344
9420
|
* Use {@link SpotterEmbedViewConfig} instead
|
|
9421
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
9345
9422
|
* @group Embed components
|
|
9346
9423
|
*/
|
|
9347
9424
|
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
@@ -9454,7 +9531,7 @@ declare enum ListPage {
|
|
|
9454
9531
|
*/
|
|
9455
9532
|
export interface DiscoveryExperience {
|
|
9456
9533
|
/**
|
|
9457
|
-
* primaryNavbarVersion determines the version of the navigation
|
|
9534
|
+
* primaryNavbarVersion determines the version of the primary navigation bar.
|
|
9458
9535
|
*/
|
|
9459
9536
|
primaryNavbarVersion?: PrimaryNavbarVersion;
|
|
9460
9537
|
/**
|
|
@@ -9477,8 +9554,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9477
9554
|
* This flag also controls the homepage left navigation bar.
|
|
9478
9555
|
*
|
|
9479
9556
|
* Supported embed types: `AppEmbed`
|
|
9480
|
-
* @default true
|
|
9481
9557
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9558
|
+
* @default true
|
|
9482
9559
|
* @example
|
|
9483
9560
|
* ```js
|
|
9484
9561
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9499,8 +9576,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9499
9576
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
9500
9577
|
*
|
|
9501
9578
|
* Supported embed types: `AppEmbed`
|
|
9502
|
-
* @default false
|
|
9503
9579
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9580
|
+
* @default false
|
|
9504
9581
|
* @example
|
|
9505
9582
|
* ```js
|
|
9506
9583
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9517,8 +9594,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9517
9594
|
* navigation bar is not hidden via `showPrimaryNavbar`.
|
|
9518
9595
|
*
|
|
9519
9596
|
* Supported embed types: `AppEmbed`
|
|
9520
|
-
* @default false
|
|
9521
9597
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9598
|
+
* @default false
|
|
9522
9599
|
* @example
|
|
9523
9600
|
* ```js
|
|
9524
9601
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9529,12 +9606,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9529
9606
|
*/
|
|
9530
9607
|
disableProfileAndHelp?: boolean;
|
|
9531
9608
|
/**
|
|
9532
|
-
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9533
|
-
* @default true
|
|
9534
9609
|
* Whether the help menu in the top navigation bar should be served
|
|
9535
9610
|
* from Pendo or ThoughtSpot's internal help items.
|
|
9536
9611
|
*
|
|
9537
9612
|
* Supported embed types: `AppEmbed`
|
|
9613
|
+
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9614
|
+
* @default true
|
|
9538
9615
|
* @example
|
|
9539
9616
|
* ```js
|
|
9540
9617
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9549,8 +9626,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9549
9626
|
* the top navigation bar in the V3 navigation experience.
|
|
9550
9627
|
*
|
|
9551
9628
|
* Supported embed types: `AppEmbed`
|
|
9552
|
-
* @default false
|
|
9553
9629
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9630
|
+
* @default false
|
|
9554
9631
|
* @example
|
|
9555
9632
|
* ```js
|
|
9556
9633
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9569,8 +9646,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9569
9646
|
* in the classic (V1) experience.
|
|
9570
9647
|
*
|
|
9571
9648
|
* Supported embed types: `AppEmbed`
|
|
9572
|
-
* @default true
|
|
9573
9649
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9650
|
+
* @default true
|
|
9574
9651
|
* @example
|
|
9575
9652
|
* ```js
|
|
9576
9653
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9588,8 +9665,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9588
9665
|
* in the classic (V1) and V2 experience modes.
|
|
9589
9666
|
*
|
|
9590
9667
|
* Supported embed types: `AppEmbed`
|
|
9591
|
-
* @default true
|
|
9592
9668
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9669
|
+
* @default true
|
|
9593
9670
|
* @example
|
|
9594
9671
|
* ```js
|
|
9595
9672
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9605,7 +9682,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9605
9682
|
* In the V3 experience, it shows or hides application selection
|
|
9606
9683
|
* icons on the left navigation panel.
|
|
9607
9684
|
* By default, the application selection menu and icons are
|
|
9608
|
-
* shown in the UI
|
|
9685
|
+
* shown in the UI.
|
|
9609
9686
|
*
|
|
9610
9687
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
9611
9688
|
*
|
|
@@ -9645,7 +9722,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9645
9722
|
* takes precedence. This is the path post the `#/` in the URL of the standalone
|
|
9646
9723
|
* ThoughtSpot app. Use this to open the embedded view to a specific path.
|
|
9647
9724
|
*
|
|
9648
|
-
* For
|
|
9725
|
+
* For example, if you want the component to open to a specific Liveboard
|
|
9649
9726
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
9650
9727
|
*
|
|
9651
9728
|
* Supported embed types: `AppEmbed`
|
|
@@ -9663,7 +9740,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9663
9740
|
* The application page to set as the start page
|
|
9664
9741
|
* in the embedded view.
|
|
9665
9742
|
*
|
|
9666
|
-
* Use this to open to particular page in the app. To open to a specific
|
|
9743
|
+
* Use this to open to a particular page in the app. To open to a specific
|
|
9667
9744
|
* path within the app, use the `path` attribute which is more flexible.
|
|
9668
9745
|
*
|
|
9669
9746
|
* Supported embed types: `AppEmbed`
|
|
@@ -9743,8 +9820,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9743
9820
|
* If set to true, the Search Assist feature is enabled.
|
|
9744
9821
|
*
|
|
9745
9822
|
* Supported embed types: `AppEmbed`
|
|
9746
|
-
* @default true
|
|
9747
9823
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
9824
|
+
* @default true
|
|
9748
9825
|
* @example
|
|
9749
9826
|
* ```js
|
|
9750
9827
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9782,8 +9859,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9782
9859
|
* For more information,
|
|
9783
9860
|
* see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
9784
9861
|
* Supported embed types: `AppEmbed`
|
|
9785
|
-
* @default false
|
|
9786
9862
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9863
|
+
* @default false
|
|
9787
9864
|
* @example
|
|
9788
9865
|
* ```js
|
|
9789
9866
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9798,8 +9875,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9798
9875
|
* For more information, see
|
|
9799
9876
|
* link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
9800
9877
|
* Supported embed types: `AppEmbed`
|
|
9801
|
-
* @default false
|
|
9802
9878
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9879
|
+
* @default false
|
|
9803
9880
|
* @example
|
|
9804
9881
|
* ```js
|
|
9805
9882
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9814,10 +9891,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9814
9891
|
*/
|
|
9815
9892
|
discoveryExperience?: DiscoveryExperience;
|
|
9816
9893
|
/**
|
|
9817
|
-
* To set the initial state of the search bar in case of saved-answers.
|
|
9894
|
+
* To set the initial state of the search bar in case of saved-answers. Use {@link collapseSearchBar} instead.
|
|
9818
9895
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
9896
|
+
* @deprecated This flag is deprecated.
|
|
9819
9897
|
* @default false
|
|
9820
|
-
* @deprecated Use {@link collapseSearchBar} instead
|
|
9821
9898
|
*/
|
|
9822
9899
|
collapseSearchBarInitially?: boolean;
|
|
9823
9900
|
/**
|
|
@@ -9845,14 +9922,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9845
9922
|
* Flag to use home page search bar mode
|
|
9846
9923
|
*
|
|
9847
9924
|
* Supported embed types: `AppEmbed`
|
|
9848
|
-
* @version SDK
|
|
9925
|
+
* @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
9849
9926
|
*/
|
|
9850
9927
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
9851
9928
|
/**
|
|
9852
9929
|
* This flag is used to enable unified search experience for full app embed.
|
|
9853
9930
|
*
|
|
9854
9931
|
* Supported embed types: `AppEmbed`
|
|
9855
|
-
* @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
|
|
9932
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
|
|
9856
9933
|
* @default true
|
|
9857
9934
|
* @example
|
|
9858
9935
|
* ```js
|
|
@@ -9864,7 +9941,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9864
9941
|
*/
|
|
9865
9942
|
isUnifiedSearchExperienceEnabled?: boolean;
|
|
9866
9943
|
/**
|
|
9867
|
-
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
9944
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
9945
|
+
* @deprecated This flag is deprecated.
|
|
9868
9946
|
*
|
|
9869
9947
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9870
9948
|
* @type {boolean}
|
|
@@ -9930,6 +10008,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9930
10008
|
/**
|
|
9931
10009
|
* This flag is used to enable the full height lazy load data.
|
|
9932
10010
|
*
|
|
10011
|
+
* @type {boolean}
|
|
10012
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10013
|
+
* @default false
|
|
9933
10014
|
* @example
|
|
9934
10015
|
* ```js
|
|
9935
10016
|
* const embed = new AppEmbed('#embed-container', {
|
|
@@ -9938,39 +10019,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9938
10019
|
* lazyLoadingForFullHeight: true,
|
|
9939
10020
|
* })
|
|
9940
10021
|
* ```
|
|
9941
|
-
*
|
|
9942
|
-
* @type {boolean}
|
|
9943
|
-
* @default false
|
|
9944
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9945
10022
|
*/
|
|
9946
10023
|
lazyLoadingForFullHeight?: boolean;
|
|
9947
10024
|
/**
|
|
9948
10025
|
* The margin to be used for lazy loading.
|
|
9949
10026
|
*
|
|
9950
10027
|
* For example, if the margin is set to '10px',
|
|
9951
|
-
* the visualization will be loaded 10px before
|
|
10028
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
9952
10029
|
* viewport.
|
|
9953
10030
|
*
|
|
9954
10031
|
* The format is similar to CSS margin.
|
|
9955
10032
|
*
|
|
10033
|
+
* @type {string}
|
|
10034
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9956
10035
|
* @example
|
|
9957
10036
|
* ```js
|
|
9958
10037
|
* const embed = new AppEmbed('#embed-container', {
|
|
9959
10038
|
* // ...other options
|
|
9960
10039
|
* fullHeight: true,
|
|
9961
10040
|
* lazyLoadingForFullHeight: true,
|
|
9962
|
-
* // Using 0px, the visualization will be only loaded when
|
|
10041
|
+
* // Using 0px, the visualization will be only loaded when it's visible in the viewport.
|
|
9963
10042
|
* lazyLoadingMargin: '0px',
|
|
9964
10043
|
* })
|
|
9965
10044
|
* ```
|
|
9966
|
-
* @type {string}
|
|
9967
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9968
10045
|
*/
|
|
9969
10046
|
lazyLoadingMargin?: string;
|
|
9970
10047
|
/**
|
|
9971
10048
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9972
10049
|
*
|
|
9973
10050
|
* Supported embed types: `AppEmbed`
|
|
10051
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9974
10052
|
* @default false
|
|
9975
10053
|
* @example
|
|
9976
10054
|
* ```js
|
|
@@ -9979,25 +10057,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9979
10057
|
* updatedSpotterChatPrompt : true,
|
|
9980
10058
|
* })
|
|
9981
10059
|
* ```
|
|
9982
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9983
10060
|
*/
|
|
9984
10061
|
updatedSpotterChatPrompt?: boolean;
|
|
10062
|
+
/**
|
|
10063
|
+
* Controls the visibility of the past conversations sidebar.
|
|
10064
|
+
*
|
|
10065
|
+
* Supported embed types: `AppEmbed`
|
|
10066
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
10067
|
+
* @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
10068
|
+
* Use `spotterSidebarConfig.enablePastConversationsSidebar`.
|
|
10069
|
+
* @default false
|
|
10070
|
+
*/
|
|
10071
|
+
enablePastConversationsSidebar?: boolean;
|
|
9985
10072
|
/**
|
|
9986
10073
|
* Configuration for the Spotter sidebar UI customization.
|
|
9987
10074
|
* Only applicable when navigating to Spotter within the app.
|
|
9988
10075
|
*
|
|
9989
10076
|
* Supported embed types: `AppEmbed`
|
|
10077
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9990
10078
|
* @example
|
|
9991
10079
|
* ```js
|
|
9992
10080
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
9993
|
-
*
|
|
10081
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
10082
|
+
* enablePastConversationsSidebar: false,
|
|
10083
|
+
* // Recommended config; this value takes precedence
|
|
9994
10084
|
* spotterSidebarConfig: {
|
|
9995
10085
|
* enablePastConversationsSidebar: true,
|
|
9996
10086
|
* spotterSidebarTitle: 'My Conversations',
|
|
9997
10087
|
* },
|
|
9998
10088
|
* })
|
|
9999
10089
|
* ```
|
|
10000
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
10001
10090
|
*/
|
|
10002
10091
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
10003
10092
|
/**
|
|
@@ -10005,6 +10094,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
10005
10094
|
* branding in tool response cards.
|
|
10006
10095
|
*
|
|
10007
10096
|
* Supported embed types: `AppEmbed`
|
|
10097
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10008
10098
|
* @example
|
|
10009
10099
|
* ```js
|
|
10010
10100
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -10015,7 +10105,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
10015
10105
|
* },
|
|
10016
10106
|
* })
|
|
10017
10107
|
* ```
|
|
10018
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10019
10108
|
*/
|
|
10020
10109
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
10021
10110
|
/**
|
|
@@ -10035,6 +10124,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
10035
10124
|
* ```
|
|
10036
10125
|
*/
|
|
10037
10126
|
minimumHeight?: number;
|
|
10127
|
+
/**
|
|
10128
|
+
* To enable the homepage announcement banner.
|
|
10129
|
+
* Controls the visibility of the announcement section
|
|
10130
|
+
* on the homepage.
|
|
10131
|
+
*
|
|
10132
|
+
* Supported embed types: `AppEmbed`
|
|
10133
|
+
* @example
|
|
10134
|
+
* ```js
|
|
10135
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
10136
|
+
* ... // other embed view config
|
|
10137
|
+
* enableHomepageAnnouncement: true,
|
|
10138
|
+
* })
|
|
10139
|
+
* ```
|
|
10140
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
10141
|
+
*/
|
|
10142
|
+
enableHomepageAnnouncement?: boolean;
|
|
10038
10143
|
}
|
|
10039
10144
|
declare class AppEmbed extends V1Embed {
|
|
10040
10145
|
protected viewConfig: AppViewConfig;
|
|
@@ -10121,9 +10226,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10121
10226
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
10122
10227
|
* incrementally as users scroll the page to view the charts and tables.
|
|
10123
10228
|
*
|
|
10124
|
-
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
10125
10229
|
*
|
|
10126
10230
|
* Supported embed types: `LiveboardEmbed`
|
|
10231
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
10127
10232
|
* @example
|
|
10128
10233
|
* ```js
|
|
10129
10234
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -10134,14 +10239,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10134
10239
|
*/
|
|
10135
10240
|
fullHeight?: boolean;
|
|
10136
10241
|
/**
|
|
10137
|
-
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
10242
|
+
* This is the minimum height (in pixels) for a full-height Liveboard.
|
|
10138
10243
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
10139
10244
|
* other screens navigable from a Liveboard.
|
|
10140
10245
|
*
|
|
10141
10246
|
* Supported embed types: `LiveboardEmbed`
|
|
10142
10247
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
10143
|
-
* @default 500
|
|
10144
10248
|
* @deprecated Use `minimumHeight` instead.
|
|
10249
|
+
* @default 500
|
|
10145
10250
|
* @example
|
|
10146
10251
|
* ```js
|
|
10147
10252
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -10170,7 +10275,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10170
10275
|
*/
|
|
10171
10276
|
minimumHeight?: number;
|
|
10172
10277
|
/**
|
|
10173
|
-
*
|
|
10278
|
+
* If set to true, the context menu in visualizations will be enabled.
|
|
10279
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10280
|
+
* @deprecated this option is deprecated.
|
|
10174
10281
|
* @example
|
|
10175
10282
|
* ```js
|
|
10176
10283
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10178,7 +10285,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10178
10285
|
* enableVizTransformations:true,
|
|
10179
10286
|
* })
|
|
10180
10287
|
* ```
|
|
10181
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10182
10288
|
*/
|
|
10183
10289
|
enableVizTransformations?: boolean;
|
|
10184
10290
|
/**
|
|
@@ -10191,8 +10297,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10191
10297
|
* ```js
|
|
10192
10298
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10193
10299
|
* ... //other embed view config
|
|
10194
|
-
* liveboardId:id of liveboard,
|
|
10300
|
+
* liveboardId:'id of liveboard',
|
|
10195
10301
|
* })
|
|
10302
|
+
* ```
|
|
10196
10303
|
*/
|
|
10197
10304
|
liveboardId?: string;
|
|
10198
10305
|
/**
|
|
@@ -10245,6 +10352,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10245
10352
|
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
10246
10353
|
* ]
|
|
10247
10354
|
* })
|
|
10355
|
+
* ```
|
|
10248
10356
|
*/
|
|
10249
10357
|
visibleVizs?: string[];
|
|
10250
10358
|
/**
|
|
@@ -10272,6 +10380,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10272
10380
|
* Specify the tab ID.
|
|
10273
10381
|
*
|
|
10274
10382
|
* Supported embed types: `LiveboardEmbed`
|
|
10383
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
10275
10384
|
* @example
|
|
10276
10385
|
* ```js
|
|
10277
10386
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10279,7 +10388,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10279
10388
|
* activeTabId:'id-1234',
|
|
10280
10389
|
* })
|
|
10281
10390
|
* ```
|
|
10282
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
10283
10391
|
*/
|
|
10284
10392
|
activeTabId?: string;
|
|
10285
10393
|
/**
|
|
@@ -10288,6 +10396,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10288
10396
|
* that includes specific filter selections.
|
|
10289
10397
|
*
|
|
10290
10398
|
* Supported embed types: `LiveboardEmbed`
|
|
10399
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10291
10400
|
* @example
|
|
10292
10401
|
* ```js
|
|
10293
10402
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10296,7 +10405,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10296
10405
|
* activeTabId: 'tab-guid',
|
|
10297
10406
|
* })
|
|
10298
10407
|
* ```
|
|
10299
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10300
10408
|
*/
|
|
10301
10409
|
personalizedViewId?: string;
|
|
10302
10410
|
/**
|
|
@@ -10317,13 +10425,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10317
10425
|
* Show a preview image of the visualization before the visualization loads.
|
|
10318
10426
|
* Only works for visualizations embeds with a viz id.
|
|
10319
10427
|
*
|
|
10320
|
-
* Also, viz
|
|
10428
|
+
* Also, viz snapshot should be enabled in the ThoughtSpot instance.
|
|
10321
10429
|
* Contact ThoughtSpot support to enable this feature.
|
|
10322
10430
|
*
|
|
10323
|
-
* Since
|
|
10431
|
+
* Since this will show preview images, be careful that it may show
|
|
10324
10432
|
* undesired data to the user when using row level security.
|
|
10325
10433
|
*
|
|
10326
10434
|
* Supported embed types: `LiveboardEmbed`
|
|
10435
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10327
10436
|
* @example
|
|
10328
10437
|
* ```js
|
|
10329
10438
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10333,7 +10442,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10333
10442
|
* });
|
|
10334
10443
|
* embed.render();
|
|
10335
10444
|
* ```
|
|
10336
|
-
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10337
10445
|
*/
|
|
10338
10446
|
showPreviewLoader?: boolean;
|
|
10339
10447
|
/**
|
|
@@ -10341,13 +10449,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10341
10449
|
*
|
|
10342
10450
|
* Supported embed types: `LiveboardEmbed`
|
|
10343
10451
|
* @hidden
|
|
10344
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10452
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10345
10453
|
* @example
|
|
10346
10454
|
* ```js
|
|
10347
10455
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10348
10456
|
* ... //other embed view config
|
|
10349
|
-
* oAuthPollingInterval:
|
|
10457
|
+
* oAuthPollingInterval: 30000,
|
|
10350
10458
|
* })
|
|
10459
|
+
* ```
|
|
10351
10460
|
*/
|
|
10352
10461
|
oAuthPollingInterval?: number;
|
|
10353
10462
|
/**
|
|
@@ -10355,35 +10464,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10355
10464
|
*
|
|
10356
10465
|
* Supported embed types: `LiveboardEmbed`
|
|
10357
10466
|
* @hidden
|
|
10358
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10467
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10359
10468
|
* @example
|
|
10360
10469
|
* ```js
|
|
10361
10470
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10362
10471
|
* ... //other embed view config
|
|
10363
10472
|
* isForceRedirect: false,
|
|
10364
10473
|
* })
|
|
10474
|
+
* ```
|
|
10365
10475
|
*/
|
|
10366
10476
|
isForceRedirect?: boolean;
|
|
10367
10477
|
/**
|
|
10368
10478
|
* The source connection ID for authentication.
|
|
10369
|
-
* @hidden
|
|
10370
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10371
10479
|
*
|
|
10372
10480
|
* Supported embed types: `LiveboardEmbed`
|
|
10481
|
+
* @hidden
|
|
10482
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10373
10483
|
* @example
|
|
10374
10484
|
* ```js
|
|
10375
10485
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10376
10486
|
* ... //other embed view config
|
|
10377
10487
|
* dataSourceId: '',
|
|
10378
10488
|
* })
|
|
10489
|
+
* ```
|
|
10379
10490
|
*/
|
|
10380
10491
|
dataSourceId?: string;
|
|
10381
10492
|
/**
|
|
10382
|
-
* The list of tab IDs to hide from the embedded.
|
|
10383
|
-
*
|
|
10384
|
-
* Use this to hide
|
|
10493
|
+
* The list of tab IDs to hide from the embedded Liveboard.
|
|
10494
|
+
* These tabs will be hidden from their respective Liveboards.
|
|
10495
|
+
* Use this to hide a tab ID.
|
|
10385
10496
|
*
|
|
10386
10497
|
* Supported embed types: `LiveboardEmbed`
|
|
10498
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
10387
10499
|
* @example
|
|
10388
10500
|
* ```js
|
|
10389
10501
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10394,7 +10506,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10394
10506
|
* ]
|
|
10395
10507
|
* });
|
|
10396
10508
|
* ```
|
|
10397
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
10398
10509
|
*/
|
|
10399
10510
|
hiddenTabs?: string[];
|
|
10400
10511
|
/**
|
|
@@ -10418,7 +10529,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10418
10529
|
*/
|
|
10419
10530
|
visibleTabs?: string[];
|
|
10420
10531
|
/**
|
|
10421
|
-
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
10532
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
10533
|
+
* @deprecated This flag is deprecated.
|
|
10422
10534
|
*
|
|
10423
10535
|
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
|
|
10424
10536
|
* @type {boolean}
|
|
@@ -10484,6 +10596,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10484
10596
|
/**
|
|
10485
10597
|
* This flag is used to enable the full height lazy load data.
|
|
10486
10598
|
*
|
|
10599
|
+
* @type {boolean}
|
|
10600
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10601
|
+
* @default false
|
|
10487
10602
|
* @example
|
|
10488
10603
|
* ```js
|
|
10489
10604
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -10492,33 +10607,29 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10492
10607
|
* lazyLoadingForFullHeight: true,
|
|
10493
10608
|
* })
|
|
10494
10609
|
* ```
|
|
10495
|
-
*
|
|
10496
|
-
* @type {boolean}
|
|
10497
|
-
* @default false
|
|
10498
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
10499
10610
|
*/
|
|
10500
10611
|
lazyLoadingForFullHeight?: boolean;
|
|
10501
10612
|
/**
|
|
10502
10613
|
* The margin to be used for lazy loading.
|
|
10503
10614
|
*
|
|
10504
10615
|
* For example, if the margin is set to '10px',
|
|
10505
|
-
* the visualization will be loaded 10px before
|
|
10616
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
10506
10617
|
* viewport.
|
|
10507
10618
|
*
|
|
10508
10619
|
* The format is similar to CSS margin.
|
|
10509
10620
|
*
|
|
10621
|
+
* @type {string}
|
|
10622
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10510
10623
|
* @example
|
|
10511
10624
|
* ```js
|
|
10512
10625
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
10513
10626
|
* // ...other options
|
|
10514
10627
|
* fullHeight: true,
|
|
10515
10628
|
* lazyLoadingForFullHeight: true,
|
|
10516
|
-
* // Using 0px, the visualization will be only loaded when
|
|
10629
|
+
* // Using 0px, the visualization will be only loaded when it's visible in the viewport.
|
|
10517
10630
|
* lazyLoadingMargin: '0px',
|
|
10518
10631
|
* })
|
|
10519
10632
|
* ```
|
|
10520
|
-
* @type {string}
|
|
10521
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
10522
10633
|
*/
|
|
10523
10634
|
lazyLoadingMargin?: string;
|
|
10524
10635
|
/**
|
|
@@ -10526,6 +10637,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10526
10637
|
* of the spotter underneath the chat input.
|
|
10527
10638
|
* default is false.
|
|
10528
10639
|
*
|
|
10640
|
+
* @type {boolean}
|
|
10641
|
+
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
10529
10642
|
* @example
|
|
10530
10643
|
* ```js
|
|
10531
10644
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -10533,14 +10646,13 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10533
10646
|
* showSpotterLimitations: true,
|
|
10534
10647
|
* })
|
|
10535
10648
|
* ```
|
|
10536
|
-
* @type {boolean}
|
|
10537
|
-
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
10538
10649
|
*/
|
|
10539
10650
|
showSpotterLimitations?: boolean;
|
|
10540
10651
|
/**
|
|
10541
10652
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
10542
10653
|
*
|
|
10543
10654
|
* Supported embed types: `LiveboardEmbed`
|
|
10655
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10544
10656
|
* @default false
|
|
10545
10657
|
* @example
|
|
10546
10658
|
* ```js
|
|
@@ -10549,7 +10661,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10549
10661
|
* updatedSpotterChatPrompt : true,
|
|
10550
10662
|
* })
|
|
10551
10663
|
* ```
|
|
10552
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10553
10664
|
*/
|
|
10554
10665
|
updatedSpotterChatPrompt?: boolean;
|
|
10555
10666
|
/**
|
|
@@ -10557,6 +10668,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10557
10668
|
* branding in tool response cards.
|
|
10558
10669
|
*
|
|
10559
10670
|
* Supported embed types: `LiveboardEmbed`
|
|
10671
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10560
10672
|
* @example
|
|
10561
10673
|
* ```js
|
|
10562
10674
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10567,7 +10679,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10567
10679
|
* },
|
|
10568
10680
|
* })
|
|
10569
10681
|
* ```
|
|
10570
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10571
10682
|
*/
|
|
10572
10683
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
10573
10684
|
}
|
|
@@ -10734,9 +10845,9 @@ export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter | null
|
|
|
10734
10845
|
export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
|
|
10735
10846
|
/**
|
|
10736
10847
|
* Reloads the ThoughtSpot iframe.
|
|
10848
|
+
* @version SDK: 1.43.1
|
|
10737
10849
|
* @param iFrame
|
|
10738
10850
|
* @group Global methods
|
|
10739
|
-
* @version SDK: 1.43.1
|
|
10740
10851
|
*/
|
|
10741
10852
|
export declare const reloadIframe: (iFrame: HTMLIFrameElement) => void;
|
|
10742
10853
|
export type SessionInfo = {
|
|
@@ -10838,6 +10949,9 @@ export interface PreRenderProps {
|
|
|
10838
10949
|
* PreRender id to be used for PreRendering the embed.
|
|
10839
10950
|
* Use PreRender to render the embed in the background and then
|
|
10840
10951
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
10952
|
+
*
|
|
10953
|
+
* Use PreRendered react component for pre rendering embed components.
|
|
10954
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
|
|
10841
10955
|
* @example
|
|
10842
10956
|
* ```js
|
|
10843
10957
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -10846,8 +10960,6 @@ export interface PreRenderProps {
|
|
|
10846
10960
|
* });
|
|
10847
10961
|
* embed.showPreRender();
|
|
10848
10962
|
* ```
|
|
10849
|
-
*
|
|
10850
|
-
* Use PreRendered react component for pre rendering embed components.
|
|
10851
10963
|
* @example
|
|
10852
10964
|
* ```tsx
|
|
10853
10965
|
* function LandingPageComponent() {
|
|
@@ -10858,7 +10970,6 @@ export interface PreRenderProps {
|
|
|
10858
10970
|
* return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
|
|
10859
10971
|
* }
|
|
10860
10972
|
* ```
|
|
10861
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
|
|
10862
10973
|
*/
|
|
10863
10974
|
preRenderId: string;
|
|
10864
10975
|
}
|
|
@@ -10882,7 +10993,7 @@ export interface AppProps extends EmbedProps, AppViewConfig {
|
|
|
10882
10993
|
* React component for Full app Embed.
|
|
10883
10994
|
* @example
|
|
10884
10995
|
* ```tsx
|
|
10885
|
-
* function
|
|
10996
|
+
* function App() {
|
|
10886
10997
|
* return <AppEmbed
|
|
10887
10998
|
* showPrimaryNavbar={false}
|
|
10888
10999
|
* pageId={Page.Liveboards}
|
|
@@ -10893,9 +11004,9 @@ export interface AppProps extends EmbedProps, AppViewConfig {
|
|
|
10893
11004
|
*/
|
|
10894
11005
|
declare const AppEmbed$1: React$1.ForwardRefExoticComponent<AppProps & React$1.RefAttributes<AppEmbed>>;
|
|
10895
11006
|
/**
|
|
10896
|
-
* React component for PreRendered
|
|
11007
|
+
* React component for PreRendered App embed.
|
|
10897
11008
|
*
|
|
10898
|
-
* PreRenderedAppEmbed will preRender the
|
|
11009
|
+
* PreRenderedAppEmbed will preRender the AppEmbed and will be hidden by
|
|
10899
11010
|
* default.
|
|
10900
11011
|
*
|
|
10901
11012
|
* AppEmbed with preRenderId passed will call showPreRender on the embed.
|
|
@@ -10936,7 +11047,7 @@ declare const LiveboardEmbed$1: React$1.ForwardRefExoticComponent<LiveboardProps
|
|
|
10936
11047
|
* LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
|
|
10937
11048
|
*
|
|
10938
11049
|
* If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
|
|
10939
|
-
* tries to preRender the LiveboardEmbed, so it is recommended to
|
|
11050
|
+
* tries to preRender the LiveboardEmbed, so it is recommended to pass the
|
|
10940
11051
|
* liveboardId to both the components.
|
|
10941
11052
|
* @example
|
|
10942
11053
|
* ```tsx
|
|
@@ -10966,7 +11077,7 @@ export interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
|
|
|
10966
11077
|
*/
|
|
10967
11078
|
declare const SearchBarEmbed$1: React$1.ForwardRefExoticComponent<SearchBarEmbedProps & React$1.RefAttributes<SearchBarEmbed>>;
|
|
10968
11079
|
/**
|
|
10969
|
-
* React component for PreRendered
|
|
11080
|
+
* React component for PreRendered SearchBar embed.
|
|
10970
11081
|
*
|
|
10971
11082
|
* PreRenderedSearchBarEmbed will preRender the SearchBarEmbed and will be hidden by
|
|
10972
11083
|
* default.
|
|
@@ -11000,9 +11111,9 @@ export interface SageEmbedProps extends EmbedProps, SageViewConfig {
|
|
|
11000
11111
|
*/
|
|
11001
11112
|
declare const SageEmbed$1: React$1.ForwardRefExoticComponent<SageEmbedProps & React$1.RefAttributes<SageEmbed>>;
|
|
11002
11113
|
/**
|
|
11003
|
-
* React component for PreRendered
|
|
11114
|
+
* React component for PreRendered Sage embed.
|
|
11004
11115
|
*
|
|
11005
|
-
* PreRenderedSageEmbed will preRender the
|
|
11116
|
+
* PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
|
|
11006
11117
|
* default.
|
|
11007
11118
|
*
|
|
11008
11119
|
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
@@ -11040,8 +11151,8 @@ export interface ConversationEmbedProps extends EmbedProps, ConversationViewConf
|
|
|
11040
11151
|
declare const SpotterEmbed$1: React$1.ForwardRefExoticComponent<SpotterEmbedProps & React$1.RefAttributes<SpotterEmbed>>;
|
|
11041
11152
|
/**
|
|
11042
11153
|
* React component for LLM based conversation BI.
|
|
11043
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
11044
11154
|
* Use {@link SpotterEmbed} instead
|
|
11155
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
11045
11156
|
* @example
|
|
11046
11157
|
* ```tsx
|
|
11047
11158
|
* function Sage() {
|
|
@@ -11070,6 +11181,7 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
|
|
|
11070
11181
|
* This component renders a single message response from your ThoughtSpot conversation,
|
|
11071
11182
|
* showing charts, visualizations, or text responses based on the user's query.
|
|
11072
11183
|
*
|
|
11184
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
11073
11185
|
* @example
|
|
11074
11186
|
* ```tsx
|
|
11075
11187
|
* const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
|
|
@@ -11086,7 +11198,6 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
|
|
|
11086
11198
|
* />
|
|
11087
11199
|
* }
|
|
11088
11200
|
* ```
|
|
11089
|
-
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
11090
11201
|
*/
|
|
11091
11202
|
export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
|
|
11092
11203
|
message: SpotterAgentMessageViewConfig;
|
|
@@ -11098,7 +11209,7 @@ export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
|
|
|
11098
11209
|
* PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
|
|
11099
11210
|
* default.
|
|
11100
11211
|
*
|
|
11101
|
-
*
|
|
11212
|
+
* SpotterEmbed with preRenderId passed will call showPreRender on the embed.
|
|
11102
11213
|
* @example
|
|
11103
11214
|
* ```tsx
|
|
11104
11215
|
* function LandingPageComponent() {
|
|
@@ -11131,6 +11242,7 @@ export type EmbedComponent = typeof SearchEmbed$1 | typeof AppEmbed$1 | typeof L
|
|
|
11131
11242
|
export declare function useEmbedRef<T extends EmbedComponent>(): React$1.MutableRefObject<React$1.ComponentRef<T>>;
|
|
11132
11243
|
/**
|
|
11133
11244
|
*
|
|
11245
|
+
* @version SDK: 1.36.2 | ThoughtSpot: *
|
|
11134
11246
|
* @param config - EmbedConfig
|
|
11135
11247
|
* @returns AuthEventEmitter
|
|
11136
11248
|
* @example
|
|
@@ -11140,7 +11252,6 @@ export declare function useEmbedRef<T extends EmbedComponent>(): React$1.Mutable
|
|
|
11140
11252
|
* return <LiveboardEmbed ref={ref} liveboardId={<id>} />
|
|
11141
11253
|
* }
|
|
11142
11254
|
* ```
|
|
11143
|
-
* @version SDK: 1.36.2 | ThoughtSpot: *
|
|
11144
11255
|
*/
|
|
11145
11256
|
export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<AuthEventEmitter>;
|
|
11146
11257
|
/**
|
|
@@ -11149,6 +11260,7 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
|
|
|
11149
11260
|
* This hook provides a sendMessage function that allows you to send natural language
|
|
11150
11261
|
* queries to your data and get back AI-generated responses with visualizations.
|
|
11151
11262
|
*
|
|
11263
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
11152
11264
|
* @param config - Configuration object containing worksheetId and other options
|
|
11153
11265
|
* @returns Object with sendMessage function that returns conversation results
|
|
11154
11266
|
* @example
|
|
@@ -11166,7 +11278,6 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
|
|
|
11166
11278
|
* }
|
|
11167
11279
|
* };
|
|
11168
11280
|
* ```
|
|
11169
|
-
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
11170
11281
|
*/
|
|
11171
11282
|
export declare function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
|
|
11172
11283
|
sendMessage: (query: string) => Promise<{
|