@thoughtspot/visual-embed-sdk 1.46.0 → 1.46.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/cjs/package.json +2 -2
- package/cjs/src/auth.d.ts +29 -4
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +30 -5
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/css-variables.d.ts +17 -17
- package/cjs/src/embed/app.d.ts +61 -33
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +11 -4
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +34 -1
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +2 -2
- package/cjs/src/embed/base.js +2 -2
- package/cjs/src/embed/bodyless-conversation.d.ts +5 -5
- package/cjs/src/embed/bodyless-conversation.js +4 -4
- package/cjs/src/embed/conversation.d.ts +43 -30
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +10 -11
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +27 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +42 -36
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +3 -3
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +1 -1
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +5 -5
- package/cjs/src/embed/sage.js +1 -1
- package/cjs/src/embed/search-bar.d.ts +7 -7
- package/cjs/src/embed/search-bar.js +1 -1
- package/cjs/src/embed/search.d.ts +16 -14
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +3 -2
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +4 -4
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +13 -7
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +35 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/react/index.d.ts +15 -15
- package/cjs/src/react/index.js +12 -12
- package/cjs/src/tokenizedFetch.d.ts +1 -1
- package/cjs/src/tokenizedFetch.js +1 -1
- package/cjs/src/types.d.ts +653 -276
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +274 -208
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +6 -4
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +55 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils.d.ts +9 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +10 -1
- package/cjs/src/utils.js.map +1 -1
- package/dist/{index-BQvLEoxp.js → index-DkizS4xM.js} +1 -1
- package/dist/src/auth.d.ts +29 -4
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/css-variables.d.ts +17 -17
- package/dist/src/embed/app.d.ts +61 -33
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +2 -2
- package/dist/src/embed/bodyless-conversation.d.ts +5 -5
- package/dist/src/embed/conversation.d.ts +43 -30
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +42 -36
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +5 -5
- package/dist/src/embed/search-bar.d.ts +7 -7
- package/dist/src/embed/search.d.ts +16 -14
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +4 -4
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +15 -15
- package/dist/src/tokenizedFetch.d.ts +1 -1
- package/dist/src/types.d.ts +653 -276
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils.d.ts +9 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +383 -290
- package/dist/tsembed-react.js +382 -289
- package/dist/tsembed.es.js +375 -282
- package/dist/tsembed.js +374 -281
- package/dist/visual-embed-sdk-react-full.d.ts +880 -431
- package/dist/visual-embed-sdk-react.d.ts +873 -427
- package/dist/visual-embed-sdk.d.ts +879 -430
- package/lib/package.json +2 -2
- package/lib/src/auth.d.ts +29 -4
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +30 -5
- package/lib/src/auth.js.map +1 -1
- package/lib/src/css-variables.d.ts +17 -17
- package/lib/src/embed/app.d.ts +61 -33
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +12 -5
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +34 -1
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +2 -2
- package/lib/src/embed/base.js +2 -2
- package/lib/src/embed/bodyless-conversation.d.ts +5 -5
- package/lib/src/embed/bodyless-conversation.js +4 -4
- package/lib/src/embed/conversation.d.ts +43 -30
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +11 -11
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +27 -0
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +42 -36
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +3 -3
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +1 -1
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +5 -5
- package/lib/src/embed/sage.js +1 -1
- package/lib/src/embed/search-bar.d.ts +7 -7
- package/lib/src/embed/search-bar.js +1 -1
- package/lib/src/embed/search.d.ts +16 -14
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +3 -2
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +4 -4
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +13 -7
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +35 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/react/index.d.ts +15 -15
- package/lib/src/react/index.js +12 -12
- package/lib/src/tokenizedFetch.d.ts +1 -1
- package/lib/src/tokenizedFetch.js +1 -1
- package/lib/src/types.d.ts +653 -276
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +274 -208
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +5 -3
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +55 -0
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils.d.ts +9 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +8 -0
- package/lib/src/utils.js.map +1 -1
- package/package.json +2 -2
- package/src/auth.ts +30 -5
- package/src/css-variables.ts +17 -17
- package/src/embed/app.spec.ts +46 -1
- package/src/embed/app.ts +73 -36
- package/src/embed/base.ts +2 -2
- package/src/embed/bodyless-conversation.ts +5 -5
- package/src/embed/conversation.spec.ts +37 -0
- package/src/embed/conversation.ts +55 -38
- package/src/embed/liveboard.spec.ts +1 -1
- package/src/embed/liveboard.ts +42 -36
- package/src/embed/sage.ts +5 -5
- package/src/embed/search-bar.tsx +7 -7
- package/src/embed/search.ts +16 -14
- package/src/embed/ts-embed.spec.ts +42 -0
- package/src/embed/ts-embed.ts +12 -7
- package/src/react/index.tsx +15 -15
- package/src/tokenizedFetch.ts +1 -1
- package/src/types.ts +652 -275
- package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
- package/src/utils/graphql/answerService/answerService.ts +6 -3
- package/src/utils.ts +14 -0
|
@@ -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({
|
|
@@ -1600,18 +1603,154 @@ export interface EmbedConfig {
|
|
|
1600
1603
|
* @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
|
|
1601
1604
|
* @example
|
|
1602
1605
|
* ```js
|
|
1603
|
-
* import {
|
|
1606
|
+
* import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
|
|
1604
1607
|
* init({
|
|
1605
1608
|
* ... // other embed config options
|
|
1606
1609
|
* customActions: [
|
|
1607
1610
|
* {
|
|
1608
|
-
*
|
|
1609
|
-
* id: '
|
|
1611
|
+
* // Unique identifier for the custom action
|
|
1612
|
+
* id: 'my-custom-action',
|
|
1613
|
+
*
|
|
1614
|
+
* // Display name shown to users in the UI
|
|
1615
|
+
* name: 'My Custom Action',
|
|
1616
|
+
*
|
|
1617
|
+
* // Where the action appears in the UI
|
|
1618
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
1619
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
1620
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
1621
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
1622
|
+
*
|
|
1623
|
+
* // What type of content this action applies to
|
|
1624
|
+
* // ANSWER: Available on answer pages
|
|
1625
|
+
* target: CustomActionTarget.ANSWER,
|
|
1626
|
+
*
|
|
1627
|
+
* // Optional: Restrict where this action appears based on data models
|
|
1628
|
+
* // dataModelIds: {
|
|
1629
|
+
* // // Restrict to specific data models
|
|
1630
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
1631
|
+
* // // Restrict to specific columns within models
|
|
1632
|
+
* // modelColumnNames: ['model-id::column-name']
|
|
1633
|
+
* // },
|
|
1634
|
+
*
|
|
1635
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
1636
|
+
* // metadataIds: {
|
|
1637
|
+
* // // Restrict to specific answers
|
|
1638
|
+
* // answerIds: ['answer-id-1', 'answer-id-2'],
|
|
1639
|
+
* // },
|
|
1640
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
1641
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
1642
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
1643
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
1644
|
+
* }
|
|
1645
|
+
* ],
|
|
1646
|
+
* })
|
|
1647
|
+
* ```
|
|
1648
|
+
* @example
|
|
1649
|
+
* ```js
|
|
1650
|
+
* import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
|
|
1651
|
+
* init({
|
|
1652
|
+
* ... // other embed config options
|
|
1653
|
+
* customActions: [
|
|
1654
|
+
* {
|
|
1655
|
+
* // Unique identifier for the custom action
|
|
1656
|
+
* id: 'my-custom-action',
|
|
1657
|
+
*
|
|
1658
|
+
* // Display name shown to users in the UI
|
|
1659
|
+
* name: 'My Custom Action',
|
|
1660
|
+
*
|
|
1661
|
+
* // Where the action appears in the UI
|
|
1662
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
1663
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
1664
|
+
* position: CustomActionsPosition.MENU,
|
|
1665
|
+
*
|
|
1666
|
+
* // What type of content this action applies to
|
|
1667
|
+
* // SPOTTER: Available in Spotter (AI-powered search)
|
|
1668
|
+
* target: CustomActionTarget.SPOTTER,
|
|
1669
|
+
*
|
|
1670
|
+
* // Optional: Restrict where this action appears based on data models
|
|
1671
|
+
* // dataModelIds: {
|
|
1672
|
+
* // // Restrict to specific data models
|
|
1673
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
1674
|
+
* // },
|
|
1675
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
1676
|
+
* // groupIds: ['group-id-1'],
|
|
1677
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
1678
|
+
* // orgIds: ['org-id-1'],
|
|
1679
|
+
* }
|
|
1680
|
+
* ],
|
|
1681
|
+
* })
|
|
1682
|
+
* ```
|
|
1683
|
+
* @example
|
|
1684
|
+
* ```js
|
|
1685
|
+
* import { CustomActionsPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
|
|
1686
|
+
* init({
|
|
1687
|
+
* ... // other embed config options
|
|
1688
|
+
* customActions: [
|
|
1689
|
+
* {
|
|
1690
|
+
* // Unique identifier for the custom action
|
|
1691
|
+
* id: 'my-liveboard-custom-action',
|
|
1692
|
+
*
|
|
1693
|
+
* // Display name shown to users in the UI
|
|
1694
|
+
* name: 'My Liveboard Custom Action',
|
|
1695
|
+
*
|
|
1696
|
+
* // Where the action appears in the UI
|
|
1697
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
1698
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
1699
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
1700
|
+
*
|
|
1701
|
+
* // What type of content this action applies to
|
|
1702
|
+
* // LIVEBOARD: Available on liveboard pages
|
|
1703
|
+
* target: CustomActionTarget.LIVEBOARD,
|
|
1704
|
+
*
|
|
1705
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
1706
|
+
* // metadataIds: {
|
|
1707
|
+
* // // Restrict to specific liveboards
|
|
1708
|
+
* // liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
|
|
1709
|
+
* // },
|
|
1710
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
1711
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
1712
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
1713
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
1714
|
+
* },
|
|
1715
|
+
* {
|
|
1716
|
+
* // Unique identifier for the custom action
|
|
1717
|
+
* id: 'my-viz-custom-action',
|
|
1718
|
+
*
|
|
1719
|
+
* // Display name shown to users in the UI
|
|
1720
|
+
* name: 'My Viz Custom Action',
|
|
1721
|
+
*
|
|
1722
|
+
* // Where the action appears in the UI
|
|
1723
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
1724
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
1725
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
1726
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
1727
|
+
*
|
|
1728
|
+
* // What type of content this action applies to
|
|
1729
|
+
* // VIZ: Available on individual visualizations
|
|
1610
1730
|
* target: CustomActionTarget.VIZ,
|
|
1611
|
-
*
|
|
1612
|
-
*
|
|
1731
|
+
*
|
|
1732
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
1733
|
+
* // metadataIds: {
|
|
1734
|
+
* // // Restrict to specific answers
|
|
1735
|
+
* // answerIds: ['answer-id-1', 'answer-id-2'],
|
|
1736
|
+
* // // Restrict to specific liveboard. If liveboardId is
|
|
1737
|
+
* // // passed, custom actions will appear on all vizzes of liveboard
|
|
1738
|
+
* // liveboardIds: ['liveboard-id-1'],
|
|
1739
|
+
* // // Restrict to specific vizIds
|
|
1740
|
+
* // vizIds: ['viz-id-1']
|
|
1741
|
+
* // },
|
|
1742
|
+
* // dataModelIds: {
|
|
1743
|
+
* // // Restrict to specific data models
|
|
1744
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
1745
|
+
* // // Restrict to specific columns within models
|
|
1746
|
+
* // modelColumnNames: ['model-id::column-name']
|
|
1747
|
+
* // },
|
|
1748
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
1749
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
1750
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
1751
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
1613
1752
|
* }
|
|
1614
|
-
* ]
|
|
1753
|
+
* ],
|
|
1615
1754
|
* })
|
|
1616
1755
|
* ```
|
|
1617
1756
|
*/
|
|
@@ -1651,7 +1790,7 @@ export interface FrameParams {
|
|
|
1651
1790
|
*/
|
|
1652
1791
|
loading?: "lazy" | "eager" | "auto";
|
|
1653
1792
|
/**
|
|
1654
|
-
*
|
|
1793
|
+
* These parameters will be passed to the iframe
|
|
1655
1794
|
* as is.
|
|
1656
1795
|
*/
|
|
1657
1796
|
[key: string]: string | number | boolean | undefined;
|
|
@@ -1726,8 +1865,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1726
1865
|
*/
|
|
1727
1866
|
disabledActionReason?: string;
|
|
1728
1867
|
/**
|
|
1729
|
-
* The list of actions to hide from the embedded.
|
|
1730
|
-
*
|
|
1868
|
+
* The list of actions to hide from the embedded view.
|
|
1869
|
+
* These actions will be hidden from the user.
|
|
1731
1870
|
* Use this to hide an action.
|
|
1732
1871
|
*
|
|
1733
1872
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
@@ -1768,7 +1907,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1768
1907
|
* The locale settings to apply to the embedded view.
|
|
1769
1908
|
*
|
|
1770
1909
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1771
|
-
* @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
|
|
1772
1911
|
* @example
|
|
1773
1912
|
* ```js
|
|
1774
1913
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1783,12 +1922,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1783
1922
|
* This is an object (key/val) of override flags which will be applied
|
|
1784
1923
|
* to the internal embedded object. This can be used to add any
|
|
1785
1924
|
* URL flag.
|
|
1786
|
-
* 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.
|
|
1787
1926
|
* Warning: This option is for advanced use only and is used internally
|
|
1788
1927
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1789
1928
|
* list of supported keys and values associated with each.
|
|
1790
1929
|
*
|
|
1791
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
|
|
1792
1932
|
* @example
|
|
1793
1933
|
* ```js
|
|
1794
1934
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1800,7 +1940,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1800
1940
|
* },
|
|
1801
1941
|
* });
|
|
1802
1942
|
* ```
|
|
1803
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1804
1943
|
*/
|
|
1805
1944
|
additionalFlags?: {
|
|
1806
1945
|
[key: string]: string | number | boolean;
|
|
@@ -1843,6 +1982,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1843
1982
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1844
1983
|
*
|
|
1845
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
|
|
1846
1986
|
* @example
|
|
1847
1987
|
* ```js
|
|
1848
1988
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1852,7 +1992,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1852
1992
|
* });
|
|
1853
1993
|
* embed.showPreRender();
|
|
1854
1994
|
* ```
|
|
1855
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1856
1995
|
*/
|
|
1857
1996
|
preRenderId?: string;
|
|
1858
1997
|
/**
|
|
@@ -1862,7 +2001,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1862
2001
|
* its dimensions based on changes to the size of the embedding element.
|
|
1863
2002
|
* @type {boolean}
|
|
1864
2003
|
* @default false
|
|
1865
|
-
* @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
|
|
1866
2005
|
* @example
|
|
1867
2006
|
* ```js
|
|
1868
2007
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -1877,9 +2016,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1877
2016
|
doNotTrackPreRenderSize?: boolean;
|
|
1878
2017
|
/**
|
|
1879
2018
|
* Enable the V2 shell. This can provide performance benefits
|
|
1880
|
-
* due to a
|
|
2019
|
+
* due to a lighter-weight shell.
|
|
1881
2020
|
*
|
|
1882
2021
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2022
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1883
2023
|
* @example
|
|
1884
2024
|
* ```js
|
|
1885
2025
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1888,7 +2028,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1888
2028
|
* enableV2Shell_experimental: true,
|
|
1889
2029
|
* });
|
|
1890
2030
|
* ```
|
|
1891
|
-
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1892
2031
|
*/
|
|
1893
2032
|
enableV2Shell_experimental?: boolean;
|
|
1894
2033
|
/**
|
|
@@ -1907,6 +2046,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1907
2046
|
* and disable redirection of links in a new tab.
|
|
1908
2047
|
*
|
|
1909
2048
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2049
|
+
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1910
2050
|
* @example
|
|
1911
2051
|
* ```js
|
|
1912
2052
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1915,7 +2055,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1915
2055
|
* disableRedirectionLinksInNewTab: true,
|
|
1916
2056
|
* });
|
|
1917
2057
|
* ```
|
|
1918
|
-
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1919
2058
|
*/
|
|
1920
2059
|
disableRedirectionLinksInNewTab?: boolean;
|
|
1921
2060
|
/**
|
|
@@ -1926,6 +2065,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1926
2065
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
1927
2066
|
*
|
|
1928
2067
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2068
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
1929
2069
|
* @example
|
|
1930
2070
|
* ```js
|
|
1931
2071
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1934,24 +2074,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1934
2074
|
* overrideOrgId: 142536,
|
|
1935
2075
|
* });
|
|
1936
2076
|
* ```
|
|
1937
|
-
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
1938
2077
|
*/
|
|
1939
2078
|
overrideOrgId?: number;
|
|
1940
2079
|
/**
|
|
1941
|
-
* Flag to override the *Open Link in New Tab* context
|
|
2080
|
+
* Flag to override the *Open Link in New Tab* context
|
|
2081
|
+
* menu option.
|
|
1942
2082
|
*
|
|
1943
|
-
*
|
|
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`
|
|
1944
2089
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1945
2090
|
* @example
|
|
1946
2091
|
* ```js
|
|
1947
|
-
*
|
|
1948
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2092
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1949
2093
|
* ... // other embed view config
|
|
1950
|
-
* linkOverride:
|
|
2094
|
+
* linkOverride: true,
|
|
1951
2095
|
* })
|
|
1952
2096
|
* ```
|
|
1953
2097
|
*/
|
|
1954
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;
|
|
1955
2127
|
/**
|
|
1956
2128
|
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
1957
2129
|
* Use this to set the primary action.
|
|
@@ -1976,7 +2148,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1976
2148
|
insertInToSlide?: boolean;
|
|
1977
2149
|
/**
|
|
1978
2150
|
* Show alert messages and toast messages in the embed.
|
|
1979
|
-
* Supported
|
|
2151
|
+
* Supported in all embed types.
|
|
1980
2152
|
*
|
|
1981
2153
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1982
2154
|
* @example
|
|
@@ -2001,7 +2173,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2001
2173
|
* ```ts
|
|
2002
2174
|
* import {
|
|
2003
2175
|
* CustomActionPayload,
|
|
2004
|
-
*
|
|
2176
|
+
* CustomActionsPosition,
|
|
2005
2177
|
* CustomActionTarget,
|
|
2006
2178
|
* } from '@thoughtspot/visual-embed-sdk';
|
|
2007
2179
|
* // Use supported embed types such as AppEmbed or LiveboardEmbed
|
|
@@ -2009,13 +2181,41 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2009
2181
|
* ... // other embed config options
|
|
2010
2182
|
* customActions: [
|
|
2011
2183
|
* {
|
|
2012
|
-
*
|
|
2013
|
-
* id: '
|
|
2014
|
-
*
|
|
2015
|
-
*
|
|
2016
|
-
*
|
|
2184
|
+
* // Unique identifier for the custom action
|
|
2185
|
+
* id: 'my-custom-action',
|
|
2186
|
+
*
|
|
2187
|
+
* // Display name shown to users in the UI
|
|
2188
|
+
* name: 'My Custom Action',
|
|
2189
|
+
*
|
|
2190
|
+
* // Where the action appears in the UI
|
|
2191
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
2192
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
2193
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
2194
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
2195
|
+
*
|
|
2196
|
+
* // What type of content this action applies to
|
|
2197
|
+
* // ANSWER: Available on answer pages
|
|
2198
|
+
* target: CustomActionTarget.ANSWER,
|
|
2199
|
+
*
|
|
2200
|
+
* // Optional: Restrict where this action appears based on data models
|
|
2201
|
+
* // dataModelIds: {
|
|
2202
|
+
* // // Restrict to specific data models
|
|
2203
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
2204
|
+
* // // Restrict to specific columns within models
|
|
2205
|
+
* // modelColumnNames: ['model-id::column-name']
|
|
2206
|
+
* // },
|
|
2207
|
+
*
|
|
2208
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
2209
|
+
* // metadataIds: {
|
|
2210
|
+
* // // Restrict to specific answers
|
|
2211
|
+
* // answerIds: ['answer-id-1', 'answer-id-2'],
|
|
2212
|
+
* // },
|
|
2213
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
2214
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
2215
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
2216
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
2017
2217
|
* }
|
|
2018
|
-
* ]
|
|
2218
|
+
* ],
|
|
2019
2219
|
* })
|
|
2020
2220
|
*
|
|
2021
2221
|
* // to trigger a custom flow on custom action click listen to Custom action embed event
|
|
@@ -2023,6 +2223,120 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2023
2223
|
* console.log('Custom Action event:', payload);
|
|
2024
2224
|
* })
|
|
2025
2225
|
* ```
|
|
2226
|
+
* @example
|
|
2227
|
+
* ```ts
|
|
2228
|
+
* import {
|
|
2229
|
+
* CustomActionsPosition,
|
|
2230
|
+
* CustomActionTarget,
|
|
2231
|
+
* } from '@thoughtspot/visual-embed-sdk';
|
|
2232
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2233
|
+
* ... // other embed config options
|
|
2234
|
+
* customActions: [
|
|
2235
|
+
* {
|
|
2236
|
+
* // Unique identifier for the custom action
|
|
2237
|
+
* id: 'my-custom-action',
|
|
2238
|
+
*
|
|
2239
|
+
* // Display name shown to users in the UI
|
|
2240
|
+
* name: 'My Custom Action',
|
|
2241
|
+
*
|
|
2242
|
+
* // Where the action appears in the UI
|
|
2243
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
2244
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
2245
|
+
* position: CustomActionsPosition.MENU,
|
|
2246
|
+
*
|
|
2247
|
+
* // What type of content this action applies to
|
|
2248
|
+
* // SPOTTER: Available in Spotter (AI-powered search)
|
|
2249
|
+
* target: CustomActionTarget.SPOTTER,
|
|
2250
|
+
*
|
|
2251
|
+
* // Optional: Restrict where this action appears based on data models
|
|
2252
|
+
* // dataModelIds: {
|
|
2253
|
+
* // // Restrict to specific data models
|
|
2254
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
2255
|
+
* // },
|
|
2256
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
2257
|
+
* // groupIds: ['group-id-1'],
|
|
2258
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
2259
|
+
* // orgIds: ['org-id-1'],
|
|
2260
|
+
* }
|
|
2261
|
+
* ],
|
|
2262
|
+
* })
|
|
2263
|
+
* ```
|
|
2264
|
+
* @example
|
|
2265
|
+
* ```ts
|
|
2266
|
+
* import {
|
|
2267
|
+
* CustomActionsPosition,
|
|
2268
|
+
* CustomActionTarget,
|
|
2269
|
+
* } from '@thoughtspot/visual-embed-sdk';
|
|
2270
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2271
|
+
* ... // other embed config options
|
|
2272
|
+
* customActions: [
|
|
2273
|
+
* {
|
|
2274
|
+
* // Unique identifier for the custom action
|
|
2275
|
+
* id: 'my-liveboard-custom-action',
|
|
2276
|
+
*
|
|
2277
|
+
* // Display name shown to users in the UI
|
|
2278
|
+
* name: 'My Liveboard Custom Action',
|
|
2279
|
+
*
|
|
2280
|
+
* // Where the action appears in the UI
|
|
2281
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
2282
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
2283
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
2284
|
+
*
|
|
2285
|
+
* // What type of content this action applies to
|
|
2286
|
+
* // LIVEBOARD: Available on liveboard pages
|
|
2287
|
+
* target: CustomActionTarget.LIVEBOARD,
|
|
2288
|
+
*
|
|
2289
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
2290
|
+
* // metadataIds: {
|
|
2291
|
+
* // // Restrict to specific liveboards
|
|
2292
|
+
* // liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
|
|
2293
|
+
* // },
|
|
2294
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
2295
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
2296
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
2297
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
2298
|
+
* },
|
|
2299
|
+
* {
|
|
2300
|
+
* // Unique identifier for the custom action
|
|
2301
|
+
* id: 'my-viz-custom-action',
|
|
2302
|
+
*
|
|
2303
|
+
* // Display name shown to users in the UI
|
|
2304
|
+
* name: 'My Viz Custom Action',
|
|
2305
|
+
*
|
|
2306
|
+
* // Where the action appears in the UI
|
|
2307
|
+
* // PRIMARY: Shows as a primary button (e.g., in the toolbar)
|
|
2308
|
+
* // MENU: Shows in the "More" menu (three dots menu)
|
|
2309
|
+
* // CONTEXTMENU: Shows in the right-click context menu
|
|
2310
|
+
* position: CustomActionsPosition.PRIMARY,
|
|
2311
|
+
*
|
|
2312
|
+
* // What type of content this action applies to
|
|
2313
|
+
* // VIZ: Available on individual visualizations
|
|
2314
|
+
* target: CustomActionTarget.VIZ,
|
|
2315
|
+
*
|
|
2316
|
+
* // Optional: Restrict where this action appears based on metadata
|
|
2317
|
+
* // metadataIds: {
|
|
2318
|
+
* // // Restrict to specific answers
|
|
2319
|
+
* // answerIds: ['answer-id-1', 'answer-id-2'],
|
|
2320
|
+
* // // Restrict to specific liveboard. If liveboardId is
|
|
2321
|
+
* // // passed, custom actions will appear on all vizzes of liveboard
|
|
2322
|
+
* // liveboardIds: ['liveboard-id-1'],
|
|
2323
|
+
* // // Restrict to specific vizIds
|
|
2324
|
+
* // vizIds: ['viz-id-1']
|
|
2325
|
+
* // },
|
|
2326
|
+
* // dataModelIds: {
|
|
2327
|
+
* // // Restrict to specific data models
|
|
2328
|
+
* // modelIds: ['model-id-1', 'model-id-2'],
|
|
2329
|
+
* // // Restrict to specific columns within models
|
|
2330
|
+
* // modelColumnNames: ['model-id::column-name']
|
|
2331
|
+
* // },
|
|
2332
|
+
* // // Restrict to specific groups (for group-based access control)
|
|
2333
|
+
* // groupIds: ['group-id-1', 'group-id-2'],
|
|
2334
|
+
* // // Restrict to specific organizations (for multi-org deployments)
|
|
2335
|
+
* // orgIds: ['org-id-1', 'org-id-2'],
|
|
2336
|
+
* }
|
|
2337
|
+
* ],
|
|
2338
|
+
* })
|
|
2339
|
+
* ```
|
|
2026
2340
|
*/
|
|
2027
2341
|
customActions?: CustomAction[];
|
|
2028
2342
|
/**
|
|
@@ -2118,7 +2432,7 @@ export interface HomePageConfig {
|
|
|
2118
2432
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
2119
2433
|
*
|
|
2120
2434
|
* Supported embed types: `AppEmbed`
|
|
2121
|
-
* @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
|
|
2122
2436
|
* @example
|
|
2123
2437
|
* ```js
|
|
2124
2438
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2139,6 +2453,7 @@ export interface HomePageConfig {
|
|
|
2139
2453
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
2140
2454
|
*
|
|
2141
2455
|
* Supported embed types: `AppEmbed`
|
|
2456
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2142
2457
|
* @example
|
|
2143
2458
|
* ```js
|
|
2144
2459
|
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2149,7 +2464,6 @@ export interface HomePageConfig {
|
|
|
2149
2464
|
* ... //other embed view configuration attributes
|
|
2150
2465
|
* })
|
|
2151
2466
|
* ```
|
|
2152
|
-
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2153
2467
|
*/
|
|
2154
2468
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2155
2469
|
}
|
|
@@ -2162,7 +2476,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2162
2476
|
* visualization, or Liveboard.
|
|
2163
2477
|
*
|
|
2164
2478
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2165
|
-
* @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
|
|
2166
2480
|
* @example
|
|
2167
2481
|
* ```js
|
|
2168
2482
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2180,11 +2494,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2180
2494
|
*/
|
|
2181
2495
|
runtimeFilters?: RuntimeFilter[];
|
|
2182
2496
|
/**
|
|
2183
|
-
* The list of parameter
|
|
2497
|
+
* The list of parameter overrides to apply to a search Answer,
|
|
2184
2498
|
* visualization, or Liveboard.
|
|
2185
2499
|
*
|
|
2186
2500
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2187
|
-
* @version SDK
|
|
2501
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2188
2502
|
* @example
|
|
2189
2503
|
* ```js
|
|
2190
2504
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2204,6 +2518,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2204
2518
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2205
2519
|
*
|
|
2206
2520
|
* Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
|
|
2521
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2207
2522
|
* @example
|
|
2208
2523
|
* ```js
|
|
2209
2524
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
|
|
@@ -2212,7 +2527,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2212
2527
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
2213
2528
|
* })
|
|
2214
2529
|
* ```
|
|
2215
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2216
2530
|
*/
|
|
2217
2531
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2218
2532
|
/**
|
|
@@ -2235,7 +2549,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2235
2549
|
* when set to false, runtime parameters will be included in the URL
|
|
2236
2550
|
* (default behavior before SDK 1.45.0).
|
|
2237
2551
|
*
|
|
2238
|
-
* Irrespective of this flag, runtime
|
|
2552
|
+
* Irrespective of this flag, runtime parameters (if passed) will be applied to the
|
|
2239
2553
|
* embedded view.
|
|
2240
2554
|
* @default true
|
|
2241
2555
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
@@ -2254,14 +2568,15 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2254
2568
|
* ... // other embed view config
|
|
2255
2569
|
* collapseSearchBar: true,
|
|
2256
2570
|
* });
|
|
2571
|
+
* ```
|
|
2257
2572
|
*/
|
|
2258
2573
|
collapseSearchBar?: boolean;
|
|
2259
2574
|
/**
|
|
2260
2575
|
* Flag to control Data panel experience
|
|
2261
2576
|
*
|
|
2262
2577
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2578
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2263
2579
|
* @default true
|
|
2264
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2265
2580
|
* @example
|
|
2266
2581
|
* ```js
|
|
2267
2582
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -2294,6 +2609,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2294
2609
|
* the current time period in filter results.
|
|
2295
2610
|
*
|
|
2296
2611
|
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2612
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2297
2613
|
* @example
|
|
2298
2614
|
* ```js
|
|
2299
2615
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
@@ -2301,7 +2617,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2301
2617
|
* isThisPeriodInDateFiltersEnabled: true,
|
|
2302
2618
|
* })
|
|
2303
2619
|
* ```
|
|
2304
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2305
2620
|
*/
|
|
2306
2621
|
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
2307
2622
|
}
|
|
@@ -2361,6 +2676,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2361
2676
|
* Boolean to control if Liveboard header is sticky or not.
|
|
2362
2677
|
*
|
|
2363
2678
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2679
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2364
2680
|
* @example
|
|
2365
2681
|
* ```js
|
|
2366
2682
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2369,7 +2685,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2369
2685
|
* isLiveboardHeaderSticky: true,
|
|
2370
2686
|
* });
|
|
2371
2687
|
* ```
|
|
2372
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2373
2688
|
*/
|
|
2374
2689
|
isLiveboardHeaderSticky?: boolean;
|
|
2375
2690
|
/**
|
|
@@ -2377,8 +2692,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2377
2692
|
*
|
|
2378
2693
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2379
2694
|
* @type {boolean}
|
|
2695
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
|
|
2380
2696
|
* @default false
|
|
2381
|
-
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
2382
2697
|
* @example
|
|
2383
2698
|
* ```js
|
|
2384
2699
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2394,8 +2709,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2394
2709
|
*
|
|
2395
2710
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2396
2711
|
* @type {boolean}
|
|
2712
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
|
|
2397
2713
|
* @default false
|
|
2398
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
|
|
2399
2714
|
* @example
|
|
2400
2715
|
* ```js
|
|
2401
2716
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2411,7 +2726,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2411
2726
|
* header.
|
|
2412
2727
|
*
|
|
2413
2728
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2414
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2729
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2415
2730
|
* @default true
|
|
2416
2731
|
* @example
|
|
2417
2732
|
* ```js
|
|
@@ -2429,7 +2744,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2429
2744
|
* **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
|
|
2430
2745
|
*
|
|
2431
2746
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2432
|
-
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
2747
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2433
2748
|
* @default false
|
|
2434
2749
|
* @example
|
|
2435
2750
|
* ```js
|
|
@@ -2447,7 +2762,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2447
2762
|
* compact header
|
|
2448
2763
|
*
|
|
2449
2764
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2450
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2765
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2451
2766
|
* @default true
|
|
2452
2767
|
* @example
|
|
2453
2768
|
* ```js
|
|
@@ -2480,7 +2795,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2480
2795
|
* the cover and filters pages in the Liveboard PDF.
|
|
2481
2796
|
*
|
|
2482
2797
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2483
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
2798
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
|
|
2484
2799
|
* @example
|
|
2485
2800
|
* ```js
|
|
2486
2801
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2684,7 +2999,7 @@ export declare enum HomepageModule {
|
|
|
2684
2999
|
*/
|
|
2685
3000
|
Search = "SEARCH",
|
|
2686
3001
|
/**
|
|
2687
|
-
*
|
|
3002
|
+
* KPI watchlist module
|
|
2688
3003
|
*/
|
|
2689
3004
|
Watchlist = "WATCHLIST",
|
|
2690
3005
|
/**
|
|
@@ -2715,7 +3030,8 @@ export declare enum ListPageColumns {
|
|
|
2715
3030
|
*/
|
|
2716
3031
|
Favorites = "FAVOURITE",
|
|
2717
3032
|
/**
|
|
2718
|
-
*
|
|
3033
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
3034
|
+
* @deprecated This option is deprecated.
|
|
2719
3035
|
*/
|
|
2720
3036
|
Favourite = "FAVOURITE",
|
|
2721
3037
|
/**
|
|
@@ -2816,13 +3132,13 @@ export declare enum EmbedEvent {
|
|
|
2816
3132
|
/**
|
|
2817
3133
|
* Rendering has initialized.
|
|
2818
3134
|
* @example
|
|
2819
|
-
|
|
3135
|
+
* ```js
|
|
2820
3136
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
2821
3137
|
* //show a loader
|
|
2822
3138
|
* function showLoader() {
|
|
2823
3139
|
* document.getElementById("loader");
|
|
2824
3140
|
* }
|
|
2825
|
-
|
|
3141
|
+
* ```
|
|
2826
3142
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2827
3143
|
*/
|
|
2828
3144
|
Init = "init",
|
|
@@ -2830,11 +3146,11 @@ export declare enum EmbedEvent {
|
|
|
2830
3146
|
* Authentication has either succeeded or failed.
|
|
2831
3147
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2832
3148
|
* @example
|
|
2833
|
-
|
|
3149
|
+
* ```js
|
|
2834
3150
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
2835
3151
|
* console.log('AuthInit', payload);
|
|
2836
3152
|
* })
|
|
2837
|
-
|
|
3153
|
+
* ```
|
|
2838
3154
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
2839
3155
|
*/
|
|
2840
3156
|
AuthInit = "authInit",
|
|
@@ -2843,13 +3159,13 @@ export declare enum EmbedEvent {
|
|
|
2843
3159
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2844
3160
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2845
3161
|
* @example
|
|
2846
|
-
|
|
3162
|
+
* ```js
|
|
2847
3163
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
2848
3164
|
* //hide loader
|
|
2849
3165
|
* function hideLoader() {
|
|
2850
3166
|
* document.getElementById("loader");
|
|
2851
3167
|
* }
|
|
2852
|
-
|
|
3168
|
+
* ```
|
|
2853
3169
|
*/
|
|
2854
3170
|
Load = "load",
|
|
2855
3171
|
/**
|
|
@@ -2858,11 +3174,11 @@ export declare enum EmbedEvent {
|
|
|
2858
3174
|
* @return data - Answer of Liveboard data
|
|
2859
3175
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2860
3176
|
* @example
|
|
2861
|
-
|
|
3177
|
+
* ```js
|
|
2862
3178
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
2863
3179
|
* console.log('data', payload);
|
|
2864
3180
|
* })
|
|
2865
|
-
|
|
3181
|
+
* ```
|
|
2866
3182
|
* @important
|
|
2867
3183
|
*/
|
|
2868
3184
|
Data = "data",
|
|
@@ -2870,9 +3186,9 @@ export declare enum EmbedEvent {
|
|
|
2870
3186
|
* Search query has been updated by the user.
|
|
2871
3187
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2872
3188
|
* @example
|
|
2873
|
-
|
|
3189
|
+
* ```js
|
|
2874
3190
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
2875
|
-
|
|
3191
|
+
* ```
|
|
2876
3192
|
*/
|
|
2877
3193
|
QueryChanged = "queryChanged",
|
|
2878
3194
|
/**
|
|
@@ -2882,7 +3198,7 @@ export declare enum EmbedEvent {
|
|
|
2882
3198
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2883
3199
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
2884
3200
|
* @example
|
|
2885
|
-
|
|
3201
|
+
* ```js
|
|
2886
3202
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
2887
3203
|
* points: {
|
|
2888
3204
|
* clickedPoint,
|
|
@@ -2890,12 +3206,12 @@ export declare enum EmbedEvent {
|
|
|
2890
3206
|
* },
|
|
2891
3207
|
* autoDrillDown: true,
|
|
2892
3208
|
* })
|
|
2893
|
-
|
|
3209
|
+
* ```
|
|
2894
3210
|
* In this example, `VizPointDoubleClick` event is used for
|
|
2895
3211
|
* triggering the `DrillDown` event when an area or specific
|
|
2896
3212
|
* data point on a table or chart is double-clicked.
|
|
2897
3213
|
* @example
|
|
2898
|
-
|
|
3214
|
+
* ```js
|
|
2899
3215
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
2900
3216
|
* console.log(payload);
|
|
2901
3217
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -2909,7 +3225,7 @@ export declare enum EmbedEvent {
|
|
|
2909
3225
|
* autoDrillDown: true,
|
|
2910
3226
|
* })
|
|
2911
3227
|
* })
|
|
2912
|
-
|
|
3228
|
+
* ```
|
|
2913
3229
|
*/
|
|
2914
3230
|
Drilldown = "drillDown",
|
|
2915
3231
|
/**
|
|
@@ -3034,13 +3350,13 @@ export declare enum EmbedEvent {
|
|
|
3034
3350
|
* The ThoughtSpot authentication session has expired.
|
|
3035
3351
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3036
3352
|
* @example
|
|
3037
|
-
|
|
3353
|
+
* ```js
|
|
3038
3354
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
3039
3355
|
* //show auth expired banner
|
|
3040
3356
|
* function showAuthExpired() {
|
|
3041
3357
|
* document.getElementById("authExpiredBanner");
|
|
3042
3358
|
* }
|
|
3043
|
-
|
|
3359
|
+
* ```
|
|
3044
3360
|
*/
|
|
3045
3361
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
3046
3362
|
/**
|
|
@@ -3075,22 +3391,22 @@ export declare enum EmbedEvent {
|
|
|
3075
3391
|
* Applicable to `SearchBarEmbed` only.
|
|
3076
3392
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3077
3393
|
* @example
|
|
3078
|
-
|
|
3394
|
+
* ```js
|
|
3079
3395
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
3080
3396
|
* .then(data => {
|
|
3081
3397
|
* console.log('Answer Data:', data);
|
|
3082
3398
|
* })
|
|
3083
|
-
|
|
3399
|
+
* ```
|
|
3084
3400
|
*/
|
|
3085
3401
|
GetDataClick = "getDataClick",
|
|
3086
3402
|
/**
|
|
3087
3403
|
* Detects the route change.
|
|
3088
3404
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3089
3405
|
* @example
|
|
3090
|
-
|
|
3406
|
+
* ```js
|
|
3091
3407
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
3092
3408
|
* console.log('data', payload))
|
|
3093
|
-
|
|
3409
|
+
* ```
|
|
3094
3410
|
*/
|
|
3095
3411
|
RouteChange = "ROUTE_CHANGE",
|
|
3096
3412
|
/**
|
|
@@ -3100,12 +3416,12 @@ export declare enum EmbedEvent {
|
|
|
3100
3416
|
V1Data = "exportVizDataToParent",
|
|
3101
3417
|
/**
|
|
3102
3418
|
* Emitted when the embed does not have cookie access. This happens
|
|
3103
|
-
* when
|
|
3104
|
-
*
|
|
3419
|
+
* when third-party cookies are blocked by Safari or other
|
|
3420
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
3105
3421
|
* @example
|
|
3106
|
-
|
|
3422
|
+
* ```js
|
|
3107
3423
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
3108
|
-
|
|
3424
|
+
* ```
|
|
3109
3425
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
3110
3426
|
*/
|
|
3111
3427
|
NoCookieAccess = "noCookieAccess",
|
|
@@ -3119,22 +3435,22 @@ export declare enum EmbedEvent {
|
|
|
3119
3435
|
* Emitted when any modal is opened in the app
|
|
3120
3436
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3121
3437
|
* @example
|
|
3122
|
-
|
|
3438
|
+
* ```js
|
|
3123
3439
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
3124
3440
|
* console.log('dialog open', payload);
|
|
3125
3441
|
* })
|
|
3126
|
-
|
|
3442
|
+
* ```
|
|
3127
3443
|
*/
|
|
3128
3444
|
DialogOpen = "dialog-open",
|
|
3129
3445
|
/**
|
|
3130
3446
|
* Emitted when any modal is closed in the app
|
|
3131
3447
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3132
3448
|
* @example
|
|
3133
|
-
|
|
3449
|
+
* ```js
|
|
3134
3450
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
3135
3451
|
* console.log('dialog close', payload);
|
|
3136
3452
|
* })
|
|
3137
|
-
|
|
3453
|
+
* ```
|
|
3138
3454
|
*/
|
|
3139
3455
|
DialogClose = "dialog-close",
|
|
3140
3456
|
/**
|
|
@@ -3143,39 +3459,39 @@ export declare enum EmbedEvent {
|
|
|
3143
3459
|
* other events on the rendered Liveboard.
|
|
3144
3460
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3145
3461
|
* @example
|
|
3146
|
-
|
|
3462
|
+
* ```js
|
|
3147
3463
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
3148
3464
|
console.log('Liveboard is rendered', payload);
|
|
3149
3465
|
})
|
|
3150
|
-
|
|
3466
|
+
* ```
|
|
3151
3467
|
* The following example shows how to trigger
|
|
3152
3468
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
3153
3469
|
* @example
|
|
3154
|
-
|
|
3470
|
+
* ```js
|
|
3155
3471
|
* const embedRef = useEmbedRef();
|
|
3156
3472
|
* const onLiveboardRendered = () => {
|
|
3157
3473
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
3158
3474
|
* };
|
|
3159
|
-
|
|
3475
|
+
* ```
|
|
3160
3476
|
*/
|
|
3161
3477
|
LiveboardRendered = "PinboardRendered",
|
|
3162
3478
|
/**
|
|
3163
3479
|
* Emits all events.
|
|
3164
|
-
* @
|
|
3480
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3165
3481
|
* @example
|
|
3166
|
-
|
|
3482
|
+
* ```js
|
|
3167
3483
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
3168
3484
|
* console.log('Embed Events', payload)
|
|
3169
3485
|
* })
|
|
3170
|
-
|
|
3486
|
+
* ```
|
|
3171
3487
|
*/
|
|
3172
3488
|
ALL = "*",
|
|
3173
3489
|
/**
|
|
3174
3490
|
* Emitted when an Answer is saved in the app.
|
|
3175
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.
|
|
3176
|
-
* @
|
|
3492
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3177
3493
|
* @example
|
|
3178
|
-
|
|
3494
|
+
* ```js
|
|
3179
3495
|
* //Emit when action starts
|
|
3180
3496
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3181
3497
|
* console.log('Save', payload)
|
|
@@ -3186,7 +3502,7 @@ export declare enum EmbedEvent {
|
|
|
3186
3502
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3187
3503
|
* console.log('Save', payload)
|
|
3188
3504
|
* })
|
|
3189
|
-
|
|
3505
|
+
* ```
|
|
3190
3506
|
*/
|
|
3191
3507
|
Save = "save",
|
|
3192
3508
|
/**
|
|
@@ -3198,11 +3514,11 @@ export declare enum EmbedEvent {
|
|
|
3198
3514
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
3199
3515
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3200
3516
|
* @example
|
|
3201
|
-
|
|
3517
|
+
* ```js
|
|
3202
3518
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
3203
3519
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3204
3520
|
* })
|
|
3205
|
-
|
|
3521
|
+
* ```
|
|
3206
3522
|
*/
|
|
3207
3523
|
Download = "download",
|
|
3208
3524
|
/**
|
|
@@ -3210,14 +3526,14 @@ export declare enum EmbedEvent {
|
|
|
3210
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.
|
|
3211
3527
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3212
3528
|
* @example
|
|
3213
|
-
|
|
3529
|
+
* ```js
|
|
3214
3530
|
* //emit when action starts
|
|
3215
3531
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3216
3532
|
* console.log('download PNG', payload)}, {start: true })
|
|
3217
3533
|
* //emit when action ends
|
|
3218
3534
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3219
3535
|
* console.log('download PNG', payload)})
|
|
3220
|
-
|
|
3536
|
+
* ```
|
|
3221
3537
|
*/
|
|
3222
3538
|
DownloadAsPng = "downloadAsPng",
|
|
3223
3539
|
/**
|
|
@@ -3225,14 +3541,14 @@ export declare enum EmbedEvent {
|
|
|
3225
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.
|
|
3226
3542
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3227
3543
|
* @example
|
|
3228
|
-
|
|
3544
|
+
* ```js
|
|
3229
3545
|
* //emit when action starts
|
|
3230
3546
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3231
3547
|
* console.log('download PDF', payload)}, {start: true })
|
|
3232
3548
|
* //emit when action ends
|
|
3233
3549
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3234
3550
|
* console.log('download PDF', payload)})
|
|
3235
|
-
|
|
3551
|
+
* ```
|
|
3236
3552
|
*/
|
|
3237
3553
|
DownloadAsPdf = "downloadAsPdf",
|
|
3238
3554
|
/**
|
|
@@ -3240,14 +3556,14 @@ export declare enum EmbedEvent {
|
|
|
3240
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.
|
|
3241
3557
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3242
3558
|
* @example
|
|
3243
|
-
|
|
3559
|
+
* ```js
|
|
3244
3560
|
* //emit when action starts
|
|
3245
3561
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3246
3562
|
* console.log('download CSV', payload)}, {start: true })
|
|
3247
3563
|
* //emit when action ends
|
|
3248
3564
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3249
3565
|
* console.log('download CSV', payload)})
|
|
3250
|
-
|
|
3566
|
+
* ```
|
|
3251
3567
|
*/
|
|
3252
3568
|
DownloadAsCsv = "downloadAsCsv",
|
|
3253
3569
|
/**
|
|
@@ -3255,14 +3571,14 @@ export declare enum EmbedEvent {
|
|
|
3255
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.
|
|
3256
3572
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3257
3573
|
* @example
|
|
3258
|
-
|
|
3574
|
+
* ```js
|
|
3259
3575
|
* //emit when action starts
|
|
3260
3576
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3261
3577
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
3262
3578
|
* //emit when action ends
|
|
3263
3579
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3264
3580
|
* console.log('download Xlsx', payload)})
|
|
3265
|
-
|
|
3581
|
+
* ```
|
|
3266
3582
|
*/
|
|
3267
3583
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3268
3584
|
/**
|
|
@@ -3270,25 +3586,25 @@ export declare enum EmbedEvent {
|
|
|
3270
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.
|
|
3271
3587
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3272
3588
|
* @example
|
|
3273
|
-
|
|
3589
|
+
* ```js
|
|
3274
3590
|
* //emit when action starts
|
|
3275
3591
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3276
3592
|
* console.log('delete answer', payload)}, {start: true })
|
|
3277
3593
|
* //trigger when action is completed
|
|
3278
3594
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3279
3595
|
* console.log('delete answer', payload)})
|
|
3280
|
-
|
|
3596
|
+
* ```
|
|
3281
3597
|
*/
|
|
3282
3598
|
AnswerDelete = "answerDelete",
|
|
3283
3599
|
/**
|
|
3284
3600
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
3285
3601
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
3286
3602
|
* @example
|
|
3287
|
-
|
|
3603
|
+
* ```js
|
|
3288
3604
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
3289
3605
|
* console.log('AI Highlights', payload);
|
|
3290
3606
|
* })
|
|
3291
|
-
|
|
3607
|
+
* ```
|
|
3292
3608
|
*/
|
|
3293
3609
|
AIHighlights = "AIHighlights",
|
|
3294
3610
|
/**
|
|
@@ -3297,7 +3613,7 @@ export declare enum EmbedEvent {
|
|
|
3297
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.
|
|
3298
3614
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3299
3615
|
* @example
|
|
3300
|
-
|
|
3616
|
+
* ```js
|
|
3301
3617
|
* //emit when action starts
|
|
3302
3618
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3303
3619
|
* console.log('pin', payload)
|
|
@@ -3308,14 +3624,14 @@ export declare enum EmbedEvent {
|
|
|
3308
3624
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3309
3625
|
* console.log('pin', payload)
|
|
3310
3626
|
* })
|
|
3311
|
-
|
|
3627
|
+
* ```
|
|
3312
3628
|
*/
|
|
3313
3629
|
Pin = "pin",
|
|
3314
3630
|
/**
|
|
3315
3631
|
* Emitted when SpotIQ analysis is triggered
|
|
3316
3632
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3317
3633
|
* @example
|
|
3318
|
-
|
|
3634
|
+
* ```js
|
|
3319
3635
|
* //emit when action starts
|
|
3320
3636
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3321
3637
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -3326,14 +3642,14 @@ export declare enum EmbedEvent {
|
|
|
3326
3642
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3327
3643
|
* console.log('SpotIQ analyze', payload)
|
|
3328
3644
|
* })
|
|
3329
|
-
|
|
3645
|
+
* ```
|
|
3330
3646
|
*/
|
|
3331
3647
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3332
3648
|
/**
|
|
3333
3649
|
* Emitted when a user shares an object with another user or group
|
|
3334
3650
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3335
3651
|
* @example
|
|
3336
|
-
|
|
3652
|
+
* ```js
|
|
3337
3653
|
* //emit when action starts
|
|
3338
3654
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3339
3655
|
* console.log('Share', payload)
|
|
@@ -3344,7 +3660,7 @@ export declare enum EmbedEvent {
|
|
|
3344
3660
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3345
3661
|
* console.log('Share', payload)
|
|
3346
3662
|
* })
|
|
3347
|
-
|
|
3663
|
+
* ```
|
|
3348
3664
|
*/
|
|
3349
3665
|
Share = "share",
|
|
3350
3666
|
/**
|
|
@@ -3352,11 +3668,11 @@ export declare enum EmbedEvent {
|
|
|
3352
3668
|
* data on a chart or table.
|
|
3353
3669
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3354
3670
|
* @example
|
|
3355
|
-
|
|
3671
|
+
* ```js
|
|
3356
3672
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
3357
3673
|
* console.log('Drill include', payload);
|
|
3358
3674
|
* })
|
|
3359
|
-
|
|
3675
|
+
* ```
|
|
3360
3676
|
*/
|
|
3361
3677
|
DrillInclude = "context-menu-item-include",
|
|
3362
3678
|
/**
|
|
@@ -3364,22 +3680,22 @@ export declare enum EmbedEvent {
|
|
|
3364
3680
|
* data on a chart or table
|
|
3365
3681
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3366
3682
|
* @example
|
|
3367
|
-
|
|
3683
|
+
* ```js
|
|
3368
3684
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
3369
3685
|
* console.log('Drill exclude', payload);
|
|
3370
3686
|
* })
|
|
3371
|
-
|
|
3687
|
+
* ```
|
|
3372
3688
|
*/
|
|
3373
3689
|
DrillExclude = "context-menu-item-exclude",
|
|
3374
3690
|
/**
|
|
3375
3691
|
* Emitted when a column value is copied in the embedded app.
|
|
3376
3692
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3377
3693
|
* @example
|
|
3378
|
-
|
|
3379
|
-
*
|
|
3694
|
+
* ```js
|
|
3695
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
3380
3696
|
* console.log('copy to clipboard', payload);
|
|
3381
3697
|
* })
|
|
3382
|
-
|
|
3698
|
+
* ```
|
|
3383
3699
|
*/
|
|
3384
3700
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3385
3701
|
/**
|
|
@@ -3387,10 +3703,10 @@ export declare enum EmbedEvent {
|
|
|
3387
3703
|
* embedded Liveboard.
|
|
3388
3704
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3389
3705
|
* @example
|
|
3390
|
-
|
|
3706
|
+
* ```js
|
|
3391
3707
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
3392
3708
|
* })
|
|
3393
|
-
|
|
3709
|
+
* ```
|
|
3394
3710
|
*/
|
|
3395
3711
|
UpdateTML = "updateTSL",
|
|
3396
3712
|
/**
|
|
@@ -3398,11 +3714,11 @@ export declare enum EmbedEvent {
|
|
|
3398
3714
|
* on an embedded Liveboard.
|
|
3399
3715
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3400
3716
|
* @example
|
|
3401
|
-
|
|
3717
|
+
* ```js
|
|
3402
3718
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
3403
3719
|
* console.log('Edit TML', payload);
|
|
3404
3720
|
* })
|
|
3405
|
-
|
|
3721
|
+
* ```
|
|
3406
3722
|
*/
|
|
3407
3723
|
EditTML = "editTSL",
|
|
3408
3724
|
/**
|
|
@@ -3411,25 +3727,25 @@ export declare enum EmbedEvent {
|
|
|
3411
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.
|
|
3412
3728
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3413
3729
|
* @example
|
|
3414
|
-
|
|
3730
|
+
* ```js
|
|
3415
3731
|
* //emit when action starts
|
|
3416
3732
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3417
3733
|
* console.log('Export TML', payload)}, { start: true })
|
|
3418
3734
|
* //emit when action ends
|
|
3419
3735
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3420
3736
|
* console.log('Export TML', payload)})
|
|
3421
|
-
|
|
3737
|
+
* ```
|
|
3422
3738
|
*/
|
|
3423
3739
|
ExportTML = "exportTSL",
|
|
3424
3740
|
/**
|
|
3425
3741
|
* Emitted when an Answer is saved as a View.
|
|
3426
3742
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3427
3743
|
* @example
|
|
3428
|
-
|
|
3744
|
+
* ```js
|
|
3429
3745
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
3430
3746
|
* console.log('View', payload);
|
|
3431
3747
|
* })
|
|
3432
|
-
|
|
3748
|
+
* ```
|
|
3433
3749
|
*/
|
|
3434
3750
|
SaveAsView = "saveAsView",
|
|
3435
3751
|
/**
|
|
@@ -3437,36 +3753,36 @@ export declare enum EmbedEvent {
|
|
|
3437
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.
|
|
3438
3754
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3439
3755
|
* @example
|
|
3440
|
-
|
|
3756
|
+
* ```js
|
|
3441
3757
|
* //emit when action starts
|
|
3442
3758
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3443
3759
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
3444
3760
|
* //emit when action ends
|
|
3445
3761
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3446
3762
|
* console.log('Copy and edit', payload)})
|
|
3447
|
-
|
|
3763
|
+
* ```
|
|
3448
3764
|
*/
|
|
3449
3765
|
CopyAEdit = "copyAEdit",
|
|
3450
3766
|
/**
|
|
3451
3767
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
3452
3768
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3453
3769
|
* @example
|
|
3454
|
-
|
|
3770
|
+
* ```js
|
|
3455
3771
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
3456
3772
|
* console.log('show data', payload);
|
|
3457
3773
|
* })
|
|
3458
|
-
|
|
3774
|
+
* ```
|
|
3459
3775
|
*/
|
|
3460
3776
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3461
3777
|
/**
|
|
3462
3778
|
* Emitted when an Answer is switched to a chart or table view.
|
|
3463
3779
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3464
3780
|
* @example
|
|
3465
|
-
|
|
3781
|
+
* ```js
|
|
3466
3782
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
3467
3783
|
* console.log('switch view', payload);
|
|
3468
3784
|
* })
|
|
3469
|
-
|
|
3785
|
+
* ```
|
|
3470
3786
|
*/
|
|
3471
3787
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3472
3788
|
/**
|
|
@@ -3483,118 +3799,118 @@ export declare enum EmbedEvent {
|
|
|
3483
3799
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3484
3800
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3485
3801
|
* @example
|
|
3486
|
-
|
|
3802
|
+
* ```js
|
|
3487
3803
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
3488
3804
|
* console.log('Liveboard details', payload);
|
|
3489
3805
|
* })
|
|
3490
|
-
|
|
3806
|
+
* ```
|
|
3491
3807
|
*/
|
|
3492
3808
|
LiveboardInfo = "pinboardInfo",
|
|
3493
3809
|
/**
|
|
3494
3810
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3495
3811
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3496
3812
|
* @example
|
|
3497
|
-
|
|
3813
|
+
* ```js
|
|
3498
3814
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
3499
3815
|
* console.log('favorites', payload);
|
|
3500
3816
|
* })
|
|
3501
|
-
|
|
3817
|
+
* ```
|
|
3502
3818
|
*/
|
|
3503
3819
|
AddToFavorites = "addToFavorites",
|
|
3504
3820
|
/**
|
|
3505
3821
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3506
3822
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3507
3823
|
* @example
|
|
3508
|
-
|
|
3824
|
+
* ```js
|
|
3509
3825
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
3510
|
-
* console.log(
|
|
3826
|
+
* console.log('Liveboard schedule', payload);
|
|
3511
3827
|
* })
|
|
3512
|
-
|
|
3828
|
+
* ```
|
|
3513
3829
|
*/
|
|
3514
3830
|
Schedule = "subscription",
|
|
3515
3831
|
/**
|
|
3516
3832
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3517
3833
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3518
3834
|
* @example
|
|
3519
|
-
|
|
3835
|
+
* ```js
|
|
3520
3836
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
3521
|
-
* console.log(
|
|
3837
|
+
* console.log('Liveboard edit', payload);
|
|
3522
3838
|
* })
|
|
3523
|
-
|
|
3839
|
+
* ```
|
|
3524
3840
|
*/
|
|
3525
3841
|
Edit = "edit",
|
|
3526
3842
|
/**
|
|
3527
3843
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3528
3844
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3529
3845
|
* @example
|
|
3530
|
-
|
|
3846
|
+
* ```js
|
|
3531
3847
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
3532
|
-
* console.log(
|
|
3848
|
+
* console.log('Copy', payload);
|
|
3533
3849
|
* })
|
|
3534
|
-
|
|
3850
|
+
* ```
|
|
3535
3851
|
*/
|
|
3536
3852
|
MakeACopy = "makeACopy",
|
|
3537
3853
|
/**
|
|
3538
3854
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3539
3855
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3540
3856
|
* @example
|
|
3541
|
-
|
|
3857
|
+
* ```js
|
|
3542
3858
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
3543
|
-
|
|
3859
|
+
* ```
|
|
3544
3860
|
* @example
|
|
3545
|
-
|
|
3861
|
+
* ```js
|
|
3546
3862
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
3547
3863
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3548
3864
|
* })
|
|
3549
|
-
|
|
3865
|
+
* ```
|
|
3550
3866
|
*/
|
|
3551
3867
|
Present = "present",
|
|
3552
3868
|
/**
|
|
3553
3869
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3554
3870
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3555
3871
|
* @example
|
|
3556
|
-
|
|
3872
|
+
* ```js
|
|
3557
3873
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
3558
3874
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3559
|
-
|
|
3875
|
+
* ```
|
|
3560
3876
|
*/
|
|
3561
3877
|
Delete = "delete",
|
|
3562
3878
|
/**
|
|
3563
3879
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3564
3880
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3565
3881
|
* @example
|
|
3566
|
-
|
|
3882
|
+
* ```js
|
|
3567
3883
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
3568
|
-
|
|
3884
|
+
* ```
|
|
3569
3885
|
*/
|
|
3570
3886
|
SchedulesList = "schedule-list",
|
|
3571
3887
|
/**
|
|
3572
3888
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3573
3889
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3574
3890
|
* @example
|
|
3575
|
-
|
|
3891
|
+
* ```js
|
|
3576
3892
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
3577
|
-
|
|
3893
|
+
* ```
|
|
3578
3894
|
*/
|
|
3579
3895
|
Cancel = "cancel",
|
|
3580
3896
|
/**
|
|
3581
3897
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3582
3898
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3583
3899
|
* @example
|
|
3584
|
-
|
|
3900
|
+
* ```js
|
|
3585
3901
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3586
3902
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3587
|
-
|
|
3903
|
+
* ```
|
|
3588
3904
|
*/
|
|
3589
3905
|
Explore = "explore",
|
|
3590
3906
|
/**
|
|
3591
3907
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
3592
3908
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3593
3909
|
* @example
|
|
3594
|
-
|
|
3910
|
+
* ```js
|
|
3595
3911
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3596
3912
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3597
|
-
|
|
3913
|
+
* ```
|
|
3598
3914
|
*/
|
|
3599
3915
|
CopyLink = "embedDocument",
|
|
3600
3916
|
/**
|
|
@@ -3602,21 +3918,21 @@ export declare enum EmbedEvent {
|
|
|
3602
3918
|
* visualization or Liveboard.
|
|
3603
3919
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3604
3920
|
* @example
|
|
3605
|
-
|
|
3921
|
+
* ```js
|
|
3606
3922
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3607
3923
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3608
|
-
|
|
3924
|
+
* ```
|
|
3609
3925
|
*/
|
|
3610
3926
|
CrossFilterChanged = "cross-filter-changed",
|
|
3611
3927
|
/**
|
|
3612
3928
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3613
3929
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3614
3930
|
* @example
|
|
3615
|
-
|
|
3931
|
+
* ```js
|
|
3616
3932
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
3617
3933
|
* console.log('VizPointClick', payload)
|
|
3618
3934
|
* })
|
|
3619
|
-
|
|
3935
|
+
* ```
|
|
3620
3936
|
*/
|
|
3621
3937
|
VizPointRightClick = "vizPointRightClick",
|
|
3622
3938
|
/**
|
|
@@ -3630,35 +3946,35 @@ export declare enum EmbedEvent {
|
|
|
3630
3946
|
* filter details.
|
|
3631
3947
|
* @example
|
|
3632
3948
|
*
|
|
3633
|
-
|
|
3949
|
+
* ```js
|
|
3634
3950
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3635
3951
|
* console.log('payload', payload);
|
|
3636
3952
|
* })
|
|
3637
|
-
*
|
|
3953
|
+
* ```
|
|
3638
3954
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3639
3955
|
*/
|
|
3640
3956
|
FilterChanged = "filterChanged",
|
|
3641
3957
|
/**
|
|
3642
3958
|
* Emitted when a user clicks the **Go** button to initiate
|
|
3643
3959
|
* a Natural Language Search query
|
|
3644
|
-
* @version SDK
|
|
3960
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3645
3961
|
*/
|
|
3646
3962
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3647
3963
|
/**
|
|
3648
3964
|
* Emitted when a user selects a data source on the embedded
|
|
3649
3965
|
* Natural Language Search interface.
|
|
3650
3966
|
*
|
|
3651
|
-
* @version SDK
|
|
3967
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3652
3968
|
*/
|
|
3653
3969
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3654
3970
|
/**
|
|
3655
3971
|
* Emitted when a user updates a connection on the **Data** page
|
|
3656
|
-
* @version SDK
|
|
3972
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3657
3973
|
*/
|
|
3658
3974
|
UpdateConnection = "updateConnection",
|
|
3659
3975
|
/**
|
|
3660
3976
|
* Emitted when a user updates a connection on the **Data** page
|
|
3661
|
-
* @version SDK
|
|
3977
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3662
3978
|
*/
|
|
3663
3979
|
CreateConnection = "createConnection",
|
|
3664
3980
|
/**
|
|
@@ -3668,7 +3984,7 @@ export declare enum EmbedEvent {
|
|
|
3668
3984
|
* @returns viewId: string
|
|
3669
3985
|
* @returns liveboardId: string
|
|
3670
3986
|
* @returns isPublic: boolean
|
|
3671
|
-
* @version SDK
|
|
3987
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3672
3988
|
*/
|
|
3673
3989
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3674
3990
|
/**
|
|
@@ -3677,7 +3993,7 @@ export declare enum EmbedEvent {
|
|
|
3677
3993
|
* @returns viewId: string
|
|
3678
3994
|
* @returns liveboardId: string
|
|
3679
3995
|
* @returns isPublic: boolean
|
|
3680
|
-
* @version SDK
|
|
3996
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3681
3997
|
*/
|
|
3682
3998
|
SavePersonalisedView = "savePersonalisedView",
|
|
3683
3999
|
/**
|
|
@@ -3686,19 +4002,19 @@ export declare enum EmbedEvent {
|
|
|
3686
4002
|
* @returns viewId: string
|
|
3687
4003
|
* @returns liveboardId: string
|
|
3688
4004
|
* @returns isPublic: boolean
|
|
3689
|
-
* @version SDK
|
|
4005
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3690
4006
|
*/
|
|
3691
4007
|
ResetLiveboard = "resetLiveboard",
|
|
3692
4008
|
/**
|
|
3693
4009
|
* Emitted when a PersonalisedView is deleted.
|
|
3694
4010
|
* @returns views: string[]
|
|
3695
4011
|
* @returns liveboardId: string
|
|
3696
|
-
* @version SDK
|
|
4012
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3697
4013
|
*/
|
|
3698
4014
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3699
4015
|
/**
|
|
3700
4016
|
* Emitted when a user creates a Worksheet.
|
|
3701
|
-
* @version SDK
|
|
4017
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3702
4018
|
*/
|
|
3703
4019
|
CreateWorksheet = "createWorksheet",
|
|
3704
4020
|
/**
|
|
@@ -3707,12 +4023,12 @@ export declare enum EmbedEvent {
|
|
|
3707
4023
|
* @returns viewId: string
|
|
3708
4024
|
* @returns liveboardId: string
|
|
3709
4025
|
* @returns isPublic: boolean
|
|
3710
|
-
* @version SDK
|
|
4026
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3711
4027
|
*/
|
|
3712
4028
|
AskSageInit = "AskSageInit",
|
|
3713
4029
|
/**
|
|
3714
4030
|
* Emitted when a Liveboard or visualization is renamed.
|
|
3715
|
-
* @version SDK
|
|
4031
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
3716
4032
|
*/
|
|
3717
4033
|
Rename = "rename",
|
|
3718
4034
|
/**
|
|
@@ -3730,14 +4046,12 @@ export declare enum EmbedEvent {
|
|
|
3730
4046
|
* - `payload`: The payload received from the embed related to the Data API call.
|
|
3731
4047
|
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
3732
4048
|
* will run or block the search operation, and if blocked, which error message to provide.
|
|
3733
|
-
*
|
|
3734
|
-
* `execute` - When `execute` returns `true`, the search is run.
|
|
4049
|
+
* - `execute` - When `execute` returns `true`, the search is run.
|
|
3735
4050
|
* When `execute` returns `false`, the search is not executed.
|
|
3736
|
-
*
|
|
3737
|
-
* `error` - Developers can customize the user-facing error message when `execute`
|
|
4051
|
+
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
3738
4052
|
* is `false` by using the `error` parameters in `responder`.
|
|
3739
|
-
* `errorText` - The error message text shown to the user.
|
|
3740
|
-
* @version SDK
|
|
4053
|
+
* - `errorText` - The error message text shown to the user.
|
|
4054
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
3741
4055
|
* @example
|
|
3742
4056
|
*
|
|
3743
4057
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -3752,7 +4066,7 @@ export declare enum EmbedEvent {
|
|
|
3752
4066
|
* },
|
|
3753
4067
|
* },
|
|
3754
4068
|
* });
|
|
3755
|
-
* })
|
|
4069
|
+
* })
|
|
3756
4070
|
* ```
|
|
3757
4071
|
* @example
|
|
3758
4072
|
*
|
|
@@ -3778,7 +4092,7 @@ export declare enum EmbedEvent {
|
|
|
3778
4092
|
* },
|
|
3779
4093
|
* },
|
|
3780
4094
|
* });
|
|
3781
|
-
* })
|
|
4095
|
+
* })
|
|
3782
4096
|
* ```
|
|
3783
4097
|
*/
|
|
3784
4098
|
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
@@ -3789,8 +4103,8 @@ export declare enum EmbedEvent {
|
|
|
3789
4103
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
3790
4104
|
* console.log('payload', payload);
|
|
3791
4105
|
* })
|
|
3792
|
-
|
|
3793
|
-
* @version SDK
|
|
4106
|
+
* ```
|
|
4107
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
3794
4108
|
*/
|
|
3795
4109
|
ParameterChanged = "parameterChanged",
|
|
3796
4110
|
/**
|
|
@@ -3845,24 +4159,24 @@ export declare enum EmbedEvent {
|
|
|
3845
4159
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
3846
4160
|
* console.log('payload', payload);
|
|
3847
4161
|
* })
|
|
3848
|
-
|
|
3849
|
-
* @version SDK
|
|
4162
|
+
* ```
|
|
4163
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
3850
4164
|
*/
|
|
3851
4165
|
CreateLiveboard = "createLiveboard",
|
|
3852
4166
|
/**
|
|
3853
4167
|
* Emitted when a user creates a Model.
|
|
3854
|
-
* @version SDK
|
|
4168
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
3855
4169
|
*/
|
|
3856
4170
|
CreateModel = "createModel",
|
|
3857
4171
|
/**
|
|
3858
4172
|
* @hidden
|
|
3859
4173
|
* Emitted when a user exits present mode.
|
|
3860
|
-
* @version SDK
|
|
4174
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3861
4175
|
*/
|
|
3862
4176
|
ExitPresentMode = "exitPresentMode",
|
|
3863
4177
|
/**
|
|
3864
4178
|
* Emitted when a user requests the full height lazy load data.
|
|
3865
|
-
* @version SDK
|
|
4179
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3866
4180
|
* @hidden
|
|
3867
4181
|
*/
|
|
3868
4182
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
@@ -3873,7 +4187,7 @@ export declare enum EmbedEvent {
|
|
|
3873
4187
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
3874
4188
|
* console.log('payload', payload);
|
|
3875
4189
|
* })
|
|
3876
|
-
|
|
4190
|
+
* ```
|
|
3877
4191
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3878
4192
|
*/
|
|
3879
4193
|
SpotterData = "SpotterData",
|
|
@@ -3884,7 +4198,7 @@ export declare enum EmbedEvent {
|
|
|
3884
4198
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
3885
4199
|
* console.log('payload', payload);
|
|
3886
4200
|
* })
|
|
3887
|
-
|
|
4201
|
+
* ```
|
|
3888
4202
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3889
4203
|
*/
|
|
3890
4204
|
PreviewSpotterData = "PreviewSpotterData",
|
|
@@ -3895,7 +4209,7 @@ export declare enum EmbedEvent {
|
|
|
3895
4209
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
3896
4210
|
* console.log('payload', payload);
|
|
3897
4211
|
* })
|
|
3898
|
-
|
|
4212
|
+
* ```
|
|
3899
4213
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3900
4214
|
*/
|
|
3901
4215
|
AddToCoaching = "addToCoaching",
|
|
@@ -3917,7 +4231,7 @@ export declare enum EmbedEvent {
|
|
|
3917
4231
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
3918
4232
|
* console.log('payload', payload);
|
|
3919
4233
|
* })
|
|
3920
|
-
|
|
4234
|
+
* ```
|
|
3921
4235
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3922
4236
|
*/
|
|
3923
4237
|
SpotterQueryTriggered = "SpotterQueryTriggered",
|
|
@@ -3928,7 +4242,7 @@ export declare enum EmbedEvent {
|
|
|
3928
4242
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
3929
4243
|
* console.log('payload', payload);
|
|
3930
4244
|
* })
|
|
3931
|
-
|
|
4245
|
+
* ```
|
|
3932
4246
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3933
4247
|
*/
|
|
3934
4248
|
LastPromptEdited = "LastPromptEdited",
|
|
@@ -3939,18 +4253,18 @@ export declare enum EmbedEvent {
|
|
|
3939
4253
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
3940
4254
|
* console.log('payload', payload);
|
|
3941
4255
|
* })
|
|
3942
|
-
|
|
4256
|
+
* ```
|
|
3943
4257
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3944
4258
|
*/
|
|
3945
4259
|
LastPromptDeleted = "LastPromptDeleted",
|
|
3946
4260
|
/**
|
|
3947
|
-
* Emitted when the
|
|
4261
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
3948
4262
|
* @example
|
|
3949
4263
|
* ```js
|
|
3950
4264
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
3951
4265
|
* console.log('payload', payload);
|
|
3952
4266
|
* })
|
|
3953
|
-
|
|
4267
|
+
* ```
|
|
3954
4268
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
3955
4269
|
*/
|
|
3956
4270
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
@@ -3961,7 +4275,7 @@ export declare enum EmbedEvent {
|
|
|
3961
4275
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
3962
4276
|
* console.log('payload', payload);
|
|
3963
4277
|
* })
|
|
3964
|
-
|
|
4278
|
+
* ```
|
|
3965
4279
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
3966
4280
|
*/
|
|
3967
4281
|
SpotterInit = "spotterInit",
|
|
@@ -3972,7 +4286,7 @@ export declare enum EmbedEvent {
|
|
|
3972
4286
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
3973
4287
|
* console.log('payload', payload);
|
|
3974
4288
|
* })
|
|
3975
|
-
|
|
4289
|
+
* ```
|
|
3976
4290
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
3977
4291
|
*/
|
|
3978
4292
|
SpotterLoadComplete = "spotterLoadComplete",
|
|
@@ -4326,7 +4640,7 @@ export declare enum HostEvent {
|
|
|
4326
4640
|
* ```js
|
|
4327
4641
|
* appEmbed.navigateToPage(-1)
|
|
4328
4642
|
* ```
|
|
4329
|
-
* @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
|
|
4330
4644
|
*/
|
|
4331
4645
|
Navigate = "Navigate",
|
|
4332
4646
|
/**
|
|
@@ -4459,9 +4773,9 @@ export declare enum HostEvent {
|
|
|
4459
4773
|
* Trigger the **Show Liveboard details** action
|
|
4460
4774
|
* on an embedded Liveboard.
|
|
4461
4775
|
* @example
|
|
4462
|
-
|
|
4776
|
+
* ```js
|
|
4463
4777
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
4464
|
-
|
|
4778
|
+
* ```
|
|
4465
4779
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4466
4780
|
*/
|
|
4467
4781
|
LiveboardInfo = "pinboardInfo",
|
|
@@ -4589,7 +4903,7 @@ export declare enum HostEvent {
|
|
|
4589
4903
|
* appEmbed.trigger(HostEvent.Remove)
|
|
4590
4904
|
* ```
|
|
4591
4905
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4592
|
-
*
|
|
4906
|
+
* @example
|
|
4593
4907
|
* ```js
|
|
4594
4908
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
4595
4909
|
* ```
|
|
@@ -4680,7 +4994,7 @@ export declare enum HostEvent {
|
|
|
4680
4994
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4681
4995
|
* ```
|
|
4682
4996
|
* ```js
|
|
4683
|
-
* vizEmbed.trigger(
|
|
4997
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
4684
4998
|
* ```
|
|
4685
4999
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4686
5000
|
*/
|
|
@@ -4697,7 +5011,7 @@ export declare enum HostEvent {
|
|
|
4697
5011
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4698
5012
|
* ```
|
|
4699
5013
|
* ```js
|
|
4700
|
-
* vizEmbed.trigger(
|
|
5014
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
4701
5015
|
* ```
|
|
4702
5016
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4703
5017
|
*/
|
|
@@ -4712,23 +5026,22 @@ export declare enum HostEvent {
|
|
|
4712
5026
|
* );
|
|
4713
5027
|
* })
|
|
4714
5028
|
* ```
|
|
4715
|
-
*
|
|
5029
|
+
* @example
|
|
4716
5030
|
* ```js
|
|
4717
|
-
|
|
4718
|
-
|
|
4719
|
-
|
|
4720
|
-
|
|
4721
|
-
|
|
4722
|
-
|
|
4723
|
-
|
|
4724
|
-
* 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, {
|
|
4725
5038
|
* vizId: latestSpotterVizId
|
|
4726
5039
|
* }).then((tml) => {
|
|
4727
5040
|
* console.log(
|
|
4728
5041
|
* tml.answer.search_query // TML representation of the search query
|
|
4729
5042
|
* );
|
|
4730
5043
|
* })
|
|
4731
|
-
|
|
5044
|
+
* ```
|
|
4732
5045
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4733
5046
|
* @important
|
|
4734
5047
|
*/
|
|
@@ -4792,6 +5105,11 @@ export declare enum HostEvent {
|
|
|
4792
5105
|
/**
|
|
4793
5106
|
* Trigger the **Download** action on charts in
|
|
4794
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
|
|
4795
5113
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
4796
5114
|
* @example
|
|
4797
5115
|
* ```js
|
|
@@ -4810,9 +5128,6 @@ export declare enum HostEvent {
|
|
|
4810
5128
|
*
|
|
4811
5129
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
4812
5130
|
* ```
|
|
4813
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
4814
|
-
* Use {@link DownloadAsPng}
|
|
4815
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
4816
5131
|
*/
|
|
4817
5132
|
Download = "downloadAsPng",
|
|
4818
5133
|
/**
|
|
@@ -5250,8 +5565,8 @@ export declare enum HostEvent {
|
|
|
5250
5565
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
5251
5566
|
* console.log('parameters', parameter);
|
|
5252
5567
|
* });
|
|
5253
|
-
|
|
5254
|
-
|
|
5568
|
+
* ```
|
|
5569
|
+
* ```js
|
|
5255
5570
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
5256
5571
|
* let latestSpotterVizId = '';
|
|
5257
5572
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -5259,7 +5574,7 @@ export declare enum HostEvent {
|
|
|
5259
5574
|
* });
|
|
5260
5575
|
*
|
|
5261
5576
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
5262
|
-
|
|
5577
|
+
* ```
|
|
5263
5578
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
5264
5579
|
*/
|
|
5265
5580
|
GetParameters = "GetParameters",
|
|
@@ -5276,7 +5591,7 @@ export declare enum HostEvent {
|
|
|
5276
5591
|
* Notify when info call is completed successfully
|
|
5277
5592
|
* ```js
|
|
5278
5593
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
5279
|
-
|
|
5594
|
+
* ```
|
|
5280
5595
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5281
5596
|
*/
|
|
5282
5597
|
InfoSuccess = "InfoSuccess",
|
|
@@ -5379,7 +5694,7 @@ export declare enum HostEvent {
|
|
|
5379
5694
|
* ```js
|
|
5380
5695
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
5381
5696
|
*
|
|
5382
|
-
|
|
5697
|
+
* ```
|
|
5383
5698
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5384
5699
|
*/
|
|
5385
5700
|
AddToCoaching = "addToCoaching",
|
|
@@ -5421,7 +5736,7 @@ export declare enum HostEvent {
|
|
|
5421
5736
|
* });
|
|
5422
5737
|
*
|
|
5423
5738
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
5424
|
-
|
|
5739
|
+
* ```
|
|
5425
5740
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5426
5741
|
*/
|
|
5427
5742
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
@@ -5431,7 +5746,7 @@ export declare enum HostEvent {
|
|
|
5431
5746
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
5432
5747
|
* ```js
|
|
5433
5748
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
5434
|
-
|
|
5749
|
+
* ```
|
|
5435
5750
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5436
5751
|
*/
|
|
5437
5752
|
ExitPresentMode = "exitPresentMode",
|
|
@@ -5682,14 +5997,14 @@ export declare enum Action {
|
|
|
5682
5997
|
* ```js
|
|
5683
5998
|
* disabledActions: [Action.CollapseDataPanel]
|
|
5684
5999
|
* ```
|
|
5685
|
-
* @version
|
|
6000
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5686
6001
|
*/
|
|
5687
6002
|
CollapseDataSources = "collapseDataSources",
|
|
5688
6003
|
/**
|
|
5689
6004
|
* The **Collapse data panel** icon on the Search page.
|
|
5690
6005
|
* Collapses the data panel view.
|
|
5691
6006
|
*
|
|
5692
|
-
* @version
|
|
6007
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5693
6008
|
*
|
|
5694
6009
|
* @example
|
|
5695
6010
|
* ```js
|
|
@@ -6136,13 +6451,12 @@ export declare enum Action {
|
|
|
6136
6451
|
*/
|
|
6137
6452
|
CreateMonitor = "createMonitor",
|
|
6138
6453
|
/**
|
|
6139
|
-
* @
|
|
6140
|
-
*
|
|
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.
|
|
6141
6456
|
* @example
|
|
6142
6457
|
* ```js
|
|
6143
6458
|
* disabledActions: [Action.ReportError]
|
|
6144
6459
|
* ```
|
|
6145
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6146
6460
|
*/
|
|
6147
6461
|
ReportError = "reportError",
|
|
6148
6462
|
/**
|
|
@@ -6152,7 +6466,7 @@ export declare enum Action {
|
|
|
6152
6466
|
* ```js
|
|
6153
6467
|
* disabledActions: [Action.SyncToSheets]
|
|
6154
6468
|
* ```
|
|
6155
|
-
* @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
|
|
6156
6470
|
*/
|
|
6157
6471
|
SyncToSheets = "sync-to-sheets",
|
|
6158
6472
|
/**
|
|
@@ -6163,7 +6477,7 @@ export declare enum Action {
|
|
|
6163
6477
|
* ```js
|
|
6164
6478
|
* disabledActions: [Action.SyncToOtherApps]
|
|
6165
6479
|
* ```
|
|
6166
|
-
* @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
|
|
6167
6481
|
*/
|
|
6168
6482
|
SyncToOtherApps = "sync-to-other-apps",
|
|
6169
6483
|
/**
|
|
@@ -6173,7 +6487,7 @@ export declare enum Action {
|
|
|
6173
6487
|
* ```js
|
|
6174
6488
|
* disabledActions: [Action.ManagePipelines]
|
|
6175
6489
|
* ```
|
|
6176
|
-
* @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
|
|
6177
6491
|
*/
|
|
6178
6492
|
ManagePipelines = "manage-pipeline",
|
|
6179
6493
|
/**
|
|
@@ -6485,7 +6799,7 @@ export declare enum Action {
|
|
|
6485
6799
|
* ```js
|
|
6486
6800
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
6487
6801
|
* ```
|
|
6488
|
-
* @version SDK
|
|
6802
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6489
6803
|
*/
|
|
6490
6804
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
6491
6805
|
/**
|
|
@@ -6495,7 +6809,7 @@ export declare enum Action {
|
|
|
6495
6809
|
* ```js
|
|
6496
6810
|
* disabledActions: [Action.LiveboardUsers]
|
|
6497
6811
|
* ```
|
|
6498
|
-
* @version SDK
|
|
6812
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6499
6813
|
*/
|
|
6500
6814
|
LiveboardUsers = "liveboardUsers",
|
|
6501
6815
|
/**
|
|
@@ -6513,7 +6827,7 @@ export declare enum Action {
|
|
|
6513
6827
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
6514
6828
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
6515
6829
|
* ```
|
|
6516
|
-
* @version SDK
|
|
6830
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
6517
6831
|
*/
|
|
6518
6832
|
TML = "tml",
|
|
6519
6833
|
/**
|
|
@@ -6559,7 +6873,7 @@ export declare enum Action {
|
|
|
6559
6873
|
* ```js
|
|
6560
6874
|
* disabledActions: [Action.AddToWatchlist]
|
|
6561
6875
|
* ```
|
|
6562
|
-
* @version SDK
|
|
6876
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6563
6877
|
*/
|
|
6564
6878
|
AddToWatchlist = "addToWatchlist",
|
|
6565
6879
|
/**
|
|
@@ -6569,7 +6883,7 @@ export declare enum Action {
|
|
|
6569
6883
|
* ```js
|
|
6570
6884
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6571
6885
|
* ```
|
|
6572
|
-
* @version SDK
|
|
6886
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6573
6887
|
*/
|
|
6574
6888
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6575
6889
|
/**
|
|
@@ -6580,7 +6894,7 @@ export declare enum Action {
|
|
|
6580
6894
|
* ```js
|
|
6581
6895
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6582
6896
|
* ```
|
|
6583
|
-
* @version SDK
|
|
6897
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6584
6898
|
*/
|
|
6585
6899
|
OrganiseFavourites = "organiseFavourites",
|
|
6586
6900
|
/**
|
|
@@ -6641,7 +6955,7 @@ export declare enum Action {
|
|
|
6641
6955
|
* ```js
|
|
6642
6956
|
* disabledActions: [Action.ManageTags]
|
|
6643
6957
|
* ```
|
|
6644
|
-
* @version SDK
|
|
6958
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6645
6959
|
*/
|
|
6646
6960
|
ManageTags = "manageTags",
|
|
6647
6961
|
/**
|
|
@@ -7129,17 +7443,79 @@ export interface CustomAction {
|
|
|
7129
7443
|
* positions in the application.
|
|
7130
7444
|
*/
|
|
7131
7445
|
export declare enum CustomActionsPosition {
|
|
7446
|
+
/**
|
|
7447
|
+
* Shows the action as a primary button
|
|
7448
|
+
* in the toolbar area of the embed.
|
|
7449
|
+
*/
|
|
7132
7450
|
PRIMARY = "PRIMARY",
|
|
7451
|
+
/**
|
|
7452
|
+
* Shows the action inside the "More" menu
|
|
7453
|
+
* (three-dot overflow menu).
|
|
7454
|
+
*/
|
|
7133
7455
|
MENU = "MENU",
|
|
7456
|
+
/**
|
|
7457
|
+
* Shows the action in the right-click
|
|
7458
|
+
* context menu. Only supported for
|
|
7459
|
+
* {@link CustomActionTarget.VIZ},
|
|
7460
|
+
* {@link CustomActionTarget.ANSWER}, and
|
|
7461
|
+
* {@link CustomActionTarget.SPOTTER} targets.
|
|
7462
|
+
*/
|
|
7134
7463
|
CONTEXTMENU = "CONTEXTMENU"
|
|
7135
7464
|
}
|
|
7136
7465
|
/**
|
|
7137
|
-
* Enum options to mention the target of the custom action.
|
|
7466
|
+
* Enum options to mention the target of the code-based custom action.
|
|
7467
|
+
* The target determines which type of ThoughtSpot object the action is
|
|
7468
|
+
* associated with, and also controls which positions and scoping options
|
|
7469
|
+
* are available.
|
|
7138
7470
|
*/
|
|
7139
7471
|
export declare enum CustomActionTarget {
|
|
7472
|
+
/**
|
|
7473
|
+
* Action applies at the Liveboard level.
|
|
7474
|
+
* Supported positions:
|
|
7475
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
7476
|
+
* {@link CustomActionsPosition.MENU}.
|
|
7477
|
+
* Can be scoped with
|
|
7478
|
+
* `metadataIds.liveboardIds`,
|
|
7479
|
+
* `orgIds`, and `groupIds`.
|
|
7480
|
+
*/
|
|
7140
7481
|
LIVEBOARD = "LIVEBOARD",
|
|
7482
|
+
/**
|
|
7483
|
+
* Action applies to individual
|
|
7484
|
+
* visualizations (charts/tables).
|
|
7485
|
+
* Supported positions:
|
|
7486
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
7487
|
+
* {@link CustomActionsPosition.MENU},
|
|
7488
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
7489
|
+
* Can be scoped with `metadataIds`
|
|
7490
|
+
* (answerIds, liveboardIds, vizIds),
|
|
7491
|
+
* `dataModelIds` (modelIds,
|
|
7492
|
+
* modelColumnNames), `orgIds`,
|
|
7493
|
+
* and `groupIds`.
|
|
7494
|
+
*/
|
|
7141
7495
|
VIZ = "VIZ",
|
|
7496
|
+
/**
|
|
7497
|
+
* Action applies to saved or unsaved
|
|
7498
|
+
* Answers. Supported positions:
|
|
7499
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
7500
|
+
* {@link CustomActionsPosition.MENU},
|
|
7501
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
7502
|
+
* Can be scoped with
|
|
7503
|
+
* `metadataIds.answerIds`,
|
|
7504
|
+
* `dataModelIds` (modelIds,
|
|
7505
|
+
* modelColumnNames), `orgIds`,
|
|
7506
|
+
* and `groupIds`.
|
|
7507
|
+
*/
|
|
7142
7508
|
ANSWER = "ANSWER",
|
|
7509
|
+
/**
|
|
7510
|
+
* Action applies to Spotter
|
|
7511
|
+
* (AI-powered search).
|
|
7512
|
+
* Supported positions:
|
|
7513
|
+
* {@link CustomActionsPosition.MENU},
|
|
7514
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
7515
|
+
* Can be scoped with
|
|
7516
|
+
* `dataModelIds.modelIds`,
|
|
7517
|
+
* `orgIds`, and `groupIds`.
|
|
7518
|
+
*/
|
|
7143
7519
|
SPOTTER = "SPOTTER"
|
|
7144
7520
|
}
|
|
7145
7521
|
/**
|
|
@@ -7431,14 +7807,14 @@ export type ApiInterceptFlags = {
|
|
|
7431
7807
|
/**
|
|
7432
7808
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
7433
7809
|
*
|
|
7434
|
-
* Can be used for
|
|
7810
|
+
* Can be used for Search and App Embed from SDK 1.29.0
|
|
7435
7811
|
*
|
|
7436
|
-
* @version SDK
|
|
7812
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7437
7813
|
*/
|
|
7438
7814
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
7439
7815
|
/**
|
|
7440
7816
|
* This allows to intercept the urls passed, once intercepted the api will only
|
|
7441
|
-
* run based on the
|
|
7817
|
+
* run based on the response from the responder of ApiIntercept event.
|
|
7442
7818
|
*
|
|
7443
7819
|
* @example
|
|
7444
7820
|
* ```js
|
|
@@ -7449,7 +7825,7 @@ export type ApiInterceptFlags = {
|
|
|
7449
7825
|
* })
|
|
7450
7826
|
* ```
|
|
7451
7827
|
*
|
|
7452
|
-
* @version SDK
|
|
7828
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7453
7829
|
*/
|
|
7454
7830
|
interceptUrls?: (string | InterceptedApiType)[];
|
|
7455
7831
|
/**
|
|
@@ -7466,7 +7842,7 @@ export type ApiInterceptFlags = {
|
|
|
7466
7842
|
* })
|
|
7467
7843
|
* ```
|
|
7468
7844
|
*
|
|
7469
|
-
* @version SDK
|
|
7845
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7470
7846
|
*/
|
|
7471
7847
|
interceptTimeout?: number;
|
|
7472
7848
|
};
|
|
@@ -7719,9 +8095,9 @@ declare class TsEmbed {
|
|
|
7719
8095
|
*/
|
|
7720
8096
|
private isPreRendered;
|
|
7721
8097
|
/**
|
|
7722
|
-
* Should we encode URL Query Params using base64 encoding which
|
|
8098
|
+
* Should we encode URL Query Params using base64 encoding which ThoughtSpot
|
|
7723
8099
|
* will generate for embedding. This provides additional security to
|
|
7724
|
-
*
|
|
8100
|
+
* ThoughtSpot clusters against Cross site scripting attacks.
|
|
7725
8101
|
* @default false
|
|
7726
8102
|
*/
|
|
7727
8103
|
private shouldEncodeUrlQueryParams;
|
|
@@ -8087,7 +8463,7 @@ declare class TsEmbed {
|
|
|
8087
8463
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
8088
8464
|
* session.
|
|
8089
8465
|
* @param vizId [Optional] to get for a specific viz in case of a Liveboard.
|
|
8090
|
-
* @version SDK: 1.25.0
|
|
8466
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
|
|
8091
8467
|
*/
|
|
8092
8468
|
getAnswerService(vizId?: string): Promise<AnswerService>;
|
|
8093
8469
|
/**
|
|
@@ -8146,81 +8522,81 @@ export interface SearchOptions {
|
|
|
8146
8522
|
* Configuration for the Spotter sidebar.
|
|
8147
8523
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
8148
8524
|
* @group Embed components
|
|
8149
|
-
* @version SDK: 1.
|
|
8525
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8150
8526
|
*/
|
|
8151
8527
|
export interface SpotterSidebarViewConfig {
|
|
8152
8528
|
/**
|
|
8153
8529
|
* Controls the visibility of the past conversations sidebar.
|
|
8154
8530
|
* @default false
|
|
8155
|
-
* @version SDK: 1.
|
|
8531
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8156
8532
|
*/
|
|
8157
8533
|
enablePastConversationsSidebar?: boolean;
|
|
8158
8534
|
/**
|
|
8159
8535
|
* Custom title text for the sidebar header.
|
|
8160
8536
|
* Defaults to translated "Spotter" text.
|
|
8161
|
-
* @version SDK: 1.
|
|
8537
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8162
8538
|
*/
|
|
8163
8539
|
spotterSidebarTitle?: string;
|
|
8164
8540
|
/**
|
|
8165
8541
|
* Boolean to set the default expanded state of the sidebar.
|
|
8166
8542
|
* @default false
|
|
8167
|
-
* @version SDK: 1.
|
|
8543
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8168
8544
|
*/
|
|
8169
8545
|
spotterSidebarDefaultExpanded?: boolean;
|
|
8170
8546
|
/**
|
|
8171
8547
|
* Custom label text for the rename action in the conversation edit menu.
|
|
8172
8548
|
* Defaults to translated "Rename" text.
|
|
8173
|
-
* @version SDK: 1.
|
|
8549
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8174
8550
|
*/
|
|
8175
8551
|
spotterChatRenameLabel?: string;
|
|
8176
8552
|
/**
|
|
8177
8553
|
* Custom label text for the delete action in the conversation edit menu.
|
|
8178
8554
|
* Defaults to translated "DELETE" text.
|
|
8179
|
-
* @version SDK: 1.
|
|
8555
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8180
8556
|
*/
|
|
8181
8557
|
spotterChatDeleteLabel?: string;
|
|
8182
8558
|
/**
|
|
8183
8559
|
* Custom title text for the delete conversation confirmation modal.
|
|
8184
8560
|
* Defaults to translated "Delete chat" text.
|
|
8185
|
-
* @version SDK: 1.
|
|
8561
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8186
8562
|
*/
|
|
8187
8563
|
spotterDeleteConversationModalTitle?: string;
|
|
8188
8564
|
/**
|
|
8189
8565
|
* Custom message text for the past conversation banner alert.
|
|
8190
8566
|
* Defaults to translated alert message.
|
|
8191
|
-
* @version SDK: 1.
|
|
8567
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8192
8568
|
*/
|
|
8193
8569
|
spotterPastConversationAlertMessage?: string;
|
|
8194
8570
|
/**
|
|
8195
8571
|
* Custom URL for the documentation/best practices link.
|
|
8196
8572
|
* Defaults to ThoughtSpot docs URL based on release version.
|
|
8197
8573
|
* Note: URL must include the protocol (e.g., `https://www.example.com`).
|
|
8198
|
-
* @version SDK: 1.
|
|
8574
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8199
8575
|
*/
|
|
8200
8576
|
spotterDocumentationUrl?: string;
|
|
8201
8577
|
/**
|
|
8202
8578
|
* Custom label text for the best practices button in the footer.
|
|
8203
8579
|
* Defaults to translated "Best Practices" text.
|
|
8204
|
-
* @version SDK: 1.
|
|
8580
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8205
8581
|
*/
|
|
8206
8582
|
spotterBestPracticesLabel?: string;
|
|
8207
8583
|
/**
|
|
8208
8584
|
* Number of conversations to fetch per batch when loading conversation history.
|
|
8209
8585
|
* @default 30
|
|
8210
|
-
* @version SDK: 1.
|
|
8586
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8211
8587
|
*/
|
|
8212
8588
|
spotterConversationsBatchSize?: number;
|
|
8213
8589
|
/**
|
|
8214
8590
|
* Custom title text for the "New Chat" button in the sidebar.
|
|
8215
8591
|
* Defaults to translated "New Chat" text.
|
|
8216
|
-
* @version SDK: 1.
|
|
8592
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8217
8593
|
*/
|
|
8218
8594
|
spotterNewChatButtonTitle?: string;
|
|
8219
8595
|
}
|
|
8220
8596
|
/**
|
|
8221
8597
|
* Configuration for customizing Spotter chat UI branding.
|
|
8222
|
-
* @group Embed components
|
|
8223
8598
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8599
|
+
* @group Embed components
|
|
8224
8600
|
*/
|
|
8225
8601
|
export interface SpotterChatViewConfig {
|
|
8226
8602
|
/**
|
|
@@ -8259,6 +8635,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8259
8635
|
* but still display the selected data source.
|
|
8260
8636
|
*
|
|
8261
8637
|
* Supported embed types: `SpotterEmbed`
|
|
8638
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8262
8639
|
* @example
|
|
8263
8640
|
* ```js
|
|
8264
8641
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8266,13 +8643,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8266
8643
|
* disableSourceSelection : true,
|
|
8267
8644
|
* })
|
|
8268
8645
|
* ```
|
|
8269
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8270
8646
|
*/
|
|
8271
8647
|
disableSourceSelection?: boolean;
|
|
8272
8648
|
/**
|
|
8273
8649
|
* hideSourceSelection : Hide data source selection
|
|
8274
8650
|
*
|
|
8275
8651
|
* Supported embed types: `SpotterEmbed`
|
|
8652
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8276
8653
|
* @example
|
|
8277
8654
|
* ```js
|
|
8278
8655
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8280,15 +8657,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8280
8657
|
* hideSourceSelection : true,
|
|
8281
8658
|
* })
|
|
8282
8659
|
* ```
|
|
8283
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8284
8660
|
*/
|
|
8285
8661
|
hideSourceSelection?: boolean;
|
|
8286
8662
|
/**
|
|
8287
8663
|
* Flag to control Data panel experience
|
|
8288
8664
|
*
|
|
8289
8665
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
8666
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8290
8667
|
* @default true
|
|
8291
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8292
8668
|
* @example
|
|
8293
8669
|
* ```js
|
|
8294
8670
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -8305,6 +8681,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8305
8681
|
* default is false.
|
|
8306
8682
|
*
|
|
8307
8683
|
* Supported embed types: `SpotterEmbed`
|
|
8684
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
8308
8685
|
* @example
|
|
8309
8686
|
* ```js
|
|
8310
8687
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8312,7 +8689,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8312
8689
|
* showSpotterLimitations : true,
|
|
8313
8690
|
* })
|
|
8314
8691
|
* ```
|
|
8315
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
8316
8692
|
*/
|
|
8317
8693
|
showSpotterLimitations?: boolean;
|
|
8318
8694
|
/**
|
|
@@ -8320,6 +8696,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8320
8696
|
* the initial screen of the conversation.
|
|
8321
8697
|
*
|
|
8322
8698
|
* Supported embed types: `SpotterEmbed`
|
|
8699
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8323
8700
|
* @example
|
|
8324
8701
|
* ```js
|
|
8325
8702
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8327,7 +8704,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8327
8704
|
* hideSampleQuestions : true,
|
|
8328
8705
|
* })
|
|
8329
8706
|
* ```
|
|
8330
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8331
8707
|
*/
|
|
8332
8708
|
hideSampleQuestions?: boolean;
|
|
8333
8709
|
/**
|
|
@@ -8335,6 +8711,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8335
8711
|
* visualization, or Liveboard.
|
|
8336
8712
|
*
|
|
8337
8713
|
* Supported embed types: `SpotterEmbed`
|
|
8714
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8338
8715
|
* @example
|
|
8339
8716
|
* ```js
|
|
8340
8717
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8348,7 +8725,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8348
8725
|
* ],
|
|
8349
8726
|
* })
|
|
8350
8727
|
* ```
|
|
8351
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8352
8728
|
*/
|
|
8353
8729
|
runtimeFilters?: RuntimeFilter[];
|
|
8354
8730
|
/**
|
|
@@ -8359,14 +8735,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8359
8735
|
* (default behavior before SDK 1.45.0).
|
|
8360
8736
|
*
|
|
8361
8737
|
* Supported embed types: `SpotterEmbed`
|
|
8362
|
-
* @default true
|
|
8363
8738
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8739
|
+
* @default true
|
|
8364
8740
|
*/
|
|
8365
8741
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
8366
8742
|
/**
|
|
8367
8743
|
* The list of runtime parameters to apply to the conversation.
|
|
8368
8744
|
*
|
|
8369
8745
|
* Supported embed types: `SpotterEmbed`
|
|
8746
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8370
8747
|
* @example
|
|
8371
8748
|
* ```js
|
|
8372
8749
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8379,7 +8756,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8379
8756
|
* ],
|
|
8380
8757
|
* })
|
|
8381
8758
|
* ```
|
|
8382
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8383
8759
|
*/
|
|
8384
8760
|
runtimeParameters?: RuntimeParameter[];
|
|
8385
8761
|
/**
|
|
@@ -8390,14 +8766,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8390
8766
|
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
8391
8767
|
*
|
|
8392
8768
|
* Supported embed types: `SpotterEmbed`
|
|
8393
|
-
* @default true
|
|
8394
8769
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8770
|
+
* @default true
|
|
8395
8771
|
*/
|
|
8396
8772
|
excludeRuntimeParametersfromURL?: boolean;
|
|
8397
8773
|
/**
|
|
8398
8774
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
8399
8775
|
*
|
|
8400
8776
|
* Supported embed types: `SpotterEmbed`
|
|
8777
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8401
8778
|
* @default false
|
|
8402
8779
|
* @example
|
|
8403
8780
|
* ```js
|
|
@@ -8406,17 +8783,30 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8406
8783
|
* updatedSpotterChatPrompt : true,
|
|
8407
8784
|
* })
|
|
8408
8785
|
* ```
|
|
8409
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8410
8786
|
*/
|
|
8411
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;
|
|
8412
8798
|
/**
|
|
8413
8799
|
* Configuration for the Spotter sidebar UI customization.
|
|
8414
8800
|
*
|
|
8415
8801
|
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
8802
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8416
8803
|
* @example
|
|
8417
8804
|
* ```js
|
|
8418
8805
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8419
|
-
*
|
|
8806
|
+
* worksheetId: 'worksheet-id',
|
|
8807
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
8808
|
+
* enablePastConversationsSidebar: false,
|
|
8809
|
+
* // Recommended config; this value takes precedence
|
|
8420
8810
|
* spotterSidebarConfig: {
|
|
8421
8811
|
* enablePastConversationsSidebar: true,
|
|
8422
8812
|
* spotterSidebarTitle: 'My Conversations',
|
|
@@ -8424,7 +8814,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8424
8814
|
* },
|
|
8425
8815
|
* })
|
|
8426
8816
|
* ```
|
|
8427
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8428
8817
|
*/
|
|
8429
8818
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
8430
8819
|
/**
|
|
@@ -8432,6 +8821,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8432
8821
|
* branding in tool response cards.
|
|
8433
8822
|
*
|
|
8434
8823
|
* Supported embed types: `SpotterEmbed`
|
|
8824
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8435
8825
|
* @example
|
|
8436
8826
|
* ```js
|
|
8437
8827
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8442,20 +8832,20 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8442
8832
|
* },
|
|
8443
8833
|
* })
|
|
8444
8834
|
* ```
|
|
8445
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8446
8835
|
*/
|
|
8447
8836
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
8448
8837
|
}
|
|
8449
8838
|
/**
|
|
8450
8839
|
* The configuration for the embedded spotterEmbed options.
|
|
8451
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8452
8840
|
* Use {@link SpotterEmbedViewConfig} instead
|
|
8841
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8453
8842
|
* @group Embed components
|
|
8454
8843
|
*/
|
|
8455
8844
|
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
8456
8845
|
}
|
|
8457
8846
|
/**
|
|
8458
8847
|
* Embed ThoughtSpot AI Conversation.
|
|
8848
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8459
8849
|
* @group Embed components
|
|
8460
8850
|
* @example
|
|
8461
8851
|
* ```js
|
|
@@ -8467,7 +8857,6 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
|
8467
8857
|
* });
|
|
8468
8858
|
* conversation.render();
|
|
8469
8859
|
* ```
|
|
8470
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8471
8860
|
*/
|
|
8472
8861
|
export declare class SpotterEmbed extends TsEmbed {
|
|
8473
8862
|
protected viewConfig: SpotterEmbedViewConfig;
|
|
@@ -8478,8 +8867,9 @@ export declare class SpotterEmbed extends TsEmbed {
|
|
|
8478
8867
|
}
|
|
8479
8868
|
/**
|
|
8480
8869
|
* Embed ThoughtSpot AI Conversation.
|
|
8481
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8482
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
|
|
8483
8873
|
* @group Embed components
|
|
8484
8874
|
* @example
|
|
8485
8875
|
* ```js
|
|
@@ -8491,7 +8881,6 @@ export declare class SpotterEmbed extends TsEmbed {
|
|
|
8491
8881
|
* });
|
|
8492
8882
|
* conversation.render();
|
|
8493
8883
|
* ```
|
|
8494
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8495
8884
|
*/
|
|
8496
8885
|
export declare class ConversationEmbed extends SpotterEmbed {
|
|
8497
8886
|
protected viewConfig: ConversationViewConfig;
|
|
@@ -8535,7 +8924,7 @@ export declare enum Page {
|
|
|
8535
8924
|
Monitor = "monitor"
|
|
8536
8925
|
}
|
|
8537
8926
|
/**
|
|
8538
|
-
* Define the initial state
|
|
8927
|
+
* Define the initial state of column custom group accordions
|
|
8539
8928
|
* in data panel v2.
|
|
8540
8929
|
*/
|
|
8541
8930
|
export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
@@ -8606,7 +8995,7 @@ export declare enum ListPage {
|
|
|
8606
8995
|
*/
|
|
8607
8996
|
export interface DiscoveryExperience {
|
|
8608
8997
|
/**
|
|
8609
|
-
* primaryNavbarVersion determines the version of the navigation
|
|
8998
|
+
* primaryNavbarVersion determines the version of the primary navigation bar.
|
|
8610
8999
|
*/
|
|
8611
9000
|
primaryNavbarVersion?: PrimaryNavbarVersion;
|
|
8612
9001
|
/**
|
|
@@ -8629,8 +9018,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8629
9018
|
* This flag also controls the homepage left navigation bar.
|
|
8630
9019
|
*
|
|
8631
9020
|
* Supported embed types: `AppEmbed`
|
|
8632
|
-
* @default true
|
|
8633
9021
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9022
|
+
* @default true
|
|
8634
9023
|
* @example
|
|
8635
9024
|
* ```js
|
|
8636
9025
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8651,8 +9040,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8651
9040
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
8652
9041
|
*
|
|
8653
9042
|
* Supported embed types: `AppEmbed`
|
|
8654
|
-
* @default false
|
|
8655
9043
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9044
|
+
* @default false
|
|
8656
9045
|
* @example
|
|
8657
9046
|
* ```js
|
|
8658
9047
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8669,8 +9058,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8669
9058
|
* navigation bar is not hidden via `showPrimaryNavbar`.
|
|
8670
9059
|
*
|
|
8671
9060
|
* Supported embed types: `AppEmbed`
|
|
8672
|
-
* @default false
|
|
8673
9061
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9062
|
+
* @default false
|
|
8674
9063
|
* @example
|
|
8675
9064
|
* ```js
|
|
8676
9065
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8681,12 +9070,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8681
9070
|
*/
|
|
8682
9071
|
disableProfileAndHelp?: boolean;
|
|
8683
9072
|
/**
|
|
8684
|
-
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
8685
|
-
* @default true
|
|
8686
9073
|
* Whether the help menu in the top navigation bar should be served
|
|
8687
9074
|
* from Pendo or ThoughtSpot's internal help items.
|
|
8688
9075
|
*
|
|
8689
9076
|
* Supported embed types: `AppEmbed`
|
|
9077
|
+
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9078
|
+
* @default true
|
|
8690
9079
|
* @example
|
|
8691
9080
|
* ```js
|
|
8692
9081
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8701,8 +9090,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8701
9090
|
* the top navigation bar in the V3 navigation experience.
|
|
8702
9091
|
*
|
|
8703
9092
|
* Supported embed types: `AppEmbed`
|
|
8704
|
-
* @default false
|
|
8705
9093
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9094
|
+
* @default false
|
|
8706
9095
|
* @example
|
|
8707
9096
|
* ```js
|
|
8708
9097
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8721,8 +9110,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8721
9110
|
* in the classic (V1) experience.
|
|
8722
9111
|
*
|
|
8723
9112
|
* Supported embed types: `AppEmbed`
|
|
8724
|
-
* @default true
|
|
8725
9113
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9114
|
+
* @default true
|
|
8726
9115
|
* @example
|
|
8727
9116
|
* ```js
|
|
8728
9117
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8740,8 +9129,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8740
9129
|
* in the classic (V1) and V2 experience modes.
|
|
8741
9130
|
*
|
|
8742
9131
|
* Supported embed types: `AppEmbed`
|
|
8743
|
-
* @default true
|
|
8744
9132
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9133
|
+
* @default true
|
|
8745
9134
|
* @example
|
|
8746
9135
|
* ```js
|
|
8747
9136
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8757,7 +9146,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8757
9146
|
* In the V3 experience, it shows or hides application selection
|
|
8758
9147
|
* icons on the left navigation panel.
|
|
8759
9148
|
* By default, the application selection menu and icons are
|
|
8760
|
-
* shown in the UI
|
|
9149
|
+
* shown in the UI.
|
|
8761
9150
|
*
|
|
8762
9151
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
8763
9152
|
*
|
|
@@ -8797,7 +9186,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8797
9186
|
* takes precedence. This is the path post the `#/` in the URL of the standalone
|
|
8798
9187
|
* ThoughtSpot app. Use this to open the embedded view to a specific path.
|
|
8799
9188
|
*
|
|
8800
|
-
* For
|
|
9189
|
+
* For example, if you want the component to open to a specific Liveboard
|
|
8801
9190
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
8802
9191
|
*
|
|
8803
9192
|
* Supported embed types: `AppEmbed`
|
|
@@ -8815,7 +9204,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8815
9204
|
* The application page to set as the start page
|
|
8816
9205
|
* in the embedded view.
|
|
8817
9206
|
*
|
|
8818
|
-
* 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
|
|
8819
9208
|
* path within the app, use the `path` attribute which is more flexible.
|
|
8820
9209
|
*
|
|
8821
9210
|
* Supported embed types: `AppEmbed`
|
|
@@ -8895,8 +9284,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8895
9284
|
* If set to true, the Search Assist feature is enabled.
|
|
8896
9285
|
*
|
|
8897
9286
|
* Supported embed types: `AppEmbed`
|
|
8898
|
-
* @default true
|
|
8899
9287
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
9288
|
+
* @default true
|
|
8900
9289
|
* @example
|
|
8901
9290
|
* ```js
|
|
8902
9291
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8934,8 +9323,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8934
9323
|
* For more information,
|
|
8935
9324
|
* see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
8936
9325
|
* Supported embed types: `AppEmbed`
|
|
8937
|
-
* @default false
|
|
8938
9326
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9327
|
+
* @default false
|
|
8939
9328
|
* @example
|
|
8940
9329
|
* ```js
|
|
8941
9330
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8950,8 +9339,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8950
9339
|
* For more information, see
|
|
8951
9340
|
* link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
8952
9341
|
* Supported embed types: `AppEmbed`
|
|
8953
|
-
* @default false
|
|
8954
9342
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9343
|
+
* @default false
|
|
8955
9344
|
* @example
|
|
8956
9345
|
* ```js
|
|
8957
9346
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8966,10 +9355,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8966
9355
|
*/
|
|
8967
9356
|
discoveryExperience?: DiscoveryExperience;
|
|
8968
9357
|
/**
|
|
8969
|
-
* 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.
|
|
8970
9359
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
9360
|
+
* @deprecated This flag is deprecated.
|
|
8971
9361
|
* @default false
|
|
8972
|
-
* @deprecated Use {@link collapseSearchBar} instead
|
|
8973
9362
|
*/
|
|
8974
9363
|
collapseSearchBarInitially?: boolean;
|
|
8975
9364
|
/**
|
|
@@ -8997,14 +9386,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8997
9386
|
* Flag to use home page search bar mode
|
|
8998
9387
|
*
|
|
8999
9388
|
* Supported embed types: `AppEmbed`
|
|
9000
|
-
* @version SDK
|
|
9389
|
+
* @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
9001
9390
|
*/
|
|
9002
9391
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
9003
9392
|
/**
|
|
9004
9393
|
* This flag is used to enable unified search experience for full app embed.
|
|
9005
9394
|
*
|
|
9006
9395
|
* Supported embed types: `AppEmbed`
|
|
9007
|
-
* @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
|
|
9396
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
|
|
9008
9397
|
* @default true
|
|
9009
9398
|
* @example
|
|
9010
9399
|
* ```js
|
|
@@ -9016,7 +9405,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9016
9405
|
*/
|
|
9017
9406
|
isUnifiedSearchExperienceEnabled?: boolean;
|
|
9018
9407
|
/**
|
|
9019
|
-
* 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.
|
|
9020
9410
|
*
|
|
9021
9411
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9022
9412
|
* @type {boolean}
|
|
@@ -9082,6 +9472,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9082
9472
|
/**
|
|
9083
9473
|
* This flag is used to enable the full height lazy load data.
|
|
9084
9474
|
*
|
|
9475
|
+
* @type {boolean}
|
|
9476
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9477
|
+
* @default false
|
|
9085
9478
|
* @example
|
|
9086
9479
|
* ```js
|
|
9087
9480
|
* const embed = new AppEmbed('#embed-container', {
|
|
@@ -9090,39 +9483,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9090
9483
|
* lazyLoadingForFullHeight: true,
|
|
9091
9484
|
* })
|
|
9092
9485
|
* ```
|
|
9093
|
-
*
|
|
9094
|
-
* @type {boolean}
|
|
9095
|
-
* @default false
|
|
9096
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9097
9486
|
*/
|
|
9098
9487
|
lazyLoadingForFullHeight?: boolean;
|
|
9099
9488
|
/**
|
|
9100
9489
|
* The margin to be used for lazy loading.
|
|
9101
9490
|
*
|
|
9102
9491
|
* For example, if the margin is set to '10px',
|
|
9103
|
-
* the visualization will be loaded 10px before
|
|
9492
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
9104
9493
|
* viewport.
|
|
9105
9494
|
*
|
|
9106
9495
|
* The format is similar to CSS margin.
|
|
9107
9496
|
*
|
|
9497
|
+
* @type {string}
|
|
9498
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9108
9499
|
* @example
|
|
9109
9500
|
* ```js
|
|
9110
9501
|
* const embed = new AppEmbed('#embed-container', {
|
|
9111
9502
|
* // ...other options
|
|
9112
9503
|
* fullHeight: true,
|
|
9113
9504
|
* lazyLoadingForFullHeight: true,
|
|
9114
|
-
* // 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.
|
|
9115
9506
|
* lazyLoadingMargin: '0px',
|
|
9116
9507
|
* })
|
|
9117
9508
|
* ```
|
|
9118
|
-
* @type {string}
|
|
9119
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9120
9509
|
*/
|
|
9121
9510
|
lazyLoadingMargin?: string;
|
|
9122
9511
|
/**
|
|
9123
9512
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9124
9513
|
*
|
|
9125
9514
|
* Supported embed types: `AppEmbed`
|
|
9515
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9126
9516
|
* @default false
|
|
9127
9517
|
* @example
|
|
9128
9518
|
* ```js
|
|
@@ -9131,25 +9521,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9131
9521
|
* updatedSpotterChatPrompt : true,
|
|
9132
9522
|
* })
|
|
9133
9523
|
* ```
|
|
9134
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9135
9524
|
*/
|
|
9136
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;
|
|
9137
9536
|
/**
|
|
9138
9537
|
* Configuration for the Spotter sidebar UI customization.
|
|
9139
9538
|
* Only applicable when navigating to Spotter within the app.
|
|
9140
9539
|
*
|
|
9141
9540
|
* Supported embed types: `AppEmbed`
|
|
9541
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9142
9542
|
* @example
|
|
9143
9543
|
* ```js
|
|
9144
9544
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
9145
|
-
*
|
|
9545
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
9546
|
+
* enablePastConversationsSidebar: false,
|
|
9547
|
+
* // Recommended config; this value takes precedence
|
|
9146
9548
|
* spotterSidebarConfig: {
|
|
9147
9549
|
* enablePastConversationsSidebar: true,
|
|
9148
9550
|
* spotterSidebarTitle: 'My Conversations',
|
|
9149
9551
|
* },
|
|
9150
9552
|
* })
|
|
9151
9553
|
* ```
|
|
9152
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9153
9554
|
*/
|
|
9154
9555
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
9155
9556
|
/**
|
|
@@ -9157,6 +9558,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9157
9558
|
* branding in tool response cards.
|
|
9158
9559
|
*
|
|
9159
9560
|
* Supported embed types: `AppEmbed`
|
|
9561
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9160
9562
|
* @example
|
|
9161
9563
|
* ```js
|
|
9162
9564
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9167,7 +9569,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9167
9569
|
* },
|
|
9168
9570
|
* })
|
|
9169
9571
|
* ```
|
|
9170
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9171
9572
|
*/
|
|
9172
9573
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
9173
9574
|
/**
|
|
@@ -9187,6 +9588,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9187
9588
|
* ```
|
|
9188
9589
|
*/
|
|
9189
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;
|
|
9190
9607
|
}
|
|
9191
9608
|
/**
|
|
9192
9609
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -9313,20 +9730,45 @@ export declare enum AuthFailureType {
|
|
|
9313
9730
|
*/
|
|
9314
9731
|
export declare enum AuthStatus {
|
|
9315
9732
|
/**
|
|
9316
|
-
* Emits when the SDK fails to authenticate
|
|
9733
|
+
* Emits when the SDK fails to authenticate.
|
|
9317
9734
|
*/
|
|
9318
9735
|
FAILURE = "FAILURE",
|
|
9319
9736
|
/**
|
|
9320
|
-
* 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
|
+
* ```
|
|
9321
9750
|
*/
|
|
9322
9751
|
SDK_SUCCESS = "SDK_SUCCESS",
|
|
9323
9752
|
/**
|
|
9324
9753
|
* @hidden
|
|
9325
|
-
* Emits when iframe is loaded and session
|
|
9754
|
+
* Emits when iframe is loaded and session
|
|
9755
|
+
* information is available.
|
|
9326
9756
|
*/
|
|
9327
9757
|
SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS",
|
|
9328
9758
|
/**
|
|
9329
|
-
* 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
|
+
* ```
|
|
9330
9772
|
*/
|
|
9331
9773
|
SUCCESS = "SUCCESS",
|
|
9332
9774
|
/**
|
|
@@ -9475,7 +9917,7 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
9475
9917
|
* }).catch(error => {
|
|
9476
9918
|
* console.error(error);
|
|
9477
9919
|
* });
|
|
9478
|
-
|
|
9920
|
+
* ```
|
|
9479
9921
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
9480
9922
|
* @group Global methods
|
|
9481
9923
|
*/
|
|
@@ -9513,9 +9955,9 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
|
9513
9955
|
export declare const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
9514
9956
|
/**
|
|
9515
9957
|
* Reloads the ThoughtSpot iframe.
|
|
9958
|
+
* @version SDK: 1.43.1
|
|
9516
9959
|
* @param iFrame
|
|
9517
9960
|
* @group Global methods
|
|
9518
|
-
* @version SDK: 1.43.1
|
|
9519
9961
|
*/
|
|
9520
9962
|
export declare const reloadIframe: (iFrame: HTMLIFrameElement) => void;
|
|
9521
9963
|
/**
|
|
@@ -9534,9 +9976,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9534
9976
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
9535
9977
|
* incrementally as users scroll the page to view the charts and tables.
|
|
9536
9978
|
*
|
|
9537
|
-
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
9538
9979
|
*
|
|
9539
9980
|
* Supported embed types: `LiveboardEmbed`
|
|
9981
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
9540
9982
|
* @example
|
|
9541
9983
|
* ```js
|
|
9542
9984
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -9547,14 +9989,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9547
9989
|
*/
|
|
9548
9990
|
fullHeight?: boolean;
|
|
9549
9991
|
/**
|
|
9550
|
-
* 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.
|
|
9551
9993
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
9552
9994
|
* other screens navigable from a Liveboard.
|
|
9553
9995
|
*
|
|
9554
9996
|
* Supported embed types: `LiveboardEmbed`
|
|
9555
9997
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
9556
|
-
* @default 500
|
|
9557
9998
|
* @deprecated Use `minimumHeight` instead.
|
|
9999
|
+
* @default 500
|
|
9558
10000
|
* @example
|
|
9559
10001
|
* ```js
|
|
9560
10002
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -9583,7 +10025,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9583
10025
|
*/
|
|
9584
10026
|
minimumHeight?: number;
|
|
9585
10027
|
/**
|
|
9586
|
-
*
|
|
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.
|
|
9587
10031
|
* @example
|
|
9588
10032
|
* ```js
|
|
9589
10033
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9591,7 +10035,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9591
10035
|
* enableVizTransformations:true,
|
|
9592
10036
|
* })
|
|
9593
10037
|
* ```
|
|
9594
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
9595
10038
|
*/
|
|
9596
10039
|
enableVizTransformations?: boolean;
|
|
9597
10040
|
/**
|
|
@@ -9604,8 +10047,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9604
10047
|
* ```js
|
|
9605
10048
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9606
10049
|
* ... //other embed view config
|
|
9607
|
-
* liveboardId:id of liveboard,
|
|
10050
|
+
* liveboardId:'id of liveboard',
|
|
9608
10051
|
* })
|
|
10052
|
+
* ```
|
|
9609
10053
|
*/
|
|
9610
10054
|
liveboardId?: string;
|
|
9611
10055
|
/**
|
|
@@ -9658,6 +10102,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9658
10102
|
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
9659
10103
|
* ]
|
|
9660
10104
|
* })
|
|
10105
|
+
* ```
|
|
9661
10106
|
*/
|
|
9662
10107
|
visibleVizs?: string[];
|
|
9663
10108
|
/**
|
|
@@ -9685,6 +10130,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9685
10130
|
* Specify the tab ID.
|
|
9686
10131
|
*
|
|
9687
10132
|
* Supported embed types: `LiveboardEmbed`
|
|
10133
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
9688
10134
|
* @example
|
|
9689
10135
|
* ```js
|
|
9690
10136
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9692,7 +10138,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9692
10138
|
* activeTabId:'id-1234',
|
|
9693
10139
|
* })
|
|
9694
10140
|
* ```
|
|
9695
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
9696
10141
|
*/
|
|
9697
10142
|
activeTabId?: string;
|
|
9698
10143
|
/**
|
|
@@ -9701,6 +10146,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9701
10146
|
* that includes specific filter selections.
|
|
9702
10147
|
*
|
|
9703
10148
|
* Supported embed types: `LiveboardEmbed`
|
|
10149
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9704
10150
|
* @example
|
|
9705
10151
|
* ```js
|
|
9706
10152
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9709,7 +10155,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9709
10155
|
* activeTabId: 'tab-guid',
|
|
9710
10156
|
* })
|
|
9711
10157
|
* ```
|
|
9712
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9713
10158
|
*/
|
|
9714
10159
|
personalizedViewId?: string;
|
|
9715
10160
|
/**
|
|
@@ -9730,13 +10175,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9730
10175
|
* Show a preview image of the visualization before the visualization loads.
|
|
9731
10176
|
* Only works for visualizations embeds with a viz id.
|
|
9732
10177
|
*
|
|
9733
|
-
* Also, viz
|
|
10178
|
+
* Also, viz snapshot should be enabled in the ThoughtSpot instance.
|
|
9734
10179
|
* Contact ThoughtSpot support to enable this feature.
|
|
9735
10180
|
*
|
|
9736
|
-
* Since
|
|
10181
|
+
* Since this will show preview images, be careful that it may show
|
|
9737
10182
|
* undesired data to the user when using row level security.
|
|
9738
10183
|
*
|
|
9739
10184
|
* Supported embed types: `LiveboardEmbed`
|
|
10185
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
9740
10186
|
* @example
|
|
9741
10187
|
* ```js
|
|
9742
10188
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9746,7 +10192,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9746
10192
|
* });
|
|
9747
10193
|
* embed.render();
|
|
9748
10194
|
* ```
|
|
9749
|
-
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
9750
10195
|
*/
|
|
9751
10196
|
showPreviewLoader?: boolean;
|
|
9752
10197
|
/**
|
|
@@ -9754,13 +10199,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9754
10199
|
*
|
|
9755
10200
|
* Supported embed types: `LiveboardEmbed`
|
|
9756
10201
|
* @hidden
|
|
9757
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10202
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
9758
10203
|
* @example
|
|
9759
10204
|
* ```js
|
|
9760
10205
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9761
10206
|
* ... //other embed view config
|
|
9762
|
-
* oAuthPollingInterval:
|
|
10207
|
+
* oAuthPollingInterval: 30000,
|
|
9763
10208
|
* })
|
|
10209
|
+
* ```
|
|
9764
10210
|
*/
|
|
9765
10211
|
oAuthPollingInterval?: number;
|
|
9766
10212
|
/**
|
|
@@ -9768,35 +10214,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9768
10214
|
*
|
|
9769
10215
|
* Supported embed types: `LiveboardEmbed`
|
|
9770
10216
|
* @hidden
|
|
9771
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10217
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
9772
10218
|
* @example
|
|
9773
10219
|
* ```js
|
|
9774
10220
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9775
10221
|
* ... //other embed view config
|
|
9776
10222
|
* isForceRedirect: false,
|
|
9777
10223
|
* })
|
|
10224
|
+
* ```
|
|
9778
10225
|
*/
|
|
9779
10226
|
isForceRedirect?: boolean;
|
|
9780
10227
|
/**
|
|
9781
10228
|
* The source connection ID for authentication.
|
|
9782
|
-
* @hidden
|
|
9783
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
9784
10229
|
*
|
|
9785
10230
|
* Supported embed types: `LiveboardEmbed`
|
|
10231
|
+
* @hidden
|
|
10232
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
9786
10233
|
* @example
|
|
9787
10234
|
* ```js
|
|
9788
10235
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9789
10236
|
* ... //other embed view config
|
|
9790
10237
|
* dataSourceId: '',
|
|
9791
10238
|
* })
|
|
10239
|
+
* ```
|
|
9792
10240
|
*/
|
|
9793
10241
|
dataSourceId?: string;
|
|
9794
10242
|
/**
|
|
9795
|
-
* The list of tab IDs to hide from the embedded.
|
|
9796
|
-
*
|
|
9797
|
-
* 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.
|
|
9798
10246
|
*
|
|
9799
10247
|
* Supported embed types: `LiveboardEmbed`
|
|
10248
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
9800
10249
|
* @example
|
|
9801
10250
|
* ```js
|
|
9802
10251
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9807,7 +10256,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9807
10256
|
* ]
|
|
9808
10257
|
* });
|
|
9809
10258
|
* ```
|
|
9810
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
9811
10259
|
*/
|
|
9812
10260
|
hiddenTabs?: string[];
|
|
9813
10261
|
/**
|
|
@@ -9831,7 +10279,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9831
10279
|
*/
|
|
9832
10280
|
visibleTabs?: string[];
|
|
9833
10281
|
/**
|
|
9834
|
-
* 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.
|
|
9835
10284
|
*
|
|
9836
10285
|
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
|
|
9837
10286
|
* @type {boolean}
|
|
@@ -9897,6 +10346,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9897
10346
|
/**
|
|
9898
10347
|
* This flag is used to enable the full height lazy load data.
|
|
9899
10348
|
*
|
|
10349
|
+
* @type {boolean}
|
|
10350
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10351
|
+
* @default false
|
|
9900
10352
|
* @example
|
|
9901
10353
|
* ```js
|
|
9902
10354
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -9905,33 +10357,29 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9905
10357
|
* lazyLoadingForFullHeight: true,
|
|
9906
10358
|
* })
|
|
9907
10359
|
* ```
|
|
9908
|
-
*
|
|
9909
|
-
* @type {boolean}
|
|
9910
|
-
* @default false
|
|
9911
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9912
10360
|
*/
|
|
9913
10361
|
lazyLoadingForFullHeight?: boolean;
|
|
9914
10362
|
/**
|
|
9915
10363
|
* The margin to be used for lazy loading.
|
|
9916
10364
|
*
|
|
9917
10365
|
* For example, if the margin is set to '10px',
|
|
9918
|
-
* the visualization will be loaded 10px before
|
|
10366
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
9919
10367
|
* viewport.
|
|
9920
10368
|
*
|
|
9921
10369
|
* The format is similar to CSS margin.
|
|
9922
10370
|
*
|
|
10371
|
+
* @type {string}
|
|
10372
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9923
10373
|
* @example
|
|
9924
10374
|
* ```js
|
|
9925
10375
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
9926
10376
|
* // ...other options
|
|
9927
10377
|
* fullHeight: true,
|
|
9928
10378
|
* lazyLoadingForFullHeight: true,
|
|
9929
|
-
* // 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.
|
|
9930
10380
|
* lazyLoadingMargin: '0px',
|
|
9931
10381
|
* })
|
|
9932
10382
|
* ```
|
|
9933
|
-
* @type {string}
|
|
9934
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9935
10383
|
*/
|
|
9936
10384
|
lazyLoadingMargin?: string;
|
|
9937
10385
|
/**
|
|
@@ -9939,6 +10387,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9939
10387
|
* of the spotter underneath the chat input.
|
|
9940
10388
|
* default is false.
|
|
9941
10389
|
*
|
|
10390
|
+
* @type {boolean}
|
|
10391
|
+
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
9942
10392
|
* @example
|
|
9943
10393
|
* ```js
|
|
9944
10394
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -9946,14 +10396,13 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9946
10396
|
* showSpotterLimitations: true,
|
|
9947
10397
|
* })
|
|
9948
10398
|
* ```
|
|
9949
|
-
* @type {boolean}
|
|
9950
|
-
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
9951
10399
|
*/
|
|
9952
10400
|
showSpotterLimitations?: boolean;
|
|
9953
10401
|
/**
|
|
9954
10402
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9955
10403
|
*
|
|
9956
10404
|
* Supported embed types: `LiveboardEmbed`
|
|
10405
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9957
10406
|
* @default false
|
|
9958
10407
|
* @example
|
|
9959
10408
|
* ```js
|
|
@@ -9962,7 +10411,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9962
10411
|
* updatedSpotterChatPrompt : true,
|
|
9963
10412
|
* })
|
|
9964
10413
|
* ```
|
|
9965
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9966
10414
|
*/
|
|
9967
10415
|
updatedSpotterChatPrompt?: boolean;
|
|
9968
10416
|
/**
|
|
@@ -9970,6 +10418,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9970
10418
|
* branding in tool response cards.
|
|
9971
10419
|
*
|
|
9972
10420
|
* Supported embed types: `LiveboardEmbed`
|
|
10421
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9973
10422
|
* @example
|
|
9974
10423
|
* ```js
|
|
9975
10424
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9980,7 +10429,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9980
10429
|
* },
|
|
9981
10430
|
* })
|
|
9982
10431
|
* ```
|
|
9983
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9984
10432
|
*/
|
|
9985
10433
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
9986
10434
|
}
|
|
@@ -9988,6 +10436,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9988
10436
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
9989
10437
|
* waits for the authentication to complete, so you need not wait for
|
|
9990
10438
|
* `AuthStatus.SUCCESS`.
|
|
10439
|
+
* @group Embed components
|
|
9991
10440
|
* @example
|
|
9992
10441
|
* ```js
|
|
9993
10442
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -9997,7 +10446,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9997
10446
|
* // .. other params here.
|
|
9998
10447
|
* })
|
|
9999
10448
|
* ```
|
|
10000
|
-
* @group Embed components
|
|
10001
10449
|
*/
|
|
10002
10450
|
export declare class LiveboardEmbed extends V1Embed {
|
|
10003
10451
|
protected viewConfig: LiveboardViewConfig;
|
|
@@ -10117,7 +10565,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10117
10565
|
* but can be expanded manually.
|
|
10118
10566
|
*
|
|
10119
10567
|
* Supported embed types: `SearchEmbed`
|
|
10120
|
-
* @version
|
|
10568
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10121
10569
|
* @example
|
|
10122
10570
|
* ```js
|
|
10123
10571
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10132,7 +10580,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10132
10580
|
* but can be expanded manually.
|
|
10133
10581
|
*
|
|
10134
10582
|
* Supported embed types: `SearchEmbed`
|
|
10135
|
-
* @version
|
|
10583
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
10136
10584
|
* @example
|
|
10137
10585
|
* ```js
|
|
10138
10586
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10146,7 +10594,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10146
10594
|
* Show or hide the data sources panel.
|
|
10147
10595
|
*
|
|
10148
10596
|
* Supported embed types: `SearchEmbed`
|
|
10149
|
-
* @version
|
|
10597
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
10150
10598
|
* @example
|
|
10151
10599
|
* ```js
|
|
10152
10600
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10162,7 +10610,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10162
10610
|
* using raw answer data.
|
|
10163
10611
|
*
|
|
10164
10612
|
* Supported embed types: `SearchEmbed`
|
|
10165
|
-
* @version
|
|
10613
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
10166
10614
|
* @example
|
|
10167
10615
|
* ```js
|
|
10168
10616
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10191,7 +10639,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10191
10639
|
* format for presenting search data.
|
|
10192
10640
|
*
|
|
10193
10641
|
* Supported embed types: `SearchEmbed`
|
|
10194
|
-
* @version
|
|
10642
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10195
10643
|
* @example
|
|
10196
10644
|
* ```js
|
|
10197
10645
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10204,6 +10652,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10204
10652
|
/**
|
|
10205
10653
|
* The array of data source GUIDs to set on load.
|
|
10206
10654
|
* Only a single data source is supported currently.
|
|
10655
|
+
* Use {@link dataSource} instead.
|
|
10207
10656
|
* @deprecated Use `dataSource` instead.
|
|
10208
10657
|
*
|
|
10209
10658
|
* Supported embed types: `SearchEmbed`
|
|
@@ -10217,10 +10666,10 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10217
10666
|
*/
|
|
10218
10667
|
dataSources?: string[];
|
|
10219
10668
|
/**
|
|
10220
|
-
* The
|
|
10669
|
+
* The data source GUID to set on load.
|
|
10221
10670
|
*
|
|
10222
10671
|
* Supported embed types: `SearchEmbed`
|
|
10223
|
-
* @version
|
|
10672
|
+
* @version SDK: 1.19.0
|
|
10224
10673
|
* @example
|
|
10225
10674
|
* ```js
|
|
10226
10675
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10232,9 +10681,9 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10232
10681
|
dataSource?: string;
|
|
10233
10682
|
/**
|
|
10234
10683
|
* The initial search query to load the answer with.
|
|
10684
|
+
* Use {@link searchOptions} instead.
|
|
10235
10685
|
* @deprecated
|
|
10236
10686
|
*
|
|
10237
|
-
* Use {@link searchOptions} instead.
|
|
10238
10687
|
*/
|
|
10239
10688
|
searchQuery?: string;
|
|
10240
10689
|
/**
|
|
@@ -10263,7 +10712,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10263
10712
|
* If set to true, the search token string is not appended to the URL.
|
|
10264
10713
|
*
|
|
10265
10714
|
* Supported embed types: `SearchEmbed`
|
|
10266
|
-
* @version
|
|
10715
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
10267
10716
|
* @example
|
|
10268
10717
|
* ```js
|
|
10269
10718
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10280,7 +10729,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10280
10729
|
* The GUID of a saved answer to load initially.
|
|
10281
10730
|
*
|
|
10282
10731
|
* Supported embed types: `SearchEmbed`
|
|
10283
|
-
* @version
|
|
10732
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10284
10733
|
* @example
|
|
10285
10734
|
* ```js
|
|
10286
10735
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10309,14 +10758,14 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10309
10758
|
* Flag to set if last selected dataSource should be used
|
|
10310
10759
|
*
|
|
10311
10760
|
* Supported embed types: `SearchEmbed`
|
|
10312
|
-
* @version
|
|
10761
|
+
* @version SDK: 1.24.0
|
|
10313
10762
|
*/
|
|
10314
10763
|
useLastSelectedSources?: boolean;
|
|
10315
10764
|
/**
|
|
10316
10765
|
* To set the initial state of the search bar in case of saved-answers.
|
|
10317
|
-
* @default false
|
|
10318
10766
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10319
10767
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
10768
|
+
* @default false
|
|
10320
10769
|
*/
|
|
10321
10770
|
collapseSearchBarInitially?: boolean;
|
|
10322
10771
|
/**
|
|
@@ -10404,8 +10853,8 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10404
10853
|
* Only a single data source is supported currently.
|
|
10405
10854
|
*
|
|
10406
10855
|
* Supported embed types: `SearchBarEmbed`
|
|
10856
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
10407
10857
|
* @deprecated Use `dataSource` instead
|
|
10408
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
10409
10858
|
* @example
|
|
10410
10859
|
* ```js
|
|
10411
10860
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10419,7 +10868,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10419
10868
|
* Pass the ID of the source to be selected.
|
|
10420
10869
|
*
|
|
10421
10870
|
* Supported embed types: `SearchBarEmbed`
|
|
10422
|
-
* @version
|
|
10871
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
10423
10872
|
* @example
|
|
10424
10873
|
* ```js
|
|
10425
10874
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10433,7 +10882,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10433
10882
|
* Boolean to define if the last selected data source should be used
|
|
10434
10883
|
*
|
|
10435
10884
|
* Supported embed types: `SearchBarEmbed`
|
|
10436
|
-
* @version
|
|
10885
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.0.sw
|
|
10437
10886
|
* @example
|
|
10438
10887
|
* ```js
|
|
10439
10888
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10455,7 +10904,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10455
10904
|
* the token string in the search bar.
|
|
10456
10905
|
*
|
|
10457
10906
|
* Supported embed types: `SearchBarEmbed`
|
|
10458
|
-
* @version
|
|
10907
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
10459
10908
|
* @example
|
|
10460
10909
|
* ```js
|
|
10461
10910
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10473,10 +10922,10 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10473
10922
|
* If set to true, the search token string is not appended to the URL.
|
|
10474
10923
|
*
|
|
10475
10924
|
* Supported embed types: `SearchBarEmbed`
|
|
10476
|
-
* @version
|
|
10925
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
10477
10926
|
* @example
|
|
10478
10927
|
* ```js
|
|
10479
|
-
* const embed = new
|
|
10928
|
+
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
10480
10929
|
* searchOptions: {
|
|
10481
10930
|
* searchTokenString: '[quantity purchased] [region]',
|
|
10482
10931
|
* executeSearch: true,
|
|
@@ -10492,7 +10941,7 @@ interface SearchAppInitData$1 extends DefaultAppInitData {
|
|
|
10492
10941
|
}
|
|
10493
10942
|
/**
|
|
10494
10943
|
* Embed ThoughtSpot search bar
|
|
10495
|
-
* @version
|
|
10944
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
10496
10945
|
* @group Embed components
|
|
10497
10946
|
*/
|
|
10498
10947
|
export declare class SearchBarEmbed extends TsEmbed {
|
|
@@ -10530,8 +10979,8 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, "prima
|
|
|
10530
10979
|
}
|
|
10531
10980
|
/**
|
|
10532
10981
|
* Configuration for conversation options.
|
|
10533
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10534
10982
|
* Use {@link SpotterAgentEmbedViewConfig} instead
|
|
10983
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10535
10984
|
* @group Embed components
|
|
10536
10985
|
*/
|
|
10537
10986
|
export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
|
|
@@ -10554,6 +11003,8 @@ declare class ConversationMessage extends TsEmbed {
|
|
|
10554
11003
|
/**
|
|
10555
11004
|
* Create a conversation embed, which can be integrated inside
|
|
10556
11005
|
* chatbots or other conversational interfaces.
|
|
11006
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
11007
|
+
* @group Embed components
|
|
10557
11008
|
* @example
|
|
10558
11009
|
* ```js
|
|
10559
11010
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -10567,8 +11018,6 @@ declare class ConversationMessage extends TsEmbed {
|
|
|
10567
11018
|
* // append the container to the DOM
|
|
10568
11019
|
* document.body.appendChild(container); // or to any other element
|
|
10569
11020
|
* ```
|
|
10570
|
-
* @group Embed components
|
|
10571
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
10572
11021
|
*/
|
|
10573
11022
|
export declare class SpotterAgentEmbed {
|
|
10574
11023
|
private viewConfig;
|
|
@@ -10606,8 +11055,9 @@ export declare class SpotterAgentEmbed {
|
|
|
10606
11055
|
/**
|
|
10607
11056
|
* Create a conversation embed, which can be integrated inside
|
|
10608
11057
|
* chatbots or other conversational interfaces.
|
|
10609
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10610
11058
|
* Use {@link SpotterAgentEmbed} instead
|
|
11059
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
11060
|
+
* @group Embed components
|
|
10611
11061
|
* @example
|
|
10612
11062
|
* ```js
|
|
10613
11063
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -10621,7 +11071,6 @@ export declare class SpotterAgentEmbed {
|
|
|
10621
11071
|
* // append the container to the DOM
|
|
10622
11072
|
* document.body.appendChild(container); // or to any other element
|
|
10623
11073
|
* ```
|
|
10624
|
-
* @group Embed components
|
|
10625
11074
|
*/
|
|
10626
11075
|
export declare class BodylessConversation extends SpotterAgentEmbed {
|
|
10627
11076
|
constructor(viewConfig: BodylessConversationViewConfig);
|
|
@@ -10666,7 +11115,7 @@ interface SearchOptions$2 {
|
|
|
10666
11115
|
/**
|
|
10667
11116
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
10668
11117
|
* GPT and LLM.
|
|
10669
|
-
* @version
|
|
11118
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
10670
11119
|
*
|
|
10671
11120
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
10672
11121
|
* @group Embed components
|
|
@@ -10720,14 +11169,14 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
10720
11169
|
hideAutocompleteSuggestions?: boolean;
|
|
10721
11170
|
/**
|
|
10722
11171
|
* Show or hide autocomplete suggestions for the search query string.
|
|
11172
|
+
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
10723
11173
|
* @deprecated
|
|
10724
11174
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
10725
|
-
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
10726
11175
|
*/
|
|
10727
11176
|
showObjectSuggestions?: boolean;
|
|
10728
11177
|
/**
|
|
10729
11178
|
* Show or hide sample questions.
|
|
10730
|
-
* The sample questions are autogenerated based on the data
|
|
11179
|
+
* The sample questions are autogenerated based on the data model
|
|
10731
11180
|
* selected for the search operation.
|
|
10732
11181
|
*
|
|
10733
11182
|
* Supported embed types: `SageEmbed`
|
|
@@ -10757,6 +11206,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
10757
11206
|
* the token string in the search bar.
|
|
10758
11207
|
*
|
|
10759
11208
|
* Supported embed types: `SageEmbed`
|
|
11209
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
10760
11210
|
* @example
|
|
10761
11211
|
* ```js
|
|
10762
11212
|
* searchOptions: {
|
|
@@ -10764,13 +11214,12 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
10764
11214
|
* executeSearch: true,
|
|
10765
11215
|
* }
|
|
10766
11216
|
* ```
|
|
10767
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
10768
11217
|
*/
|
|
10769
11218
|
searchOptions?: SearchOptions$2;
|
|
10770
11219
|
}
|
|
10771
11220
|
/**
|
|
10772
11221
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
10773
|
-
* @version
|
|
11222
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
10774
11223
|
*
|
|
10775
11224
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
10776
11225
|
* @group Embed components
|
|
@@ -10885,7 +11334,7 @@ export declare function uploadMixpanelEvent(eventId: string, eventProps?: {}): v
|
|
|
10885
11334
|
* tokenizedFetch("<TS_ORIGIN>/api/rest/2.0/auth/session/user", {
|
|
10886
11335
|
* // .. fetch options ..
|
|
10887
11336
|
* });
|
|
10888
|
-
|
|
11337
|
+
* ```
|
|
10889
11338
|
* @version SDK: 1.28.0
|
|
10890
11339
|
* @group Global methods
|
|
10891
11340
|
*/
|