@thoughtspot/visual-embed-sdk 1.23.0-alpha.0 → 1.24.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/css-variables.d.ts +1 -1
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +6 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +4 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +12 -0
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +15 -0
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +13 -3
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/sage.spec.js +1 -1
- package/cjs/src/embed/sage.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +11 -1
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +69 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/types.d.ts +956 -199
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +914 -180
- package/cjs/src/types.js.map +1 -1
- package/dist/src/css-variables.d.ts +1 -1
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +6 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +15 -0
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +956 -199
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +943 -186
- package/dist/tsembed-react.js +925 -178
- package/dist/tsembed.es.js +943 -186
- package/dist/tsembed.js +925 -178
- package/dist/visual-embed-sdk-react-full.d.ts +991 -213
- package/dist/visual-embed-sdk-react.d.ts +991 -213
- package/dist/visual-embed-sdk.d.ts +994 -216
- package/lib/package.json +1 -1
- package/lib/src/css-variables.d.ts +1 -1
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/liveboard.d.ts +6 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +4 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +12 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +15 -0
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +13 -3
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/sage.spec.js +1 -1
- package/lib/src/embed/sage.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +11 -1
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +69 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/types.d.ts +956 -199
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +914 -180
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +994 -216
- package/package.json +1 -1
- package/src/css-variables.ts +1 -1
- package/src/embed/liveboard.spec.ts +16 -0
- package/src/embed/liveboard.ts +10 -0
- package/src/embed/sage.spec.ts +1 -1
- package/src/embed/sage.ts +25 -2
- package/src/embed/ts-embed.spec.ts +79 -0
- package/src/embed/ts-embed.ts +13 -1
- package/src/types.ts +969 -199
package/lib/src/types.d.ts
CHANGED
|
@@ -163,7 +163,7 @@ export declare enum AuthType {
|
|
|
163
163
|
* .then((data) => data.token);
|
|
164
164
|
* }
|
|
165
165
|
* ```
|
|
166
|
-
* @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1
|
|
166
|
+
* @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
|
|
167
167
|
*/
|
|
168
168
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
169
169
|
/**
|
|
@@ -334,7 +334,7 @@ export interface EmbedConfig {
|
|
|
334
334
|
*
|
|
335
335
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
336
336
|
*
|
|
337
|
-
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1
|
|
337
|
+
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
|
|
338
338
|
*/
|
|
339
339
|
redirectPath?: string;
|
|
340
340
|
/** @internal */
|
|
@@ -376,14 +376,14 @@ export interface EmbedConfig {
|
|
|
376
376
|
* This flag is typically used alongside the combination of auth modes such as {@link
|
|
377
377
|
* AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
|
|
378
378
|
*
|
|
379
|
-
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
379
|
+
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
380
380
|
* @default false
|
|
381
381
|
*/
|
|
382
382
|
disableLoginRedirect?: boolean;
|
|
383
383
|
/**
|
|
384
384
|
* This message is displayed on the embed view when the login fails.
|
|
385
385
|
*
|
|
386
|
-
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
386
|
+
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
387
387
|
*/
|
|
388
388
|
loginFailedMessage?: string;
|
|
389
389
|
/**
|
|
@@ -405,7 +405,7 @@ export interface EmbedConfig {
|
|
|
405
405
|
* Dynamic CSS Url to be injected in the loaded application.
|
|
406
406
|
* You would also need to set `style-src` in the CSP settings.
|
|
407
407
|
*
|
|
408
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
408
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
409
409
|
* @default ''
|
|
410
410
|
*/
|
|
411
411
|
customCssUrl?: string;
|
|
@@ -417,13 +417,13 @@ export interface EmbedConfig {
|
|
|
417
417
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
418
418
|
* involves an extra network call.
|
|
419
419
|
*
|
|
420
|
-
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
420
|
+
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
421
421
|
*/
|
|
422
422
|
detectCookieAccessSlow?: boolean;
|
|
423
423
|
/**
|
|
424
424
|
* Hide beta alert warning message for SearchEmbed.
|
|
425
425
|
*
|
|
426
|
-
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1
|
|
426
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
427
427
|
*/
|
|
428
428
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
429
429
|
/**
|
|
@@ -471,7 +471,7 @@ export interface EmbedConfig {
|
|
|
471
471
|
* Disable Full App access of Embedded app outside of the iFrame.
|
|
472
472
|
*
|
|
473
473
|
* @default true
|
|
474
|
-
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1
|
|
474
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
475
475
|
*/
|
|
476
476
|
blockNonEmbedFullAppAccess?: boolean;
|
|
477
477
|
/**
|
|
@@ -574,14 +574,14 @@ export interface ViewConfig {
|
|
|
574
574
|
*
|
|
575
575
|
* Use either this or hiddenActions.
|
|
576
576
|
*
|
|
577
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
577
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
578
578
|
* @important
|
|
579
579
|
*/
|
|
580
580
|
visibleActions?: Action[];
|
|
581
581
|
/**
|
|
582
582
|
* Show alert messages and toast messages in the embedded view.
|
|
583
583
|
*
|
|
584
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
584
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
585
585
|
*/
|
|
586
586
|
showAlerts?: boolean;
|
|
587
587
|
/**
|
|
@@ -592,7 +592,7 @@ export interface ViewConfig {
|
|
|
592
592
|
/**
|
|
593
593
|
* The locale/language to use for the embedded view.
|
|
594
594
|
*
|
|
595
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1
|
|
595
|
+
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
596
596
|
*/
|
|
597
597
|
locale?: string;
|
|
598
598
|
/**
|
|
@@ -603,7 +603,7 @@ export interface ViewConfig {
|
|
|
603
603
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
604
604
|
* list of supported keys and values associated with each.
|
|
605
605
|
*
|
|
606
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
606
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
607
607
|
*/
|
|
608
608
|
additionalFlags?: {
|
|
609
609
|
[key: string]: string | number | boolean;
|
|
@@ -612,7 +612,7 @@ export interface ViewConfig {
|
|
|
612
612
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
613
613
|
* You would also need to set `style-src` in the CSP settings.
|
|
614
614
|
*
|
|
615
|
-
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1
|
|
615
|
+
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
616
616
|
* @default ''
|
|
617
617
|
*/
|
|
618
618
|
customizations?: CustomisationsInterface;
|
|
@@ -660,24 +660,60 @@ export interface ViewConfig {
|
|
|
660
660
|
/**
|
|
661
661
|
* Boolean to hide liveboard header
|
|
662
662
|
*
|
|
663
|
-
* @version SDK: 1.
|
|
663
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
664
664
|
* @default false
|
|
665
665
|
*/
|
|
666
666
|
hideLiveboardHeader?: boolean;
|
|
667
667
|
/**
|
|
668
668
|
* Boolean to show liveboard title
|
|
669
669
|
*
|
|
670
|
-
* @version SDK: 1.
|
|
670
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
671
671
|
* @default false
|
|
672
672
|
*/
|
|
673
673
|
showLiveboardTitle?: boolean;
|
|
674
674
|
/**
|
|
675
675
|
* Boolean to show liveboard description
|
|
676
676
|
*
|
|
677
|
-
* @version SDK: 1.
|
|
677
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
678
678
|
* @default false
|
|
679
679
|
*/
|
|
680
680
|
showLiveboardDescription?: boolean;
|
|
681
|
+
/**
|
|
682
|
+
* The list of tab IDs to hide from the embedded.
|
|
683
|
+
* This Tabs will be hidden from their respective LBs.
|
|
684
|
+
* Use this to hide an tabID.
|
|
685
|
+
*
|
|
686
|
+
* @example
|
|
687
|
+
* ```js
|
|
688
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
689
|
+
* ... // other liveboard view config
|
|
690
|
+
* hiddenTabs: [
|
|
691
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
692
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
693
|
+
* });
|
|
694
|
+
* ```
|
|
695
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
696
|
+
*/
|
|
697
|
+
hiddenTabs?: string[];
|
|
698
|
+
/**
|
|
699
|
+
* The list of tab IDs to show in the embedded.
|
|
700
|
+
* Only this Tabs will be shown in their respective LBs.
|
|
701
|
+
* Use this to show an tabID.
|
|
702
|
+
*
|
|
703
|
+
* Use either this or hiddenTabs.
|
|
704
|
+
*
|
|
705
|
+
* @example
|
|
706
|
+
* ```js
|
|
707
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
708
|
+
* ... // other liveboard view config
|
|
709
|
+
* visibleTabs: [
|
|
710
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
711
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
712
|
+
* });
|
|
713
|
+
* ```
|
|
714
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
715
|
+
*/
|
|
716
|
+
visibleTabs?: string[];
|
|
681
717
|
}
|
|
682
718
|
/**
|
|
683
719
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
@@ -883,7 +919,7 @@ export declare enum EmbedEvent {
|
|
|
883
919
|
* One or more data columns have been selected.
|
|
884
920
|
*
|
|
885
921
|
* @returns columnIds - the list of columns
|
|
886
|
-
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
922
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
887
923
|
*/
|
|
888
924
|
AddRemoveColumns = "addRemoveColumns",
|
|
889
925
|
/**
|
|
@@ -916,7 +952,7 @@ export declare enum EmbedEvent {
|
|
|
916
952
|
* });
|
|
917
953
|
* ```
|
|
918
954
|
* @return viz, clickedPoint - metadata about point that is clicked
|
|
919
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
955
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
920
956
|
* @important
|
|
921
957
|
*/
|
|
922
958
|
VizPointClick = "vizPointClick",
|
|
@@ -966,7 +1002,7 @@ export declare enum EmbedEvent {
|
|
|
966
1002
|
* Emitted when the "Get Data" button in Search Bar embed
|
|
967
1003
|
* is clicked.
|
|
968
1004
|
*
|
|
969
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0
|
|
1005
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
970
1006
|
*/
|
|
971
1007
|
GetDataClick = "getDataClick",
|
|
972
1008
|
/**
|
|
@@ -996,13 +1032,13 @@ export declare enum EmbedEvent {
|
|
|
996
1032
|
/**
|
|
997
1033
|
* Emitted when any modal is opened in the app
|
|
998
1034
|
*
|
|
999
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
1035
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1000
1036
|
*/
|
|
1001
1037
|
DialogOpen = "dialog-open",
|
|
1002
1038
|
/**
|
|
1003
1039
|
* Emitted when any modal is closed in the app
|
|
1004
1040
|
*
|
|
1005
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
1041
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1006
1042
|
*/
|
|
1007
1043
|
DialogClose = "dialog-close",
|
|
1008
1044
|
/**
|
|
@@ -1010,136 +1046,136 @@ export declare enum EmbedEvent {
|
|
|
1010
1046
|
* You can use this event as a hook to trigger
|
|
1011
1047
|
* other events on the rendered Liveboard.
|
|
1012
1048
|
*
|
|
1013
|
-
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
1049
|
+
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1014
1050
|
*/
|
|
1015
1051
|
LiveboardRendered = "PinboardRendered",
|
|
1016
1052
|
/**
|
|
1017
1053
|
* This can be used to register an event listener which
|
|
1018
1054
|
* is triggered on all events.
|
|
1019
1055
|
*
|
|
1020
|
-
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
1056
|
+
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1021
1057
|
*/
|
|
1022
1058
|
ALL = "*",
|
|
1023
1059
|
/**
|
|
1024
|
-
* Emitted when
|
|
1060
|
+
* Emitted when an Answer is saved in the app
|
|
1025
1061
|
*
|
|
1026
|
-
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1062
|
+
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1027
1063
|
*/
|
|
1028
1064
|
Save = "save",
|
|
1029
1065
|
/**
|
|
1030
1066
|
* Emitted when the download action is triggered on an answer
|
|
1031
1067
|
*
|
|
1032
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1068
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1033
1069
|
*/
|
|
1034
1070
|
Download = "download",
|
|
1035
1071
|
/**
|
|
1036
1072
|
* Emitted when the download action is triggered on an answer
|
|
1037
1073
|
*
|
|
1038
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0
|
|
1074
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
1039
1075
|
*/
|
|
1040
1076
|
DownloadAsPng = "downloadAsPng",
|
|
1041
1077
|
/**
|
|
1042
1078
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
1043
1079
|
*
|
|
1044
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1080
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1045
1081
|
*/
|
|
1046
1082
|
DownloadAsPdf = "downloadAsPdf",
|
|
1047
1083
|
/**
|
|
1048
1084
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
1049
1085
|
*
|
|
1050
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1086
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1051
1087
|
*/
|
|
1052
1088
|
DownloadAsCsv = "downloadAsCsv",
|
|
1053
1089
|
/**
|
|
1054
1090
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
1055
1091
|
*
|
|
1056
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1092
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1057
1093
|
*/
|
|
1058
1094
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
1059
1095
|
/**
|
|
1060
1096
|
* Emitted when an answer is deleted in the app
|
|
1061
1097
|
*
|
|
1062
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1098
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1063
1099
|
*/
|
|
1064
1100
|
AnswerDelete = "answerDelete",
|
|
1065
1101
|
/**
|
|
1066
1102
|
* Emitted when an answer is pinned to a Liveboard
|
|
1067
1103
|
*
|
|
1068
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1104
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1069
1105
|
*/
|
|
1070
1106
|
Pin = "pin",
|
|
1071
1107
|
/**
|
|
1072
1108
|
* Emitted when SpotIQ analysis is triggered
|
|
1073
1109
|
*
|
|
1074
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1110
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1075
1111
|
*/
|
|
1076
1112
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
1077
1113
|
/**
|
|
1078
1114
|
* Emitted when a user shares an object with another user or group
|
|
1079
1115
|
*
|
|
1080
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1116
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1081
1117
|
*/
|
|
1082
1118
|
Share = "share",
|
|
1083
1119
|
/**
|
|
1084
1120
|
* Emitted when a user clicks the Include action to include a specific value or data
|
|
1085
1121
|
* on a chart or table
|
|
1086
1122
|
*
|
|
1087
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1123
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1088
1124
|
*/
|
|
1089
1125
|
DrillInclude = "context-menu-item-include",
|
|
1090
1126
|
/**
|
|
1091
1127
|
* Emitted when a user clicks the Exclude action to exclude a specific value or data
|
|
1092
1128
|
* on a chart or table
|
|
1093
1129
|
*
|
|
1094
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1130
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1095
1131
|
*/
|
|
1096
1132
|
DrillExclude = "context-menu-item-exclude",
|
|
1097
1133
|
/**
|
|
1098
1134
|
* Emitted when copied column value on the app
|
|
1099
1135
|
*
|
|
1100
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1136
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1101
1137
|
*/
|
|
1102
1138
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
1103
1139
|
/**
|
|
1104
1140
|
* Emitted when a user clicks the Update TML action
|
|
1105
1141
|
*
|
|
1106
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1142
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1107
1143
|
*/
|
|
1108
1144
|
UpdateTML = "updateTSL",
|
|
1109
1145
|
/**
|
|
1110
1146
|
* Emitted when a user clicks the Edit TML action
|
|
1111
1147
|
*
|
|
1112
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1148
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1113
1149
|
*/
|
|
1114
1150
|
EditTML = "editTSL",
|
|
1115
1151
|
/**
|
|
1116
1152
|
* Emitted when ExportTML trigger in answer on the app
|
|
1117
1153
|
*
|
|
1118
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1154
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1119
1155
|
*/
|
|
1120
1156
|
ExportTML = "exportTSL",
|
|
1121
1157
|
/**
|
|
1122
1158
|
* Emitted when an answer is saved as a view
|
|
1123
1159
|
*
|
|
1124
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1160
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1125
1161
|
*/
|
|
1126
1162
|
SaveAsView = "saveAsView",
|
|
1127
1163
|
/**
|
|
1128
1164
|
* Emitted when copy of existing answer on the app
|
|
1129
1165
|
*
|
|
1130
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1166
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1131
1167
|
*/
|
|
1132
1168
|
CopyAEdit = "copyAEdit",
|
|
1133
1169
|
/**
|
|
1134
1170
|
* Emitted when a user clicks Show underlying data on an answe
|
|
1135
1171
|
*
|
|
1136
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1172
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1137
1173
|
*/
|
|
1138
1174
|
ShowUnderlyingData = "showUnderlyingData",
|
|
1139
1175
|
/**
|
|
1140
1176
|
* Emitted when an answer is switched to a chart or table view
|
|
1141
1177
|
*
|
|
1142
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1178
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1143
1179
|
*/
|
|
1144
1180
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
1145
1181
|
/**
|
|
@@ -1151,67 +1187,67 @@ export declare enum EmbedEvent {
|
|
|
1151
1187
|
/**
|
|
1152
1188
|
* Emitted when a user clicks Show Liveboard details on a Liveboard
|
|
1153
1189
|
*
|
|
1154
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1190
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1155
1191
|
*/
|
|
1156
1192
|
LiveboardInfo = "pinboardInfo",
|
|
1157
1193
|
/**
|
|
1158
1194
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1159
1195
|
*
|
|
1160
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1196
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1161
1197
|
*/
|
|
1162
1198
|
AddToFavorites = "addToFavorites",
|
|
1163
1199
|
/**
|
|
1164
1200
|
* Emitted when a user clicks Schedule on a Liveboard
|
|
1165
1201
|
*
|
|
1166
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1202
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1167
1203
|
*/
|
|
1168
1204
|
Schedule = "subscription",
|
|
1169
1205
|
/**
|
|
1170
1206
|
* Emitted when a user clicks Edit on a Liveboard or visualization
|
|
1171
1207
|
*
|
|
1172
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1208
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1173
1209
|
*/
|
|
1174
1210
|
Edit = "edit",
|
|
1175
1211
|
/**
|
|
1176
1212
|
* Emitted when a user clicks Make a copy on a Liveboard
|
|
1177
1213
|
*
|
|
1178
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1214
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1179
1215
|
*/
|
|
1180
1216
|
MakeACopy = "makeACopy",
|
|
1181
1217
|
/**
|
|
1182
1218
|
* Emitted when a user clicks Present on a Liveboard or visualization
|
|
1183
1219
|
*
|
|
1184
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1220
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1185
1221
|
*/
|
|
1186
1222
|
Present = "present",
|
|
1187
1223
|
/**
|
|
1188
1224
|
* Emitted when a user clicks Delete on a Liveboard
|
|
1189
1225
|
*
|
|
1190
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1226
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1191
1227
|
*/
|
|
1192
1228
|
Delete = "delete",
|
|
1193
1229
|
/**
|
|
1194
1230
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1195
1231
|
*
|
|
1196
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1232
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1197
1233
|
*/
|
|
1198
1234
|
SchedulesList = "schedule-list",
|
|
1199
1235
|
/**
|
|
1200
1236
|
* Emitted when a user clicks Cancel in edit mode on a Liveboard
|
|
1201
1237
|
*
|
|
1202
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1238
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1203
1239
|
*/
|
|
1204
1240
|
Cancel = "cancel",
|
|
1205
1241
|
/**
|
|
1206
1242
|
* Emitted when a user clicks Explore on a visualization
|
|
1207
1243
|
*
|
|
1208
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1244
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1209
1245
|
*/
|
|
1210
1246
|
Explore = "explore",
|
|
1211
1247
|
/**
|
|
1212
1248
|
* Emitted when a user clicks Copy link action on a visualization
|
|
1213
1249
|
*
|
|
1214
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1250
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1215
1251
|
*/
|
|
1216
1252
|
CopyLink = "embedDocument",
|
|
1217
1253
|
/**
|
|
@@ -1231,7 +1267,25 @@ export declare enum EmbedEvent {
|
|
|
1231
1267
|
*
|
|
1232
1268
|
* @hidden
|
|
1233
1269
|
*/
|
|
1234
|
-
InsertIntoSlide = "insertInToSlide"
|
|
1270
|
+
InsertIntoSlide = "insertInToSlide",
|
|
1271
|
+
/**
|
|
1272
|
+
* Emitted when a user changes any filter on a Liveboard.
|
|
1273
|
+
*
|
|
1274
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1275
|
+
*/
|
|
1276
|
+
FilterChanged = "filterChanged",
|
|
1277
|
+
/**
|
|
1278
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
1279
|
+
*
|
|
1280
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
1281
|
+
*/
|
|
1282
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
1283
|
+
/**
|
|
1284
|
+
* Emitten when a user select data source in Sage Embed
|
|
1285
|
+
*
|
|
1286
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
1287
|
+
*/
|
|
1288
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
1235
1289
|
}
|
|
1236
1290
|
/**
|
|
1237
1291
|
* Event types that can be triggered by the host application
|
|
@@ -1257,13 +1311,15 @@ export declare enum EmbedEvent {
|
|
|
1257
1311
|
*/
|
|
1258
1312
|
export declare enum HostEvent {
|
|
1259
1313
|
/**
|
|
1260
|
-
*
|
|
1314
|
+
* Triggers a search query in AppEmbed and SearchEmbed
|
|
1315
|
+
* deployments.
|
|
1316
|
+
* Includes the following properties:
|
|
1261
1317
|
*
|
|
1262
1318
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
1263
1319
|
* - Although an array, only a single source
|
|
1264
|
-
* is supported
|
|
1265
|
-
* @param - searchQuery -
|
|
1266
|
-
* @param - execute -
|
|
1320
|
+
* is supported.
|
|
1321
|
+
* @param - searchQuery - Query string with search tokens
|
|
1322
|
+
* @param - execute - executes the existing / updated query
|
|
1267
1323
|
* @example
|
|
1268
1324
|
* ```js
|
|
1269
1325
|
* searchEmbed.trigger(HostEvent.Search, {
|
|
@@ -1275,13 +1331,14 @@ export declare enum HostEvent {
|
|
|
1275
1331
|
*/
|
|
1276
1332
|
Search = "search",
|
|
1277
1333
|
/**
|
|
1278
|
-
*
|
|
1334
|
+
* Triggers a drill on certain points of the specified column
|
|
1335
|
+
* Includes the following properties:
|
|
1279
1336
|
*
|
|
1280
1337
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
1281
|
-
*
|
|
1282
|
-
* @param - columnGuid -
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1338
|
+
* to drill to. For example, { selectedPoints: []}
|
|
1339
|
+
* @param - columnGuid - Optional. GUID of the column to drill
|
|
1340
|
+
* by. If not provided it will auto drill by the configured
|
|
1341
|
+
* column.
|
|
1285
1342
|
* @example
|
|
1286
1343
|
* ```js
|
|
1287
1344
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -1314,17 +1371,17 @@ export declare enum HostEvent {
|
|
|
1314
1371
|
*/
|
|
1315
1372
|
Reload = "reload",
|
|
1316
1373
|
/**
|
|
1317
|
-
*
|
|
1374
|
+
* Sets the visible visualizations on a Liveboard.
|
|
1318
1375
|
*
|
|
1319
|
-
* @param -
|
|
1320
|
-
*
|
|
1376
|
+
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
1377
|
+
* in this parameter will be hidden.
|
|
1321
1378
|
* @example
|
|
1322
1379
|
* ```js
|
|
1323
1380
|
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
|
|
1324
1381
|
* '730496d6-6903-4601-937e-2c691821af3c',
|
|
1325
1382
|
* 'd547ec54-2a37-4516-a222-2b06719af726'])
|
|
1326
1383
|
* ```
|
|
1327
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
1384
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1328
1385
|
*/
|
|
1329
1386
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
1330
1387
|
/**
|
|
@@ -1341,8 +1398,18 @@ export declare enum HostEvent {
|
|
|
1341
1398
|
*/
|
|
1342
1399
|
SetActiveTab = "SetActiveTab",
|
|
1343
1400
|
/**
|
|
1344
|
-
*
|
|
1345
|
-
*
|
|
1401
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
1402
|
+
* runtime filters passed here are appended to the existing runtime
|
|
1403
|
+
* filters.
|
|
1404
|
+
* Pass an array of runtime filters with the following attributes:
|
|
1405
|
+
* `columnName`
|
|
1406
|
+
* _String_. The name of the column to filter on.
|
|
1407
|
+
* `operator`
|
|
1408
|
+
* Runtime filter operator to apply. For information,
|
|
1409
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
1410
|
+
* `values`
|
|
1411
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
1412
|
+
* operators such as BW and IN accept multiple operands.
|
|
1346
1413
|
*
|
|
1347
1414
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
1348
1415
|
* @example
|
|
@@ -1352,12 +1419,12 @@ export declare enum HostEvent {
|
|
|
1352
1419
|
* {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
|
|
1353
1420
|
* ])
|
|
1354
1421
|
* ```
|
|
1355
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
1422
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1356
1423
|
* @important
|
|
1357
1424
|
*/
|
|
1358
1425
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
1359
1426
|
/**
|
|
1360
|
-
* Navigate to a specific page in
|
|
1427
|
+
* Navigate to a specific page in the embedded application without reloading the page.
|
|
1361
1428
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
1362
1429
|
*
|
|
1363
1430
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
@@ -1365,12 +1432,12 @@ export declare enum HostEvent {
|
|
|
1365
1432
|
* ```js
|
|
1366
1433
|
* appEmbed.navigateToPage(-1)
|
|
1367
1434
|
* ```
|
|
1368
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1
|
|
1435
|
+
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
1369
1436
|
*/
|
|
1370
1437
|
Navigate = "Navigate",
|
|
1371
1438
|
/**
|
|
1372
1439
|
* Opens the filter panel for a particular column.
|
|
1373
|
-
* Works with Search embed.
|
|
1440
|
+
* Works with Search and Liveboard embed.
|
|
1374
1441
|
*
|
|
1375
1442
|
* @param - { columnId: string,
|
|
1376
1443
|
* name: string,
|
|
@@ -1379,233 +1446,257 @@ export declare enum HostEvent {
|
|
|
1379
1446
|
* @example
|
|
1380
1447
|
* ```js
|
|
1381
1448
|
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
1382
|
-
*
|
|
1449
|
+
* { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
|
|
1450
|
+
* LiveboardEmbed.trigger(HostEvent.OpenFilter,
|
|
1451
|
+
* { columnId: '<column-GUID>'})
|
|
1383
1452
|
* ```
|
|
1384
1453
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1385
1454
|
*/
|
|
1386
1455
|
OpenFilter = "openFilter",
|
|
1387
1456
|
/**
|
|
1388
|
-
* Adds
|
|
1457
|
+
* Adds columns to the current search query.
|
|
1389
1458
|
*
|
|
1390
1459
|
* @param - { columnIds: string[] }
|
|
1391
1460
|
* @example
|
|
1392
1461
|
* ```js
|
|
1393
|
-
* searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['
|
|
1462
|
+
* searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
|
|
1394
1463
|
* ```
|
|
1395
1464
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1396
1465
|
*/
|
|
1397
1466
|
AddColumns = "addColumns",
|
|
1398
1467
|
/**
|
|
1399
|
-
* Removes a column from the current
|
|
1468
|
+
* Removes a column from the current search query.
|
|
1400
1469
|
*
|
|
1401
1470
|
* @param - { columnId: string }
|
|
1402
1471
|
* @example
|
|
1403
1472
|
* ```js
|
|
1404
|
-
* searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '
|
|
1473
|
+
* searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
|
|
1405
1474
|
* ```
|
|
1406
1475
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1407
1476
|
*/
|
|
1408
1477
|
RemoveColumn = "removeColumn",
|
|
1409
1478
|
/**
|
|
1410
|
-
* Gets the current
|
|
1479
|
+
* Gets the current Liveboard content.
|
|
1411
1480
|
*
|
|
1412
1481
|
* @example
|
|
1413
1482
|
* ```js
|
|
1414
1483
|
* liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
|
|
1415
1484
|
* ```
|
|
1416
|
-
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1
|
|
1485
|
+
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
1417
1486
|
*/
|
|
1418
1487
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
1419
1488
|
/**
|
|
1420
|
-
* Triggers the Pin action on an embedded object
|
|
1489
|
+
* Triggers the **Pin** action on an embedded object
|
|
1421
1490
|
*
|
|
1422
|
-
* @param -
|
|
1423
|
-
*
|
|
1491
|
+
* @param - Liveboard embed takes the `vizId` as a
|
|
1492
|
+
* key. Can be left undefined when embedding Search, full app or
|
|
1493
|
+
* a visualization.
|
|
1424
1494
|
* @example
|
|
1425
1495
|
* ```js
|
|
1426
1496
|
* liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1497
|
+
* ```
|
|
1498
|
+
* ```js
|
|
1427
1499
|
* vizEmbed.trigger(HostEvent.Pin)
|
|
1500
|
+
* ```
|
|
1501
|
+
* ```js
|
|
1428
1502
|
* searchEmbed.trigger(HostEvent.Pin)
|
|
1429
1503
|
* ```
|
|
1430
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1504
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1431
1505
|
*/
|
|
1432
1506
|
Pin = "pin",
|
|
1433
1507
|
/**
|
|
1434
|
-
* Triggers the Show Liveboard details action on a Liveboard
|
|
1508
|
+
* Triggers the **Show Liveboard details** action on a Liveboard
|
|
1435
1509
|
*
|
|
1436
1510
|
* @example
|
|
1437
1511
|
* ```js
|
|
1438
1512
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
1439
1513
|
* ```
|
|
1440
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1514
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1441
1515
|
*/
|
|
1442
1516
|
LiveboardInfo = "pinboardInfo",
|
|
1443
1517
|
/**
|
|
1444
|
-
* Triggers the Schedule action on a Liveboard
|
|
1518
|
+
* Triggers the **Schedule** action on a Liveboard
|
|
1445
1519
|
*
|
|
1446
1520
|
* @example
|
|
1447
1521
|
* ```js
|
|
1448
1522
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
1449
1523
|
* ```
|
|
1450
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1524
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1451
1525
|
*/
|
|
1452
1526
|
Schedule = "subscription",
|
|
1453
1527
|
/**
|
|
1454
|
-
* Triggers the Manage schedule action on a Liveboard
|
|
1528
|
+
* Triggers the **Manage schedule** action on a Liveboard
|
|
1455
1529
|
*
|
|
1456
1530
|
* @example
|
|
1457
1531
|
* ```js
|
|
1458
1532
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
1459
1533
|
* ```
|
|
1460
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1534
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1461
1535
|
*/
|
|
1462
1536
|
SchedulesList = "schedule-list",
|
|
1463
1537
|
/**
|
|
1464
|
-
* Triggers the Export TML action on a Liveboard
|
|
1538
|
+
* Triggers the **Export TML** action on a Liveboard
|
|
1465
1539
|
*
|
|
1466
1540
|
* @example
|
|
1467
1541
|
* ```js
|
|
1468
1542
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
1469
1543
|
* ```
|
|
1470
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1544
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1471
1545
|
*/
|
|
1472
1546
|
ExportTML = "exportTSL",
|
|
1473
1547
|
/**
|
|
1474
|
-
* Triggers the Edit TML action on a Liveboard
|
|
1548
|
+
* Triggers the **Edit TML** action on a Liveboard
|
|
1475
1549
|
*
|
|
1476
1550
|
* @example
|
|
1477
1551
|
* ```js
|
|
1478
1552
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
1479
1553
|
* ```
|
|
1480
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1554
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1481
1555
|
*/
|
|
1482
1556
|
EditTML = "editTSL",
|
|
1483
1557
|
/**
|
|
1484
|
-
* Triggers the Update TML action on a Liveboard
|
|
1558
|
+
* Triggers the **Update TML** action on a Liveboard
|
|
1485
1559
|
*
|
|
1486
1560
|
* @example
|
|
1487
1561
|
* ```js
|
|
1488
1562
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
1489
1563
|
* ```
|
|
1490
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1564
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1491
1565
|
*/
|
|
1492
1566
|
UpdateTML = "updateTSL",
|
|
1493
1567
|
/**
|
|
1494
|
-
* Triggers the Download PDF action on a Liveboard
|
|
1568
|
+
* Triggers the **Download PDF** action on a Liveboard
|
|
1495
1569
|
*
|
|
1496
1570
|
* @example
|
|
1497
1571
|
* ```js
|
|
1498
1572
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
1499
1573
|
* ```
|
|
1500
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1574
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1501
1575
|
*/
|
|
1502
1576
|
DownloadAsPdf = "downloadAsPdf",
|
|
1503
1577
|
/**
|
|
1504
|
-
* Triggers the Make a copy action on a Liveboard,
|
|
1578
|
+
* Triggers the **Make a copy** action on a Liveboard, Search, or
|
|
1579
|
+
* visualization page
|
|
1505
1580
|
*
|
|
1506
1581
|
* @example
|
|
1507
1582
|
* ```js
|
|
1508
1583
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1584
|
+
* ```
|
|
1585
|
+
* ```js
|
|
1509
1586
|
* vizEmbed.trigger(HostEvent.MakeACopy)
|
|
1587
|
+
* ```
|
|
1588
|
+
* ```js
|
|
1510
1589
|
* searchEmbed.trigger(HostEvent.MakeACopy)
|
|
1511
1590
|
* ```
|
|
1512
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1591
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1513
1592
|
*/
|
|
1514
1593
|
MakeACopy = "makeACopy",
|
|
1515
1594
|
/**
|
|
1516
|
-
* Triggers the Delete action on a Liveboard
|
|
1595
|
+
* Triggers the **Delete** action on a Liveboard
|
|
1517
1596
|
*
|
|
1518
1597
|
* @example
|
|
1519
1598
|
* ```js
|
|
1520
1599
|
* appEmbed.trigger(HostEvent.Remove)
|
|
1521
1600
|
* ```
|
|
1522
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1601
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1523
1602
|
*/
|
|
1524
1603
|
Remove = "delete",
|
|
1525
1604
|
/**
|
|
1526
|
-
* Triggers the Explore action on a visualization
|
|
1605
|
+
* Triggers the **Explore* action on a visualization
|
|
1527
1606
|
*
|
|
1528
|
-
* @param - an object with vizId as a key
|
|
1607
|
+
* @param - an object with `vizId` as a key
|
|
1529
1608
|
* @example
|
|
1530
1609
|
* ```js
|
|
1531
1610
|
* liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1532
1611
|
* ```
|
|
1533
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1612
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1534
1613
|
*/
|
|
1535
1614
|
Explore = "explore",
|
|
1536
1615
|
/**
|
|
1537
|
-
* Triggers the Create alert action on a visualization
|
|
1616
|
+
* Triggers the **Create alert** action on a visualization
|
|
1538
1617
|
*
|
|
1539
|
-
* @param - an object with vizId as a key
|
|
1618
|
+
* @param - an object with `vizId` as a key
|
|
1540
1619
|
* @example
|
|
1541
1620
|
* ```js
|
|
1542
1621
|
* liveboardEmbed.trigger(HostEvent.CreateMonitor {
|
|
1543
1622
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1544
1623
|
* })
|
|
1545
1624
|
* ```
|
|
1546
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1625
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1547
1626
|
*/
|
|
1548
1627
|
CreateMonitor = "createMonitor",
|
|
1549
1628
|
/**
|
|
1550
|
-
* Triggers the Manage
|
|
1629
|
+
* Triggers the **Manage alerts** action on a visualization
|
|
1551
1630
|
*
|
|
1552
|
-
* @param - an object with vizId as a key
|
|
1631
|
+
* @param - an object with `vizId` as a key
|
|
1553
1632
|
* @example
|
|
1554
1633
|
* ```js
|
|
1555
1634
|
* liveboardEmbed.trigger(HostEvent.ManageMonitor, {
|
|
1556
1635
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1557
1636
|
* })
|
|
1558
1637
|
* ```
|
|
1559
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1638
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1560
1639
|
*/
|
|
1561
1640
|
ManageMonitor = "manageMonitor",
|
|
1562
1641
|
/**
|
|
1563
|
-
* Triggers the Edit action on a Liveboard or visualization
|
|
1642
|
+
* Triggers the **Edit** action on a Liveboard or visualization
|
|
1564
1643
|
*
|
|
1565
|
-
* @param - object -
|
|
1566
|
-
*
|
|
1644
|
+
* @param - object - To trigger the action for a specific visualization
|
|
1645
|
+
* in Liveboard embed, pass in `vizId` as a key.
|
|
1646
|
+
* Can be left undefined when embedding Search, full app, or
|
|
1647
|
+
* a visualization.
|
|
1567
1648
|
* @example
|
|
1568
1649
|
* ```js
|
|
1569
1650
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
1570
|
-
*
|
|
1651
|
+
* ```
|
|
1652
|
+
* ```js
|
|
1571
1653
|
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
1572
1654
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1573
|
-
*
|
|
1655
|
+
* ```
|
|
1656
|
+
* ```js
|
|
1574
1657
|
* vizEmbed.trigger((HostEvent.Edit)
|
|
1575
1658
|
* ```
|
|
1576
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1659
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1577
1660
|
*/
|
|
1578
1661
|
Edit = "edit",
|
|
1579
1662
|
/**
|
|
1580
|
-
* Triggers the Copy link action on a Liveboard or visualization
|
|
1663
|
+
* Triggers the **Copy link** action on a Liveboard or visualization
|
|
1581
1664
|
*
|
|
1582
|
-
* @param - object - to trigger the action for a
|
|
1583
|
-
*
|
|
1665
|
+
* @param - object - to trigger the action for a
|
|
1666
|
+
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
1584
1667
|
* @example
|
|
1585
1668
|
* ```js
|
|
1586
1669
|
* liveboardEmbed.trigger(HostEvent.CopyLink)
|
|
1670
|
+
* ```
|
|
1671
|
+
* ```js
|
|
1587
1672
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1673
|
+
* ```
|
|
1674
|
+
* ```js
|
|
1588
1675
|
* vizEmbed.trigger((HostEvent.CopyLink)
|
|
1589
1676
|
* ```
|
|
1590
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1677
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1591
1678
|
*/
|
|
1592
1679
|
CopyLink = "embedDocument",
|
|
1593
1680
|
/**
|
|
1594
|
-
* Triggers the Present action on a Liveboard or visualization
|
|
1681
|
+
* Triggers the **Present** action on a Liveboard or visualization
|
|
1595
1682
|
*
|
|
1596
|
-
* @param - object - to trigger the action for a
|
|
1597
|
-
* in Liveboard embed, pass in vizId as a key
|
|
1683
|
+
* @param - object - to trigger the action for a specific visualization
|
|
1684
|
+
* in Liveboard embed, pass in `vizId` as a key
|
|
1598
1685
|
* @example
|
|
1599
1686
|
* ```js
|
|
1600
1687
|
* liveboardEmbed.trigger(HostEvent.Present)
|
|
1688
|
+
* ```
|
|
1689
|
+
* ```js
|
|
1601
1690
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1691
|
+
* ```
|
|
1692
|
+
* ```js
|
|
1602
1693
|
* vizEmbed.trigger((HostEvent.Present)
|
|
1603
1694
|
* ```
|
|
1604
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1695
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1605
1696
|
*/
|
|
1606
1697
|
Present = "present",
|
|
1607
1698
|
/**
|
|
1608
|
-
*
|
|
1699
|
+
* Gets TML for the current search.
|
|
1609
1700
|
*
|
|
1610
1701
|
* @example
|
|
1611
1702
|
* ```js
|
|
@@ -1615,78 +1706,90 @@ export declare enum HostEvent {
|
|
|
1615
1706
|
* );
|
|
1616
1707
|
* })
|
|
1617
1708
|
* ```
|
|
1618
|
-
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1
|
|
1709
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
1619
1710
|
* @important
|
|
1620
1711
|
*/
|
|
1621
1712
|
GetTML = "getTML",
|
|
1622
1713
|
/**
|
|
1623
|
-
* Triggers the
|
|
1714
|
+
* Triggers the **Show underlying data** action on visualization or search
|
|
1624
1715
|
*
|
|
1625
1716
|
* @param - an object with vizId as a key
|
|
1626
1717
|
* @example
|
|
1627
1718
|
* ```js
|
|
1628
1719
|
* liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
|
|
1629
1720
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1630
|
-
*
|
|
1721
|
+
* ```
|
|
1722
|
+
* ```js
|
|
1631
1723
|
* vizEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
1632
|
-
*
|
|
1724
|
+
* ```
|
|
1725
|
+
* ```js
|
|
1633
1726
|
* searchEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
1634
1727
|
* ```
|
|
1635
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1728
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1636
1729
|
*/
|
|
1637
1730
|
ShowUnderlyingData = "showUnderlyingData",
|
|
1638
1731
|
/**
|
|
1639
|
-
* Triggers the Delete action on visualization or search
|
|
1732
|
+
* Triggers the **Delete** action on visualization or search
|
|
1640
1733
|
*
|
|
1641
|
-
* @param -
|
|
1642
|
-
*
|
|
1734
|
+
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
1735
|
+
* Can be left empty if embedding Search or visualization.
|
|
1643
1736
|
* @example
|
|
1644
1737
|
* ```js
|
|
1645
1738
|
* liveboardEmbed.trigger(HostEvent.Delete, {vizId:
|
|
1646
1739
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1647
|
-
*
|
|
1740
|
+
* ```
|
|
1741
|
+
* ```js
|
|
1648
1742
|
* vizEmbed.trigger(HostEvent.Delete)
|
|
1649
|
-
*
|
|
1743
|
+
* ```
|
|
1744
|
+
* ```js
|
|
1650
1745
|
* searchEmbed.trigger(HostEvent.Delete)
|
|
1651
1746
|
* ```
|
|
1652
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1747
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1653
1748
|
*/
|
|
1654
1749
|
Delete = "onDeleteAnswer",
|
|
1655
1750
|
/**
|
|
1656
|
-
* Triggers the
|
|
1751
|
+
* Triggers the **SpotIQ analyze** action on visualization
|
|
1752
|
+
* or search.
|
|
1657
1753
|
*
|
|
1658
|
-
* @param -
|
|
1659
|
-
*
|
|
1754
|
+
* @param - Liveboard embed takes `vizId` as a
|
|
1755
|
+
* key. Can be left undefined when embedding Search or
|
|
1756
|
+
* visualization.
|
|
1660
1757
|
* @example
|
|
1661
1758
|
* ```js
|
|
1662
1759
|
* liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
|
|
1663
1760
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1664
|
-
*
|
|
1761
|
+
* ```
|
|
1762
|
+
* ```js
|
|
1665
1763
|
* vizEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
1666
|
-
*
|
|
1764
|
+
* ```
|
|
1765
|
+
* ```js
|
|
1667
1766
|
* searchEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
1668
1767
|
* ```
|
|
1669
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1768
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1670
1769
|
*/
|
|
1671
1770
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
1672
1771
|
/**
|
|
1673
|
-
* Triggers the Download action on
|
|
1772
|
+
* Triggers the **Download** action on charts in
|
|
1773
|
+
* the embedded view.
|
|
1674
1774
|
*
|
|
1675
1775
|
* @example
|
|
1676
1776
|
* ```js
|
|
1677
1777
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
1678
1778
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1679
|
-
*
|
|
1779
|
+
* ```
|
|
1780
|
+
* ```js
|
|
1680
1781
|
* vizEmbed.trigger(HostEvent.Download)
|
|
1681
|
-
*
|
|
1782
|
+
* ```
|
|
1783
|
+
* ```js
|
|
1682
1784
|
* searchEmbed.trigger(HostEvent.Download)
|
|
1683
1785
|
* ```
|
|
1684
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1
|
|
1685
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1786
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
|
|
1787
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1686
1788
|
*/
|
|
1687
1789
|
Download = "downloadAsPng",
|
|
1688
1790
|
/**
|
|
1689
|
-
* Triggers the Download action on
|
|
1791
|
+
* Triggers the **Download** > **PNG** action on
|
|
1792
|
+
* charts in the embedded view.
|
|
1690
1793
|
*
|
|
1691
1794
|
* @example
|
|
1692
1795
|
* ```js
|
|
@@ -1697,115 +1800,184 @@ export declare enum HostEvent {
|
|
|
1697
1800
|
*
|
|
1698
1801
|
* searchEmbed.trigger(HostEvent.DownloadAsPng)
|
|
1699
1802
|
* ```
|
|
1700
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1
|
|
1803
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
|
|
1701
1804
|
*/
|
|
1702
1805
|
DownloadAsPng = "downloadAsPng",
|
|
1703
1806
|
/**
|
|
1704
|
-
* Triggers the
|
|
1807
|
+
* Triggers the **Download** > **CSV** action on tables in
|
|
1808
|
+
* the embedded view.
|
|
1705
1809
|
*
|
|
1706
1810
|
* @example
|
|
1707
1811
|
* ```js
|
|
1708
1812
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
1709
1813
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1710
|
-
*
|
|
1814
|
+
* ```
|
|
1815
|
+
* ```js
|
|
1711
1816
|
* vizEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
1712
|
-
*
|
|
1817
|
+
* ```
|
|
1818
|
+
* ```js
|
|
1713
1819
|
* searchEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
1714
1820
|
* ```
|
|
1715
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1821
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1716
1822
|
*/
|
|
1717
1823
|
DownloadAsCsv = "downloadAsCSV",
|
|
1718
1824
|
/**
|
|
1719
|
-
* Triggers the
|
|
1825
|
+
* Triggers the **Download** > **XLSX** action on tables
|
|
1826
|
+
* in the embedded view.
|
|
1720
1827
|
*
|
|
1721
1828
|
* @example
|
|
1722
1829
|
* ```js
|
|
1723
1830
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
1724
1831
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1725
|
-
*
|
|
1832
|
+
* ```
|
|
1833
|
+
* ```js
|
|
1726
1834
|
* vizEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
1727
|
-
*
|
|
1835
|
+
* ```
|
|
1836
|
+
* ```js
|
|
1728
1837
|
* searchEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
1729
1838
|
* ```
|
|
1730
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1839
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1731
1840
|
*/
|
|
1732
1841
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
1733
1842
|
/**
|
|
1734
|
-
* Triggers the Share action on
|
|
1843
|
+
* Triggers the **Share** action on an embedded
|
|
1844
|
+
* Liveboard or Answer.
|
|
1735
1845
|
*
|
|
1736
1846
|
* @example
|
|
1737
1847
|
* ```js
|
|
1738
1848
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
1739
|
-
*
|
|
1849
|
+
* ```
|
|
1850
|
+
* ```js
|
|
1740
1851
|
* searchEmbed.trigger(HostEvent.Share)
|
|
1741
1852
|
* ```
|
|
1742
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1853
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1743
1854
|
*/
|
|
1744
1855
|
Share = "share",
|
|
1745
1856
|
/**
|
|
1746
|
-
*
|
|
1857
|
+
* Triggers the **Save** action on a Liveboard or Answer.
|
|
1858
|
+
* Saves the changes.
|
|
1747
1859
|
*
|
|
1748
1860
|
* @example
|
|
1749
1861
|
* ```js
|
|
1750
1862
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
1751
|
-
*
|
|
1863
|
+
* ```
|
|
1864
|
+
* ```js
|
|
1752
1865
|
* searchEmbed.trigger(HostEvent.Save)
|
|
1753
1866
|
* ```
|
|
1754
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1867
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1755
1868
|
*/
|
|
1756
1869
|
Save = "save",
|
|
1757
1870
|
/**
|
|
1758
|
-
* Triggers the
|
|
1871
|
+
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
1872
|
+
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
1759
1873
|
*
|
|
1760
|
-
* @param - an object with vizId as a key
|
|
1874
|
+
* @param - an object with `vizId` as a key
|
|
1761
1875
|
* @example
|
|
1762
1876
|
* ```js
|
|
1763
1877
|
* liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
|
|
1764
1878
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1765
|
-
*
|
|
1879
|
+
* ```
|
|
1880
|
+
* ```js
|
|
1766
1881
|
* vizEmbed.trigger(HostEvent.SyncToSheets)
|
|
1767
1882
|
* ```
|
|
1768
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1883
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1769
1884
|
*/
|
|
1770
1885
|
SyncToSheets = "sync-to-sheets",
|
|
1771
1886
|
/**
|
|
1772
|
-
* Triggers the
|
|
1887
|
+
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
1888
|
+
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
1889
|
+
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
1773
1890
|
*
|
|
1774
1891
|
* @param - an object with vizId as a key
|
|
1775
1892
|
* @example
|
|
1776
1893
|
* ```js
|
|
1777
1894
|
* liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
|
|
1778
1895
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1779
|
-
*
|
|
1896
|
+
* ```
|
|
1897
|
+
* ```js
|
|
1780
1898
|
* vizEmbed.trigger(HostEvent.SyncToOtherApps)
|
|
1781
1899
|
* ```
|
|
1782
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1900
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1783
1901
|
*/
|
|
1784
1902
|
SyncToOtherApps = "sync-to-other-apps",
|
|
1785
1903
|
/**
|
|
1786
|
-
* Triggers the
|
|
1904
|
+
* Triggers the **Manage pipelines** action on an embedded
|
|
1905
|
+
* visualization or Answer.
|
|
1906
|
+
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
1787
1907
|
*
|
|
1788
|
-
* @param - an object with vizId as a key
|
|
1908
|
+
* @param - an object with `vizId` as a key
|
|
1789
1909
|
* @example
|
|
1790
1910
|
* ```js
|
|
1791
1911
|
* liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
|
|
1792
1912
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1793
|
-
*
|
|
1913
|
+
* ```
|
|
1914
|
+
* ```js
|
|
1794
1915
|
* vizEmbed.trigger(HostEvent.ManagePipelines)
|
|
1795
1916
|
* ```
|
|
1796
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1917
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1797
1918
|
*/
|
|
1798
1919
|
ManagePipelines = "manage-pipeline",
|
|
1799
1920
|
/**
|
|
1800
|
-
* Triggers the Reset search
|
|
1921
|
+
* Triggers the Reset search on the Search page
|
|
1801
1922
|
*
|
|
1802
1923
|
* @example
|
|
1803
1924
|
* ```js
|
|
1804
1925
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
1805
1926
|
* ```
|
|
1806
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1
|
|
1927
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
|
|
1807
1928
|
*/
|
|
1808
|
-
ResetSearch = "resetSearch"
|
|
1929
|
+
ResetSearch = "resetSearch",
|
|
1930
|
+
/**
|
|
1931
|
+
* Gets the currents visible and runtime filters applied on a Liveboard
|
|
1932
|
+
*
|
|
1933
|
+
* @example
|
|
1934
|
+
* liveboardEmbed.trigger(HostEvent.GetFilters)
|
|
1935
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1936
|
+
*/
|
|
1937
|
+
GetFilters = "getFilters",
|
|
1938
|
+
/**
|
|
1939
|
+
* Updates the visible filters on the Liveboard.
|
|
1940
|
+
*
|
|
1941
|
+
* @param - filter: filter object containing column name and filter operation and values
|
|
1942
|
+
* @example
|
|
1943
|
+
*
|
|
1944
|
+
* ```js
|
|
1945
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
1946
|
+
* filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
|
|
1947
|
+
* })
|
|
1948
|
+
* ```
|
|
1949
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1950
|
+
*/
|
|
1951
|
+
UpdateFilters = "updateFilters",
|
|
1952
|
+
GetTabs = "getTabs",
|
|
1953
|
+
/**
|
|
1954
|
+
* Set the visible Tabs on a Liveboard.
|
|
1955
|
+
*
|
|
1956
|
+
* @param - an array of ids of Tabs to show, the ids not passed
|
|
1957
|
+
* will be hidden.
|
|
1958
|
+
* @example
|
|
1959
|
+
* ```js
|
|
1960
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
|
|
1961
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1962
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
1963
|
+
* ```
|
|
1964
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
1965
|
+
*/
|
|
1966
|
+
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
1967
|
+
/**
|
|
1968
|
+
* Set the hidden tabs on a Liveboard.
|
|
1969
|
+
*
|
|
1970
|
+
* @param - an array of ids of Tabs to hide, the ids not passed
|
|
1971
|
+
* will be shown.
|
|
1972
|
+
* @example
|
|
1973
|
+
* ```js
|
|
1974
|
+
* liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
|
|
1975
|
+
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
1976
|
+
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
1977
|
+
* ```
|
|
1978
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
1979
|
+
*/
|
|
1980
|
+
SetHiddenTabs = "SetPinboardHiddenTabs"
|
|
1809
1981
|
}
|
|
1810
1982
|
/**
|
|
1811
1983
|
* The different visual modes that the data sources panel within
|
|
@@ -1882,26 +2054,51 @@ export declare enum Param {
|
|
|
1882
2054
|
HideEurekaSuggestions = "hideEurekaSuggestions",
|
|
1883
2055
|
HideLiveboardHeader = "hideLiveboardHeader",
|
|
1884
2056
|
ShowLiveboardDescription = "showLiveboardDescription",
|
|
1885
|
-
ShowLiveboardTitle = "showLiveboardTitle"
|
|
2057
|
+
ShowLiveboardTitle = "showLiveboardTitle",
|
|
2058
|
+
HiddenTabs = "hideTabs",
|
|
2059
|
+
VisibleTabs = "visibleTabs",
|
|
2060
|
+
HideTabPanel = "hideTabPanel",
|
|
2061
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
2062
|
+
WorksheetId = "worksheetId",
|
|
2063
|
+
Query = "query,"
|
|
1886
2064
|
}
|
|
1887
2065
|
/**
|
|
1888
|
-
*
|
|
1889
|
-
*
|
|
1890
|
-
*
|
|
1891
|
-
*
|
|
1892
|
-
*
|
|
2066
|
+
* ThoughtSpot application pages include actions and menu commands
|
|
2067
|
+
* for various user-initiated operations. These actions are represented
|
|
2068
|
+
* as enumeration members in the SDK. To show, hide, or disable
|
|
2069
|
+
* specific actions in the embedded view, define the Action
|
|
2070
|
+
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
2071
|
+
* or `hiddenActions` array.
|
|
1893
2072
|
*
|
|
1894
2073
|
* @example
|
|
1895
2074
|
* ```js
|
|
1896
2075
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1897
2076
|
* ... // other options
|
|
1898
|
-
* visibleActions: [Action.Save, Action.Explore],
|
|
1899
|
-
*
|
|
1900
|
-
* hiddenActions: [
|
|
2077
|
+
* visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
|
|
2078
|
+
* disabledActions: [Action.Download],
|
|
2079
|
+
* //hiddenActions: [], // Set either this or visibleActions
|
|
2080
|
+
* })
|
|
2081
|
+
* ```
|
|
2082
|
+
* @example
|
|
2083
|
+
* ```js
|
|
2084
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
2085
|
+
* ... // other options
|
|
2086
|
+
* //visibleActions: [],
|
|
2087
|
+
* disabledActions: [Action.Download],
|
|
2088
|
+
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
1901
2089
|
* })
|
|
1902
2090
|
* ```
|
|
1903
2091
|
*/
|
|
1904
2092
|
export declare enum Action {
|
|
2093
|
+
/**
|
|
2094
|
+
* The **Save** action on an Answer or Liveboard.
|
|
2095
|
+
* Allows users to save the changes.
|
|
2096
|
+
*
|
|
2097
|
+
* @example
|
|
2098
|
+
* ```js
|
|
2099
|
+
* disabledActions: [Action.SaveAsView]
|
|
2100
|
+
* ```
|
|
2101
|
+
*/
|
|
1905
2102
|
Save = "save",
|
|
1906
2103
|
/**
|
|
1907
2104
|
* @hidden
|
|
@@ -1911,27 +2108,147 @@ export declare enum Action {
|
|
|
1911
2108
|
* @hidden
|
|
1912
2109
|
*/
|
|
1913
2110
|
SaveUntitled = "saveUntitled",
|
|
2111
|
+
/**
|
|
2112
|
+
* The **Save as View** action on the Answer
|
|
2113
|
+
* page. Saves an Answer as a View object.
|
|
2114
|
+
*
|
|
2115
|
+
* @example
|
|
2116
|
+
* ```js
|
|
2117
|
+
* disabledActions: [Action.SaveAsView]
|
|
2118
|
+
* ```
|
|
2119
|
+
*/
|
|
1914
2120
|
SaveAsView = "saveAsView",
|
|
2121
|
+
/**
|
|
2122
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
2123
|
+
* page.
|
|
2124
|
+
* Creates a copy of the Liveboard, visualization,
|
|
2125
|
+
* or Answer.
|
|
2126
|
+
*
|
|
2127
|
+
* @example
|
|
2128
|
+
* ```js
|
|
2129
|
+
* disabledActions: [Action.MakeACopy]
|
|
2130
|
+
* ```
|
|
2131
|
+
*/
|
|
1915
2132
|
MakeACopy = "makeACopy",
|
|
2133
|
+
/**
|
|
2134
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
2135
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
2136
|
+
*
|
|
2137
|
+
* @example
|
|
2138
|
+
* ```js
|
|
2139
|
+
* disabledActions: [Action.EditACopy]
|
|
2140
|
+
* ```
|
|
2141
|
+
*/
|
|
1916
2142
|
EditACopy = "editACopy",
|
|
2143
|
+
/**
|
|
2144
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
2145
|
+
* Copies the visualization URL
|
|
2146
|
+
*
|
|
2147
|
+
* @example
|
|
2148
|
+
* ```js
|
|
2149
|
+
* disabledActions: [Action.CopyLink]
|
|
2150
|
+
* ```
|
|
2151
|
+
*/
|
|
1917
2152
|
CopyLink = "embedDocument",
|
|
1918
2153
|
/**
|
|
1919
2154
|
* @hidden
|
|
1920
2155
|
*/
|
|
1921
2156
|
ResetLayout = "resetLayout",
|
|
2157
|
+
/**
|
|
2158
|
+
* The **Schedule** menu action on a Liveboard.
|
|
2159
|
+
* Allows scheduling a Liveboard notification.
|
|
2160
|
+
*
|
|
2161
|
+
* @example
|
|
2162
|
+
* ```js
|
|
2163
|
+
* disabledActions: [Action.Schedule]
|
|
2164
|
+
* ```
|
|
2165
|
+
*/
|
|
1922
2166
|
Schedule = "subscription",
|
|
2167
|
+
/**
|
|
2168
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
2169
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
2170
|
+
*
|
|
2171
|
+
* @example
|
|
2172
|
+
* ```js
|
|
2173
|
+
* disabledActions: [Action.SchedulesList]
|
|
2174
|
+
* ```
|
|
2175
|
+
*/
|
|
1923
2176
|
SchedulesList = "schedule-list",
|
|
2177
|
+
/**
|
|
2178
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
2179
|
+
* Allows users to share an object with other users and groups.
|
|
2180
|
+
*
|
|
2181
|
+
* @example
|
|
2182
|
+
* ```js
|
|
2183
|
+
* disabledActions: [Action.Share]
|
|
2184
|
+
* ```
|
|
2185
|
+
*/
|
|
1924
2186
|
Share = "share",
|
|
2187
|
+
/**
|
|
2188
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
2189
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
2190
|
+
*
|
|
2191
|
+
* @example
|
|
2192
|
+
* ```js
|
|
2193
|
+
* disabledActions: [Action.AddFilter]
|
|
2194
|
+
* ```
|
|
2195
|
+
*/
|
|
1925
2196
|
AddFilter = "addFilter",
|
|
2197
|
+
/**
|
|
2198
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
2199
|
+
* Allows configuring filter options when adding filters to a
|
|
2200
|
+
* Liveboard or Answer.
|
|
2201
|
+
*
|
|
2202
|
+
* @example
|
|
2203
|
+
* ```js
|
|
2204
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
2205
|
+
* ```
|
|
2206
|
+
*/
|
|
1926
2207
|
ConfigureFilter = "configureFilter",
|
|
1927
2208
|
CollapseDataSources = "collapseDataSources",
|
|
2209
|
+
/**
|
|
2210
|
+
* The **Choose sources** button on Search page.
|
|
2211
|
+
* Allows selecting data sources for search queries.
|
|
2212
|
+
*
|
|
2213
|
+
* @example
|
|
2214
|
+
* ```js
|
|
2215
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
2216
|
+
* ```
|
|
2217
|
+
*/
|
|
1928
2218
|
ChooseDataSources = "chooseDataSources",
|
|
2219
|
+
/**
|
|
2220
|
+
* The **Create formula** action on a Search or Answer page.
|
|
2221
|
+
* Allows adding formulas to an Answer.
|
|
2222
|
+
*
|
|
2223
|
+
* @example
|
|
2224
|
+
* ```js
|
|
2225
|
+
* disabledActions: [Action.AddFormula]
|
|
2226
|
+
* ```
|
|
2227
|
+
*/
|
|
1929
2228
|
AddFormula = "addFormula",
|
|
2229
|
+
/**
|
|
2230
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
2231
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
2232
|
+
*
|
|
2233
|
+
* @example
|
|
2234
|
+
* ```js
|
|
2235
|
+
* disabledActions: [Action.AddParameter]
|
|
2236
|
+
* ```
|
|
2237
|
+
*/
|
|
1930
2238
|
AddParameter = "addParameter",
|
|
1931
2239
|
/**
|
|
1932
2240
|
* @hidden
|
|
1933
2241
|
*/
|
|
1934
2242
|
SearchOnTop = "searchOnTop",
|
|
2243
|
+
/**
|
|
2244
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
2245
|
+
* Answer page.
|
|
2246
|
+
*
|
|
2247
|
+
* @example
|
|
2248
|
+
* ```js
|
|
2249
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
2250
|
+
* ```
|
|
2251
|
+
*/
|
|
1935
2252
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
1936
2253
|
/**
|
|
1937
2254
|
* @hidden
|
|
@@ -1946,24 +2263,165 @@ export declare enum Action {
|
|
|
1946
2263
|
* @hidden
|
|
1947
2264
|
*/
|
|
1948
2265
|
ReplaySearch = "replaySearch",
|
|
2266
|
+
/**
|
|
2267
|
+
* The **Show underlying data** menu action on a visualization or
|
|
2268
|
+
* Answer page.
|
|
2269
|
+
*
|
|
2270
|
+
* @example
|
|
2271
|
+
* ```js
|
|
2272
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
2273
|
+
* ```
|
|
2274
|
+
*/
|
|
1949
2275
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2276
|
+
/**
|
|
2277
|
+
* The **Download** menu action on Liveboard visualizations
|
|
2278
|
+
* and Answers.
|
|
2279
|
+
* Allows downloading a visualization or Answer.
|
|
2280
|
+
*
|
|
2281
|
+
* @example
|
|
2282
|
+
* ```js
|
|
2283
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
2284
|
+
* ```
|
|
2285
|
+
*/
|
|
1950
2286
|
Download = "download",
|
|
2287
|
+
/**
|
|
2288
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
2289
|
+
* or Answer page.
|
|
2290
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
2291
|
+
*
|
|
2292
|
+
* @example
|
|
2293
|
+
* ```js
|
|
2294
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
2295
|
+
* ```
|
|
2296
|
+
*/
|
|
1951
2297
|
DownloadAsPng = "downloadAsPng",
|
|
2298
|
+
/**
|
|
2299
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
2300
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
2301
|
+
*
|
|
2302
|
+
* @example
|
|
2303
|
+
* ```js
|
|
2304
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
2305
|
+
* ```
|
|
2306
|
+
*/
|
|
1952
2307
|
DownloadAsPdf = "downloadAsPdf",
|
|
2308
|
+
/**
|
|
2309
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
2310
|
+
* or Answer page.
|
|
2311
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
2312
|
+
*
|
|
2313
|
+
* @example
|
|
2314
|
+
* ```js
|
|
2315
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
2316
|
+
* ```
|
|
2317
|
+
*/
|
|
1953
2318
|
DownloadAsCsv = "downloadAsCSV",
|
|
2319
|
+
/**
|
|
2320
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
2321
|
+
* or Answer page.
|
|
2322
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
2323
|
+
*
|
|
2324
|
+
* @example
|
|
2325
|
+
* ```js
|
|
2326
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
2327
|
+
* ```
|
|
2328
|
+
*/
|
|
1954
2329
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
1955
2330
|
/**
|
|
1956
2331
|
* @hidden
|
|
1957
2332
|
*/
|
|
1958
2333
|
DownloadTrace = "downloadTrace",
|
|
2334
|
+
/**
|
|
2335
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
2336
|
+
* Worksheets and Data Connections page.
|
|
2337
|
+
* Exports an object as a TML file.
|
|
2338
|
+
*
|
|
2339
|
+
* @example
|
|
2340
|
+
* ```js
|
|
2341
|
+
* disabledActions: [Action.ExportTML]
|
|
2342
|
+
* ```
|
|
2343
|
+
*/
|
|
1959
2344
|
ExportTML = "exportTSL",
|
|
2345
|
+
/**
|
|
2346
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
2347
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
2348
|
+
*
|
|
2349
|
+
* @example
|
|
2350
|
+
* ```js
|
|
2351
|
+
* disabledActions: [Action.ImportTML]
|
|
2352
|
+
* ```
|
|
2353
|
+
*/
|
|
1960
2354
|
ImportTML = "importTSL",
|
|
2355
|
+
/**
|
|
2356
|
+
* The **Update TML** menu action for Liveboards and Answers.
|
|
2357
|
+
* Update TML representation of ThoughtSpot objects.
|
|
2358
|
+
*
|
|
2359
|
+
* @example
|
|
2360
|
+
* ```js
|
|
2361
|
+
* disabledActions: [Action.UpdateTML]
|
|
2362
|
+
* ```
|
|
2363
|
+
*/
|
|
1961
2364
|
UpdateTML = "updateTSL",
|
|
2365
|
+
/**
|
|
2366
|
+
* The **Edit TML** menu action for Liveboards and Answers.
|
|
2367
|
+
* Opens the TML editor.
|
|
2368
|
+
*
|
|
2369
|
+
* @example
|
|
2370
|
+
* ```js
|
|
2371
|
+
* disabledActions: [Action.EditTML]
|
|
2372
|
+
* ```
|
|
2373
|
+
*/
|
|
1962
2374
|
EditTML = "editTSL",
|
|
2375
|
+
/**
|
|
2376
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
2377
|
+
* Allows presenting a Liveboard or visualization in
|
|
2378
|
+
* slideshow mode.
|
|
2379
|
+
*
|
|
2380
|
+
* @example
|
|
2381
|
+
* ```js
|
|
2382
|
+
* disabledActions: [Action.Present]
|
|
2383
|
+
* ```
|
|
2384
|
+
*/
|
|
1963
2385
|
Present = "present",
|
|
2386
|
+
/**
|
|
2387
|
+
* The tile resize options in the visualization menu.
|
|
2388
|
+
* Allows switching between different preset layouts.
|
|
2389
|
+
*
|
|
2390
|
+
* @example
|
|
2391
|
+
* ```js
|
|
2392
|
+
* disabledActions: [Action.ToggleSize]
|
|
2393
|
+
* ```
|
|
2394
|
+
*/
|
|
1964
2395
|
ToggleSize = "toggleSize",
|
|
2396
|
+
/**
|
|
2397
|
+
* The *Edit* action on the Liveboard page and in the
|
|
2398
|
+
* visualization menu.
|
|
2399
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
2400
|
+
*
|
|
2401
|
+
* @example
|
|
2402
|
+
* ```js
|
|
2403
|
+
* disabledActions: [Action.Edit]
|
|
2404
|
+
* ```
|
|
2405
|
+
*/
|
|
1965
2406
|
Edit = "edit",
|
|
2407
|
+
/**
|
|
2408
|
+
* The text edit option for Liveboard and visualization titles.
|
|
2409
|
+
*
|
|
2410
|
+
* @example
|
|
2411
|
+
* ```js
|
|
2412
|
+
* disabledActions: [Action.EditTitle]
|
|
2413
|
+
* ```
|
|
2414
|
+
*/
|
|
1966
2415
|
EditTitle = "editTitle",
|
|
2416
|
+
/**
|
|
2417
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
2418
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
2419
|
+
*
|
|
2420
|
+
* @example
|
|
2421
|
+
* ```js
|
|
2422
|
+
* disabledActions: [Action.Remove]
|
|
2423
|
+
* ```
|
|
2424
|
+
*/
|
|
1967
2425
|
Remove = "delete",
|
|
1968
2426
|
/**
|
|
1969
2427
|
* @hidden
|
|
@@ -1985,6 +2443,17 @@ export declare enum Action {
|
|
|
1985
2443
|
* @hidden
|
|
1986
2444
|
*/
|
|
1987
2445
|
PinboardInfo = "pinboardInfo",
|
|
2446
|
+
/**
|
|
2447
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
2448
|
+
* Displays details such as the name, description, and
|
|
2449
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
2450
|
+
* and update.
|
|
2451
|
+
*
|
|
2452
|
+
* @example
|
|
2453
|
+
* ```js
|
|
2454
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
2455
|
+
* ```
|
|
2456
|
+
*/
|
|
1988
2457
|
LiveboardInfo = "pinboardInfo",
|
|
1989
2458
|
/**
|
|
1990
2459
|
* @hidden
|
|
@@ -1995,20 +2464,67 @@ export declare enum Action {
|
|
|
1995
2464
|
*/
|
|
1996
2465
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
1997
2466
|
/**
|
|
1998
|
-
* Pin action
|
|
2467
|
+
* The **Pin** menu action on an Answer or
|
|
2468
|
+
* Search results page.
|
|
2469
|
+
*
|
|
2470
|
+
* @example
|
|
2471
|
+
* ```js
|
|
2472
|
+
* disabledActions: [Action.Pin]
|
|
2473
|
+
* ```
|
|
1999
2474
|
*/
|
|
2000
2475
|
Pin = "pin",
|
|
2001
2476
|
/**
|
|
2002
2477
|
* @hidden
|
|
2003
2478
|
*/
|
|
2004
2479
|
AnalysisInfo = "analysisInfo",
|
|
2480
|
+
/**
|
|
2481
|
+
* The **Schedule** menu action on a Liveboard.
|
|
2482
|
+
*
|
|
2483
|
+
* @example
|
|
2484
|
+
* ```js
|
|
2485
|
+
* disabledActions: [Action.Subscription]
|
|
2486
|
+
* ```
|
|
2487
|
+
*/
|
|
2005
2488
|
Subscription = "subscription",
|
|
2006
2489
|
/**
|
|
2007
|
-
* Explore action
|
|
2490
|
+
* The **Explore** action on Liveboard visualizations
|
|
2491
|
+
*
|
|
2492
|
+
* @example
|
|
2493
|
+
* ```js
|
|
2494
|
+
* disabledActions: [Action.Explore]
|
|
2495
|
+
* ```
|
|
2008
2496
|
*/
|
|
2009
2497
|
Explore = "explore",
|
|
2498
|
+
/**
|
|
2499
|
+
* The action to include data points on a drilled-down Answer
|
|
2500
|
+
* or visualization
|
|
2501
|
+
*
|
|
2502
|
+
* @example
|
|
2503
|
+
* ```js
|
|
2504
|
+
* disabledActions: [Action.DrillInclude]
|
|
2505
|
+
* ```
|
|
2506
|
+
*/
|
|
2010
2507
|
DrillInclude = "context-menu-item-include",
|
|
2508
|
+
/**
|
|
2509
|
+
* The action to exclude data points on a drilled-down Answer
|
|
2510
|
+
* or visualization
|
|
2511
|
+
*
|
|
2512
|
+
* @example
|
|
2513
|
+
* ```js
|
|
2514
|
+
* disabledActions: [Action.DrillInclude]
|
|
2515
|
+
* ```
|
|
2516
|
+
*/
|
|
2011
2517
|
DrillExclude = "context-menu-item-exclude",
|
|
2518
|
+
/**
|
|
2519
|
+
* The **Copy to clipboard** menu action on tables in an Answer
|
|
2520
|
+
* or Liveboard.
|
|
2521
|
+
* Copies the selected data point.
|
|
2522
|
+
*
|
|
2523
|
+
* @example
|
|
2524
|
+
* ```js
|
|
2525
|
+
* disabledActions: [Action.CopyToClipboard]
|
|
2526
|
+
* ```
|
|
2527
|
+
*/
|
|
2012
2528
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
2013
2529
|
CopyAndEdit = "context-menu-item-copy-and-edit",
|
|
2014
2530
|
/**
|
|
@@ -2017,89 +2533,291 @@ export declare enum Action {
|
|
|
2017
2533
|
DrillEdit = "context-menu-item-edit",
|
|
2018
2534
|
EditMeasure = "context-menu-item-edit-measure",
|
|
2019
2535
|
Separator = "context-menu-item-separator",
|
|
2536
|
+
/**
|
|
2537
|
+
* The **Drill down** menu action on Answers and Liveboard
|
|
2538
|
+
* visualizations.
|
|
2539
|
+
* Allows drilling down to a specific data point on a chart or table.
|
|
2540
|
+
*
|
|
2541
|
+
* @example
|
|
2542
|
+
* ```js
|
|
2543
|
+
* disabledActions: [Action.DrillDown]
|
|
2544
|
+
* ```
|
|
2545
|
+
*/
|
|
2020
2546
|
DrillDown = "DRILL",
|
|
2547
|
+
/**
|
|
2548
|
+
* The request access action on Liveboards.
|
|
2549
|
+
* Allows users with view permissions to request edit access to a Liveboard.
|
|
2550
|
+
*
|
|
2551
|
+
* @example
|
|
2552
|
+
* ```js
|
|
2553
|
+
* disabledActions: [Action.RequestAccess]
|
|
2554
|
+
* ```
|
|
2555
|
+
*/
|
|
2021
2556
|
RequestAccess = "requestAccess",
|
|
2022
|
-
QueryDetailsButtons = "queryDetailsButtons",
|
|
2023
2557
|
/**
|
|
2024
|
-
*
|
|
2558
|
+
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
2559
|
+
* of the Answer page
|
|
2560
|
+
*
|
|
2561
|
+
* @example
|
|
2562
|
+
* ```js
|
|
2563
|
+
* disabledActions: [Action.QueryDetailsButtons]
|
|
2564
|
+
* ```
|
|
2565
|
+
*/
|
|
2566
|
+
QueryDetailsButtons = "QueryDetailsButtons",
|
|
2567
|
+
/**
|
|
2568
|
+
* The **Delete** action for Answers.
|
|
2569
|
+
*
|
|
2570
|
+
* @example
|
|
2571
|
+
* ```js
|
|
2572
|
+
* disabledActions: [Action.AnswerDelete]
|
|
2573
|
+
* ```
|
|
2574
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2025
2575
|
*/
|
|
2026
2576
|
AnswerDelete = "onDeleteAnswer",
|
|
2027
2577
|
/**
|
|
2028
|
-
*
|
|
2578
|
+
* The Chart switcher icon on Answer and visualization pages.
|
|
2579
|
+
*
|
|
2580
|
+
* @example
|
|
2581
|
+
* ```js
|
|
2582
|
+
* disabledActions: [Action.AnswerChartSwitcher]
|
|
2583
|
+
* ```
|
|
2584
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2029
2585
|
*/
|
|
2030
2586
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
2031
2587
|
/**
|
|
2032
|
-
*
|
|
2588
|
+
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
2589
|
+
*
|
|
2590
|
+
* @example
|
|
2591
|
+
* ```js
|
|
2592
|
+
* disabledActions: [Action.AddToFavorites]
|
|
2593
|
+
* ```
|
|
2594
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2033
2595
|
*/
|
|
2034
2596
|
AddToFavorites = "addToFavorites",
|
|
2035
2597
|
/**
|
|
2036
|
-
*
|
|
2598
|
+
* The edit icon on Liveboards (Classic experience).
|
|
2599
|
+
*
|
|
2600
|
+
* @example
|
|
2601
|
+
* ```js
|
|
2602
|
+
* disabledActions: [Action.EditDetails]
|
|
2603
|
+
* ```
|
|
2604
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2037
2605
|
*/
|
|
2038
2606
|
EditDetails = "editDetails",
|
|
2039
2607
|
/**
|
|
2040
|
-
*
|
|
2608
|
+
* The Create alert action on KPI charts.
|
|
2609
|
+
*
|
|
2610
|
+
* @example
|
|
2611
|
+
* ```js
|
|
2612
|
+
* disabledActions: [Action.CreateMonitor ]
|
|
2613
|
+
* ```
|
|
2614
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2041
2615
|
*/
|
|
2042
2616
|
CreateMonitor = "createMonitor",
|
|
2043
2617
|
/**
|
|
2044
|
-
* @
|
|
2618
|
+
* @example
|
|
2619
|
+
* ```js
|
|
2620
|
+
* disabledActions: [Action.ReportError]
|
|
2621
|
+
* ```
|
|
2622
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2045
2623
|
*/
|
|
2046
2624
|
ReportError = "reportError",
|
|
2625
|
+
/**
|
|
2626
|
+
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
2627
|
+
* Allows sending data to a Google Sheet.
|
|
2628
|
+
*
|
|
2629
|
+
* @example
|
|
2630
|
+
* ```js
|
|
2631
|
+
* disabledActions: [Action.SyncToSheets]
|
|
2632
|
+
* ```
|
|
2633
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2634
|
+
*/
|
|
2047
2635
|
SyncToSheets = "sync-to-sheets",
|
|
2636
|
+
/**
|
|
2637
|
+
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
2638
|
+
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
2639
|
+
* Microsoft Teams, and so on.
|
|
2640
|
+
*
|
|
2641
|
+
* @example
|
|
2642
|
+
* ```js
|
|
2643
|
+
* disabledActions: [Action.SyncToOtherApps]
|
|
2644
|
+
* ```
|
|
2645
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2646
|
+
*/
|
|
2048
2647
|
SyncToOtherApps = "sync-to-other-apps",
|
|
2648
|
+
/**
|
|
2649
|
+
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
2650
|
+
* Allows users to manage data sync pipelines to third-party apps.
|
|
2651
|
+
*
|
|
2652
|
+
* @example
|
|
2653
|
+
* ```js
|
|
2654
|
+
* disabledActions: [Action.SyncToOtherApps]
|
|
2655
|
+
* ```
|
|
2656
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2657
|
+
*/
|
|
2049
2658
|
ManagePipelines = "manage-pipeline",
|
|
2050
2659
|
/**
|
|
2660
|
+
* The **Filter** action on Liveboard visualizations.
|
|
2661
|
+
* Allows users to apply cross-filters on a Liveboard.
|
|
2662
|
+
*
|
|
2663
|
+
* @example
|
|
2664
|
+
* ```js
|
|
2665
|
+
* disabledActions: [Action.CrossFilter]
|
|
2666
|
+
* ```
|
|
2051
2667
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2052
2668
|
*/
|
|
2053
2669
|
CrossFilter = "context-menu-item-cross-filter",
|
|
2054
2670
|
/**
|
|
2671
|
+
* The **Remove** action that appears when cross filters are applied
|
|
2672
|
+
* on a Liveboard.
|
|
2673
|
+
* Removes filters applied o a visualization.
|
|
2674
|
+
*
|
|
2675
|
+
* @example
|
|
2676
|
+
* ```js
|
|
2677
|
+
* disabledActions: [Action.RemoveCrossFilter]
|
|
2678
|
+
* ```
|
|
2055
2679
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2056
2680
|
*/
|
|
2057
2681
|
RemoveCrossFilter = "context-menu-item-remove-cross-filter",
|
|
2058
2682
|
/**
|
|
2683
|
+
* The **Aggregate** option in the chart axis or the
|
|
2684
|
+
* table column customization menu.
|
|
2685
|
+
* Provides aggregation options to analyze the data on a chart or table.
|
|
2686
|
+
*
|
|
2687
|
+
* @example
|
|
2688
|
+
* ```js
|
|
2689
|
+
* disabledActions: [Action.AxisMenuAggregate]
|
|
2690
|
+
* ```
|
|
2059
2691
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2060
2692
|
*/
|
|
2061
2693
|
AxisMenuAggregate = "axisMenuAggregate",
|
|
2062
2694
|
/**
|
|
2695
|
+
* The **Time bucket** option in the chart axis or table column
|
|
2696
|
+
* customization menu.
|
|
2697
|
+
* Allows defining time metric for date comparison.
|
|
2698
|
+
*
|
|
2699
|
+
* @example
|
|
2700
|
+
* ```js
|
|
2701
|
+
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
2702
|
+
* ```
|
|
2063
2703
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2064
2704
|
*/
|
|
2065
2705
|
AxisMenuTimeBucket = "axisMenuTimeBucket",
|
|
2066
2706
|
/**
|
|
2707
|
+
* The **Filter** action in the chart axis or table column
|
|
2708
|
+
* customization menu.
|
|
2709
|
+
*
|
|
2710
|
+
* @example
|
|
2711
|
+
* ```js
|
|
2712
|
+
* disabledActions: [Action.AxisMenuFilter]
|
|
2713
|
+
* ```
|
|
2067
2714
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2068
2715
|
*/
|
|
2069
2716
|
AxisMenuFilter = "axisMenuFilter",
|
|
2070
2717
|
/**
|
|
2718
|
+
* The **Conditional formatting** action on chart or table.
|
|
2719
|
+
* Allows adding rules for conditional formatting of data
|
|
2720
|
+
* points on a chart or table.
|
|
2721
|
+
*
|
|
2722
|
+
* @example
|
|
2723
|
+
* ```js
|
|
2724
|
+
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
2725
|
+
* ```
|
|
2071
2726
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2072
2727
|
*/
|
|
2073
2728
|
AxisMenuConditionalFormat = "axisMenuConditionalFormat",
|
|
2074
2729
|
/**
|
|
2730
|
+
* The **Sort** menu action on a table or chart axis
|
|
2731
|
+
* Sorts data in ascending or descending order.
|
|
2732
|
+
* Allows adding, editing, or removing filters.
|
|
2733
|
+
*
|
|
2734
|
+
* @example
|
|
2735
|
+
* ```js
|
|
2736
|
+
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
2737
|
+
* ```
|
|
2075
2738
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2076
2739
|
*/
|
|
2077
2740
|
AxisMenuSort = "axisMenuSort",
|
|
2078
2741
|
/**
|
|
2742
|
+
* The **Group** option in the chart axis or table column
|
|
2743
|
+
* customization menu.
|
|
2744
|
+
* Allows grouping data points if the axes use the same
|
|
2745
|
+
* unit of measurement and a similar scale.
|
|
2746
|
+
*
|
|
2747
|
+
* @example
|
|
2748
|
+
* ```js
|
|
2749
|
+
* disabledActions: [Action.AxisMenuGroup]
|
|
2750
|
+
* ```
|
|
2079
2751
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2080
2752
|
*/
|
|
2081
2753
|
AxisMenuGroup = "axisMenuGroup",
|
|
2082
2754
|
/**
|
|
2755
|
+
* The **Position** option in the axis customization menu.
|
|
2756
|
+
* Allows changing the position of the axis to the
|
|
2757
|
+
* left or right side of the chart.
|
|
2758
|
+
*
|
|
2759
|
+
* @example
|
|
2760
|
+
* ```js
|
|
2761
|
+
* disabledActions: [Action.AxisMenuPosition]
|
|
2762
|
+
* ```
|
|
2083
2763
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2084
2764
|
*/
|
|
2085
2765
|
AxisMenuPosition = "axisMenuPosition",
|
|
2086
2766
|
/**
|
|
2767
|
+
* The **Rename** option in the chart axis or table column customization menu.
|
|
2768
|
+
* Renames the axis label on a chart or the column header on a table.
|
|
2769
|
+
*
|
|
2770
|
+
* @example
|
|
2771
|
+
* ```js
|
|
2772
|
+
* disabledActions: [Action.AxisMenuRename]
|
|
2773
|
+
* ```
|
|
2087
2774
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2088
2775
|
*/
|
|
2089
2776
|
AxisMenuRename = "axisMenuRename",
|
|
2090
2777
|
/**
|
|
2778
|
+
* The **Edit** action in the axis customization menu.
|
|
2779
|
+
* Allows editing the axis name, position, minimum and maximum values,
|
|
2780
|
+
* and format of a column.
|
|
2781
|
+
*
|
|
2782
|
+
* @example
|
|
2783
|
+
* ```js
|
|
2784
|
+
* disabledActions: [Action.AxisMenuEdit]
|
|
2785
|
+
* ```
|
|
2091
2786
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2092
2787
|
*/
|
|
2093
2788
|
AxisMenuEdit = "axisMenuEdit",
|
|
2094
2789
|
/**
|
|
2790
|
+
* The **Number format** action to customize the format of
|
|
2791
|
+
* the data labels on a chart or table.
|
|
2792
|
+
*
|
|
2793
|
+
* @example
|
|
2794
|
+
* ```js
|
|
2795
|
+
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
2796
|
+
* ```
|
|
2095
2797
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2096
2798
|
*/
|
|
2097
2799
|
AxisMenuNumberFormat = "axisMenuNumberFormat",
|
|
2098
2800
|
/**
|
|
2801
|
+
* The **Text wrapping** action on a table.
|
|
2802
|
+
* Wraps or clips column text on a table.
|
|
2803
|
+
*
|
|
2804
|
+
* @example
|
|
2805
|
+
* ```js
|
|
2806
|
+
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
2807
|
+
* ```
|
|
2099
2808
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2100
2809
|
*/
|
|
2101
2810
|
AxisMenuTextWrapping = "axisMenuTextWrapping",
|
|
2102
2811
|
/**
|
|
2812
|
+
* The **Remove** action in the chart axis or table column
|
|
2813
|
+
* customization menu.
|
|
2814
|
+
* Removes the data labels from a chart or the column of a
|
|
2815
|
+
* table visualization.
|
|
2816
|
+
*
|
|
2817
|
+
* @example
|
|
2818
|
+
* ```js
|
|
2819
|
+
* disabledActions: [Action.AxisMenuRemove]
|
|
2820
|
+
* ```
|
|
2103
2821
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2104
2822
|
*/
|
|
2105
2823
|
AxisMenuRemove = "axisMenuRemove",
|
|
@@ -2108,9 +2826,48 @@ export declare enum Action {
|
|
|
2108
2826
|
*/
|
|
2109
2827
|
InsertInToSlide = "insertInToSlide",
|
|
2110
2828
|
/**
|
|
2829
|
+
* The **Rename** menu action on Liveboards and visualizations.
|
|
2830
|
+
* Allows renaming a Liveboard or visualization.
|
|
2831
|
+
*
|
|
2832
|
+
* @example
|
|
2833
|
+
* ```js
|
|
2834
|
+
* disabledActions: [Action.RenameModalTitleDescription]
|
|
2835
|
+
* ```
|
|
2111
2836
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2112
2837
|
*/
|
|
2113
|
-
RenameModalTitleDescription = "renameModalTitleDescription"
|
|
2838
|
+
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
2839
|
+
/**
|
|
2840
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2841
|
+
*/
|
|
2842
|
+
RequestVerification = "requestVerification",
|
|
2843
|
+
/**
|
|
2844
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2845
|
+
*/
|
|
2846
|
+
MarkAsVerified = "markAsVerified",
|
|
2847
|
+
/**
|
|
2848
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2849
|
+
*/
|
|
2850
|
+
AddTab = "addTab",
|
|
2851
|
+
/**
|
|
2852
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2853
|
+
*/
|
|
2854
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
2855
|
+
/**
|
|
2856
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2857
|
+
*/
|
|
2858
|
+
ShowSageQuery = "showSageQuery",
|
|
2859
|
+
/**
|
|
2860
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2861
|
+
*/
|
|
2862
|
+
EditSageAnswer = "editSageAnswer",
|
|
2863
|
+
/**
|
|
2864
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2865
|
+
*/
|
|
2866
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
2867
|
+
/**
|
|
2868
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2869
|
+
*/
|
|
2870
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
2114
2871
|
}
|
|
2115
2872
|
export interface SessionInterface {
|
|
2116
2873
|
sessionId: string;
|