@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
@@ -348,6 +348,12 @@ export interface LiveboardViewConfig extends ViewConfig {
348
348
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
349
349
  */
350
350
  activeTabId?: string;
351
+ /**
352
+ * Hide tab Panel of embedded LB
353
+ *
354
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
355
+ */
356
+ hideTabPanel?: boolean;
351
357
  }
352
358
  /**
353
359
  * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -895,7 +901,7 @@ export enum AuthType {
895
901
  * .then((data) => data.token);
896
902
  * }
897
903
  * ```
898
- * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
904
+ * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
899
905
  */
900
906
  TrustedAuthTokenCookieless = "AuthServerCookieless",
901
907
  /**
@@ -1066,7 +1072,7 @@ export interface EmbedConfig {
1066
1072
  *
1067
1073
  * Eg: "/dashboard", "#/foo" [Do not include the host]
1068
1074
  *
1069
- * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1-sw
1075
+ * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
1070
1076
  */
1071
1077
  redirectPath?: string;
1072
1078
  /** @internal */
@@ -1108,14 +1114,14 @@ export interface EmbedConfig {
1108
1114
  * This flag is typically used alongside the combination of auth modes such as {@link
1109
1115
  * AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
1110
1116
  *
1111
- * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1117
+ * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1112
1118
  * @default false
1113
1119
  */
1114
1120
  disableLoginRedirect?: boolean;
1115
1121
  /**
1116
1122
  * This message is displayed on the embed view when the login fails.
1117
1123
  *
1118
- * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1124
+ * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1119
1125
  */
1120
1126
  loginFailedMessage?: string;
1121
1127
  /**
@@ -1137,7 +1143,7 @@ export interface EmbedConfig {
1137
1143
  * Dynamic CSS Url to be injected in the loaded application.
1138
1144
  * You would also need to set `style-src` in the CSP settings.
1139
1145
  *
1140
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1146
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1141
1147
  * @default ''
1142
1148
  */
1143
1149
  customCssUrl?: string;
@@ -1149,13 +1155,13 @@ export interface EmbedConfig {
1149
1155
  * This is slightly slower than letting the browser handle the cookie check, as it
1150
1156
  * involves an extra network call.
1151
1157
  *
1152
- * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1158
+ * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1153
1159
  */
1154
1160
  detectCookieAccessSlow?: boolean;
1155
1161
  /**
1156
1162
  * Hide beta alert warning message for SearchEmbed.
1157
1163
  *
1158
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw*
1164
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
1159
1165
  */
1160
1166
  suppressSearchEmbedBetaWarning?: boolean;
1161
1167
  /**
@@ -1203,7 +1209,7 @@ export interface EmbedConfig {
1203
1209
  * Disable Full App access of Embedded app outside of the iFrame.
1204
1210
  *
1205
1211
  * @default true
1206
- * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1-sw
1212
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1207
1213
  */
1208
1214
  blockNonEmbedFullAppAccess?: boolean;
1209
1215
  /**
@@ -1306,14 +1312,14 @@ export interface ViewConfig {
1306
1312
  *
1307
1313
  * Use either this or hiddenActions.
1308
1314
  *
1309
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1315
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1310
1316
  * @important
1311
1317
  */
1312
1318
  visibleActions?: Action[];
1313
1319
  /**
1314
1320
  * Show alert messages and toast messages in the embedded view.
1315
1321
  *
1316
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1322
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1317
1323
  */
1318
1324
  showAlerts?: boolean;
1319
1325
  /**
@@ -1324,7 +1330,7 @@ export interface ViewConfig {
1324
1330
  /**
1325
1331
  * The locale/language to use for the embedded view.
1326
1332
  *
1327
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
1333
+ * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1328
1334
  */
1329
1335
  locale?: string;
1330
1336
  /**
@@ -1335,7 +1341,7 @@ export interface ViewConfig {
1335
1341
  * to control embed behavior in non-regular ways. We do not publish the
1336
1342
  * list of supported keys and values associated with each.
1337
1343
  *
1338
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1344
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1339
1345
  */
1340
1346
  additionalFlags?: {
1341
1347
  [key: string]: string | number | boolean;
@@ -1344,7 +1350,7 @@ export interface ViewConfig {
1344
1350
  * Dynamic CSSUrl and customCSS to be injected in the loaded application.
1345
1351
  * You would also need to set `style-src` in the CSP settings.
1346
1352
  *
1347
- * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1-sw, 8.4.0.cl
1353
+ * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
1348
1354
  * @default ''
1349
1355
  */
1350
1356
  customizations?: CustomisationsInterface;
@@ -1389,6 +1395,63 @@ export interface ViewConfig {
1389
1395
  * @hidden
1390
1396
  */
1391
1397
  excludeRuntimeFiltersfromURL?: boolean;
1398
+ /**
1399
+ * Boolean to hide liveboard header
1400
+ *
1401
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1402
+ * @default false
1403
+ */
1404
+ hideLiveboardHeader?: boolean;
1405
+ /**
1406
+ * Boolean to show liveboard title
1407
+ *
1408
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1409
+ * @default false
1410
+ */
1411
+ showLiveboardTitle?: boolean;
1412
+ /**
1413
+ * Boolean to show liveboard description
1414
+ *
1415
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1416
+ * @default false
1417
+ */
1418
+ showLiveboardDescription?: boolean;
1419
+ /**
1420
+ * The list of tab IDs to hide from the embedded.
1421
+ * This Tabs will be hidden from their respective LBs.
1422
+ * Use this to hide an tabID.
1423
+ *
1424
+ * @example
1425
+ * ```js
1426
+ * const embed = new LiveboardEmbed('#embed', {
1427
+ * ... // other liveboard view config
1428
+ * hiddenTabs: [
1429
+ * '430496d6-6903-4601-937e-2c691821af3c',
1430
+ * 'f547ec54-2a37-4516-a222-2b06719af726']
1431
+ * });
1432
+ * ```
1433
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1434
+ */
1435
+ hiddenTabs?: string[];
1436
+ /**
1437
+ * The list of tab IDs to show in the embedded.
1438
+ * Only this Tabs will be shown in their respective LBs.
1439
+ * Use this to show an tabID.
1440
+ *
1441
+ * Use either this or hiddenTabs.
1442
+ *
1443
+ * @example
1444
+ * ```js
1445
+ * const embed = new LiveboardEmbed('#embed', {
1446
+ * ... // other liveboard view config
1447
+ * visibleTabs: [
1448
+ * '430496d6-6903-4601-937e-2c691821af3c',
1449
+ * 'f547ec54-2a37-4516-a222-2b06719af726']
1450
+ * });
1451
+ * ```
1452
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1453
+ */
1454
+ visibleTabs?: string[];
1392
1455
  }
1393
1456
  /**
1394
1457
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1594,7 +1657,7 @@ export enum EmbedEvent {
1594
1657
  * One or more data columns have been selected.
1595
1658
  *
1596
1659
  * @returns columnIds - the list of columns
1597
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1660
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1598
1661
  */
1599
1662
  AddRemoveColumns = "addRemoveColumns",
1600
1663
  /**
@@ -1627,7 +1690,7 @@ export enum EmbedEvent {
1627
1690
  * });
1628
1691
  * ```
1629
1692
  * @return viz, clickedPoint - metadata about point that is clicked
1630
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1693
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1631
1694
  * @important
1632
1695
  */
1633
1696
  VizPointClick = "vizPointClick",
@@ -1677,7 +1740,7 @@ export enum EmbedEvent {
1677
1740
  * Emitted when the "Get Data" button in Search Bar embed
1678
1741
  * is clicked.
1679
1742
  *
1680
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
1743
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
1681
1744
  */
1682
1745
  GetDataClick = "getDataClick",
1683
1746
  /**
@@ -1707,13 +1770,13 @@ export enum EmbedEvent {
1707
1770
  /**
1708
1771
  * Emitted when any modal is opened in the app
1709
1772
  *
1710
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1773
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1711
1774
  */
1712
1775
  DialogOpen = "dialog-open",
1713
1776
  /**
1714
1777
  * Emitted when any modal is closed in the app
1715
1778
  *
1716
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1779
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1717
1780
  */
1718
1781
  DialogClose = "dialog-close",
1719
1782
  /**
@@ -1721,136 +1784,136 @@ export enum EmbedEvent {
1721
1784
  * You can use this event as a hook to trigger
1722
1785
  * other events on the rendered Liveboard.
1723
1786
  *
1724
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1787
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1725
1788
  */
1726
1789
  LiveboardRendered = "PinboardRendered",
1727
1790
  /**
1728
1791
  * This can be used to register an event listener which
1729
1792
  * is triggered on all events.
1730
1793
  *
1731
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1794
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1732
1795
  */
1733
1796
  ALL = "*",
1734
1797
  /**
1735
- * Emitted when answer is saved in the app
1798
+ * Emitted when an Answer is saved in the app
1736
1799
  *
1737
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1800
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1738
1801
  */
1739
1802
  Save = "save",
1740
1803
  /**
1741
1804
  * Emitted when the download action is triggered on an answer
1742
1805
  *
1743
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1806
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1744
1807
  */
1745
1808
  Download = "download",
1746
1809
  /**
1747
1810
  * Emitted when the download action is triggered on an answer
1748
1811
  *
1749
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
1812
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
1750
1813
  */
1751
1814
  DownloadAsPng = "downloadAsPng",
1752
1815
  /**
1753
1816
  * Emitted when the Download as PDF action is triggered on an answer
1754
1817
  *
1755
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1818
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1756
1819
  */
1757
1820
  DownloadAsPdf = "downloadAsPdf",
1758
1821
  /**
1759
1822
  * Emitted when the Download as CSV action is triggered on an answer
1760
1823
  *
1761
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1824
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1762
1825
  */
1763
1826
  DownloadAsCsv = "downloadAsCsv",
1764
1827
  /**
1765
1828
  * Emitted when the Download as XLSX action is triggered on an answer
1766
1829
  *
1767
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1830
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1768
1831
  */
1769
1832
  DownloadAsXlsx = "downloadAsXlsx",
1770
1833
  /**
1771
1834
  * Emitted when an answer is deleted in the app
1772
1835
  *
1773
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1836
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1774
1837
  */
1775
1838
  AnswerDelete = "answerDelete",
1776
1839
  /**
1777
1840
  * Emitted when an answer is pinned to a Liveboard
1778
1841
  *
1779
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1842
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1780
1843
  */
1781
1844
  Pin = "pin",
1782
1845
  /**
1783
1846
  * Emitted when SpotIQ analysis is triggered
1784
1847
  *
1785
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1848
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1786
1849
  */
1787
1850
  SpotIQAnalyze = "spotIQAnalyze",
1788
1851
  /**
1789
1852
  * Emitted when a user shares an object with another user or group
1790
1853
  *
1791
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1854
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1792
1855
  */
1793
1856
  Share = "share",
1794
1857
  /**
1795
1858
  * Emitted when a user clicks the Include action to include a specific value or data
1796
1859
  * on a chart or table
1797
1860
  *
1798
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1861
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1799
1862
  */
1800
1863
  DrillInclude = "context-menu-item-include",
1801
1864
  /**
1802
1865
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
1803
1866
  * on a chart or table
1804
1867
  *
1805
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1868
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1806
1869
  */
1807
1870
  DrillExclude = "context-menu-item-exclude",
1808
1871
  /**
1809
1872
  * Emitted when copied column value on the app
1810
1873
  *
1811
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1874
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1812
1875
  */
1813
1876
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
1814
1877
  /**
1815
1878
  * Emitted when a user clicks the Update TML action
1816
1879
  *
1817
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1880
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1818
1881
  */
1819
1882
  UpdateTML = "updateTSL",
1820
1883
  /**
1821
1884
  * Emitted when a user clicks the Edit TML action
1822
1885
  *
1823
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1886
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1824
1887
  */
1825
1888
  EditTML = "editTSL",
1826
1889
  /**
1827
1890
  * Emitted when ExportTML trigger in answer on the app
1828
1891
  *
1829
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1892
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1830
1893
  */
1831
1894
  ExportTML = "exportTSL",
1832
1895
  /**
1833
1896
  * Emitted when an answer is saved as a view
1834
1897
  *
1835
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1898
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1836
1899
  */
1837
1900
  SaveAsView = "saveAsView",
1838
1901
  /**
1839
1902
  * Emitted when copy of existing answer on the app
1840
1903
  *
1841
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1904
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1842
1905
  */
1843
1906
  CopyAEdit = "copyAEdit",
1844
1907
  /**
1845
1908
  * Emitted when a user clicks Show underlying data on an answe
1846
1909
  *
1847
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1910
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1848
1911
  */
1849
1912
  ShowUnderlyingData = "showUnderlyingData",
1850
1913
  /**
1851
1914
  * Emitted when an answer is switched to a chart or table view
1852
1915
  *
1853
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1916
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1854
1917
  */
1855
1918
  AnswerChartSwitcher = "answerChartSwitcher",
1856
1919
  /**
@@ -1862,67 +1925,67 @@ export enum EmbedEvent {
1862
1925
  /**
1863
1926
  * Emitted when a user clicks Show Liveboard details on a Liveboard
1864
1927
  *
1865
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1928
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1866
1929
  */
1867
1930
  LiveboardInfo = "pinboardInfo",
1868
1931
  /**
1869
1932
  * Emitted when a user clicks on the Favorite icon on a Liveboard
1870
1933
  *
1871
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1934
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1872
1935
  */
1873
1936
  AddToFavorites = "addToFavorites",
1874
1937
  /**
1875
1938
  * Emitted when a user clicks Schedule on a Liveboard
1876
1939
  *
1877
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1940
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1878
1941
  */
1879
1942
  Schedule = "subscription",
1880
1943
  /**
1881
1944
  * Emitted when a user clicks Edit on a Liveboard or visualization
1882
1945
  *
1883
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1946
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1884
1947
  */
1885
1948
  Edit = "edit",
1886
1949
  /**
1887
1950
  * Emitted when a user clicks Make a copy on a Liveboard
1888
1951
  *
1889
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1952
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1890
1953
  */
1891
1954
  MakeACopy = "makeACopy",
1892
1955
  /**
1893
1956
  * Emitted when a user clicks Present on a Liveboard or visualization
1894
1957
  *
1895
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1958
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1896
1959
  */
1897
1960
  Present = "present",
1898
1961
  /**
1899
1962
  * Emitted when a user clicks Delete on a Liveboard
1900
1963
  *
1901
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1964
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1902
1965
  */
1903
1966
  Delete = "delete",
1904
1967
  /**
1905
1968
  * Emitted when a user clicks Manage schedules on a Liveboard
1906
1969
  *
1907
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1970
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1908
1971
  */
1909
1972
  SchedulesList = "schedule-list",
1910
1973
  /**
1911
1974
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
1912
1975
  *
1913
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1976
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1914
1977
  */
1915
1978
  Cancel = "cancel",
1916
1979
  /**
1917
1980
  * Emitted when a user clicks Explore on a visualization
1918
1981
  *
1919
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1982
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1920
1983
  */
1921
1984
  Explore = "explore",
1922
1985
  /**
1923
1986
  * Emitted when a user clicks Copy link action on a visualization
1924
1987
  *
1925
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1988
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1926
1989
  */
1927
1990
  CopyLink = "embedDocument",
1928
1991
  /**
@@ -1942,7 +2005,13 @@ export enum EmbedEvent {
1942
2005
  *
1943
2006
  * @hidden
1944
2007
  */
1945
- InsertIntoSlide = "insertInToSlide"
2008
+ InsertIntoSlide = "insertInToSlide",
2009
+ /**
2010
+ * Emitted when a user changes any filter on a Liveboard.
2011
+ *
2012
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2013
+ */
2014
+ FilterChanged = "filterChanged"
1946
2015
  }
1947
2016
  /**
1948
2017
  * Event types that can be triggered by the host application
@@ -1968,13 +2037,14 @@ export enum EmbedEvent {
1968
2037
  */
1969
2038
  export enum HostEvent {
1970
2039
  /**
1971
- * Trigger a search
1972
- *
2040
+ * Triggers a search query in AppEmbed and SearchEmbed
2041
+ * deployments.
2042
+ * Includes the following properties:
1973
2043
  * @param - dataSourceIds - The data source GUID to Search on
1974
2044
  * - Although an array, only a single source
1975
- * is supported at this time.
1976
- * @param - searchQuery - The search query
1977
- * @param - execute - execute the existing / updated query
2045
+ * is supported.
2046
+ * @param - searchQuery - Query string with search tokens
2047
+ * @param - execute - executes the existing / updated query
1978
2048
  * @example
1979
2049
  * ```js
1980
2050
  * searchEmbed.trigger(HostEvent.Search, {
@@ -1986,13 +2056,13 @@ export enum HostEvent {
1986
2056
  */
1987
2057
  Search = "search",
1988
2058
  /**
1989
- * Trigger a drill on certain points by certain column
1990
- *
2059
+ * Triggers a drill on certain points of the specified column
2060
+ * Includes the following properties:
1991
2061
  * @param - points - an object containing selectedPoints/clickedPoints
1992
- * eg. { selectedPoints: []}
1993
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
1994
- * if not provided it will auto drill by the configured
1995
- * column.
2062
+ * to drill to. For example, { selectedPoints: []}
2063
+ * @param - columnGuid - Optional. GUID of the column to drill
2064
+ * by. If not provided it will auto drill by the configured
2065
+ * column.
1996
2066
  * @example
1997
2067
  * ```js
1998
2068
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -2025,17 +2095,17 @@ export enum HostEvent {
2025
2095
  */
2026
2096
  Reload = "reload",
2027
2097
  /**
2028
- * Set the visible visualizations on a Liveboard.
2098
+ * Sets the visible visualizations on a Liveboard.
2029
2099
  *
2030
- * @param - an array of ids of visualizations to show, the ids not passed
2031
- * will be hidden.
2100
+ * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
2101
+ * in this parameter will be hidden.
2032
2102
  * @example
2033
2103
  * ```js
2034
2104
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
2035
2105
  * '730496d6-6903-4601-937e-2c691821af3c',
2036
2106
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
2037
2107
  * ```
2038
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
2108
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2039
2109
  */
2040
2110
  SetVisibleVizs = "SetPinboardVisibleVizs",
2041
2111
  /**
@@ -2052,9 +2122,18 @@ export enum HostEvent {
2052
2122
  */
2053
2123
  SetActiveTab = "SetActiveTab",
2054
2124
  /**
2055
- * Update the runtime filters. The runtime filters passed here are extended
2056
- * on to the existing runtime filters if they exist.
2057
- *
2125
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
2126
+ * runtime filters passed here are appended to the existing runtime
2127
+ * filters.
2128
+ * Pass an array of runtime filters with the following attributes:
2129
+ * `columnName`
2130
+ * _String_. The name of the column to filter on.
2131
+ * `operator`
2132
+ * Runtime filter operator to apply. For information,
2133
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2134
+ * `values`
2135
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
2136
+ * such as BW and IN accept multiple operands.
2058
2137
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
2059
2138
  * @example
2060
2139
  * ```js
@@ -2063,25 +2142,24 @@ export enum HostEvent {
2063
2142
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
2064
2143
  * ])
2065
2144
  * ```
2066
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2145
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2067
2146
  * @important
2068
2147
  */
2069
2148
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
2070
2149
  /**
2071
- * Navigate to a specific page in App embed without any reload.
2150
+ * Navigate to a specific page in the embedded application without reloading the page.
2072
2151
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
2073
- *
2074
2152
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
2075
2153
  * @example
2076
2154
  * ```js
2077
2155
  * appEmbed.navigateToPage(-1)
2078
2156
  * ```
2079
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
2157
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
2080
2158
  */
2081
2159
  Navigate = "Navigate",
2082
2160
  /**
2083
2161
  * Opens the filter panel for a particular column.
2084
- * Works with Search embed.
2162
+ * Works with Search and Liveboard embed.
2085
2163
  *
2086
2164
  * @param - { columnId: string,
2087
2165
  * name: string,
@@ -2090,233 +2168,257 @@ export enum HostEvent {
2090
2168
  * @example
2091
2169
  * ```js
2092
2170
  * searchEmbed.trigger(HostEvent.OpenFilter,
2093
- * { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
2171
+ * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
2172
+ * LiveboardEmbed.trigger(HostEvent.OpenFilter,
2173
+ * { columnId: '<column-GUID>'})
2094
2174
  * ```
2095
2175
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2096
2176
  */
2097
2177
  OpenFilter = "openFilter",
2098
2178
  /**
2099
- * Adds the columns to the current Search.
2179
+ * Adds columns to the current search query.
2100
2180
  *
2101
2181
  * @param - { columnIds: string[] }
2102
2182
  * @example
2103
2183
  * ```js
2104
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
2184
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
2105
2185
  * ```
2106
2186
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2107
2187
  */
2108
2188
  AddColumns = "addColumns",
2109
2189
  /**
2110
- * Removes a column from the current Search.
2190
+ * Removes a column from the current search query.
2111
2191
  *
2112
2192
  * @param - { columnId: string }
2113
2193
  * @example
2114
2194
  * ```js
2115
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
2195
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
2116
2196
  * ```
2117
2197
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2118
2198
  */
2119
2199
  RemoveColumn = "removeColumn",
2120
2200
  /**
2121
- * Gets the current pinboard content.
2201
+ * Gets the current Liveboard content.
2122
2202
  *
2123
2203
  * @example
2124
2204
  * ```js
2125
2205
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
2126
2206
  * ```
2127
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
2207
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
2128
2208
  */
2129
2209
  getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
2130
2210
  /**
2131
- * Triggers the Pin action on an embedded object
2211
+ * Triggers the **Pin** action on an embedded object
2132
2212
  *
2133
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2134
- * can be left empty for search and visualization embeds
2213
+ * @param - Liveboard embed takes the `vizId` as a
2214
+ * key. Can be left undefined when embedding Search, full app or
2215
+ * a visualization.
2135
2216
  * @example
2136
2217
  * ```js
2137
2218
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2219
+ * ```
2220
+ * ```js
2138
2221
  * vizEmbed.trigger(HostEvent.Pin)
2222
+ * ```
2223
+ * ```js
2139
2224
  * searchEmbed.trigger(HostEvent.Pin)
2140
2225
  * ```
2141
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2226
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2142
2227
  */
2143
2228
  Pin = "pin",
2144
2229
  /**
2145
- * Triggers the Show Liveboard details action on a Liveboard
2230
+ * Triggers the **Show Liveboard details** action on a Liveboard
2146
2231
  *
2147
2232
  * @example
2148
2233
  * ```js
2149
2234
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
2150
2235
  * ```
2151
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2236
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2152
2237
  */
2153
2238
  LiveboardInfo = "pinboardInfo",
2154
2239
  /**
2155
- * Triggers the Schedule action on a Liveboard
2240
+ * Triggers the **Schedule** action on a Liveboard
2156
2241
  *
2157
2242
  * @example
2158
2243
  * ```js
2159
2244
  * liveboardEmbed.trigger(HostEvent.Schedule)
2160
2245
  * ```
2161
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2246
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2162
2247
  */
2163
2248
  Schedule = "subscription",
2164
2249
  /**
2165
- * Triggers the Manage schedule action on a Liveboard
2250
+ * Triggers the **Manage schedule** action on a Liveboard
2166
2251
  *
2167
2252
  * @example
2168
2253
  * ```js
2169
2254
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
2170
2255
  * ```
2171
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2256
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2172
2257
  */
2173
2258
  SchedulesList = "schedule-list",
2174
2259
  /**
2175
- * Triggers the Export TML action on a Liveboard
2260
+ * Triggers the **Export TML** action on a Liveboard
2176
2261
  *
2177
2262
  * @example
2178
2263
  * ```js
2179
2264
  * liveboardEmbed.trigger(HostEvent.ExportTML)
2180
2265
  * ```
2181
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2266
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2182
2267
  */
2183
2268
  ExportTML = "exportTSL",
2184
2269
  /**
2185
- * Triggers the Edit TML action on a Liveboard
2270
+ * Triggers the **Edit TML** action on a Liveboard
2186
2271
  *
2187
2272
  * @example
2188
2273
  * ```js
2189
2274
  * liveboardEmbed.trigger(HostEvent.EditTML)
2190
2275
  * ```
2191
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2276
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2192
2277
  */
2193
2278
  EditTML = "editTSL",
2194
2279
  /**
2195
- * Triggers the Update TML action on a Liveboard
2280
+ * Triggers the **Update TML** action on a Liveboard
2196
2281
  *
2197
2282
  * @example
2198
2283
  * ```js
2199
2284
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
2200
2285
  * ```
2201
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2286
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2202
2287
  */
2203
2288
  UpdateTML = "updateTSL",
2204
2289
  /**
2205
- * Triggers the Download PDF action on a Liveboard
2290
+ * Triggers the **Download PDF** action on a Liveboard
2206
2291
  *
2207
2292
  * @example
2208
2293
  * ```js
2209
2294
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
2210
2295
  * ```
2211
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2296
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2212
2297
  */
2213
2298
  DownloadAsPdf = "downloadAsPdf",
2214
2299
  /**
2215
- * Triggers the Make a copy action on a Liveboard, search or visualization
2300
+ * Triggers the **Make a copy** action on a Liveboard, Search, or
2301
+ * visualization page
2216
2302
  *
2217
2303
  * @example
2218
2304
  * ```js
2219
2305
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2306
+ * ```
2307
+ * ```js
2220
2308
  * vizEmbed.trigger(HostEvent.MakeACopy)
2309
+ * ```
2310
+ * ```js
2221
2311
  * searchEmbed.trigger(HostEvent.MakeACopy)
2222
2312
  * ```
2223
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2313
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2224
2314
  */
2225
2315
  MakeACopy = "makeACopy",
2226
2316
  /**
2227
- * Triggers the Delete action on a Liveboard
2317
+ * Triggers the **Delete** action on a Liveboard
2228
2318
  *
2229
2319
  * @example
2230
2320
  * ```js
2231
2321
  * appEmbed.trigger(HostEvent.Remove)
2232
2322
  * ```
2233
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2323
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2234
2324
  */
2235
2325
  Remove = "delete",
2236
2326
  /**
2237
- * Triggers the Explore action on a visualization
2327
+ * Triggers the **Explore* action on a visualization
2238
2328
  *
2239
- * @param - an object with vizId as a key
2329
+ * @param - an object with `vizId` as a key
2240
2330
  * @example
2241
2331
  * ```js
2242
2332
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2243
2333
  * ```
2244
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2334
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2245
2335
  */
2246
2336
  Explore = "explore",
2247
2337
  /**
2248
- * Triggers the Create alert action on a visualization
2338
+ * Triggers the **Create alert** action on a visualization
2249
2339
  *
2250
- * @param - an object with vizId as a key
2340
+ * @param - an object with `vizId` as a key
2251
2341
  * @example
2252
2342
  * ```js
2253
2343
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
2254
2344
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2255
2345
  * })
2256
2346
  * ```
2257
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2347
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2258
2348
  */
2259
2349
  CreateMonitor = "createMonitor",
2260
2350
  /**
2261
- * Triggers the Manage alert action on a visualization
2351
+ * Triggers the **Manage alerts** action on a visualization
2262
2352
  *
2263
- * @param - an object with vizId as a key
2353
+ * @param - an object with `vizId` as a key
2264
2354
  * @example
2265
2355
  * ```js
2266
2356
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
2267
2357
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2268
2358
  * })
2269
2359
  * ```
2270
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2360
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2271
2361
  */
2272
2362
  ManageMonitor = "manageMonitor",
2273
2363
  /**
2274
- * Triggers the Edit action on a Liveboard or visualization
2364
+ * Triggers the **Edit** action on a Liveboard or visualization
2275
2365
  *
2276
- * @param - object - to trigger the action for a specfic visualization
2277
- * in Liveboard embed, pass in vizId as a key
2366
+ * @param - object - To trigger the action for a specific visualization
2367
+ * in Liveboard embed, pass in `vizId` as a key.
2368
+ * Can be left undefined when embedding Search, full app, or
2369
+ * a visualization.
2278
2370
  * @example
2279
2371
  * ```js
2280
2372
  * liveboardEmbed.trigger(HostEvent.Edit)
2281
- *
2373
+ * ```
2374
+ * ```js
2282
2375
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
2283
2376
  * '730496d6-6903-4601-937e-2c691821af3c'})
2284
- *
2377
+ * ```
2378
+ * ```js
2285
2379
  * vizEmbed.trigger((HostEvent.Edit)
2286
2380
  * ```
2287
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2381
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2288
2382
  */
2289
2383
  Edit = "edit",
2290
2384
  /**
2291
- * Triggers the Copy link action on a Liveboard or visualization
2385
+ * Triggers the **Copy link** action on a Liveboard or visualization
2292
2386
  *
2293
- * @param - object - to trigger the action for a s
2294
- * pecfic visualization in Liveboard embed, pass in vizId as a key
2387
+ * @param - object - to trigger the action for a
2388
+ * specific visualization in Liveboard embed, pass in `vizId` as a key
2295
2389
  * @example
2296
2390
  * ```js
2297
2391
  * liveboardEmbed.trigger(HostEvent.CopyLink)
2392
+ * ```
2393
+ * ```js
2298
2394
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2395
+ * ```
2396
+ * ```js
2299
2397
  * vizEmbed.trigger((HostEvent.CopyLink)
2300
2398
  * ```
2301
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2399
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2302
2400
  */
2303
2401
  CopyLink = "embedDocument",
2304
2402
  /**
2305
- * Triggers the Present action on a Liveboard or visualization
2403
+ * Triggers the **Present** action on a Liveboard or visualization
2306
2404
  *
2307
- * @param - object - to trigger the action for a specfic visualization
2308
- * in Liveboard embed, pass in vizId as a key
2405
+ * @param - object - to trigger the action for a specific visualization
2406
+ * in Liveboard embed, pass in `vizId` as a key
2309
2407
  * @example
2310
2408
  * ```js
2311
2409
  * liveboardEmbed.trigger(HostEvent.Present)
2410
+ * ```
2411
+ * ```js
2312
2412
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2413
+ * ```
2414
+ * ```js
2313
2415
  * vizEmbed.trigger((HostEvent.Present)
2314
2416
  * ```
2315
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2417
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2316
2418
  */
2317
2419
  Present = "present",
2318
2420
  /**
2319
- * Get TML for the current search.
2421
+ * Gets TML for the current search.
2320
2422
  *
2321
2423
  * @example
2322
2424
  * ```js
@@ -2326,79 +2428,89 @@ export enum HostEvent {
2326
2428
  * );
2327
2429
  * })
2328
2430
  * ```
2329
- * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
2431
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2330
2432
  * @important
2331
2433
  */
2332
2434
  GetTML = "getTML",
2333
2435
  /**
2334
- * Triggers the ShowUnderlyingData action on visualization or search
2436
+ * Triggers the **Show underlying data** action on visualization or search
2335
2437
  *
2336
2438
  * @param - an object with vizId as a key
2337
2439
  * @example
2338
2440
  * ```js
2339
2441
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
2340
2442
  * '730496d6-6903-4601-937e-2c691821af3c'})
2341
- *
2443
+ * ```
2444
+ * ```js
2342
2445
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
2343
- *
2446
+ * ```
2447
+ * ```js
2344
2448
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
2345
2449
  * ```
2346
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2450
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2347
2451
  */
2348
2452
  ShowUnderlyingData = "showUnderlyingData",
2349
2453
  /**
2350
- * Triggers the Delete action on visualization or search
2454
+ * Triggers the **Delete** action on visualization or search
2351
2455
  *
2352
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2353
- * can be left empty for search and visualization embeds
2456
+ * @param - Liveboard embed takes an object with `vizId` as a key.
2457
+ * Can be left empty if embedding Search or visualization.
2354
2458
  * @example
2355
2459
  * ```js
2356
2460
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
2357
2461
  * '730496d6-6903-4601-937e-2c691821af3c'})
2358
- *
2462
+ * ```
2463
+ * ```js
2359
2464
  * vizEmbed.trigger(HostEvent.Delete)
2360
- *
2465
+ * ```
2466
+ * ```js
2361
2467
  * searchEmbed.trigger(HostEvent.Delete)
2362
2468
  * ```
2363
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2469
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2364
2470
  */
2365
2471
  Delete = "onDeleteAnswer",
2366
2472
  /**
2367
- * Triggers the SpotIQAnalyze action on visualization or search
2368
- *
2369
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2370
- * can be left empty for search and visualization embeds
2473
+ * Triggers the **SpotIQ analyze** action on visualization
2474
+ * or search.
2475
+ * @param - Liveboard embed takes `vizId` as a
2476
+ * key. Can be left undefined when embedding Search or
2477
+ * visualization.
2371
2478
  * @example
2372
2479
  * ```js
2373
2480
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
2374
2481
  * '730496d6-6903-4601-937e-2c691821af3c'})
2375
- *
2482
+ * ```
2483
+ * ```js
2376
2484
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
2377
- *
2485
+ * ```
2486
+ * ```js
2378
2487
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
2379
2488
  * ```
2380
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2489
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2381
2490
  */
2382
2491
  SpotIQAnalyze = "spotIQAnalyze",
2383
2492
  /**
2384
- * Triggers the Download action on visualization or search when Displaymode is Chart
2493
+ * Triggers the **Download** action on charts in
2494
+ * the embedded view.
2385
2495
  *
2386
2496
  * @example
2387
2497
  * ```js
2388
2498
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
2389
2499
  * '730496d6-6903-4601-937e-2c691821af3c'})
2390
- *
2500
+ * ```
2501
+ * ```js
2391
2502
  * vizEmbed.trigger(HostEvent.Download)
2392
- *
2503
+ * ```
2504
+ * ```js
2393
2505
  * searchEmbed.trigger(HostEvent.Download)
2394
2506
  * ```
2395
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
2396
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2507
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
2508
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2397
2509
  */
2398
2510
  Download = "downloadAsPng",
2399
2511
  /**
2400
- * Triggers the Download action on visualization or search when Displaymode is Chart
2401
- *
2512
+ * Triggers the **Download** > **PNG** action on
2513
+ * charts in the embedded view.
2402
2514
  * @example
2403
2515
  * ```js
2404
2516
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -2408,115 +2520,179 @@ export enum HostEvent {
2408
2520
  *
2409
2521
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
2410
2522
  * ```
2411
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
2523
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
2412
2524
  */
2413
2525
  DownloadAsPng = "downloadAsPng",
2414
2526
  /**
2415
- * Triggers the downloadAsCSV action on visualization or search
2527
+ * Triggers the **Download** > **CSV** action on tables in
2528
+ * the embedded view.
2416
2529
  *
2417
2530
  * @example
2418
2531
  * ```js
2419
2532
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
2420
2533
  * '730496d6-6903-4601-937e-2c691821af3c'})
2421
- *
2534
+ * ```
2535
+ * ```js
2422
2536
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
2423
- *
2537
+ * ```
2538
+ * ```js
2424
2539
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
2425
2540
  * ```
2426
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2541
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2427
2542
  */
2428
2543
  DownloadAsCsv = "downloadAsCSV",
2429
2544
  /**
2430
- * Triggers the downloadAsXLSX action on visualization or search
2431
- *
2545
+ * Triggers the **Download** > **XLSX** action on tables
2546
+ * in the embedded view.
2432
2547
  * @example
2433
2548
  * ```js
2434
2549
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
2435
2550
  * '730496d6-6903-4601-937e-2c691821af3c'})
2436
- *
2551
+ * ```
2552
+ * ```js
2437
2553
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
2438
- *
2554
+ * ```
2555
+ * ```js
2439
2556
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
2440
2557
  * ```
2441
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2558
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2442
2559
  */
2443
2560
  DownloadAsXlsx = "downloadAsXLSX",
2444
2561
  /**
2445
- * Triggers the Share action on a liveboard or answer
2562
+ * Triggers the **Share** action on an embedded
2563
+ * Liveboard or Answer.
2446
2564
  *
2447
2565
  * @example
2448
2566
  * ```js
2449
2567
  * liveboardEmbed.trigger(HostEvent.Share)
2450
- *
2568
+ * ```
2569
+ * ```js
2451
2570
  * searchEmbed.trigger(HostEvent.Share)
2452
2571
  * ```
2453
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2572
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2454
2573
  */
2455
2574
  Share = "share",
2456
2575
  /**
2457
- * Trigger the Save action on a liveboard or answer
2458
- *
2576
+ * Triggers the **Save** action on a Liveboard or Answer.
2577
+ * Saves the changes.
2459
2578
  * @example
2460
2579
  * ```js
2461
2580
  * liveboardEmbed.trigger(HostEvent.Save)
2462
- *
2581
+ * ```
2582
+ * ```js
2463
2583
  * searchEmbed.trigger(HostEvent.Save)
2464
2584
  * ```
2465
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2585
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2466
2586
  */
2467
2587
  Save = "save",
2468
2588
  /**
2469
- * Triggers the SyncToSheets action on visualization
2470
- *
2471
- * @param - an object with vizId as a key
2589
+ * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
2590
+ * Sends data from an Answer or Liveboard visualization to a Google sheet.
2591
+ * @param - an object with `vizId` as a key
2472
2592
  * @example
2473
2593
  * ```js
2474
2594
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
2475
2595
  * '730496d6-6903-4601-937e-2c691821af3c'})
2476
- *
2596
+ * ```
2597
+ * ```js
2477
2598
  * vizEmbed.trigger(HostEvent.SyncToSheets)
2478
2599
  * ```
2479
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2600
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2480
2601
  */
2481
2602
  SyncToSheets = "sync-to-sheets",
2482
2603
  /**
2483
- * Triggers the SyncToOtherApps action on visualization
2484
- *
2604
+ * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
2605
+ * Sends data from an Answer or Liveboard visualization to third-party apps such
2606
+ * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
2485
2607
  * @param - an object with vizId as a key
2486
2608
  * @example
2487
2609
  * ```js
2488
2610
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
2489
2611
  * '730496d6-6903-4601-937e-2c691821af3c'})
2490
- *
2612
+ * ```
2613
+ * ```js
2491
2614
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
2492
2615
  * ```
2493
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2616
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2494
2617
  */
2495
2618
  SyncToOtherApps = "sync-to-other-apps",
2496
2619
  /**
2497
- * Triggers the ManagePipelines action on visualization
2498
- *
2499
- * @param - an object with vizId as a key
2620
+ * Triggers the **Manage pipelines** action on an embedded
2621
+ * visualization or Answer.
2622
+ * Allows users to manage ThoughtSpot Sync pipelines.
2623
+ * @param - an object with `vizId` as a key
2500
2624
  * @example
2501
2625
  * ```js
2502
2626
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
2503
2627
  * '730496d6-6903-4601-937e-2c691821af3c'})
2504
- *
2628
+ * ```
2629
+ * ```js
2505
2630
  * vizEmbed.trigger(HostEvent.ManagePipelines)
2506
2631
  * ```
2507
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2632
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2508
2633
  */
2509
2634
  ManagePipelines = "manage-pipeline",
2510
2635
  /**
2511
- * Triggers the Reset search in answer
2636
+ * Triggers the Reset search on the Search page
2512
2637
  *
2513
2638
  * @example
2514
2639
  * ```js
2515
2640
  * searchEmbed.trigger(HostEvent.ResetSearch)
2516
2641
  * ```
2517
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
2642
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
2643
+ */
2644
+ ResetSearch = "resetSearch",
2645
+ /**
2646
+ * Gets the currents visible and runtime filters applied on a Liveboard
2647
+ *
2648
+ * @example
2649
+ * liveboardEmbed.trigger(HostEvent.GetFilters)
2650
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2518
2651
  */
2519
- ResetSearch = "resetSearch"
2652
+ GetFilters = "getFilters",
2653
+ /**
2654
+ * Updates the visible filters on the Liveboard.
2655
+ *
2656
+ * @param - filter: filter object containing column name and filter operation and values
2657
+ * @example
2658
+ *
2659
+ * ```js
2660
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
2661
+ * filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
2662
+ * })
2663
+ * ```
2664
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2665
+ */
2666
+ UpdateFilters = "updateFilters",
2667
+ GetTabs = "getTabs",
2668
+ /**
2669
+ * Set the visible Tabs on a Liveboard.
2670
+ *
2671
+ * @param - an array of ids of Tabs to show, the ids not passed
2672
+ * will be hidden.
2673
+ * @example
2674
+ * ```js
2675
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
2676
+ * '430496d6-6903-4601-937e-2c691821af3c',
2677
+ * 'f547ec54-2a37-4516-a222-2b06719af726'])
2678
+ * ```
2679
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2680
+ */
2681
+ SetVisibleTabs = "SetPinboardVisibleTabs",
2682
+ /**
2683
+ * Set the hidden tabs on a Liveboard.
2684
+ *
2685
+ * @param - an array of ids of Tabs to hide, the ids not passed
2686
+ * will be shown.
2687
+ * @example
2688
+ * ```js
2689
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
2690
+ * '630496d6-6903-4601-937e-2c691821af3c',
2691
+ * 'i547ec54-2a37-4516-a222-2b06719af726'])
2692
+ * ```
2693
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2694
+ */
2695
+ SetHiddenTabs = "SetPinboardHiddenTabs"
2520
2696
  }
2521
2697
  /**
2522
2698
  * The different visual modes that the data sources panel within
@@ -2590,26 +2766,50 @@ export enum Param {
2590
2766
  HideWorksheetSelector = "hideWorksheetSelector",
2591
2767
  DisableWorksheetChange = "disableWorksheetChange",
2592
2768
  HideEurekaResults = "hideEurekaResults",
2593
- HideEurekaSuggestions = "hideEurekaSuggestions"
2769
+ HideEurekaSuggestions = "hideEurekaSuggestions",
2770
+ HideLiveboardHeader = "hideLiveboardHeader",
2771
+ ShowLiveboardDescription = "showLiveboardDescription",
2772
+ ShowLiveboardTitle = "showLiveboardTitle",
2773
+ HiddenTabs = "hideTabs",
2774
+ VisibleTabs = "visibleTabs",
2775
+ HideTabPanel = "hideTabPanel"
2594
2776
  }
2595
2777
  /**
2596
- * The list of actions that can be performed on visual ThoughtSpot
2597
- * entities, such as answers and Liveboards.
2598
- *
2599
- * This enum is used to specify the actions that could be disabled,
2600
- * hidden or made visible.
2601
- *
2778
+ * ThoughtSpot application pages include actions and menu commands
2779
+ * for various user-initiated operations. These actions are represented
2780
+ * as enumeration members in the SDK. To show, hide, or disable
2781
+ * specific actions in the embedded view, define the Action
2782
+ * enumeration members in the `disabledActions`, `visibleActions`,
2783
+ * or `hiddenActions` array.
2602
2784
  * @example
2603
2785
  * ```js
2604
2786
  * const embed = new LiveboardEmbed('#embed-container', {
2605
2787
  * ... // other options
2606
- * visibleActions: [Action.Save, Action.Explore],
2607
- * disableActions: [Action.Save],
2608
- * hiddenActions: [Action.Download], // Set either this or visibleActions
2788
+ * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
2789
+ * disabledActions: [Action.Download],
2790
+ * //hiddenActions: [], // Set either this or visibleActions
2609
2791
  * })
2610
2792
  * ```
2793
+ * @example
2794
+ * ```js
2795
+ * const embed = new LiveboardEmbed('#embed-container', {
2796
+ * ... // other options
2797
+ * //visibleActions: [],
2798
+ * disabledActions: [Action.Download],
2799
+ * hiddenActions: [Action.Edit, ActionAction.Explore],
2800
+ * })
2801
+ * ```
2802
+
2611
2803
  */
2612
2804
  export enum Action {
2805
+ /**
2806
+ * The **Save** action on an Answer or Liveboard.
2807
+ * Allows users to save the changes.
2808
+ * @example
2809
+ * ```js
2810
+ * disabledActions: [Action.SaveAsView]
2811
+ * ```
2812
+ */
2613
2813
  Save = "save",
2614
2814
  /**
2615
2815
  * @hidden
@@ -2619,27 +2819,137 @@ export enum Action {
2619
2819
  * @hidden
2620
2820
  */
2621
2821
  SaveUntitled = "saveUntitled",
2822
+ /**
2823
+ * The **Save as View** action on the Answer
2824
+ * page. Saves an Answer as a View object.
2825
+ *
2826
+ * @example
2827
+ * ```js
2828
+ * disabledActions: [Action.SaveAsView]
2829
+ * ```
2830
+ */
2622
2831
  SaveAsView = "saveAsView",
2832
+ /**
2833
+ * The **Make a copy** action on a Liveboard or Answer
2834
+ * page.
2835
+ * Creates a copy of the Liveboard, visualization,
2836
+ * or Answer.
2837
+ *
2838
+ * @example
2839
+ * ```js
2840
+ * disabledActions: [Action.MakeACopy]
2841
+ * ```
2842
+ */
2623
2843
  MakeACopy = "makeACopy",
2844
+ /**
2845
+ * The **Copy and Edit** action on a Liveboard.
2846
+ * This action is now replaced with `Action.MakeACopy`.
2847
+ *
2848
+ * @example
2849
+ * ```js
2850
+ * disabledActions: [Action.EditACopy]
2851
+ * ```
2852
+ */
2624
2853
  EditACopy = "editACopy",
2854
+ /**
2855
+ * The **Copy link** menu action on a Liveboard visualization.
2856
+ * Copies the visualization URL
2857
+ * @example
2858
+ * ```js
2859
+ * disabledActions: [Action.CopyLink]
2860
+ * ```
2861
+ */
2625
2862
  CopyLink = "embedDocument",
2626
2863
  /**
2627
2864
  * @hidden
2628
2865
  */
2629
2866
  ResetLayout = "resetLayout",
2867
+ /**
2868
+ * The **Schedule** menu action on a Liveboard.
2869
+ * Allows scheduling a Liveboard notification.
2870
+ * @example
2871
+ * ```js
2872
+ * disabledActions: [Action.Schedule]
2873
+ * ```
2874
+ */
2630
2875
  Schedule = "subscription",
2876
+ /**
2877
+ * The **Manage schedules** menu action on a Liveboard.
2878
+ * Allows users to manage scheduled Liveboard jobs.
2879
+ * @example
2880
+ * ```js
2881
+ * disabledActions: [Action.SchedulesList]
2882
+ * ```
2883
+ */
2631
2884
  SchedulesList = "schedule-list",
2885
+ /**
2886
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
2887
+ * Allows users to share an object with other users and groups.
2888
+ * @example
2889
+ * ```js
2890
+ * disabledActions: [Action.Share]
2891
+ * ```
2892
+ */
2632
2893
  Share = "share",
2894
+ /**
2895
+ * The **Add filter** action on a Liveboard and Search page.
2896
+ * Allows adding filters to Answers and visualizations on a Liveboard.
2897
+ * @example
2898
+ * ```js
2899
+ * disabledActions: [Action.AddFilter]
2900
+ * ```
2901
+ */
2633
2902
  AddFilter = "addFilter",
2903
+ /**
2904
+ * Filter configuration options on a Liveboard and Search page.
2905
+ * Allows configuring filter options when adding filters to a
2906
+ * Liveboard or Answer.
2907
+ * @example
2908
+ * ```js
2909
+ * disabledActions: [Action.ConfigureFilter]
2910
+ * ```
2911
+ */
2634
2912
  ConfigureFilter = "configureFilter",
2635
2913
  CollapseDataSources = "collapseDataSources",
2914
+ /**
2915
+ * The **Choose sources** button on Search page.
2916
+ * Allows selecting data sources for search queries.
2917
+ * @example
2918
+ * ```js
2919
+ * disabledActions: [Action.ChooseDataSources]
2920
+ * ```
2921
+ */
2636
2922
  ChooseDataSources = "chooseDataSources",
2923
+ /**
2924
+ * The **Create formula** action on a Search or Answer page.
2925
+ * Allows adding formulas to an Answer.
2926
+ * @example
2927
+ * ```js
2928
+ * disabledActions: [Action.AddFormula]
2929
+ * ```
2930
+ */
2637
2931
  AddFormula = "addFormula",
2932
+ /**
2933
+ * The **Add parameter** action on a Liveboard or Answer.
2934
+ * Allows adding Parameters to a Liveboard or Answer.
2935
+ * @example
2936
+ * ```js
2937
+ * disabledActions: [Action.AddParameter]
2938
+ * ```
2939
+ */
2638
2940
  AddParameter = "addParameter",
2639
2941
  /**
2640
2942
  * @hidden
2641
2943
  */
2642
2944
  SearchOnTop = "searchOnTop",
2945
+ /**
2946
+ * The **SpotIQ analyze** menu action on a visualization or
2947
+ * Answer page.
2948
+ * @example
2949
+ * ```js
2950
+ * disabledActions: [Action.SpotIQAnalyze]
2951
+ * ```
2952
+ */
2643
2953
  SpotIQAnalyze = "spotIQAnalyze",
2644
2954
  /**
2645
2955
  * @hidden
@@ -2654,24 +2964,150 @@ export enum Action {
2654
2964
  * @hidden
2655
2965
  */
2656
2966
  ReplaySearch = "replaySearch",
2967
+ /**
2968
+ * The **Show underlying data** menu action on a visualization or
2969
+ * Answer page.
2970
+ * @example
2971
+ * ```js
2972
+ * disabledActions: [Action.ShowUnderlyingData]
2973
+ * ```
2974
+ */
2657
2975
  ShowUnderlyingData = "showUnderlyingData",
2976
+ /**
2977
+ * The **Download** menu action on Liveboard visualizations
2978
+ * and Answers.
2979
+ * Allows downloading a visualization or Answer.
2980
+ * @example
2981
+ * ```js
2982
+ * disabledActions: [Action.DownloadAsPng]
2983
+ * ```
2984
+ */
2658
2985
  Download = "download",
2986
+ /**
2987
+ * The **Download** > **PNG** menu action for charts on a Liveboard
2988
+ * or Answer page.
2989
+ * Downloads a visualization or Answer as a PNG file.
2990
+ * @example
2991
+ * ```js
2992
+ * disabledActions: [Action.DownloadAsPng]
2993
+ * ```
2994
+ */
2659
2995
  DownloadAsPng = "downloadAsPng",
2996
+ /**
2997
+ * The **Download** > **PDF** menu action on a Liveboard.
2998
+ * Downloads a visualization or Answer as a PDF file.
2999
+ * @example
3000
+ * ```js
3001
+ * disabledActions: [Action.DownloadAsPdf]
3002
+ * ```
3003
+ */
2660
3004
  DownloadAsPdf = "downloadAsPdf",
3005
+ /**
3006
+ * The **Download** > **CSV** menu action for tables on a Liveboard
3007
+ * or Answer page.
3008
+ * Downloads a visualization or Answer in the XLSX format.
3009
+ * @example
3010
+ * ```js
3011
+ * disabledActions: [Action.DownloadAsCsv]
3012
+ * ```
3013
+ */
2661
3014
  DownloadAsCsv = "downloadAsCSV",
3015
+ /**
3016
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
3017
+ * or Answer page.
3018
+ * Downloads a visualization or Answer in the XLSX format.
3019
+ * @example
3020
+ * ```js
3021
+ * disabledActions: [Action.DownloadAsXlsx]
3022
+ * ```
3023
+ */
2662
3024
  DownloadAsXlsx = "downloadAsXLSX",
2663
3025
  /**
2664
3026
  * @hidden
2665
3027
  */
2666
3028
  DownloadTrace = "downloadTrace",
3029
+ /**
3030
+ * The **Export TML** menu action on Liveboard, Answers
3031
+ * Worksheets and Data Connections page.
3032
+ * Exports an object as a TML file.
3033
+ * @example
3034
+ * ```js
3035
+ * disabledActions: [Action.ExportTML]
3036
+ * ```
3037
+ */
2667
3038
  ExportTML = "exportTSL",
3039
+ /**
3040
+ * The **Import TML** menu action for Liveboards and Answers.
3041
+ * Imports TML representation of ThoughtSpot objects.
3042
+ * @example
3043
+ * ```js
3044
+ * disabledActions: [Action.ImportTML]
3045
+ * ```
3046
+ */
2668
3047
  ImportTML = "importTSL",
3048
+ /**
3049
+ * The **Update TML** menu action for Liveboards and Answers.
3050
+ * Update TML representation of ThoughtSpot objects.
3051
+ * @example
3052
+ * ```js
3053
+ * disabledActions: [Action.UpdateTML]
3054
+ * ```
3055
+ */
2669
3056
  UpdateTML = "updateTSL",
3057
+ /**
3058
+ * The **Edit TML** menu action for Liveboards and Answers.
3059
+ * Opens the TML editor.
3060
+ * @example
3061
+ * ```js
3062
+ * disabledActions: [Action.EditTML]
3063
+ * ```
3064
+ */
2670
3065
  EditTML = "editTSL",
3066
+ /**
3067
+ * The **Present** menu action for Liveboards and Answers.
3068
+ * Allows presenting a Liveboard or visualization in
3069
+ * slideshow mode.
3070
+ * @example
3071
+ * ```js
3072
+ * disabledActions: [Action.Present]
3073
+ * ```
3074
+ */
2671
3075
  Present = "present",
3076
+ /**
3077
+ * The tile resize options in the visualization menu.
3078
+ * Allows switching between different preset layouts.
3079
+ * @example
3080
+ * ```js
3081
+ * disabledActions: [Action.ToggleSize]
3082
+ * ```
3083
+ */
2672
3084
  ToggleSize = "toggleSize",
3085
+ /**
3086
+ * The *Edit* action on the Liveboard page and in the
3087
+ * visualization menu.
3088
+ * Opens a Liveboard or visualization in edit mode.
3089
+ * @example
3090
+ * ```js
3091
+ * disabledActions: [Action.Edit]
3092
+ * ```
3093
+ */
2673
3094
  Edit = "edit",
3095
+ /**
3096
+ * The text edit option for Liveboard and visualization titles.
3097
+ * @example
3098
+ * ```js
3099
+ * disabledActions: [Action.EditTitle]
3100
+ * ```
3101
+ */
2674
3102
  EditTitle = "editTitle",
3103
+ /**
3104
+ * The **Delete** menu action on Liveboards and visualizations.
3105
+ * Deletes a Liveboard or a visualization from a Liveboard.
3106
+ * @example
3107
+ * ```js
3108
+ * disabledActions: [Action.Remove]
3109
+ * ```
3110
+ */
2675
3111
  Remove = "delete",
2676
3112
  /**
2677
3113
  * @hidden
@@ -2693,6 +3129,16 @@ export enum Action {
2693
3129
  * @hidden
2694
3130
  */
2695
3131
  PinboardInfo = "pinboardInfo",
3132
+ /**
3133
+ * The **Show Liveboard details** menu action on a Liveboard.
3134
+ * Displays details such as the name, description, and
3135
+ * author of the Liveboard, and timestamp of Liveboard creation
3136
+ * and update.
3137
+ * @example
3138
+ * ```js
3139
+ * disabledActions: [Action.LiveboardInfo]
3140
+ * ```
3141
+ */
2696
3142
  LiveboardInfo = "pinboardInfo",
2697
3143
  /**
2698
3144
  * @hidden
@@ -2703,20 +3149,61 @@ export enum Action {
2703
3149
  */
2704
3150
  DownloadEmbraceQueries = "downloadEmbraceQueries",
2705
3151
  /**
2706
- * Pin action.
2707
- */
3152
+ * The **Pin** menu action on an Answer or
3153
+ * Search results page.
3154
+ * @example
3155
+ * ```js
3156
+ * disabledActions: [Action.Pin]
3157
+ * ```
3158
+ */
2708
3159
  Pin = "pin",
2709
3160
  /**
2710
3161
  * @hidden
2711
3162
  */
2712
3163
  AnalysisInfo = "analysisInfo",
2713
- Subscription = "subscription",
2714
3164
  /**
2715
- * Explore action.
3165
+ * The **Schedule** menu action on a Liveboard.
3166
+ * @example
3167
+ * ```js
3168
+ * disabledActions: [Action.Subscription]
3169
+ * ```
2716
3170
  */
3171
+ Subscription = "subscription",
3172
+ /**
3173
+ * The **Explore** action on Liveboard visualizations
3174
+ * @example
3175
+ * ```js
3176
+ * disabledActions: [Action.Explore]
3177
+ * ```
3178
+ */
2717
3179
  Explore = "explore",
3180
+ /**
3181
+ * The action to include data points on a drilled-down Answer
3182
+ * or visualization
3183
+ * @example
3184
+ * ```js
3185
+ * disabledActions: [Action.DrillInclude]
3186
+ * ```
3187
+ */
2718
3188
  DrillInclude = "context-menu-item-include",
3189
+ /**
3190
+ * The action to exclude data points on a drilled-down Answer
3191
+ * or visualization
3192
+ * @example
3193
+ * ```js
3194
+ * disabledActions: [Action.DrillInclude]
3195
+ * ```
3196
+ */
2719
3197
  DrillExclude = "context-menu-item-exclude",
3198
+ /**
3199
+ * The **Copy to clipboard** menu action on tables in an Answer
3200
+ * or Liveboard.
3201
+ * Copies the selected data point.
3202
+ * @example
3203
+ * ```js
3204
+ * disabledActions: [Action.CopyToClipboard]
3205
+ * ```
3206
+ */
2720
3207
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
2721
3208
  CopyAndEdit = "context-menu-item-copy-and-edit",
2722
3209
  /**
@@ -2725,89 +3212,266 @@ export enum Action {
2725
3212
  DrillEdit = "context-menu-item-edit",
2726
3213
  EditMeasure = "context-menu-item-edit-measure",
2727
3214
  Separator = "context-menu-item-separator",
3215
+ /**
3216
+ * The **Drill down** menu action on Answers and Liveboard
3217
+ * visualizations.
3218
+ * Allows drilling down to a specific data point on a chart or table.
3219
+ * @example
3220
+ * ```js
3221
+ * disabledActions: [Action.DrillDown]
3222
+ * ```
3223
+ */
2728
3224
  DrillDown = "DRILL",
3225
+ /**
3226
+ * The request access action on Liveboards.
3227
+ * Allows users with view permissions to request edit access to a Liveboard.
3228
+ * @example
3229
+ * ```js
3230
+ * disabledActions: [Action.RequestAccess]
3231
+ * ```
3232
+ */
2729
3233
  RequestAccess = "requestAccess",
2730
- QueryDetailsButtons = "queryDetailsButtons",
2731
3234
  /**
2732
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3235
+ * The **Query visualizer** and **Query SQL** buttons in Query details panel
3236
+ * of the Answer page
3237
+ * @example
3238
+ * ```js
3239
+ * disabledActions: [Action.QueryDetailsButtons]
3240
+ * ```
3241
+ */
3242
+ QueryDetailsButtons = "QueryDetailsButtons",
3243
+ /**
3244
+ * The **Delete** action for Answers.
3245
+ * @example
3246
+ * ```js
3247
+ * disabledActions: [Action.AnswerDelete]
3248
+ * ```
3249
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2733
3250
  */
2734
3251
  AnswerDelete = "onDeleteAnswer",
2735
3252
  /**
2736
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3253
+ * The Chart switcher icon on Answer and visualization pages.
3254
+ * @example
3255
+ * ```js
3256
+ * disabledActions: [Action.AnswerChartSwitcher]
3257
+ * ```
3258
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2737
3259
  */
2738
3260
  AnswerChartSwitcher = "answerChartSwitcher",
2739
3261
  /**
2740
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3262
+ * Favorites icon (*) on Answers, Liveboard, and Data pages
3263
+ * @example
3264
+ * ```js
3265
+ * disabledActions: [Action.AddToFavorites]
3266
+ * ```
3267
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2741
3268
  */
2742
3269
  AddToFavorites = "addToFavorites",
2743
3270
  /**
2744
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3271
+ * The edit icon on Liveboards (Classic experience).
3272
+ * @example
3273
+ * ```js
3274
+ * disabledActions: [Action.EditDetails]
3275
+ * ```
3276
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2745
3277
  */
2746
3278
  EditDetails = "editDetails",
2747
3279
  /**
2748
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
3280
+ * The Create alert action on KPI charts.
3281
+ * @example
3282
+ * ```js
3283
+ * disabledActions: [Action.CreateMonitor ]
3284
+ * ```
3285
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2749
3286
  */
2750
3287
  CreateMonitor = "createMonitor",
2751
3288
  /**
2752
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
3289
+ * @example
3290
+ * ```js
3291
+ * disabledActions: [Action.ReportError]
3292
+ * ```
3293
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2753
3294
  */
2754
3295
  ReportError = "reportError",
3296
+ /**
3297
+ * The **Sync to sheets** action on Answers and Liveboard visualizations.
3298
+ * Allows sending data to a Google Sheet.
3299
+ * @example
3300
+ * ```js
3301
+ * disabledActions: [Action.SyncToSheets]
3302
+ * ```
3303
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3304
+ */
2755
3305
  SyncToSheets = "sync-to-sheets",
3306
+ /**
3307
+ * The **Sync to other apps** action on Answers and Liveboard visualizations.
3308
+ * Allows sending data to third-party apps like Slack, Salesforce,
3309
+ * Microsoft Teams, and so on.
3310
+ * @example
3311
+ * ```js
3312
+ * disabledActions: [Action.SyncToOtherApps]
3313
+ * ```
3314
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3315
+ */
2756
3316
  SyncToOtherApps = "sync-to-other-apps",
3317
+ /**
3318
+ * The **Manage pipelines** action on Answers and Liveboard visualizations.
3319
+ * Allows users to manage data sync pipelines to third-party apps.
3320
+ * @example
3321
+ * ```js
3322
+ * disabledActions: [Action.SyncToOtherApps]
3323
+ * ```
3324
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3325
+ */
2757
3326
  ManagePipelines = "manage-pipeline",
2758
3327
  /**
3328
+ * The **Filter** action on Liveboard visualizations.
3329
+ * Allows users to apply cross-filters on a Liveboard.
3330
+ * @example
3331
+ * ```js
3332
+ * disabledActions: [Action.CrossFilter]
3333
+ * ```
2759
3334
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2760
3335
  */
2761
3336
  CrossFilter = "context-menu-item-cross-filter",
2762
3337
  /**
3338
+ * The **Remove** action that appears when cross filters are applied
3339
+ * on a Liveboard.
3340
+ * Removes filters applied o a visualization.
3341
+ * @example
3342
+ * ```js
3343
+ * disabledActions: [Action.RemoveCrossFilter]
3344
+ * ```
2763
3345
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2764
3346
  */
2765
3347
  RemoveCrossFilter = "context-menu-item-remove-cross-filter",
2766
3348
  /**
3349
+ * The **Aggregate** option in the chart axis or the
3350
+ * table column customization menu.
3351
+ * Provides aggregation options to analyze the data on a chart or table.
3352
+ * @example
3353
+ * ```js
3354
+ * disabledActions: [Action.AxisMenuAggregate]
3355
+ * ```
2767
3356
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2768
3357
  */
2769
3358
  AxisMenuAggregate = "axisMenuAggregate",
2770
3359
  /**
3360
+ * The **Time bucket** option in the chart axis or table column
3361
+ * customization menu.
3362
+ * Allows defining time metric for date comparison.
3363
+ * @example
3364
+ * ```js
3365
+ * disabledActions: [Action.AxisMenuTimeBucket]
3366
+ * ```
2771
3367
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2772
3368
  */
2773
3369
  AxisMenuTimeBucket = "axisMenuTimeBucket",
2774
3370
  /**
3371
+ * The **Filter** action in the chart axis or table column
3372
+ * customization menu.
3373
+ * @example
3374
+ * ```js
3375
+ * disabledActions: [Action.AxisMenuFilter]
3376
+ * ```
2775
3377
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2776
3378
  */
2777
3379
  AxisMenuFilter = "axisMenuFilter",
2778
3380
  /**
3381
+ * The **Conditional formatting** action on chart or table.
3382
+ * Allows adding rules for conditional formatting of data
3383
+ * points on a chart or table.
3384
+ * @example
3385
+ * ```js
3386
+ * disabledActions: [Action.AxisMenuConditionalFormat]
3387
+ * ```
2779
3388
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2780
3389
  */
2781
3390
  AxisMenuConditionalFormat = "axisMenuConditionalFormat",
2782
3391
  /**
3392
+ * The **Sort** menu action on a table or chart axis
3393
+ * Sorts data in ascending or descending order.
3394
+ * Allows adding, editing, or removing filters.
3395
+ * @example
3396
+ * ```js
3397
+ * disabledActions: [Action.AxisMenuConditionalFormat]
3398
+ * ```
2783
3399
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2784
3400
  */
2785
3401
  AxisMenuSort = "axisMenuSort",
2786
3402
  /**
3403
+ * The **Group** option in the chart axis or table column
3404
+ * customization menu.
3405
+ * Allows grouping data points if the axes use the same
3406
+ * unit of measurement and a similar scale.
3407
+ * @example
3408
+ * ```js
3409
+ * disabledActions: [Action.AxisMenuGroup]
3410
+ * ```
2787
3411
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2788
3412
  */
2789
3413
  AxisMenuGroup = "axisMenuGroup",
2790
3414
  /**
3415
+ * The **Position** option in the axis customization menu.
3416
+ * Allows changing the position of the axis to the
3417
+ * left or right side of the chart.
3418
+ * @example
3419
+ * ```js
3420
+ * disabledActions: [Action.AxisMenuPosition]
3421
+ * ```
2791
3422
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2792
3423
  */
2793
3424
  AxisMenuPosition = "axisMenuPosition",
2794
3425
  /**
3426
+ * The **Rename** option in the chart axis or table column customization menu.
3427
+ * Renames the axis label on a chart or the column header on a table.
3428
+ * @example
3429
+ * ```js
3430
+ * disabledActions: [Action.AxisMenuRename]
3431
+ * ```
2795
3432
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2796
3433
  */
2797
3434
  AxisMenuRename = "axisMenuRename",
2798
3435
  /**
3436
+ * The **Edit** action in the axis customization menu.
3437
+ * Allows editing the axis name, position, minimum and maximum values,
3438
+ * and format of a column.
3439
+ * @example
3440
+ * ```js
3441
+ * disabledActions: [Action.AxisMenuEdit]
3442
+ * ```
2799
3443
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2800
3444
  */
2801
3445
  AxisMenuEdit = "axisMenuEdit",
2802
3446
  /**
3447
+ * The **Number format** action to customize the format of
3448
+ * the data labels on a chart or table.
3449
+ * @example
3450
+ * ```js
3451
+ * disabledActions: [Action.AxisMenuNumberFormat]
3452
+ * ```
2803
3453
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2804
3454
  */
2805
3455
  AxisMenuNumberFormat = "axisMenuNumberFormat",
2806
3456
  /**
3457
+ * The **Text wrapping** action on a table.
3458
+ * Wraps or clips column text on a table.
3459
+ * @example
3460
+ * ```js
3461
+ * disabledActions: [Action.AxisMenuTextWrapping]
3462
+ * ```
2807
3463
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2808
3464
  */
2809
3465
  AxisMenuTextWrapping = "axisMenuTextWrapping",
2810
3466
  /**
3467
+ * The **Remove** action in the chart axis or table column
3468
+ * customization menu.
3469
+ * Removes the data labels from a chart or the column of a
3470
+ * table visualization.
3471
+ * @example
3472
+ * ```js
3473
+ * disabledActions: [Action.AxisMenuRemove]
3474
+ * ```
2811
3475
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2812
3476
  */
2813
3477
  AxisMenuRemove = "axisMenuRemove",
@@ -2816,9 +3480,31 @@ export enum Action {
2816
3480
  */
2817
3481
  InsertInToSlide = "insertInToSlide",
2818
3482
  /**
3483
+ * The **Rename** menu action on Liveboards and visualizations.
3484
+ * Allows renaming a Liveboard or visualization.
3485
+ * @example
3486
+ * ```js
3487
+ * disabledActions: [Action.RenameModalTitleDescription]
3488
+ * ```
2819
3489
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2820
3490
  */
2821
- RenameModalTitleDescription = "renameModalTitleDescription"
3491
+ RenameModalTitleDescription = "renameModalTitleDescription",
3492
+ /**
3493
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3494
+ */
3495
+ RequestVerification = "requestVerification",
3496
+ /**
3497
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3498
+ */
3499
+ MarkAsVerified = "markAsVerified",
3500
+ /**
3501
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3502
+ */
3503
+ AddTab = "addTab",
3504
+ /**
3505
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3506
+ */
3507
+ EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
2822
3508
  }
2823
3509
  export interface SessionInterface {
2824
3510
  sessionId: string;
@@ -2973,7 +3659,7 @@ export interface CustomCssVariables {
2973
3659
  * Background color of the primary buttons. For example, the primary buttons such as
2974
3660
  * Pin* and *Save*.
2975
3661
  */
2976
- '---ts-var-button--primary-background'?: string;
3662
+ '--ts-var-button--primary-background'?: string;
2977
3663
  /**
2978
3664
  * Background color of the primary buttons on hover.
2979
3665
  */
@@ -3189,6 +3875,7 @@ export const HiddenActionItemByDefaultForSageEmbed: Action[];
3189
3875
  /**
3190
3876
  * Embed ThoughtSpot LLM and GPT based natural language search component.
3191
3877
  *
3878
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
3192
3879
  * @group Embed components
3193
3880
  */
3194
3881
  export class SageEmbed extends V1Embed {