@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
|
@@ -426,37 +426,37 @@ export interface CustomCssVariables {
|
|
|
426
426
|
/**
|
|
427
427
|
* Padding of the groups in the Liveboard.
|
|
428
428
|
*
|
|
429
|
-
* Please enable the Liveboard
|
|
429
|
+
* 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.
|
|
430
430
|
*/
|
|
431
431
|
"--ts-var-liveboard-group-padding"?: string;
|
|
432
432
|
/**
|
|
433
433
|
* Font size of the title of the groups in the Liveboard.
|
|
434
434
|
*
|
|
435
|
-
* Please enable the Liveboard
|
|
435
|
+
* 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.
|
|
436
436
|
*/
|
|
437
437
|
"--ts-var-liveboard-group-title-font-size"?: string;
|
|
438
438
|
/**
|
|
439
439
|
* Font weight of the title of the groups in the Liveboard.
|
|
440
440
|
*
|
|
441
|
-
* Please enable the Liveboard
|
|
441
|
+
* 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.
|
|
442
442
|
*/
|
|
443
443
|
"--ts-var-liveboard-group-title-font-weight"?: string;
|
|
444
444
|
/**
|
|
445
445
|
* Font size of the title of the tiles inside the groups in the Liveboard.
|
|
446
446
|
*
|
|
447
|
-
* Please enable the Liveboard
|
|
447
|
+
* 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.
|
|
448
448
|
*/
|
|
449
449
|
"--ts-var-liveboard-group-tile-title-font-size"?: string;
|
|
450
450
|
/**
|
|
451
451
|
* Font weight of the title of the tiles inside the groups in the Liveboard.
|
|
452
452
|
*
|
|
453
|
-
* Please enable the Liveboard
|
|
453
|
+
* 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.
|
|
454
454
|
*/
|
|
455
455
|
"--ts-var-liveboard-group-tile-title-font-weight"?: string;
|
|
456
456
|
/**
|
|
457
457
|
* Padding of the group tiles in the Liveboard.
|
|
458
458
|
*
|
|
459
|
-
* Please enable the Liveboard
|
|
459
|
+
* 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.
|
|
460
460
|
*/
|
|
461
461
|
"--ts-var-liveboard-group-tile-padding"?: string;
|
|
462
462
|
/**
|
|
@@ -466,13 +466,13 @@ export interface CustomCssVariables {
|
|
|
466
466
|
/**
|
|
467
467
|
* Background color of the groups in the Liveboard.
|
|
468
468
|
*
|
|
469
|
-
* Please enable the Liveboard
|
|
469
|
+
* 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.
|
|
470
470
|
*/
|
|
471
471
|
"--ts-var-liveboard-group-background"?: string;
|
|
472
472
|
/**
|
|
473
473
|
* Border color of the groups in the Liveboard.
|
|
474
474
|
*
|
|
475
|
-
* Please enable the Liveboard
|
|
475
|
+
* 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.
|
|
476
476
|
*/
|
|
477
477
|
"--ts-var-liveboard-group-border-color"?: string;
|
|
478
478
|
/**
|
|
@@ -486,55 +486,55 @@ export interface CustomCssVariables {
|
|
|
486
486
|
/**
|
|
487
487
|
* Font color of the title of the groups in the Liveboard.
|
|
488
488
|
*
|
|
489
|
-
* Please enable the Liveboard
|
|
489
|
+
* 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.
|
|
490
490
|
*/
|
|
491
491
|
"--ts-var-liveboard-group-title-font-color"?: string;
|
|
492
492
|
/**
|
|
493
493
|
* Font color of the description of the groups in the Liveboard.
|
|
494
494
|
*
|
|
495
|
-
* Please enable the Liveboard
|
|
495
|
+
* 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.
|
|
496
496
|
*/
|
|
497
497
|
"--ts-var-liveboard-group-description-font-color"?: string;
|
|
498
498
|
/**
|
|
499
499
|
* Font color of the title of the tiles inside the groups in the Liveboard.
|
|
500
500
|
*
|
|
501
|
-
* Please enable the Liveboard
|
|
501
|
+
* 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.
|
|
502
502
|
*/
|
|
503
503
|
"--ts-var-liveboard-group-tile-title-font-color"?: string;
|
|
504
504
|
/**
|
|
505
505
|
* Font color of the description of the tiles inside the groups in the Liveboard.
|
|
506
506
|
*
|
|
507
|
-
* Please enable the Liveboard
|
|
507
|
+
* 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.
|
|
508
508
|
*/
|
|
509
509
|
"--ts-var-liveboard-group-tile-description-font-color"?: string;
|
|
510
510
|
/**
|
|
511
511
|
* Background color of the tiles inside the groups in the Liveboard.
|
|
512
512
|
*
|
|
513
|
-
* Please enable the Liveboard
|
|
513
|
+
* 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.
|
|
514
514
|
*/
|
|
515
515
|
"--ts-var-liveboard-group-tile-background"?: string;
|
|
516
516
|
/**
|
|
517
517
|
* Background color of the filter chips in the Liveboard.
|
|
518
518
|
*
|
|
519
|
-
* Please enable the Liveboard
|
|
519
|
+
* 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.
|
|
520
520
|
*/
|
|
521
521
|
"--ts-var-liveboard-chip-background"?: string;
|
|
522
522
|
/**
|
|
523
523
|
* Font color of the filter chips in the Liveboard.
|
|
524
524
|
*
|
|
525
|
-
* Please enable the Liveboard
|
|
525
|
+
* 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.
|
|
526
526
|
*/
|
|
527
527
|
"--ts-var-liveboard-chip-color"?: string;
|
|
528
528
|
/**
|
|
529
529
|
* Background color of the filter chips in the Liveboard on hover.
|
|
530
530
|
*
|
|
531
|
-
* Please enable the Liveboard
|
|
531
|
+
* 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.
|
|
532
532
|
*/
|
|
533
533
|
"--ts-var-liveboard-chip--hover-background"?: string;
|
|
534
534
|
/**
|
|
535
535
|
* Background color of the filter chips in the Liveboard on active.
|
|
536
536
|
*
|
|
537
|
-
* Please enable the Liveboard
|
|
537
|
+
* 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.
|
|
538
538
|
*/
|
|
539
539
|
"--ts-var-liveboard-chip--active-background"?: string;
|
|
540
540
|
/**
|
|
@@ -807,7 +807,7 @@ export interface UnderlyingDataPoint {
|
|
|
807
807
|
* });
|
|
808
808
|
* ```
|
|
809
809
|
*
|
|
810
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
810
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
811
811
|
* @group Events
|
|
812
812
|
*/
|
|
813
813
|
export declare class AnswerService {
|
|
@@ -855,6 +855,7 @@ export declare class AnswerService {
|
|
|
855
855
|
* ]);
|
|
856
856
|
* console.log(await service.fetchData());
|
|
857
857
|
* });
|
|
858
|
+
* ```
|
|
858
859
|
*/
|
|
859
860
|
addColumnsByName(columnNames: string[]): Promise<any>;
|
|
860
861
|
/**
|
|
@@ -926,7 +927,7 @@ export declare class AnswerService {
|
|
|
926
927
|
* const data = await underlying.fetchData(0, 100);
|
|
927
928
|
* })
|
|
928
929
|
* ```
|
|
929
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
930
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
930
931
|
*/
|
|
931
932
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
932
933
|
/**
|
|
@@ -947,7 +948,7 @@ export declare class AnswerService {
|
|
|
947
948
|
setTMLOverride(override: any): void;
|
|
948
949
|
}
|
|
949
950
|
/**
|
|
950
|
-
* The authentication mechanism for allowing access to
|
|
951
|
+
* The authentication mechanism for allowing access to
|
|
951
952
|
* the embedded app
|
|
952
953
|
* @group Authentication / Init
|
|
953
954
|
*/
|
|
@@ -972,6 +973,7 @@ export declare enum AuthType {
|
|
|
972
973
|
* To use this:
|
|
973
974
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
974
975
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
976
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
975
977
|
* @example
|
|
976
978
|
* ```js
|
|
977
979
|
* init({
|
|
@@ -979,18 +981,17 @@ export declare enum AuthType {
|
|
|
979
981
|
* authType: AuthType.EmbeddedSSO,
|
|
980
982
|
* });
|
|
981
983
|
* ```
|
|
982
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
983
984
|
*/
|
|
984
985
|
EmbeddedSSO = "EmbeddedSSO",
|
|
985
986
|
/**
|
|
986
|
-
* SSO using SAML
|
|
987
|
-
* @deprecated
|
|
987
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
988
|
+
* @deprecated This option is deprecated.
|
|
988
989
|
* @hidden
|
|
989
990
|
*/
|
|
990
991
|
SSO = "SSO_SAML",
|
|
991
992
|
/**
|
|
992
|
-
* SSO using SAML
|
|
993
|
-
* @deprecated
|
|
993
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
994
|
+
* @deprecated This option is deprecated.
|
|
994
995
|
* @hidden
|
|
995
996
|
*/
|
|
996
997
|
SAML = "SSO_SAML",
|
|
@@ -1041,8 +1042,9 @@ export declare enum AuthType {
|
|
|
1041
1042
|
SAMLRedirect = "SSO_SAML",
|
|
1042
1043
|
/**
|
|
1043
1044
|
* SSO using OIDC
|
|
1045
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
1046
|
+
* @deprecated This option is deprecated.
|
|
1044
1047
|
* @hidden
|
|
1045
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
1046
1048
|
*/
|
|
1047
1049
|
OIDC = "SSO_OIDC",
|
|
1048
1050
|
/**
|
|
@@ -1053,8 +1055,9 @@ export declare enum AuthType {
|
|
|
1053
1055
|
OIDCRedirect = "SSO_OIDC",
|
|
1054
1056
|
/**
|
|
1055
1057
|
* Trusted authentication server
|
|
1058
|
+
* Use {@link TrustedAuth} instead
|
|
1059
|
+
* @deprecated This option is deprecated.
|
|
1056
1060
|
* @hidden
|
|
1057
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
1058
1061
|
*/
|
|
1059
1062
|
AuthServer = "AuthServer",
|
|
1060
1063
|
/**
|
|
@@ -1081,6 +1084,7 @@ export declare enum AuthType {
|
|
|
1081
1084
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1082
1085
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1083
1086
|
* implemented by some browsers.
|
|
1087
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1084
1088
|
* @example
|
|
1085
1089
|
* ```js
|
|
1086
1090
|
* init({
|
|
@@ -1091,8 +1095,8 @@ export declare enum AuthType {
|
|
|
1091
1095
|
* .then((response) => response.json())
|
|
1092
1096
|
* .then((data) => data.token);
|
|
1093
1097
|
* }
|
|
1098
|
+
* });
|
|
1094
1099
|
* ```
|
|
1095
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1096
1100
|
*/
|
|
1097
1101
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
1098
1102
|
/**
|
|
@@ -1112,43 +1116,43 @@ export declare enum HomeLeftNavItem {
|
|
|
1112
1116
|
/**
|
|
1113
1117
|
* The *Search data* option in
|
|
1114
1118
|
* the *Insights* left navigation panel.
|
|
1115
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1119
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1116
1120
|
*/
|
|
1117
1121
|
SearchData = "search-data",
|
|
1118
1122
|
/**
|
|
1119
1123
|
* The *Home* menu option in
|
|
1120
1124
|
* the *Insights* left navigation panel.
|
|
1121
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1125
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1122
1126
|
*/
|
|
1123
1127
|
Home = "insights-home",
|
|
1124
1128
|
/**
|
|
1125
1129
|
* The *Liveboards* menu option in
|
|
1126
1130
|
* the *Insights* left navigation panel.
|
|
1127
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1131
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1128
1132
|
*/
|
|
1129
1133
|
Liveboards = "liveboards",
|
|
1130
1134
|
/**
|
|
1131
1135
|
* The *Answers* menu option in
|
|
1132
1136
|
* the *Insights* left navigation panel.
|
|
1133
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1137
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1134
1138
|
*/
|
|
1135
1139
|
Answers = "answers",
|
|
1136
1140
|
/**
|
|
1137
1141
|
* The *Monitor subscriptions* menu option in
|
|
1138
1142
|
* the *Insights* left navigation panel.
|
|
1139
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1143
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1140
1144
|
*/
|
|
1141
1145
|
MonitorSubscription = "monitor-alerts",
|
|
1142
1146
|
/**
|
|
1143
1147
|
* The *SpotIQ analysis* menu option in
|
|
1144
1148
|
* the *Insights* left navigation panel.
|
|
1145
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1149
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1146
1150
|
*/
|
|
1147
1151
|
SpotIQAnalysis = "spotiq-analysis",
|
|
1148
1152
|
/**
|
|
1149
1153
|
* The *Liveboard schedules* menu option in
|
|
1150
1154
|
* the *Insights* left navigation panel.
|
|
1151
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
1155
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
1152
1156
|
*/
|
|
1153
1157
|
LiveboardSchedules = "liveboard-schedules",
|
|
1154
1158
|
/**
|
|
@@ -1319,8 +1323,8 @@ export interface EmbedConfig {
|
|
|
1319
1323
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1320
1324
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1321
1325
|
* place.
|
|
1326
|
+
* @deprecated This option is deprecated.
|
|
1322
1327
|
* @default false
|
|
1323
|
-
* @deprecated
|
|
1324
1328
|
*/
|
|
1325
1329
|
noRedirect?: boolean;
|
|
1326
1330
|
/**
|
|
@@ -1329,8 +1333,8 @@ export interface EmbedConfig {
|
|
|
1329
1333
|
*
|
|
1330
1334
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1331
1335
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1332
|
-
* @default false
|
|
1333
1336
|
* @version SDK: 1.18.0
|
|
1337
|
+
* @default false
|
|
1334
1338
|
*/
|
|
1335
1339
|
inPopup?: boolean;
|
|
1336
1340
|
/**
|
|
@@ -1339,7 +1343,7 @@ export interface EmbedConfig {
|
|
|
1339
1343
|
* terminated.
|
|
1340
1344
|
*
|
|
1341
1345
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1342
|
-
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1346
|
+
* @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1343
1347
|
*/
|
|
1344
1348
|
redirectPath?: string;
|
|
1345
1349
|
/** @internal */
|
|
@@ -1412,7 +1416,7 @@ export interface EmbedConfig {
|
|
|
1412
1416
|
detectCookieAccessSlow?: boolean;
|
|
1413
1417
|
/**
|
|
1414
1418
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
1415
|
-
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1419
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1416
1420
|
*/
|
|
1417
1421
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
1418
1422
|
/**
|
|
@@ -1429,6 +1433,7 @@ export interface EmbedConfig {
|
|
|
1429
1433
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
1430
1434
|
* button that the user can click to trigger the flow.
|
|
1431
1435
|
* This attribute sets a containing element for that button.
|
|
1436
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1432
1437
|
* @example
|
|
1433
1438
|
* ```js
|
|
1434
1439
|
* init({
|
|
@@ -1437,7 +1442,6 @@ export interface EmbedConfig {
|
|
|
1437
1442
|
* authTriggerContainer: '#auth-trigger-container'
|
|
1438
1443
|
* })
|
|
1439
1444
|
* ```
|
|
1440
|
-
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1441
1445
|
*/
|
|
1442
1446
|
authTriggerContainer?: string | HTMLElement;
|
|
1443
1447
|
/**
|
|
@@ -1454,11 +1458,10 @@ export interface EmbedConfig {
|
|
|
1454
1458
|
*/
|
|
1455
1459
|
authTriggerText?: string;
|
|
1456
1460
|
/**
|
|
1457
|
-
* Prevent users from accessing
|
|
1458
|
-
*
|
|
1459
|
-
* outside of the iframe.
|
|
1460
|
-
* @default true
|
|
1461
|
+
* Prevent embedded application users from accessing ThoughtSpot
|
|
1462
|
+
* application pages outside of the iframe.
|
|
1461
1463
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1464
|
+
* @default true
|
|
1462
1465
|
*/
|
|
1463
1466
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1464
1467
|
/**
|
|
@@ -1488,6 +1491,7 @@ export interface EmbedConfig {
|
|
|
1488
1491
|
* other logs such as warnings, information alerts,
|
|
1489
1492
|
* and debug messages in the console output.
|
|
1490
1493
|
*
|
|
1494
|
+
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
1491
1495
|
* @default LogLevel.ERROR
|
|
1492
1496
|
* @example
|
|
1493
1497
|
* ```js
|
|
@@ -1496,7 +1500,6 @@ export interface EmbedConfig {
|
|
|
1496
1500
|
* logLevel: LogLevel.SILENT
|
|
1497
1501
|
* })
|
|
1498
1502
|
* ```
|
|
1499
|
-
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
1500
1503
|
*/
|
|
1501
1504
|
logLevel?: LogLevel;
|
|
1502
1505
|
/**
|
|
@@ -1523,6 +1526,7 @@ export interface EmbedConfig {
|
|
|
1523
1526
|
* This flag is used to disable the token verification in the SDK.
|
|
1524
1527
|
* Enabling this flag will also disable the caching of the token.
|
|
1525
1528
|
* @hidden
|
|
1529
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
1526
1530
|
* @example
|
|
1527
1531
|
* ```js
|
|
1528
1532
|
* init({
|
|
@@ -1530,12 +1534,11 @@ export interface EmbedConfig {
|
|
|
1530
1534
|
* disableTokenVerification : true
|
|
1531
1535
|
* })
|
|
1532
1536
|
* ```
|
|
1533
|
-
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
1534
1537
|
*/
|
|
1535
1538
|
disableTokenVerification?: boolean;
|
|
1536
1539
|
/**
|
|
1537
1540
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
1538
|
-
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
1541
|
+
* @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
1539
1542
|
*/
|
|
1540
1543
|
disableLoginFailurePage?: boolean;
|
|
1541
1544
|
/**
|
|
@@ -1545,6 +1548,7 @@ export interface EmbedConfig {
|
|
|
1545
1548
|
* Warning: This option is for advanced use only and is used internally
|
|
1546
1549
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1547
1550
|
* list of supported keys and values associated with each.
|
|
1551
|
+
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
1548
1552
|
* @example
|
|
1549
1553
|
* ```js
|
|
1550
1554
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1555,7 +1559,6 @@ export interface EmbedConfig {
|
|
|
1555
1559
|
* }
|
|
1556
1560
|
* });
|
|
1557
1561
|
* ```
|
|
1558
|
-
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
1559
1562
|
*/
|
|
1560
1563
|
additionalFlags?: {
|
|
1561
1564
|
[key: string]: string | number | boolean;
|
|
@@ -1563,6 +1566,7 @@ export interface EmbedConfig {
|
|
|
1563
1566
|
/**
|
|
1564
1567
|
* This is an object (key/val) for customVariables being
|
|
1565
1568
|
* used by the third party tool's script.
|
|
1569
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1566
1570
|
* @example
|
|
1567
1571
|
* ```js
|
|
1568
1572
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1573,15 +1577,14 @@ export interface EmbedConfig {
|
|
|
1573
1577
|
* }
|
|
1574
1578
|
* });
|
|
1575
1579
|
* ```
|
|
1576
|
-
* @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1577
1580
|
*/
|
|
1578
1581
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
1579
1582
|
disablePreauthCache?: boolean;
|
|
1580
1583
|
/**
|
|
1581
1584
|
* Disable fullscreen presentation mode functionality. When enabled, prevents entering
|
|
1582
1585
|
* and exiting fullscreen mode for embedded visualizations during presentations.
|
|
1583
|
-
* @default true (feature is disabled by default)
|
|
1584
1586
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1587
|
+
* @default true (feature is disabled by default)
|
|
1585
1588
|
* @example
|
|
1586
1589
|
* ```js
|
|
1587
1590
|
* init({
|
|
@@ -1787,7 +1790,7 @@ export interface FrameParams {
|
|
|
1787
1790
|
*/
|
|
1788
1791
|
loading?: "lazy" | "eager" | "auto";
|
|
1789
1792
|
/**
|
|
1790
|
-
*
|
|
1793
|
+
* These parameters will be passed to the iframe
|
|
1791
1794
|
* as is.
|
|
1792
1795
|
*/
|
|
1793
1796
|
[key: string]: string | number | boolean | undefined;
|
|
@@ -1862,8 +1865,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1862
1865
|
*/
|
|
1863
1866
|
disabledActionReason?: string;
|
|
1864
1867
|
/**
|
|
1865
|
-
* The list of actions to hide from the embedded.
|
|
1866
|
-
*
|
|
1868
|
+
* The list of actions to hide from the embedded view.
|
|
1869
|
+
* These actions will be hidden from the user.
|
|
1867
1870
|
* Use this to hide an action.
|
|
1868
1871
|
*
|
|
1869
1872
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
@@ -1904,7 +1907,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1904
1907
|
* The locale settings to apply to the embedded view.
|
|
1905
1908
|
*
|
|
1906
1909
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1907
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
1910
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1908
1911
|
* @example
|
|
1909
1912
|
* ```js
|
|
1910
1913
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1919,12 +1922,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1919
1922
|
* This is an object (key/val) of override flags which will be applied
|
|
1920
1923
|
* to the internal embedded object. This can be used to add any
|
|
1921
1924
|
* URL flag.
|
|
1922
|
-
* If the same flags are passed in init, they will be
|
|
1925
|
+
* If the same flags are passed in init, they will be overridden by the values here.
|
|
1923
1926
|
* Warning: This option is for advanced use only and is used internally
|
|
1924
1927
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1925
1928
|
* list of supported keys and values associated with each.
|
|
1926
1929
|
*
|
|
1927
1930
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1931
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1928
1932
|
* @example
|
|
1929
1933
|
* ```js
|
|
1930
1934
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1936,7 +1940,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1936
1940
|
* },
|
|
1937
1941
|
* });
|
|
1938
1942
|
* ```
|
|
1939
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1940
1943
|
*/
|
|
1941
1944
|
additionalFlags?: {
|
|
1942
1945
|
[key: string]: string | number | boolean;
|
|
@@ -1979,6 +1982,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1979
1982
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1980
1983
|
*
|
|
1981
1984
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1985
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1982
1986
|
* @example
|
|
1983
1987
|
* ```js
|
|
1984
1988
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1988,7 +1992,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1988
1992
|
* });
|
|
1989
1993
|
* embed.showPreRender();
|
|
1990
1994
|
* ```
|
|
1991
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1992
1995
|
*/
|
|
1993
1996
|
preRenderId?: string;
|
|
1994
1997
|
/**
|
|
@@ -1998,7 +2001,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1998
2001
|
* its dimensions based on changes to the size of the embedding element.
|
|
1999
2002
|
* @type {boolean}
|
|
2000
2003
|
* @default false
|
|
2001
|
-
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2004
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
|
|
2002
2005
|
* @example
|
|
2003
2006
|
* ```js
|
|
2004
2007
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -2013,9 +2016,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2013
2016
|
doNotTrackPreRenderSize?: boolean;
|
|
2014
2017
|
/**
|
|
2015
2018
|
* Enable the V2 shell. This can provide performance benefits
|
|
2016
|
-
* due to a
|
|
2019
|
+
* due to a lighter-weight shell.
|
|
2017
2020
|
*
|
|
2018
2021
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2022
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
2019
2023
|
* @example
|
|
2020
2024
|
* ```js
|
|
2021
2025
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2024,7 +2028,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2024
2028
|
* enableV2Shell_experimental: true,
|
|
2025
2029
|
* });
|
|
2026
2030
|
* ```
|
|
2027
|
-
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
2028
2031
|
*/
|
|
2029
2032
|
enableV2Shell_experimental?: boolean;
|
|
2030
2033
|
/**
|
|
@@ -2043,6 +2046,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2043
2046
|
* and disable redirection of links in a new tab.
|
|
2044
2047
|
*
|
|
2045
2048
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2049
|
+
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
2046
2050
|
* @example
|
|
2047
2051
|
* ```js
|
|
2048
2052
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2051,7 +2055,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2051
2055
|
* disableRedirectionLinksInNewTab: true,
|
|
2052
2056
|
* });
|
|
2053
2057
|
* ```
|
|
2054
|
-
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
2055
2058
|
*/
|
|
2056
2059
|
disableRedirectionLinksInNewTab?: boolean;
|
|
2057
2060
|
/**
|
|
@@ -2062,6 +2065,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2062
2065
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
2063
2066
|
*
|
|
2064
2067
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2068
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
2065
2069
|
* @example
|
|
2066
2070
|
* ```js
|
|
2067
2071
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2070,24 +2074,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2070
2074
|
* overrideOrgId: 142536,
|
|
2071
2075
|
* });
|
|
2072
2076
|
* ```
|
|
2073
|
-
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
2074
2077
|
*/
|
|
2075
2078
|
overrideOrgId?: number;
|
|
2076
2079
|
/**
|
|
2077
|
-
* Flag to override the *Open Link in New Tab* context
|
|
2080
|
+
* Flag to override the *Open Link in New Tab* context
|
|
2081
|
+
* menu option.
|
|
2078
2082
|
*
|
|
2079
|
-
*
|
|
2083
|
+
* For improved link override handling, use
|
|
2084
|
+
* {@link enableLinkOverridesV2} instead.
|
|
2085
|
+
*
|
|
2086
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2087
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2088
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2080
2089
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2081
2090
|
* @example
|
|
2082
2091
|
* ```js
|
|
2083
|
-
*
|
|
2084
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2092
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2085
2093
|
* ... // other embed view config
|
|
2086
|
-
* linkOverride:
|
|
2094
|
+
* linkOverride: true,
|
|
2087
2095
|
* })
|
|
2088
2096
|
* ```
|
|
2089
2097
|
*/
|
|
2090
2098
|
linkOverride?: boolean;
|
|
2099
|
+
/**
|
|
2100
|
+
* Enables the V2 link override mechanism with improved
|
|
2101
|
+
* handling. When enabled, navigation links within the
|
|
2102
|
+
* embedded ThoughtSpot app are intercepted and routed
|
|
2103
|
+
* through the SDK via the `EmbedEvent.DialogOpen`
|
|
2104
|
+
* event.
|
|
2105
|
+
*
|
|
2106
|
+
* The SDK automatically sends {@link linkOverride}
|
|
2107
|
+
* alongside this flag for backward compatibility with
|
|
2108
|
+
* older ThoughtSpot versions.
|
|
2109
|
+
*
|
|
2110
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2111
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2112
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2113
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
|
|
2114
|
+
* @example
|
|
2115
|
+
* ```js
|
|
2116
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2117
|
+
* ... // other embed view config
|
|
2118
|
+
* enableLinkOverridesV2: true,
|
|
2119
|
+
* });
|
|
2120
|
+
*
|
|
2121
|
+
* embed.on(EmbedEvent.DialogOpen, (payload) => {
|
|
2122
|
+
* console.log('Link clicked:', payload);
|
|
2123
|
+
* });
|
|
2124
|
+
* ```
|
|
2125
|
+
*/
|
|
2126
|
+
enableLinkOverridesV2?: boolean;
|
|
2091
2127
|
/**
|
|
2092
2128
|
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
2093
2129
|
* Use this to set the primary action.
|
|
@@ -2112,7 +2148,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2112
2148
|
insertInToSlide?: boolean;
|
|
2113
2149
|
/**
|
|
2114
2150
|
* Show alert messages and toast messages in the embed.
|
|
2115
|
-
* Supported
|
|
2151
|
+
* Supported in all embed types.
|
|
2116
2152
|
*
|
|
2117
2153
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2118
2154
|
* @example
|
|
@@ -2396,7 +2432,7 @@ export interface HomePageConfig {
|
|
|
2396
2432
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
2397
2433
|
*
|
|
2398
2434
|
* Supported embed types: `AppEmbed`
|
|
2399
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2435
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2400
2436
|
* @example
|
|
2401
2437
|
* ```js
|
|
2402
2438
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2417,6 +2453,7 @@ export interface HomePageConfig {
|
|
|
2417
2453
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
2418
2454
|
*
|
|
2419
2455
|
* Supported embed types: `AppEmbed`
|
|
2456
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2420
2457
|
* @example
|
|
2421
2458
|
* ```js
|
|
2422
2459
|
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2427,7 +2464,6 @@ export interface HomePageConfig {
|
|
|
2427
2464
|
* ... //other embed view configuration attributes
|
|
2428
2465
|
* })
|
|
2429
2466
|
* ```
|
|
2430
|
-
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2431
2467
|
*/
|
|
2432
2468
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2433
2469
|
}
|
|
@@ -2440,7 +2476,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2440
2476
|
* visualization, or Liveboard.
|
|
2441
2477
|
*
|
|
2442
2478
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2443
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2479
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2444
2480
|
* @example
|
|
2445
2481
|
* ```js
|
|
2446
2482
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2458,11 +2494,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2458
2494
|
*/
|
|
2459
2495
|
runtimeFilters?: RuntimeFilter[];
|
|
2460
2496
|
/**
|
|
2461
|
-
* The list of parameter
|
|
2497
|
+
* The list of parameter overrides to apply to a search Answer,
|
|
2462
2498
|
* visualization, or Liveboard.
|
|
2463
2499
|
*
|
|
2464
2500
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2465
|
-
* @version SDK
|
|
2501
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2466
2502
|
* @example
|
|
2467
2503
|
* ```js
|
|
2468
2504
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2482,6 +2518,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2482
2518
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2483
2519
|
*
|
|
2484
2520
|
* Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
|
|
2521
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2485
2522
|
* @example
|
|
2486
2523
|
* ```js
|
|
2487
2524
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
|
|
@@ -2490,7 +2527,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2490
2527
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
2491
2528
|
* })
|
|
2492
2529
|
* ```
|
|
2493
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2494
2530
|
*/
|
|
2495
2531
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2496
2532
|
/**
|
|
@@ -2513,7 +2549,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2513
2549
|
* when set to false, runtime parameters will be included in the URL
|
|
2514
2550
|
* (default behavior before SDK 1.45.0).
|
|
2515
2551
|
*
|
|
2516
|
-
* Irrespective of this flag, runtime
|
|
2552
|
+
* Irrespective of this flag, runtime parameters (if passed) will be applied to the
|
|
2517
2553
|
* embedded view.
|
|
2518
2554
|
* @default true
|
|
2519
2555
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
@@ -2532,14 +2568,15 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2532
2568
|
* ... // other embed view config
|
|
2533
2569
|
* collapseSearchBar: true,
|
|
2534
2570
|
* });
|
|
2571
|
+
* ```
|
|
2535
2572
|
*/
|
|
2536
2573
|
collapseSearchBar?: boolean;
|
|
2537
2574
|
/**
|
|
2538
2575
|
* Flag to control Data panel experience
|
|
2539
2576
|
*
|
|
2540
2577
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2578
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2541
2579
|
* @default true
|
|
2542
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2543
2580
|
* @example
|
|
2544
2581
|
* ```js
|
|
2545
2582
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -2572,6 +2609,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2572
2609
|
* the current time period in filter results.
|
|
2573
2610
|
*
|
|
2574
2611
|
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2612
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2575
2613
|
* @example
|
|
2576
2614
|
* ```js
|
|
2577
2615
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
@@ -2579,7 +2617,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2579
2617
|
* isThisPeriodInDateFiltersEnabled: true,
|
|
2580
2618
|
* })
|
|
2581
2619
|
* ```
|
|
2582
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2583
2620
|
*/
|
|
2584
2621
|
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
2585
2622
|
}
|
|
@@ -2639,6 +2676,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2639
2676
|
* Boolean to control if Liveboard header is sticky or not.
|
|
2640
2677
|
*
|
|
2641
2678
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2679
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2642
2680
|
* @example
|
|
2643
2681
|
* ```js
|
|
2644
2682
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2647,7 +2685,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2647
2685
|
* isLiveboardHeaderSticky: true,
|
|
2648
2686
|
* });
|
|
2649
2687
|
* ```
|
|
2650
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2651
2688
|
*/
|
|
2652
2689
|
isLiveboardHeaderSticky?: boolean;
|
|
2653
2690
|
/**
|
|
@@ -2655,8 +2692,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2655
2692
|
*
|
|
2656
2693
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2657
2694
|
* @type {boolean}
|
|
2695
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
|
|
2658
2696
|
* @default false
|
|
2659
|
-
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
2660
2697
|
* @example
|
|
2661
2698
|
* ```js
|
|
2662
2699
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2672,8 +2709,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2672
2709
|
*
|
|
2673
2710
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2674
2711
|
* @type {boolean}
|
|
2712
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
|
|
2675
2713
|
* @default false
|
|
2676
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
|
|
2677
2714
|
* @example
|
|
2678
2715
|
* ```js
|
|
2679
2716
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2689,7 +2726,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2689
2726
|
* header.
|
|
2690
2727
|
*
|
|
2691
2728
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2692
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2729
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2693
2730
|
* @default true
|
|
2694
2731
|
* @example
|
|
2695
2732
|
* ```js
|
|
@@ -2707,7 +2744,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2707
2744
|
* **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
|
|
2708
2745
|
*
|
|
2709
2746
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2710
|
-
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
2747
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2711
2748
|
* @default false
|
|
2712
2749
|
* @example
|
|
2713
2750
|
* ```js
|
|
@@ -2725,7 +2762,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2725
2762
|
* compact header
|
|
2726
2763
|
*
|
|
2727
2764
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2728
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2765
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2729
2766
|
* @default true
|
|
2730
2767
|
* @example
|
|
2731
2768
|
* ```js
|
|
@@ -2758,7 +2795,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2758
2795
|
* the cover and filters pages in the Liveboard PDF.
|
|
2759
2796
|
*
|
|
2760
2797
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2761
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
2798
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
|
|
2762
2799
|
* @example
|
|
2763
2800
|
* ```js
|
|
2764
2801
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2962,7 +2999,7 @@ export declare enum HomepageModule {
|
|
|
2962
2999
|
*/
|
|
2963
3000
|
Search = "SEARCH",
|
|
2964
3001
|
/**
|
|
2965
|
-
*
|
|
3002
|
+
* KPI watchlist module
|
|
2966
3003
|
*/
|
|
2967
3004
|
Watchlist = "WATCHLIST",
|
|
2968
3005
|
/**
|
|
@@ -2993,7 +3030,8 @@ export declare enum ListPageColumns {
|
|
|
2993
3030
|
*/
|
|
2994
3031
|
Favorites = "FAVOURITE",
|
|
2995
3032
|
/**
|
|
2996
|
-
*
|
|
3033
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
3034
|
+
* @deprecated This option is deprecated.
|
|
2997
3035
|
*/
|
|
2998
3036
|
Favourite = "FAVOURITE",
|
|
2999
3037
|
/**
|
|
@@ -3094,13 +3132,13 @@ export declare enum EmbedEvent {
|
|
|
3094
3132
|
/**
|
|
3095
3133
|
* Rendering has initialized.
|
|
3096
3134
|
* @example
|
|
3097
|
-
|
|
3135
|
+
* ```js
|
|
3098
3136
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
3099
3137
|
* //show a loader
|
|
3100
3138
|
* function showLoader() {
|
|
3101
3139
|
* document.getElementById("loader");
|
|
3102
3140
|
* }
|
|
3103
|
-
|
|
3141
|
+
* ```
|
|
3104
3142
|
* @returns timestamp - The timestamp when the event was generated.
|
|
3105
3143
|
*/
|
|
3106
3144
|
Init = "init",
|
|
@@ -3108,11 +3146,11 @@ export declare enum EmbedEvent {
|
|
|
3108
3146
|
* Authentication has either succeeded or failed.
|
|
3109
3147
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3110
3148
|
* @example
|
|
3111
|
-
|
|
3149
|
+
* ```js
|
|
3112
3150
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
3113
3151
|
* console.log('AuthInit', payload);
|
|
3114
3152
|
* })
|
|
3115
|
-
|
|
3153
|
+
* ```
|
|
3116
3154
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
3117
3155
|
*/
|
|
3118
3156
|
AuthInit = "authInit",
|
|
@@ -3121,13 +3159,13 @@ export declare enum EmbedEvent {
|
|
|
3121
3159
|
* @returns timestamp - The timestamp when the event was generated.
|
|
3122
3160
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3123
3161
|
* @example
|
|
3124
|
-
|
|
3162
|
+
* ```js
|
|
3125
3163
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
3126
3164
|
* //hide loader
|
|
3127
3165
|
* function hideLoader() {
|
|
3128
3166
|
* document.getElementById("loader");
|
|
3129
3167
|
* }
|
|
3130
|
-
|
|
3168
|
+
* ```
|
|
3131
3169
|
*/
|
|
3132
3170
|
Load = "load",
|
|
3133
3171
|
/**
|
|
@@ -3136,11 +3174,11 @@ export declare enum EmbedEvent {
|
|
|
3136
3174
|
* @return data - Answer of Liveboard data
|
|
3137
3175
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3138
3176
|
* @example
|
|
3139
|
-
|
|
3177
|
+
* ```js
|
|
3140
3178
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
3141
3179
|
* console.log('data', payload);
|
|
3142
3180
|
* })
|
|
3143
|
-
|
|
3181
|
+
* ```
|
|
3144
3182
|
* @important
|
|
3145
3183
|
*/
|
|
3146
3184
|
Data = "data",
|
|
@@ -3148,9 +3186,9 @@ export declare enum EmbedEvent {
|
|
|
3148
3186
|
* Search query has been updated by the user.
|
|
3149
3187
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3150
3188
|
* @example
|
|
3151
|
-
|
|
3189
|
+
* ```js
|
|
3152
3190
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
3153
|
-
|
|
3191
|
+
* ```
|
|
3154
3192
|
*/
|
|
3155
3193
|
QueryChanged = "queryChanged",
|
|
3156
3194
|
/**
|
|
@@ -3160,7 +3198,7 @@ export declare enum EmbedEvent {
|
|
|
3160
3198
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
3161
3199
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
3162
3200
|
* @example
|
|
3163
|
-
|
|
3201
|
+
* ```js
|
|
3164
3202
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
3165
3203
|
* points: {
|
|
3166
3204
|
* clickedPoint,
|
|
@@ -3168,12 +3206,12 @@ export declare enum EmbedEvent {
|
|
|
3168
3206
|
* },
|
|
3169
3207
|
* autoDrillDown: true,
|
|
3170
3208
|
* })
|
|
3171
|
-
|
|
3209
|
+
* ```
|
|
3172
3210
|
* In this example, `VizPointDoubleClick` event is used for
|
|
3173
3211
|
* triggering the `DrillDown` event when an area or specific
|
|
3174
3212
|
* data point on a table or chart is double-clicked.
|
|
3175
3213
|
* @example
|
|
3176
|
-
|
|
3214
|
+
* ```js
|
|
3177
3215
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
3178
3216
|
* console.log(payload);
|
|
3179
3217
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -3187,7 +3225,7 @@ export declare enum EmbedEvent {
|
|
|
3187
3225
|
* autoDrillDown: true,
|
|
3188
3226
|
* })
|
|
3189
3227
|
* })
|
|
3190
|
-
|
|
3228
|
+
* ```
|
|
3191
3229
|
*/
|
|
3192
3230
|
Drilldown = "drillDown",
|
|
3193
3231
|
/**
|
|
@@ -3312,13 +3350,13 @@ export declare enum EmbedEvent {
|
|
|
3312
3350
|
* The ThoughtSpot authentication session has expired.
|
|
3313
3351
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3314
3352
|
* @example
|
|
3315
|
-
|
|
3353
|
+
* ```js
|
|
3316
3354
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
3317
3355
|
* //show auth expired banner
|
|
3318
3356
|
* function showAuthExpired() {
|
|
3319
3357
|
* document.getElementById("authExpiredBanner");
|
|
3320
3358
|
* }
|
|
3321
|
-
|
|
3359
|
+
* ```
|
|
3322
3360
|
*/
|
|
3323
3361
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
3324
3362
|
/**
|
|
@@ -3353,22 +3391,22 @@ export declare enum EmbedEvent {
|
|
|
3353
3391
|
* Applicable to `SearchBarEmbed` only.
|
|
3354
3392
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3355
3393
|
* @example
|
|
3356
|
-
|
|
3394
|
+
* ```js
|
|
3357
3395
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
3358
3396
|
* .then(data => {
|
|
3359
3397
|
* console.log('Answer Data:', data);
|
|
3360
3398
|
* })
|
|
3361
|
-
|
|
3399
|
+
* ```
|
|
3362
3400
|
*/
|
|
3363
3401
|
GetDataClick = "getDataClick",
|
|
3364
3402
|
/**
|
|
3365
3403
|
* Detects the route change.
|
|
3366
3404
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3367
3405
|
* @example
|
|
3368
|
-
|
|
3406
|
+
* ```js
|
|
3369
3407
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
3370
3408
|
* console.log('data', payload))
|
|
3371
|
-
|
|
3409
|
+
* ```
|
|
3372
3410
|
*/
|
|
3373
3411
|
RouteChange = "ROUTE_CHANGE",
|
|
3374
3412
|
/**
|
|
@@ -3378,12 +3416,12 @@ export declare enum EmbedEvent {
|
|
|
3378
3416
|
V1Data = "exportVizDataToParent",
|
|
3379
3417
|
/**
|
|
3380
3418
|
* Emitted when the embed does not have cookie access. This happens
|
|
3381
|
-
* when
|
|
3382
|
-
*
|
|
3419
|
+
* when third-party cookies are blocked by Safari or other
|
|
3420
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
3383
3421
|
* @example
|
|
3384
|
-
|
|
3422
|
+
* ```js
|
|
3385
3423
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
3386
|
-
|
|
3424
|
+
* ```
|
|
3387
3425
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
3388
3426
|
*/
|
|
3389
3427
|
NoCookieAccess = "noCookieAccess",
|
|
@@ -3397,22 +3435,22 @@ export declare enum EmbedEvent {
|
|
|
3397
3435
|
* Emitted when any modal is opened in the app
|
|
3398
3436
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3399
3437
|
* @example
|
|
3400
|
-
|
|
3438
|
+
* ```js
|
|
3401
3439
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
3402
3440
|
* console.log('dialog open', payload);
|
|
3403
3441
|
* })
|
|
3404
|
-
|
|
3442
|
+
* ```
|
|
3405
3443
|
*/
|
|
3406
3444
|
DialogOpen = "dialog-open",
|
|
3407
3445
|
/**
|
|
3408
3446
|
* Emitted when any modal is closed in the app
|
|
3409
3447
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3410
3448
|
* @example
|
|
3411
|
-
|
|
3449
|
+
* ```js
|
|
3412
3450
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
3413
3451
|
* console.log('dialog close', payload);
|
|
3414
3452
|
* })
|
|
3415
|
-
|
|
3453
|
+
* ```
|
|
3416
3454
|
*/
|
|
3417
3455
|
DialogClose = "dialog-close",
|
|
3418
3456
|
/**
|
|
@@ -3421,39 +3459,39 @@ export declare enum EmbedEvent {
|
|
|
3421
3459
|
* other events on the rendered Liveboard.
|
|
3422
3460
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3423
3461
|
* @example
|
|
3424
|
-
|
|
3462
|
+
* ```js
|
|
3425
3463
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
3426
3464
|
console.log('Liveboard is rendered', payload);
|
|
3427
3465
|
})
|
|
3428
|
-
|
|
3466
|
+
* ```
|
|
3429
3467
|
* The following example shows how to trigger
|
|
3430
3468
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
3431
3469
|
* @example
|
|
3432
|
-
|
|
3470
|
+
* ```js
|
|
3433
3471
|
* const embedRef = useEmbedRef();
|
|
3434
3472
|
* const onLiveboardRendered = () => {
|
|
3435
3473
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
3436
3474
|
* };
|
|
3437
|
-
|
|
3475
|
+
* ```
|
|
3438
3476
|
*/
|
|
3439
3477
|
LiveboardRendered = "PinboardRendered",
|
|
3440
3478
|
/**
|
|
3441
3479
|
* Emits all events.
|
|
3442
|
-
* @
|
|
3480
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3443
3481
|
* @example
|
|
3444
|
-
|
|
3482
|
+
* ```js
|
|
3445
3483
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
3446
3484
|
* console.log('Embed Events', payload)
|
|
3447
3485
|
* })
|
|
3448
|
-
|
|
3486
|
+
* ```
|
|
3449
3487
|
*/
|
|
3450
3488
|
ALL = "*",
|
|
3451
3489
|
/**
|
|
3452
3490
|
* Emitted when an Answer is saved in the app.
|
|
3453
3491
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
3454
|
-
* @
|
|
3492
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3455
3493
|
* @example
|
|
3456
|
-
|
|
3494
|
+
* ```js
|
|
3457
3495
|
* //Emit when action starts
|
|
3458
3496
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3459
3497
|
* console.log('Save', payload)
|
|
@@ -3464,7 +3502,7 @@ export declare enum EmbedEvent {
|
|
|
3464
3502
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3465
3503
|
* console.log('Save', payload)
|
|
3466
3504
|
* })
|
|
3467
|
-
|
|
3505
|
+
* ```
|
|
3468
3506
|
*/
|
|
3469
3507
|
Save = "save",
|
|
3470
3508
|
/**
|
|
@@ -3476,11 +3514,11 @@ export declare enum EmbedEvent {
|
|
|
3476
3514
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
3477
3515
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3478
3516
|
* @example
|
|
3479
|
-
|
|
3517
|
+
* ```js
|
|
3480
3518
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
3481
3519
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3482
3520
|
* })
|
|
3483
|
-
|
|
3521
|
+
* ```
|
|
3484
3522
|
*/
|
|
3485
3523
|
Download = "download",
|
|
3486
3524
|
/**
|
|
@@ -3488,14 +3526,14 @@ export declare enum EmbedEvent {
|
|
|
3488
3526
|
* Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
|
|
3489
3527
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3490
3528
|
* @example
|
|
3491
|
-
|
|
3529
|
+
* ```js
|
|
3492
3530
|
* //emit when action starts
|
|
3493
3531
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3494
3532
|
* console.log('download PNG', payload)}, {start: true })
|
|
3495
3533
|
* //emit when action ends
|
|
3496
3534
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3497
3535
|
* console.log('download PNG', payload)})
|
|
3498
|
-
|
|
3536
|
+
* ```
|
|
3499
3537
|
*/
|
|
3500
3538
|
DownloadAsPng = "downloadAsPng",
|
|
3501
3539
|
/**
|
|
@@ -3503,14 +3541,14 @@ export declare enum EmbedEvent {
|
|
|
3503
3541
|
* 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.
|
|
3504
3542
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3505
3543
|
* @example
|
|
3506
|
-
|
|
3544
|
+
* ```js
|
|
3507
3545
|
* //emit when action starts
|
|
3508
3546
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3509
3547
|
* console.log('download PDF', payload)}, {start: true })
|
|
3510
3548
|
* //emit when action ends
|
|
3511
3549
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3512
3550
|
* console.log('download PDF', payload)})
|
|
3513
|
-
|
|
3551
|
+
* ```
|
|
3514
3552
|
*/
|
|
3515
3553
|
DownloadAsPdf = "downloadAsPdf",
|
|
3516
3554
|
/**
|
|
@@ -3518,14 +3556,14 @@ export declare enum EmbedEvent {
|
|
|
3518
3556
|
* 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.
|
|
3519
3557
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3520
3558
|
* @example
|
|
3521
|
-
|
|
3559
|
+
* ```js
|
|
3522
3560
|
* //emit when action starts
|
|
3523
3561
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3524
3562
|
* console.log('download CSV', payload)}, {start: true })
|
|
3525
3563
|
* //emit when action ends
|
|
3526
3564
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3527
3565
|
* console.log('download CSV', payload)})
|
|
3528
|
-
|
|
3566
|
+
* ```
|
|
3529
3567
|
*/
|
|
3530
3568
|
DownloadAsCsv = "downloadAsCsv",
|
|
3531
3569
|
/**
|
|
@@ -3533,14 +3571,14 @@ export declare enum EmbedEvent {
|
|
|
3533
3571
|
* 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.
|
|
3534
3572
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3535
3573
|
* @example
|
|
3536
|
-
|
|
3574
|
+
* ```js
|
|
3537
3575
|
* //emit when action starts
|
|
3538
3576
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3539
3577
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
3540
3578
|
* //emit when action ends
|
|
3541
3579
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3542
3580
|
* console.log('download Xlsx', payload)})
|
|
3543
|
-
|
|
3581
|
+
* ```
|
|
3544
3582
|
*/
|
|
3545
3583
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3546
3584
|
/**
|
|
@@ -3548,25 +3586,25 @@ export declare enum EmbedEvent {
|
|
|
3548
3586
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
|
|
3549
3587
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3550
3588
|
* @example
|
|
3551
|
-
|
|
3589
|
+
* ```js
|
|
3552
3590
|
* //emit when action starts
|
|
3553
3591
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3554
3592
|
* console.log('delete answer', payload)}, {start: true })
|
|
3555
3593
|
* //trigger when action is completed
|
|
3556
3594
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3557
3595
|
* console.log('delete answer', payload)})
|
|
3558
|
-
|
|
3596
|
+
* ```
|
|
3559
3597
|
*/
|
|
3560
3598
|
AnswerDelete = "answerDelete",
|
|
3561
3599
|
/**
|
|
3562
3600
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
3563
3601
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
3564
3602
|
* @example
|
|
3565
|
-
|
|
3603
|
+
* ```js
|
|
3566
3604
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
3567
3605
|
* console.log('AI Highlights', payload);
|
|
3568
3606
|
* })
|
|
3569
|
-
|
|
3607
|
+
* ```
|
|
3570
3608
|
*/
|
|
3571
3609
|
AIHighlights = "AIHighlights",
|
|
3572
3610
|
/**
|
|
@@ -3575,7 +3613,7 @@ export declare enum EmbedEvent {
|
|
|
3575
3613
|
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
|
|
3576
3614
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3577
3615
|
* @example
|
|
3578
|
-
|
|
3616
|
+
* ```js
|
|
3579
3617
|
* //emit when action starts
|
|
3580
3618
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3581
3619
|
* console.log('pin', payload)
|
|
@@ -3586,14 +3624,14 @@ export declare enum EmbedEvent {
|
|
|
3586
3624
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3587
3625
|
* console.log('pin', payload)
|
|
3588
3626
|
* })
|
|
3589
|
-
|
|
3627
|
+
* ```
|
|
3590
3628
|
*/
|
|
3591
3629
|
Pin = "pin",
|
|
3592
3630
|
/**
|
|
3593
3631
|
* Emitted when SpotIQ analysis is triggered
|
|
3594
3632
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3595
3633
|
* @example
|
|
3596
|
-
|
|
3634
|
+
* ```js
|
|
3597
3635
|
* //emit when action starts
|
|
3598
3636
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3599
3637
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -3604,14 +3642,14 @@ export declare enum EmbedEvent {
|
|
|
3604
3642
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3605
3643
|
* console.log('SpotIQ analyze', payload)
|
|
3606
3644
|
* })
|
|
3607
|
-
|
|
3645
|
+
* ```
|
|
3608
3646
|
*/
|
|
3609
3647
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3610
3648
|
/**
|
|
3611
3649
|
* Emitted when a user shares an object with another user or group
|
|
3612
3650
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3613
3651
|
* @example
|
|
3614
|
-
|
|
3652
|
+
* ```js
|
|
3615
3653
|
* //emit when action starts
|
|
3616
3654
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3617
3655
|
* console.log('Share', payload)
|
|
@@ -3622,7 +3660,7 @@ export declare enum EmbedEvent {
|
|
|
3622
3660
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3623
3661
|
* console.log('Share', payload)
|
|
3624
3662
|
* })
|
|
3625
|
-
|
|
3663
|
+
* ```
|
|
3626
3664
|
*/
|
|
3627
3665
|
Share = "share",
|
|
3628
3666
|
/**
|
|
@@ -3630,11 +3668,11 @@ export declare enum EmbedEvent {
|
|
|
3630
3668
|
* data on a chart or table.
|
|
3631
3669
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3632
3670
|
* @example
|
|
3633
|
-
|
|
3671
|
+
* ```js
|
|
3634
3672
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
3635
3673
|
* console.log('Drill include', payload);
|
|
3636
3674
|
* })
|
|
3637
|
-
|
|
3675
|
+
* ```
|
|
3638
3676
|
*/
|
|
3639
3677
|
DrillInclude = "context-menu-item-include",
|
|
3640
3678
|
/**
|
|
@@ -3642,22 +3680,22 @@ export declare enum EmbedEvent {
|
|
|
3642
3680
|
* data on a chart or table
|
|
3643
3681
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3644
3682
|
* @example
|
|
3645
|
-
|
|
3683
|
+
* ```js
|
|
3646
3684
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
3647
3685
|
* console.log('Drill exclude', payload);
|
|
3648
3686
|
* })
|
|
3649
|
-
|
|
3687
|
+
* ```
|
|
3650
3688
|
*/
|
|
3651
3689
|
DrillExclude = "context-menu-item-exclude",
|
|
3652
3690
|
/**
|
|
3653
3691
|
* Emitted when a column value is copied in the embedded app.
|
|
3654
3692
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3655
3693
|
* @example
|
|
3656
|
-
|
|
3657
|
-
*
|
|
3694
|
+
* ```js
|
|
3695
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
3658
3696
|
* console.log('copy to clipboard', payload);
|
|
3659
3697
|
* })
|
|
3660
|
-
|
|
3698
|
+
* ```
|
|
3661
3699
|
*/
|
|
3662
3700
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3663
3701
|
/**
|
|
@@ -3665,10 +3703,10 @@ export declare enum EmbedEvent {
|
|
|
3665
3703
|
* embedded Liveboard.
|
|
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.UpdateTML)
|
|
3670
3708
|
* })
|
|
3671
|
-
|
|
3709
|
+
* ```
|
|
3672
3710
|
*/
|
|
3673
3711
|
UpdateTML = "updateTSL",
|
|
3674
3712
|
/**
|
|
@@ -3676,11 +3714,11 @@ export declare enum EmbedEvent {
|
|
|
3676
3714
|
* on an embedded Liveboard.
|
|
3677
3715
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3678
3716
|
* @example
|
|
3679
|
-
|
|
3717
|
+
* ```js
|
|
3680
3718
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
3681
3719
|
* console.log('Edit TML', payload);
|
|
3682
3720
|
* })
|
|
3683
|
-
|
|
3721
|
+
* ```
|
|
3684
3722
|
*/
|
|
3685
3723
|
EditTML = "editTSL",
|
|
3686
3724
|
/**
|
|
@@ -3689,25 +3727,25 @@ export declare enum EmbedEvent {
|
|
|
3689
3727
|
* Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
|
|
3690
3728
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3691
3729
|
* @example
|
|
3692
|
-
|
|
3730
|
+
* ```js
|
|
3693
3731
|
* //emit when action starts
|
|
3694
3732
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3695
3733
|
* console.log('Export TML', payload)}, { start: true })
|
|
3696
3734
|
* //emit when action ends
|
|
3697
3735
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3698
3736
|
* console.log('Export TML', payload)})
|
|
3699
|
-
|
|
3737
|
+
* ```
|
|
3700
3738
|
*/
|
|
3701
3739
|
ExportTML = "exportTSL",
|
|
3702
3740
|
/**
|
|
3703
3741
|
* Emitted when an Answer is saved as a View.
|
|
3704
3742
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3705
3743
|
* @example
|
|
3706
|
-
|
|
3744
|
+
* ```js
|
|
3707
3745
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
3708
3746
|
* console.log('View', payload);
|
|
3709
3747
|
* })
|
|
3710
|
-
|
|
3748
|
+
* ```
|
|
3711
3749
|
*/
|
|
3712
3750
|
SaveAsView = "saveAsView",
|
|
3713
3751
|
/**
|
|
@@ -3715,36 +3753,36 @@ export declare enum EmbedEvent {
|
|
|
3715
3753
|
* 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.
|
|
3716
3754
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3717
3755
|
* @example
|
|
3718
|
-
|
|
3756
|
+
* ```js
|
|
3719
3757
|
* //emit when action starts
|
|
3720
3758
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3721
3759
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
3722
3760
|
* //emit when action ends
|
|
3723
3761
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3724
3762
|
* console.log('Copy and edit', payload)})
|
|
3725
|
-
|
|
3763
|
+
* ```
|
|
3726
3764
|
*/
|
|
3727
3765
|
CopyAEdit = "copyAEdit",
|
|
3728
3766
|
/**
|
|
3729
3767
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
3730
3768
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3731
3769
|
* @example
|
|
3732
|
-
|
|
3770
|
+
* ```js
|
|
3733
3771
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
3734
3772
|
* console.log('show data', payload);
|
|
3735
3773
|
* })
|
|
3736
|
-
|
|
3774
|
+
* ```
|
|
3737
3775
|
*/
|
|
3738
3776
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3739
3777
|
/**
|
|
3740
3778
|
* Emitted when an Answer is switched to a chart or table view.
|
|
3741
3779
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3742
3780
|
* @example
|
|
3743
|
-
|
|
3781
|
+
* ```js
|
|
3744
3782
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
3745
3783
|
* console.log('switch view', payload);
|
|
3746
3784
|
* })
|
|
3747
|
-
|
|
3785
|
+
* ```
|
|
3748
3786
|
*/
|
|
3749
3787
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3750
3788
|
/**
|
|
@@ -3761,118 +3799,118 @@ export declare enum EmbedEvent {
|
|
|
3761
3799
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3762
3800
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3763
3801
|
* @example
|
|
3764
|
-
|
|
3802
|
+
* ```js
|
|
3765
3803
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
3766
3804
|
* console.log('Liveboard details', payload);
|
|
3767
3805
|
* })
|
|
3768
|
-
|
|
3806
|
+
* ```
|
|
3769
3807
|
*/
|
|
3770
3808
|
LiveboardInfo = "pinboardInfo",
|
|
3771
3809
|
/**
|
|
3772
3810
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3773
3811
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3774
3812
|
* @example
|
|
3775
|
-
|
|
3813
|
+
* ```js
|
|
3776
3814
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
3777
3815
|
* console.log('favorites', payload);
|
|
3778
3816
|
* })
|
|
3779
|
-
|
|
3817
|
+
* ```
|
|
3780
3818
|
*/
|
|
3781
3819
|
AddToFavorites = "addToFavorites",
|
|
3782
3820
|
/**
|
|
3783
3821
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3784
3822
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3785
3823
|
* @example
|
|
3786
|
-
|
|
3824
|
+
* ```js
|
|
3787
3825
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
3788
|
-
* console.log(
|
|
3826
|
+
* console.log('Liveboard schedule', payload);
|
|
3789
3827
|
* })
|
|
3790
|
-
|
|
3828
|
+
* ```
|
|
3791
3829
|
*/
|
|
3792
3830
|
Schedule = "subscription",
|
|
3793
3831
|
/**
|
|
3794
3832
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3795
3833
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3796
3834
|
* @example
|
|
3797
|
-
|
|
3835
|
+
* ```js
|
|
3798
3836
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
3799
|
-
* console.log(
|
|
3837
|
+
* console.log('Liveboard edit', payload);
|
|
3800
3838
|
* })
|
|
3801
|
-
|
|
3839
|
+
* ```
|
|
3802
3840
|
*/
|
|
3803
3841
|
Edit = "edit",
|
|
3804
3842
|
/**
|
|
3805
3843
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
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.MakeACopy, payload => {
|
|
3810
|
-
* console.log(
|
|
3848
|
+
* console.log('Copy', payload);
|
|
3811
3849
|
* })
|
|
3812
|
-
|
|
3850
|
+
* ```
|
|
3813
3851
|
*/
|
|
3814
3852
|
MakeACopy = "makeACopy",
|
|
3815
3853
|
/**
|
|
3816
3854
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3817
3855
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3818
3856
|
* @example
|
|
3819
|
-
|
|
3857
|
+
* ```js
|
|
3820
3858
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
3821
|
-
|
|
3859
|
+
* ```
|
|
3822
3860
|
* @example
|
|
3823
|
-
|
|
3861
|
+
* ```js
|
|
3824
3862
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
3825
3863
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3826
3864
|
* })
|
|
3827
|
-
|
|
3865
|
+
* ```
|
|
3828
3866
|
*/
|
|
3829
3867
|
Present = "present",
|
|
3830
3868
|
/**
|
|
3831
3869
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3832
3870
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3833
3871
|
* @example
|
|
3834
|
-
|
|
3872
|
+
* ```js
|
|
3835
3873
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
3836
3874
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3837
|
-
|
|
3875
|
+
* ```
|
|
3838
3876
|
*/
|
|
3839
3877
|
Delete = "delete",
|
|
3840
3878
|
/**
|
|
3841
3879
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3842
3880
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3843
3881
|
* @example
|
|
3844
|
-
|
|
3882
|
+
* ```js
|
|
3845
3883
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
3846
|
-
|
|
3884
|
+
* ```
|
|
3847
3885
|
*/
|
|
3848
3886
|
SchedulesList = "schedule-list",
|
|
3849
3887
|
/**
|
|
3850
3888
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3851
3889
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3852
3890
|
* @example
|
|
3853
|
-
|
|
3891
|
+
* ```js
|
|
3854
3892
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
3855
|
-
|
|
3893
|
+
* ```
|
|
3856
3894
|
*/
|
|
3857
3895
|
Cancel = "cancel",
|
|
3858
3896
|
/**
|
|
3859
3897
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3860
3898
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3861
3899
|
* @example
|
|
3862
|
-
|
|
3900
|
+
* ```js
|
|
3863
3901
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3864
3902
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3865
|
-
|
|
3903
|
+
* ```
|
|
3866
3904
|
*/
|
|
3867
3905
|
Explore = "explore",
|
|
3868
3906
|
/**
|
|
3869
3907
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
3870
3908
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3871
3909
|
* @example
|
|
3872
|
-
|
|
3910
|
+
* ```js
|
|
3873
3911
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3874
3912
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3875
|
-
|
|
3913
|
+
* ```
|
|
3876
3914
|
*/
|
|
3877
3915
|
CopyLink = "embedDocument",
|
|
3878
3916
|
/**
|
|
@@ -3880,21 +3918,21 @@ export declare enum EmbedEvent {
|
|
|
3880
3918
|
* visualization or Liveboard.
|
|
3881
3919
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3882
3920
|
* @example
|
|
3883
|
-
|
|
3921
|
+
* ```js
|
|
3884
3922
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3885
3923
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3886
|
-
|
|
3924
|
+
* ```
|
|
3887
3925
|
*/
|
|
3888
3926
|
CrossFilterChanged = "cross-filter-changed",
|
|
3889
3927
|
/**
|
|
3890
3928
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3891
3929
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3892
3930
|
* @example
|
|
3893
|
-
|
|
3931
|
+
* ```js
|
|
3894
3932
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
3895
3933
|
* console.log('VizPointClick', payload)
|
|
3896
3934
|
* })
|
|
3897
|
-
|
|
3935
|
+
* ```
|
|
3898
3936
|
*/
|
|
3899
3937
|
VizPointRightClick = "vizPointRightClick",
|
|
3900
3938
|
/**
|
|
@@ -3908,35 +3946,35 @@ export declare enum EmbedEvent {
|
|
|
3908
3946
|
* filter details.
|
|
3909
3947
|
* @example
|
|
3910
3948
|
*
|
|
3911
|
-
|
|
3949
|
+
* ```js
|
|
3912
3950
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3913
3951
|
* console.log('payload', payload);
|
|
3914
3952
|
* })
|
|
3915
|
-
*
|
|
3953
|
+
* ```
|
|
3916
3954
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3917
3955
|
*/
|
|
3918
3956
|
FilterChanged = "filterChanged",
|
|
3919
3957
|
/**
|
|
3920
3958
|
* Emitted when a user clicks the **Go** button to initiate
|
|
3921
3959
|
* a Natural Language Search query
|
|
3922
|
-
* @version SDK
|
|
3960
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3923
3961
|
*/
|
|
3924
3962
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3925
3963
|
/**
|
|
3926
3964
|
* Emitted when a user selects a data source on the embedded
|
|
3927
3965
|
* Natural Language Search interface.
|
|
3928
3966
|
*
|
|
3929
|
-
* @version SDK
|
|
3967
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3930
3968
|
*/
|
|
3931
3969
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3932
3970
|
/**
|
|
3933
3971
|
* Emitted when a user updates a connection on the **Data** page
|
|
3934
|
-
* @version SDK
|
|
3972
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3935
3973
|
*/
|
|
3936
3974
|
UpdateConnection = "updateConnection",
|
|
3937
3975
|
/**
|
|
3938
3976
|
* Emitted when a user updates a connection on the **Data** page
|
|
3939
|
-
* @version SDK
|
|
3977
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3940
3978
|
*/
|
|
3941
3979
|
CreateConnection = "createConnection",
|
|
3942
3980
|
/**
|
|
@@ -3946,7 +3984,7 @@ export declare enum EmbedEvent {
|
|
|
3946
3984
|
* @returns viewId: string
|
|
3947
3985
|
* @returns liveboardId: string
|
|
3948
3986
|
* @returns isPublic: boolean
|
|
3949
|
-
* @version SDK
|
|
3987
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3950
3988
|
*/
|
|
3951
3989
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3952
3990
|
/**
|
|
@@ -3955,7 +3993,7 @@ export declare enum EmbedEvent {
|
|
|
3955
3993
|
* @returns viewId: string
|
|
3956
3994
|
* @returns liveboardId: string
|
|
3957
3995
|
* @returns isPublic: boolean
|
|
3958
|
-
* @version SDK
|
|
3996
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3959
3997
|
*/
|
|
3960
3998
|
SavePersonalisedView = "savePersonalisedView",
|
|
3961
3999
|
/**
|
|
@@ -3964,19 +4002,19 @@ export declare enum EmbedEvent {
|
|
|
3964
4002
|
* @returns viewId: string
|
|
3965
4003
|
* @returns liveboardId: string
|
|
3966
4004
|
* @returns isPublic: boolean
|
|
3967
|
-
* @version SDK
|
|
4005
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3968
4006
|
*/
|
|
3969
4007
|
ResetLiveboard = "resetLiveboard",
|
|
3970
4008
|
/**
|
|
3971
4009
|
* Emitted when a PersonalisedView is deleted.
|
|
3972
4010
|
* @returns views: string[]
|
|
3973
4011
|
* @returns liveboardId: string
|
|
3974
|
-
* @version SDK
|
|
4012
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3975
4013
|
*/
|
|
3976
4014
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3977
4015
|
/**
|
|
3978
4016
|
* Emitted when a user creates a Worksheet.
|
|
3979
|
-
* @version SDK
|
|
4017
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3980
4018
|
*/
|
|
3981
4019
|
CreateWorksheet = "createWorksheet",
|
|
3982
4020
|
/**
|
|
@@ -3985,12 +4023,12 @@ export declare enum EmbedEvent {
|
|
|
3985
4023
|
* @returns viewId: string
|
|
3986
4024
|
* @returns liveboardId: string
|
|
3987
4025
|
* @returns isPublic: boolean
|
|
3988
|
-
* @version SDK
|
|
4026
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3989
4027
|
*/
|
|
3990
4028
|
AskSageInit = "AskSageInit",
|
|
3991
4029
|
/**
|
|
3992
4030
|
* Emitted when a Liveboard or visualization is renamed.
|
|
3993
|
-
* @version SDK
|
|
4031
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
3994
4032
|
*/
|
|
3995
4033
|
Rename = "rename",
|
|
3996
4034
|
/**
|
|
@@ -4013,7 +4051,7 @@ export declare enum EmbedEvent {
|
|
|
4013
4051
|
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
4014
4052
|
* is `false` by using the `error` parameters in `responder`.
|
|
4015
4053
|
* - `errorText` - The error message text shown to the user.
|
|
4016
|
-
* @version SDK
|
|
4054
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4017
4055
|
* @example
|
|
4018
4056
|
*
|
|
4019
4057
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -4065,8 +4103,8 @@ export declare enum EmbedEvent {
|
|
|
4065
4103
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
4066
4104
|
* console.log('payload', payload);
|
|
4067
4105
|
* })
|
|
4068
|
-
|
|
4069
|
-
* @version SDK
|
|
4106
|
+
* ```
|
|
4107
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4070
4108
|
*/
|
|
4071
4109
|
ParameterChanged = "parameterChanged",
|
|
4072
4110
|
/**
|
|
@@ -4121,24 +4159,24 @@ export declare enum EmbedEvent {
|
|
|
4121
4159
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
4122
4160
|
* console.log('payload', payload);
|
|
4123
4161
|
* })
|
|
4124
|
-
|
|
4125
|
-
* @version SDK
|
|
4162
|
+
* ```
|
|
4163
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4126
4164
|
*/
|
|
4127
4165
|
CreateLiveboard = "createLiveboard",
|
|
4128
4166
|
/**
|
|
4129
4167
|
* Emitted when a user creates a Model.
|
|
4130
|
-
* @version SDK
|
|
4168
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4131
4169
|
*/
|
|
4132
4170
|
CreateModel = "createModel",
|
|
4133
4171
|
/**
|
|
4134
4172
|
* @hidden
|
|
4135
4173
|
* Emitted when a user exits present mode.
|
|
4136
|
-
* @version SDK
|
|
4174
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4137
4175
|
*/
|
|
4138
4176
|
ExitPresentMode = "exitPresentMode",
|
|
4139
4177
|
/**
|
|
4140
4178
|
* Emitted when a user requests the full height lazy load data.
|
|
4141
|
-
* @version SDK
|
|
4179
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4142
4180
|
* @hidden
|
|
4143
4181
|
*/
|
|
4144
4182
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
@@ -4149,7 +4187,7 @@ export declare enum EmbedEvent {
|
|
|
4149
4187
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
4150
4188
|
* console.log('payload', payload);
|
|
4151
4189
|
* })
|
|
4152
|
-
|
|
4190
|
+
* ```
|
|
4153
4191
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4154
4192
|
*/
|
|
4155
4193
|
SpotterData = "SpotterData",
|
|
@@ -4160,7 +4198,7 @@ export declare enum EmbedEvent {
|
|
|
4160
4198
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
4161
4199
|
* console.log('payload', payload);
|
|
4162
4200
|
* })
|
|
4163
|
-
|
|
4201
|
+
* ```
|
|
4164
4202
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4165
4203
|
*/
|
|
4166
4204
|
PreviewSpotterData = "PreviewSpotterData",
|
|
@@ -4171,7 +4209,7 @@ export declare enum EmbedEvent {
|
|
|
4171
4209
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
4172
4210
|
* console.log('payload', payload);
|
|
4173
4211
|
* })
|
|
4174
|
-
|
|
4212
|
+
* ```
|
|
4175
4213
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
4176
4214
|
*/
|
|
4177
4215
|
AddToCoaching = "addToCoaching",
|
|
@@ -4193,7 +4231,7 @@ export declare enum EmbedEvent {
|
|
|
4193
4231
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
4194
4232
|
* console.log('payload', payload);
|
|
4195
4233
|
* })
|
|
4196
|
-
|
|
4234
|
+
* ```
|
|
4197
4235
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4198
4236
|
*/
|
|
4199
4237
|
SpotterQueryTriggered = "SpotterQueryTriggered",
|
|
@@ -4204,7 +4242,7 @@ export declare enum EmbedEvent {
|
|
|
4204
4242
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
4205
4243
|
* console.log('payload', payload);
|
|
4206
4244
|
* })
|
|
4207
|
-
|
|
4245
|
+
* ```
|
|
4208
4246
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4209
4247
|
*/
|
|
4210
4248
|
LastPromptEdited = "LastPromptEdited",
|
|
@@ -4215,18 +4253,18 @@ export declare enum EmbedEvent {
|
|
|
4215
4253
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
4216
4254
|
* console.log('payload', payload);
|
|
4217
4255
|
* })
|
|
4218
|
-
|
|
4256
|
+
* ```
|
|
4219
4257
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4220
4258
|
*/
|
|
4221
4259
|
LastPromptDeleted = "LastPromptDeleted",
|
|
4222
4260
|
/**
|
|
4223
|
-
* Emitted when the
|
|
4261
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
4224
4262
|
* @example
|
|
4225
4263
|
* ```js
|
|
4226
4264
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
4227
4265
|
* console.log('payload', payload);
|
|
4228
4266
|
* })
|
|
4229
|
-
|
|
4267
|
+
* ```
|
|
4230
4268
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4231
4269
|
*/
|
|
4232
4270
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
@@ -4237,7 +4275,7 @@ export declare enum EmbedEvent {
|
|
|
4237
4275
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
4238
4276
|
* console.log('payload', payload);
|
|
4239
4277
|
* })
|
|
4240
|
-
|
|
4278
|
+
* ```
|
|
4241
4279
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
4242
4280
|
*/
|
|
4243
4281
|
SpotterInit = "spotterInit",
|
|
@@ -4248,7 +4286,7 @@ export declare enum EmbedEvent {
|
|
|
4248
4286
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
4249
4287
|
* console.log('payload', payload);
|
|
4250
4288
|
* })
|
|
4251
|
-
|
|
4289
|
+
* ```
|
|
4252
4290
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
4253
4291
|
*/
|
|
4254
4292
|
SpotterLoadComplete = "spotterLoadComplete",
|
|
@@ -4602,7 +4640,7 @@ export declare enum HostEvent {
|
|
|
4602
4640
|
* ```js
|
|
4603
4641
|
* appEmbed.navigateToPage(-1)
|
|
4604
4642
|
* ```
|
|
4605
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
4643
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
4606
4644
|
*/
|
|
4607
4645
|
Navigate = "Navigate",
|
|
4608
4646
|
/**
|
|
@@ -4735,9 +4773,9 @@ export declare enum HostEvent {
|
|
|
4735
4773
|
* Trigger the **Show Liveboard details** action
|
|
4736
4774
|
* on an embedded Liveboard.
|
|
4737
4775
|
* @example
|
|
4738
|
-
|
|
4776
|
+
* ```js
|
|
4739
4777
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
4740
|
-
|
|
4778
|
+
* ```
|
|
4741
4779
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4742
4780
|
*/
|
|
4743
4781
|
LiveboardInfo = "pinboardInfo",
|
|
@@ -4865,7 +4903,7 @@ export declare enum HostEvent {
|
|
|
4865
4903
|
* appEmbed.trigger(HostEvent.Remove)
|
|
4866
4904
|
* ```
|
|
4867
4905
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4868
|
-
*
|
|
4906
|
+
* @example
|
|
4869
4907
|
* ```js
|
|
4870
4908
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
4871
4909
|
* ```
|
|
@@ -4956,7 +4994,7 @@ export declare enum HostEvent {
|
|
|
4956
4994
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4957
4995
|
* ```
|
|
4958
4996
|
* ```js
|
|
4959
|
-
* vizEmbed.trigger(
|
|
4997
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
4960
4998
|
* ```
|
|
4961
4999
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4962
5000
|
*/
|
|
@@ -4973,7 +5011,7 @@ export declare enum HostEvent {
|
|
|
4973
5011
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4974
5012
|
* ```
|
|
4975
5013
|
* ```js
|
|
4976
|
-
* vizEmbed.trigger(
|
|
5014
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
4977
5015
|
* ```
|
|
4978
5016
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4979
5017
|
*/
|
|
@@ -4988,23 +5026,22 @@ export declare enum HostEvent {
|
|
|
4988
5026
|
* );
|
|
4989
5027
|
* })
|
|
4990
5028
|
* ```
|
|
4991
|
-
*
|
|
5029
|
+
* @example
|
|
4992
5030
|
* ```js
|
|
4993
|
-
|
|
4994
|
-
|
|
4995
|
-
|
|
4996
|
-
|
|
4997
|
-
|
|
4998
|
-
|
|
4999
|
-
|
|
5000
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
5031
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
5032
|
+
* let latestSpotterVizId = '';
|
|
5033
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
5034
|
+
* latestSpotterVizId = payload.data.id;
|
|
5035
|
+
* });
|
|
5036
|
+
*
|
|
5037
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
5001
5038
|
* vizId: latestSpotterVizId
|
|
5002
5039
|
* }).then((tml) => {
|
|
5003
5040
|
* console.log(
|
|
5004
5041
|
* tml.answer.search_query // TML representation of the search query
|
|
5005
5042
|
* );
|
|
5006
5043
|
* })
|
|
5007
|
-
|
|
5044
|
+
* ```
|
|
5008
5045
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5009
5046
|
* @important
|
|
5010
5047
|
*/
|
|
@@ -5068,6 +5105,11 @@ export declare enum HostEvent {
|
|
|
5068
5105
|
/**
|
|
5069
5106
|
* Trigger the **Download** action on charts in
|
|
5070
5107
|
* the embedded view.
|
|
5108
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
5109
|
+
*
|
|
5110
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
5111
|
+
*
|
|
5112
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
5071
5113
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
5072
5114
|
* @example
|
|
5073
5115
|
* ```js
|
|
@@ -5086,9 +5128,6 @@ export declare enum HostEvent {
|
|
|
5086
5128
|
*
|
|
5087
5129
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
5088
5130
|
* ```
|
|
5089
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
5090
|
-
* Use {@link DownloadAsPng}
|
|
5091
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
5092
5131
|
*/
|
|
5093
5132
|
Download = "downloadAsPng",
|
|
5094
5133
|
/**
|
|
@@ -5526,8 +5565,8 @@ export declare enum HostEvent {
|
|
|
5526
5565
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
5527
5566
|
* console.log('parameters', parameter);
|
|
5528
5567
|
* });
|
|
5529
|
-
|
|
5530
|
-
|
|
5568
|
+
* ```
|
|
5569
|
+
* ```js
|
|
5531
5570
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
5532
5571
|
* let latestSpotterVizId = '';
|
|
5533
5572
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -5535,7 +5574,7 @@ export declare enum HostEvent {
|
|
|
5535
5574
|
* });
|
|
5536
5575
|
*
|
|
5537
5576
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
5538
|
-
|
|
5577
|
+
* ```
|
|
5539
5578
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
5540
5579
|
*/
|
|
5541
5580
|
GetParameters = "GetParameters",
|
|
@@ -5552,7 +5591,7 @@ export declare enum HostEvent {
|
|
|
5552
5591
|
* Notify when info call is completed successfully
|
|
5553
5592
|
* ```js
|
|
5554
5593
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
5555
|
-
|
|
5594
|
+
* ```
|
|
5556
5595
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5557
5596
|
*/
|
|
5558
5597
|
InfoSuccess = "InfoSuccess",
|
|
@@ -5655,7 +5694,7 @@ export declare enum HostEvent {
|
|
|
5655
5694
|
* ```js
|
|
5656
5695
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
5657
5696
|
*
|
|
5658
|
-
|
|
5697
|
+
* ```
|
|
5659
5698
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5660
5699
|
*/
|
|
5661
5700
|
AddToCoaching = "addToCoaching",
|
|
@@ -5697,7 +5736,7 @@ export declare enum HostEvent {
|
|
|
5697
5736
|
* });
|
|
5698
5737
|
*
|
|
5699
5738
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
5700
|
-
|
|
5739
|
+
* ```
|
|
5701
5740
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5702
5741
|
*/
|
|
5703
5742
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
@@ -5707,7 +5746,7 @@ export declare enum HostEvent {
|
|
|
5707
5746
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
5708
5747
|
* ```js
|
|
5709
5748
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
5710
|
-
|
|
5749
|
+
* ```
|
|
5711
5750
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5712
5751
|
*/
|
|
5713
5752
|
ExitPresentMode = "exitPresentMode",
|
|
@@ -5958,14 +5997,14 @@ export declare enum Action {
|
|
|
5958
5997
|
* ```js
|
|
5959
5998
|
* disabledActions: [Action.CollapseDataPanel]
|
|
5960
5999
|
* ```
|
|
5961
|
-
* @version
|
|
6000
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5962
6001
|
*/
|
|
5963
6002
|
CollapseDataSources = "collapseDataSources",
|
|
5964
6003
|
/**
|
|
5965
6004
|
* The **Collapse data panel** icon on the Search page.
|
|
5966
6005
|
* Collapses the data panel view.
|
|
5967
6006
|
*
|
|
5968
|
-
* @version
|
|
6007
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5969
6008
|
*
|
|
5970
6009
|
* @example
|
|
5971
6010
|
* ```js
|
|
@@ -6412,13 +6451,12 @@ export declare enum Action {
|
|
|
6412
6451
|
*/
|
|
6413
6452
|
CreateMonitor = "createMonitor",
|
|
6414
6453
|
/**
|
|
6415
|
-
* @
|
|
6416
|
-
*
|
|
6454
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6455
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
6417
6456
|
* @example
|
|
6418
6457
|
* ```js
|
|
6419
6458
|
* disabledActions: [Action.ReportError]
|
|
6420
6459
|
* ```
|
|
6421
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6422
6460
|
*/
|
|
6423
6461
|
ReportError = "reportError",
|
|
6424
6462
|
/**
|
|
@@ -6428,7 +6466,7 @@ export declare enum Action {
|
|
|
6428
6466
|
* ```js
|
|
6429
6467
|
* disabledActions: [Action.SyncToSheets]
|
|
6430
6468
|
* ```
|
|
6431
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6469
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6432
6470
|
*/
|
|
6433
6471
|
SyncToSheets = "sync-to-sheets",
|
|
6434
6472
|
/**
|
|
@@ -6439,7 +6477,7 @@ export declare enum Action {
|
|
|
6439
6477
|
* ```js
|
|
6440
6478
|
* disabledActions: [Action.SyncToOtherApps]
|
|
6441
6479
|
* ```
|
|
6442
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6480
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6443
6481
|
*/
|
|
6444
6482
|
SyncToOtherApps = "sync-to-other-apps",
|
|
6445
6483
|
/**
|
|
@@ -6449,7 +6487,7 @@ export declare enum Action {
|
|
|
6449
6487
|
* ```js
|
|
6450
6488
|
* disabledActions: [Action.ManagePipelines]
|
|
6451
6489
|
* ```
|
|
6452
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6490
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6453
6491
|
*/
|
|
6454
6492
|
ManagePipelines = "manage-pipeline",
|
|
6455
6493
|
/**
|
|
@@ -6761,7 +6799,7 @@ export declare enum Action {
|
|
|
6761
6799
|
* ```js
|
|
6762
6800
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
6763
6801
|
* ```
|
|
6764
|
-
* @version SDK
|
|
6802
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6765
6803
|
*/
|
|
6766
6804
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
6767
6805
|
/**
|
|
@@ -6771,7 +6809,7 @@ export declare enum Action {
|
|
|
6771
6809
|
* ```js
|
|
6772
6810
|
* disabledActions: [Action.LiveboardUsers]
|
|
6773
6811
|
* ```
|
|
6774
|
-
* @version SDK
|
|
6812
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6775
6813
|
*/
|
|
6776
6814
|
LiveboardUsers = "liveboardUsers",
|
|
6777
6815
|
/**
|
|
@@ -6789,7 +6827,7 @@ export declare enum Action {
|
|
|
6789
6827
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
6790
6828
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
6791
6829
|
* ```
|
|
6792
|
-
* @version SDK
|
|
6830
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
6793
6831
|
*/
|
|
6794
6832
|
TML = "tml",
|
|
6795
6833
|
/**
|
|
@@ -6835,7 +6873,7 @@ export declare enum Action {
|
|
|
6835
6873
|
* ```js
|
|
6836
6874
|
* disabledActions: [Action.AddToWatchlist]
|
|
6837
6875
|
* ```
|
|
6838
|
-
* @version SDK
|
|
6876
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6839
6877
|
*/
|
|
6840
6878
|
AddToWatchlist = "addToWatchlist",
|
|
6841
6879
|
/**
|
|
@@ -6845,7 +6883,7 @@ export declare enum Action {
|
|
|
6845
6883
|
* ```js
|
|
6846
6884
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6847
6885
|
* ```
|
|
6848
|
-
* @version SDK
|
|
6886
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6849
6887
|
*/
|
|
6850
6888
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6851
6889
|
/**
|
|
@@ -6856,7 +6894,7 @@ export declare enum Action {
|
|
|
6856
6894
|
* ```js
|
|
6857
6895
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6858
6896
|
* ```
|
|
6859
|
-
* @version SDK
|
|
6897
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6860
6898
|
*/
|
|
6861
6899
|
OrganiseFavourites = "organiseFavourites",
|
|
6862
6900
|
/**
|
|
@@ -6917,7 +6955,7 @@ export declare enum Action {
|
|
|
6917
6955
|
* ```js
|
|
6918
6956
|
* disabledActions: [Action.ManageTags]
|
|
6919
6957
|
* ```
|
|
6920
|
-
* @version SDK
|
|
6958
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6921
6959
|
*/
|
|
6922
6960
|
ManageTags = "manageTags",
|
|
6923
6961
|
/**
|
|
@@ -7769,14 +7807,14 @@ export type ApiInterceptFlags = {
|
|
|
7769
7807
|
/**
|
|
7770
7808
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
7771
7809
|
*
|
|
7772
|
-
* Can be used for
|
|
7810
|
+
* Can be used for Search and App Embed from SDK 1.29.0
|
|
7773
7811
|
*
|
|
7774
|
-
* @version SDK
|
|
7812
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7775
7813
|
*/
|
|
7776
7814
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
7777
7815
|
/**
|
|
7778
7816
|
* This allows to intercept the urls passed, once intercepted the api will only
|
|
7779
|
-
* run based on the
|
|
7817
|
+
* run based on the response from the responder of ApiIntercept event.
|
|
7780
7818
|
*
|
|
7781
7819
|
* @example
|
|
7782
7820
|
* ```js
|
|
@@ -7787,7 +7825,7 @@ export type ApiInterceptFlags = {
|
|
|
7787
7825
|
* })
|
|
7788
7826
|
* ```
|
|
7789
7827
|
*
|
|
7790
|
-
* @version SDK
|
|
7828
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7791
7829
|
*/
|
|
7792
7830
|
interceptUrls?: (string | InterceptedApiType)[];
|
|
7793
7831
|
/**
|
|
@@ -7804,7 +7842,7 @@ export type ApiInterceptFlags = {
|
|
|
7804
7842
|
* })
|
|
7805
7843
|
* ```
|
|
7806
7844
|
*
|
|
7807
|
-
* @version SDK
|
|
7845
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7808
7846
|
*/
|
|
7809
7847
|
interceptTimeout?: number;
|
|
7810
7848
|
};
|
|
@@ -8057,9 +8095,9 @@ declare class TsEmbed {
|
|
|
8057
8095
|
*/
|
|
8058
8096
|
private isPreRendered;
|
|
8059
8097
|
/**
|
|
8060
|
-
* Should we encode URL Query Params using base64 encoding which
|
|
8098
|
+
* Should we encode URL Query Params using base64 encoding which ThoughtSpot
|
|
8061
8099
|
* will generate for embedding. This provides additional security to
|
|
8062
|
-
*
|
|
8100
|
+
* ThoughtSpot clusters against Cross site scripting attacks.
|
|
8063
8101
|
* @default false
|
|
8064
8102
|
*/
|
|
8065
8103
|
private shouldEncodeUrlQueryParams;
|
|
@@ -8425,7 +8463,7 @@ declare class TsEmbed {
|
|
|
8425
8463
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
8426
8464
|
* session.
|
|
8427
8465
|
* @param vizId [Optional] to get for a specific viz in case of a Liveboard.
|
|
8428
|
-
* @version SDK: 1.25.0
|
|
8466
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
|
|
8429
8467
|
*/
|
|
8430
8468
|
getAnswerService(vizId?: string): Promise<AnswerService>;
|
|
8431
8469
|
/**
|
|
@@ -8484,81 +8522,81 @@ export interface SearchOptions {
|
|
|
8484
8522
|
* Configuration for the Spotter sidebar.
|
|
8485
8523
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
8486
8524
|
* @group Embed components
|
|
8487
|
-
* @version SDK: 1.
|
|
8525
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8488
8526
|
*/
|
|
8489
8527
|
export interface SpotterSidebarViewConfig {
|
|
8490
8528
|
/**
|
|
8491
8529
|
* Controls the visibility of the past conversations sidebar.
|
|
8492
8530
|
* @default false
|
|
8493
|
-
* @version SDK: 1.
|
|
8531
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8494
8532
|
*/
|
|
8495
8533
|
enablePastConversationsSidebar?: boolean;
|
|
8496
8534
|
/**
|
|
8497
8535
|
* Custom title text for the sidebar header.
|
|
8498
8536
|
* Defaults to translated "Spotter" text.
|
|
8499
|
-
* @version SDK: 1.
|
|
8537
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8500
8538
|
*/
|
|
8501
8539
|
spotterSidebarTitle?: string;
|
|
8502
8540
|
/**
|
|
8503
8541
|
* Boolean to set the default expanded state of the sidebar.
|
|
8504
8542
|
* @default false
|
|
8505
|
-
* @version SDK: 1.
|
|
8543
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8506
8544
|
*/
|
|
8507
8545
|
spotterSidebarDefaultExpanded?: boolean;
|
|
8508
8546
|
/**
|
|
8509
8547
|
* Custom label text for the rename action in the conversation edit menu.
|
|
8510
8548
|
* Defaults to translated "Rename" text.
|
|
8511
|
-
* @version SDK: 1.
|
|
8549
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8512
8550
|
*/
|
|
8513
8551
|
spotterChatRenameLabel?: string;
|
|
8514
8552
|
/**
|
|
8515
8553
|
* Custom label text for the delete action in the conversation edit menu.
|
|
8516
8554
|
* Defaults to translated "DELETE" text.
|
|
8517
|
-
* @version SDK: 1.
|
|
8555
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8518
8556
|
*/
|
|
8519
8557
|
spotterChatDeleteLabel?: string;
|
|
8520
8558
|
/**
|
|
8521
8559
|
* Custom title text for the delete conversation confirmation modal.
|
|
8522
8560
|
* Defaults to translated "Delete chat" text.
|
|
8523
|
-
* @version SDK: 1.
|
|
8561
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8524
8562
|
*/
|
|
8525
8563
|
spotterDeleteConversationModalTitle?: string;
|
|
8526
8564
|
/**
|
|
8527
8565
|
* Custom message text for the past conversation banner alert.
|
|
8528
8566
|
* Defaults to translated alert message.
|
|
8529
|
-
* @version SDK: 1.
|
|
8567
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8530
8568
|
*/
|
|
8531
8569
|
spotterPastConversationAlertMessage?: string;
|
|
8532
8570
|
/**
|
|
8533
8571
|
* Custom URL for the documentation/best practices link.
|
|
8534
8572
|
* Defaults to ThoughtSpot docs URL based on release version.
|
|
8535
8573
|
* Note: URL must include the protocol (e.g., `https://www.example.com`).
|
|
8536
|
-
* @version SDK: 1.
|
|
8574
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8537
8575
|
*/
|
|
8538
8576
|
spotterDocumentationUrl?: string;
|
|
8539
8577
|
/**
|
|
8540
8578
|
* Custom label text for the best practices button in the footer.
|
|
8541
8579
|
* Defaults to translated "Best Practices" text.
|
|
8542
|
-
* @version SDK: 1.
|
|
8580
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8543
8581
|
*/
|
|
8544
8582
|
spotterBestPracticesLabel?: string;
|
|
8545
8583
|
/**
|
|
8546
8584
|
* Number of conversations to fetch per batch when loading conversation history.
|
|
8547
8585
|
* @default 30
|
|
8548
|
-
* @version SDK: 1.
|
|
8586
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8549
8587
|
*/
|
|
8550
8588
|
spotterConversationsBatchSize?: number;
|
|
8551
8589
|
/**
|
|
8552
8590
|
* Custom title text for the "New Chat" button in the sidebar.
|
|
8553
8591
|
* Defaults to translated "New Chat" text.
|
|
8554
|
-
* @version SDK: 1.
|
|
8592
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8555
8593
|
*/
|
|
8556
8594
|
spotterNewChatButtonTitle?: string;
|
|
8557
8595
|
}
|
|
8558
8596
|
/**
|
|
8559
8597
|
* Configuration for customizing Spotter chat UI branding.
|
|
8560
|
-
* @group Embed components
|
|
8561
8598
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8599
|
+
* @group Embed components
|
|
8562
8600
|
*/
|
|
8563
8601
|
export interface SpotterChatViewConfig {
|
|
8564
8602
|
/**
|
|
@@ -8597,6 +8635,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8597
8635
|
* but still display the selected data source.
|
|
8598
8636
|
*
|
|
8599
8637
|
* Supported embed types: `SpotterEmbed`
|
|
8638
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8600
8639
|
* @example
|
|
8601
8640
|
* ```js
|
|
8602
8641
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8604,13 +8643,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8604
8643
|
* disableSourceSelection : true,
|
|
8605
8644
|
* })
|
|
8606
8645
|
* ```
|
|
8607
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8608
8646
|
*/
|
|
8609
8647
|
disableSourceSelection?: boolean;
|
|
8610
8648
|
/**
|
|
8611
8649
|
* hideSourceSelection : Hide data source selection
|
|
8612
8650
|
*
|
|
8613
8651
|
* Supported embed types: `SpotterEmbed`
|
|
8652
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8614
8653
|
* @example
|
|
8615
8654
|
* ```js
|
|
8616
8655
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8618,15 +8657,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8618
8657
|
* hideSourceSelection : true,
|
|
8619
8658
|
* })
|
|
8620
8659
|
* ```
|
|
8621
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8622
8660
|
*/
|
|
8623
8661
|
hideSourceSelection?: boolean;
|
|
8624
8662
|
/**
|
|
8625
8663
|
* Flag to control Data panel experience
|
|
8626
8664
|
*
|
|
8627
8665
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
8666
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8628
8667
|
* @default true
|
|
8629
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8630
8668
|
* @example
|
|
8631
8669
|
* ```js
|
|
8632
8670
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -8643,6 +8681,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8643
8681
|
* default is false.
|
|
8644
8682
|
*
|
|
8645
8683
|
* Supported embed types: `SpotterEmbed`
|
|
8684
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
8646
8685
|
* @example
|
|
8647
8686
|
* ```js
|
|
8648
8687
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8650,7 +8689,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8650
8689
|
* showSpotterLimitations : true,
|
|
8651
8690
|
* })
|
|
8652
8691
|
* ```
|
|
8653
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
8654
8692
|
*/
|
|
8655
8693
|
showSpotterLimitations?: boolean;
|
|
8656
8694
|
/**
|
|
@@ -8658,6 +8696,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8658
8696
|
* the initial screen of the conversation.
|
|
8659
8697
|
*
|
|
8660
8698
|
* Supported embed types: `SpotterEmbed`
|
|
8699
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8661
8700
|
* @example
|
|
8662
8701
|
* ```js
|
|
8663
8702
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8665,7 +8704,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8665
8704
|
* hideSampleQuestions : true,
|
|
8666
8705
|
* })
|
|
8667
8706
|
* ```
|
|
8668
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8669
8707
|
*/
|
|
8670
8708
|
hideSampleQuestions?: boolean;
|
|
8671
8709
|
/**
|
|
@@ -8673,6 +8711,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8673
8711
|
* visualization, or Liveboard.
|
|
8674
8712
|
*
|
|
8675
8713
|
* Supported embed types: `SpotterEmbed`
|
|
8714
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8676
8715
|
* @example
|
|
8677
8716
|
* ```js
|
|
8678
8717
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8686,7 +8725,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8686
8725
|
* ],
|
|
8687
8726
|
* })
|
|
8688
8727
|
* ```
|
|
8689
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8690
8728
|
*/
|
|
8691
8729
|
runtimeFilters?: RuntimeFilter[];
|
|
8692
8730
|
/**
|
|
@@ -8697,14 +8735,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8697
8735
|
* (default behavior before SDK 1.45.0).
|
|
8698
8736
|
*
|
|
8699
8737
|
* Supported embed types: `SpotterEmbed`
|
|
8700
|
-
* @default true
|
|
8701
8738
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8739
|
+
* @default true
|
|
8702
8740
|
*/
|
|
8703
8741
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
8704
8742
|
/**
|
|
8705
8743
|
* The list of runtime parameters to apply to the conversation.
|
|
8706
8744
|
*
|
|
8707
8745
|
* Supported embed types: `SpotterEmbed`
|
|
8746
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8708
8747
|
* @example
|
|
8709
8748
|
* ```js
|
|
8710
8749
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8717,7 +8756,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8717
8756
|
* ],
|
|
8718
8757
|
* })
|
|
8719
8758
|
* ```
|
|
8720
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8721
8759
|
*/
|
|
8722
8760
|
runtimeParameters?: RuntimeParameter[];
|
|
8723
8761
|
/**
|
|
@@ -8728,14 +8766,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8728
8766
|
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
8729
8767
|
*
|
|
8730
8768
|
* Supported embed types: `SpotterEmbed`
|
|
8731
|
-
* @default true
|
|
8732
8769
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8770
|
+
* @default true
|
|
8733
8771
|
*/
|
|
8734
8772
|
excludeRuntimeParametersfromURL?: boolean;
|
|
8735
8773
|
/**
|
|
8736
8774
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
8737
8775
|
*
|
|
8738
8776
|
* Supported embed types: `SpotterEmbed`
|
|
8777
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8739
8778
|
* @default false
|
|
8740
8779
|
* @example
|
|
8741
8780
|
* ```js
|
|
@@ -8744,17 +8783,30 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8744
8783
|
* updatedSpotterChatPrompt : true,
|
|
8745
8784
|
* })
|
|
8746
8785
|
* ```
|
|
8747
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8748
8786
|
*/
|
|
8749
8787
|
updatedSpotterChatPrompt?: boolean;
|
|
8788
|
+
/**
|
|
8789
|
+
* Controls the visibility of the past conversations sidebar.
|
|
8790
|
+
*
|
|
8791
|
+
* Supported embed types: `SpotterEmbed`
|
|
8792
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8793
|
+
* @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8794
|
+
* Use `spotterSidebarConfig.enablePastConversationsSidebar`.
|
|
8795
|
+
* @default false
|
|
8796
|
+
*/
|
|
8797
|
+
enablePastConversationsSidebar?: boolean;
|
|
8750
8798
|
/**
|
|
8751
8799
|
* Configuration for the Spotter sidebar UI customization.
|
|
8752
8800
|
*
|
|
8753
8801
|
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
8802
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8754
8803
|
* @example
|
|
8755
8804
|
* ```js
|
|
8756
8805
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8757
|
-
*
|
|
8806
|
+
* worksheetId: 'worksheet-id',
|
|
8807
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
8808
|
+
* enablePastConversationsSidebar: false,
|
|
8809
|
+
* // Recommended config; this value takes precedence
|
|
8758
8810
|
* spotterSidebarConfig: {
|
|
8759
8811
|
* enablePastConversationsSidebar: true,
|
|
8760
8812
|
* spotterSidebarTitle: 'My Conversations',
|
|
@@ -8762,7 +8814,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8762
8814
|
* },
|
|
8763
8815
|
* })
|
|
8764
8816
|
* ```
|
|
8765
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8766
8817
|
*/
|
|
8767
8818
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
8768
8819
|
/**
|
|
@@ -8770,6 +8821,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8770
8821
|
* branding in tool response cards.
|
|
8771
8822
|
*
|
|
8772
8823
|
* Supported embed types: `SpotterEmbed`
|
|
8824
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8773
8825
|
* @example
|
|
8774
8826
|
* ```js
|
|
8775
8827
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8780,20 +8832,20 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8780
8832
|
* },
|
|
8781
8833
|
* })
|
|
8782
8834
|
* ```
|
|
8783
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8784
8835
|
*/
|
|
8785
8836
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
8786
8837
|
}
|
|
8787
8838
|
/**
|
|
8788
8839
|
* The configuration for the embedded spotterEmbed options.
|
|
8789
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8790
8840
|
* Use {@link SpotterEmbedViewConfig} instead
|
|
8841
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8791
8842
|
* @group Embed components
|
|
8792
8843
|
*/
|
|
8793
8844
|
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
8794
8845
|
}
|
|
8795
8846
|
/**
|
|
8796
8847
|
* Embed ThoughtSpot AI Conversation.
|
|
8848
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8797
8849
|
* @group Embed components
|
|
8798
8850
|
* @example
|
|
8799
8851
|
* ```js
|
|
@@ -8805,7 +8857,6 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
|
8805
8857
|
* });
|
|
8806
8858
|
* conversation.render();
|
|
8807
8859
|
* ```
|
|
8808
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8809
8860
|
*/
|
|
8810
8861
|
export declare class SpotterEmbed extends TsEmbed {
|
|
8811
8862
|
protected viewConfig: SpotterEmbedViewConfig;
|
|
@@ -8816,8 +8867,9 @@ export declare class SpotterEmbed extends TsEmbed {
|
|
|
8816
8867
|
}
|
|
8817
8868
|
/**
|
|
8818
8869
|
* Embed ThoughtSpot AI Conversation.
|
|
8819
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8820
8870
|
* Use {@link SpotterEmbed} instead
|
|
8871
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8872
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8821
8873
|
* @group Embed components
|
|
8822
8874
|
* @example
|
|
8823
8875
|
* ```js
|
|
@@ -8829,7 +8881,6 @@ export declare class SpotterEmbed extends TsEmbed {
|
|
|
8829
8881
|
* });
|
|
8830
8882
|
* conversation.render();
|
|
8831
8883
|
* ```
|
|
8832
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8833
8884
|
*/
|
|
8834
8885
|
export declare class ConversationEmbed extends SpotterEmbed {
|
|
8835
8886
|
protected viewConfig: ConversationViewConfig;
|
|
@@ -8944,7 +8995,7 @@ export declare enum ListPage {
|
|
|
8944
8995
|
*/
|
|
8945
8996
|
export interface DiscoveryExperience {
|
|
8946
8997
|
/**
|
|
8947
|
-
* primaryNavbarVersion determines the version of the navigation
|
|
8998
|
+
* primaryNavbarVersion determines the version of the primary navigation bar.
|
|
8948
8999
|
*/
|
|
8949
9000
|
primaryNavbarVersion?: PrimaryNavbarVersion;
|
|
8950
9001
|
/**
|
|
@@ -8967,8 +9018,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8967
9018
|
* This flag also controls the homepage left navigation bar.
|
|
8968
9019
|
*
|
|
8969
9020
|
* Supported embed types: `AppEmbed`
|
|
8970
|
-
* @default true
|
|
8971
9021
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9022
|
+
* @default true
|
|
8972
9023
|
* @example
|
|
8973
9024
|
* ```js
|
|
8974
9025
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8989,8 +9040,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8989
9040
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
8990
9041
|
*
|
|
8991
9042
|
* Supported embed types: `AppEmbed`
|
|
8992
|
-
* @default false
|
|
8993
9043
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9044
|
+
* @default false
|
|
8994
9045
|
* @example
|
|
8995
9046
|
* ```js
|
|
8996
9047
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9007,8 +9058,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9007
9058
|
* navigation bar is not hidden via `showPrimaryNavbar`.
|
|
9008
9059
|
*
|
|
9009
9060
|
* Supported embed types: `AppEmbed`
|
|
9010
|
-
* @default false
|
|
9011
9061
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9062
|
+
* @default false
|
|
9012
9063
|
* @example
|
|
9013
9064
|
* ```js
|
|
9014
9065
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9019,12 +9070,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9019
9070
|
*/
|
|
9020
9071
|
disableProfileAndHelp?: boolean;
|
|
9021
9072
|
/**
|
|
9022
|
-
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9023
|
-
* @default true
|
|
9024
9073
|
* Whether the help menu in the top navigation bar should be served
|
|
9025
9074
|
* from Pendo or ThoughtSpot's internal help items.
|
|
9026
9075
|
*
|
|
9027
9076
|
* Supported embed types: `AppEmbed`
|
|
9077
|
+
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9078
|
+
* @default true
|
|
9028
9079
|
* @example
|
|
9029
9080
|
* ```js
|
|
9030
9081
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9039,8 +9090,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9039
9090
|
* the top navigation bar in the V3 navigation experience.
|
|
9040
9091
|
*
|
|
9041
9092
|
* Supported embed types: `AppEmbed`
|
|
9042
|
-
* @default false
|
|
9043
9093
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9094
|
+
* @default false
|
|
9044
9095
|
* @example
|
|
9045
9096
|
* ```js
|
|
9046
9097
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9059,8 +9110,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9059
9110
|
* in the classic (V1) experience.
|
|
9060
9111
|
*
|
|
9061
9112
|
* Supported embed types: `AppEmbed`
|
|
9062
|
-
* @default true
|
|
9063
9113
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9114
|
+
* @default true
|
|
9064
9115
|
* @example
|
|
9065
9116
|
* ```js
|
|
9066
9117
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9078,8 +9129,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9078
9129
|
* in the classic (V1) and V2 experience modes.
|
|
9079
9130
|
*
|
|
9080
9131
|
* Supported embed types: `AppEmbed`
|
|
9081
|
-
* @default true
|
|
9082
9132
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9133
|
+
* @default true
|
|
9083
9134
|
* @example
|
|
9084
9135
|
* ```js
|
|
9085
9136
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9095,7 +9146,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9095
9146
|
* In the V3 experience, it shows or hides application selection
|
|
9096
9147
|
* icons on the left navigation panel.
|
|
9097
9148
|
* By default, the application selection menu and icons are
|
|
9098
|
-
* shown in the UI
|
|
9149
|
+
* shown in the UI.
|
|
9099
9150
|
*
|
|
9100
9151
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
9101
9152
|
*
|
|
@@ -9135,7 +9186,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9135
9186
|
* takes precedence. This is the path post the `#/` in the URL of the standalone
|
|
9136
9187
|
* ThoughtSpot app. Use this to open the embedded view to a specific path.
|
|
9137
9188
|
*
|
|
9138
|
-
* For
|
|
9189
|
+
* For example, if you want the component to open to a specific Liveboard
|
|
9139
9190
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
9140
9191
|
*
|
|
9141
9192
|
* Supported embed types: `AppEmbed`
|
|
@@ -9153,7 +9204,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9153
9204
|
* The application page to set as the start page
|
|
9154
9205
|
* in the embedded view.
|
|
9155
9206
|
*
|
|
9156
|
-
* Use this to open to particular page in the app. To open to a specific
|
|
9207
|
+
* Use this to open to a particular page in the app. To open to a specific
|
|
9157
9208
|
* path within the app, use the `path` attribute which is more flexible.
|
|
9158
9209
|
*
|
|
9159
9210
|
* Supported embed types: `AppEmbed`
|
|
@@ -9233,8 +9284,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9233
9284
|
* If set to true, the Search Assist feature is enabled.
|
|
9234
9285
|
*
|
|
9235
9286
|
* Supported embed types: `AppEmbed`
|
|
9236
|
-
* @default true
|
|
9237
9287
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
9288
|
+
* @default true
|
|
9238
9289
|
* @example
|
|
9239
9290
|
* ```js
|
|
9240
9291
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9272,8 +9323,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9272
9323
|
* For more information,
|
|
9273
9324
|
* see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
9274
9325
|
* Supported embed types: `AppEmbed`
|
|
9275
|
-
* @default false
|
|
9276
9326
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9327
|
+
* @default false
|
|
9277
9328
|
* @example
|
|
9278
9329
|
* ```js
|
|
9279
9330
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9288,8 +9339,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9288
9339
|
* For more information, see
|
|
9289
9340
|
* link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
9290
9341
|
* Supported embed types: `AppEmbed`
|
|
9291
|
-
* @default false
|
|
9292
9342
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9343
|
+
* @default false
|
|
9293
9344
|
* @example
|
|
9294
9345
|
* ```js
|
|
9295
9346
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9304,10 +9355,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9304
9355
|
*/
|
|
9305
9356
|
discoveryExperience?: DiscoveryExperience;
|
|
9306
9357
|
/**
|
|
9307
|
-
* To set the initial state of the search bar in case of saved-answers.
|
|
9358
|
+
* To set the initial state of the search bar in case of saved-answers. Use {@link collapseSearchBar} instead.
|
|
9308
9359
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
9360
|
+
* @deprecated This flag is deprecated.
|
|
9309
9361
|
* @default false
|
|
9310
|
-
* @deprecated Use {@link collapseSearchBar} instead
|
|
9311
9362
|
*/
|
|
9312
9363
|
collapseSearchBarInitially?: boolean;
|
|
9313
9364
|
/**
|
|
@@ -9335,14 +9386,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9335
9386
|
* Flag to use home page search bar mode
|
|
9336
9387
|
*
|
|
9337
9388
|
* Supported embed types: `AppEmbed`
|
|
9338
|
-
* @version SDK
|
|
9389
|
+
* @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
9339
9390
|
*/
|
|
9340
9391
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
9341
9392
|
/**
|
|
9342
9393
|
* This flag is used to enable unified search experience for full app embed.
|
|
9343
9394
|
*
|
|
9344
9395
|
* Supported embed types: `AppEmbed`
|
|
9345
|
-
* @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
|
|
9396
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
|
|
9346
9397
|
* @default true
|
|
9347
9398
|
* @example
|
|
9348
9399
|
* ```js
|
|
@@ -9354,7 +9405,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9354
9405
|
*/
|
|
9355
9406
|
isUnifiedSearchExperienceEnabled?: boolean;
|
|
9356
9407
|
/**
|
|
9357
|
-
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
9408
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
9409
|
+
* @deprecated This flag is deprecated.
|
|
9358
9410
|
*
|
|
9359
9411
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9360
9412
|
* @type {boolean}
|
|
@@ -9420,6 +9472,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9420
9472
|
/**
|
|
9421
9473
|
* This flag is used to enable the full height lazy load data.
|
|
9422
9474
|
*
|
|
9475
|
+
* @type {boolean}
|
|
9476
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9477
|
+
* @default false
|
|
9423
9478
|
* @example
|
|
9424
9479
|
* ```js
|
|
9425
9480
|
* const embed = new AppEmbed('#embed-container', {
|
|
@@ -9428,39 +9483,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9428
9483
|
* lazyLoadingForFullHeight: true,
|
|
9429
9484
|
* })
|
|
9430
9485
|
* ```
|
|
9431
|
-
*
|
|
9432
|
-
* @type {boolean}
|
|
9433
|
-
* @default false
|
|
9434
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9435
9486
|
*/
|
|
9436
9487
|
lazyLoadingForFullHeight?: boolean;
|
|
9437
9488
|
/**
|
|
9438
9489
|
* The margin to be used for lazy loading.
|
|
9439
9490
|
*
|
|
9440
9491
|
* For example, if the margin is set to '10px',
|
|
9441
|
-
* the visualization will be loaded 10px before
|
|
9492
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
9442
9493
|
* viewport.
|
|
9443
9494
|
*
|
|
9444
9495
|
* The format is similar to CSS margin.
|
|
9445
9496
|
*
|
|
9497
|
+
* @type {string}
|
|
9498
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9446
9499
|
* @example
|
|
9447
9500
|
* ```js
|
|
9448
9501
|
* const embed = new AppEmbed('#embed-container', {
|
|
9449
9502
|
* // ...other options
|
|
9450
9503
|
* fullHeight: true,
|
|
9451
9504
|
* lazyLoadingForFullHeight: true,
|
|
9452
|
-
* // Using 0px, the visualization will be only loaded when
|
|
9505
|
+
* // Using 0px, the visualization will be only loaded when it's visible in the viewport.
|
|
9453
9506
|
* lazyLoadingMargin: '0px',
|
|
9454
9507
|
* })
|
|
9455
9508
|
* ```
|
|
9456
|
-
* @type {string}
|
|
9457
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9458
9509
|
*/
|
|
9459
9510
|
lazyLoadingMargin?: string;
|
|
9460
9511
|
/**
|
|
9461
9512
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9462
9513
|
*
|
|
9463
9514
|
* Supported embed types: `AppEmbed`
|
|
9515
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9464
9516
|
* @default false
|
|
9465
9517
|
* @example
|
|
9466
9518
|
* ```js
|
|
@@ -9469,25 +9521,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9469
9521
|
* updatedSpotterChatPrompt : true,
|
|
9470
9522
|
* })
|
|
9471
9523
|
* ```
|
|
9472
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9473
9524
|
*/
|
|
9474
9525
|
updatedSpotterChatPrompt?: boolean;
|
|
9526
|
+
/**
|
|
9527
|
+
* Controls the visibility of the past conversations sidebar.
|
|
9528
|
+
*
|
|
9529
|
+
* Supported embed types: `AppEmbed`
|
|
9530
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9531
|
+
* @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9532
|
+
* Use `spotterSidebarConfig.enablePastConversationsSidebar`.
|
|
9533
|
+
* @default false
|
|
9534
|
+
*/
|
|
9535
|
+
enablePastConversationsSidebar?: boolean;
|
|
9475
9536
|
/**
|
|
9476
9537
|
* Configuration for the Spotter sidebar UI customization.
|
|
9477
9538
|
* Only applicable when navigating to Spotter within the app.
|
|
9478
9539
|
*
|
|
9479
9540
|
* Supported embed types: `AppEmbed`
|
|
9541
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9480
9542
|
* @example
|
|
9481
9543
|
* ```js
|
|
9482
9544
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
9483
|
-
*
|
|
9545
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
9546
|
+
* enablePastConversationsSidebar: false,
|
|
9547
|
+
* // Recommended config; this value takes precedence
|
|
9484
9548
|
* spotterSidebarConfig: {
|
|
9485
9549
|
* enablePastConversationsSidebar: true,
|
|
9486
9550
|
* spotterSidebarTitle: 'My Conversations',
|
|
9487
9551
|
* },
|
|
9488
9552
|
* })
|
|
9489
9553
|
* ```
|
|
9490
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9491
9554
|
*/
|
|
9492
9555
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
9493
9556
|
/**
|
|
@@ -9495,6 +9558,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9495
9558
|
* branding in tool response cards.
|
|
9496
9559
|
*
|
|
9497
9560
|
* Supported embed types: `AppEmbed`
|
|
9561
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9498
9562
|
* @example
|
|
9499
9563
|
* ```js
|
|
9500
9564
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9505,7 +9569,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9505
9569
|
* },
|
|
9506
9570
|
* })
|
|
9507
9571
|
* ```
|
|
9508
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9509
9572
|
*/
|
|
9510
9573
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
9511
9574
|
/**
|
|
@@ -9525,6 +9588,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9525
9588
|
* ```
|
|
9526
9589
|
*/
|
|
9527
9590
|
minimumHeight?: number;
|
|
9591
|
+
/**
|
|
9592
|
+
* To enable the homepage announcement banner.
|
|
9593
|
+
* Controls the visibility of the announcement section
|
|
9594
|
+
* on the homepage.
|
|
9595
|
+
*
|
|
9596
|
+
* Supported embed types: `AppEmbed`
|
|
9597
|
+
* @example
|
|
9598
|
+
* ```js
|
|
9599
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
9600
|
+
* ... // other embed view config
|
|
9601
|
+
* enableHomepageAnnouncement: true,
|
|
9602
|
+
* })
|
|
9603
|
+
* ```
|
|
9604
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
9605
|
+
*/
|
|
9606
|
+
enableHomepageAnnouncement?: boolean;
|
|
9528
9607
|
}
|
|
9529
9608
|
/**
|
|
9530
9609
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -9651,20 +9730,45 @@ export declare enum AuthFailureType {
|
|
|
9651
9730
|
*/
|
|
9652
9731
|
export declare enum AuthStatus {
|
|
9653
9732
|
/**
|
|
9654
|
-
* Emits when the SDK fails to authenticate
|
|
9733
|
+
* Emits when the SDK fails to authenticate.
|
|
9655
9734
|
*/
|
|
9656
9735
|
FAILURE = "FAILURE",
|
|
9657
9736
|
/**
|
|
9658
|
-
* Emits when the SDK
|
|
9737
|
+
* Emits when the SDK authentication step completes
|
|
9738
|
+
* successfully (e.g., token exchange, cookie set).
|
|
9739
|
+
* This fires before any iframe is rendered. Use
|
|
9740
|
+
* this to know that auth passed and it is safe to
|
|
9741
|
+
* proceed with rendering. The callback receives no
|
|
9742
|
+
* arguments.
|
|
9743
|
+
* @example
|
|
9744
|
+
* ```js
|
|
9745
|
+
* const authEE = init({ ... });
|
|
9746
|
+
* authEE.on(AuthStatus.SDK_SUCCESS, () => {
|
|
9747
|
+
* // Auth done, iframe not loaded yet
|
|
9748
|
+
* });
|
|
9749
|
+
* ```
|
|
9659
9750
|
*/
|
|
9660
9751
|
SDK_SUCCESS = "SDK_SUCCESS",
|
|
9661
9752
|
/**
|
|
9662
9753
|
* @hidden
|
|
9663
|
-
* Emits when iframe is loaded and session
|
|
9754
|
+
* Emits when iframe is loaded and session
|
|
9755
|
+
* information is available.
|
|
9664
9756
|
*/
|
|
9665
9757
|
SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS",
|
|
9666
9758
|
/**
|
|
9667
|
-
* Emits when the app
|
|
9759
|
+
* Emits when the ThoughtSpot app inside the
|
|
9760
|
+
* embedded iframe confirms its session is active.
|
|
9761
|
+
* This fires after the iframe loads and sends back an `AuthInit` event.
|
|
9762
|
+
* @param sessionInfo Information about the user session, with details like `userGUID`.
|
|
9763
|
+
* @see EmbedEvent.AuthInit
|
|
9764
|
+
* @example
|
|
9765
|
+
* ```js
|
|
9766
|
+
* const authEE = init({ ... });
|
|
9767
|
+
* authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
|
|
9768
|
+
* // App is loaded and authenticated
|
|
9769
|
+
* console.log(sessionInfo.userGUID);
|
|
9770
|
+
* });
|
|
9771
|
+
* ```
|
|
9668
9772
|
*/
|
|
9669
9773
|
SUCCESS = "SUCCESS",
|
|
9670
9774
|
/**
|
|
@@ -9813,7 +9917,7 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
9813
9917
|
* }).catch(error => {
|
|
9814
9918
|
* console.error(error);
|
|
9815
9919
|
* });
|
|
9816
|
-
|
|
9920
|
+
* ```
|
|
9817
9921
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
9818
9922
|
* @group Global methods
|
|
9819
9923
|
*/
|
|
@@ -9851,9 +9955,9 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
|
9851
9955
|
export declare const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
9852
9956
|
/**
|
|
9853
9957
|
* Reloads the ThoughtSpot iframe.
|
|
9958
|
+
* @version SDK: 1.43.1
|
|
9854
9959
|
* @param iFrame
|
|
9855
9960
|
* @group Global methods
|
|
9856
|
-
* @version SDK: 1.43.1
|
|
9857
9961
|
*/
|
|
9858
9962
|
export declare const reloadIframe: (iFrame: HTMLIFrameElement) => void;
|
|
9859
9963
|
/**
|
|
@@ -9872,9 +9976,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9872
9976
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
9873
9977
|
* incrementally as users scroll the page to view the charts and tables.
|
|
9874
9978
|
*
|
|
9875
|
-
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
9876
9979
|
*
|
|
9877
9980
|
* Supported embed types: `LiveboardEmbed`
|
|
9981
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
9878
9982
|
* @example
|
|
9879
9983
|
* ```js
|
|
9880
9984
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -9885,14 +9989,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9885
9989
|
*/
|
|
9886
9990
|
fullHeight?: boolean;
|
|
9887
9991
|
/**
|
|
9888
|
-
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
9992
|
+
* This is the minimum height (in pixels) for a full-height Liveboard.
|
|
9889
9993
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
9890
9994
|
* other screens navigable from a Liveboard.
|
|
9891
9995
|
*
|
|
9892
9996
|
* Supported embed types: `LiveboardEmbed`
|
|
9893
9997
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
9894
|
-
* @default 500
|
|
9895
9998
|
* @deprecated Use `minimumHeight` instead.
|
|
9999
|
+
* @default 500
|
|
9896
10000
|
* @example
|
|
9897
10001
|
* ```js
|
|
9898
10002
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -9921,7 +10025,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9921
10025
|
*/
|
|
9922
10026
|
minimumHeight?: number;
|
|
9923
10027
|
/**
|
|
9924
|
-
*
|
|
10028
|
+
* If set to true, the context menu in visualizations will be enabled.
|
|
10029
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10030
|
+
* @deprecated this option is deprecated.
|
|
9925
10031
|
* @example
|
|
9926
10032
|
* ```js
|
|
9927
10033
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9929,7 +10035,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9929
10035
|
* enableVizTransformations:true,
|
|
9930
10036
|
* })
|
|
9931
10037
|
* ```
|
|
9932
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
9933
10038
|
*/
|
|
9934
10039
|
enableVizTransformations?: boolean;
|
|
9935
10040
|
/**
|
|
@@ -9942,8 +10047,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9942
10047
|
* ```js
|
|
9943
10048
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9944
10049
|
* ... //other embed view config
|
|
9945
|
-
* liveboardId:id of liveboard,
|
|
10050
|
+
* liveboardId:'id of liveboard',
|
|
9946
10051
|
* })
|
|
10052
|
+
* ```
|
|
9947
10053
|
*/
|
|
9948
10054
|
liveboardId?: string;
|
|
9949
10055
|
/**
|
|
@@ -9996,6 +10102,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9996
10102
|
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
9997
10103
|
* ]
|
|
9998
10104
|
* })
|
|
10105
|
+
* ```
|
|
9999
10106
|
*/
|
|
10000
10107
|
visibleVizs?: string[];
|
|
10001
10108
|
/**
|
|
@@ -10023,6 +10130,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10023
10130
|
* Specify the tab ID.
|
|
10024
10131
|
*
|
|
10025
10132
|
* Supported embed types: `LiveboardEmbed`
|
|
10133
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
10026
10134
|
* @example
|
|
10027
10135
|
* ```js
|
|
10028
10136
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10030,7 +10138,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10030
10138
|
* activeTabId:'id-1234',
|
|
10031
10139
|
* })
|
|
10032
10140
|
* ```
|
|
10033
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
10034
10141
|
*/
|
|
10035
10142
|
activeTabId?: string;
|
|
10036
10143
|
/**
|
|
@@ -10039,6 +10146,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10039
10146
|
* that includes specific filter selections.
|
|
10040
10147
|
*
|
|
10041
10148
|
* Supported embed types: `LiveboardEmbed`
|
|
10149
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10042
10150
|
* @example
|
|
10043
10151
|
* ```js
|
|
10044
10152
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10047,7 +10155,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10047
10155
|
* activeTabId: 'tab-guid',
|
|
10048
10156
|
* })
|
|
10049
10157
|
* ```
|
|
10050
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10051
10158
|
*/
|
|
10052
10159
|
personalizedViewId?: string;
|
|
10053
10160
|
/**
|
|
@@ -10068,13 +10175,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10068
10175
|
* Show a preview image of the visualization before the visualization loads.
|
|
10069
10176
|
* Only works for visualizations embeds with a viz id.
|
|
10070
10177
|
*
|
|
10071
|
-
* Also, viz
|
|
10178
|
+
* Also, viz snapshot should be enabled in the ThoughtSpot instance.
|
|
10072
10179
|
* Contact ThoughtSpot support to enable this feature.
|
|
10073
10180
|
*
|
|
10074
|
-
* Since
|
|
10181
|
+
* Since this will show preview images, be careful that it may show
|
|
10075
10182
|
* undesired data to the user when using row level security.
|
|
10076
10183
|
*
|
|
10077
10184
|
* Supported embed types: `LiveboardEmbed`
|
|
10185
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10078
10186
|
* @example
|
|
10079
10187
|
* ```js
|
|
10080
10188
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10084,7 +10192,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10084
10192
|
* });
|
|
10085
10193
|
* embed.render();
|
|
10086
10194
|
* ```
|
|
10087
|
-
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10088
10195
|
*/
|
|
10089
10196
|
showPreviewLoader?: boolean;
|
|
10090
10197
|
/**
|
|
@@ -10092,13 +10199,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10092
10199
|
*
|
|
10093
10200
|
* Supported embed types: `LiveboardEmbed`
|
|
10094
10201
|
* @hidden
|
|
10095
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10202
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10096
10203
|
* @example
|
|
10097
10204
|
* ```js
|
|
10098
10205
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10099
10206
|
* ... //other embed view config
|
|
10100
|
-
* oAuthPollingInterval:
|
|
10207
|
+
* oAuthPollingInterval: 30000,
|
|
10101
10208
|
* })
|
|
10209
|
+
* ```
|
|
10102
10210
|
*/
|
|
10103
10211
|
oAuthPollingInterval?: number;
|
|
10104
10212
|
/**
|
|
@@ -10106,35 +10214,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10106
10214
|
*
|
|
10107
10215
|
* Supported embed types: `LiveboardEmbed`
|
|
10108
10216
|
* @hidden
|
|
10109
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10217
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10110
10218
|
* @example
|
|
10111
10219
|
* ```js
|
|
10112
10220
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10113
10221
|
* ... //other embed view config
|
|
10114
10222
|
* isForceRedirect: false,
|
|
10115
10223
|
* })
|
|
10224
|
+
* ```
|
|
10116
10225
|
*/
|
|
10117
10226
|
isForceRedirect?: boolean;
|
|
10118
10227
|
/**
|
|
10119
10228
|
* The source connection ID for authentication.
|
|
10120
|
-
* @hidden
|
|
10121
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10122
10229
|
*
|
|
10123
10230
|
* Supported embed types: `LiveboardEmbed`
|
|
10231
|
+
* @hidden
|
|
10232
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10124
10233
|
* @example
|
|
10125
10234
|
* ```js
|
|
10126
10235
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10127
10236
|
* ... //other embed view config
|
|
10128
10237
|
* dataSourceId: '',
|
|
10129
10238
|
* })
|
|
10239
|
+
* ```
|
|
10130
10240
|
*/
|
|
10131
10241
|
dataSourceId?: string;
|
|
10132
10242
|
/**
|
|
10133
|
-
* The list of tab IDs to hide from the embedded.
|
|
10134
|
-
*
|
|
10135
|
-
* Use this to hide
|
|
10243
|
+
* The list of tab IDs to hide from the embedded Liveboard.
|
|
10244
|
+
* These tabs will be hidden from their respective Liveboards.
|
|
10245
|
+
* Use this to hide a tab ID.
|
|
10136
10246
|
*
|
|
10137
10247
|
* Supported embed types: `LiveboardEmbed`
|
|
10248
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
10138
10249
|
* @example
|
|
10139
10250
|
* ```js
|
|
10140
10251
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10145,7 +10256,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10145
10256
|
* ]
|
|
10146
10257
|
* });
|
|
10147
10258
|
* ```
|
|
10148
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
10149
10259
|
*/
|
|
10150
10260
|
hiddenTabs?: string[];
|
|
10151
10261
|
/**
|
|
@@ -10169,7 +10279,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10169
10279
|
*/
|
|
10170
10280
|
visibleTabs?: string[];
|
|
10171
10281
|
/**
|
|
10172
|
-
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
10282
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
10283
|
+
* @deprecated This flag is deprecated.
|
|
10173
10284
|
*
|
|
10174
10285
|
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
|
|
10175
10286
|
* @type {boolean}
|
|
@@ -10235,6 +10346,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10235
10346
|
/**
|
|
10236
10347
|
* This flag is used to enable the full height lazy load data.
|
|
10237
10348
|
*
|
|
10349
|
+
* @type {boolean}
|
|
10350
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10351
|
+
* @default false
|
|
10238
10352
|
* @example
|
|
10239
10353
|
* ```js
|
|
10240
10354
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -10243,33 +10357,29 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10243
10357
|
* lazyLoadingForFullHeight: true,
|
|
10244
10358
|
* })
|
|
10245
10359
|
* ```
|
|
10246
|
-
*
|
|
10247
|
-
* @type {boolean}
|
|
10248
|
-
* @default false
|
|
10249
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
10250
10360
|
*/
|
|
10251
10361
|
lazyLoadingForFullHeight?: boolean;
|
|
10252
10362
|
/**
|
|
10253
10363
|
* The margin to be used for lazy loading.
|
|
10254
10364
|
*
|
|
10255
10365
|
* For example, if the margin is set to '10px',
|
|
10256
|
-
* the visualization will be loaded 10px before
|
|
10366
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
10257
10367
|
* viewport.
|
|
10258
10368
|
*
|
|
10259
10369
|
* The format is similar to CSS margin.
|
|
10260
10370
|
*
|
|
10371
|
+
* @type {string}
|
|
10372
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10261
10373
|
* @example
|
|
10262
10374
|
* ```js
|
|
10263
10375
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
10264
10376
|
* // ...other options
|
|
10265
10377
|
* fullHeight: true,
|
|
10266
10378
|
* lazyLoadingForFullHeight: true,
|
|
10267
|
-
* // Using 0px, the visualization will be only loaded when
|
|
10379
|
+
* // Using 0px, the visualization will be only loaded when it's visible in the viewport.
|
|
10268
10380
|
* lazyLoadingMargin: '0px',
|
|
10269
10381
|
* })
|
|
10270
10382
|
* ```
|
|
10271
|
-
* @type {string}
|
|
10272
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
10273
10383
|
*/
|
|
10274
10384
|
lazyLoadingMargin?: string;
|
|
10275
10385
|
/**
|
|
@@ -10277,6 +10387,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10277
10387
|
* of the spotter underneath the chat input.
|
|
10278
10388
|
* default is false.
|
|
10279
10389
|
*
|
|
10390
|
+
* @type {boolean}
|
|
10391
|
+
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
10280
10392
|
* @example
|
|
10281
10393
|
* ```js
|
|
10282
10394
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -10284,14 +10396,13 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10284
10396
|
* showSpotterLimitations: true,
|
|
10285
10397
|
* })
|
|
10286
10398
|
* ```
|
|
10287
|
-
* @type {boolean}
|
|
10288
|
-
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
10289
10399
|
*/
|
|
10290
10400
|
showSpotterLimitations?: boolean;
|
|
10291
10401
|
/**
|
|
10292
10402
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
10293
10403
|
*
|
|
10294
10404
|
* Supported embed types: `LiveboardEmbed`
|
|
10405
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10295
10406
|
* @default false
|
|
10296
10407
|
* @example
|
|
10297
10408
|
* ```js
|
|
@@ -10300,7 +10411,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10300
10411
|
* updatedSpotterChatPrompt : true,
|
|
10301
10412
|
* })
|
|
10302
10413
|
* ```
|
|
10303
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10304
10414
|
*/
|
|
10305
10415
|
updatedSpotterChatPrompt?: boolean;
|
|
10306
10416
|
/**
|
|
@@ -10308,6 +10418,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10308
10418
|
* branding in tool response cards.
|
|
10309
10419
|
*
|
|
10310
10420
|
* Supported embed types: `LiveboardEmbed`
|
|
10421
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10311
10422
|
* @example
|
|
10312
10423
|
* ```js
|
|
10313
10424
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10318,7 +10429,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10318
10429
|
* },
|
|
10319
10430
|
* })
|
|
10320
10431
|
* ```
|
|
10321
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10322
10432
|
*/
|
|
10323
10433
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
10324
10434
|
}
|
|
@@ -10326,6 +10436,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10326
10436
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
10327
10437
|
* waits for the authentication to complete, so you need not wait for
|
|
10328
10438
|
* `AuthStatus.SUCCESS`.
|
|
10439
|
+
* @group Embed components
|
|
10329
10440
|
* @example
|
|
10330
10441
|
* ```js
|
|
10331
10442
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -10335,7 +10446,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10335
10446
|
* // .. other params here.
|
|
10336
10447
|
* })
|
|
10337
10448
|
* ```
|
|
10338
|
-
* @group Embed components
|
|
10339
10449
|
*/
|
|
10340
10450
|
export declare class LiveboardEmbed extends V1Embed {
|
|
10341
10451
|
protected viewConfig: LiveboardViewConfig;
|
|
@@ -10455,7 +10565,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10455
10565
|
* but can be expanded manually.
|
|
10456
10566
|
*
|
|
10457
10567
|
* Supported embed types: `SearchEmbed`
|
|
10458
|
-
* @version
|
|
10568
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10459
10569
|
* @example
|
|
10460
10570
|
* ```js
|
|
10461
10571
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10470,7 +10580,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10470
10580
|
* but can be expanded manually.
|
|
10471
10581
|
*
|
|
10472
10582
|
* Supported embed types: `SearchEmbed`
|
|
10473
|
-
* @version
|
|
10583
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
10474
10584
|
* @example
|
|
10475
10585
|
* ```js
|
|
10476
10586
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10484,7 +10594,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10484
10594
|
* Show or hide the data sources panel.
|
|
10485
10595
|
*
|
|
10486
10596
|
* Supported embed types: `SearchEmbed`
|
|
10487
|
-
* @version
|
|
10597
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
10488
10598
|
* @example
|
|
10489
10599
|
* ```js
|
|
10490
10600
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10500,7 +10610,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10500
10610
|
* using raw answer data.
|
|
10501
10611
|
*
|
|
10502
10612
|
* Supported embed types: `SearchEmbed`
|
|
10503
|
-
* @version
|
|
10613
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
10504
10614
|
* @example
|
|
10505
10615
|
* ```js
|
|
10506
10616
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10529,7 +10639,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10529
10639
|
* format for presenting search data.
|
|
10530
10640
|
*
|
|
10531
10641
|
* Supported embed types: `SearchEmbed`
|
|
10532
|
-
* @version
|
|
10642
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10533
10643
|
* @example
|
|
10534
10644
|
* ```js
|
|
10535
10645
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10542,6 +10652,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10542
10652
|
/**
|
|
10543
10653
|
* The array of data source GUIDs to set on load.
|
|
10544
10654
|
* Only a single data source is supported currently.
|
|
10655
|
+
* Use {@link dataSource} instead.
|
|
10545
10656
|
* @deprecated Use `dataSource` instead.
|
|
10546
10657
|
*
|
|
10547
10658
|
* Supported embed types: `SearchEmbed`
|
|
@@ -10555,10 +10666,10 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10555
10666
|
*/
|
|
10556
10667
|
dataSources?: string[];
|
|
10557
10668
|
/**
|
|
10558
|
-
* The
|
|
10669
|
+
* The data source GUID to set on load.
|
|
10559
10670
|
*
|
|
10560
10671
|
* Supported embed types: `SearchEmbed`
|
|
10561
|
-
* @version
|
|
10672
|
+
* @version SDK: 1.19.0
|
|
10562
10673
|
* @example
|
|
10563
10674
|
* ```js
|
|
10564
10675
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10570,9 +10681,9 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10570
10681
|
dataSource?: string;
|
|
10571
10682
|
/**
|
|
10572
10683
|
* The initial search query to load the answer with.
|
|
10684
|
+
* Use {@link searchOptions} instead.
|
|
10573
10685
|
* @deprecated
|
|
10574
10686
|
*
|
|
10575
|
-
* Use {@link searchOptions} instead.
|
|
10576
10687
|
*/
|
|
10577
10688
|
searchQuery?: string;
|
|
10578
10689
|
/**
|
|
@@ -10601,7 +10712,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10601
10712
|
* If set to true, the search token string is not appended to the URL.
|
|
10602
10713
|
*
|
|
10603
10714
|
* Supported embed types: `SearchEmbed`
|
|
10604
|
-
* @version
|
|
10715
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
10605
10716
|
* @example
|
|
10606
10717
|
* ```js
|
|
10607
10718
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10618,7 +10729,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10618
10729
|
* The GUID of a saved answer to load initially.
|
|
10619
10730
|
*
|
|
10620
10731
|
* Supported embed types: `SearchEmbed`
|
|
10621
|
-
* @version
|
|
10732
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10622
10733
|
* @example
|
|
10623
10734
|
* ```js
|
|
10624
10735
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10647,14 +10758,14 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10647
10758
|
* Flag to set if last selected dataSource should be used
|
|
10648
10759
|
*
|
|
10649
10760
|
* Supported embed types: `SearchEmbed`
|
|
10650
|
-
* @version
|
|
10761
|
+
* @version SDK: 1.24.0
|
|
10651
10762
|
*/
|
|
10652
10763
|
useLastSelectedSources?: boolean;
|
|
10653
10764
|
/**
|
|
10654
10765
|
* To set the initial state of the search bar in case of saved-answers.
|
|
10655
|
-
* @default false
|
|
10656
10766
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10657
10767
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
10768
|
+
* @default false
|
|
10658
10769
|
*/
|
|
10659
10770
|
collapseSearchBarInitially?: boolean;
|
|
10660
10771
|
/**
|
|
@@ -10742,8 +10853,8 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10742
10853
|
* Only a single data source is supported currently.
|
|
10743
10854
|
*
|
|
10744
10855
|
* Supported embed types: `SearchBarEmbed`
|
|
10856
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
10745
10857
|
* @deprecated Use `dataSource` instead
|
|
10746
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
10747
10858
|
* @example
|
|
10748
10859
|
* ```js
|
|
10749
10860
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10757,7 +10868,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10757
10868
|
* Pass the ID of the source to be selected.
|
|
10758
10869
|
*
|
|
10759
10870
|
* Supported embed types: `SearchBarEmbed`
|
|
10760
|
-
* @version
|
|
10871
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
10761
10872
|
* @example
|
|
10762
10873
|
* ```js
|
|
10763
10874
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10771,7 +10882,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10771
10882
|
* Boolean to define if the last selected data source should be used
|
|
10772
10883
|
*
|
|
10773
10884
|
* Supported embed types: `SearchBarEmbed`
|
|
10774
|
-
* @version
|
|
10885
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.0.sw
|
|
10775
10886
|
* @example
|
|
10776
10887
|
* ```js
|
|
10777
10888
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10793,7 +10904,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10793
10904
|
* the token string in the search bar.
|
|
10794
10905
|
*
|
|
10795
10906
|
* Supported embed types: `SearchBarEmbed`
|
|
10796
|
-
* @version
|
|
10907
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
10797
10908
|
* @example
|
|
10798
10909
|
* ```js
|
|
10799
10910
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10811,10 +10922,10 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10811
10922
|
* If set to true, the search token string is not appended to the URL.
|
|
10812
10923
|
*
|
|
10813
10924
|
* Supported embed types: `SearchBarEmbed`
|
|
10814
|
-
* @version
|
|
10925
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
10815
10926
|
* @example
|
|
10816
10927
|
* ```js
|
|
10817
|
-
* const embed = new
|
|
10928
|
+
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
10818
10929
|
* searchOptions: {
|
|
10819
10930
|
* searchTokenString: '[quantity purchased] [region]',
|
|
10820
10931
|
* executeSearch: true,
|
|
@@ -10830,7 +10941,7 @@ interface SearchAppInitData$1 extends DefaultAppInitData {
|
|
|
10830
10941
|
}
|
|
10831
10942
|
/**
|
|
10832
10943
|
* Embed ThoughtSpot search bar
|
|
10833
|
-
* @version
|
|
10944
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
10834
10945
|
* @group Embed components
|
|
10835
10946
|
*/
|
|
10836
10947
|
export declare class SearchBarEmbed extends TsEmbed {
|
|
@@ -10868,8 +10979,8 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, "prima
|
|
|
10868
10979
|
}
|
|
10869
10980
|
/**
|
|
10870
10981
|
* Configuration for conversation options.
|
|
10871
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10872
10982
|
* Use {@link SpotterAgentEmbedViewConfig} instead
|
|
10983
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10873
10984
|
* @group Embed components
|
|
10874
10985
|
*/
|
|
10875
10986
|
export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
|
|
@@ -10892,6 +11003,8 @@ declare class ConversationMessage extends TsEmbed {
|
|
|
10892
11003
|
/**
|
|
10893
11004
|
* Create a conversation embed, which can be integrated inside
|
|
10894
11005
|
* chatbots or other conversational interfaces.
|
|
11006
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
11007
|
+
* @group Embed components
|
|
10895
11008
|
* @example
|
|
10896
11009
|
* ```js
|
|
10897
11010
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -10905,8 +11018,6 @@ declare class ConversationMessage extends TsEmbed {
|
|
|
10905
11018
|
* // append the container to the DOM
|
|
10906
11019
|
* document.body.appendChild(container); // or to any other element
|
|
10907
11020
|
* ```
|
|
10908
|
-
* @group Embed components
|
|
10909
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
10910
11021
|
*/
|
|
10911
11022
|
export declare class SpotterAgentEmbed {
|
|
10912
11023
|
private viewConfig;
|
|
@@ -10944,8 +11055,9 @@ export declare class SpotterAgentEmbed {
|
|
|
10944
11055
|
/**
|
|
10945
11056
|
* Create a conversation embed, which can be integrated inside
|
|
10946
11057
|
* chatbots or other conversational interfaces.
|
|
10947
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10948
11058
|
* Use {@link SpotterAgentEmbed} instead
|
|
11059
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
11060
|
+
* @group Embed components
|
|
10949
11061
|
* @example
|
|
10950
11062
|
* ```js
|
|
10951
11063
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -10959,7 +11071,6 @@ export declare class SpotterAgentEmbed {
|
|
|
10959
11071
|
* // append the container to the DOM
|
|
10960
11072
|
* document.body.appendChild(container); // or to any other element
|
|
10961
11073
|
* ```
|
|
10962
|
-
* @group Embed components
|
|
10963
11074
|
*/
|
|
10964
11075
|
export declare class BodylessConversation extends SpotterAgentEmbed {
|
|
10965
11076
|
constructor(viewConfig: BodylessConversationViewConfig);
|
|
@@ -11004,7 +11115,7 @@ interface SearchOptions$2 {
|
|
|
11004
11115
|
/**
|
|
11005
11116
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
11006
11117
|
* GPT and LLM.
|
|
11007
|
-
* @version
|
|
11118
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
11008
11119
|
*
|
|
11009
11120
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
11010
11121
|
* @group Embed components
|
|
@@ -11058,14 +11169,14 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
11058
11169
|
hideAutocompleteSuggestions?: boolean;
|
|
11059
11170
|
/**
|
|
11060
11171
|
* Show or hide autocomplete suggestions for the search query string.
|
|
11172
|
+
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
11061
11173
|
* @deprecated
|
|
11062
11174
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
11063
|
-
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
11064
11175
|
*/
|
|
11065
11176
|
showObjectSuggestions?: boolean;
|
|
11066
11177
|
/**
|
|
11067
11178
|
* Show or hide sample questions.
|
|
11068
|
-
* The sample questions are autogenerated based on the data
|
|
11179
|
+
* The sample questions are autogenerated based on the data model
|
|
11069
11180
|
* selected for the search operation.
|
|
11070
11181
|
*
|
|
11071
11182
|
* Supported embed types: `SageEmbed`
|
|
@@ -11095,6 +11206,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
11095
11206
|
* the token string in the search bar.
|
|
11096
11207
|
*
|
|
11097
11208
|
* Supported embed types: `SageEmbed`
|
|
11209
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
11098
11210
|
* @example
|
|
11099
11211
|
* ```js
|
|
11100
11212
|
* searchOptions: {
|
|
@@ -11102,13 +11214,12 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
11102
11214
|
* executeSearch: true,
|
|
11103
11215
|
* }
|
|
11104
11216
|
* ```
|
|
11105
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
11106
11217
|
*/
|
|
11107
11218
|
searchOptions?: SearchOptions$2;
|
|
11108
11219
|
}
|
|
11109
11220
|
/**
|
|
11110
11221
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
11111
|
-
* @version
|
|
11222
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
11112
11223
|
*
|
|
11113
11224
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
11114
11225
|
* @group Embed components
|
|
@@ -11223,7 +11334,7 @@ export declare function uploadMixpanelEvent(eventId: string, eventProps?: {}): v
|
|
|
11223
11334
|
* tokenizedFetch("<TS_ORIGIN>/api/rest/2.0/auth/session/user", {
|
|
11224
11335
|
* // .. fetch options ..
|
|
11225
11336
|
* });
|
|
11226
|
-
|
|
11337
|
+
* ```
|
|
11227
11338
|
* @version SDK: 1.28.0
|
|
11228
11339
|
* @group Global methods
|
|
11229
11340
|
*/
|