@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
@@ -186,6 +186,7 @@ export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
186
186
  /**
187
187
  * Embed ThoughtSpot LLM and GPT based natural language search component.
188
188
  *
189
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
189
190
  * @group Embed components
190
191
  */
191
192
  export declare class SageEmbed extends V1Embed {
@@ -564,6 +565,12 @@ export interface LiveboardViewConfig extends ViewConfig {
564
565
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
565
566
  */
566
567
  activeTabId?: string;
568
+ /**
569
+ * Hide tab Panel of embedded LB
570
+ *
571
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
572
+ */
573
+ hideTabPanel?: boolean;
567
574
  }
568
575
  /**
569
576
  * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -1030,7 +1037,7 @@ export declare enum AuthType {
1030
1037
  * .then((data) => data.token);
1031
1038
  * }
1032
1039
  * ```
1033
- * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
1040
+ * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
1034
1041
  */
1035
1042
  TrustedAuthTokenCookieless = "AuthServerCookieless",
1036
1043
  /**
@@ -1201,7 +1208,7 @@ export interface EmbedConfig {
1201
1208
  *
1202
1209
  * Eg: "/dashboard", "#/foo" [Do not include the host]
1203
1210
  *
1204
- * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1-sw
1211
+ * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
1205
1212
  */
1206
1213
  redirectPath?: string;
1207
1214
  /** @internal */
@@ -1243,14 +1250,14 @@ export interface EmbedConfig {
1243
1250
  * This flag is typically used alongside the combination of auth modes such as {@link
1244
1251
  * AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
1245
1252
  *
1246
- * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1253
+ * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1247
1254
  * @default false
1248
1255
  */
1249
1256
  disableLoginRedirect?: boolean;
1250
1257
  /**
1251
1258
  * This message is displayed on the embed view when the login fails.
1252
1259
  *
1253
- * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1260
+ * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1254
1261
  */
1255
1262
  loginFailedMessage?: string;
1256
1263
  /**
@@ -1272,7 +1279,7 @@ export interface EmbedConfig {
1272
1279
  * Dynamic CSS Url to be injected in the loaded application.
1273
1280
  * You would also need to set `style-src` in the CSP settings.
1274
1281
  *
1275
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1282
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1276
1283
  * @default ''
1277
1284
  */
1278
1285
  customCssUrl?: string;
@@ -1284,13 +1291,13 @@ export interface EmbedConfig {
1284
1291
  * This is slightly slower than letting the browser handle the cookie check, as it
1285
1292
  * involves an extra network call.
1286
1293
  *
1287
- * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1294
+ * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1288
1295
  */
1289
1296
  detectCookieAccessSlow?: boolean;
1290
1297
  /**
1291
1298
  * Hide beta alert warning message for SearchEmbed.
1292
1299
  *
1293
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw*
1300
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
1294
1301
  */
1295
1302
  suppressSearchEmbedBetaWarning?: boolean;
1296
1303
  /**
@@ -1338,7 +1345,7 @@ export interface EmbedConfig {
1338
1345
  * Disable Full App access of Embedded app outside of the iFrame.
1339
1346
  *
1340
1347
  * @default true
1341
- * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1-sw
1348
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1342
1349
  */
1343
1350
  blockNonEmbedFullAppAccess?: boolean;
1344
1351
  /**
@@ -1441,14 +1448,14 @@ export interface ViewConfig {
1441
1448
  *
1442
1449
  * Use either this or hiddenActions.
1443
1450
  *
1444
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1451
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1445
1452
  * @important
1446
1453
  */
1447
1454
  visibleActions?: Action[];
1448
1455
  /**
1449
1456
  * Show alert messages and toast messages in the embedded view.
1450
1457
  *
1451
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1458
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1452
1459
  */
1453
1460
  showAlerts?: boolean;
1454
1461
  /**
@@ -1459,7 +1466,7 @@ export interface ViewConfig {
1459
1466
  /**
1460
1467
  * The locale/language to use for the embedded view.
1461
1468
  *
1462
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
1469
+ * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1463
1470
  */
1464
1471
  locale?: string;
1465
1472
  /**
@@ -1470,7 +1477,7 @@ export interface ViewConfig {
1470
1477
  * to control embed behavior in non-regular ways. We do not publish the
1471
1478
  * list of supported keys and values associated with each.
1472
1479
  *
1473
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1480
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1474
1481
  */
1475
1482
  additionalFlags?: {
1476
1483
  [key: string]: string | number | boolean;
@@ -1479,7 +1486,7 @@ export interface ViewConfig {
1479
1486
  * Dynamic CSSUrl and customCSS to be injected in the loaded application.
1480
1487
  * You would also need to set `style-src` in the CSP settings.
1481
1488
  *
1482
- * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1-sw, 8.4.0.cl
1489
+ * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
1483
1490
  * @default ''
1484
1491
  */
1485
1492
  customizations?: CustomisationsInterface;
@@ -1524,6 +1531,63 @@ export interface ViewConfig {
1524
1531
  * @hidden
1525
1532
  */
1526
1533
  excludeRuntimeFiltersfromURL?: boolean;
1534
+ /**
1535
+ * Boolean to hide liveboard header
1536
+ *
1537
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1538
+ * @default false
1539
+ */
1540
+ hideLiveboardHeader?: boolean;
1541
+ /**
1542
+ * Boolean to show liveboard title
1543
+ *
1544
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1545
+ * @default false
1546
+ */
1547
+ showLiveboardTitle?: boolean;
1548
+ /**
1549
+ * Boolean to show liveboard description
1550
+ *
1551
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1552
+ * @default false
1553
+ */
1554
+ showLiveboardDescription?: boolean;
1555
+ /**
1556
+ * The list of tab IDs to hide from the embedded.
1557
+ * This Tabs will be hidden from their respective LBs.
1558
+ * Use this to hide an tabID.
1559
+ *
1560
+ * @example
1561
+ * ```js
1562
+ * const embed = new LiveboardEmbed('#embed', {
1563
+ * ... // other liveboard view config
1564
+ * hiddenTabs: [
1565
+ * '430496d6-6903-4601-937e-2c691821af3c',
1566
+ * 'f547ec54-2a37-4516-a222-2b06719af726']
1567
+ * });
1568
+ * ```
1569
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1570
+ */
1571
+ hiddenTabs?: string[];
1572
+ /**
1573
+ * The list of tab IDs to show in the embedded.
1574
+ * Only this Tabs will be shown in their respective LBs.
1575
+ * Use this to show an tabID.
1576
+ *
1577
+ * Use either this or hiddenTabs.
1578
+ *
1579
+ * @example
1580
+ * ```js
1581
+ * const embed = new LiveboardEmbed('#embed', {
1582
+ * ... // other liveboard view config
1583
+ * visibleTabs: [
1584
+ * '430496d6-6903-4601-937e-2c691821af3c',
1585
+ * 'f547ec54-2a37-4516-a222-2b06719af726']
1586
+ * });
1587
+ * ```
1588
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1589
+ */
1590
+ visibleTabs?: string[];
1527
1591
  }
1528
1592
  /**
1529
1593
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1729,7 +1793,7 @@ export declare enum EmbedEvent {
1729
1793
  * One or more data columns have been selected.
1730
1794
  *
1731
1795
  * @returns columnIds - the list of columns
1732
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1796
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1733
1797
  */
1734
1798
  AddRemoveColumns = "addRemoveColumns",
1735
1799
  /**
@@ -1762,7 +1826,7 @@ export declare enum EmbedEvent {
1762
1826
  * });
1763
1827
  * ```
1764
1828
  * @return viz, clickedPoint - metadata about point that is clicked
1765
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1829
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1766
1830
  * @important
1767
1831
  */
1768
1832
  VizPointClick = "vizPointClick",
@@ -1812,7 +1876,7 @@ export declare enum EmbedEvent {
1812
1876
  * Emitted when the "Get Data" button in Search Bar embed
1813
1877
  * is clicked.
1814
1878
  *
1815
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
1879
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
1816
1880
  */
1817
1881
  GetDataClick = "getDataClick",
1818
1882
  /**
@@ -1842,13 +1906,13 @@ export declare enum EmbedEvent {
1842
1906
  /**
1843
1907
  * Emitted when any modal is opened in the app
1844
1908
  *
1845
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1909
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1846
1910
  */
1847
1911
  DialogOpen = "dialog-open",
1848
1912
  /**
1849
1913
  * Emitted when any modal is closed in the app
1850
1914
  *
1851
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1915
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1852
1916
  */
1853
1917
  DialogClose = "dialog-close",
1854
1918
  /**
@@ -1856,136 +1920,136 @@ export declare enum EmbedEvent {
1856
1920
  * You can use this event as a hook to trigger
1857
1921
  * other events on the rendered Liveboard.
1858
1922
  *
1859
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1923
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1860
1924
  */
1861
1925
  LiveboardRendered = "PinboardRendered",
1862
1926
  /**
1863
1927
  * This can be used to register an event listener which
1864
1928
  * is triggered on all events.
1865
1929
  *
1866
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1930
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1867
1931
  */
1868
1932
  ALL = "*",
1869
1933
  /**
1870
- * Emitted when answer is saved in the app
1934
+ * Emitted when an Answer is saved in the app
1871
1935
  *
1872
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1936
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1873
1937
  */
1874
1938
  Save = "save",
1875
1939
  /**
1876
1940
  * Emitted when the download action is triggered on an answer
1877
1941
  *
1878
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1942
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1879
1943
  */
1880
1944
  Download = "download",
1881
1945
  /**
1882
1946
  * Emitted when the download action is triggered on an answer
1883
1947
  *
1884
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
1948
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
1885
1949
  */
1886
1950
  DownloadAsPng = "downloadAsPng",
1887
1951
  /**
1888
1952
  * Emitted when the Download as PDF action is triggered on an answer
1889
1953
  *
1890
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1954
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1891
1955
  */
1892
1956
  DownloadAsPdf = "downloadAsPdf",
1893
1957
  /**
1894
1958
  * Emitted when the Download as CSV action is triggered on an answer
1895
1959
  *
1896
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1960
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1897
1961
  */
1898
1962
  DownloadAsCsv = "downloadAsCsv",
1899
1963
  /**
1900
1964
  * Emitted when the Download as XLSX action is triggered on an answer
1901
1965
  *
1902
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1966
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1903
1967
  */
1904
1968
  DownloadAsXlsx = "downloadAsXlsx",
1905
1969
  /**
1906
1970
  * Emitted when an answer is deleted in the app
1907
1971
  *
1908
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1972
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1909
1973
  */
1910
1974
  AnswerDelete = "answerDelete",
1911
1975
  /**
1912
1976
  * Emitted when an answer is pinned to a Liveboard
1913
1977
  *
1914
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1978
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1915
1979
  */
1916
1980
  Pin = "pin",
1917
1981
  /**
1918
1982
  * Emitted when SpotIQ analysis is triggered
1919
1983
  *
1920
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1984
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1921
1985
  */
1922
1986
  SpotIQAnalyze = "spotIQAnalyze",
1923
1987
  /**
1924
1988
  * Emitted when a user shares an object with another user or group
1925
1989
  *
1926
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1990
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1927
1991
  */
1928
1992
  Share = "share",
1929
1993
  /**
1930
1994
  * Emitted when a user clicks the Include action to include a specific value or data
1931
1995
  * on a chart or table
1932
1996
  *
1933
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1997
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1934
1998
  */
1935
1999
  DrillInclude = "context-menu-item-include",
1936
2000
  /**
1937
2001
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
1938
2002
  * on a chart or table
1939
2003
  *
1940
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2004
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1941
2005
  */
1942
2006
  DrillExclude = "context-menu-item-exclude",
1943
2007
  /**
1944
2008
  * Emitted when copied column value on the app
1945
2009
  *
1946
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2010
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1947
2011
  */
1948
2012
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
1949
2013
  /**
1950
2014
  * Emitted when a user clicks the Update TML action
1951
2015
  *
1952
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2016
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1953
2017
  */
1954
2018
  UpdateTML = "updateTSL",
1955
2019
  /**
1956
2020
  * Emitted when a user clicks the Edit TML action
1957
2021
  *
1958
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2022
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1959
2023
  */
1960
2024
  EditTML = "editTSL",
1961
2025
  /**
1962
2026
  * Emitted when ExportTML trigger in answer on the app
1963
2027
  *
1964
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2028
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1965
2029
  */
1966
2030
  ExportTML = "exportTSL",
1967
2031
  /**
1968
2032
  * Emitted when an answer is saved as a view
1969
2033
  *
1970
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2034
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1971
2035
  */
1972
2036
  SaveAsView = "saveAsView",
1973
2037
  /**
1974
2038
  * Emitted when copy of existing answer on the app
1975
2039
  *
1976
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2040
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1977
2041
  */
1978
2042
  CopyAEdit = "copyAEdit",
1979
2043
  /**
1980
2044
  * Emitted when a user clicks Show underlying data on an answe
1981
2045
  *
1982
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2046
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1983
2047
  */
1984
2048
  ShowUnderlyingData = "showUnderlyingData",
1985
2049
  /**
1986
2050
  * Emitted when an answer is switched to a chart or table view
1987
2051
  *
1988
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2052
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1989
2053
  */
1990
2054
  AnswerChartSwitcher = "answerChartSwitcher",
1991
2055
  /**
@@ -1997,67 +2061,67 @@ export declare enum EmbedEvent {
1997
2061
  /**
1998
2062
  * Emitted when a user clicks Show Liveboard details on a Liveboard
1999
2063
  *
2000
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2064
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2001
2065
  */
2002
2066
  LiveboardInfo = "pinboardInfo",
2003
2067
  /**
2004
2068
  * Emitted when a user clicks on the Favorite icon on a Liveboard
2005
2069
  *
2006
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2070
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2007
2071
  */
2008
2072
  AddToFavorites = "addToFavorites",
2009
2073
  /**
2010
2074
  * Emitted when a user clicks Schedule on a Liveboard
2011
2075
  *
2012
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2076
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2013
2077
  */
2014
2078
  Schedule = "subscription",
2015
2079
  /**
2016
2080
  * Emitted when a user clicks Edit on a Liveboard or visualization
2017
2081
  *
2018
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2082
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2019
2083
  */
2020
2084
  Edit = "edit",
2021
2085
  /**
2022
2086
  * Emitted when a user clicks Make a copy on a Liveboard
2023
2087
  *
2024
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2088
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2025
2089
  */
2026
2090
  MakeACopy = "makeACopy",
2027
2091
  /**
2028
2092
  * Emitted when a user clicks Present on a Liveboard or visualization
2029
2093
  *
2030
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2094
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2031
2095
  */
2032
2096
  Present = "present",
2033
2097
  /**
2034
2098
  * Emitted when a user clicks Delete on a Liveboard
2035
2099
  *
2036
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2100
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2037
2101
  */
2038
2102
  Delete = "delete",
2039
2103
  /**
2040
2104
  * Emitted when a user clicks Manage schedules on a Liveboard
2041
2105
  *
2042
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2106
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2043
2107
  */
2044
2108
  SchedulesList = "schedule-list",
2045
2109
  /**
2046
2110
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
2047
2111
  *
2048
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2112
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2049
2113
  */
2050
2114
  Cancel = "cancel",
2051
2115
  /**
2052
2116
  * Emitted when a user clicks Explore on a visualization
2053
2117
  *
2054
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2118
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2055
2119
  */
2056
2120
  Explore = "explore",
2057
2121
  /**
2058
2122
  * Emitted when a user clicks Copy link action on a visualization
2059
2123
  *
2060
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2124
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2061
2125
  */
2062
2126
  CopyLink = "embedDocument",
2063
2127
  /**
@@ -2077,7 +2141,13 @@ export declare enum EmbedEvent {
2077
2141
  *
2078
2142
  * @hidden
2079
2143
  */
2080
- InsertIntoSlide = "insertInToSlide"
2144
+ InsertIntoSlide = "insertInToSlide",
2145
+ /**
2146
+ * Emitted when a user changes any filter on a Liveboard.
2147
+ *
2148
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2149
+ */
2150
+ FilterChanged = "filterChanged"
2081
2151
  }
2082
2152
  /**
2083
2153
  * Event types that can be triggered by the host application
@@ -2103,13 +2173,14 @@ export declare enum EmbedEvent {
2103
2173
  */
2104
2174
  export declare enum HostEvent {
2105
2175
  /**
2106
- * Trigger a search
2107
- *
2176
+ * Triggers a search query in AppEmbed and SearchEmbed
2177
+ * deployments.
2178
+ * Includes the following properties:
2108
2179
  * @param - dataSourceIds - The data source GUID to Search on
2109
2180
  * - Although an array, only a single source
2110
- * is supported at this time.
2111
- * @param - searchQuery - The search query
2112
- * @param - execute - execute the existing / updated query
2181
+ * is supported.
2182
+ * @param - searchQuery - Query string with search tokens
2183
+ * @param - execute - executes the existing / updated query
2113
2184
  * @example
2114
2185
  * ```js
2115
2186
  * searchEmbed.trigger(HostEvent.Search, {
@@ -2121,13 +2192,13 @@ export declare enum HostEvent {
2121
2192
  */
2122
2193
  Search = "search",
2123
2194
  /**
2124
- * Trigger a drill on certain points by certain column
2125
- *
2195
+ * Triggers a drill on certain points of the specified column
2196
+ * Includes the following properties:
2126
2197
  * @param - points - an object containing selectedPoints/clickedPoints
2127
- * eg. { selectedPoints: []}
2128
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
2129
- * if not provided it will auto drill by the configured
2130
- * column.
2198
+ * to drill to. For example, { selectedPoints: []}
2199
+ * @param - columnGuid - Optional. GUID of the column to drill
2200
+ * by. If not provided it will auto drill by the configured
2201
+ * column.
2131
2202
  * @example
2132
2203
  * ```js
2133
2204
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -2160,17 +2231,17 @@ export declare enum HostEvent {
2160
2231
  */
2161
2232
  Reload = "reload",
2162
2233
  /**
2163
- * Set the visible visualizations on a Liveboard.
2234
+ * Sets the visible visualizations on a Liveboard.
2164
2235
  *
2165
- * @param - an array of ids of visualizations to show, the ids not passed
2166
- * will be hidden.
2236
+ * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
2237
+ * in this parameter will be hidden.
2167
2238
  * @example
2168
2239
  * ```js
2169
2240
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
2170
2241
  * '730496d6-6903-4601-937e-2c691821af3c',
2171
2242
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
2172
2243
  * ```
2173
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
2244
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2174
2245
  */
2175
2246
  SetVisibleVizs = "SetPinboardVisibleVizs",
2176
2247
  /**
@@ -2187,9 +2258,18 @@ export declare enum HostEvent {
2187
2258
  */
2188
2259
  SetActiveTab = "SetActiveTab",
2189
2260
  /**
2190
- * Update the runtime filters. The runtime filters passed here are extended
2191
- * on to the existing runtime filters if they exist.
2192
- *
2261
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
2262
+ * runtime filters passed here are appended to the existing runtime
2263
+ * filters.
2264
+ * Pass an array of runtime filters with the following attributes:
2265
+ * `columnName`
2266
+ * _String_. The name of the column to filter on.
2267
+ * `operator`
2268
+ * Runtime filter operator to apply. For information,
2269
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2270
+ * `values`
2271
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
2272
+ * such as BW and IN accept multiple operands.
2193
2273
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
2194
2274
  * @example
2195
2275
  * ```js
@@ -2198,25 +2278,24 @@ export declare enum HostEvent {
2198
2278
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
2199
2279
  * ])
2200
2280
  * ```
2201
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2281
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2202
2282
  * @important
2203
2283
  */
2204
2284
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
2205
2285
  /**
2206
- * Navigate to a specific page in App embed without any reload.
2286
+ * Navigate to a specific page in the embedded application without reloading the page.
2207
2287
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
2208
- *
2209
2288
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
2210
2289
  * @example
2211
2290
  * ```js
2212
2291
  * appEmbed.navigateToPage(-1)
2213
2292
  * ```
2214
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
2293
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
2215
2294
  */
2216
2295
  Navigate = "Navigate",
2217
2296
  /**
2218
2297
  * Opens the filter panel for a particular column.
2219
- * Works with Search embed.
2298
+ * Works with Search and Liveboard embed.
2220
2299
  *
2221
2300
  * @param - { columnId: string,
2222
2301
  * name: string,
@@ -2225,233 +2304,257 @@ export declare enum HostEvent {
2225
2304
  * @example
2226
2305
  * ```js
2227
2306
  * searchEmbed.trigger(HostEvent.OpenFilter,
2228
- * { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
2307
+ * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
2308
+ * LiveboardEmbed.trigger(HostEvent.OpenFilter,
2309
+ * { columnId: '<column-GUID>'})
2229
2310
  * ```
2230
2311
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2231
2312
  */
2232
2313
  OpenFilter = "openFilter",
2233
2314
  /**
2234
- * Adds the columns to the current Search.
2315
+ * Adds columns to the current search query.
2235
2316
  *
2236
2317
  * @param - { columnIds: string[] }
2237
2318
  * @example
2238
2319
  * ```js
2239
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
2320
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
2240
2321
  * ```
2241
2322
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2242
2323
  */
2243
2324
  AddColumns = "addColumns",
2244
2325
  /**
2245
- * Removes a column from the current Search.
2326
+ * Removes a column from the current search query.
2246
2327
  *
2247
2328
  * @param - { columnId: string }
2248
2329
  * @example
2249
2330
  * ```js
2250
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
2331
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
2251
2332
  * ```
2252
2333
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2253
2334
  */
2254
2335
  RemoveColumn = "removeColumn",
2255
2336
  /**
2256
- * Gets the current pinboard content.
2337
+ * Gets the current Liveboard content.
2257
2338
  *
2258
2339
  * @example
2259
2340
  * ```js
2260
2341
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
2261
2342
  * ```
2262
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
2343
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
2263
2344
  */
2264
2345
  getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
2265
2346
  /**
2266
- * Triggers the Pin action on an embedded object
2347
+ * Triggers the **Pin** action on an embedded object
2267
2348
  *
2268
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2269
- * can be left empty for search and visualization embeds
2349
+ * @param - Liveboard embed takes the `vizId` as a
2350
+ * key. Can be left undefined when embedding Search, full app or
2351
+ * a visualization.
2270
2352
  * @example
2271
2353
  * ```js
2272
2354
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2355
+ * ```
2356
+ * ```js
2273
2357
  * vizEmbed.trigger(HostEvent.Pin)
2358
+ * ```
2359
+ * ```js
2274
2360
  * searchEmbed.trigger(HostEvent.Pin)
2275
2361
  * ```
2276
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2362
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2277
2363
  */
2278
2364
  Pin = "pin",
2279
2365
  /**
2280
- * Triggers the Show Liveboard details action on a Liveboard
2366
+ * Triggers the **Show Liveboard details** action on a Liveboard
2281
2367
  *
2282
2368
  * @example
2283
2369
  * ```js
2284
2370
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
2285
2371
  * ```
2286
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2372
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2287
2373
  */
2288
2374
  LiveboardInfo = "pinboardInfo",
2289
2375
  /**
2290
- * Triggers the Schedule action on a Liveboard
2376
+ * Triggers the **Schedule** action on a Liveboard
2291
2377
  *
2292
2378
  * @example
2293
2379
  * ```js
2294
2380
  * liveboardEmbed.trigger(HostEvent.Schedule)
2295
2381
  * ```
2296
- * @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
2297
2383
  */
2298
2384
  Schedule = "subscription",
2299
2385
  /**
2300
- * Triggers the Manage schedule action on a Liveboard
2386
+ * Triggers the **Manage schedule** action on a Liveboard
2301
2387
  *
2302
2388
  * @example
2303
2389
  * ```js
2304
2390
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
2305
2391
  * ```
2306
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2392
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2307
2393
  */
2308
2394
  SchedulesList = "schedule-list",
2309
2395
  /**
2310
- * Triggers the Export TML action on a Liveboard
2396
+ * Triggers the **Export TML** action on a Liveboard
2311
2397
  *
2312
2398
  * @example
2313
2399
  * ```js
2314
2400
  * liveboardEmbed.trigger(HostEvent.ExportTML)
2315
2401
  * ```
2316
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2402
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2317
2403
  */
2318
2404
  ExportTML = "exportTSL",
2319
2405
  /**
2320
- * Triggers the Edit TML action on a Liveboard
2406
+ * Triggers the **Edit TML** action on a Liveboard
2321
2407
  *
2322
2408
  * @example
2323
2409
  * ```js
2324
2410
  * liveboardEmbed.trigger(HostEvent.EditTML)
2325
2411
  * ```
2326
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2412
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2327
2413
  */
2328
2414
  EditTML = "editTSL",
2329
2415
  /**
2330
- * Triggers the Update TML action on a Liveboard
2416
+ * Triggers the **Update TML** action on a Liveboard
2331
2417
  *
2332
2418
  * @example
2333
2419
  * ```js
2334
2420
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
2335
2421
  * ```
2336
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2422
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2337
2423
  */
2338
2424
  UpdateTML = "updateTSL",
2339
2425
  /**
2340
- * Triggers the Download PDF action on a Liveboard
2426
+ * Triggers the **Download PDF** action on a Liveboard
2341
2427
  *
2342
2428
  * @example
2343
2429
  * ```js
2344
2430
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
2345
2431
  * ```
2346
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2432
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2347
2433
  */
2348
2434
  DownloadAsPdf = "downloadAsPdf",
2349
2435
  /**
2350
- * Triggers the Make a copy action on a Liveboard, search or visualization
2436
+ * Triggers the **Make a copy** action on a Liveboard, Search, or
2437
+ * visualization page
2351
2438
  *
2352
2439
  * @example
2353
2440
  * ```js
2354
2441
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2442
+ * ```
2443
+ * ```js
2355
2444
  * vizEmbed.trigger(HostEvent.MakeACopy)
2445
+ * ```
2446
+ * ```js
2356
2447
  * searchEmbed.trigger(HostEvent.MakeACopy)
2357
2448
  * ```
2358
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2449
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2359
2450
  */
2360
2451
  MakeACopy = "makeACopy",
2361
2452
  /**
2362
- * Triggers the Delete action on a Liveboard
2453
+ * Triggers the **Delete** action on a Liveboard
2363
2454
  *
2364
2455
  * @example
2365
2456
  * ```js
2366
2457
  * appEmbed.trigger(HostEvent.Remove)
2367
2458
  * ```
2368
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2459
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2369
2460
  */
2370
2461
  Remove = "delete",
2371
2462
  /**
2372
- * Triggers the Explore action on a visualization
2463
+ * Triggers the **Explore* action on a visualization
2373
2464
  *
2374
- * @param - an object with vizId as a key
2465
+ * @param - an object with `vizId` as a key
2375
2466
  * @example
2376
2467
  * ```js
2377
2468
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2378
2469
  * ```
2379
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2470
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2380
2471
  */
2381
2472
  Explore = "explore",
2382
2473
  /**
2383
- * Triggers the Create alert action on a visualization
2474
+ * Triggers the **Create alert** action on a visualization
2384
2475
  *
2385
- * @param - an object with vizId as a key
2476
+ * @param - an object with `vizId` as a key
2386
2477
  * @example
2387
2478
  * ```js
2388
2479
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
2389
2480
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2390
2481
  * })
2391
2482
  * ```
2392
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2483
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2393
2484
  */
2394
2485
  CreateMonitor = "createMonitor",
2395
2486
  /**
2396
- * Triggers the Manage alert action on a visualization
2487
+ * Triggers the **Manage alerts** action on a visualization
2397
2488
  *
2398
- * @param - an object with vizId as a key
2489
+ * @param - an object with `vizId` as a key
2399
2490
  * @example
2400
2491
  * ```js
2401
2492
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
2402
2493
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2403
2494
  * })
2404
2495
  * ```
2405
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2496
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2406
2497
  */
2407
2498
  ManageMonitor = "manageMonitor",
2408
2499
  /**
2409
- * Triggers the Edit action on a Liveboard or visualization
2500
+ * Triggers the **Edit** action on a Liveboard or visualization
2410
2501
  *
2411
- * @param - object - to trigger the action for a specfic visualization
2412
- * in Liveboard embed, pass in vizId as a key
2502
+ * @param - object - To trigger the action for a specific visualization
2503
+ * in Liveboard embed, pass in `vizId` as a key.
2504
+ * Can be left undefined when embedding Search, full app, or
2505
+ * a visualization.
2413
2506
  * @example
2414
2507
  * ```js
2415
2508
  * liveboardEmbed.trigger(HostEvent.Edit)
2416
- *
2509
+ * ```
2510
+ * ```js
2417
2511
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
2418
2512
  * '730496d6-6903-4601-937e-2c691821af3c'})
2419
- *
2513
+ * ```
2514
+ * ```js
2420
2515
  * vizEmbed.trigger((HostEvent.Edit)
2421
2516
  * ```
2422
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2517
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2423
2518
  */
2424
2519
  Edit = "edit",
2425
2520
  /**
2426
- * Triggers the Copy link action on a Liveboard or visualization
2521
+ * Triggers the **Copy link** action on a Liveboard or visualization
2427
2522
  *
2428
- * @param - object - to trigger the action for a s
2429
- * pecfic visualization in Liveboard embed, pass in vizId as a key
2523
+ * @param - object - to trigger the action for a
2524
+ * specific visualization in Liveboard embed, pass in `vizId` as a key
2430
2525
  * @example
2431
2526
  * ```js
2432
2527
  * liveboardEmbed.trigger(HostEvent.CopyLink)
2528
+ * ```
2529
+ * ```js
2433
2530
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2531
+ * ```
2532
+ * ```js
2434
2533
  * vizEmbed.trigger((HostEvent.CopyLink)
2435
2534
  * ```
2436
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2535
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2437
2536
  */
2438
2537
  CopyLink = "embedDocument",
2439
2538
  /**
2440
- * Triggers the Present action on a Liveboard or visualization
2539
+ * Triggers the **Present** action on a Liveboard or visualization
2441
2540
  *
2442
- * @param - object - to trigger the action for a specfic visualization
2443
- * in Liveboard embed, pass in vizId as a key
2541
+ * @param - object - to trigger the action for a specific visualization
2542
+ * in Liveboard embed, pass in `vizId` as a key
2444
2543
  * @example
2445
2544
  * ```js
2446
2545
  * liveboardEmbed.trigger(HostEvent.Present)
2546
+ * ```
2547
+ * ```js
2447
2548
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2549
+ * ```
2550
+ * ```js
2448
2551
  * vizEmbed.trigger((HostEvent.Present)
2449
2552
  * ```
2450
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2553
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2451
2554
  */
2452
2555
  Present = "present",
2453
2556
  /**
2454
- * Get TML for the current search.
2557
+ * Gets TML for the current search.
2455
2558
  *
2456
2559
  * @example
2457
2560
  * ```js
@@ -2461,79 +2564,89 @@ export declare enum HostEvent {
2461
2564
  * );
2462
2565
  * })
2463
2566
  * ```
2464
- * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
2567
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2465
2568
  * @important
2466
2569
  */
2467
2570
  GetTML = "getTML",
2468
2571
  /**
2469
- * Triggers the ShowUnderlyingData action on visualization or search
2572
+ * Triggers the **Show underlying data** action on visualization or search
2470
2573
  *
2471
2574
  * @param - an object with vizId as a key
2472
2575
  * @example
2473
2576
  * ```js
2474
2577
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
2475
2578
  * '730496d6-6903-4601-937e-2c691821af3c'})
2476
- *
2579
+ * ```
2580
+ * ```js
2477
2581
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
2478
- *
2582
+ * ```
2583
+ * ```js
2479
2584
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
2480
2585
  * ```
2481
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2586
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2482
2587
  */
2483
2588
  ShowUnderlyingData = "showUnderlyingData",
2484
2589
  /**
2485
- * Triggers the Delete action on visualization or search
2590
+ * Triggers the **Delete** action on visualization or search
2486
2591
  *
2487
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2488
- * can be left empty for search and visualization embeds
2592
+ * @param - Liveboard embed takes an object with `vizId` as a key.
2593
+ * Can be left empty if embedding Search or visualization.
2489
2594
  * @example
2490
2595
  * ```js
2491
2596
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
2492
2597
  * '730496d6-6903-4601-937e-2c691821af3c'})
2493
- *
2598
+ * ```
2599
+ * ```js
2494
2600
  * vizEmbed.trigger(HostEvent.Delete)
2495
- *
2601
+ * ```
2602
+ * ```js
2496
2603
  * searchEmbed.trigger(HostEvent.Delete)
2497
2604
  * ```
2498
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2605
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2499
2606
  */
2500
2607
  Delete = "onDeleteAnswer",
2501
2608
  /**
2502
- * Triggers the SpotIQAnalyze action on visualization or search
2503
- *
2504
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2505
- * can be left empty for search and visualization embeds
2609
+ * Triggers the **SpotIQ analyze** action on visualization
2610
+ * or search.
2611
+ * @param - Liveboard embed takes `vizId` as a
2612
+ * key. Can be left undefined when embedding Search or
2613
+ * visualization.
2506
2614
  * @example
2507
2615
  * ```js
2508
2616
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
2509
2617
  * '730496d6-6903-4601-937e-2c691821af3c'})
2510
- *
2618
+ * ```
2619
+ * ```js
2511
2620
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
2512
- *
2621
+ * ```
2622
+ * ```js
2513
2623
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
2514
2624
  * ```
2515
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2625
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2516
2626
  */
2517
2627
  SpotIQAnalyze = "spotIQAnalyze",
2518
2628
  /**
2519
- * Triggers the Download action on visualization or search when Displaymode is Chart
2629
+ * Triggers the **Download** action on charts in
2630
+ * the embedded view.
2520
2631
  *
2521
2632
  * @example
2522
2633
  * ```js
2523
2634
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
2524
2635
  * '730496d6-6903-4601-937e-2c691821af3c'})
2525
- *
2636
+ * ```
2637
+ * ```js
2526
2638
  * vizEmbed.trigger(HostEvent.Download)
2527
- *
2639
+ * ```
2640
+ * ```js
2528
2641
  * searchEmbed.trigger(HostEvent.Download)
2529
2642
  * ```
2530
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
2531
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2643
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
2644
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2532
2645
  */
2533
2646
  Download = "downloadAsPng",
2534
2647
  /**
2535
- * Triggers the Download action on visualization or search when Displaymode is Chart
2536
- *
2648
+ * Triggers the **Download** > **PNG** action on
2649
+ * charts in the embedded view.
2537
2650
  * @example
2538
2651
  * ```js
2539
2652
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -2543,115 +2656,179 @@ export declare enum HostEvent {
2543
2656
  *
2544
2657
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
2545
2658
  * ```
2546
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
2659
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
2547
2660
  */
2548
2661
  DownloadAsPng = "downloadAsPng",
2549
2662
  /**
2550
- * Triggers the downloadAsCSV action on visualization or search
2663
+ * Triggers the **Download** > **CSV** action on tables in
2664
+ * the embedded view.
2551
2665
  *
2552
2666
  * @example
2553
2667
  * ```js
2554
2668
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
2555
2669
  * '730496d6-6903-4601-937e-2c691821af3c'})
2556
- *
2670
+ * ```
2671
+ * ```js
2557
2672
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
2558
- *
2673
+ * ```
2674
+ * ```js
2559
2675
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
2560
2676
  * ```
2561
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2677
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2562
2678
  */
2563
2679
  DownloadAsCsv = "downloadAsCSV",
2564
2680
  /**
2565
- * Triggers the downloadAsXLSX action on visualization or search
2566
- *
2681
+ * Triggers the **Download** > **XLSX** action on tables
2682
+ * in the embedded view.
2567
2683
  * @example
2568
2684
  * ```js
2569
2685
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
2570
2686
  * '730496d6-6903-4601-937e-2c691821af3c'})
2571
- *
2687
+ * ```
2688
+ * ```js
2572
2689
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
2573
- *
2690
+ * ```
2691
+ * ```js
2574
2692
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
2575
2693
  * ```
2576
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2694
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2577
2695
  */
2578
2696
  DownloadAsXlsx = "downloadAsXLSX",
2579
2697
  /**
2580
- * Triggers the Share action on a liveboard or answer
2698
+ * Triggers the **Share** action on an embedded
2699
+ * Liveboard or Answer.
2581
2700
  *
2582
2701
  * @example
2583
2702
  * ```js
2584
2703
  * liveboardEmbed.trigger(HostEvent.Share)
2585
- *
2704
+ * ```
2705
+ * ```js
2586
2706
  * searchEmbed.trigger(HostEvent.Share)
2587
2707
  * ```
2588
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2708
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2589
2709
  */
2590
2710
  Share = "share",
2591
2711
  /**
2592
- * Trigger the Save action on a liveboard or answer
2593
- *
2712
+ * Triggers the **Save** action on a Liveboard or Answer.
2713
+ * Saves the changes.
2594
2714
  * @example
2595
2715
  * ```js
2596
2716
  * liveboardEmbed.trigger(HostEvent.Save)
2597
- *
2717
+ * ```
2718
+ * ```js
2598
2719
  * searchEmbed.trigger(HostEvent.Save)
2599
2720
  * ```
2600
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2721
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2601
2722
  */
2602
2723
  Save = "save",
2603
2724
  /**
2604
- * Triggers the SyncToSheets action on visualization
2605
- *
2606
- * @param - an object with vizId as a key
2725
+ * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
2726
+ * Sends data from an Answer or Liveboard visualization to a Google sheet.
2727
+ * @param - an object with `vizId` as a key
2607
2728
  * @example
2608
2729
  * ```js
2609
2730
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
2610
2731
  * '730496d6-6903-4601-937e-2c691821af3c'})
2611
- *
2732
+ * ```
2733
+ * ```js
2612
2734
  * vizEmbed.trigger(HostEvent.SyncToSheets)
2613
2735
  * ```
2614
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2736
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2615
2737
  */
2616
2738
  SyncToSheets = "sync-to-sheets",
2617
2739
  /**
2618
- * Triggers the SyncToOtherApps action on visualization
2619
- *
2740
+ * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
2741
+ * Sends data from an Answer or Liveboard visualization to third-party apps such
2742
+ * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
2620
2743
  * @param - an object with vizId as a key
2621
2744
  * @example
2622
2745
  * ```js
2623
2746
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
2624
2747
  * '730496d6-6903-4601-937e-2c691821af3c'})
2625
- *
2748
+ * ```
2749
+ * ```js
2626
2750
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
2627
2751
  * ```
2628
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2752
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2629
2753
  */
2630
2754
  SyncToOtherApps = "sync-to-other-apps",
2631
2755
  /**
2632
- * Triggers the ManagePipelines action on visualization
2633
- *
2634
- * @param - an object with vizId as a key
2756
+ * Triggers the **Manage pipelines** action on an embedded
2757
+ * visualization or Answer.
2758
+ * Allows users to manage ThoughtSpot Sync pipelines.
2759
+ * @param - an object with `vizId` as a key
2635
2760
  * @example
2636
2761
  * ```js
2637
2762
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
2638
2763
  * '730496d6-6903-4601-937e-2c691821af3c'})
2639
- *
2764
+ * ```
2765
+ * ```js
2640
2766
  * vizEmbed.trigger(HostEvent.ManagePipelines)
2641
2767
  * ```
2642
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2768
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2643
2769
  */
2644
2770
  ManagePipelines = "manage-pipeline",
2645
2771
  /**
2646
- * Triggers the Reset search in answer
2772
+ * Triggers the Reset search on the Search page
2647
2773
  *
2648
2774
  * @example
2649
2775
  * ```js
2650
2776
  * searchEmbed.trigger(HostEvent.ResetSearch)
2651
2777
  * ```
2652
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
2778
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
2779
+ */
2780
+ ResetSearch = "resetSearch",
2781
+ /**
2782
+ * Gets the currents visible and runtime filters applied on a Liveboard
2783
+ *
2784
+ * @example
2785
+ * liveboardEmbed.trigger(HostEvent.GetFilters)
2786
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2653
2787
  */
2654
- ResetSearch = "resetSearch"
2788
+ GetFilters = "getFilters",
2789
+ /**
2790
+ * Updates the visible filters on the Liveboard.
2791
+ *
2792
+ * @param - filter: filter object containing column name and filter operation and values
2793
+ * @example
2794
+ *
2795
+ * ```js
2796
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
2797
+ * filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
2798
+ * })
2799
+ * ```
2800
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2801
+ */
2802
+ UpdateFilters = "updateFilters",
2803
+ GetTabs = "getTabs",
2804
+ /**
2805
+ * Set the visible Tabs on a Liveboard.
2806
+ *
2807
+ * @param - an array of ids of Tabs to show, the ids not passed
2808
+ * will be hidden.
2809
+ * @example
2810
+ * ```js
2811
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
2812
+ * '430496d6-6903-4601-937e-2c691821af3c',
2813
+ * 'f547ec54-2a37-4516-a222-2b06719af726'])
2814
+ * ```
2815
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2816
+ */
2817
+ SetVisibleTabs = "SetPinboardVisibleTabs",
2818
+ /**
2819
+ * Set the hidden tabs on a Liveboard.
2820
+ *
2821
+ * @param - an array of ids of Tabs to hide, the ids not passed
2822
+ * will be shown.
2823
+ * @example
2824
+ * ```js
2825
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
2826
+ * '630496d6-6903-4601-937e-2c691821af3c',
2827
+ * 'i547ec54-2a37-4516-a222-2b06719af726'])
2828
+ * ```
2829
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2830
+ */
2831
+ SetHiddenTabs = "SetPinboardHiddenTabs"
2655
2832
  }
2656
2833
  /**
2657
2834
  * The different visual modes that the data sources panel within
@@ -2725,26 +2902,50 @@ export declare enum Param {
2725
2902
  HideWorksheetSelector = "hideWorksheetSelector",
2726
2903
  DisableWorksheetChange = "disableWorksheetChange",
2727
2904
  HideEurekaResults = "hideEurekaResults",
2728
- HideEurekaSuggestions = "hideEurekaSuggestions"
2905
+ HideEurekaSuggestions = "hideEurekaSuggestions",
2906
+ HideLiveboardHeader = "hideLiveboardHeader",
2907
+ ShowLiveboardDescription = "showLiveboardDescription",
2908
+ ShowLiveboardTitle = "showLiveboardTitle",
2909
+ HiddenTabs = "hideTabs",
2910
+ VisibleTabs = "visibleTabs",
2911
+ HideTabPanel = "hideTabPanel"
2729
2912
  }
2730
2913
  /**
2731
- * The list of actions that can be performed on visual ThoughtSpot
2732
- * entities, such as answers and Liveboards.
2733
- *
2734
- * This enum is used to specify the actions that could be disabled,
2735
- * hidden or made visible.
2736
- *
2914
+ * ThoughtSpot application pages include actions and menu commands
2915
+ * for various user-initiated operations. These actions are represented
2916
+ * as enumeration members in the SDK. To show, hide, or disable
2917
+ * specific actions in the embedded view, define the Action
2918
+ * enumeration members in the `disabledActions`, `visibleActions`,
2919
+ * or `hiddenActions` array.
2737
2920
  * @example
2738
2921
  * ```js
2739
2922
  * const embed = new LiveboardEmbed('#embed-container', {
2740
2923
  * ... // other options
2741
- * visibleActions: [Action.Save, Action.Explore],
2742
- * disableActions: [Action.Save],
2743
- * hiddenActions: [Action.Download], // Set either this or visibleActions
2924
+ * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
2925
+ * disabledActions: [Action.Download],
2926
+ * //hiddenActions: [], // Set either this or visibleActions
2744
2927
  * })
2745
2928
  * ```
2929
+ * @example
2930
+ * ```js
2931
+ * const embed = new LiveboardEmbed('#embed-container', {
2932
+ * ... // other options
2933
+ * //visibleActions: [],
2934
+ * disabledActions: [Action.Download],
2935
+ * hiddenActions: [Action.Edit, ActionAction.Explore],
2936
+ * })
2937
+ * ```
2938
+
2746
2939
  */
2747
2940
  export declare enum Action {
2941
+ /**
2942
+ * The **Save** action on an Answer or Liveboard.
2943
+ * Allows users to save the changes.
2944
+ * @example
2945
+ * ```js
2946
+ * disabledActions: [Action.SaveAsView]
2947
+ * ```
2948
+ */
2748
2949
  Save = "save",
2749
2950
  /**
2750
2951
  * @hidden
@@ -2754,27 +2955,137 @@ export declare enum Action {
2754
2955
  * @hidden
2755
2956
  */
2756
2957
  SaveUntitled = "saveUntitled",
2958
+ /**
2959
+ * The **Save as View** action on the Answer
2960
+ * page. Saves an Answer as a View object.
2961
+ *
2962
+ * @example
2963
+ * ```js
2964
+ * disabledActions: [Action.SaveAsView]
2965
+ * ```
2966
+ */
2757
2967
  SaveAsView = "saveAsView",
2968
+ /**
2969
+ * The **Make a copy** action on a Liveboard or Answer
2970
+ * page.
2971
+ * Creates a copy of the Liveboard, visualization,
2972
+ * or Answer.
2973
+ *
2974
+ * @example
2975
+ * ```js
2976
+ * disabledActions: [Action.MakeACopy]
2977
+ * ```
2978
+ */
2758
2979
  MakeACopy = "makeACopy",
2980
+ /**
2981
+ * The **Copy and Edit** action on a Liveboard.
2982
+ * This action is now replaced with `Action.MakeACopy`.
2983
+ *
2984
+ * @example
2985
+ * ```js
2986
+ * disabledActions: [Action.EditACopy]
2987
+ * ```
2988
+ */
2759
2989
  EditACopy = "editACopy",
2990
+ /**
2991
+ * The **Copy link** menu action on a Liveboard visualization.
2992
+ * Copies the visualization URL
2993
+ * @example
2994
+ * ```js
2995
+ * disabledActions: [Action.CopyLink]
2996
+ * ```
2997
+ */
2760
2998
  CopyLink = "embedDocument",
2761
2999
  /**
2762
3000
  * @hidden
2763
3001
  */
2764
3002
  ResetLayout = "resetLayout",
3003
+ /**
3004
+ * The **Schedule** menu action on a Liveboard.
3005
+ * Allows scheduling a Liveboard notification.
3006
+ * @example
3007
+ * ```js
3008
+ * disabledActions: [Action.Schedule]
3009
+ * ```
3010
+ */
2765
3011
  Schedule = "subscription",
3012
+ /**
3013
+ * The **Manage schedules** menu action on a Liveboard.
3014
+ * Allows users to manage scheduled Liveboard jobs.
3015
+ * @example
3016
+ * ```js
3017
+ * disabledActions: [Action.SchedulesList]
3018
+ * ```
3019
+ */
2766
3020
  SchedulesList = "schedule-list",
3021
+ /**
3022
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
3023
+ * Allows users to share an object with other users and groups.
3024
+ * @example
3025
+ * ```js
3026
+ * disabledActions: [Action.Share]
3027
+ * ```
3028
+ */
2767
3029
  Share = "share",
3030
+ /**
3031
+ * The **Add filter** action on a Liveboard and Search page.
3032
+ * Allows adding filters to Answers and visualizations on a Liveboard.
3033
+ * @example
3034
+ * ```js
3035
+ * disabledActions: [Action.AddFilter]
3036
+ * ```
3037
+ */
2768
3038
  AddFilter = "addFilter",
3039
+ /**
3040
+ * Filter configuration options on a Liveboard and Search page.
3041
+ * Allows configuring filter options when adding filters to a
3042
+ * Liveboard or Answer.
3043
+ * @example
3044
+ * ```js
3045
+ * disabledActions: [Action.ConfigureFilter]
3046
+ * ```
3047
+ */
2769
3048
  ConfigureFilter = "configureFilter",
2770
3049
  CollapseDataSources = "collapseDataSources",
3050
+ /**
3051
+ * The **Choose sources** button on Search page.
3052
+ * Allows selecting data sources for search queries.
3053
+ * @example
3054
+ * ```js
3055
+ * disabledActions: [Action.ChooseDataSources]
3056
+ * ```
3057
+ */
2771
3058
  ChooseDataSources = "chooseDataSources",
3059
+ /**
3060
+ * The **Create formula** action on a Search or Answer page.
3061
+ * Allows adding formulas to an Answer.
3062
+ * @example
3063
+ * ```js
3064
+ * disabledActions: [Action.AddFormula]
3065
+ * ```
3066
+ */
2772
3067
  AddFormula = "addFormula",
3068
+ /**
3069
+ * The **Add parameter** action on a Liveboard or Answer.
3070
+ * Allows adding Parameters to a Liveboard or Answer.
3071
+ * @example
3072
+ * ```js
3073
+ * disabledActions: [Action.AddParameter]
3074
+ * ```
3075
+ */
2773
3076
  AddParameter = "addParameter",
2774
3077
  /**
2775
3078
  * @hidden
2776
3079
  */
2777
3080
  SearchOnTop = "searchOnTop",
3081
+ /**
3082
+ * The **SpotIQ analyze** menu action on a visualization or
3083
+ * Answer page.
3084
+ * @example
3085
+ * ```js
3086
+ * disabledActions: [Action.SpotIQAnalyze]
3087
+ * ```
3088
+ */
2778
3089
  SpotIQAnalyze = "spotIQAnalyze",
2779
3090
  /**
2780
3091
  * @hidden
@@ -2789,24 +3100,150 @@ export declare enum Action {
2789
3100
  * @hidden
2790
3101
  */
2791
3102
  ReplaySearch = "replaySearch",
3103
+ /**
3104
+ * The **Show underlying data** menu action on a visualization or
3105
+ * Answer page.
3106
+ * @example
3107
+ * ```js
3108
+ * disabledActions: [Action.ShowUnderlyingData]
3109
+ * ```
3110
+ */
2792
3111
  ShowUnderlyingData = "showUnderlyingData",
3112
+ /**
3113
+ * The **Download** menu action on Liveboard visualizations
3114
+ * and Answers.
3115
+ * Allows downloading a visualization or Answer.
3116
+ * @example
3117
+ * ```js
3118
+ * disabledActions: [Action.DownloadAsPng]
3119
+ * ```
3120
+ */
2793
3121
  Download = "download",
3122
+ /**
3123
+ * The **Download** > **PNG** menu action for charts on a Liveboard
3124
+ * or Answer page.
3125
+ * Downloads a visualization or Answer as a PNG file.
3126
+ * @example
3127
+ * ```js
3128
+ * disabledActions: [Action.DownloadAsPng]
3129
+ * ```
3130
+ */
2794
3131
  DownloadAsPng = "downloadAsPng",
3132
+ /**
3133
+ * The **Download** > **PDF** menu action on a Liveboard.
3134
+ * Downloads a visualization or Answer as a PDF file.
3135
+ * @example
3136
+ * ```js
3137
+ * disabledActions: [Action.DownloadAsPdf]
3138
+ * ```
3139
+ */
2795
3140
  DownloadAsPdf = "downloadAsPdf",
3141
+ /**
3142
+ * The **Download** > **CSV** menu action for tables on a Liveboard
3143
+ * or Answer page.
3144
+ * Downloads a visualization or Answer in the XLSX format.
3145
+ * @example
3146
+ * ```js
3147
+ * disabledActions: [Action.DownloadAsCsv]
3148
+ * ```
3149
+ */
2796
3150
  DownloadAsCsv = "downloadAsCSV",
3151
+ /**
3152
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
3153
+ * or Answer page.
3154
+ * Downloads a visualization or Answer in the XLSX format.
3155
+ * @example
3156
+ * ```js
3157
+ * disabledActions: [Action.DownloadAsXlsx]
3158
+ * ```
3159
+ */
2797
3160
  DownloadAsXlsx = "downloadAsXLSX",
2798
3161
  /**
2799
3162
  * @hidden
2800
3163
  */
2801
3164
  DownloadTrace = "downloadTrace",
3165
+ /**
3166
+ * The **Export TML** menu action on Liveboard, Answers
3167
+ * Worksheets and Data Connections page.
3168
+ * Exports an object as a TML file.
3169
+ * @example
3170
+ * ```js
3171
+ * disabledActions: [Action.ExportTML]
3172
+ * ```
3173
+ */
2802
3174
  ExportTML = "exportTSL",
3175
+ /**
3176
+ * The **Import TML** menu action for Liveboards and Answers.
3177
+ * Imports TML representation of ThoughtSpot objects.
3178
+ * @example
3179
+ * ```js
3180
+ * disabledActions: [Action.ImportTML]
3181
+ * ```
3182
+ */
2803
3183
  ImportTML = "importTSL",
3184
+ /**
3185
+ * The **Update TML** menu action for Liveboards and Answers.
3186
+ * Update TML representation of ThoughtSpot objects.
3187
+ * @example
3188
+ * ```js
3189
+ * disabledActions: [Action.UpdateTML]
3190
+ * ```
3191
+ */
2804
3192
  UpdateTML = "updateTSL",
3193
+ /**
3194
+ * The **Edit TML** menu action for Liveboards and Answers.
3195
+ * Opens the TML editor.
3196
+ * @example
3197
+ * ```js
3198
+ * disabledActions: [Action.EditTML]
3199
+ * ```
3200
+ */
2805
3201
  EditTML = "editTSL",
3202
+ /**
3203
+ * The **Present** menu action for Liveboards and Answers.
3204
+ * Allows presenting a Liveboard or visualization in
3205
+ * slideshow mode.
3206
+ * @example
3207
+ * ```js
3208
+ * disabledActions: [Action.Present]
3209
+ * ```
3210
+ */
2806
3211
  Present = "present",
3212
+ /**
3213
+ * The tile resize options in the visualization menu.
3214
+ * Allows switching between different preset layouts.
3215
+ * @example
3216
+ * ```js
3217
+ * disabledActions: [Action.ToggleSize]
3218
+ * ```
3219
+ */
2807
3220
  ToggleSize = "toggleSize",
3221
+ /**
3222
+ * The *Edit* action on the Liveboard page and in the
3223
+ * visualization menu.
3224
+ * Opens a Liveboard or visualization in edit mode.
3225
+ * @example
3226
+ * ```js
3227
+ * disabledActions: [Action.Edit]
3228
+ * ```
3229
+ */
2808
3230
  Edit = "edit",
3231
+ /**
3232
+ * The text edit option for Liveboard and visualization titles.
3233
+ * @example
3234
+ * ```js
3235
+ * disabledActions: [Action.EditTitle]
3236
+ * ```
3237
+ */
2809
3238
  EditTitle = "editTitle",
3239
+ /**
3240
+ * The **Delete** menu action on Liveboards and visualizations.
3241
+ * Deletes a Liveboard or a visualization from a Liveboard.
3242
+ * @example
3243
+ * ```js
3244
+ * disabledActions: [Action.Remove]
3245
+ * ```
3246
+ */
2810
3247
  Remove = "delete",
2811
3248
  /**
2812
3249
  * @hidden
@@ -2828,6 +3265,16 @@ export declare enum Action {
2828
3265
  * @hidden
2829
3266
  */
2830
3267
  PinboardInfo = "pinboardInfo",
3268
+ /**
3269
+ * The **Show Liveboard details** menu action on a Liveboard.
3270
+ * Displays details such as the name, description, and
3271
+ * author of the Liveboard, and timestamp of Liveboard creation
3272
+ * and update.
3273
+ * @example
3274
+ * ```js
3275
+ * disabledActions: [Action.LiveboardInfo]
3276
+ * ```
3277
+ */
2831
3278
  LiveboardInfo = "pinboardInfo",
2832
3279
  /**
2833
3280
  * @hidden
@@ -2838,20 +3285,61 @@ export declare enum Action {
2838
3285
  */
2839
3286
  DownloadEmbraceQueries = "downloadEmbraceQueries",
2840
3287
  /**
2841
- * Pin action.
2842
- */
3288
+ * The **Pin** menu action on an Answer or
3289
+ * Search results page.
3290
+ * @example
3291
+ * ```js
3292
+ * disabledActions: [Action.Pin]
3293
+ * ```
3294
+ */
2843
3295
  Pin = "pin",
2844
3296
  /**
2845
3297
  * @hidden
2846
3298
  */
2847
3299
  AnalysisInfo = "analysisInfo",
2848
- Subscription = "subscription",
2849
3300
  /**
2850
- * Explore action.
3301
+ * The **Schedule** menu action on a Liveboard.
3302
+ * @example
3303
+ * ```js
3304
+ * disabledActions: [Action.Subscription]
3305
+ * ```
2851
3306
  */
3307
+ Subscription = "subscription",
3308
+ /**
3309
+ * The **Explore** action on Liveboard visualizations
3310
+ * @example
3311
+ * ```js
3312
+ * disabledActions: [Action.Explore]
3313
+ * ```
3314
+ */
2852
3315
  Explore = "explore",
3316
+ /**
3317
+ * The action to include data points on a drilled-down Answer
3318
+ * or visualization
3319
+ * @example
3320
+ * ```js
3321
+ * disabledActions: [Action.DrillInclude]
3322
+ * ```
3323
+ */
2853
3324
  DrillInclude = "context-menu-item-include",
3325
+ /**
3326
+ * The action to exclude data points on a drilled-down Answer
3327
+ * or visualization
3328
+ * @example
3329
+ * ```js
3330
+ * disabledActions: [Action.DrillInclude]
3331
+ * ```
3332
+ */
2854
3333
  DrillExclude = "context-menu-item-exclude",
3334
+ /**
3335
+ * The **Copy to clipboard** menu action on tables in an Answer
3336
+ * or Liveboard.
3337
+ * Copies the selected data point.
3338
+ * @example
3339
+ * ```js
3340
+ * disabledActions: [Action.CopyToClipboard]
3341
+ * ```
3342
+ */
2855
3343
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
2856
3344
  CopyAndEdit = "context-menu-item-copy-and-edit",
2857
3345
  /**
@@ -2860,89 +3348,266 @@ export declare enum Action {
2860
3348
  DrillEdit = "context-menu-item-edit",
2861
3349
  EditMeasure = "context-menu-item-edit-measure",
2862
3350
  Separator = "context-menu-item-separator",
3351
+ /**
3352
+ * The **Drill down** menu action on Answers and Liveboard
3353
+ * visualizations.
3354
+ * Allows drilling down to a specific data point on a chart or table.
3355
+ * @example
3356
+ * ```js
3357
+ * disabledActions: [Action.DrillDown]
3358
+ * ```
3359
+ */
2863
3360
  DrillDown = "DRILL",
3361
+ /**
3362
+ * The request access action on Liveboards.
3363
+ * Allows users with view permissions to request edit access to a Liveboard.
3364
+ * @example
3365
+ * ```js
3366
+ * disabledActions: [Action.RequestAccess]
3367
+ * ```
3368
+ */
2864
3369
  RequestAccess = "requestAccess",
2865
- QueryDetailsButtons = "queryDetailsButtons",
2866
3370
  /**
2867
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3371
+ * The **Query visualizer** and **Query SQL** buttons in Query details panel
3372
+ * of the Answer page
3373
+ * @example
3374
+ * ```js
3375
+ * disabledActions: [Action.QueryDetailsButtons]
3376
+ * ```
3377
+ */
3378
+ QueryDetailsButtons = "QueryDetailsButtons",
3379
+ /**
3380
+ * The **Delete** action for Answers.
3381
+ * @example
3382
+ * ```js
3383
+ * disabledActions: [Action.AnswerDelete]
3384
+ * ```
3385
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2868
3386
  */
2869
3387
  AnswerDelete = "onDeleteAnswer",
2870
3388
  /**
2871
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3389
+ * The Chart switcher icon on Answer and visualization pages.
3390
+ * @example
3391
+ * ```js
3392
+ * disabledActions: [Action.AnswerChartSwitcher]
3393
+ * ```
3394
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2872
3395
  */
2873
3396
  AnswerChartSwitcher = "answerChartSwitcher",
2874
3397
  /**
2875
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3398
+ * Favorites icon (*) on Answers, Liveboard, and Data pages
3399
+ * @example
3400
+ * ```js
3401
+ * disabledActions: [Action.AddToFavorites]
3402
+ * ```
3403
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2876
3404
  */
2877
3405
  AddToFavorites = "addToFavorites",
2878
3406
  /**
2879
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3407
+ * The edit icon on Liveboards (Classic experience).
3408
+ * @example
3409
+ * ```js
3410
+ * disabledActions: [Action.EditDetails]
3411
+ * ```
3412
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2880
3413
  */
2881
3414
  EditDetails = "editDetails",
2882
3415
  /**
2883
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
3416
+ * The Create alert action on KPI charts.
3417
+ * @example
3418
+ * ```js
3419
+ * disabledActions: [Action.CreateMonitor ]
3420
+ * ```
3421
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2884
3422
  */
2885
3423
  CreateMonitor = "createMonitor",
2886
3424
  /**
2887
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
3425
+ * @example
3426
+ * ```js
3427
+ * disabledActions: [Action.ReportError]
3428
+ * ```
3429
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2888
3430
  */
2889
3431
  ReportError = "reportError",
3432
+ /**
3433
+ * The **Sync to sheets** action on Answers and Liveboard visualizations.
3434
+ * Allows sending data to a Google Sheet.
3435
+ * @example
3436
+ * ```js
3437
+ * disabledActions: [Action.SyncToSheets]
3438
+ * ```
3439
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3440
+ */
2890
3441
  SyncToSheets = "sync-to-sheets",
3442
+ /**
3443
+ * The **Sync to other apps** action on Answers and Liveboard visualizations.
3444
+ * Allows sending data to third-party apps like Slack, Salesforce,
3445
+ * Microsoft Teams, and so on.
3446
+ * @example
3447
+ * ```js
3448
+ * disabledActions: [Action.SyncToOtherApps]
3449
+ * ```
3450
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3451
+ */
2891
3452
  SyncToOtherApps = "sync-to-other-apps",
3453
+ /**
3454
+ * The **Manage pipelines** action on Answers and Liveboard visualizations.
3455
+ * Allows users to manage data sync pipelines to third-party apps.
3456
+ * @example
3457
+ * ```js
3458
+ * disabledActions: [Action.SyncToOtherApps]
3459
+ * ```
3460
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3461
+ */
2892
3462
  ManagePipelines = "manage-pipeline",
2893
3463
  /**
3464
+ * The **Filter** action on Liveboard visualizations.
3465
+ * Allows users to apply cross-filters on a Liveboard.
3466
+ * @example
3467
+ * ```js
3468
+ * disabledActions: [Action.CrossFilter]
3469
+ * ```
2894
3470
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2895
3471
  */
2896
3472
  CrossFilter = "context-menu-item-cross-filter",
2897
3473
  /**
3474
+ * The **Remove** action that appears when cross filters are applied
3475
+ * on a Liveboard.
3476
+ * Removes filters applied o a visualization.
3477
+ * @example
3478
+ * ```js
3479
+ * disabledActions: [Action.RemoveCrossFilter]
3480
+ * ```
2898
3481
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2899
3482
  */
2900
3483
  RemoveCrossFilter = "context-menu-item-remove-cross-filter",
2901
3484
  /**
3485
+ * The **Aggregate** option in the chart axis or the
3486
+ * table column customization menu.
3487
+ * Provides aggregation options to analyze the data on a chart or table.
3488
+ * @example
3489
+ * ```js
3490
+ * disabledActions: [Action.AxisMenuAggregate]
3491
+ * ```
2902
3492
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2903
3493
  */
2904
3494
  AxisMenuAggregate = "axisMenuAggregate",
2905
3495
  /**
3496
+ * The **Time bucket** option in the chart axis or table column
3497
+ * customization menu.
3498
+ * Allows defining time metric for date comparison.
3499
+ * @example
3500
+ * ```js
3501
+ * disabledActions: [Action.AxisMenuTimeBucket]
3502
+ * ```
2906
3503
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2907
3504
  */
2908
3505
  AxisMenuTimeBucket = "axisMenuTimeBucket",
2909
3506
  /**
3507
+ * The **Filter** action in the chart axis or table column
3508
+ * customization menu.
3509
+ * @example
3510
+ * ```js
3511
+ * disabledActions: [Action.AxisMenuFilter]
3512
+ * ```
2910
3513
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2911
3514
  */
2912
3515
  AxisMenuFilter = "axisMenuFilter",
2913
3516
  /**
3517
+ * The **Conditional formatting** action on chart or table.
3518
+ * Allows adding rules for conditional formatting of data
3519
+ * points on a chart or table.
3520
+ * @example
3521
+ * ```js
3522
+ * disabledActions: [Action.AxisMenuConditionalFormat]
3523
+ * ```
2914
3524
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2915
3525
  */
2916
3526
  AxisMenuConditionalFormat = "axisMenuConditionalFormat",
2917
3527
  /**
3528
+ * The **Sort** menu action on a table or chart axis
3529
+ * Sorts data in ascending or descending order.
3530
+ * Allows adding, editing, or removing filters.
3531
+ * @example
3532
+ * ```js
3533
+ * disabledActions: [Action.AxisMenuConditionalFormat]
3534
+ * ```
2918
3535
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2919
3536
  */
2920
3537
  AxisMenuSort = "axisMenuSort",
2921
3538
  /**
3539
+ * The **Group** option in the chart axis or table column
3540
+ * customization menu.
3541
+ * Allows grouping data points if the axes use the same
3542
+ * unit of measurement and a similar scale.
3543
+ * @example
3544
+ * ```js
3545
+ * disabledActions: [Action.AxisMenuGroup]
3546
+ * ```
2922
3547
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2923
3548
  */
2924
3549
  AxisMenuGroup = "axisMenuGroup",
2925
3550
  /**
3551
+ * The **Position** option in the axis customization menu.
3552
+ * Allows changing the position of the axis to the
3553
+ * left or right side of the chart.
3554
+ * @example
3555
+ * ```js
3556
+ * disabledActions: [Action.AxisMenuPosition]
3557
+ * ```
2926
3558
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2927
3559
  */
2928
3560
  AxisMenuPosition = "axisMenuPosition",
2929
3561
  /**
3562
+ * The **Rename** option in the chart axis or table column customization menu.
3563
+ * Renames the axis label on a chart or the column header on a table.
3564
+ * @example
3565
+ * ```js
3566
+ * disabledActions: [Action.AxisMenuRename]
3567
+ * ```
2930
3568
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2931
3569
  */
2932
3570
  AxisMenuRename = "axisMenuRename",
2933
3571
  /**
3572
+ * The **Edit** action in the axis customization menu.
3573
+ * Allows editing the axis name, position, minimum and maximum values,
3574
+ * and format of a column.
3575
+ * @example
3576
+ * ```js
3577
+ * disabledActions: [Action.AxisMenuEdit]
3578
+ * ```
2934
3579
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2935
3580
  */
2936
3581
  AxisMenuEdit = "axisMenuEdit",
2937
3582
  /**
3583
+ * The **Number format** action to customize the format of
3584
+ * the data labels on a chart or table.
3585
+ * @example
3586
+ * ```js
3587
+ * disabledActions: [Action.AxisMenuNumberFormat]
3588
+ * ```
2938
3589
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2939
3590
  */
2940
3591
  AxisMenuNumberFormat = "axisMenuNumberFormat",
2941
3592
  /**
3593
+ * The **Text wrapping** action on a table.
3594
+ * Wraps or clips column text on a table.
3595
+ * @example
3596
+ * ```js
3597
+ * disabledActions: [Action.AxisMenuTextWrapping]
3598
+ * ```
2942
3599
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2943
3600
  */
2944
3601
  AxisMenuTextWrapping = "axisMenuTextWrapping",
2945
3602
  /**
3603
+ * The **Remove** action in the chart axis or table column
3604
+ * customization menu.
3605
+ * Removes the data labels from a chart or the column of a
3606
+ * table visualization.
3607
+ * @example
3608
+ * ```js
3609
+ * disabledActions: [Action.AxisMenuRemove]
3610
+ * ```
2946
3611
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2947
3612
  */
2948
3613
  AxisMenuRemove = "axisMenuRemove",
@@ -2951,9 +3616,31 @@ export declare enum Action {
2951
3616
  */
2952
3617
  InsertInToSlide = "insertInToSlide",
2953
3618
  /**
3619
+ * The **Rename** menu action on Liveboards and visualizations.
3620
+ * Allows renaming a Liveboard or visualization.
3621
+ * @example
3622
+ * ```js
3623
+ * disabledActions: [Action.RenameModalTitleDescription]
3624
+ * ```
2954
3625
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2955
3626
  */
2956
- RenameModalTitleDescription = "renameModalTitleDescription"
3627
+ RenameModalTitleDescription = "renameModalTitleDescription",
3628
+ /**
3629
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3630
+ */
3631
+ RequestVerification = "requestVerification",
3632
+ /**
3633
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3634
+ */
3635
+ MarkAsVerified = "markAsVerified",
3636
+ /**
3637
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3638
+ */
3639
+ AddTab = "addTab",
3640
+ /**
3641
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3642
+ */
3643
+ EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
2957
3644
  }
2958
3645
  export interface SessionInterface {
2959
3646
  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
  */