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