@thoughtspot/visual-embed-sdk 1.35.10 → 1.35.12

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 (133) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +11 -2
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js.map +1 -1
  5. package/cjs/src/embed/hostEventClient/contracts.d.ts +1 -1
  6. package/cjs/src/embed/hostEventClient/contracts.js +1 -1
  7. package/cjs/src/embed/liveboard.d.ts +7 -4
  8. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  9. package/cjs/src/embed/liveboard.js +4 -3
  10. package/cjs/src/embed/liveboard.js.map +1 -1
  11. package/cjs/src/embed/liveboard.spec.js +17 -1
  12. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  13. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  14. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  15. package/cjs/src/embed/searchEmbed-basic-auth.spec.js +104 -0
  16. package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
  17. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  18. package/cjs/src/embed/ts-embed.js +5 -2
  19. package/cjs/src/embed/ts-embed.js.map +1 -1
  20. package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
  21. package/cjs/src/embed/ts-embed.spec.js +110 -0
  22. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  23. package/cjs/src/hostEventsTypeMapping.d.ts +2 -0
  24. package/cjs/src/hostEventsTypeMapping.d.ts.map +1 -0
  25. package/cjs/src/hostEventsTypeMapping.js +4 -0
  26. package/cjs/src/hostEventsTypeMapping.js.map +1 -0
  27. package/cjs/src/types.d.ts +298 -161
  28. package/cjs/src/types.d.ts.map +1 -1
  29. package/cjs/src/types.js +274 -133
  30. package/cjs/src/types.js.map +1 -1
  31. package/cjs/src/utils/embedApi/contracts.d.ts +101 -0
  32. package/cjs/src/utils/embedApi/contracts.d.ts.map +1 -0
  33. package/cjs/src/utils/embedApi/contracts.js +17 -0
  34. package/cjs/src/utils/embedApi/contracts.js.map +1 -0
  35. package/cjs/src/utils/embedApi/embedApiClient.d.ts +12 -0
  36. package/cjs/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  37. package/cjs/src/utils/embedApi/embedApiClient.js +46 -0
  38. package/cjs/src/utils/embedApi/embedApiClient.js.map +1 -0
  39. package/cjs/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  40. package/cjs/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  41. package/cjs/src/utils/embedApi/processEmbedApi.js +18 -0
  42. package/cjs/src/utils/embedApi/processEmbedApi.js.map +1 -0
  43. package/dist/{index-DWOIXXJ1.js → index-BBBimG1x.js} +1 -1
  44. package/dist/index-BGnxP5NY.js +7370 -0
  45. package/dist/index-CENLvayL.js +7370 -0
  46. package/dist/index-CbltIawo.js +7370 -0
  47. package/dist/index-CoQfqaHj.js +7370 -0
  48. package/dist/index-CzwzS0P4.js +7370 -0
  49. package/dist/index-D-9WUCUl.js +7370 -0
  50. package/dist/index-DFwi_pV_.js +7370 -0
  51. package/dist/index-DOIjN0N_.js +7370 -0
  52. package/dist/index-DYBx8SuE.js +7370 -0
  53. package/dist/index-DaLHJaLd.js +7370 -0
  54. package/dist/index-DnJX-gN2.js +7370 -0
  55. package/dist/index-IDmSUe93.js +7370 -0
  56. package/dist/index-nWevLycs.js +7370 -0
  57. package/dist/src/embed/app.d.ts +11 -2
  58. package/dist/src/embed/app.d.ts.map +1 -1
  59. package/dist/src/embed/hostEventClient/contracts.d.ts +1 -1
  60. package/dist/src/embed/liveboard.d.ts +7 -4
  61. package/dist/src/embed/liveboard.d.ts.map +1 -1
  62. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  63. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  64. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  65. package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
  66. package/dist/src/hostEventsTypeMapping.d.ts +2 -0
  67. package/dist/src/hostEventsTypeMapping.d.ts.map +1 -0
  68. package/dist/src/types.d.ts +298 -161
  69. package/dist/src/types.d.ts.map +1 -1
  70. package/dist/src/utils/embedApi/contracts.d.ts +101 -0
  71. package/dist/src/utils/embedApi/contracts.d.ts.map +1 -0
  72. package/dist/src/utils/embedApi/embedApiClient.d.ts +12 -0
  73. package/dist/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  74. package/dist/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  75. package/dist/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  76. package/dist/tsembed-react.es.js +287 -142
  77. package/dist/tsembed-react.js +286 -141
  78. package/dist/tsembed.es.js +287 -142
  79. package/dist/tsembed.js +286 -141
  80. package/dist/visual-embed-sdk-react-full.d.ts +316 -167
  81. package/dist/visual-embed-sdk-react.d.ts +316 -167
  82. package/dist/visual-embed-sdk.d.ts +316 -167
  83. package/lib/package.json +1 -1
  84. package/lib/src/embed/app.d.ts +11 -2
  85. package/lib/src/embed/app.d.ts.map +1 -1
  86. package/lib/src/embed/app.js.map +1 -1
  87. package/lib/src/embed/hostEventClient/contracts.d.ts +1 -1
  88. package/lib/src/embed/hostEventClient/contracts.js +1 -1
  89. package/lib/src/embed/liveboard.d.ts +7 -4
  90. package/lib/src/embed/liveboard.d.ts.map +1 -1
  91. package/lib/src/embed/liveboard.js +4 -3
  92. package/lib/src/embed/liveboard.js.map +1 -1
  93. package/lib/src/embed/liveboard.spec.js +17 -1
  94. package/lib/src/embed/liveboard.spec.js.map +1 -1
  95. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  96. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  97. package/lib/src/embed/searchEmbed-basic-auth.spec.js +101 -0
  98. package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
  99. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  100. package/lib/src/embed/ts-embed.js +5 -2
  101. package/lib/src/embed/ts-embed.js.map +1 -1
  102. package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
  103. package/lib/src/embed/ts-embed.spec.js +111 -1
  104. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  105. package/lib/src/hostEventsTypeMapping.d.ts +2 -0
  106. package/lib/src/hostEventsTypeMapping.d.ts.map +1 -0
  107. package/lib/src/hostEventsTypeMapping.js +2 -0
  108. package/lib/src/hostEventsTypeMapping.js.map +1 -0
  109. package/lib/src/types.d.ts +298 -161
  110. package/lib/src/types.d.ts.map +1 -1
  111. package/lib/src/types.js +274 -133
  112. package/lib/src/types.js.map +1 -1
  113. package/lib/src/utils/embedApi/contracts.d.ts +101 -0
  114. package/lib/src/utils/embedApi/contracts.d.ts.map +1 -0
  115. package/lib/src/utils/embedApi/contracts.js +14 -0
  116. package/lib/src/utils/embedApi/contracts.js.map +1 -0
  117. package/lib/src/utils/embedApi/embedApiClient.d.ts +12 -0
  118. package/lib/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  119. package/lib/src/utils/embedApi/embedApiClient.js +42 -0
  120. package/lib/src/utils/embedApi/embedApiClient.js.map +1 -0
  121. package/lib/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  122. package/lib/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  123. package/lib/src/utils/embedApi/processEmbedApi.js +14 -0
  124. package/lib/src/utils/embedApi/processEmbedApi.js.map +1 -0
  125. package/lib/src/visual-embed-sdk.d.ts +317 -168
  126. package/package.json +1 -1
  127. package/src/embed/app.ts +11 -2
  128. package/src/embed/hostEventClient/contracts.ts +1 -1
  129. package/src/embed/liveboard.spec.ts +23 -2
  130. package/src/embed/liveboard.ts +11 -8
  131. package/src/embed/ts-embed.spec.ts +160 -1
  132. package/src/embed/ts-embed.ts +4 -4
  133. package/src/types.ts +300 -164
package/src/types.ts CHANGED
@@ -17,7 +17,7 @@ import type { SessionInterface } from './utils/graphql/answerService/answerServi
17
17
  // eslint-disable-next-line no-shadow
18
18
  export enum AuthType {
19
19
  /**
20
- * No authentication on the SDK. Passthrough to the embedded App. Alias for
20
+ * No authentication on the SDK. Pass-through to the embedded App. Alias for
21
21
  * `Passthrough`.
22
22
  * @example
23
23
  * ```js
@@ -216,8 +216,8 @@ export interface customCssInterface {
216
216
  /**
217
217
  * The custom css variables, which can be set.
218
218
  * The allowed list is in the CustomCssVariables
219
- * interface.
220
- * Or here: https://try-everywhere.thoughtspot.cloud/resources/static/css/custom_variables.css
219
+ * interface. For more information, see
220
+ * link:https://developers.thoughtspot.com/docs/css-variables-reference
221
221
  */
222
222
  variables?: CustomCssVariables;
223
223
  /**
@@ -261,7 +261,7 @@ export interface CustomStyles {
261
261
 
262
262
  /**
263
263
  * Configuration to define the customization on the Embedded
264
- * Thoughtspot components.
264
+ * ThoughtSpot components.
265
265
  * You can customize styles, text strings, and icons.
266
266
  * For more information, see https://developers.thoughtspot.com/docs/custom-css.
267
267
  * @example
@@ -388,7 +388,7 @@ export interface EmbedConfig {
388
388
  /**
389
389
  * Boolean to define if the query parameters in the ThoughtSpot URL
390
390
  * should be encoded in base64. This provides additional security to
391
- * Thoughtspot clusters against cross-site scripting attacks.
391
+ * ThoughtSpot clusters against cross-site scripting attacks.
392
392
  * @default false
393
393
  */
394
394
  shouldEncodeUrlQueryParams?: boolean;
@@ -553,18 +553,18 @@ export interface EmbedConfig {
553
553
  */
554
554
  disableSDKTracking?: boolean;
555
555
  /**
556
- * Overrides default/user preffered locale for date formatting
557
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
556
+ * Overrides default/user preferred locale for date formatting
557
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
558
558
  */
559
559
  dateFormatLocale?: string;
560
560
  /**
561
- * Overrides default/user preffered locale for number formatting
562
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
561
+ * Overrides default/user preferred locale for number formatting
562
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
563
563
  */
564
564
  numberFormatLocale?: string;
565
565
  /**
566
566
  * Format to be used for currency when currency format is set to infer from browser
567
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
567
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
568
568
  */
569
569
  currencyFormat?: string;
570
570
 
@@ -579,13 +579,13 @@ export interface EmbedConfig {
579
579
  * disableTokenVerification : true
580
580
  * })
581
581
  * ```
582
- * @version SDK: 1.28.5 | Thoughtspot: *
582
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
583
583
  */
584
584
  disableTokenVerification?: boolean;
585
585
 
586
586
  /**
587
587
  * This flag is used to disable showing the login failure page in the embedded app.
588
- * @version SDK 1.32.3 | Thoughtspot: *
588
+ * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
589
589
  */
590
590
  disableLoginFailurePage?: boolean;
591
591
  /**
@@ -621,7 +621,7 @@ export interface EmbedConfig {
621
621
  * }
622
622
  * });
623
623
  * ```
624
- * @version SDK 1.37.0 | Thoughtspot: 10.7.0.cl
624
+ * @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
625
625
  */
626
626
  customVariablesForThirdPartyTools?: Record< string, any >;
627
627
  }
@@ -784,7 +784,7 @@ export interface ViewConfig {
784
784
  /**
785
785
  * The list of parameter override to apply to a search answer,
786
786
  * visualization, or Liveboard.
787
- * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
787
+ * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
788
788
  * @example
789
789
  * ```js
790
790
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -842,7 +842,7 @@ export interface ViewConfig {
842
842
  /**
843
843
  * Insert as a sibling of the target container, instead of appending to a
844
844
  * child inside it.
845
- * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
845
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
846
846
  * @example
847
847
  * ```js
848
848
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -915,7 +915,7 @@ export interface ViewConfig {
915
915
  * 'f547ec54-2a37-4516-a222-2b06719af726']
916
916
  * });
917
917
  * ```
918
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
918
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
919
919
  */
920
920
  hiddenTabs?: string[];
921
921
  /**
@@ -925,7 +925,7 @@ export interface ViewConfig {
925
925
  * **Note**: This option does not apply to the classic homepage.
926
926
  * To access the updated modular homepage, set
927
927
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
928
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
928
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
929
929
  * @example
930
930
  * ```js
931
931
  * const embed = new AppEmbed('#tsEmbed', {
@@ -942,7 +942,7 @@ export interface ViewConfig {
942
942
  * **Note**: This option does not apply to the classic homepage.
943
943
  * To access the updated modular homepage, set
944
944
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
945
- * @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
945
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
946
946
  * @example
947
947
  * ```js
948
948
  * const embed = new AppEmbed('#tsEmbed', {
@@ -957,7 +957,7 @@ export interface ViewConfig {
957
957
  * Only the tabs specified in the array will be shown in the Liveboard.
958
958
  *
959
959
  * Use either `visibleTabs` or `hiddenTabs`.
960
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
960
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
961
961
  * @example
962
962
  * ```js
963
963
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -985,7 +985,7 @@ export interface ViewConfig {
985
985
  * **Note**: This option does not apply to the classic homepage.
986
986
  * To access the updated modular homepage, set
987
987
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
988
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
988
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
989
989
  */
990
990
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
991
991
  /**
@@ -1000,7 +1000,7 @@ export interface ViewConfig {
1000
1000
  * });
1001
1001
  * embed.showPreRender();
1002
1002
  * ```
1003
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
1003
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1004
1004
  */
1005
1005
  preRenderId?: string;
1006
1006
 
@@ -1056,7 +1056,7 @@ export interface ViewConfig {
1056
1056
  /**
1057
1057
  * To set the initial state of the search bar in case of saved Answers.
1058
1058
  * @default true
1059
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
1059
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
1060
1060
  * @example
1061
1061
  * ```js
1062
1062
  * const embed = new LiveboardEmbed('#embed', {
@@ -1080,7 +1080,7 @@ export interface ViewConfig {
1080
1080
  /**
1081
1081
  * Flag to control Data panel experience
1082
1082
  * @default false
1083
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
1083
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
1084
1084
  * @example
1085
1085
  * ```js
1086
1086
  * const embed = new AppEmbed('#tsEmbed', {
@@ -1092,7 +1092,7 @@ export interface ViewConfig {
1092
1092
  dataPanelV2?: boolean;
1093
1093
  /**
1094
1094
  * To enable custom column groups in data panel v2
1095
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1095
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
1096
1096
  * @default false
1097
1097
  * @example
1098
1098
  * ```js
@@ -1120,9 +1120,10 @@ export interface ViewConfig {
1120
1120
  */
1121
1121
  overrideOrgId?: number;
1122
1122
  /**
1123
- * Flag to control new flip tooltip context menu experience
1123
+ * Flag to enhance the visual effects of charts
1124
+ * This feature is a beta release for 10.6
1124
1125
  * @default false
1125
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
1126
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
1126
1127
  */
1127
1128
  enableFlipTooltipToContextMenu?: boolean;
1128
1129
  }
@@ -1255,7 +1256,7 @@ export enum RuntimeFilterOp {
1255
1256
  * **Note**: This option does not apply to the classic homepage.
1256
1257
  * To access the updated modular homepage, set
1257
1258
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
1258
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
1259
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1259
1260
  */
1260
1261
  // eslint-disable-next-line no-shadow
1261
1262
  export enum HomepageModule {
@@ -2102,7 +2103,7 @@ export enum EmbedEvent {
2102
2103
  */
2103
2104
  Explore = 'explore',
2104
2105
  /**
2105
- * Emitted when a user clicks **Copy link** action on a visualization
2106
+ * Emitted when a user clicks **Copy link** action on a visualization.
2106
2107
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2107
2108
  * @example
2108
2109
  *```js
@@ -2152,23 +2153,26 @@ export enum EmbedEvent {
2152
2153
  */
2153
2154
  FilterChanged = 'filterChanged',
2154
2155
  /**
2155
- * Emitted when a user clicks the **Go** button on the sage embed
2156
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2156
+ * Emitted when a user clicks the **Go** button to initiate
2157
+ * a Natural Language Search query
2158
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2157
2159
  */
2158
2160
  SageEmbedQuery = 'sageEmbedQuery',
2159
2161
  /**
2160
- * Emitted when a user selects a data source on the sage embed
2161
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2162
+ * Emitted when a user selects a data source on the embedded
2163
+ * Natural Language Search interface.
2164
+ *
2165
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2162
2166
  */
2163
2167
  SageWorksheetUpdated = 'sageWorksheetUpdated',
2164
2168
  /**
2165
2169
  * Emitted when a user updates a connection on the **Data** page
2166
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
2170
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
2167
2171
  */
2168
2172
  UpdateConnection = 'updateConnection',
2169
2173
  /**
2170
2174
  * Emitted when a user updates a connection on the **Data** page
2171
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
2175
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
2172
2176
  */
2173
2177
  CreateConnection = 'createConnection',
2174
2178
  /**
@@ -2178,7 +2182,7 @@ export enum EmbedEvent {
2178
2182
  * @returns viewId: string
2179
2183
  * @returns liveboardId: string
2180
2184
  * @returns isPublic: boolean
2181
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2185
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2182
2186
  */
2183
2187
  UpdatePersonalisedView = 'updatePersonalisedView',
2184
2188
  /**
@@ -2187,7 +2191,7 @@ export enum EmbedEvent {
2187
2191
  * @returns viewId: string
2188
2192
  * @returns liveboardId: string
2189
2193
  * @returns isPublic: boolean
2190
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2194
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2191
2195
  */
2192
2196
  SavePersonalisedView = 'savePersonalisedView',
2193
2197
  /**
@@ -2196,28 +2200,28 @@ export enum EmbedEvent {
2196
2200
  * @returns viewId: string
2197
2201
  * @returns liveboardId: string
2198
2202
  * @returns isPublic: boolean
2199
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2203
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2200
2204
  */
2201
2205
  ResetLiveboard = 'resetLiveboard',
2202
2206
  /**
2203
2207
  * Emitted when a PersonalisedView is deleted.
2204
2208
  * @returns views: string[]
2205
2209
  * @returns liveboardId: string
2206
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
2210
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2207
2211
  */
2208
2212
  DeletePersonalisedView = 'deletePersonalisedView',
2209
2213
  /**
2210
2214
  * Emitted when a user creates a new worksheet
2211
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
2215
+ * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
2212
2216
  */
2213
2217
  CreateWorksheet = 'createWorksheet',
2214
2218
  /**
2215
- * Emitted when Ask Sage is initialized.
2219
+ * Emitted when the *Ask Sage* is initialized.
2216
2220
  * @returns viewName: string
2217
2221
  * @returns viewId: string
2218
2222
  * @returns liveboardId: string
2219
2223
  * @returns isPublic: boolean
2220
- * @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
2224
+ * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
2221
2225
  */
2222
2226
  AskSageInit = 'AskSageInit',
2223
2227
  /**
@@ -2245,7 +2249,7 @@ export enum EmbedEvent {
2245
2249
  *
2246
2250
  * error: Developers can customize the error message text when `execute`
2247
2251
  * returns `false` using the error parameter in responder.
2248
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
2252
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
2249
2253
  * @example
2250
2254
  *```js
2251
2255
  * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -2293,9 +2297,26 @@ export enum EmbedEvent {
2293
2297
  * console.log('payload', payload);
2294
2298
  * })
2295
2299
  *```
2296
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
2300
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
2297
2301
  */
2298
2302
  ParameterChanged = 'parameterChanged',
2303
+ /**
2304
+ * Emitted when the table viz renders.
2305
+ * You can use this event as a hook to trigger
2306
+ * other events on the rendered table viz data.
2307
+ * @example
2308
+ * ```js
2309
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
2310
+ * console.log(payload);
2311
+ * const columnDataLite = payload.data.data.columnDataLite;
2312
+ * columnDataLite[0].dataValue[0]="new fob";
2313
+ * console.log('>>> new Data', columnDataLite);
2314
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
2315
+ * })
2316
+ * ```
2317
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
2318
+ */
2319
+ TableVizRendered = 'TableVizRendered',
2299
2320
  }
2300
2321
 
2301
2322
  /**
@@ -2442,7 +2463,7 @@ export enum HostEvent {
2442
2463
  * const url = embed.trigger(HostEvent.GetIframeUrl);
2443
2464
  * console.log("iFrameURL",url);
2444
2465
  * ```
2445
- * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
2466
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
2446
2467
  */
2447
2468
  GetIframeUrl = 'GetIframeUrl',
2448
2469
  /**
@@ -2475,6 +2496,11 @@ export enum HostEvent {
2475
2496
  * attributes passed with this event are appended to the existing runtime
2476
2497
  * filters applied on a Liveboard.
2477
2498
  *
2499
+ * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
2500
+ * and `AppEmbed` only. In full application embedding, this event updates
2501
+ * the runtime filters applied on the Liveboard and saved Answer objects.
2502
+ *
2503
+ *
2478
2504
  * Pass an array of runtime filters with the following attributes:
2479
2505
  *
2480
2506
  * `columnName` - _String_. The name of the column to filter on.
@@ -2485,9 +2511,12 @@ export enum HostEvent {
2485
2511
  * `values` - List of operands. Some operators such as EQ and LE allow a
2486
2512
  * single value, whereas BW and IN accept multiple values.
2487
2513
  *
2488
- * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
2489
- * and `AppEmbed` only. In full application embedding, this event updates
2490
- * the runtime filters applied on the Liveboard and saved Answer objects.
2514
+ * **Note**: Updating runtime filters resets the ThoughtSpot
2515
+ * object to its original state and applies new filter conditions.
2516
+ * Any user changes (like drilling into a visualization)
2517
+ * will be cleared, restoring the original visualization
2518
+ * with the updated filters.
2519
+ *
2491
2520
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
2492
2521
  * @example
2493
2522
  * ```js
@@ -2502,7 +2531,7 @@ export enum HostEvent {
2502
2531
  UpdateRuntimeFilters = 'UpdateRuntimeFilters',
2503
2532
  /**
2504
2533
  * Navigate to a specific page in the embedded ThoughtSpot application.
2505
- * This is the same as calling `appEmbed.navigateToPage(path, true)`
2534
+ * This is the same as calling `appEmbed.navigateToPage(path, true)`.
2506
2535
  * @param - `path` - the path to navigate to to go forward or back. The path value can
2507
2536
  * be a number; for example, `1`, `-1`.
2508
2537
  * @example
@@ -2698,7 +2727,7 @@ export enum HostEvent {
2698
2727
  * @param - an object with `vizId` as a key
2699
2728
  * @example
2700
2729
  * ```js
2701
- * liveboardEmbed.trigger(HostEvent.CreateMonitor {
2730
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
2702
2731
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2703
2732
  * })
2704
2733
  * ```
@@ -2797,7 +2826,9 @@ export enum HostEvent {
2797
2826
  */
2798
2827
  GetTML = 'getTML',
2799
2828
  /**
2800
- * Trigger the **Show underlying data** action on visualization or search
2829
+ * Trigger the **Show underlying data** action on a
2830
+ * chart or table.
2831
+ *
2801
2832
  * @param - an object with vizId as a key
2802
2833
  * @example
2803
2834
  * ```js
@@ -2831,8 +2862,8 @@ export enum HostEvent {
2831
2862
  */
2832
2863
  Delete = 'onDeleteAnswer',
2833
2864
  /**
2834
- * Trigger the **SpotIQ analyze** action on visualization
2835
- * or search.
2865
+ * Trigger the **SpotIQ analyze** action on a
2866
+ * chart or table.
2836
2867
  * @param - Liveboard embed takes `vizId` as a
2837
2868
  * key. Can be left undefined when embedding Search or
2838
2869
  * visualization.
@@ -3105,7 +3136,7 @@ export enum HostEvent {
3105
3136
  * '430496d6-6903-4601-937e-2c691821af3c',
3106
3137
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
3107
3138
  * ```
3108
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3139
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3109
3140
  */
3110
3141
  SetVisibleTabs = 'SetPinboardVisibleTabs',
3111
3142
  /**
@@ -3118,7 +3149,7 @@ export enum HostEvent {
3118
3149
  * '630496d6-6903-4601-937e-2c691821af3c',
3119
3150
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
3120
3151
  * ```
3121
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3152
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3122
3153
  */
3123
3154
  SetHiddenTabs = 'SetPinboardHiddenTabs',
3124
3155
  /**
@@ -3132,7 +3163,7 @@ export enum HostEvent {
3132
3163
  * executeSearch: true,
3133
3164
  * })
3134
3165
  * ```
3135
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
3166
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3136
3167
  */
3137
3168
  UpdateSageQuery = 'updateSageQuery',
3138
3169
  /**
@@ -3149,21 +3180,22 @@ export enum HostEvent {
3149
3180
  * ```js
3150
3181
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
3151
3182
  * ```
3152
- * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
3183
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
3153
3184
  */
3154
3185
  GetAnswerSession = 'getAnswerSession',
3155
3186
  /**
3156
- * Trigger Ask Sage for viz
3187
+ * Trigger the *Ask Sage* action for visualizations
3157
3188
  * @example
3158
3189
  * ```js
3159
3190
  * liveboardEmbed.trigger(HostEvent.AskSage,
3160
3191
  * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
3161
3192
  * ```
3162
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
3193
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3163
3194
  */
3164
3195
  AskSage = 'AskSage',
3165
3196
  /**
3166
- * Trigger cross filter update action on a Liveboard
3197
+ * Trigger cross filter update action on a Liveboard.
3198
+ *
3167
3199
  * @example
3168
3200
  * ```js
3169
3201
  * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -3174,7 +3206,7 @@ export enum HostEvent {
3174
3206
  * ],
3175
3207
  * });
3176
3208
  * ```
3177
- * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
3209
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
3178
3210
  */
3179
3211
  UpdateCrossFilter = 'UpdateCrossFilter',
3180
3212
  /**
@@ -3183,11 +3215,13 @@ export enum HostEvent {
3183
3215
  * ```js
3184
3216
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
3185
3217
  * ```
3186
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
3218
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
3187
3219
  */
3188
3220
  ResetLiveboardPersonalisedView = 'ResetLiveboardPersonalisedView',
3189
3221
  /**
3190
- * Triggers an event to Update Parameter values for Answers and Liveboard
3222
+ * Triggers an action to update Parameter values on embedded
3223
+ * Answers and Liveboard.
3224
+ *
3191
3225
  * @example
3192
3226
  * ```js
3193
3227
  * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -3195,30 +3229,30 @@ export enum HostEvent {
3195
3229
  * value: "almond"
3196
3230
  * }])
3197
3231
  *
3198
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
3232
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
3199
3233
  */
3200
3234
  UpdateParameters = 'UpdateParameters',
3201
3235
  /**
3202
- * Triggers GetParameters to fetch the runtime parameters
3236
+ * Triggers GetParameters to fetch the runtime Parameters.
3203
3237
  * ```js
3204
3238
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
3205
3239
  * console.log('parameters', parameter);
3206
3240
  * });
3207
3241
  *```
3208
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
3242
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
3209
3243
  */
3210
3244
  GetParameters = 'GetParameters',
3211
3245
  /**
3212
- * Triggers an event to update a persoanlised view of a Liveboard
3246
+ * Triggers an event to update a personalized view of a Liveboard.
3213
3247
  * ```js
3214
3248
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
3215
3249
  * ```
3216
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3250
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
3217
3251
  */
3218
3252
  UpdatePersonalisedView = 'UpdatePersonalisedView',
3219
3253
  /**
3220
- * Triggers the action to get the current view of the liveboard
3221
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3254
+ * Triggers the action to get the current view of the Liveboard.
3255
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
3222
3256
  */
3223
3257
  SaveAnswer = 'saveAnswer',
3224
3258
  /**
@@ -3226,6 +3260,25 @@ export enum HostEvent {
3226
3260
  * @hidden
3227
3261
  */
3228
3262
  UIPassthrough = 'UiPassthrough',
3263
+ /**
3264
+ * Triggers the table viz rerender with the updated data.
3265
+ * Includes the following properties:
3266
+ * @param - columnDataLite - an array of object containing data
3267
+ * transformed from data picked from TableVizRendered event.
3268
+ * For example, { columnDataLite: []}
3269
+ * @example
3270
+ * ```js
3271
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
3272
+ * console.log(payload);
3273
+ * const columnDataLite = payload.data.data.columnDataLite;
3274
+ * columnDataLite[0].dataValue[0]="new fob";
3275
+ * console.log('>>> new Data', columnDataLite);
3276
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
3277
+ * })
3278
+ * ```
3279
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
3280
+ */
3281
+ TransformTableVizData = 'TransformTableVizData',
3229
3282
  }
3230
3283
 
3231
3284
  /**
@@ -3292,7 +3345,12 @@ export enum Param {
3292
3345
  AuthType = 'authType',
3293
3346
  IconSpriteUrl = 'iconSprite',
3294
3347
  cookieless = 'cookieless',
3295
- ContextMenuTrigger = 'isContextMenuEnabledOnLeftClick',
3348
+ // Deprecated: `isContextMenuEnabledOnLeftClick`
3349
+ // Introduced: `contextMenuEnabledOnWhichClick` with values: 'left',
3350
+ // 'right', or 'both'. This update only affects ThoughtSpot URL parameters
3351
+ // and does not impact existing workflows or use cases. Added support for
3352
+ // 'both' clicks in `contextMenuTrigger` configuration.
3353
+ ContextMenuTrigger = 'contextMenuEnabledOnWhichClick',
3296
3354
  LinkOverride = 'linkOverride',
3297
3355
  blockNonEmbedFullAppAccess = 'blockNonEmbedFullAppAccess',
3298
3356
  ShowInsertToSlide = 'insertInToSlide',
@@ -3445,7 +3503,8 @@ export enum Action {
3445
3503
  ResetLayout = 'resetLayout',
3446
3504
  /**
3447
3505
  * The **Schedule** menu action on a Liveboard.
3448
- * Allows scheduling a Liveboard notification.
3506
+ * Allows scheduling a Liveboard job, for example,
3507
+ * sending periodic notifications.
3449
3508
  * @example
3450
3509
  * ```js
3451
3510
  * disabledActions: [Action.Schedule]
@@ -3487,7 +3546,7 @@ export enum Action {
3487
3546
  * ```js
3488
3547
  * disabledActions: [Action.AddDataPanelObjects]
3489
3548
  * ```
3490
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
3549
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
3491
3550
  */
3492
3551
  AddDataPanelObjects = 'addDataPanelObjects',
3493
3552
  /**
@@ -3500,7 +3559,28 @@ export enum Action {
3500
3559
  * ```
3501
3560
  */
3502
3561
  ConfigureFilter = 'configureFilter',
3562
+ /**
3563
+ * The **Collapse data sources** icon on the Search page.
3564
+ * Collapses the panel showing data sources.
3565
+ *
3566
+ * @example
3567
+ * ```js
3568
+ * disabledActions: [Action.CollapseDataPanel]
3569
+ * ```
3570
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
3571
+ */
3503
3572
  CollapseDataSources = 'collapseDataSources',
3573
+ /**
3574
+ * The **Collapse data panel** icon on the Search page.
3575
+ * Collapses the data panel view.
3576
+ *
3577
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
3578
+ *
3579
+ * @example
3580
+ * ```js
3581
+ * disabledActions: [Action.CollapseDataPanel]
3582
+ * ```
3583
+ */
3504
3584
  CollapseDataPanel = 'collapseDataPanel',
3505
3585
  /**
3506
3586
  * The **Choose sources** button on Search page.
@@ -3536,7 +3616,7 @@ export enum Action {
3536
3616
  * ```js
3537
3617
  * disabledActions: [Action.AddColumnSet]
3538
3618
  * ```
3539
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
3619
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
3540
3620
  */
3541
3621
  AddColumnSet = 'addSimpleCohort',
3542
3622
  /**
@@ -3546,7 +3626,7 @@ export enum Action {
3546
3626
  * ```js
3547
3627
  * disabledActions: [Action.AddQuerySet]
3548
3628
  * ```
3549
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
3629
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
3550
3630
  */
3551
3631
  AddQuerySet = 'addAdvancedCohort',
3552
3632
  /**
@@ -3578,6 +3658,8 @@ export enum Action {
3578
3658
  /**
3579
3659
  * The **Show underlying data** menu action on a visualization or
3580
3660
  * Answer page.
3661
+ * Displays detailed information and raw data
3662
+ * for a given visualization.
3581
3663
  * @example
3582
3664
  * ```js
3583
3665
  * disabledActions: [Action.ShowUnderlyingData]
@@ -3779,6 +3861,7 @@ export enum Action {
3779
3861
  AnalysisInfo = 'analysisInfo',
3780
3862
  /**
3781
3863
  * The **Schedule** menu action on a Liveboard.
3864
+ * Allows scheduling a Liveboard job.
3782
3865
  * @example
3783
3866
  * ```js
3784
3867
  * disabledActions: [Action.Subscription]
@@ -3849,8 +3932,13 @@ export enum Action {
3849
3932
  */
3850
3933
  RequestAccess = 'requestAccess',
3851
3934
  /**
3852
- * The **Query visualizer** and **Query SQL** buttons in Query details panel
3853
- * of the Answer page
3935
+ * The **Query visualizer** and **Query SQL** buttons in
3936
+ * Query details panel of the Answer page.
3937
+ *
3938
+ * **Query visualizer** - Displays the tables
3939
+ * and filters used in a search query.
3940
+ * **Query SQL** - Displays the SQL statements used
3941
+ * in a search query to fetch data.
3854
3942
  * @example
3855
3943
  * ```js
3856
3944
  * disabledActions: [Action.QueryDetailsButtons]
@@ -3868,7 +3956,10 @@ export enum Action {
3868
3956
  */
3869
3957
  AnswerDelete = 'onDeleteAnswer',
3870
3958
  /**
3871
- * The Chart switcher icon on Answer and visualization pages.
3959
+ * The chart switcher icon on Answer page and
3960
+ * visualizations in edit mode.
3961
+ * Allows switching to the table or chart mode
3962
+ * when editing a visualization.
3872
3963
  * @example
3873
3964
  * ```js
3874
3965
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -3877,7 +3968,10 @@ export enum Action {
3877
3968
  */
3878
3969
  AnswerChartSwitcher = 'answerChartSwitcher',
3879
3970
  /**
3880
- * Favorites icon (*) on Answers, Liveboard, and Data pages
3971
+ * The Favorites icon (*) for Answers,
3972
+ * Liveboard, and data objects like Worksheet, Model,
3973
+ * Tables and Views.
3974
+ * Allows adding an object to the user’s favorites list.
3881
3975
  * @example
3882
3976
  * ```js
3883
3977
  * disabledActions: [Action.AddToFavorites]
@@ -3895,7 +3989,9 @@ export enum Action {
3895
3989
  */
3896
3990
  EditDetails = 'editDetails',
3897
3991
  /**
3898
- * The Create alert action on KPI charts.
3992
+ * The *Create alert* action for KPI charts.
3993
+ * Allows users to schedule threshold-based alerts
3994
+ * for KPI charts.
3899
3995
  * @example
3900
3996
  * ```js
3901
3997
  * disabledActions: [Action.CreateMonitor]
@@ -3951,7 +4047,7 @@ export enum Action {
3951
4047
  * ```js
3952
4048
  * disabledActions: [Action.CrossFilter]
3953
4049
  * ```
3954
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4050
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
3955
4051
  */
3956
4052
  CrossFilter = 'context-menu-item-cross-filter',
3957
4053
  /**
@@ -3961,7 +4057,7 @@ export enum Action {
3961
4057
  * ```js
3962
4058
  * disabledActions: [Action.SyncToSlack]
3963
4059
  * ```
3964
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
4060
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
3965
4061
  */
3966
4062
  SyncToSlack = 'syncToSlack',
3967
4063
  /**
@@ -3971,7 +4067,7 @@ export enum Action {
3971
4067
  * ```js
3972
4068
  * disabledActions: [Action.SyncToTeams]
3973
4069
  * ```
3974
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
4070
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
3975
4071
  */
3976
4072
  SyncToTeams = 'syncToTeams',
3977
4073
  /**
@@ -3982,7 +4078,7 @@ export enum Action {
3982
4078
  * ```js
3983
4079
  * disabledActions: [Action.RemoveCrossFilter]
3984
4080
  * ```
3985
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4081
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3986
4082
  */
3987
4083
  RemoveCrossFilter = 'context-menu-item-remove-cross-filter',
3988
4084
  /**
@@ -3993,7 +4089,7 @@ export enum Action {
3993
4089
  * ```js
3994
4090
  * disabledActions: [Action.AxisMenuAggregate]
3995
4091
  * ```
3996
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4092
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
3997
4093
  */
3998
4094
  AxisMenuAggregate = 'axisMenuAggregate',
3999
4095
  /**
@@ -4004,17 +4100,19 @@ export enum Action {
4004
4100
  * ```js
4005
4101
  * disabledActions: [Action.AxisMenuTimeBucket]
4006
4102
  * ```
4007
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4103
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4008
4104
  */
4009
4105
  AxisMenuTimeBucket = 'axisMenuTimeBucket',
4010
4106
  /**
4011
4107
  * The **Filter** action in the chart axis or table column
4012
4108
  * customization menu.
4109
+ * Allows adding, editing, or removing filters.
4110
+ *
4013
4111
  * @example
4014
4112
  * ```js
4015
4113
  * disabledActions: [Action.AxisMenuFilter]
4016
4114
  * ```
4017
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4115
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4018
4116
  */
4019
4117
  AxisMenuFilter = 'axisMenuFilter',
4020
4118
  /**
@@ -4025,7 +4123,7 @@ export enum Action {
4025
4123
  * ```js
4026
4124
  * disabledActions: [Action.AxisMenuConditionalFormat]
4027
4125
  * ```
4028
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4126
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4029
4127
  */
4030
4128
  AxisMenuConditionalFormat = 'axisMenuConditionalFormat',
4031
4129
  /**
@@ -4036,7 +4134,7 @@ export enum Action {
4036
4134
  * ```js
4037
4135
  * disabledActions: [Action.AxisMenuConditionalFormat]
4038
4136
  * ```
4039
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4137
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4040
4138
  */
4041
4139
  AxisMenuSort = 'axisMenuSort',
4042
4140
  /**
@@ -4048,7 +4146,7 @@ export enum Action {
4048
4146
  * ```js
4049
4147
  * disabledActions: [Action.AxisMenuGroup]
4050
4148
  * ```
4051
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4149
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4052
4150
  */
4053
4151
  AxisMenuGroup = 'axisMenuGroup',
4054
4152
  /**
@@ -4059,7 +4157,7 @@ export enum Action {
4059
4157
  * ```js
4060
4158
  * disabledActions: [Action.AxisMenuPosition]
4061
4159
  * ```
4062
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4160
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4063
4161
  */
4064
4162
  AxisMenuPosition = 'axisMenuPosition',
4065
4163
  /**
@@ -4069,7 +4167,7 @@ export enum Action {
4069
4167
  * ```js
4070
4168
  * disabledActions: [Action.AxisMenuRename]
4071
4169
  * ```
4072
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4170
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4073
4171
  */
4074
4172
  AxisMenuRename = 'axisMenuRename',
4075
4173
  /**
@@ -4080,7 +4178,7 @@ export enum Action {
4080
4178
  * ```js
4081
4179
  * disabledActions: [Action.AxisMenuEdit]
4082
4180
  * ```
4083
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4181
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4084
4182
  */
4085
4183
  AxisMenuEdit = 'axisMenuEdit',
4086
4184
  /**
@@ -4090,7 +4188,7 @@ export enum Action {
4090
4188
  * ```js
4091
4189
  * disabledActions: [Action.AxisMenuNumberFormat]
4092
4190
  * ```
4093
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4191
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4094
4192
  */
4095
4193
  AxisMenuNumberFormat = 'axisMenuNumberFormat',
4096
4194
  /**
@@ -4100,7 +4198,7 @@ export enum Action {
4100
4198
  * ```js
4101
4199
  * disabledActions: [Action.AxisMenuTextWrapping]
4102
4200
  * ```
4103
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4201
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4104
4202
  */
4105
4203
  AxisMenuTextWrapping = 'axisMenuTextWrapping',
4106
4204
  /**
@@ -4112,7 +4210,7 @@ export enum Action {
4112
4210
  * ```js
4113
4211
  * disabledActions: [Action.AxisMenuRemove]
4114
4212
  * ```
4115
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4213
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
4116
4214
  */
4117
4215
  AxisMenuRemove = 'axisMenuRemove',
4118
4216
  /**
@@ -4126,26 +4224,27 @@ export enum Action {
4126
4224
  * ```js
4127
4225
  * disabledActions: [Action.RenameModalTitleDescription]
4128
4226
  * ```
4129
- * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
4227
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
4130
4228
  */
4131
4229
  RenameModalTitleDescription = 'renameModalTitleDescription',
4132
4230
  /**
4133
- *
4231
+ * The *Request verification* action on a Liveboard.
4232
+ * Initiates a request for Liveboard verification.
4134
4233
  * @example
4135
4234
  * ```js
4136
4235
  * disabledActions: [Action.RequestVerification]
4137
4236
  * ```
4138
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
4237
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
4139
4238
  */
4140
4239
  RequestVerification = 'requestVerification',
4141
4240
  /**
4142
4241
  *
4143
- *Allows users to mark a Liveboard as verified.
4242
+ * Allows users to mark a Liveboard as verified.
4144
4243
  * @example
4145
4244
  * ```js
4146
4245
  * disabledActions: [Action.MarkAsVerified]
4147
4246
  * ```
4148
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
4247
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
4149
4248
  */
4150
4249
  MarkAsVerified = 'markAsVerified',
4151
4250
  /**
@@ -4155,7 +4254,7 @@ export enum Action {
4155
4254
  * ```js
4156
4255
  * disabledActions: [Action.AddTab]
4157
4256
  * ```
4158
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4257
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4159
4258
  */
4160
4259
  AddTab = 'addTab',
4161
4260
  /**
@@ -4165,35 +4264,42 @@ export enum Action {
4165
4264
  * ```js
4166
4265
  * disabledActions: [Action.EnableContextualChangeAnalysis]
4167
4266
  * ```
4168
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
4267
+ * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
4169
4268
  */
4170
4269
  EnableContextualChangeAnalysis = 'enableContextualChangeAnalysis',
4171
4270
  /**
4271
+ * Action ID to hide or disable Natural Language Search query.
4172
4272
  *
4173
4273
  * @example
4174
4274
  * ```js
4175
4275
  * disabledActions: [Action.ShowSageQuery]
4176
4276
  * ```
4177
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4277
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
4178
4278
  */
4179
4279
  ShowSageQuery = 'showSageQuery',
4180
4280
  /**
4281
+ *
4282
+ * Action ID to hide or disable the edit option for the
4283
+ * results generated from the
4284
+ * Natural Language Search query.
4181
4285
  *
4182
4286
  * @example
4183
4287
  * ```js
4184
4288
  * disabledActions: [Action.EditSageAnswer]
4185
4289
  * ```
4186
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4290
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
4187
4291
  */
4188
4292
  EditSageAnswer = 'editSageAnswer',
4189
4293
  /**
4294
+ * The feedback widget for AI-generated Answers.
4295
+ * Allows users to send feedback on the Answers generated
4296
+ * from a Natural Language Search query.
4190
4297
  *
4191
- *This action allows users to send feedback on AI-generated Answers.
4192
4298
  * @example
4193
4299
  * ```js
4194
4300
  * disabledActions: [Action.SageAnswerFeedback]
4195
4301
  * ```
4196
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4302
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
4197
4303
  */
4198
4304
  SageAnswerFeedback = 'sageAnswerFeedback',
4199
4305
  /**
@@ -4202,7 +4308,7 @@ export enum Action {
4202
4308
  * ```js
4203
4309
  * disabledActions: [Action.ModifySageAnswer]
4204
4310
  * ```
4205
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4311
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
4206
4312
  */
4207
4313
  ModifySageAnswer = 'modifySageAnswer',
4208
4314
  /**
@@ -4215,7 +4321,10 @@ export enum Action {
4215
4321
  */
4216
4322
  MoveToTab = 'onContainerMove',
4217
4323
  /**
4218
- * The **Manage Alertsb** menu action on KPI visualizations.
4324
+ * The **Manage Alerts** menu action on KPI visualizations.
4325
+ * Allows creating, viewing, and editing monitor
4326
+ * alerts for a KPI chart.
4327
+ *
4219
4328
  * @example
4220
4329
  * ```js
4221
4330
  * disabledActions: [Action.ManageMonitor]
@@ -4223,21 +4332,23 @@ export enum Action {
4223
4332
  */
4224
4333
  ManageMonitor = 'manageMonitor',
4225
4334
  /**
4226
- * Action ID for Liveboard Personalised Views dropdown
4335
+ * The Liveboard Personalised Views dropdown.
4336
+ * Allows navigating to a personalized Liveboard View.
4227
4337
  * @example
4228
4338
  * ```js
4229
4339
  * disabledActions: [Action.PersonalisedViewsDropdown]
4230
4340
  * ```
4231
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
4341
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
4232
4342
  */
4233
4343
  PersonalisedViewsDropdown = 'personalisedViewsDropdown',
4234
4344
  /**
4235
- * Action ID for Liveboard Users ( Recently Visited / social proof )
4345
+ * Action ID for show or hide the user details on a
4346
+ * Liveboard (Recently visited / social proof)
4236
4347
  * @example
4237
4348
  * ```js
4238
4349
  * disabledActions: [Action.LiveboardUsers]
4239
4350
  * ```
4240
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
4351
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
4241
4352
  */
4242
4353
  LiveboardUsers = 'liveboardUsers',
4243
4354
 
@@ -4256,119 +4367,133 @@ export enum Action {
4256
4367
  * hiddenAction: [Action.TML] // hide all TML actions
4257
4368
  * disabledActions: [Action.TML] // to disable all TML actions
4258
4369
  * ```
4259
- * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
4370
+ * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
4260
4371
  */
4261
4372
  TML = 'tml',
4262
-
4263
4373
  /**
4264
- * Action ID for the create Liveboard option on the Liveboard list page
4265
- * and Pin modal
4374
+ * The **Create Liveboard* action on
4375
+ * the Liveboards page and the Pin modal.
4376
+ * Allows users to create a Liveboard.
4377
+ *
4266
4378
  * @example
4267
4379
  * ```js
4268
4380
  * hiddenAction: [Action.CreateLiveboard]
4269
4381
  * disabledActions: [Action.CreateLiveboard]
4270
4382
  * ```
4271
- * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
4383
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4272
4384
  */
4273
4385
  CreateLiveboard = 'createLiveboard',
4274
4386
 
4275
4387
  /**
4276
- * Action ID for to hide Verified Liveboard Banner
4388
+ * Action ID for to hide or disable the
4389
+ * Verified Liveboard banner.
4277
4390
  * @example
4278
4391
  * ```js
4279
4392
  * hiddenAction: [Action.VerifiedLiveboard]
4280
4393
  * ```
4281
- * @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
4394
+ * @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
4282
4395
  */
4283
4396
  VerifiedLiveboard = 'verifiedLiveboard',
4284
4397
 
4285
4398
  /**
4286
- * Action ID for ask sage button
4399
+ * The *Ask Sage* action for Answers and visualizations.
4400
+ * Allows initiating a Natural Language Search query.
4401
+ *
4287
4402
  * @example
4288
4403
  * ```js
4289
4404
  * hiddenAction: [Action.AskAi]
4290
4405
  * ```
4291
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
4406
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
4292
4407
  */
4293
4408
  AskAi = 'AskAi',
4294
4409
 
4295
4410
  /**
4296
4411
  * The **Add KPI to Watchlist** action on Home page watchlist.
4412
+ * Adds a KPI chart to the watchlist on the Home page.
4297
4413
  * @example
4298
4414
  * ```js
4299
4415
  * disabledActions: [Action.AddToWatchlist]
4300
4416
  * ```
4301
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
4417
+ * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
4302
4418
  */
4303
4419
  AddToWatchlist = 'addToWatchlist',
4304
4420
 
4305
4421
  /**
4306
4422
  * The **Remove from watchlist** menu action on KPI watchlist.
4423
+ * Removes a KPI chart from the watchlist on the Home page.
4307
4424
  * @example
4308
4425
  * ```js
4309
4426
  * disabledActions: [Action.RemoveFromWatchlist]
4310
4427
  * ```
4311
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
4428
+ * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
4312
4429
  */
4313
4430
  RemoveFromWatchlist = 'removeFromWatchlist',
4314
-
4315
4431
  /**
4316
- * The **Organise Favourites** action on Homepage Favourite Module.
4432
+ * The **Organize Favourites** action on Homepage
4433
+ * *Favorites* module.
4434
+ *
4317
4435
  * @example
4318
4436
  * ```js
4319
4437
  * disabledActions: [Action.OrganiseFavourites]
4320
4438
  * ```
4321
- * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
4439
+ * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
4322
4440
  */
4323
4441
  OrganiseFavourites = 'organiseFavourites',
4324
4442
 
4325
4443
  /**
4326
- * Action ID for AI Highlights button
4444
+ * The **AI Highlights** action on a Liveboard.
4445
+ *
4327
4446
  * @example
4328
4447
  * ```js
4329
4448
  * hiddenAction: [Action.AIHighlights]
4330
4449
  * ```
4331
- * @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
4450
+ * @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
4332
4451
  */
4333
4452
  AIHighlights = 'AIHighlights',
4334
4453
 
4335
4454
  /**
4336
- * Action ID for edit the schedule action on schedule on homepage
4455
+ * The *Edit* action on the *Liveboard Schedules* page
4456
+ * (new Homepage experience).
4457
+ * Allows editing Liveboard schedules.
4458
+ *
4337
4459
  * @example
4338
4460
  * ```js
4339
4461
  * disabledActions: [Action.EditScheduleHomepage]
4340
4462
  * ```
4341
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
4463
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4342
4464
  */
4343
4465
  EditScheduleHomepage = 'editScheduleHomepage',
4344
4466
 
4345
4467
  /**
4346
- * Action ID for pause schedule action on schedule on homepage
4468
+ * The *Pause* action on the *Liveboard Schedules* page
4469
+ * Pauses a scheduled Liveboard job.
4347
4470
  * @example
4348
4471
  * ```js
4349
4472
  * disabledActions: [Action.PauseScheduleHomepage]
4350
4473
  * ```
4351
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
4474
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4352
4475
  */
4353
4476
  PauseScheduleHomepage = 'pauseScheduleHomepage',
4354
4477
 
4355
4478
  /**
4356
- * Action ID for view schedule run action on schedule on homepage
4479
+ * The **View run history** action **Liveboard Schedules** page.
4480
+ * Allows viewing schedule run history.
4357
4481
  * @example
4358
4482
  * ```js
4359
4483
  * disabledActions: [Action.ViewScheduleRunHomepage]
4360
4484
  * ```
4361
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
4485
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
4362
4486
  */
4363
4487
  ViewScheduleRunHomepage = 'viewScheduleRunHomepage',
4364
4488
 
4365
4489
  /**
4366
- * Action ID for unsubscribe schedule action on schedule on homepage
4490
+ * Action ID to hide or disable the
4491
+ * unsubscribe option for Liveboard schedules.
4367
4492
  * @example
4368
4493
  * ```js
4369
4494
  * disabledActions: [Action.UnsubscribeScheduleHomepage]
4370
4495
  * ```
4371
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
4496
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
4372
4497
  */
4373
4498
  UnsubscribeScheduleHomepage = 'unsubscribeScheduleHomepage',
4374
4499
 
@@ -4378,17 +4503,18 @@ export enum Action {
4378
4503
  * ```js
4379
4504
  * disabledActions: [Action.ManageTags]
4380
4505
  * ```
4381
- * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
4506
+ * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4382
4507
  */
4383
4508
  ManageTags = 'manageTags',
4384
4509
 
4385
4510
  /**
4386
- * Action ID for delete schedule action on schedule on homepage
4511
+ * The **Delete** action on the **Liveboard Schedules* page.
4512
+ * Deletes a Liveboard schedule.
4387
4513
  * @example
4388
4514
  * ```js
4389
4515
  * disabledActions: [Action.DeleteScheduleHomepage]
4390
4516
  * ```
4391
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
4517
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
4392
4518
  */
4393
4519
  DeleteScheduleHomepage = 'deleteScheduleHomepage',
4394
4520
 
@@ -4398,7 +4524,7 @@ export enum Action {
4398
4524
  * ```js
4399
4525
  * disabledActions: [Action.KPIAnalysisCTA]
4400
4526
  * ```
4401
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
4527
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4402
4528
  */
4403
4529
  KPIAnalysisCTA = 'kpiAnalysisCTA',
4404
4530
  /**
@@ -4407,77 +4533,85 @@ export enum Action {
4407
4533
  * ```js
4408
4534
  * const disabledActions = [Action.DisableChipReorder]
4409
4535
  * ```
4410
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
4536
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
4411
4537
  */
4412
4538
  DisableChipReorder = 'disableChipReorder',
4413
4539
 
4414
4540
  /**
4415
- * Action ID for Hide Irrelevant filters button
4541
+ * Action ID to show, hide, or disable filters
4542
+ * in a Liveboard tab.
4543
+ *
4416
4544
  * @example
4417
4545
  * ```js
4418
4546
  * hiddenAction: [Action.ChangeFilterVisibilityInTab]
4419
4547
  * ```
4420
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
4548
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
4421
4549
  */
4422
4550
  ChangeFilterVisibilityInTab = 'changeFilterVisibilityInTab',
4423
4551
 
4424
4552
  /**
4425
- * Action ID for hide/disable Preview data button in spotter
4553
+ * The **Preview data** button on the Spotter interface.
4554
+ * Allows previewing the data used for Spotter queries.
4555
+ *
4426
4556
  * @example
4427
4557
  * ```js
4428
4558
  * hiddenAction: [Action.PreviewDataSpotter]
4429
4559
  * ```
4430
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
4560
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
4431
4561
  */
4432
4562
  PreviewDataSpotter = 'previewDataSpotter',
4433
4563
 
4434
4564
  /**
4435
- * Action ID for hide/disable reset button in spotter
4565
+ * The **Reset** link on the Spotter interface.
4566
+ * Resets the conversation with Spotter.
4567
+ *
4436
4568
  * @example
4437
4569
  * ```js
4438
4570
  * hiddenAction: [Action.ResetSpotterChat]
4439
4571
  * ```
4440
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
4572
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
4441
4573
  */
4442
4574
  ResetSpotterChat = 'resetSpotterChat',
4443
-
4444
4575
  /**
4445
- * Action ID for hide/disable feedback in spotter
4576
+ * Action ID for hide or disable the
4577
+ * Spotter feedback widget.
4578
+ *
4446
4579
  * @example
4447
4580
  * ```js
4448
4581
  * hiddenAction: [Action.SpotterFeedback]
4449
4582
  * ```
4450
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
4583
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
4451
4584
  */
4452
4585
  SpotterFeedback = 'spotterFeedback',
4453
-
4454
4586
  /**
4455
- * Action ID for hide/disable editing previous prompt in spotter
4587
+ * Action ID for hide or disable
4588
+ * the previous prompt edit option in Spotter.
4589
+ *
4456
4590
  * @example
4457
4591
  * ```js
4458
4592
  * hiddenAction: [Action.EditPreviousPrompt]
4459
4593
  * ```
4460
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
4594
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
4461
4595
  */
4462
4596
  EditPreviousPrompt = 'editPreviousPrompt',
4463
-
4464
4597
  /**
4465
- * Action ID for hide/disable deleting previous prompt in spotter
4598
+ * Action ID for hide or disable
4599
+ * the previous prompt deletion option in Spotter.
4600
+ *
4466
4601
  * @example
4467
4602
  * ```js
4468
4603
  * hiddenAction: [Action.DeletePreviousPrompt]
4469
4604
  * ```
4470
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
4605
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
4471
4606
  */
4472
4607
  DeletePreviousPrompt = 'deletePreviousPrompt',
4473
-
4474
4608
  /**
4475
4609
  * Action ID for hide/disable edit of tokens on spotter results.
4476
4610
  * @example
4477
4611
  * ```js
4478
4612
  * hiddenAction: [Action.EditTokens]
4479
4613
  * ```
4480
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
4614
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
4481
4615
  */
4482
4616
  EditTokens = 'editTokens',
4483
4617
  }
@@ -4495,10 +4629,12 @@ export enum PrefetchFeatures {
4495
4629
 
4496
4630
  /**
4497
4631
  * Enum for options to change context trigger
4632
+ * BOTH_CLICKS option is introduced in 10.7
4498
4633
  */
4499
4634
  export enum ContextMenuTriggerOptions {
4500
4635
  LEFT_CLICK = 'left-click',
4501
4636
  RIGHT_CLICK = 'right-click',
4637
+ BOTH_CLICKS = 'both-clicks',
4502
4638
  }
4503
4639
 
4504
4640
  export interface ColumnValue {
@@ -4559,7 +4695,7 @@ export enum LogLevel {
4559
4695
  * logLevel: LogLevel.SILENT,
4560
4696
  * })
4561
4697
  * ```
4562
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
4698
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
4563
4699
  */
4564
4700
  SILENT = 'SILENT',
4565
4701
  /**
@@ -4571,7 +4707,7 @@ export enum LogLevel {
4571
4707
  * logLevel: LogLevel.ERROR,
4572
4708
  * })
4573
4709
  * ```
4574
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
4710
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
4575
4711
  */
4576
4712
  ERROR = 'ERROR',
4577
4713
  /**
@@ -4583,7 +4719,7 @@ export enum LogLevel {
4583
4719
  * logLevel: LogLevel.WARN,
4584
4720
  * })
4585
4721
  * ```
4586
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
4722
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
4587
4723
  */
4588
4724
  WARN = 'WARN',
4589
4725
  /**
@@ -4595,7 +4731,7 @@ export enum LogLevel {
4595
4731
  * logLevel: LogLevel.INFO,
4596
4732
  * })
4597
4733
  * ```
4598
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
4734
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
4599
4735
  */
4600
4736
  INFO = 'INFO',
4601
4737
 
@@ -4608,7 +4744,7 @@ export enum LogLevel {
4608
4744
  * logLevel: LogLevel.DEBUG,
4609
4745
  * })
4610
4746
  * ```
4611
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
4747
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
4612
4748
  */
4613
4749
  DEBUG = 'DEBUG',
4614
4750
  /**
@@ -4620,7 +4756,7 @@ export enum LogLevel {
4620
4756
  * logLevel: LogLevel.TRACE,
4621
4757
  * })
4622
4758
  * ```
4623
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
4759
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
4624
4760
  */
4625
4761
  TRACE = 'TRACE',
4626
4762
  }