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