@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
@@ -197,6 +197,7 @@ export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
197
197
  /**
198
198
  * Embed ThoughtSpot LLM and GPT based natural language search component.
199
199
  *
200
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
200
201
  * @group Embed components
201
202
  */
202
203
  export declare class SageEmbed extends V1Embed {
@@ -575,6 +576,12 @@ export interface LiveboardViewConfig extends ViewConfig {
575
576
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
576
577
  */
577
578
  activeTabId?: string;
579
+ /**
580
+ * Hide tab Panel of embedded LB
581
+ *
582
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
583
+ */
584
+ hideTabPanel?: boolean;
578
585
  }
579
586
  /**
580
587
  * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -1306,7 +1313,7 @@ export declare enum AuthType {
1306
1313
  * .then((data) => data.token);
1307
1314
  * }
1308
1315
  * ```
1309
- * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
1316
+ * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
1310
1317
  */
1311
1318
  TrustedAuthTokenCookieless = "AuthServerCookieless",
1312
1319
  /**
@@ -1477,7 +1484,7 @@ export interface EmbedConfig {
1477
1484
  *
1478
1485
  * Eg: "/dashboard", "#/foo" [Do not include the host]
1479
1486
  *
1480
- * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1-sw
1487
+ * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
1481
1488
  */
1482
1489
  redirectPath?: string;
1483
1490
  /** @internal */
@@ -1519,14 +1526,14 @@ export interface EmbedConfig {
1519
1526
  * This flag is typically used alongside the combination of auth modes such as {@link
1520
1527
  * AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
1521
1528
  *
1522
- * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1529
+ * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1523
1530
  * @default false
1524
1531
  */
1525
1532
  disableLoginRedirect?: boolean;
1526
1533
  /**
1527
1534
  * This message is displayed on the embed view when the login fails.
1528
1535
  *
1529
- * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1536
+ * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1530
1537
  */
1531
1538
  loginFailedMessage?: string;
1532
1539
  /**
@@ -1548,7 +1555,7 @@ export interface EmbedConfig {
1548
1555
  * Dynamic CSS Url to be injected in the loaded application.
1549
1556
  * You would also need to set `style-src` in the CSP settings.
1550
1557
  *
1551
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1558
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1552
1559
  * @default ''
1553
1560
  */
1554
1561
  customCssUrl?: string;
@@ -1560,13 +1567,13 @@ export interface EmbedConfig {
1560
1567
  * This is slightly slower than letting the browser handle the cookie check, as it
1561
1568
  * involves an extra network call.
1562
1569
  *
1563
- * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1570
+ * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1564
1571
  */
1565
1572
  detectCookieAccessSlow?: boolean;
1566
1573
  /**
1567
1574
  * Hide beta alert warning message for SearchEmbed.
1568
1575
  *
1569
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw*
1576
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
1570
1577
  */
1571
1578
  suppressSearchEmbedBetaWarning?: boolean;
1572
1579
  /**
@@ -1614,7 +1621,7 @@ export interface EmbedConfig {
1614
1621
  * Disable Full App access of Embedded app outside of the iFrame.
1615
1622
  *
1616
1623
  * @default true
1617
- * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1-sw
1624
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1618
1625
  */
1619
1626
  blockNonEmbedFullAppAccess?: boolean;
1620
1627
  /**
@@ -1717,14 +1724,14 @@ export interface ViewConfig {
1717
1724
  *
1718
1725
  * Use either this or hiddenActions.
1719
1726
  *
1720
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1727
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1721
1728
  * @important
1722
1729
  */
1723
1730
  visibleActions?: Action[];
1724
1731
  /**
1725
1732
  * Show alert messages and toast messages in the embedded view.
1726
1733
  *
1727
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1734
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1728
1735
  */
1729
1736
  showAlerts?: boolean;
1730
1737
  /**
@@ -1735,7 +1742,7 @@ export interface ViewConfig {
1735
1742
  /**
1736
1743
  * The locale/language to use for the embedded view.
1737
1744
  *
1738
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
1745
+ * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1739
1746
  */
1740
1747
  locale?: string;
1741
1748
  /**
@@ -1746,7 +1753,7 @@ export interface ViewConfig {
1746
1753
  * to control embed behavior in non-regular ways. We do not publish the
1747
1754
  * list of supported keys and values associated with each.
1748
1755
  *
1749
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1756
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1750
1757
  */
1751
1758
  additionalFlags?: {
1752
1759
  [key: string]: string | number | boolean;
@@ -1755,7 +1762,7 @@ export interface ViewConfig {
1755
1762
  * Dynamic CSSUrl and customCSS to be injected in the loaded application.
1756
1763
  * You would also need to set `style-src` in the CSP settings.
1757
1764
  *
1758
- * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1-sw, 8.4.0.cl
1765
+ * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
1759
1766
  * @default ''
1760
1767
  */
1761
1768
  customizations?: CustomisationsInterface;
@@ -1800,6 +1807,63 @@ export interface ViewConfig {
1800
1807
  * @hidden
1801
1808
  */
1802
1809
  excludeRuntimeFiltersfromURL?: boolean;
1810
+ /**
1811
+ * Boolean to hide liveboard header
1812
+ *
1813
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1814
+ * @default false
1815
+ */
1816
+ hideLiveboardHeader?: boolean;
1817
+ /**
1818
+ * Boolean to show liveboard title
1819
+ *
1820
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1821
+ * @default false
1822
+ */
1823
+ showLiveboardTitle?: boolean;
1824
+ /**
1825
+ * Boolean to show liveboard description
1826
+ *
1827
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1828
+ * @default false
1829
+ */
1830
+ showLiveboardDescription?: boolean;
1831
+ /**
1832
+ * The list of tab IDs to hide from the embedded.
1833
+ * This Tabs will be hidden from their respective LBs.
1834
+ * Use this to hide an tabID.
1835
+ *
1836
+ * @example
1837
+ * ```js
1838
+ * const embed = new LiveboardEmbed('#embed', {
1839
+ * ... // other liveboard view config
1840
+ * hiddenTabs: [
1841
+ * '430496d6-6903-4601-937e-2c691821af3c',
1842
+ * 'f547ec54-2a37-4516-a222-2b06719af726']
1843
+ * });
1844
+ * ```
1845
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1846
+ */
1847
+ hiddenTabs?: string[];
1848
+ /**
1849
+ * The list of tab IDs to show in the embedded.
1850
+ * Only this Tabs will be shown in their respective LBs.
1851
+ * Use this to show an tabID.
1852
+ *
1853
+ * Use either this or hiddenTabs.
1854
+ *
1855
+ * @example
1856
+ * ```js
1857
+ * const embed = new LiveboardEmbed('#embed', {
1858
+ * ... // other liveboard view config
1859
+ * visibleTabs: [
1860
+ * '430496d6-6903-4601-937e-2c691821af3c',
1861
+ * 'f547ec54-2a37-4516-a222-2b06719af726']
1862
+ * });
1863
+ * ```
1864
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1865
+ */
1866
+ visibleTabs?: string[];
1803
1867
  }
1804
1868
  /**
1805
1869
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2005,7 +2069,7 @@ export declare enum EmbedEvent {
2005
2069
  * One or more data columns have been selected.
2006
2070
  *
2007
2071
  * @returns columnIds - the list of columns
2008
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
2072
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2009
2073
  */
2010
2074
  AddRemoveColumns = "addRemoveColumns",
2011
2075
  /**
@@ -2038,7 +2102,7 @@ export declare enum EmbedEvent {
2038
2102
  * });
2039
2103
  * ```
2040
2104
  * @return viz, clickedPoint - metadata about point that is clicked
2041
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2105
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2042
2106
  * @important
2043
2107
  */
2044
2108
  VizPointClick = "vizPointClick",
@@ -2088,7 +2152,7 @@ export declare enum EmbedEvent {
2088
2152
  * Emitted when the "Get Data" button in Search Bar embed
2089
2153
  * is clicked.
2090
2154
  *
2091
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
2155
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
2092
2156
  */
2093
2157
  GetDataClick = "getDataClick",
2094
2158
  /**
@@ -2118,13 +2182,13 @@ export declare enum EmbedEvent {
2118
2182
  /**
2119
2183
  * Emitted when any modal is opened in the app
2120
2184
  *
2121
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
2185
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2122
2186
  */
2123
2187
  DialogOpen = "dialog-open",
2124
2188
  /**
2125
2189
  * Emitted when any modal is closed in the app
2126
2190
  *
2127
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
2191
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2128
2192
  */
2129
2193
  DialogClose = "dialog-close",
2130
2194
  /**
@@ -2132,136 +2196,136 @@ export declare enum EmbedEvent {
2132
2196
  * You can use this event as a hook to trigger
2133
2197
  * other events on the rendered Liveboard.
2134
2198
  *
2135
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2199
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2136
2200
  */
2137
2201
  LiveboardRendered = "PinboardRendered",
2138
2202
  /**
2139
2203
  * This can be used to register an event listener which
2140
2204
  * is triggered on all events.
2141
2205
  *
2142
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
2206
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2143
2207
  */
2144
2208
  ALL = "*",
2145
2209
  /**
2146
- * Emitted when answer is saved in the app
2210
+ * Emitted when an Answer is saved in the app
2147
2211
  *
2148
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2212
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2149
2213
  */
2150
2214
  Save = "save",
2151
2215
  /**
2152
2216
  * Emitted when the download action is triggered on an answer
2153
2217
  *
2154
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2218
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2155
2219
  */
2156
2220
  Download = "download",
2157
2221
  /**
2158
2222
  * Emitted when the download action is triggered on an answer
2159
2223
  *
2160
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
2224
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
2161
2225
  */
2162
2226
  DownloadAsPng = "downloadAsPng",
2163
2227
  /**
2164
2228
  * Emitted when the Download as PDF action is triggered on an answer
2165
2229
  *
2166
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2230
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2167
2231
  */
2168
2232
  DownloadAsPdf = "downloadAsPdf",
2169
2233
  /**
2170
2234
  * Emitted when the Download as CSV action is triggered on an answer
2171
2235
  *
2172
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2236
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2173
2237
  */
2174
2238
  DownloadAsCsv = "downloadAsCsv",
2175
2239
  /**
2176
2240
  * Emitted when the Download as XLSX action is triggered on an answer
2177
2241
  *
2178
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2242
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2179
2243
  */
2180
2244
  DownloadAsXlsx = "downloadAsXlsx",
2181
2245
  /**
2182
2246
  * Emitted when an answer is deleted in the app
2183
2247
  *
2184
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2248
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2185
2249
  */
2186
2250
  AnswerDelete = "answerDelete",
2187
2251
  /**
2188
2252
  * Emitted when an answer is pinned to a Liveboard
2189
2253
  *
2190
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2254
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2191
2255
  */
2192
2256
  Pin = "pin",
2193
2257
  /**
2194
2258
  * Emitted when SpotIQ analysis is triggered
2195
2259
  *
2196
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2260
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2197
2261
  */
2198
2262
  SpotIQAnalyze = "spotIQAnalyze",
2199
2263
  /**
2200
2264
  * Emitted when a user shares an object with another user or group
2201
2265
  *
2202
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2266
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2203
2267
  */
2204
2268
  Share = "share",
2205
2269
  /**
2206
2270
  * Emitted when a user clicks the Include action to include a specific value or data
2207
2271
  * on a chart or table
2208
2272
  *
2209
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2273
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2210
2274
  */
2211
2275
  DrillInclude = "context-menu-item-include",
2212
2276
  /**
2213
2277
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
2214
2278
  * on a chart or table
2215
2279
  *
2216
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2280
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2217
2281
  */
2218
2282
  DrillExclude = "context-menu-item-exclude",
2219
2283
  /**
2220
2284
  * Emitted when copied column value on the app
2221
2285
  *
2222
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2286
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2223
2287
  */
2224
2288
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
2225
2289
  /**
2226
2290
  * Emitted when a user clicks the Update TML action
2227
2291
  *
2228
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2292
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2229
2293
  */
2230
2294
  UpdateTML = "updateTSL",
2231
2295
  /**
2232
2296
  * Emitted when a user clicks the Edit TML action
2233
2297
  *
2234
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2298
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2235
2299
  */
2236
2300
  EditTML = "editTSL",
2237
2301
  /**
2238
2302
  * Emitted when ExportTML trigger in answer on the app
2239
2303
  *
2240
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2304
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2241
2305
  */
2242
2306
  ExportTML = "exportTSL",
2243
2307
  /**
2244
2308
  * Emitted when an answer is saved as a view
2245
2309
  *
2246
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2310
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2247
2311
  */
2248
2312
  SaveAsView = "saveAsView",
2249
2313
  /**
2250
2314
  * Emitted when copy of existing answer on the app
2251
2315
  *
2252
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2316
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2253
2317
  */
2254
2318
  CopyAEdit = "copyAEdit",
2255
2319
  /**
2256
2320
  * Emitted when a user clicks Show underlying data on an answe
2257
2321
  *
2258
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2322
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2259
2323
  */
2260
2324
  ShowUnderlyingData = "showUnderlyingData",
2261
2325
  /**
2262
2326
  * Emitted when an answer is switched to a chart or table view
2263
2327
  *
2264
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2328
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2265
2329
  */
2266
2330
  AnswerChartSwitcher = "answerChartSwitcher",
2267
2331
  /**
@@ -2273,67 +2337,67 @@ export declare enum EmbedEvent {
2273
2337
  /**
2274
2338
  * Emitted when a user clicks Show Liveboard details on a Liveboard
2275
2339
  *
2276
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2340
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2277
2341
  */
2278
2342
  LiveboardInfo = "pinboardInfo",
2279
2343
  /**
2280
2344
  * Emitted when a user clicks on the Favorite icon on a Liveboard
2281
2345
  *
2282
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2346
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2283
2347
  */
2284
2348
  AddToFavorites = "addToFavorites",
2285
2349
  /**
2286
2350
  * Emitted when a user clicks Schedule on a Liveboard
2287
2351
  *
2288
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2352
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2289
2353
  */
2290
2354
  Schedule = "subscription",
2291
2355
  /**
2292
2356
  * Emitted when a user clicks Edit on a Liveboard or visualization
2293
2357
  *
2294
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2358
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2295
2359
  */
2296
2360
  Edit = "edit",
2297
2361
  /**
2298
2362
  * Emitted when a user clicks Make a copy on a Liveboard
2299
2363
  *
2300
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2364
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2301
2365
  */
2302
2366
  MakeACopy = "makeACopy",
2303
2367
  /**
2304
2368
  * Emitted when a user clicks Present on a Liveboard or visualization
2305
2369
  *
2306
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2370
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2307
2371
  */
2308
2372
  Present = "present",
2309
2373
  /**
2310
2374
  * Emitted when a user clicks Delete on a Liveboard
2311
2375
  *
2312
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2376
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2313
2377
  */
2314
2378
  Delete = "delete",
2315
2379
  /**
2316
2380
  * Emitted when a user clicks Manage schedules on a Liveboard
2317
2381
  *
2318
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2382
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2319
2383
  */
2320
2384
  SchedulesList = "schedule-list",
2321
2385
  /**
2322
2386
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
2323
2387
  *
2324
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2388
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2325
2389
  */
2326
2390
  Cancel = "cancel",
2327
2391
  /**
2328
2392
  * Emitted when a user clicks Explore on a visualization
2329
2393
  *
2330
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2394
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2331
2395
  */
2332
2396
  Explore = "explore",
2333
2397
  /**
2334
2398
  * Emitted when a user clicks Copy link action on a visualization
2335
2399
  *
2336
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2400
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2337
2401
  */
2338
2402
  CopyLink = "embedDocument",
2339
2403
  /**
@@ -2353,7 +2417,13 @@ export declare enum EmbedEvent {
2353
2417
  *
2354
2418
  * @hidden
2355
2419
  */
2356
- InsertIntoSlide = "insertInToSlide"
2420
+ InsertIntoSlide = "insertInToSlide",
2421
+ /**
2422
+ * Emitted when a user changes any filter on a Liveboard.
2423
+ *
2424
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2425
+ */
2426
+ FilterChanged = "filterChanged"
2357
2427
  }
2358
2428
  /**
2359
2429
  * Event types that can be triggered by the host application
@@ -2379,13 +2449,14 @@ export declare enum EmbedEvent {
2379
2449
  */
2380
2450
  export declare enum HostEvent {
2381
2451
  /**
2382
- * Trigger a search
2383
- *
2452
+ * Triggers a search query in AppEmbed and SearchEmbed
2453
+ * deployments.
2454
+ * Includes the following properties:
2384
2455
  * @param - dataSourceIds - The data source GUID to Search on
2385
2456
  * - Although an array, only a single source
2386
- * is supported at this time.
2387
- * @param - searchQuery - The search query
2388
- * @param - execute - execute the existing / updated query
2457
+ * is supported.
2458
+ * @param - searchQuery - Query string with search tokens
2459
+ * @param - execute - executes the existing / updated query
2389
2460
  * @example
2390
2461
  * ```js
2391
2462
  * searchEmbed.trigger(HostEvent.Search, {
@@ -2397,13 +2468,13 @@ export declare enum HostEvent {
2397
2468
  */
2398
2469
  Search = "search",
2399
2470
  /**
2400
- * Trigger a drill on certain points by certain column
2401
- *
2471
+ * Triggers a drill on certain points of the specified column
2472
+ * Includes the following properties:
2402
2473
  * @param - points - an object containing selectedPoints/clickedPoints
2403
- * eg. { selectedPoints: []}
2404
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
2405
- * if not provided it will auto drill by the configured
2406
- * column.
2474
+ * to drill to. For example, { selectedPoints: []}
2475
+ * @param - columnGuid - Optional. GUID of the column to drill
2476
+ * by. If not provided it will auto drill by the configured
2477
+ * column.
2407
2478
  * @example
2408
2479
  * ```js
2409
2480
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -2436,17 +2507,17 @@ export declare enum HostEvent {
2436
2507
  */
2437
2508
  Reload = "reload",
2438
2509
  /**
2439
- * Set the visible visualizations on a Liveboard.
2510
+ * Sets the visible visualizations on a Liveboard.
2440
2511
  *
2441
- * @param - an array of ids of visualizations to show, the ids not passed
2442
- * will be hidden.
2512
+ * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
2513
+ * in this parameter will be hidden.
2443
2514
  * @example
2444
2515
  * ```js
2445
2516
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
2446
2517
  * '730496d6-6903-4601-937e-2c691821af3c',
2447
2518
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
2448
2519
  * ```
2449
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
2520
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2450
2521
  */
2451
2522
  SetVisibleVizs = "SetPinboardVisibleVizs",
2452
2523
  /**
@@ -2463,9 +2534,18 @@ export declare enum HostEvent {
2463
2534
  */
2464
2535
  SetActiveTab = "SetActiveTab",
2465
2536
  /**
2466
- * Update the runtime filters. The runtime filters passed here are extended
2467
- * on to the existing runtime filters if they exist.
2468
- *
2537
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
2538
+ * runtime filters passed here are appended to the existing runtime
2539
+ * filters.
2540
+ * Pass an array of runtime filters with the following attributes:
2541
+ * `columnName`
2542
+ * _String_. The name of the column to filter on.
2543
+ * `operator`
2544
+ * Runtime filter operator to apply. For information,
2545
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2546
+ * `values`
2547
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
2548
+ * such as BW and IN accept multiple operands.
2469
2549
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
2470
2550
  * @example
2471
2551
  * ```js
@@ -2474,25 +2554,24 @@ export declare enum HostEvent {
2474
2554
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
2475
2555
  * ])
2476
2556
  * ```
2477
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2557
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2478
2558
  * @important
2479
2559
  */
2480
2560
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
2481
2561
  /**
2482
- * Navigate to a specific page in App embed without any reload.
2562
+ * Navigate to a specific page in the embedded application without reloading the page.
2483
2563
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
2484
- *
2485
2564
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
2486
2565
  * @example
2487
2566
  * ```js
2488
2567
  * appEmbed.navigateToPage(-1)
2489
2568
  * ```
2490
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
2569
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
2491
2570
  */
2492
2571
  Navigate = "Navigate",
2493
2572
  /**
2494
2573
  * Opens the filter panel for a particular column.
2495
- * Works with Search embed.
2574
+ * Works with Search and Liveboard embed.
2496
2575
  *
2497
2576
  * @param - { columnId: string,
2498
2577
  * name: string,
@@ -2501,233 +2580,257 @@ export declare enum HostEvent {
2501
2580
  * @example
2502
2581
  * ```js
2503
2582
  * searchEmbed.trigger(HostEvent.OpenFilter,
2504
- * { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
2583
+ * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
2584
+ * LiveboardEmbed.trigger(HostEvent.OpenFilter,
2585
+ * { columnId: '<column-GUID>'})
2505
2586
  * ```
2506
2587
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2507
2588
  */
2508
2589
  OpenFilter = "openFilter",
2509
2590
  /**
2510
- * Adds the columns to the current Search.
2591
+ * Adds columns to the current search query.
2511
2592
  *
2512
2593
  * @param - { columnIds: string[] }
2513
2594
  * @example
2514
2595
  * ```js
2515
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
2596
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
2516
2597
  * ```
2517
2598
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2518
2599
  */
2519
2600
  AddColumns = "addColumns",
2520
2601
  /**
2521
- * Removes a column from the current Search.
2602
+ * Removes a column from the current search query.
2522
2603
  *
2523
2604
  * @param - { columnId: string }
2524
2605
  * @example
2525
2606
  * ```js
2526
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
2607
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
2527
2608
  * ```
2528
2609
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2529
2610
  */
2530
2611
  RemoveColumn = "removeColumn",
2531
2612
  /**
2532
- * Gets the current pinboard content.
2613
+ * Gets the current Liveboard content.
2533
2614
  *
2534
2615
  * @example
2535
2616
  * ```js
2536
2617
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
2537
2618
  * ```
2538
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
2619
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
2539
2620
  */
2540
2621
  getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
2541
2622
  /**
2542
- * Triggers the Pin action on an embedded object
2623
+ * Triggers the **Pin** action on an embedded object
2543
2624
  *
2544
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2545
- * can be left empty for search and visualization embeds
2625
+ * @param - Liveboard embed takes the `vizId` as a
2626
+ * key. Can be left undefined when embedding Search, full app or
2627
+ * a visualization.
2546
2628
  * @example
2547
2629
  * ```js
2548
2630
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2631
+ * ```
2632
+ * ```js
2549
2633
  * vizEmbed.trigger(HostEvent.Pin)
2634
+ * ```
2635
+ * ```js
2550
2636
  * searchEmbed.trigger(HostEvent.Pin)
2551
2637
  * ```
2552
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2638
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2553
2639
  */
2554
2640
  Pin = "pin",
2555
2641
  /**
2556
- * Triggers the Show Liveboard details action on a Liveboard
2642
+ * Triggers the **Show Liveboard details** action on a Liveboard
2557
2643
  *
2558
2644
  * @example
2559
2645
  * ```js
2560
2646
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
2561
2647
  * ```
2562
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2648
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2563
2649
  */
2564
2650
  LiveboardInfo = "pinboardInfo",
2565
2651
  /**
2566
- * Triggers the Schedule action on a Liveboard
2652
+ * Triggers the **Schedule** action on a Liveboard
2567
2653
  *
2568
2654
  * @example
2569
2655
  * ```js
2570
2656
  * liveboardEmbed.trigger(HostEvent.Schedule)
2571
2657
  * ```
2572
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2658
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2573
2659
  */
2574
2660
  Schedule = "subscription",
2575
2661
  /**
2576
- * Triggers the Manage schedule action on a Liveboard
2662
+ * Triggers the **Manage schedule** action on a Liveboard
2577
2663
  *
2578
2664
  * @example
2579
2665
  * ```js
2580
2666
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
2581
2667
  * ```
2582
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2668
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2583
2669
  */
2584
2670
  SchedulesList = "schedule-list",
2585
2671
  /**
2586
- * Triggers the Export TML action on a Liveboard
2672
+ * Triggers the **Export TML** action on a Liveboard
2587
2673
  *
2588
2674
  * @example
2589
2675
  * ```js
2590
2676
  * liveboardEmbed.trigger(HostEvent.ExportTML)
2591
2677
  * ```
2592
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2678
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2593
2679
  */
2594
2680
  ExportTML = "exportTSL",
2595
2681
  /**
2596
- * Triggers the Edit TML action on a Liveboard
2682
+ * Triggers the **Edit TML** action on a Liveboard
2597
2683
  *
2598
2684
  * @example
2599
2685
  * ```js
2600
2686
  * liveboardEmbed.trigger(HostEvent.EditTML)
2601
2687
  * ```
2602
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2688
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2603
2689
  */
2604
2690
  EditTML = "editTSL",
2605
2691
  /**
2606
- * Triggers the Update TML action on a Liveboard
2692
+ * Triggers the **Update TML** action on a Liveboard
2607
2693
  *
2608
2694
  * @example
2609
2695
  * ```js
2610
2696
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
2611
2697
  * ```
2612
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2698
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2613
2699
  */
2614
2700
  UpdateTML = "updateTSL",
2615
2701
  /**
2616
- * Triggers the Download PDF action on a Liveboard
2702
+ * Triggers the **Download PDF** action on a Liveboard
2617
2703
  *
2618
2704
  * @example
2619
2705
  * ```js
2620
2706
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
2621
2707
  * ```
2622
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2708
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2623
2709
  */
2624
2710
  DownloadAsPdf = "downloadAsPdf",
2625
2711
  /**
2626
- * Triggers the Make a copy action on a Liveboard, search or visualization
2712
+ * Triggers the **Make a copy** action on a Liveboard, Search, or
2713
+ * visualization page
2627
2714
  *
2628
2715
  * @example
2629
2716
  * ```js
2630
2717
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2718
+ * ```
2719
+ * ```js
2631
2720
  * vizEmbed.trigger(HostEvent.MakeACopy)
2721
+ * ```
2722
+ * ```js
2632
2723
  * searchEmbed.trigger(HostEvent.MakeACopy)
2633
2724
  * ```
2634
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2725
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2635
2726
  */
2636
2727
  MakeACopy = "makeACopy",
2637
2728
  /**
2638
- * Triggers the Delete action on a Liveboard
2729
+ * Triggers the **Delete** action on a Liveboard
2639
2730
  *
2640
2731
  * @example
2641
2732
  * ```js
2642
2733
  * appEmbed.trigger(HostEvent.Remove)
2643
2734
  * ```
2644
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2735
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2645
2736
  */
2646
2737
  Remove = "delete",
2647
2738
  /**
2648
- * Triggers the Explore action on a visualization
2739
+ * Triggers the **Explore* action on a visualization
2649
2740
  *
2650
- * @param - an object with vizId as a key
2741
+ * @param - an object with `vizId` as a key
2651
2742
  * @example
2652
2743
  * ```js
2653
2744
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2654
2745
  * ```
2655
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2746
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2656
2747
  */
2657
2748
  Explore = "explore",
2658
2749
  /**
2659
- * Triggers the Create alert action on a visualization
2750
+ * Triggers the **Create alert** action on a visualization
2660
2751
  *
2661
- * @param - an object with vizId as a key
2752
+ * @param - an object with `vizId` as a key
2662
2753
  * @example
2663
2754
  * ```js
2664
2755
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
2665
2756
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2666
2757
  * })
2667
2758
  * ```
2668
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2759
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2669
2760
  */
2670
2761
  CreateMonitor = "createMonitor",
2671
2762
  /**
2672
- * Triggers the Manage alert action on a visualization
2763
+ * Triggers the **Manage alerts** action on a visualization
2673
2764
  *
2674
- * @param - an object with vizId as a key
2765
+ * @param - an object with `vizId` as a key
2675
2766
  * @example
2676
2767
  * ```js
2677
2768
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
2678
2769
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2679
2770
  * })
2680
2771
  * ```
2681
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2772
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2682
2773
  */
2683
2774
  ManageMonitor = "manageMonitor",
2684
2775
  /**
2685
- * Triggers the Edit action on a Liveboard or visualization
2776
+ * Triggers the **Edit** action on a Liveboard or visualization
2686
2777
  *
2687
- * @param - object - to trigger the action for a specfic visualization
2688
- * in Liveboard embed, pass in vizId as a key
2778
+ * @param - object - To trigger the action for a specific visualization
2779
+ * in Liveboard embed, pass in `vizId` as a key.
2780
+ * Can be left undefined when embedding Search, full app, or
2781
+ * a visualization.
2689
2782
  * @example
2690
2783
  * ```js
2691
2784
  * liveboardEmbed.trigger(HostEvent.Edit)
2692
- *
2785
+ * ```
2786
+ * ```js
2693
2787
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
2694
2788
  * '730496d6-6903-4601-937e-2c691821af3c'})
2695
- *
2789
+ * ```
2790
+ * ```js
2696
2791
  * vizEmbed.trigger((HostEvent.Edit)
2697
2792
  * ```
2698
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2793
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2699
2794
  */
2700
2795
  Edit = "edit",
2701
2796
  /**
2702
- * Triggers the Copy link action on a Liveboard or visualization
2797
+ * Triggers the **Copy link** action on a Liveboard or visualization
2703
2798
  *
2704
- * @param - object - to trigger the action for a s
2705
- * pecfic visualization in Liveboard embed, pass in vizId as a key
2799
+ * @param - object - to trigger the action for a
2800
+ * specific visualization in Liveboard embed, pass in `vizId` as a key
2706
2801
  * @example
2707
2802
  * ```js
2708
2803
  * liveboardEmbed.trigger(HostEvent.CopyLink)
2804
+ * ```
2805
+ * ```js
2709
2806
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2807
+ * ```
2808
+ * ```js
2710
2809
  * vizEmbed.trigger((HostEvent.CopyLink)
2711
2810
  * ```
2712
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2811
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2713
2812
  */
2714
2813
  CopyLink = "embedDocument",
2715
2814
  /**
2716
- * Triggers the Present action on a Liveboard or visualization
2815
+ * Triggers the **Present** action on a Liveboard or visualization
2717
2816
  *
2718
- * @param - object - to trigger the action for a specfic visualization
2719
- * in Liveboard embed, pass in vizId as a key
2817
+ * @param - object - to trigger the action for a specific visualization
2818
+ * in Liveboard embed, pass in `vizId` as a key
2720
2819
  * @example
2721
2820
  * ```js
2722
2821
  * liveboardEmbed.trigger(HostEvent.Present)
2822
+ * ```
2823
+ * ```js
2723
2824
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2825
+ * ```
2826
+ * ```js
2724
2827
  * vizEmbed.trigger((HostEvent.Present)
2725
2828
  * ```
2726
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2829
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2727
2830
  */
2728
2831
  Present = "present",
2729
2832
  /**
2730
- * Get TML for the current search.
2833
+ * Gets TML for the current search.
2731
2834
  *
2732
2835
  * @example
2733
2836
  * ```js
@@ -2737,79 +2840,89 @@ export declare enum HostEvent {
2737
2840
  * );
2738
2841
  * })
2739
2842
  * ```
2740
- * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
2843
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2741
2844
  * @important
2742
2845
  */
2743
2846
  GetTML = "getTML",
2744
2847
  /**
2745
- * Triggers the ShowUnderlyingData action on visualization or search
2848
+ * Triggers the **Show underlying data** action on visualization or search
2746
2849
  *
2747
2850
  * @param - an object with vizId as a key
2748
2851
  * @example
2749
2852
  * ```js
2750
2853
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
2751
2854
  * '730496d6-6903-4601-937e-2c691821af3c'})
2752
- *
2855
+ * ```
2856
+ * ```js
2753
2857
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
2754
- *
2858
+ * ```
2859
+ * ```js
2755
2860
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
2756
2861
  * ```
2757
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2862
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2758
2863
  */
2759
2864
  ShowUnderlyingData = "showUnderlyingData",
2760
2865
  /**
2761
- * Triggers the Delete action on visualization or search
2866
+ * Triggers the **Delete** action on visualization or search
2762
2867
  *
2763
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2764
- * can be left empty for search and visualization embeds
2868
+ * @param - Liveboard embed takes an object with `vizId` as a key.
2869
+ * Can be left empty if embedding Search or visualization.
2765
2870
  * @example
2766
2871
  * ```js
2767
2872
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
2768
2873
  * '730496d6-6903-4601-937e-2c691821af3c'})
2769
- *
2874
+ * ```
2875
+ * ```js
2770
2876
  * vizEmbed.trigger(HostEvent.Delete)
2771
- *
2877
+ * ```
2878
+ * ```js
2772
2879
  * searchEmbed.trigger(HostEvent.Delete)
2773
2880
  * ```
2774
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2881
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2775
2882
  */
2776
2883
  Delete = "onDeleteAnswer",
2777
2884
  /**
2778
- * Triggers the SpotIQAnalyze action on visualization or search
2779
- *
2780
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2781
- * can be left empty for search and visualization embeds
2885
+ * Triggers the **SpotIQ analyze** action on visualization
2886
+ * or search.
2887
+ * @param - Liveboard embed takes `vizId` as a
2888
+ * key. Can be left undefined when embedding Search or
2889
+ * visualization.
2782
2890
  * @example
2783
2891
  * ```js
2784
2892
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
2785
2893
  * '730496d6-6903-4601-937e-2c691821af3c'})
2786
- *
2894
+ * ```
2895
+ * ```js
2787
2896
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
2788
- *
2897
+ * ```
2898
+ * ```js
2789
2899
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
2790
2900
  * ```
2791
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2901
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2792
2902
  */
2793
2903
  SpotIQAnalyze = "spotIQAnalyze",
2794
2904
  /**
2795
- * Triggers the Download action on visualization or search when Displaymode is Chart
2905
+ * Triggers the **Download** action on charts in
2906
+ * the embedded view.
2796
2907
  *
2797
2908
  * @example
2798
2909
  * ```js
2799
2910
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
2800
2911
  * '730496d6-6903-4601-937e-2c691821af3c'})
2801
- *
2912
+ * ```
2913
+ * ```js
2802
2914
  * vizEmbed.trigger(HostEvent.Download)
2803
- *
2915
+ * ```
2916
+ * ```js
2804
2917
  * searchEmbed.trigger(HostEvent.Download)
2805
2918
  * ```
2806
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
2807
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2919
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
2920
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2808
2921
  */
2809
2922
  Download = "downloadAsPng",
2810
2923
  /**
2811
- * Triggers the Download action on visualization or search when Displaymode is Chart
2812
- *
2924
+ * Triggers the **Download** > **PNG** action on
2925
+ * charts in the embedded view.
2813
2926
  * @example
2814
2927
  * ```js
2815
2928
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -2819,115 +2932,179 @@ export declare enum HostEvent {
2819
2932
  *
2820
2933
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
2821
2934
  * ```
2822
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
2935
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
2823
2936
  */
2824
2937
  DownloadAsPng = "downloadAsPng",
2825
2938
  /**
2826
- * Triggers the downloadAsCSV action on visualization or search
2939
+ * Triggers the **Download** > **CSV** action on tables in
2940
+ * the embedded view.
2827
2941
  *
2828
2942
  * @example
2829
2943
  * ```js
2830
2944
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
2831
2945
  * '730496d6-6903-4601-937e-2c691821af3c'})
2832
- *
2946
+ * ```
2947
+ * ```js
2833
2948
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
2834
- *
2949
+ * ```
2950
+ * ```js
2835
2951
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
2836
2952
  * ```
2837
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2953
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2838
2954
  */
2839
2955
  DownloadAsCsv = "downloadAsCSV",
2840
2956
  /**
2841
- * Triggers the downloadAsXLSX action on visualization or search
2842
- *
2957
+ * Triggers the **Download** > **XLSX** action on tables
2958
+ * in the embedded view.
2843
2959
  * @example
2844
2960
  * ```js
2845
2961
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
2846
2962
  * '730496d6-6903-4601-937e-2c691821af3c'})
2847
- *
2963
+ * ```
2964
+ * ```js
2848
2965
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
2849
- *
2966
+ * ```
2967
+ * ```js
2850
2968
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
2851
2969
  * ```
2852
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2970
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2853
2971
  */
2854
2972
  DownloadAsXlsx = "downloadAsXLSX",
2855
2973
  /**
2856
- * Triggers the Share action on a liveboard or answer
2974
+ * Triggers the **Share** action on an embedded
2975
+ * Liveboard or Answer.
2857
2976
  *
2858
2977
  * @example
2859
2978
  * ```js
2860
2979
  * liveboardEmbed.trigger(HostEvent.Share)
2861
- *
2980
+ * ```
2981
+ * ```js
2862
2982
  * searchEmbed.trigger(HostEvent.Share)
2863
2983
  * ```
2864
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2984
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2865
2985
  */
2866
2986
  Share = "share",
2867
2987
  /**
2868
- * Trigger the Save action on a liveboard or answer
2869
- *
2988
+ * Triggers the **Save** action on a Liveboard or Answer.
2989
+ * Saves the changes.
2870
2990
  * @example
2871
2991
  * ```js
2872
2992
  * liveboardEmbed.trigger(HostEvent.Save)
2873
- *
2993
+ * ```
2994
+ * ```js
2874
2995
  * searchEmbed.trigger(HostEvent.Save)
2875
2996
  * ```
2876
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2997
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2877
2998
  */
2878
2999
  Save = "save",
2879
3000
  /**
2880
- * Triggers the SyncToSheets action on visualization
2881
- *
2882
- * @param - an object with vizId as a key
3001
+ * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
3002
+ * Sends data from an Answer or Liveboard visualization to a Google sheet.
3003
+ * @param - an object with `vizId` as a key
2883
3004
  * @example
2884
3005
  * ```js
2885
3006
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
2886
3007
  * '730496d6-6903-4601-937e-2c691821af3c'})
2887
- *
3008
+ * ```
3009
+ * ```js
2888
3010
  * vizEmbed.trigger(HostEvent.SyncToSheets)
2889
3011
  * ```
2890
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
3012
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2891
3013
  */
2892
3014
  SyncToSheets = "sync-to-sheets",
2893
3015
  /**
2894
- * Triggers the SyncToOtherApps action on visualization
2895
- *
3016
+ * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
3017
+ * Sends data from an Answer or Liveboard visualization to third-party apps such
3018
+ * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
2896
3019
  * @param - an object with vizId as a key
2897
3020
  * @example
2898
3021
  * ```js
2899
3022
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
2900
3023
  * '730496d6-6903-4601-937e-2c691821af3c'})
2901
- *
3024
+ * ```
3025
+ * ```js
2902
3026
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
2903
3027
  * ```
2904
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
3028
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2905
3029
  */
2906
3030
  SyncToOtherApps = "sync-to-other-apps",
2907
3031
  /**
2908
- * Triggers the ManagePipelines action on visualization
2909
- *
2910
- * @param - an object with vizId as a key
3032
+ * Triggers the **Manage pipelines** action on an embedded
3033
+ * visualization or Answer.
3034
+ * Allows users to manage ThoughtSpot Sync pipelines.
3035
+ * @param - an object with `vizId` as a key
2911
3036
  * @example
2912
3037
  * ```js
2913
3038
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
2914
3039
  * '730496d6-6903-4601-937e-2c691821af3c'})
2915
- *
3040
+ * ```
3041
+ * ```js
2916
3042
  * vizEmbed.trigger(HostEvent.ManagePipelines)
2917
3043
  * ```
2918
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
3044
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2919
3045
  */
2920
3046
  ManagePipelines = "manage-pipeline",
2921
3047
  /**
2922
- * Triggers the Reset search in answer
3048
+ * Triggers the Reset search on the Search page
2923
3049
  *
2924
3050
  * @example
2925
3051
  * ```js
2926
3052
  * searchEmbed.trigger(HostEvent.ResetSearch)
2927
3053
  * ```
2928
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
3054
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
3055
+ */
3056
+ ResetSearch = "resetSearch",
3057
+ /**
3058
+ * Gets the currents visible and runtime filters applied on a Liveboard
3059
+ *
3060
+ * @example
3061
+ * liveboardEmbed.trigger(HostEvent.GetFilters)
3062
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2929
3063
  */
2930
- ResetSearch = "resetSearch"
3064
+ GetFilters = "getFilters",
3065
+ /**
3066
+ * Updates the visible filters on the Liveboard.
3067
+ *
3068
+ * @param - filter: filter object containing column name and filter operation and values
3069
+ * @example
3070
+ *
3071
+ * ```js
3072
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
3073
+ * filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
3074
+ * })
3075
+ * ```
3076
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3077
+ */
3078
+ UpdateFilters = "updateFilters",
3079
+ GetTabs = "getTabs",
3080
+ /**
3081
+ * Set the visible Tabs on a Liveboard.
3082
+ *
3083
+ * @param - an array of ids of Tabs to show, the ids not passed
3084
+ * will be hidden.
3085
+ * @example
3086
+ * ```js
3087
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
3088
+ * '430496d6-6903-4601-937e-2c691821af3c',
3089
+ * 'f547ec54-2a37-4516-a222-2b06719af726'])
3090
+ * ```
3091
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3092
+ */
3093
+ SetVisibleTabs = "SetPinboardVisibleTabs",
3094
+ /**
3095
+ * Set the hidden tabs on a Liveboard.
3096
+ *
3097
+ * @param - an array of ids of Tabs to hide, the ids not passed
3098
+ * will be shown.
3099
+ * @example
3100
+ * ```js
3101
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
3102
+ * '630496d6-6903-4601-937e-2c691821af3c',
3103
+ * 'i547ec54-2a37-4516-a222-2b06719af726'])
3104
+ * ```
3105
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3106
+ */
3107
+ SetHiddenTabs = "SetPinboardHiddenTabs"
2931
3108
  }
2932
3109
  /**
2933
3110
  * The different visual modes that the data sources panel within
@@ -3001,26 +3178,50 @@ export declare enum Param {
3001
3178
  HideWorksheetSelector = "hideWorksheetSelector",
3002
3179
  DisableWorksheetChange = "disableWorksheetChange",
3003
3180
  HideEurekaResults = "hideEurekaResults",
3004
- HideEurekaSuggestions = "hideEurekaSuggestions"
3181
+ HideEurekaSuggestions = "hideEurekaSuggestions",
3182
+ HideLiveboardHeader = "hideLiveboardHeader",
3183
+ ShowLiveboardDescription = "showLiveboardDescription",
3184
+ ShowLiveboardTitle = "showLiveboardTitle",
3185
+ HiddenTabs = "hideTabs",
3186
+ VisibleTabs = "visibleTabs",
3187
+ HideTabPanel = "hideTabPanel"
3005
3188
  }
3006
3189
  /**
3007
- * The list of actions that can be performed on visual ThoughtSpot
3008
- * entities, such as answers and Liveboards.
3009
- *
3010
- * This enum is used to specify the actions that could be disabled,
3011
- * hidden or made visible.
3012
- *
3190
+ * ThoughtSpot application pages include actions and menu commands
3191
+ * for various user-initiated operations. These actions are represented
3192
+ * as enumeration members in the SDK. To show, hide, or disable
3193
+ * specific actions in the embedded view, define the Action
3194
+ * enumeration members in the `disabledActions`, `visibleActions`,
3195
+ * or `hiddenActions` array.
3013
3196
  * @example
3014
3197
  * ```js
3015
3198
  * const embed = new LiveboardEmbed('#embed-container', {
3016
3199
  * ... // other options
3017
- * visibleActions: [Action.Save, Action.Explore],
3018
- * disableActions: [Action.Save],
3019
- * hiddenActions: [Action.Download], // Set either this or visibleActions
3200
+ * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
3201
+ * disabledActions: [Action.Download],
3202
+ * //hiddenActions: [], // Set either this or visibleActions
3020
3203
  * })
3021
3204
  * ```
3205
+ * @example
3206
+ * ```js
3207
+ * const embed = new LiveboardEmbed('#embed-container', {
3208
+ * ... // other options
3209
+ * //visibleActions: [],
3210
+ * disabledActions: [Action.Download],
3211
+ * hiddenActions: [Action.Edit, ActionAction.Explore],
3212
+ * })
3213
+ * ```
3214
+
3022
3215
  */
3023
3216
  export declare enum Action {
3217
+ /**
3218
+ * The **Save** action on an Answer or Liveboard.
3219
+ * Allows users to save the changes.
3220
+ * @example
3221
+ * ```js
3222
+ * disabledActions: [Action.SaveAsView]
3223
+ * ```
3224
+ */
3024
3225
  Save = "save",
3025
3226
  /**
3026
3227
  * @hidden
@@ -3030,27 +3231,137 @@ export declare enum Action {
3030
3231
  * @hidden
3031
3232
  */
3032
3233
  SaveUntitled = "saveUntitled",
3234
+ /**
3235
+ * The **Save as View** action on the Answer
3236
+ * page. Saves an Answer as a View object.
3237
+ *
3238
+ * @example
3239
+ * ```js
3240
+ * disabledActions: [Action.SaveAsView]
3241
+ * ```
3242
+ */
3033
3243
  SaveAsView = "saveAsView",
3244
+ /**
3245
+ * The **Make a copy** action on a Liveboard or Answer
3246
+ * page.
3247
+ * Creates a copy of the Liveboard, visualization,
3248
+ * or Answer.
3249
+ *
3250
+ * @example
3251
+ * ```js
3252
+ * disabledActions: [Action.MakeACopy]
3253
+ * ```
3254
+ */
3034
3255
  MakeACopy = "makeACopy",
3256
+ /**
3257
+ * The **Copy and Edit** action on a Liveboard.
3258
+ * This action is now replaced with `Action.MakeACopy`.
3259
+ *
3260
+ * @example
3261
+ * ```js
3262
+ * disabledActions: [Action.EditACopy]
3263
+ * ```
3264
+ */
3035
3265
  EditACopy = "editACopy",
3266
+ /**
3267
+ * The **Copy link** menu action on a Liveboard visualization.
3268
+ * Copies the visualization URL
3269
+ * @example
3270
+ * ```js
3271
+ * disabledActions: [Action.CopyLink]
3272
+ * ```
3273
+ */
3036
3274
  CopyLink = "embedDocument",
3037
3275
  /**
3038
3276
  * @hidden
3039
3277
  */
3040
3278
  ResetLayout = "resetLayout",
3279
+ /**
3280
+ * The **Schedule** menu action on a Liveboard.
3281
+ * Allows scheduling a Liveboard notification.
3282
+ * @example
3283
+ * ```js
3284
+ * disabledActions: [Action.Schedule]
3285
+ * ```
3286
+ */
3041
3287
  Schedule = "subscription",
3288
+ /**
3289
+ * The **Manage schedules** menu action on a Liveboard.
3290
+ * Allows users to manage scheduled Liveboard jobs.
3291
+ * @example
3292
+ * ```js
3293
+ * disabledActions: [Action.SchedulesList]
3294
+ * ```
3295
+ */
3042
3296
  SchedulesList = "schedule-list",
3297
+ /**
3298
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
3299
+ * Allows users to share an object with other users and groups.
3300
+ * @example
3301
+ * ```js
3302
+ * disabledActions: [Action.Share]
3303
+ * ```
3304
+ */
3043
3305
  Share = "share",
3306
+ /**
3307
+ * The **Add filter** action on a Liveboard and Search page.
3308
+ * Allows adding filters to Answers and visualizations on a Liveboard.
3309
+ * @example
3310
+ * ```js
3311
+ * disabledActions: [Action.AddFilter]
3312
+ * ```
3313
+ */
3044
3314
  AddFilter = "addFilter",
3315
+ /**
3316
+ * Filter configuration options on a Liveboard and Search page.
3317
+ * Allows configuring filter options when adding filters to a
3318
+ * Liveboard or Answer.
3319
+ * @example
3320
+ * ```js
3321
+ * disabledActions: [Action.ConfigureFilter]
3322
+ * ```
3323
+ */
3045
3324
  ConfigureFilter = "configureFilter",
3046
3325
  CollapseDataSources = "collapseDataSources",
3326
+ /**
3327
+ * The **Choose sources** button on Search page.
3328
+ * Allows selecting data sources for search queries.
3329
+ * @example
3330
+ * ```js
3331
+ * disabledActions: [Action.ChooseDataSources]
3332
+ * ```
3333
+ */
3047
3334
  ChooseDataSources = "chooseDataSources",
3335
+ /**
3336
+ * The **Create formula** action on a Search or Answer page.
3337
+ * Allows adding formulas to an Answer.
3338
+ * @example
3339
+ * ```js
3340
+ * disabledActions: [Action.AddFormula]
3341
+ * ```
3342
+ */
3048
3343
  AddFormula = "addFormula",
3344
+ /**
3345
+ * The **Add parameter** action on a Liveboard or Answer.
3346
+ * Allows adding Parameters to a Liveboard or Answer.
3347
+ * @example
3348
+ * ```js
3349
+ * disabledActions: [Action.AddParameter]
3350
+ * ```
3351
+ */
3049
3352
  AddParameter = "addParameter",
3050
3353
  /**
3051
3354
  * @hidden
3052
3355
  */
3053
3356
  SearchOnTop = "searchOnTop",
3357
+ /**
3358
+ * The **SpotIQ analyze** menu action on a visualization or
3359
+ * Answer page.
3360
+ * @example
3361
+ * ```js
3362
+ * disabledActions: [Action.SpotIQAnalyze]
3363
+ * ```
3364
+ */
3054
3365
  SpotIQAnalyze = "spotIQAnalyze",
3055
3366
  /**
3056
3367
  * @hidden
@@ -3065,24 +3376,150 @@ export declare enum Action {
3065
3376
  * @hidden
3066
3377
  */
3067
3378
  ReplaySearch = "replaySearch",
3379
+ /**
3380
+ * The **Show underlying data** menu action on a visualization or
3381
+ * Answer page.
3382
+ * @example
3383
+ * ```js
3384
+ * disabledActions: [Action.ShowUnderlyingData]
3385
+ * ```
3386
+ */
3068
3387
  ShowUnderlyingData = "showUnderlyingData",
3388
+ /**
3389
+ * The **Download** menu action on Liveboard visualizations
3390
+ * and Answers.
3391
+ * Allows downloading a visualization or Answer.
3392
+ * @example
3393
+ * ```js
3394
+ * disabledActions: [Action.DownloadAsPng]
3395
+ * ```
3396
+ */
3069
3397
  Download = "download",
3398
+ /**
3399
+ * The **Download** > **PNG** menu action for charts on a Liveboard
3400
+ * or Answer page.
3401
+ * Downloads a visualization or Answer as a PNG file.
3402
+ * @example
3403
+ * ```js
3404
+ * disabledActions: [Action.DownloadAsPng]
3405
+ * ```
3406
+ */
3070
3407
  DownloadAsPng = "downloadAsPng",
3408
+ /**
3409
+ * The **Download** > **PDF** menu action on a Liveboard.
3410
+ * Downloads a visualization or Answer as a PDF file.
3411
+ * @example
3412
+ * ```js
3413
+ * disabledActions: [Action.DownloadAsPdf]
3414
+ * ```
3415
+ */
3071
3416
  DownloadAsPdf = "downloadAsPdf",
3417
+ /**
3418
+ * The **Download** > **CSV** menu action for tables on a Liveboard
3419
+ * or Answer page.
3420
+ * Downloads a visualization or Answer in the XLSX format.
3421
+ * @example
3422
+ * ```js
3423
+ * disabledActions: [Action.DownloadAsCsv]
3424
+ * ```
3425
+ */
3072
3426
  DownloadAsCsv = "downloadAsCSV",
3427
+ /**
3428
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
3429
+ * or Answer page.
3430
+ * Downloads a visualization or Answer in the XLSX format.
3431
+ * @example
3432
+ * ```js
3433
+ * disabledActions: [Action.DownloadAsXlsx]
3434
+ * ```
3435
+ */
3073
3436
  DownloadAsXlsx = "downloadAsXLSX",
3074
3437
  /**
3075
3438
  * @hidden
3076
3439
  */
3077
3440
  DownloadTrace = "downloadTrace",
3441
+ /**
3442
+ * The **Export TML** menu action on Liveboard, Answers
3443
+ * Worksheets and Data Connections page.
3444
+ * Exports an object as a TML file.
3445
+ * @example
3446
+ * ```js
3447
+ * disabledActions: [Action.ExportTML]
3448
+ * ```
3449
+ */
3078
3450
  ExportTML = "exportTSL",
3451
+ /**
3452
+ * The **Import TML** menu action for Liveboards and Answers.
3453
+ * Imports TML representation of ThoughtSpot objects.
3454
+ * @example
3455
+ * ```js
3456
+ * disabledActions: [Action.ImportTML]
3457
+ * ```
3458
+ */
3079
3459
  ImportTML = "importTSL",
3460
+ /**
3461
+ * The **Update TML** menu action for Liveboards and Answers.
3462
+ * Update TML representation of ThoughtSpot objects.
3463
+ * @example
3464
+ * ```js
3465
+ * disabledActions: [Action.UpdateTML]
3466
+ * ```
3467
+ */
3080
3468
  UpdateTML = "updateTSL",
3469
+ /**
3470
+ * The **Edit TML** menu action for Liveboards and Answers.
3471
+ * Opens the TML editor.
3472
+ * @example
3473
+ * ```js
3474
+ * disabledActions: [Action.EditTML]
3475
+ * ```
3476
+ */
3081
3477
  EditTML = "editTSL",
3478
+ /**
3479
+ * The **Present** menu action for Liveboards and Answers.
3480
+ * Allows presenting a Liveboard or visualization in
3481
+ * slideshow mode.
3482
+ * @example
3483
+ * ```js
3484
+ * disabledActions: [Action.Present]
3485
+ * ```
3486
+ */
3082
3487
  Present = "present",
3488
+ /**
3489
+ * The tile resize options in the visualization menu.
3490
+ * Allows switching between different preset layouts.
3491
+ * @example
3492
+ * ```js
3493
+ * disabledActions: [Action.ToggleSize]
3494
+ * ```
3495
+ */
3083
3496
  ToggleSize = "toggleSize",
3497
+ /**
3498
+ * The *Edit* action on the Liveboard page and in the
3499
+ * visualization menu.
3500
+ * Opens a Liveboard or visualization in edit mode.
3501
+ * @example
3502
+ * ```js
3503
+ * disabledActions: [Action.Edit]
3504
+ * ```
3505
+ */
3084
3506
  Edit = "edit",
3507
+ /**
3508
+ * The text edit option for Liveboard and visualization titles.
3509
+ * @example
3510
+ * ```js
3511
+ * disabledActions: [Action.EditTitle]
3512
+ * ```
3513
+ */
3085
3514
  EditTitle = "editTitle",
3515
+ /**
3516
+ * The **Delete** menu action on Liveboards and visualizations.
3517
+ * Deletes a Liveboard or a visualization from a Liveboard.
3518
+ * @example
3519
+ * ```js
3520
+ * disabledActions: [Action.Remove]
3521
+ * ```
3522
+ */
3086
3523
  Remove = "delete",
3087
3524
  /**
3088
3525
  * @hidden
@@ -3104,6 +3541,16 @@ export declare enum Action {
3104
3541
  * @hidden
3105
3542
  */
3106
3543
  PinboardInfo = "pinboardInfo",
3544
+ /**
3545
+ * The **Show Liveboard details** menu action on a Liveboard.
3546
+ * Displays details such as the name, description, and
3547
+ * author of the Liveboard, and timestamp of Liveboard creation
3548
+ * and update.
3549
+ * @example
3550
+ * ```js
3551
+ * disabledActions: [Action.LiveboardInfo]
3552
+ * ```
3553
+ */
3107
3554
  LiveboardInfo = "pinboardInfo",
3108
3555
  /**
3109
3556
  * @hidden
@@ -3114,20 +3561,61 @@ export declare enum Action {
3114
3561
  */
3115
3562
  DownloadEmbraceQueries = "downloadEmbraceQueries",
3116
3563
  /**
3117
- * Pin action.
3118
- */
3564
+ * The **Pin** menu action on an Answer or
3565
+ * Search results page.
3566
+ * @example
3567
+ * ```js
3568
+ * disabledActions: [Action.Pin]
3569
+ * ```
3570
+ */
3119
3571
  Pin = "pin",
3120
3572
  /**
3121
3573
  * @hidden
3122
3574
  */
3123
3575
  AnalysisInfo = "analysisInfo",
3124
- Subscription = "subscription",
3125
3576
  /**
3126
- * Explore action.
3577
+ * The **Schedule** menu action on a Liveboard.
3578
+ * @example
3579
+ * ```js
3580
+ * disabledActions: [Action.Subscription]
3581
+ * ```
3127
3582
  */
3583
+ Subscription = "subscription",
3584
+ /**
3585
+ * The **Explore** action on Liveboard visualizations
3586
+ * @example
3587
+ * ```js
3588
+ * disabledActions: [Action.Explore]
3589
+ * ```
3590
+ */
3128
3591
  Explore = "explore",
3592
+ /**
3593
+ * The action to include data points on a drilled-down Answer
3594
+ * or visualization
3595
+ * @example
3596
+ * ```js
3597
+ * disabledActions: [Action.DrillInclude]
3598
+ * ```
3599
+ */
3129
3600
  DrillInclude = "context-menu-item-include",
3601
+ /**
3602
+ * The action to exclude data points on a drilled-down Answer
3603
+ * or visualization
3604
+ * @example
3605
+ * ```js
3606
+ * disabledActions: [Action.DrillInclude]
3607
+ * ```
3608
+ */
3130
3609
  DrillExclude = "context-menu-item-exclude",
3610
+ /**
3611
+ * The **Copy to clipboard** menu action on tables in an Answer
3612
+ * or Liveboard.
3613
+ * Copies the selected data point.
3614
+ * @example
3615
+ * ```js
3616
+ * disabledActions: [Action.CopyToClipboard]
3617
+ * ```
3618
+ */
3131
3619
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
3132
3620
  CopyAndEdit = "context-menu-item-copy-and-edit",
3133
3621
  /**
@@ -3136,89 +3624,266 @@ export declare enum Action {
3136
3624
  DrillEdit = "context-menu-item-edit",
3137
3625
  EditMeasure = "context-menu-item-edit-measure",
3138
3626
  Separator = "context-menu-item-separator",
3627
+ /**
3628
+ * The **Drill down** menu action on Answers and Liveboard
3629
+ * visualizations.
3630
+ * Allows drilling down to a specific data point on a chart or table.
3631
+ * @example
3632
+ * ```js
3633
+ * disabledActions: [Action.DrillDown]
3634
+ * ```
3635
+ */
3139
3636
  DrillDown = "DRILL",
3637
+ /**
3638
+ * The request access action on Liveboards.
3639
+ * Allows users with view permissions to request edit access to a Liveboard.
3640
+ * @example
3641
+ * ```js
3642
+ * disabledActions: [Action.RequestAccess]
3643
+ * ```
3644
+ */
3140
3645
  RequestAccess = "requestAccess",
3141
- QueryDetailsButtons = "queryDetailsButtons",
3142
3646
  /**
3143
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3647
+ * The **Query visualizer** and **Query SQL** buttons in Query details panel
3648
+ * of the Answer page
3649
+ * @example
3650
+ * ```js
3651
+ * disabledActions: [Action.QueryDetailsButtons]
3652
+ * ```
3653
+ */
3654
+ QueryDetailsButtons = "QueryDetailsButtons",
3655
+ /**
3656
+ * The **Delete** action for Answers.
3657
+ * @example
3658
+ * ```js
3659
+ * disabledActions: [Action.AnswerDelete]
3660
+ * ```
3661
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
3144
3662
  */
3145
3663
  AnswerDelete = "onDeleteAnswer",
3146
3664
  /**
3147
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3665
+ * The Chart switcher icon on Answer and visualization pages.
3666
+ * @example
3667
+ * ```js
3668
+ * disabledActions: [Action.AnswerChartSwitcher]
3669
+ * ```
3670
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
3148
3671
  */
3149
3672
  AnswerChartSwitcher = "answerChartSwitcher",
3150
3673
  /**
3151
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3674
+ * Favorites icon (*) on Answers, Liveboard, and Data pages
3675
+ * @example
3676
+ * ```js
3677
+ * disabledActions: [Action.AddToFavorites]
3678
+ * ```
3679
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
3152
3680
  */
3153
3681
  AddToFavorites = "addToFavorites",
3154
3682
  /**
3155
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3683
+ * The edit icon on Liveboards (Classic experience).
3684
+ * @example
3685
+ * ```js
3686
+ * disabledActions: [Action.EditDetails]
3687
+ * ```
3688
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
3156
3689
  */
3157
3690
  EditDetails = "editDetails",
3158
3691
  /**
3159
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
3692
+ * The Create alert action on KPI charts.
3693
+ * @example
3694
+ * ```js
3695
+ * disabledActions: [Action.CreateMonitor ]
3696
+ * ```
3697
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3160
3698
  */
3161
3699
  CreateMonitor = "createMonitor",
3162
3700
  /**
3163
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
3701
+ * @example
3702
+ * ```js
3703
+ * disabledActions: [Action.ReportError]
3704
+ * ```
3705
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3164
3706
  */
3165
3707
  ReportError = "reportError",
3708
+ /**
3709
+ * The **Sync to sheets** action on Answers and Liveboard visualizations.
3710
+ * Allows sending data to a Google Sheet.
3711
+ * @example
3712
+ * ```js
3713
+ * disabledActions: [Action.SyncToSheets]
3714
+ * ```
3715
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3716
+ */
3166
3717
  SyncToSheets = "sync-to-sheets",
3718
+ /**
3719
+ * The **Sync to other apps** action on Answers and Liveboard visualizations.
3720
+ * Allows sending data to third-party apps like Slack, Salesforce,
3721
+ * Microsoft Teams, and so on.
3722
+ * @example
3723
+ * ```js
3724
+ * disabledActions: [Action.SyncToOtherApps]
3725
+ * ```
3726
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3727
+ */
3167
3728
  SyncToOtherApps = "sync-to-other-apps",
3729
+ /**
3730
+ * The **Manage pipelines** action on Answers and Liveboard visualizations.
3731
+ * Allows users to manage data sync pipelines to third-party apps.
3732
+ * @example
3733
+ * ```js
3734
+ * disabledActions: [Action.SyncToOtherApps]
3735
+ * ```
3736
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3737
+ */
3168
3738
  ManagePipelines = "manage-pipeline",
3169
3739
  /**
3740
+ * The **Filter** action on Liveboard visualizations.
3741
+ * Allows users to apply cross-filters on a Liveboard.
3742
+ * @example
3743
+ * ```js
3744
+ * disabledActions: [Action.CrossFilter]
3745
+ * ```
3170
3746
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3171
3747
  */
3172
3748
  CrossFilter = "context-menu-item-cross-filter",
3173
3749
  /**
3750
+ * The **Remove** action that appears when cross filters are applied
3751
+ * on a Liveboard.
3752
+ * Removes filters applied o a visualization.
3753
+ * @example
3754
+ * ```js
3755
+ * disabledActions: [Action.RemoveCrossFilter]
3756
+ * ```
3174
3757
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3175
3758
  */
3176
3759
  RemoveCrossFilter = "context-menu-item-remove-cross-filter",
3177
3760
  /**
3761
+ * The **Aggregate** option in the chart axis or the
3762
+ * table column customization menu.
3763
+ * Provides aggregation options to analyze the data on a chart or table.
3764
+ * @example
3765
+ * ```js
3766
+ * disabledActions: [Action.AxisMenuAggregate]
3767
+ * ```
3178
3768
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3179
3769
  */
3180
3770
  AxisMenuAggregate = "axisMenuAggregate",
3181
3771
  /**
3772
+ * The **Time bucket** option in the chart axis or table column
3773
+ * customization menu.
3774
+ * Allows defining time metric for date comparison.
3775
+ * @example
3776
+ * ```js
3777
+ * disabledActions: [Action.AxisMenuTimeBucket]
3778
+ * ```
3182
3779
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3183
3780
  */
3184
3781
  AxisMenuTimeBucket = "axisMenuTimeBucket",
3185
3782
  /**
3783
+ * The **Filter** action in the chart axis or table column
3784
+ * customization menu.
3785
+ * @example
3786
+ * ```js
3787
+ * disabledActions: [Action.AxisMenuFilter]
3788
+ * ```
3186
3789
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3187
3790
  */
3188
3791
  AxisMenuFilter = "axisMenuFilter",
3189
3792
  /**
3793
+ * The **Conditional formatting** action on chart or table.
3794
+ * Allows adding rules for conditional formatting of data
3795
+ * points on a chart or table.
3796
+ * @example
3797
+ * ```js
3798
+ * disabledActions: [Action.AxisMenuConditionalFormat]
3799
+ * ```
3190
3800
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3191
3801
  */
3192
3802
  AxisMenuConditionalFormat = "axisMenuConditionalFormat",
3193
3803
  /**
3804
+ * The **Sort** menu action on a table or chart axis
3805
+ * Sorts data in ascending or descending order.
3806
+ * Allows adding, editing, or removing filters.
3807
+ * @example
3808
+ * ```js
3809
+ * disabledActions: [Action.AxisMenuConditionalFormat]
3810
+ * ```
3194
3811
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3195
3812
  */
3196
3813
  AxisMenuSort = "axisMenuSort",
3197
3814
  /**
3815
+ * The **Group** option in the chart axis or table column
3816
+ * customization menu.
3817
+ * Allows grouping data points if the axes use the same
3818
+ * unit of measurement and a similar scale.
3819
+ * @example
3820
+ * ```js
3821
+ * disabledActions: [Action.AxisMenuGroup]
3822
+ * ```
3198
3823
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3199
3824
  */
3200
3825
  AxisMenuGroup = "axisMenuGroup",
3201
3826
  /**
3827
+ * The **Position** option in the axis customization menu.
3828
+ * Allows changing the position of the axis to the
3829
+ * left or right side of the chart.
3830
+ * @example
3831
+ * ```js
3832
+ * disabledActions: [Action.AxisMenuPosition]
3833
+ * ```
3202
3834
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3203
3835
  */
3204
3836
  AxisMenuPosition = "axisMenuPosition",
3205
3837
  /**
3838
+ * The **Rename** option in the chart axis or table column customization menu.
3839
+ * Renames the axis label on a chart or the column header on a table.
3840
+ * @example
3841
+ * ```js
3842
+ * disabledActions: [Action.AxisMenuRename]
3843
+ * ```
3206
3844
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3207
3845
  */
3208
3846
  AxisMenuRename = "axisMenuRename",
3209
3847
  /**
3848
+ * The **Edit** action in the axis customization menu.
3849
+ * Allows editing the axis name, position, minimum and maximum values,
3850
+ * and format of a column.
3851
+ * @example
3852
+ * ```js
3853
+ * disabledActions: [Action.AxisMenuEdit]
3854
+ * ```
3210
3855
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3211
3856
  */
3212
3857
  AxisMenuEdit = "axisMenuEdit",
3213
3858
  /**
3859
+ * The **Number format** action to customize the format of
3860
+ * the data labels on a chart or table.
3861
+ * @example
3862
+ * ```js
3863
+ * disabledActions: [Action.AxisMenuNumberFormat]
3864
+ * ```
3214
3865
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3215
3866
  */
3216
3867
  AxisMenuNumberFormat = "axisMenuNumberFormat",
3217
3868
  /**
3869
+ * The **Text wrapping** action on a table.
3870
+ * Wraps or clips column text on a table.
3871
+ * @example
3872
+ * ```js
3873
+ * disabledActions: [Action.AxisMenuTextWrapping]
3874
+ * ```
3218
3875
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3219
3876
  */
3220
3877
  AxisMenuTextWrapping = "axisMenuTextWrapping",
3221
3878
  /**
3879
+ * The **Remove** action in the chart axis or table column
3880
+ * customization menu.
3881
+ * Removes the data labels from a chart or the column of a
3882
+ * table visualization.
3883
+ * @example
3884
+ * ```js
3885
+ * disabledActions: [Action.AxisMenuRemove]
3886
+ * ```
3222
3887
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3223
3888
  */
3224
3889
  AxisMenuRemove = "axisMenuRemove",
@@ -3227,9 +3892,31 @@ export declare enum Action {
3227
3892
  */
3228
3893
  InsertInToSlide = "insertInToSlide",
3229
3894
  /**
3895
+ * The **Rename** menu action on Liveboards and visualizations.
3896
+ * Allows renaming a Liveboard or visualization.
3897
+ * @example
3898
+ * ```js
3899
+ * disabledActions: [Action.RenameModalTitleDescription]
3900
+ * ```
3230
3901
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3231
3902
  */
3232
- RenameModalTitleDescription = "renameModalTitleDescription"
3903
+ RenameModalTitleDescription = "renameModalTitleDescription",
3904
+ /**
3905
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3906
+ */
3907
+ RequestVerification = "requestVerification",
3908
+ /**
3909
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3910
+ */
3911
+ MarkAsVerified = "markAsVerified",
3912
+ /**
3913
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3914
+ */
3915
+ AddTab = "addTab",
3916
+ /**
3917
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3918
+ */
3919
+ EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
3233
3920
  }
3234
3921
  export interface SessionInterface {
3235
3922
  sessionId: string;
@@ -3384,7 +4071,7 @@ export interface CustomCssVariables {
3384
4071
  * Background color of the primary buttons. For example, the primary buttons such as
3385
4072
  * Pin* and *Save*.
3386
4073
  */
3387
- '---ts-var-button--primary-background'?: string;
4074
+ '--ts-var-button--primary-background'?: string;
3388
4075
  /**
3389
4076
  * Background color of the primary buttons on hover.
3390
4077
  */