@thoughtspot/visual-embed-sdk 1.22.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.
Files changed (69) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/css-variables.d.ts +1 -1
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/liveboard.d.ts +6 -0
  5. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  6. package/cjs/src/embed/liveboard.js +4 -1
  7. package/cjs/src/embed/liveboard.js.map +1 -1
  8. package/cjs/src/embed/liveboard.spec.js +12 -0
  9. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  10. package/cjs/src/embed/sage.d.ts +1 -0
  11. package/cjs/src/embed/sage.d.ts.map +1 -1
  12. package/cjs/src/embed/sage.js +1 -0
  13. package/cjs/src/embed/sage.js.map +1 -1
  14. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  15. package/cjs/src/embed/ts-embed.js +20 -1
  16. package/cjs/src/embed/ts-embed.js.map +1 -1
  17. package/cjs/src/embed/ts-embed.spec.js +69 -0
  18. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  19. package/cjs/src/types.d.ts +890 -210
  20. package/cjs/src/types.d.ts.map +1 -1
  21. package/cjs/src/types.js +830 -194
  22. package/cjs/src/types.js.map +1 -1
  23. package/dist/src/css-variables.d.ts +1 -1
  24. package/dist/src/css-variables.d.ts.map +1 -1
  25. package/dist/src/embed/liveboard.d.ts +6 -0
  26. package/dist/src/embed/liveboard.d.ts.map +1 -1
  27. package/dist/src/embed/sage.d.ts +1 -0
  28. package/dist/src/embed/sage.d.ts.map +1 -1
  29. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  30. package/dist/src/types.d.ts +890 -210
  31. package/dist/src/types.d.ts.map +1 -1
  32. package/dist/tsembed-react.es.js +856 -197
  33. package/dist/tsembed-react.js +837 -188
  34. package/dist/tsembed.es.js +856 -197
  35. package/dist/tsembed.js +837 -188
  36. package/dist/visual-embed-sdk-react-full.d.ts +898 -211
  37. package/dist/visual-embed-sdk-react.d.ts +898 -211
  38. package/dist/visual-embed-sdk.d.ts +898 -211
  39. package/lib/package.json +1 -1
  40. package/lib/src/css-variables.d.ts +1 -1
  41. package/lib/src/css-variables.d.ts.map +1 -1
  42. package/lib/src/embed/liveboard.d.ts +6 -0
  43. package/lib/src/embed/liveboard.d.ts.map +1 -1
  44. package/lib/src/embed/liveboard.js +4 -1
  45. package/lib/src/embed/liveboard.js.map +1 -1
  46. package/lib/src/embed/liveboard.spec.js +12 -0
  47. package/lib/src/embed/liveboard.spec.js.map +1 -1
  48. package/lib/src/embed/sage.d.ts +1 -0
  49. package/lib/src/embed/sage.d.ts.map +1 -1
  50. package/lib/src/embed/sage.js +1 -0
  51. package/lib/src/embed/sage.js.map +1 -1
  52. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  53. package/lib/src/embed/ts-embed.js +20 -1
  54. package/lib/src/embed/ts-embed.js.map +1 -1
  55. package/lib/src/embed/ts-embed.spec.js +69 -0
  56. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  57. package/lib/src/types.d.ts +890 -210
  58. package/lib/src/types.d.ts.map +1 -1
  59. package/lib/src/types.js +830 -194
  60. package/lib/src/types.js.map +1 -1
  61. package/lib/src/visual-embed-sdk.d.ts +898 -211
  62. package/package.json +1 -1
  63. package/src/css-variables.ts +1 -1
  64. package/src/embed/liveboard.spec.ts +16 -0
  65. package/src/embed/liveboard.ts +10 -0
  66. package/src/embed/sage.ts +1 -0
  67. package/src/embed/ts-embed.spec.ts +79 -0
  68. package/src/embed/ts-embed.ts +26 -1
  69. package/src/types.ts +903 -210
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-sw
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-sw
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-sw
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-sw
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-sw
430
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
431
431
  * @default ''
432
432
  */
433
433
  customCssUrl?: string;
@@ -439,13 +439,13 @@ 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-sw
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-sw*
448
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
449
449
  */
450
450
  suppressSearchEmbedBetaWarning?: boolean;
451
451
 
@@ -494,7 +494,7 @@ export interface EmbedConfig {
494
494
  * Disable Full App access of Embedded app outside of the iFrame.
495
495
  *
496
496
  * @default true
497
- * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1-sw
497
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
498
498
  */
499
499
  blockNonEmbedFullAppAccess?: boolean;
500
500
 
@@ -602,14 +602,14 @@ export interface ViewConfig {
602
602
  *
603
603
  * Use either this or hiddenActions.
604
604
  *
605
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
605
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
606
606
  * @important
607
607
  */
608
608
  visibleActions?: Action[];
609
609
  /**
610
610
  * Show alert messages and toast messages in the embedded view.
611
611
  *
612
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
612
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
613
613
  */
614
614
  showAlerts?: boolean;
615
615
  /**
@@ -620,7 +620,7 @@ export interface ViewConfig {
620
620
  /**
621
621
  * The locale/language to use for the embedded view.
622
622
  *
623
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
623
+ * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
624
624
  */
625
625
  locale?: string;
626
626
  /**
@@ -631,14 +631,14 @@ export interface ViewConfig {
631
631
  * to control embed behavior in non-regular ways. We do not publish the
632
632
  * list of supported keys and values associated with each.
633
633
  *
634
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
634
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
635
635
  */
636
636
  additionalFlags?: { [key: string]: string | number | boolean };
637
637
  /**
638
638
  * Dynamic CSSUrl and customCSS to be injected in the loaded application.
639
639
  * You would also need to set `style-src` in the CSP settings.
640
640
  *
641
- * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1-sw, 8.4.0.cl
641
+ * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
642
642
  * @default ''
643
643
  */
644
644
  customizations?: CustomisationsInterface;
@@ -683,6 +683,63 @@ export interface ViewConfig {
683
683
  * @hidden
684
684
  */
685
685
  excludeRuntimeFiltersfromURL?: boolean;
686
+ /**
687
+ * Boolean to hide liveboard header
688
+ *
689
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
690
+ * @default false
691
+ */
692
+ hideLiveboardHeader?: boolean;
693
+ /**
694
+ * Boolean to show liveboard title
695
+ *
696
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
697
+ * @default false
698
+ */
699
+ showLiveboardTitle?: boolean;
700
+ /**
701
+ * Boolean to show liveboard description
702
+ *
703
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
704
+ * @default false
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[];
686
743
  }
687
744
 
688
745
  /**
@@ -903,7 +960,7 @@ export enum EmbedEvent {
903
960
  * One or more data columns have been selected.
904
961
  *
905
962
  * @returns columnIds - the list of columns
906
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
963
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
907
964
  */
908
965
  AddRemoveColumns = 'addRemoveColumns',
909
966
  /**
@@ -936,7 +993,7 @@ export enum EmbedEvent {
936
993
  * });
937
994
  * ```
938
995
  * @return viz, clickedPoint - metadata about point that is clicked
939
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
996
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
940
997
  * @important
941
998
  */
942
999
  VizPointClick = 'vizPointClick',
@@ -986,7 +1043,7 @@ export enum EmbedEvent {
986
1043
  * Emitted when the "Get Data" button in Search Bar embed
987
1044
  * is clicked.
988
1045
  *
989
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
1046
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
990
1047
  */
991
1048
  GetDataClick = 'getDataClick',
992
1049
  /**
@@ -1016,13 +1073,13 @@ export enum EmbedEvent {
1016
1073
  /**
1017
1074
  * Emitted when any modal is opened in the app
1018
1075
  *
1019
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1076
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1020
1077
  */
1021
1078
  DialogOpen = 'dialog-open',
1022
1079
  /**
1023
1080
  * Emitted when any modal is closed in the app
1024
1081
  *
1025
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1082
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1026
1083
  */
1027
1084
  DialogClose = 'dialog-close',
1028
1085
  /**
@@ -1030,136 +1087,136 @@ export enum EmbedEvent {
1030
1087
  * You can use this event as a hook to trigger
1031
1088
  * other events on the rendered Liveboard.
1032
1089
  *
1033
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1090
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1034
1091
  */
1035
1092
  LiveboardRendered = 'PinboardRendered',
1036
1093
  /**
1037
1094
  * This can be used to register an event listener which
1038
1095
  * is triggered on all events.
1039
1096
  *
1040
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1097
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1041
1098
  */
1042
1099
  ALL = '*',
1043
1100
  /**
1044
- * Emitted when answer is saved in the app
1101
+ * Emitted when an Answer is saved in the app
1045
1102
  *
1046
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1103
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1047
1104
  */
1048
1105
  Save = 'save',
1049
1106
  /**
1050
1107
  * Emitted when the download action is triggered on an answer
1051
1108
  *
1052
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1109
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1053
1110
  */
1054
1111
  Download = 'download',
1055
1112
  /**
1056
1113
  * Emitted when the download action is triggered on an answer
1057
1114
  *
1058
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
1115
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
1059
1116
  */
1060
1117
  DownloadAsPng = 'downloadAsPng',
1061
1118
  /**
1062
1119
  * Emitted when the Download as PDF action is triggered on an answer
1063
1120
  *
1064
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1121
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1065
1122
  */
1066
1123
  DownloadAsPdf = 'downloadAsPdf',
1067
1124
  /**
1068
1125
  * Emitted when the Download as CSV action is triggered on an answer
1069
1126
  *
1070
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1127
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1071
1128
  */
1072
1129
  DownloadAsCsv = 'downloadAsCsv',
1073
1130
  /**
1074
1131
  * Emitted when the Download as XLSX action is triggered on an answer
1075
1132
  *
1076
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1133
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1077
1134
  */
1078
1135
  DownloadAsXlsx = 'downloadAsXlsx',
1079
1136
  /**
1080
1137
  * Emitted when an answer is deleted in the app
1081
1138
  *
1082
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1139
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1083
1140
  */
1084
1141
  AnswerDelete = 'answerDelete',
1085
1142
  /**
1086
1143
  * Emitted when an answer is pinned to a Liveboard
1087
1144
  *
1088
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1145
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1089
1146
  */
1090
1147
  Pin = 'pin',
1091
1148
  /**
1092
1149
  * Emitted when SpotIQ analysis is triggered
1093
1150
  *
1094
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1151
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1095
1152
  */
1096
1153
  SpotIQAnalyze = 'spotIQAnalyze',
1097
1154
  /**
1098
1155
  * Emitted when a user shares an object with another user or group
1099
1156
  *
1100
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1157
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1101
1158
  */
1102
1159
  Share = 'share',
1103
1160
  /**
1104
1161
  * Emitted when a user clicks the Include action to include a specific value or data
1105
1162
  * on a chart or table
1106
1163
  *
1107
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1164
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1108
1165
  */
1109
1166
  DrillInclude = 'context-menu-item-include',
1110
1167
  /**
1111
1168
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
1112
1169
  * on a chart or table
1113
1170
  *
1114
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1171
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1115
1172
  */
1116
1173
  DrillExclude = 'context-menu-item-exclude',
1117
1174
  /**
1118
1175
  * Emitted when copied column value on the app
1119
1176
  *
1120
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1177
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1121
1178
  */
1122
1179
  CopyToClipboard = 'context-menu-item-copy-to-clipboard',
1123
1180
  /**
1124
1181
  * Emitted when a user clicks the Update TML action
1125
1182
  *
1126
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1183
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1127
1184
  */
1128
1185
  UpdateTML = 'updateTSL',
1129
1186
  /**
1130
1187
  * Emitted when a user clicks the Edit TML action
1131
1188
  *
1132
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1189
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1133
1190
  */
1134
1191
  EditTML = 'editTSL',
1135
1192
  /**
1136
1193
  * Emitted when ExportTML trigger in answer on the app
1137
1194
  *
1138
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1195
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1139
1196
  */
1140
1197
  ExportTML = 'exportTSL',
1141
1198
  /**
1142
1199
  * Emitted when an answer is saved as a view
1143
1200
  *
1144
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1201
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1145
1202
  */
1146
1203
  SaveAsView = 'saveAsView',
1147
1204
  /**
1148
1205
  * Emitted when copy of existing answer on the app
1149
1206
  *
1150
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1207
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1151
1208
  */
1152
1209
  CopyAEdit = 'copyAEdit',
1153
1210
  /**
1154
1211
  * Emitted when a user clicks Show underlying data on an answe
1155
1212
  *
1156
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1213
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1157
1214
  */
1158
1215
  ShowUnderlyingData = 'showUnderlyingData',
1159
1216
  /**
1160
1217
  * Emitted when an answer is switched to a chart or table view
1161
1218
  *
1162
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1219
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1163
1220
  */
1164
1221
  AnswerChartSwitcher = 'answerChartSwitcher',
1165
1222
  /**
@@ -1171,67 +1228,67 @@ export enum EmbedEvent {
1171
1228
  /**
1172
1229
  * Emitted when a user clicks Show Liveboard details on a Liveboard
1173
1230
  *
1174
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1231
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1175
1232
  */
1176
1233
  LiveboardInfo = 'pinboardInfo',
1177
1234
  /**
1178
1235
  * Emitted when a user clicks on the Favorite icon on a Liveboard
1179
1236
  *
1180
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1237
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1181
1238
  */
1182
1239
  AddToFavorites = 'addToFavorites',
1183
1240
  /**
1184
1241
  * Emitted when a user clicks Schedule on a Liveboard
1185
1242
  *
1186
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1243
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1187
1244
  */
1188
1245
  Schedule = 'subscription',
1189
1246
  /**
1190
1247
  * Emitted when a user clicks Edit on a Liveboard or visualization
1191
1248
  *
1192
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1249
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1193
1250
  */
1194
1251
  Edit = 'edit',
1195
1252
  /**
1196
1253
  * Emitted when a user clicks Make a copy on a Liveboard
1197
1254
  *
1198
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1255
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1199
1256
  */
1200
1257
  MakeACopy = 'makeACopy',
1201
1258
  /**
1202
1259
  * Emitted when a user clicks Present on a Liveboard or visualization
1203
1260
  *
1204
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1261
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1205
1262
  */
1206
1263
  Present = 'present',
1207
1264
  /**
1208
1265
  * Emitted when a user clicks Delete on a Liveboard
1209
1266
  *
1210
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1267
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1211
1268
  */
1212
1269
  Delete = 'delete',
1213
1270
  /**
1214
1271
  * Emitted when a user clicks Manage schedules on a Liveboard
1215
1272
  *
1216
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1273
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1217
1274
  */
1218
1275
  SchedulesList = 'schedule-list',
1219
1276
  /**
1220
1277
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
1221
1278
  *
1222
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1279
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1223
1280
  */
1224
1281
  Cancel = 'cancel',
1225
1282
  /**
1226
1283
  * Emitted when a user clicks Explore on a visualization
1227
1284
  *
1228
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1285
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1229
1286
  */
1230
1287
  Explore = 'explore',
1231
1288
  /**
1232
1289
  * Emitted when a user clicks Copy link action on a visualization
1233
1290
  *
1234
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1291
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1235
1292
  */
1236
1293
  CopyLink = 'embedDocument',
1237
1294
  /**
@@ -1252,6 +1309,12 @@ export enum EmbedEvent {
1252
1309
  * @hidden
1253
1310
  */
1254
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',
1255
1318
  }
1256
1319
 
1257
1320
  /**
@@ -1279,13 +1342,14 @@ export enum EmbedEvent {
1279
1342
  // eslint-disable-next-line no-shadow
1280
1343
  export enum HostEvent {
1281
1344
  /**
1282
- * Trigger a search
1283
- *
1345
+ * Triggers a search query in AppEmbed and SearchEmbed
1346
+ * deployments.
1347
+ * Includes the following properties:
1284
1348
  * @param - dataSourceIds - The data source GUID to Search on
1285
1349
  * - Although an array, only a single source
1286
- * is supported at this time.
1287
- * @param - searchQuery - The search query
1288
- * @param - execute - execute the existing / updated query
1350
+ * is supported.
1351
+ * @param - searchQuery - Query string with search tokens
1352
+ * @param - execute - executes the existing / updated query
1289
1353
  * @example
1290
1354
  * ```js
1291
1355
  * searchEmbed.trigger(HostEvent.Search, {
@@ -1297,13 +1361,13 @@ export enum HostEvent {
1297
1361
  */
1298
1362
  Search = 'search',
1299
1363
  /**
1300
- * Trigger a drill on certain points by certain column
1301
- *
1364
+ * Triggers a drill on certain points of the specified column
1365
+ * Includes the following properties:
1302
1366
  * @param - points - an object containing selectedPoints/clickedPoints
1303
- * eg. { selectedPoints: []}
1304
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
1305
- * if not provided it will auto drill by the configured
1306
- * column.
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.
1307
1371
  * @example
1308
1372
  * ```js
1309
1373
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -1336,17 +1400,17 @@ export enum HostEvent {
1336
1400
  */
1337
1401
  Reload = 'reload',
1338
1402
  /**
1339
- * Set the visible visualizations on a Liveboard.
1403
+ * Sets the visible visualizations on a Liveboard.
1340
1404
  *
1341
- * @param - an array of ids of visualizations to show, the ids not passed
1342
- * will be hidden.
1405
+ * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
1406
+ * in this parameter will be hidden.
1343
1407
  * @example
1344
1408
  * ```js
1345
1409
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
1346
1410
  * '730496d6-6903-4601-937e-2c691821af3c',
1347
1411
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
1348
1412
  * ```
1349
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1413
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1350
1414
  */
1351
1415
  SetVisibleVizs = 'SetPinboardVisibleVizs',
1352
1416
  /**
@@ -1363,9 +1427,18 @@ export enum HostEvent {
1363
1427
  */
1364
1428
  SetActiveTab = 'SetActiveTab',
1365
1429
  /**
1366
- * Update the runtime filters. The runtime filters passed here are extended
1367
- * on to the existing runtime filters if they exist.
1368
- *
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.
1369
1442
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
1370
1443
  * @example
1371
1444
  * ```js
@@ -1374,25 +1447,24 @@ export enum HostEvent {
1374
1447
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
1375
1448
  * ])
1376
1449
  * ```
1377
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1450
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1378
1451
  * @important
1379
1452
  */
1380
1453
  UpdateRuntimeFilters = 'UpdateRuntimeFilters',
1381
1454
  /**
1382
- * Navigate to a specific page in App embed without any reload.
1455
+ * Navigate to a specific page in the embedded application without reloading the page.
1383
1456
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
1384
- *
1385
1457
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
1386
1458
  * @example
1387
1459
  * ```js
1388
1460
  * appEmbed.navigateToPage(-1)
1389
1461
  * ```
1390
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
1462
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
1391
1463
  */
1392
1464
  Navigate = 'Navigate',
1393
1465
  /**
1394
1466
  * Opens the filter panel for a particular column.
1395
- * Works with Search embed.
1467
+ * Works with Search and Liveboard embed.
1396
1468
  *
1397
1469
  * @param - { columnId: string,
1398
1470
  * name: string,
@@ -1401,233 +1473,257 @@ export enum HostEvent {
1401
1473
  * @example
1402
1474
  * ```js
1403
1475
  * searchEmbed.trigger(HostEvent.OpenFilter,
1404
- * { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
1476
+ * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
1477
+ * LiveboardEmbed.trigger(HostEvent.OpenFilter,
1478
+ * { columnId: '<column-GUID>'})
1405
1479
  * ```
1406
1480
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1407
1481
  */
1408
1482
  OpenFilter = 'openFilter',
1409
1483
  /**
1410
- * Adds the columns to the current Search.
1484
+ * Adds columns to the current search query.
1411
1485
  *
1412
1486
  * @param - { columnIds: string[] }
1413
1487
  * @example
1414
1488
  * ```js
1415
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
1489
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
1416
1490
  * ```
1417
1491
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1418
1492
  */
1419
1493
  AddColumns = 'addColumns',
1420
1494
  /**
1421
- * Removes a column from the current Search.
1495
+ * Removes a column from the current search query.
1422
1496
  *
1423
1497
  * @param - { columnId: string }
1424
1498
  * @example
1425
1499
  * ```js
1426
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
1500
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
1427
1501
  * ```
1428
1502
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1429
1503
  */
1430
1504
  RemoveColumn = 'removeColumn',
1431
1505
  /**
1432
- * Gets the current pinboard content.
1506
+ * Gets the current Liveboard content.
1433
1507
  *
1434
1508
  * @example
1435
1509
  * ```js
1436
1510
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
1437
1511
  * ```
1438
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
1512
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
1439
1513
  */
1440
1514
  getExportRequestForCurrentPinboard = 'getExportRequestForCurrentPinboard',
1441
1515
  /**
1442
- * Triggers the Pin action on an embedded object
1516
+ * Triggers the **Pin** action on an embedded object
1443
1517
  *
1444
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1445
- * can be left empty for search and visualization embeds
1518
+ * @param - Liveboard embed takes the `vizId` as a
1519
+ * key. Can be left undefined when embedding Search, full app or
1520
+ * a visualization.
1446
1521
  * @example
1447
1522
  * ```js
1448
1523
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1524
+ * ```
1525
+ * ```js
1449
1526
  * vizEmbed.trigger(HostEvent.Pin)
1527
+ * ```
1528
+ * ```js
1450
1529
  * searchEmbed.trigger(HostEvent.Pin)
1451
1530
  * ```
1452
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1531
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1453
1532
  */
1454
1533
  Pin = 'pin',
1455
1534
  /**
1456
- * Triggers the Show Liveboard details action on a Liveboard
1535
+ * Triggers the **Show Liveboard details** action on a Liveboard
1457
1536
  *
1458
1537
  * @example
1459
1538
  * ```js
1460
1539
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
1461
1540
  * ```
1462
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1541
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1463
1542
  */
1464
1543
  LiveboardInfo = 'pinboardInfo',
1465
1544
  /**
1466
- * Triggers the Schedule action on a Liveboard
1545
+ * Triggers the **Schedule** action on a Liveboard
1467
1546
  *
1468
1547
  * @example
1469
1548
  * ```js
1470
1549
  * liveboardEmbed.trigger(HostEvent.Schedule)
1471
1550
  * ```
1472
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1551
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1473
1552
  */
1474
1553
  Schedule = 'subscription',
1475
1554
  /**
1476
- * Triggers the Manage schedule action on a Liveboard
1555
+ * Triggers the **Manage schedule** action on a Liveboard
1477
1556
  *
1478
1557
  * @example
1479
1558
  * ```js
1480
1559
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
1481
1560
  * ```
1482
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1561
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1483
1562
  */
1484
1563
  SchedulesList = 'schedule-list',
1485
1564
  /**
1486
- * Triggers the Export TML action on a Liveboard
1565
+ * Triggers the **Export TML** action on a Liveboard
1487
1566
  *
1488
1567
  * @example
1489
1568
  * ```js
1490
1569
  * liveboardEmbed.trigger(HostEvent.ExportTML)
1491
1570
  * ```
1492
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1571
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1493
1572
  */
1494
1573
  ExportTML = 'exportTSL',
1495
1574
  /**
1496
- * Triggers the Edit TML action on a Liveboard
1575
+ * Triggers the **Edit TML** action on a Liveboard
1497
1576
  *
1498
1577
  * @example
1499
1578
  * ```js
1500
1579
  * liveboardEmbed.trigger(HostEvent.EditTML)
1501
1580
  * ```
1502
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1581
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1503
1582
  */
1504
1583
  EditTML = 'editTSL',
1505
1584
  /**
1506
- * Triggers the Update TML action on a Liveboard
1585
+ * Triggers the **Update TML** action on a Liveboard
1507
1586
  *
1508
1587
  * @example
1509
1588
  * ```js
1510
1589
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
1511
1590
  * ```
1512
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1591
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1513
1592
  */
1514
1593
  UpdateTML = 'updateTSL',
1515
1594
  /**
1516
- * Triggers the Download PDF action on a Liveboard
1595
+ * Triggers the **Download PDF** action on a Liveboard
1517
1596
  *
1518
1597
  * @example
1519
1598
  * ```js
1520
1599
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
1521
1600
  * ```
1522
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1601
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1523
1602
  */
1524
1603
  DownloadAsPdf = 'downloadAsPdf',
1525
1604
  /**
1526
- * Triggers the Make a copy action on a Liveboard, search or visualization
1605
+ * Triggers the **Make a copy** action on a Liveboard, Search, or
1606
+ * visualization page
1527
1607
  *
1528
1608
  * @example
1529
1609
  * ```js
1530
1610
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1611
+ * ```
1612
+ * ```js
1531
1613
  * vizEmbed.trigger(HostEvent.MakeACopy)
1614
+ * ```
1615
+ * ```js
1532
1616
  * searchEmbed.trigger(HostEvent.MakeACopy)
1533
1617
  * ```
1534
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1618
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1535
1619
  */
1536
1620
  MakeACopy = 'makeACopy',
1537
1621
  /**
1538
- * Triggers the Delete action on a Liveboard
1622
+ * Triggers the **Delete** action on a Liveboard
1539
1623
  *
1540
1624
  * @example
1541
1625
  * ```js
1542
1626
  * appEmbed.trigger(HostEvent.Remove)
1543
1627
  * ```
1544
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1628
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1545
1629
  */
1546
1630
  Remove = 'delete',
1547
1631
  /**
1548
- * Triggers the Explore action on a visualization
1632
+ * Triggers the **Explore* action on a visualization
1549
1633
  *
1550
- * @param - an object with vizId as a key
1634
+ * @param - an object with `vizId` as a key
1551
1635
  * @example
1552
1636
  * ```js
1553
1637
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1554
1638
  * ```
1555
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1639
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1556
1640
  */
1557
1641
  Explore = 'explore',
1558
1642
  /**
1559
- * Triggers the Create alert action on a visualization
1643
+ * Triggers the **Create alert** action on a visualization
1560
1644
  *
1561
- * @param - an object with vizId as a key
1645
+ * @param - an object with `vizId` as a key
1562
1646
  * @example
1563
1647
  * ```js
1564
1648
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
1565
1649
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1566
1650
  * })
1567
1651
  * ```
1568
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1652
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1569
1653
  */
1570
1654
  CreateMonitor = 'createMonitor',
1571
1655
  /**
1572
- * Triggers the Manage alert action on a visualization
1656
+ * Triggers the **Manage alerts** action on a visualization
1573
1657
  *
1574
- * @param - an object with vizId as a key
1658
+ * @param - an object with `vizId` as a key
1575
1659
  * @example
1576
1660
  * ```js
1577
1661
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
1578
1662
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1579
1663
  * })
1580
1664
  * ```
1581
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1665
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1582
1666
  */
1583
1667
  ManageMonitor = 'manageMonitor',
1584
1668
  /**
1585
- * Triggers the Edit action on a Liveboard or visualization
1669
+ * Triggers the **Edit** action on a Liveboard or visualization
1586
1670
  *
1587
- * @param - object - to trigger the action for a specfic visualization
1588
- * in Liveboard embed, pass in vizId as a key
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.
1589
1675
  * @example
1590
1676
  * ```js
1591
1677
  * liveboardEmbed.trigger(HostEvent.Edit)
1592
- *
1678
+ * ```
1679
+ * ```js
1593
1680
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
1594
1681
  * '730496d6-6903-4601-937e-2c691821af3c'})
1595
- *
1682
+ * ```
1683
+ * ```js
1596
1684
  * vizEmbed.trigger((HostEvent.Edit)
1597
1685
  * ```
1598
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1686
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1599
1687
  */
1600
1688
  Edit = 'edit',
1601
1689
  /**
1602
- * Triggers the Copy link action on a Liveboard or visualization
1690
+ * Triggers the **Copy link** action on a Liveboard or visualization
1603
1691
  *
1604
- * @param - object - to trigger the action for a s
1605
- * pecfic visualization in Liveboard embed, pass in vizId as a key
1692
+ * @param - object - to trigger the action for a
1693
+ * specific visualization in Liveboard embed, pass in `vizId` as a key
1606
1694
  * @example
1607
1695
  * ```js
1608
1696
  * liveboardEmbed.trigger(HostEvent.CopyLink)
1697
+ * ```
1698
+ * ```js
1609
1699
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1700
+ * ```
1701
+ * ```js
1610
1702
  * vizEmbed.trigger((HostEvent.CopyLink)
1611
1703
  * ```
1612
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1704
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1613
1705
  */
1614
1706
  CopyLink = 'embedDocument',
1615
1707
  /**
1616
- * Triggers the Present action on a Liveboard or visualization
1708
+ * Triggers the **Present** action on a Liveboard or visualization
1617
1709
  *
1618
- * @param - object - to trigger the action for a specfic visualization
1619
- * 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
1620
1712
  * @example
1621
1713
  * ```js
1622
1714
  * liveboardEmbed.trigger(HostEvent.Present)
1715
+ * ```
1716
+ * ```js
1623
1717
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1718
+ * ```
1719
+ * ```js
1624
1720
  * vizEmbed.trigger((HostEvent.Present)
1625
1721
  * ```
1626
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1722
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1627
1723
  */
1628
1724
  Present = 'present',
1629
1725
  /**
1630
- * Get TML for the current search.
1726
+ * Gets TML for the current search.
1631
1727
  *
1632
1728
  * @example
1633
1729
  * ```js
@@ -1637,79 +1733,89 @@ export enum HostEvent {
1637
1733
  * );
1638
1734
  * })
1639
1735
  * ```
1640
- * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
1736
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
1641
1737
  * @important
1642
1738
  */
1643
1739
  GetTML = 'getTML',
1644
1740
  /**
1645
- * Triggers the ShowUnderlyingData action on visualization or search
1741
+ * Triggers the **Show underlying data** action on visualization or search
1646
1742
  *
1647
1743
  * @param - an object with vizId as a key
1648
1744
  * @example
1649
1745
  * ```js
1650
1746
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
1651
1747
  * '730496d6-6903-4601-937e-2c691821af3c'})
1652
- *
1748
+ * ```
1749
+ * ```js
1653
1750
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
1654
- *
1751
+ * ```
1752
+ * ```js
1655
1753
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
1656
1754
  * ```
1657
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1755
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1658
1756
  */
1659
1757
  ShowUnderlyingData = 'showUnderlyingData',
1660
1758
  /**
1661
- * Triggers the Delete action on visualization or search
1759
+ * Triggers the **Delete** action on visualization or search
1662
1760
  *
1663
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1664
- * can be left empty for search and visualization embeds
1761
+ * @param - Liveboard embed takes an object with `vizId` as a key.
1762
+ * Can be left empty if embedding Search or visualization.
1665
1763
  * @example
1666
1764
  * ```js
1667
1765
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
1668
1766
  * '730496d6-6903-4601-937e-2c691821af3c'})
1669
- *
1767
+ * ```
1768
+ * ```js
1670
1769
  * vizEmbed.trigger(HostEvent.Delete)
1671
- *
1770
+ * ```
1771
+ * ```js
1672
1772
  * searchEmbed.trigger(HostEvent.Delete)
1673
1773
  * ```
1674
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1774
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1675
1775
  */
1676
1776
  Delete = 'onDeleteAnswer',
1677
1777
  /**
1678
- * Triggers the SpotIQAnalyze action on visualization or search
1679
- *
1680
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1681
- * can be left empty for search and visualization embeds
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.
1682
1783
  * @example
1683
1784
  * ```js
1684
1785
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
1685
1786
  * '730496d6-6903-4601-937e-2c691821af3c'})
1686
- *
1787
+ * ```
1788
+ * ```js
1687
1789
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
1688
- *
1790
+ * ```
1791
+ * ```js
1689
1792
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
1690
1793
  * ```
1691
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1794
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1692
1795
  */
1693
1796
  SpotIQAnalyze = 'spotIQAnalyze',
1694
1797
  /**
1695
- * Triggers the Download action on visualization or search when Displaymode is Chart
1798
+ * Triggers the **Download** action on charts in
1799
+ * the embedded view.
1696
1800
  *
1697
1801
  * @example
1698
1802
  * ```js
1699
1803
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
1700
1804
  * '730496d6-6903-4601-937e-2c691821af3c'})
1701
- *
1805
+ * ```
1806
+ * ```js
1702
1807
  * vizEmbed.trigger(HostEvent.Download)
1703
- *
1808
+ * ```
1809
+ * ```js
1704
1810
  * searchEmbed.trigger(HostEvent.Download)
1705
1811
  * ```
1706
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
1707
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
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
1708
1814
  */
1709
1815
  Download = 'downloadAsPng',
1710
1816
  /**
1711
- * Triggers the Download action on visualization or search when Displaymode is Chart
1712
- *
1817
+ * Triggers the **Download** > **PNG** action on
1818
+ * charts in the embedded view.
1713
1819
  * @example
1714
1820
  * ```js
1715
1821
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1719,115 +1825,192 @@ export enum HostEvent {
1719
1825
  *
1720
1826
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
1721
1827
  * ```
1722
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
1828
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
1723
1829
  */
1724
1830
  DownloadAsPng = 'downloadAsPng',
1725
1831
  /**
1726
- * Triggers the downloadAsCSV action on visualization or search
1832
+ * Triggers the **Download** > **CSV** action on tables in
1833
+ * the embedded view.
1727
1834
  *
1728
1835
  * @example
1729
1836
  * ```js
1730
1837
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
1731
1838
  * '730496d6-6903-4601-937e-2c691821af3c'})
1732
- *
1839
+ * ```
1840
+ * ```js
1733
1841
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
1734
- *
1842
+ * ```
1843
+ * ```js
1735
1844
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
1736
1845
  * ```
1737
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1846
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1738
1847
  */
1739
1848
  DownloadAsCsv = 'downloadAsCSV',
1740
1849
  /**
1741
- * Triggers the downloadAsXLSX action on visualization or search
1742
- *
1850
+ * Triggers the **Download** > **XLSX** action on tables
1851
+ * in the embedded view.
1743
1852
  * @example
1744
1853
  * ```js
1745
1854
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
1746
1855
  * '730496d6-6903-4601-937e-2c691821af3c'})
1747
- *
1856
+ * ```
1857
+ * ```js
1748
1858
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
1749
- *
1859
+ * ```
1860
+ * ```js
1750
1861
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
1751
1862
  * ```
1752
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1863
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1753
1864
  */
1754
1865
  DownloadAsXlsx = 'downloadAsXLSX',
1755
1866
  /**
1756
- * Triggers the Share action on a liveboard or answer
1867
+ * Triggers the **Share** action on an embedded
1868
+ * Liveboard or Answer.
1757
1869
  *
1758
1870
  * @example
1759
1871
  * ```js
1760
1872
  * liveboardEmbed.trigger(HostEvent.Share)
1761
- *
1873
+ * ```
1874
+ * ```js
1762
1875
  * searchEmbed.trigger(HostEvent.Share)
1763
1876
  * ```
1764
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1877
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1765
1878
  */
1766
1879
  Share = 'share',
1767
1880
  /**
1768
- * Trigger the Save action on a liveboard or answer
1769
- *
1881
+ * Triggers the **Save** action on a Liveboard or Answer.
1882
+ * Saves the changes.
1770
1883
  * @example
1771
1884
  * ```js
1772
1885
  * liveboardEmbed.trigger(HostEvent.Save)
1773
- *
1886
+ * ```
1887
+ * ```js
1774
1888
  * searchEmbed.trigger(HostEvent.Save)
1775
1889
  * ```
1776
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1890
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1777
1891
  */
1778
1892
  Save = 'save',
1779
1893
  /**
1780
- * Triggers the SyncToSheets action on visualization
1781
- *
1782
- * @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
1783
1897
  * @example
1784
1898
  * ```js
1785
1899
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
1786
1900
  * '730496d6-6903-4601-937e-2c691821af3c'})
1787
- *
1901
+ * ```
1902
+ * ```js
1788
1903
  * vizEmbed.trigger(HostEvent.SyncToSheets)
1789
1904
  * ```
1790
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1905
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1791
1906
  */
1792
1907
  SyncToSheets = 'sync-to-sheets',
1793
1908
  /**
1794
- * Triggers the SyncToOtherApps action on visualization
1795
- *
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.
1796
1912
  * @param - an object with vizId as a key
1797
1913
  * @example
1798
1914
  * ```js
1799
1915
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
1800
1916
  * '730496d6-6903-4601-937e-2c691821af3c'})
1801
- *
1917
+ * ```
1918
+ * ```js
1802
1919
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
1803
1920
  * ```
1804
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1921
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1805
1922
  */
1806
1923
  SyncToOtherApps = 'sync-to-other-apps',
1807
1924
  /**
1808
- * Triggers the ManagePipelines action on visualization
1809
- *
1810
- * @param - an object with vizId as a key
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
1811
1929
  * @example
1812
1930
  * ```js
1813
1931
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
1814
1932
  * '730496d6-6903-4601-937e-2c691821af3c'})
1815
- *
1933
+ * ```
1934
+ * ```js
1816
1935
  * vizEmbed.trigger(HostEvent.ManagePipelines)
1817
1936
  * ```
1818
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1937
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1819
1938
  */
1820
1939
  ManagePipelines = 'manage-pipeline',
1821
1940
  /**
1822
- * Triggers the Reset search in answer
1941
+ * Triggers the Reset search on the Search page
1823
1942
  *
1824
1943
  * @example
1825
1944
  * ```js
1826
1945
  * searchEmbed.trigger(HostEvent.ResetSearch)
1827
1946
  * ```
1828
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
1947
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
1829
1948
  */
1830
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',
1831
2014
  }
1832
2015
 
1833
2016
  /**
@@ -1900,34 +2083,58 @@ export enum Param {
1900
2083
  ShowInsertToSlide = 'insertInToSlide',
1901
2084
  PrimaryNavHidden = 'primaryNavHidden',
1902
2085
  HideProfleAndHelp = 'profileAndHelpInNavBarHidden',
1903
- HideApplicationSwitcher= 'applicationSwitcherHidden',
1904
- HideOrgSwitcher= 'orgSwitcherHidden',
2086
+ HideApplicationSwitcher = 'applicationSwitcherHidden',
2087
+ HideOrgSwitcher = 'orgSwitcherHidden',
1905
2088
  IsSageEmbed = 'isSageEmbed',
1906
2089
  HideWorksheetSelector = 'hideWorksheetSelector',
1907
2090
  DisableWorksheetChange = 'disableWorksheetChange',
1908
2091
  HideEurekaResults = 'hideEurekaResults',
1909
2092
  HideEurekaSuggestions = 'hideEurekaSuggestions',
2093
+ HideLiveboardHeader = 'hideLiveboardHeader',
2094
+ ShowLiveboardDescription = 'showLiveboardDescription',
2095
+ ShowLiveboardTitle = 'showLiveboardTitle',
2096
+ HiddenTabs = 'hideTabs',
2097
+ VisibleTabs = 'visibleTabs',
2098
+ HideTabPanel = 'hideTabPanel'
1910
2099
  }
1911
2100
 
1912
2101
  /**
1913
- * The list of actions that can be performed on visual ThoughtSpot
1914
- * entities, such as answers and Liveboards.
1915
- *
1916
- * This enum is used to specify the actions that could be disabled,
1917
- * hidden or made visible.
1918
- *
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.
1919
2108
  * @example
1920
2109
  * ```js
1921
2110
  * const embed = new LiveboardEmbed('#embed-container', {
1922
2111
  * ... // other options
1923
- * visibleActions: [Action.Save, Action.Explore],
1924
- * disableActions: [Action.Save],
1925
- * hiddenActions: [Action.Download], // Set either this or visibleActions
2112
+ * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
2113
+ * disabledActions: [Action.Download],
2114
+ * //hiddenActions: [], // Set either this or visibleActions
1926
2115
  * })
1927
2116
  * ```
2117
+ * @example
2118
+ * ```js
2119
+ * const embed = new LiveboardEmbed('#embed-container', {
2120
+ * ... // other options
2121
+ * //visibleActions: [],
2122
+ * disabledActions: [Action.Download],
2123
+ * hiddenActions: [Action.Edit, ActionAction.Explore],
2124
+ * })
2125
+ * ```
2126
+
1928
2127
  */
1929
2128
  // eslint-disable-next-line no-shadow
1930
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
+ */
1931
2138
  Save = 'save',
1932
2139
  /**
1933
2140
  * @hidden
@@ -1937,27 +2144,137 @@ export enum Action {
1937
2144
  * @hidden
1938
2145
  */
1939
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
+ */
1940
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
+ */
1941
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
+ */
1942
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
+ */
1943
2187
  CopyLink = 'embedDocument',
1944
2188
  /**
1945
2189
  * @hidden
1946
2190
  */
1947
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
+ */
1948
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
+ */
1949
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
+ */
1950
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
+ */
1951
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
+ */
1952
2237
  ConfigureFilter = 'configureFilter',
1953
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
+ */
1954
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
+ */
1955
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
+ */
1956
2265
  AddParameter = 'addParameter',
1957
2266
  /**
1958
2267
  * @hidden
1959
2268
  */
1960
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
+ */
1961
2278
  SpotIQAnalyze = 'spotIQAnalyze',
1962
2279
  /**
1963
2280
  * @hidden
@@ -1972,24 +2289,150 @@ export enum Action {
1972
2289
  * @hidden
1973
2290
  */
1974
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
+ */
1975
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
+ */
1976
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
+ */
1977
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
+ */
1978
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
+ */
1979
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
+ */
1980
2349
  DownloadAsXlsx = 'downloadAsXLSX',
1981
2350
  /**
1982
2351
  * @hidden
1983
2352
  */
1984
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
+ */
1985
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
+ */
1986
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
+ */
1987
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
+ */
1988
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
+ */
1989
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
+ */
1990
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
+ */
1991
2419
  Edit = 'edit',
2420
+ /**
2421
+ * The text edit option for Liveboard and visualization titles.
2422
+ * @example
2423
+ * ```js
2424
+ * disabledActions: [Action.EditTitle]
2425
+ * ```
2426
+ */
1992
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
+ */
1993
2436
  Remove = 'delete',
1994
2437
  /**
1995
2438
  * @hidden
@@ -2011,6 +2454,16 @@ export enum Action {
2011
2454
  * @hidden
2012
2455
  */
2013
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
+ */
2014
2467
  LiveboardInfo = 'pinboardInfo',
2015
2468
  /**
2016
2469
  * @hidden
@@ -2021,20 +2474,62 @@ export enum Action {
2021
2474
  */
2022
2475
  DownloadEmbraceQueries = 'downloadEmbraceQueries',
2023
2476
  /**
2024
- * Pin action.
2025
- */
2477
+ * The **Pin** menu action on an Answer or
2478
+ * Search results page.
2479
+ * @example
2480
+ * ```js
2481
+ * disabledActions: [Action.Pin]
2482
+ * ```
2483
+ */
2026
2484
  Pin = 'pin',
2027
2485
  /**
2028
2486
  * @hidden
2029
2487
  */
2030
2488
  AnalysisInfo = 'analysisInfo',
2489
+ /**
2490
+ * The **Schedule** menu action on a Liveboard.
2491
+ * @example
2492
+ * ```js
2493
+ * disabledActions: [Action.Subscription]
2494
+ * ```
2495
+ */
2031
2496
  Subscription = 'subscription',
2032
2497
  /**
2033
- * Explore action.
2034
- */
2498
+ * The **Explore** action on Liveboard visualizations
2499
+ * @example
2500
+ * ```js
2501
+ * disabledActions: [Action.Explore]
2502
+ * ```
2503
+ */
2035
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
+
2036
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
+ */
2037
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
+ */
2038
2533
  CopyToClipboard = 'context-menu-item-copy-to-clipboard',
2039
2534
  CopyAndEdit = 'context-menu-item-copy-and-edit',
2040
2535
  /**
@@ -2043,89 +2538,266 @@ export enum Action {
2043
2538
  DrillEdit = 'context-menu-item-edit',
2044
2539
  EditMeasure = 'context-menu-item-edit-measure',
2045
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
+ */
2046
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
+ */
2047
2559
  RequestAccess = 'requestAccess',
2048
- QueryDetailsButtons = 'queryDetailsButtons',
2049
- /**
2050
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
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
2051
2576
  */
2052
2577
  AnswerDelete = 'onDeleteAnswer',
2053
2578
  /**
2054
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
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
2055
2585
  */
2056
2586
  AnswerChartSwitcher = 'answerChartSwitcher',
2057
2587
  /**
2058
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
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
2059
2594
  */
2060
2595
  AddToFavorites = 'addToFavorites',
2061
2596
  /**
2062
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
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
2063
2603
  */
2064
2604
  EditDetails = 'editDetails',
2065
2605
  /**
2066
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
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
2067
2612
  */
2068
2613
  CreateMonitor = 'createMonitor',
2069
2614
  /**
2070
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2615
+ * @example
2616
+ * ```js
2617
+ * disabledActions: [Action.ReportError]
2618
+ * ```
2619
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2071
2620
  */
2072
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
+ */
2073
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
+ */
2074
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
+ */
2075
2652
  ManagePipelines = 'manage-pipeline',
2076
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
+ * ```
2077
2660
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2078
2661
  */
2079
2662
  CrossFilter = 'context-menu-item-cross-filter',
2080
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
+ * ```
2081
2671
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2082
2672
  */
2083
2673
  RemoveCrossFilter = 'context-menu-item-remove-cross-filter',
2084
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
+ * ```
2085
2682
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2086
2683
  */
2087
2684
  AxisMenuAggregate = 'axisMenuAggregate',
2088
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
+ * ```
2089
2693
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2090
2694
  */
2091
2695
  AxisMenuTimeBucket = 'axisMenuTimeBucket',
2092
2696
  /**
2697
+ * The **Filter** action in the chart axis or table column
2698
+ * customization menu.
2699
+ * @example
2700
+ * ```js
2701
+ * disabledActions: [Action.AxisMenuFilter]
2702
+ * ```
2093
2703
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2094
2704
  */
2095
2705
  AxisMenuFilter = 'axisMenuFilter',
2096
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
+ * ```
2097
2714
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2098
2715
  */
2099
2716
  AxisMenuConditionalFormat = 'axisMenuConditionalFormat',
2100
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
+ * ```
2101
2725
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2102
2726
  */
2103
2727
  AxisMenuSort = 'axisMenuSort',
2104
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
+ * ```
2105
2737
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2106
2738
  */
2107
2739
  AxisMenuGroup = 'axisMenuGroup',
2108
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
+ * ```
2109
2748
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2110
2749
  */
2111
2750
  AxisMenuPosition = 'axisMenuPosition',
2112
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
+ * ```
2113
2758
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2114
2759
  */
2115
2760
  AxisMenuRename = 'axisMenuRename',
2116
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
+ * ```
2117
2769
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2118
2770
  */
2119
2771
  AxisMenuEdit = 'axisMenuEdit',
2120
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
+ * ```
2121
2779
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2122
2780
  */
2123
2781
  AxisMenuNumberFormat = 'axisMenuNumberFormat',
2124
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
+ * ```
2125
2789
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2126
2790
  */
2127
2791
  AxisMenuTextWrapping = 'axisMenuTextWrapping',
2128
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
+ * ```
2129
2801
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2130
2802
  */
2131
2803
  AxisMenuRemove = 'axisMenuRemove',
@@ -2133,11 +2805,32 @@ export enum Action {
2133
2805
  * @hidden
2134
2806
  */
2135
2807
  InsertInToSlide = 'insertInToSlide',
2136
-
2137
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
+ * ```
2138
2815
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2139
2816
  */
2140
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',
2141
2834
  }
2142
2835
 
2143
2836
  export interface SessionInterface {