@thoughtspot/visual-embed-sdk 1.23.0-alpha.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 (86) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +8 -1
  3. package/cjs/src/css-variables.d.ts +1 -1
  4. package/cjs/src/css-variables.d.ts.map +1 -1
  5. package/cjs/src/embed/liveboard.d.ts +6 -0
  6. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  7. package/cjs/src/embed/liveboard.js +4 -1
  8. package/cjs/src/embed/liveboard.js.map +1 -1
  9. package/cjs/src/embed/liveboard.spec.js +12 -0
  10. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  11. package/cjs/src/embed/sage.d.ts +1 -0
  12. package/cjs/src/embed/sage.d.ts.map +1 -1
  13. package/cjs/src/embed/sage.js +1 -0
  14. package/cjs/src/embed/sage.js.map +1 -1
  15. package/cjs/src/embed/search.d.ts +4 -0
  16. package/cjs/src/embed/search.d.ts.map +1 -1
  17. package/cjs/src/embed/search.js +1 -1
  18. package/cjs/src/embed/search.js.map +1 -1
  19. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  20. package/cjs/src/embed/ts-embed.js +11 -1
  21. package/cjs/src/embed/ts-embed.js.map +1 -1
  22. package/cjs/src/embed/ts-embed.spec.js +69 -0
  23. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  24. package/cjs/src/react/index.spec.js +12 -0
  25. package/cjs/src/react/index.spec.js.map +1 -1
  26. package/cjs/src/types.d.ts +869 -213
  27. package/cjs/src/types.d.ts.map +1 -1
  28. package/cjs/src/types.js +827 -194
  29. package/cjs/src/types.js.map +1 -1
  30. package/dist/src/css-variables.d.ts +1 -1
  31. package/dist/src/css-variables.d.ts.map +1 -1
  32. package/dist/src/embed/liveboard.d.ts +6 -0
  33. package/dist/src/embed/liveboard.d.ts.map +1 -1
  34. package/dist/src/embed/sage.d.ts +1 -0
  35. package/dist/src/embed/sage.d.ts.map +1 -1
  36. package/dist/src/embed/search.d.ts +4 -0
  37. package/dist/src/embed/search.d.ts.map +1 -1
  38. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  39. package/dist/src/types.d.ts +869 -213
  40. package/dist/src/types.d.ts.map +1 -1
  41. package/dist/tsembed-react.es.js +845 -198
  42. package/dist/tsembed-react.js +826 -189
  43. package/dist/tsembed.es.js +845 -198
  44. package/dist/tsembed.js +826 -189
  45. package/dist/visual-embed-sdk-react-full.d.ts +881 -214
  46. package/dist/visual-embed-sdk-react.d.ts +881 -214
  47. package/dist/visual-embed-sdk.d.ts +881 -214
  48. package/lib/package.json +8 -1
  49. package/lib/src/css-variables.d.ts +1 -1
  50. package/lib/src/css-variables.d.ts.map +1 -1
  51. package/lib/src/embed/liveboard.d.ts +6 -0
  52. package/lib/src/embed/liveboard.d.ts.map +1 -1
  53. package/lib/src/embed/liveboard.js +4 -1
  54. package/lib/src/embed/liveboard.js.map +1 -1
  55. package/lib/src/embed/liveboard.spec.js +12 -0
  56. package/lib/src/embed/liveboard.spec.js.map +1 -1
  57. package/lib/src/embed/sage.d.ts +1 -0
  58. package/lib/src/embed/sage.d.ts.map +1 -1
  59. package/lib/src/embed/sage.js +1 -0
  60. package/lib/src/embed/sage.js.map +1 -1
  61. package/lib/src/embed/search.d.ts +4 -0
  62. package/lib/src/embed/search.d.ts.map +1 -1
  63. package/lib/src/embed/search.js +1 -1
  64. package/lib/src/embed/search.js.map +1 -1
  65. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  66. package/lib/src/embed/ts-embed.js +11 -1
  67. package/lib/src/embed/ts-embed.js.map +1 -1
  68. package/lib/src/embed/ts-embed.spec.js +69 -0
  69. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  70. package/lib/src/react/index.spec.js +12 -0
  71. package/lib/src/react/index.spec.js.map +1 -1
  72. package/lib/src/types.d.ts +869 -213
  73. package/lib/src/types.d.ts.map +1 -1
  74. package/lib/src/types.js +827 -194
  75. package/lib/src/types.js.map +1 -1
  76. package/lib/src/visual-embed-sdk.d.ts +881 -214
  77. package/package.json +8 -1
  78. package/src/css-variables.ts +1 -1
  79. package/src/embed/liveboard.spec.ts +16 -0
  80. package/src/embed/liveboard.ts +10 -0
  81. package/src/embed/sage.ts +1 -0
  82. package/src/embed/search.ts +5 -0
  83. package/src/embed/ts-embed.spec.ts +79 -0
  84. package/src/embed/ts-embed.ts +13 -1
  85. package/src/react/index.spec.tsx +29 -0
  86. package/src/types.ts +883 -213
@@ -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
@@ -439,6 +445,10 @@ export interface SearchViewConfig extends ViewConfig {
439
445
  * using raw answer data.
440
446
  */
441
447
  hideResults?: boolean;
448
+ /**
449
+ * If set to true, expands all the data sources panel.
450
+ */
451
+ expandAllDataSource?: boolean;
442
452
  /**
443
453
  * If set to true, the Search Assist feature is enabled.
444
454
  *
@@ -891,7 +901,7 @@ export enum AuthType {
891
901
  * .then((data) => data.token);
892
902
  * }
893
903
  * ```
894
- * @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
895
905
  */
896
906
  TrustedAuthTokenCookieless = "AuthServerCookieless",
897
907
  /**
@@ -1062,7 +1072,7 @@ export interface EmbedConfig {
1062
1072
  *
1063
1073
  * Eg: "/dashboard", "#/foo" [Do not include the host]
1064
1074
  *
1065
- * @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
1066
1076
  */
1067
1077
  redirectPath?: string;
1068
1078
  /** @internal */
@@ -1104,14 +1114,14 @@ export interface EmbedConfig {
1104
1114
  * This flag is typically used alongside the combination of auth modes such as {@link
1105
1115
  * AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
1106
1116
  *
1107
- * @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
1108
1118
  * @default false
1109
1119
  */
1110
1120
  disableLoginRedirect?: boolean;
1111
1121
  /**
1112
1122
  * This message is displayed on the embed view when the login fails.
1113
1123
  *
1114
- * @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
1115
1125
  */
1116
1126
  loginFailedMessage?: string;
1117
1127
  /**
@@ -1133,7 +1143,7 @@ export interface EmbedConfig {
1133
1143
  * Dynamic CSS Url to be injected in the loaded application.
1134
1144
  * You would also need to set `style-src` in the CSP settings.
1135
1145
  *
1136
- * @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
1137
1147
  * @default ''
1138
1148
  */
1139
1149
  customCssUrl?: string;
@@ -1145,13 +1155,13 @@ export interface EmbedConfig {
1145
1155
  * This is slightly slower than letting the browser handle the cookie check, as it
1146
1156
  * involves an extra network call.
1147
1157
  *
1148
- * @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
1149
1159
  */
1150
1160
  detectCookieAccessSlow?: boolean;
1151
1161
  /**
1152
1162
  * Hide beta alert warning message for SearchEmbed.
1153
1163
  *
1154
- * @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*
1155
1165
  */
1156
1166
  suppressSearchEmbedBetaWarning?: boolean;
1157
1167
  /**
@@ -1199,7 +1209,7 @@ export interface EmbedConfig {
1199
1209
  * Disable Full App access of Embedded app outside of the iFrame.
1200
1210
  *
1201
1211
  * @default true
1202
- * @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
1203
1213
  */
1204
1214
  blockNonEmbedFullAppAccess?: boolean;
1205
1215
  /**
@@ -1302,14 +1312,14 @@ export interface ViewConfig {
1302
1312
  *
1303
1313
  * Use either this or hiddenActions.
1304
1314
  *
1305
- * @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
1306
1316
  * @important
1307
1317
  */
1308
1318
  visibleActions?: Action[];
1309
1319
  /**
1310
1320
  * Show alert messages and toast messages in the embedded view.
1311
1321
  *
1312
- * @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
1313
1323
  */
1314
1324
  showAlerts?: boolean;
1315
1325
  /**
@@ -1320,7 +1330,7 @@ export interface ViewConfig {
1320
1330
  /**
1321
1331
  * The locale/language to use for the embedded view.
1322
1332
  *
1323
- * @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
1324
1334
  */
1325
1335
  locale?: string;
1326
1336
  /**
@@ -1331,7 +1341,7 @@ export interface ViewConfig {
1331
1341
  * to control embed behavior in non-regular ways. We do not publish the
1332
1342
  * list of supported keys and values associated with each.
1333
1343
  *
1334
- * @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
1335
1345
  */
1336
1346
  additionalFlags?: {
1337
1347
  [key: string]: string | number | boolean;
@@ -1340,7 +1350,7 @@ export interface ViewConfig {
1340
1350
  * Dynamic CSSUrl and customCSS to be injected in the loaded application.
1341
1351
  * You would also need to set `style-src` in the CSP settings.
1342
1352
  *
1343
- * @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
1344
1354
  * @default ''
1345
1355
  */
1346
1356
  customizations?: CustomisationsInterface;
@@ -1388,24 +1398,60 @@ export interface ViewConfig {
1388
1398
  /**
1389
1399
  * Boolean to hide liveboard header
1390
1400
  *
1391
- * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
1401
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1392
1402
  * @default false
1393
1403
  */
1394
1404
  hideLiveboardHeader?: boolean;
1395
1405
  /**
1396
1406
  * Boolean to show liveboard title
1397
1407
  *
1398
- * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
1408
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1399
1409
  * @default false
1400
1410
  */
1401
1411
  showLiveboardTitle?: boolean;
1402
1412
  /**
1403
1413
  * Boolean to show liveboard description
1404
1414
  *
1405
- * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
1415
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1406
1416
  * @default false
1407
1417
  */
1408
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[];
1409
1455
  }
1410
1456
  /**
1411
1457
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1611,7 +1657,7 @@ export enum EmbedEvent {
1611
1657
  * One or more data columns have been selected.
1612
1658
  *
1613
1659
  * @returns columnIds - the list of columns
1614
- * @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
1615
1661
  */
1616
1662
  AddRemoveColumns = "addRemoveColumns",
1617
1663
  /**
@@ -1644,7 +1690,7 @@ export enum EmbedEvent {
1644
1690
  * });
1645
1691
  * ```
1646
1692
  * @return viz, clickedPoint - metadata about point that is clicked
1647
- * @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
1648
1694
  * @important
1649
1695
  */
1650
1696
  VizPointClick = "vizPointClick",
@@ -1694,7 +1740,7 @@ export enum EmbedEvent {
1694
1740
  * Emitted when the "Get Data" button in Search Bar embed
1695
1741
  * is clicked.
1696
1742
  *
1697
- * @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
1698
1744
  */
1699
1745
  GetDataClick = "getDataClick",
1700
1746
  /**
@@ -1724,13 +1770,13 @@ export enum EmbedEvent {
1724
1770
  /**
1725
1771
  * Emitted when any modal is opened in the app
1726
1772
  *
1727
- * @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
1728
1774
  */
1729
1775
  DialogOpen = "dialog-open",
1730
1776
  /**
1731
1777
  * Emitted when any modal is closed in the app
1732
1778
  *
1733
- * @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
1734
1780
  */
1735
1781
  DialogClose = "dialog-close",
1736
1782
  /**
@@ -1738,136 +1784,136 @@ export enum EmbedEvent {
1738
1784
  * You can use this event as a hook to trigger
1739
1785
  * other events on the rendered Liveboard.
1740
1786
  *
1741
- * @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
1742
1788
  */
1743
1789
  LiveboardRendered = "PinboardRendered",
1744
1790
  /**
1745
1791
  * This can be used to register an event listener which
1746
1792
  * is triggered on all events.
1747
1793
  *
1748
- * @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
1749
1795
  */
1750
1796
  ALL = "*",
1751
1797
  /**
1752
- * Emitted when answer is saved in the app
1798
+ * Emitted when an Answer is saved in the app
1753
1799
  *
1754
- * @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
1755
1801
  */
1756
1802
  Save = "save",
1757
1803
  /**
1758
1804
  * Emitted when the download action is triggered on an answer
1759
1805
  *
1760
- * @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
1761
1807
  */
1762
1808
  Download = "download",
1763
1809
  /**
1764
1810
  * Emitted when the download action is triggered on an answer
1765
1811
  *
1766
- * @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
1767
1813
  */
1768
1814
  DownloadAsPng = "downloadAsPng",
1769
1815
  /**
1770
1816
  * Emitted when the Download as PDF action is triggered on an answer
1771
1817
  *
1772
- * @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
1773
1819
  */
1774
1820
  DownloadAsPdf = "downloadAsPdf",
1775
1821
  /**
1776
1822
  * Emitted when the Download as CSV action is triggered on an answer
1777
1823
  *
1778
- * @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
1779
1825
  */
1780
1826
  DownloadAsCsv = "downloadAsCsv",
1781
1827
  /**
1782
1828
  * Emitted when the Download as XLSX action is triggered on an answer
1783
1829
  *
1784
- * @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
1785
1831
  */
1786
1832
  DownloadAsXlsx = "downloadAsXlsx",
1787
1833
  /**
1788
1834
  * Emitted when an answer is deleted in the app
1789
1835
  *
1790
- * @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
1791
1837
  */
1792
1838
  AnswerDelete = "answerDelete",
1793
1839
  /**
1794
1840
  * Emitted when an answer is pinned to a Liveboard
1795
1841
  *
1796
- * @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
1797
1843
  */
1798
1844
  Pin = "pin",
1799
1845
  /**
1800
1846
  * Emitted when SpotIQ analysis is triggered
1801
1847
  *
1802
- * @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
1803
1849
  */
1804
1850
  SpotIQAnalyze = "spotIQAnalyze",
1805
1851
  /**
1806
1852
  * Emitted when a user shares an object with another user or group
1807
1853
  *
1808
- * @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
1809
1855
  */
1810
1856
  Share = "share",
1811
1857
  /**
1812
1858
  * Emitted when a user clicks the Include action to include a specific value or data
1813
1859
  * on a chart or table
1814
1860
  *
1815
- * @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
1816
1862
  */
1817
1863
  DrillInclude = "context-menu-item-include",
1818
1864
  /**
1819
1865
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
1820
1866
  * on a chart or table
1821
1867
  *
1822
- * @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
1823
1869
  */
1824
1870
  DrillExclude = "context-menu-item-exclude",
1825
1871
  /**
1826
1872
  * Emitted when copied column value on the app
1827
1873
  *
1828
- * @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
1829
1875
  */
1830
1876
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
1831
1877
  /**
1832
1878
  * Emitted when a user clicks the Update TML action
1833
1879
  *
1834
- * @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
1835
1881
  */
1836
1882
  UpdateTML = "updateTSL",
1837
1883
  /**
1838
1884
  * Emitted when a user clicks the Edit TML action
1839
1885
  *
1840
- * @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
1841
1887
  */
1842
1888
  EditTML = "editTSL",
1843
1889
  /**
1844
1890
  * Emitted when ExportTML trigger in answer on the app
1845
1891
  *
1846
- * @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
1847
1893
  */
1848
1894
  ExportTML = "exportTSL",
1849
1895
  /**
1850
1896
  * Emitted when an answer is saved as a view
1851
1897
  *
1852
- * @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
1853
1899
  */
1854
1900
  SaveAsView = "saveAsView",
1855
1901
  /**
1856
1902
  * Emitted when copy of existing answer on the app
1857
1903
  *
1858
- * @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
1859
1905
  */
1860
1906
  CopyAEdit = "copyAEdit",
1861
1907
  /**
1862
1908
  * Emitted when a user clicks Show underlying data on an answe
1863
1909
  *
1864
- * @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
1865
1911
  */
1866
1912
  ShowUnderlyingData = "showUnderlyingData",
1867
1913
  /**
1868
1914
  * Emitted when an answer is switched to a chart or table view
1869
1915
  *
1870
- * @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
1871
1917
  */
1872
1918
  AnswerChartSwitcher = "answerChartSwitcher",
1873
1919
  /**
@@ -1879,67 +1925,67 @@ export enum EmbedEvent {
1879
1925
  /**
1880
1926
  * Emitted when a user clicks Show Liveboard details on a Liveboard
1881
1927
  *
1882
- * @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
1883
1929
  */
1884
1930
  LiveboardInfo = "pinboardInfo",
1885
1931
  /**
1886
1932
  * Emitted when a user clicks on the Favorite icon on a Liveboard
1887
1933
  *
1888
- * @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
1889
1935
  */
1890
1936
  AddToFavorites = "addToFavorites",
1891
1937
  /**
1892
1938
  * Emitted when a user clicks Schedule on a Liveboard
1893
1939
  *
1894
- * @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
1895
1941
  */
1896
1942
  Schedule = "subscription",
1897
1943
  /**
1898
1944
  * Emitted when a user clicks Edit on a Liveboard or visualization
1899
1945
  *
1900
- * @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
1901
1947
  */
1902
1948
  Edit = "edit",
1903
1949
  /**
1904
1950
  * Emitted when a user clicks Make a copy on a Liveboard
1905
1951
  *
1906
- * @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
1907
1953
  */
1908
1954
  MakeACopy = "makeACopy",
1909
1955
  /**
1910
1956
  * Emitted when a user clicks Present on a Liveboard or visualization
1911
1957
  *
1912
- * @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
1913
1959
  */
1914
1960
  Present = "present",
1915
1961
  /**
1916
1962
  * Emitted when a user clicks Delete on a Liveboard
1917
1963
  *
1918
- * @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
1919
1965
  */
1920
1966
  Delete = "delete",
1921
1967
  /**
1922
1968
  * Emitted when a user clicks Manage schedules on a Liveboard
1923
1969
  *
1924
- * @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
1925
1971
  */
1926
1972
  SchedulesList = "schedule-list",
1927
1973
  /**
1928
1974
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
1929
1975
  *
1930
- * @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
1931
1977
  */
1932
1978
  Cancel = "cancel",
1933
1979
  /**
1934
1980
  * Emitted when a user clicks Explore on a visualization
1935
1981
  *
1936
- * @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
1937
1983
  */
1938
1984
  Explore = "explore",
1939
1985
  /**
1940
1986
  * Emitted when a user clicks Copy link action on a visualization
1941
1987
  *
1942
- * @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
1943
1989
  */
1944
1990
  CopyLink = "embedDocument",
1945
1991
  /**
@@ -1959,7 +2005,13 @@ export enum EmbedEvent {
1959
2005
  *
1960
2006
  * @hidden
1961
2007
  */
1962
- 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"
1963
2015
  }
1964
2016
  /**
1965
2017
  * Event types that can be triggered by the host application
@@ -1985,13 +2037,14 @@ export enum EmbedEvent {
1985
2037
  */
1986
2038
  export enum HostEvent {
1987
2039
  /**
1988
- * Trigger a search
1989
- *
2040
+ * Triggers a search query in AppEmbed and SearchEmbed
2041
+ * deployments.
2042
+ * Includes the following properties:
1990
2043
  * @param - dataSourceIds - The data source GUID to Search on
1991
2044
  * - Although an array, only a single source
1992
- * is supported at this time.
1993
- * @param - searchQuery - The search query
1994
- * @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
1995
2048
  * @example
1996
2049
  * ```js
1997
2050
  * searchEmbed.trigger(HostEvent.Search, {
@@ -2003,13 +2056,13 @@ export enum HostEvent {
2003
2056
  */
2004
2057
  Search = "search",
2005
2058
  /**
2006
- * Trigger a drill on certain points by certain column
2007
- *
2059
+ * Triggers a drill on certain points of the specified column
2060
+ * Includes the following properties:
2008
2061
  * @param - points - an object containing selectedPoints/clickedPoints
2009
- * eg. { selectedPoints: []}
2010
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
2011
- * if not provided it will auto drill by the configured
2012
- * 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.
2013
2066
  * @example
2014
2067
  * ```js
2015
2068
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -2042,17 +2095,17 @@ export enum HostEvent {
2042
2095
  */
2043
2096
  Reload = "reload",
2044
2097
  /**
2045
- * Set the visible visualizations on a Liveboard.
2098
+ * Sets the visible visualizations on a Liveboard.
2046
2099
  *
2047
- * @param - an array of ids of visualizations to show, the ids not passed
2048
- * 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.
2049
2102
  * @example
2050
2103
  * ```js
2051
2104
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
2052
2105
  * '730496d6-6903-4601-937e-2c691821af3c',
2053
2106
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
2054
2107
  * ```
2055
- * @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
2056
2109
  */
2057
2110
  SetVisibleVizs = "SetPinboardVisibleVizs",
2058
2111
  /**
@@ -2069,9 +2122,18 @@ export enum HostEvent {
2069
2122
  */
2070
2123
  SetActiveTab = "SetActiveTab",
2071
2124
  /**
2072
- * Update the runtime filters. The runtime filters passed here are extended
2073
- * on to the existing runtime filters if they exist.
2074
- *
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.
2075
2137
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
2076
2138
  * @example
2077
2139
  * ```js
@@ -2080,25 +2142,24 @@ export enum HostEvent {
2080
2142
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
2081
2143
  * ])
2082
2144
  * ```
2083
- * @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
2084
2146
  * @important
2085
2147
  */
2086
2148
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
2087
2149
  /**
2088
- * 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.
2089
2151
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
2090
- *
2091
2152
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
2092
2153
  * @example
2093
2154
  * ```js
2094
2155
  * appEmbed.navigateToPage(-1)
2095
2156
  * ```
2096
- * @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
2097
2158
  */
2098
2159
  Navigate = "Navigate",
2099
2160
  /**
2100
2161
  * Opens the filter panel for a particular column.
2101
- * Works with Search embed.
2162
+ * Works with Search and Liveboard embed.
2102
2163
  *
2103
2164
  * @param - { columnId: string,
2104
2165
  * name: string,
@@ -2107,233 +2168,257 @@ export enum HostEvent {
2107
2168
  * @example
2108
2169
  * ```js
2109
2170
  * searchEmbed.trigger(HostEvent.OpenFilter,
2110
- * { 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>'})
2111
2174
  * ```
2112
2175
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2113
2176
  */
2114
2177
  OpenFilter = "openFilter",
2115
2178
  /**
2116
- * Adds the columns to the current Search.
2179
+ * Adds columns to the current search query.
2117
2180
  *
2118
2181
  * @param - { columnIds: string[] }
2119
2182
  * @example
2120
2183
  * ```js
2121
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
2184
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
2122
2185
  * ```
2123
2186
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2124
2187
  */
2125
2188
  AddColumns = "addColumns",
2126
2189
  /**
2127
- * Removes a column from the current Search.
2190
+ * Removes a column from the current search query.
2128
2191
  *
2129
2192
  * @param - { columnId: string }
2130
2193
  * @example
2131
2194
  * ```js
2132
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
2195
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
2133
2196
  * ```
2134
2197
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2135
2198
  */
2136
2199
  RemoveColumn = "removeColumn",
2137
2200
  /**
2138
- * Gets the current pinboard content.
2201
+ * Gets the current Liveboard content.
2139
2202
  *
2140
2203
  * @example
2141
2204
  * ```js
2142
2205
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
2143
2206
  * ```
2144
- * @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
2145
2208
  */
2146
2209
  getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
2147
2210
  /**
2148
- * Triggers the Pin action on an embedded object
2211
+ * Triggers the **Pin** action on an embedded object
2149
2212
  *
2150
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2151
- * 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.
2152
2216
  * @example
2153
2217
  * ```js
2154
2218
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2219
+ * ```
2220
+ * ```js
2155
2221
  * vizEmbed.trigger(HostEvent.Pin)
2222
+ * ```
2223
+ * ```js
2156
2224
  * searchEmbed.trigger(HostEvent.Pin)
2157
2225
  * ```
2158
- * @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
2159
2227
  */
2160
2228
  Pin = "pin",
2161
2229
  /**
2162
- * Triggers the Show Liveboard details action on a Liveboard
2230
+ * Triggers the **Show Liveboard details** action on a Liveboard
2163
2231
  *
2164
2232
  * @example
2165
2233
  * ```js
2166
2234
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
2167
2235
  * ```
2168
- * @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
2169
2237
  */
2170
2238
  LiveboardInfo = "pinboardInfo",
2171
2239
  /**
2172
- * Triggers the Schedule action on a Liveboard
2240
+ * Triggers the **Schedule** action on a Liveboard
2173
2241
  *
2174
2242
  * @example
2175
2243
  * ```js
2176
2244
  * liveboardEmbed.trigger(HostEvent.Schedule)
2177
2245
  * ```
2178
- * @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
2179
2247
  */
2180
2248
  Schedule = "subscription",
2181
2249
  /**
2182
- * Triggers the Manage schedule action on a Liveboard
2250
+ * Triggers the **Manage schedule** action on a Liveboard
2183
2251
  *
2184
2252
  * @example
2185
2253
  * ```js
2186
2254
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
2187
2255
  * ```
2188
- * @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
2189
2257
  */
2190
2258
  SchedulesList = "schedule-list",
2191
2259
  /**
2192
- * Triggers the Export TML action on a Liveboard
2260
+ * Triggers the **Export TML** action on a Liveboard
2193
2261
  *
2194
2262
  * @example
2195
2263
  * ```js
2196
2264
  * liveboardEmbed.trigger(HostEvent.ExportTML)
2197
2265
  * ```
2198
- * @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
2199
2267
  */
2200
2268
  ExportTML = "exportTSL",
2201
2269
  /**
2202
- * Triggers the Edit TML action on a Liveboard
2270
+ * Triggers the **Edit TML** action on a Liveboard
2203
2271
  *
2204
2272
  * @example
2205
2273
  * ```js
2206
2274
  * liveboardEmbed.trigger(HostEvent.EditTML)
2207
2275
  * ```
2208
- * @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
2209
2277
  */
2210
2278
  EditTML = "editTSL",
2211
2279
  /**
2212
- * Triggers the Update TML action on a Liveboard
2280
+ * Triggers the **Update TML** action on a Liveboard
2213
2281
  *
2214
2282
  * @example
2215
2283
  * ```js
2216
2284
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
2217
2285
  * ```
2218
- * @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
2219
2287
  */
2220
2288
  UpdateTML = "updateTSL",
2221
2289
  /**
2222
- * Triggers the Download PDF action on a Liveboard
2290
+ * Triggers the **Download PDF** action on a Liveboard
2223
2291
  *
2224
2292
  * @example
2225
2293
  * ```js
2226
2294
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
2227
2295
  * ```
2228
- * @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
2229
2297
  */
2230
2298
  DownloadAsPdf = "downloadAsPdf",
2231
2299
  /**
2232
- * 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
2233
2302
  *
2234
2303
  * @example
2235
2304
  * ```js
2236
2305
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2306
+ * ```
2307
+ * ```js
2237
2308
  * vizEmbed.trigger(HostEvent.MakeACopy)
2309
+ * ```
2310
+ * ```js
2238
2311
  * searchEmbed.trigger(HostEvent.MakeACopy)
2239
2312
  * ```
2240
- * @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
2241
2314
  */
2242
2315
  MakeACopy = "makeACopy",
2243
2316
  /**
2244
- * Triggers the Delete action on a Liveboard
2317
+ * Triggers the **Delete** action on a Liveboard
2245
2318
  *
2246
2319
  * @example
2247
2320
  * ```js
2248
2321
  * appEmbed.trigger(HostEvent.Remove)
2249
2322
  * ```
2250
- * @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
2251
2324
  */
2252
2325
  Remove = "delete",
2253
2326
  /**
2254
- * Triggers the Explore action on a visualization
2327
+ * Triggers the **Explore* action on a visualization
2255
2328
  *
2256
- * @param - an object with vizId as a key
2329
+ * @param - an object with `vizId` as a key
2257
2330
  * @example
2258
2331
  * ```js
2259
2332
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2260
2333
  * ```
2261
- * @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
2262
2335
  */
2263
2336
  Explore = "explore",
2264
2337
  /**
2265
- * Triggers the Create alert action on a visualization
2338
+ * Triggers the **Create alert** action on a visualization
2266
2339
  *
2267
- * @param - an object with vizId as a key
2340
+ * @param - an object with `vizId` as a key
2268
2341
  * @example
2269
2342
  * ```js
2270
2343
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
2271
2344
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2272
2345
  * })
2273
2346
  * ```
2274
- * @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
2275
2348
  */
2276
2349
  CreateMonitor = "createMonitor",
2277
2350
  /**
2278
- * Triggers the Manage alert action on a visualization
2351
+ * Triggers the **Manage alerts** action on a visualization
2279
2352
  *
2280
- * @param - an object with vizId as a key
2353
+ * @param - an object with `vizId` as a key
2281
2354
  * @example
2282
2355
  * ```js
2283
2356
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
2284
2357
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2285
2358
  * })
2286
2359
  * ```
2287
- * @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
2288
2361
  */
2289
2362
  ManageMonitor = "manageMonitor",
2290
2363
  /**
2291
- * Triggers the Edit action on a Liveboard or visualization
2364
+ * Triggers the **Edit** action on a Liveboard or visualization
2292
2365
  *
2293
- * @param - object - to trigger the action for a specfic visualization
2294
- * 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.
2295
2370
  * @example
2296
2371
  * ```js
2297
2372
  * liveboardEmbed.trigger(HostEvent.Edit)
2298
- *
2373
+ * ```
2374
+ * ```js
2299
2375
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
2300
2376
  * '730496d6-6903-4601-937e-2c691821af3c'})
2301
- *
2377
+ * ```
2378
+ * ```js
2302
2379
  * vizEmbed.trigger((HostEvent.Edit)
2303
2380
  * ```
2304
- * @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
2305
2382
  */
2306
2383
  Edit = "edit",
2307
2384
  /**
2308
- * Triggers the Copy link action on a Liveboard or visualization
2385
+ * Triggers the **Copy link** action on a Liveboard or visualization
2309
2386
  *
2310
- * @param - object - to trigger the action for a s
2311
- * 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
2312
2389
  * @example
2313
2390
  * ```js
2314
2391
  * liveboardEmbed.trigger(HostEvent.CopyLink)
2392
+ * ```
2393
+ * ```js
2315
2394
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2395
+ * ```
2396
+ * ```js
2316
2397
  * vizEmbed.trigger((HostEvent.CopyLink)
2317
2398
  * ```
2318
- * @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
2319
2400
  */
2320
2401
  CopyLink = "embedDocument",
2321
2402
  /**
2322
- * Triggers the Present action on a Liveboard or visualization
2403
+ * Triggers the **Present** action on a Liveboard or visualization
2323
2404
  *
2324
- * @param - object - to trigger the action for a specfic visualization
2325
- * 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
2326
2407
  * @example
2327
2408
  * ```js
2328
2409
  * liveboardEmbed.trigger(HostEvent.Present)
2410
+ * ```
2411
+ * ```js
2329
2412
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2413
+ * ```
2414
+ * ```js
2330
2415
  * vizEmbed.trigger((HostEvent.Present)
2331
2416
  * ```
2332
- * @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
2333
2418
  */
2334
2419
  Present = "present",
2335
2420
  /**
2336
- * Get TML for the current search.
2421
+ * Gets TML for the current search.
2337
2422
  *
2338
2423
  * @example
2339
2424
  * ```js
@@ -2343,79 +2428,89 @@ export enum HostEvent {
2343
2428
  * );
2344
2429
  * })
2345
2430
  * ```
2346
- * @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
2347
2432
  * @important
2348
2433
  */
2349
2434
  GetTML = "getTML",
2350
2435
  /**
2351
- * Triggers the ShowUnderlyingData action on visualization or search
2436
+ * Triggers the **Show underlying data** action on visualization or search
2352
2437
  *
2353
2438
  * @param - an object with vizId as a key
2354
2439
  * @example
2355
2440
  * ```js
2356
2441
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
2357
2442
  * '730496d6-6903-4601-937e-2c691821af3c'})
2358
- *
2443
+ * ```
2444
+ * ```js
2359
2445
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
2360
- *
2446
+ * ```
2447
+ * ```js
2361
2448
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
2362
2449
  * ```
2363
- * @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
2364
2451
  */
2365
2452
  ShowUnderlyingData = "showUnderlyingData",
2366
2453
  /**
2367
- * Triggers the Delete action on visualization or search
2454
+ * Triggers the **Delete** action on visualization or search
2368
2455
  *
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
2456
+ * @param - Liveboard embed takes an object with `vizId` as a key.
2457
+ * Can be left empty if embedding Search or visualization.
2371
2458
  * @example
2372
2459
  * ```js
2373
2460
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
2374
2461
  * '730496d6-6903-4601-937e-2c691821af3c'})
2375
- *
2462
+ * ```
2463
+ * ```js
2376
2464
  * vizEmbed.trigger(HostEvent.Delete)
2377
- *
2465
+ * ```
2466
+ * ```js
2378
2467
  * searchEmbed.trigger(HostEvent.Delete)
2379
2468
  * ```
2380
- * @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
2381
2470
  */
2382
2471
  Delete = "onDeleteAnswer",
2383
2472
  /**
2384
- * Triggers the SpotIQAnalyze action on visualization or search
2385
- *
2386
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2387
- * 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.
2388
2478
  * @example
2389
2479
  * ```js
2390
2480
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
2391
2481
  * '730496d6-6903-4601-937e-2c691821af3c'})
2392
- *
2482
+ * ```
2483
+ * ```js
2393
2484
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
2394
- *
2485
+ * ```
2486
+ * ```js
2395
2487
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
2396
2488
  * ```
2397
- * @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
2398
2490
  */
2399
2491
  SpotIQAnalyze = "spotIQAnalyze",
2400
2492
  /**
2401
- * Triggers the Download action on visualization or search when Displaymode is Chart
2493
+ * Triggers the **Download** action on charts in
2494
+ * the embedded view.
2402
2495
  *
2403
2496
  * @example
2404
2497
  * ```js
2405
2498
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
2406
2499
  * '730496d6-6903-4601-937e-2c691821af3c'})
2407
- *
2500
+ * ```
2501
+ * ```js
2408
2502
  * vizEmbed.trigger(HostEvent.Download)
2409
- *
2503
+ * ```
2504
+ * ```js
2410
2505
  * searchEmbed.trigger(HostEvent.Download)
2411
2506
  * ```
2412
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
2413
- * @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
2414
2509
  */
2415
2510
  Download = "downloadAsPng",
2416
2511
  /**
2417
- * Triggers the Download action on visualization or search when Displaymode is Chart
2418
- *
2512
+ * Triggers the **Download** > **PNG** action on
2513
+ * charts in the embedded view.
2419
2514
  * @example
2420
2515
  * ```js
2421
2516
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -2425,115 +2520,179 @@ export enum HostEvent {
2425
2520
  *
2426
2521
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
2427
2522
  * ```
2428
- * @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
2429
2524
  */
2430
2525
  DownloadAsPng = "downloadAsPng",
2431
2526
  /**
2432
- * Triggers the downloadAsCSV action on visualization or search
2527
+ * Triggers the **Download** > **CSV** action on tables in
2528
+ * the embedded view.
2433
2529
  *
2434
2530
  * @example
2435
2531
  * ```js
2436
2532
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
2437
2533
  * '730496d6-6903-4601-937e-2c691821af3c'})
2438
- *
2534
+ * ```
2535
+ * ```js
2439
2536
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
2440
- *
2537
+ * ```
2538
+ * ```js
2441
2539
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
2442
2540
  * ```
2443
- * @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
2444
2542
  */
2445
2543
  DownloadAsCsv = "downloadAsCSV",
2446
2544
  /**
2447
- * Triggers the downloadAsXLSX action on visualization or search
2448
- *
2545
+ * Triggers the **Download** > **XLSX** action on tables
2546
+ * in the embedded view.
2449
2547
  * @example
2450
2548
  * ```js
2451
2549
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
2452
2550
  * '730496d6-6903-4601-937e-2c691821af3c'})
2453
- *
2551
+ * ```
2552
+ * ```js
2454
2553
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
2455
- *
2554
+ * ```
2555
+ * ```js
2456
2556
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
2457
2557
  * ```
2458
- * @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
2459
2559
  */
2460
2560
  DownloadAsXlsx = "downloadAsXLSX",
2461
2561
  /**
2462
- * Triggers the Share action on a liveboard or answer
2562
+ * Triggers the **Share** action on an embedded
2563
+ * Liveboard or Answer.
2463
2564
  *
2464
2565
  * @example
2465
2566
  * ```js
2466
2567
  * liveboardEmbed.trigger(HostEvent.Share)
2467
- *
2568
+ * ```
2569
+ * ```js
2468
2570
  * searchEmbed.trigger(HostEvent.Share)
2469
2571
  * ```
2470
- * @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
2471
2573
  */
2472
2574
  Share = "share",
2473
2575
  /**
2474
- * Trigger the Save action on a liveboard or answer
2475
- *
2576
+ * Triggers the **Save** action on a Liveboard or Answer.
2577
+ * Saves the changes.
2476
2578
  * @example
2477
2579
  * ```js
2478
2580
  * liveboardEmbed.trigger(HostEvent.Save)
2479
- *
2581
+ * ```
2582
+ * ```js
2480
2583
  * searchEmbed.trigger(HostEvent.Save)
2481
2584
  * ```
2482
- * @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
2483
2586
  */
2484
2587
  Save = "save",
2485
2588
  /**
2486
- * Triggers the SyncToSheets action on visualization
2487
- *
2488
- * @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
2489
2592
  * @example
2490
2593
  * ```js
2491
2594
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
2492
2595
  * '730496d6-6903-4601-937e-2c691821af3c'})
2493
- *
2596
+ * ```
2597
+ * ```js
2494
2598
  * vizEmbed.trigger(HostEvent.SyncToSheets)
2495
2599
  * ```
2496
- * @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
2497
2601
  */
2498
2602
  SyncToSheets = "sync-to-sheets",
2499
2603
  /**
2500
- * Triggers the SyncToOtherApps action on visualization
2501
- *
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.
2502
2607
  * @param - an object with vizId as a key
2503
2608
  * @example
2504
2609
  * ```js
2505
2610
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
2506
2611
  * '730496d6-6903-4601-937e-2c691821af3c'})
2507
- *
2612
+ * ```
2613
+ * ```js
2508
2614
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
2509
2615
  * ```
2510
- * @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
2511
2617
  */
2512
2618
  SyncToOtherApps = "sync-to-other-apps",
2513
2619
  /**
2514
- * Triggers the ManagePipelines action on visualization
2515
- *
2516
- * @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
2517
2624
  * @example
2518
2625
  * ```js
2519
2626
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
2520
2627
  * '730496d6-6903-4601-937e-2c691821af3c'})
2521
- *
2628
+ * ```
2629
+ * ```js
2522
2630
  * vizEmbed.trigger(HostEvent.ManagePipelines)
2523
2631
  * ```
2524
- * @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
2525
2633
  */
2526
2634
  ManagePipelines = "manage-pipeline",
2527
2635
  /**
2528
- * Triggers the Reset search in answer
2636
+ * Triggers the Reset search on the Search page
2529
2637
  *
2530
2638
  * @example
2531
2639
  * ```js
2532
2640
  * searchEmbed.trigger(HostEvent.ResetSearch)
2533
2641
  * ```
2534
- * @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
2535
2643
  */
2536
- ResetSearch = "resetSearch"
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
2651
+ */
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"
2537
2696
  }
2538
2697
  /**
2539
2698
  * The different visual modes that the data sources panel within
@@ -2610,26 +2769,47 @@ export enum Param {
2610
2769
  HideEurekaSuggestions = "hideEurekaSuggestions",
2611
2770
  HideLiveboardHeader = "hideLiveboardHeader",
2612
2771
  ShowLiveboardDescription = "showLiveboardDescription",
2613
- ShowLiveboardTitle = "showLiveboardTitle"
2772
+ ShowLiveboardTitle = "showLiveboardTitle",
2773
+ HiddenTabs = "hideTabs",
2774
+ VisibleTabs = "visibleTabs",
2775
+ HideTabPanel = "hideTabPanel"
2614
2776
  }
2615
2777
  /**
2616
- * The list of actions that can be performed on visual ThoughtSpot
2617
- * entities, such as answers and Liveboards.
2618
- *
2619
- * This enum is used to specify the actions that could be disabled,
2620
- * hidden or made visible.
2621
- *
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.
2622
2784
  * @example
2623
2785
  * ```js
2624
2786
  * const embed = new LiveboardEmbed('#embed-container', {
2625
2787
  * ... // other options
2626
- * visibleActions: [Action.Save, Action.Explore],
2627
- * disableActions: [Action.Save],
2628
- * 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
2629
2791
  * })
2630
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
+
2631
2803
  */
2632
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
+ */
2633
2813
  Save = "save",
2634
2814
  /**
2635
2815
  * @hidden
@@ -2639,27 +2819,137 @@ export enum Action {
2639
2819
  * @hidden
2640
2820
  */
2641
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
+ */
2642
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
+ */
2643
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
+ */
2644
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
+ */
2645
2862
  CopyLink = "embedDocument",
2646
2863
  /**
2647
2864
  * @hidden
2648
2865
  */
2649
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
+ */
2650
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
+ */
2651
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
+ */
2652
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
+ */
2653
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
+ */
2654
2912
  ConfigureFilter = "configureFilter",
2655
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
+ */
2656
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
+ */
2657
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
+ */
2658
2940
  AddParameter = "addParameter",
2659
2941
  /**
2660
2942
  * @hidden
2661
2943
  */
2662
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
+ */
2663
2953
  SpotIQAnalyze = "spotIQAnalyze",
2664
2954
  /**
2665
2955
  * @hidden
@@ -2674,24 +2964,150 @@ export enum Action {
2674
2964
  * @hidden
2675
2965
  */
2676
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
+ */
2677
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
+ */
2678
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
+ */
2679
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
+ */
2680
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
+ */
2681
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
+ */
2682
3024
  DownloadAsXlsx = "downloadAsXLSX",
2683
3025
  /**
2684
3026
  * @hidden
2685
3027
  */
2686
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
+ */
2687
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
+ */
2688
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
+ */
2689
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
+ */
2690
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
+ */
2691
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
+ */
2692
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
+ */
2693
3094
  Edit = "edit",
3095
+ /**
3096
+ * The text edit option for Liveboard and visualization titles.
3097
+ * @example
3098
+ * ```js
3099
+ * disabledActions: [Action.EditTitle]
3100
+ * ```
3101
+ */
2694
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
+ */
2695
3111
  Remove = "delete",
2696
3112
  /**
2697
3113
  * @hidden
@@ -2713,6 +3129,16 @@ export enum Action {
2713
3129
  * @hidden
2714
3130
  */
2715
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
+ */
2716
3142
  LiveboardInfo = "pinboardInfo",
2717
3143
  /**
2718
3144
  * @hidden
@@ -2723,20 +3149,61 @@ export enum Action {
2723
3149
  */
2724
3150
  DownloadEmbraceQueries = "downloadEmbraceQueries",
2725
3151
  /**
2726
- * Pin action.
2727
- */
3152
+ * The **Pin** menu action on an Answer or
3153
+ * Search results page.
3154
+ * @example
3155
+ * ```js
3156
+ * disabledActions: [Action.Pin]
3157
+ * ```
3158
+ */
2728
3159
  Pin = "pin",
2729
3160
  /**
2730
3161
  * @hidden
2731
3162
  */
2732
3163
  AnalysisInfo = "analysisInfo",
2733
- Subscription = "subscription",
2734
3164
  /**
2735
- * Explore action.
3165
+ * The **Schedule** menu action on a Liveboard.
3166
+ * @example
3167
+ * ```js
3168
+ * disabledActions: [Action.Subscription]
3169
+ * ```
2736
3170
  */
3171
+ Subscription = "subscription",
3172
+ /**
3173
+ * The **Explore** action on Liveboard visualizations
3174
+ * @example
3175
+ * ```js
3176
+ * disabledActions: [Action.Explore]
3177
+ * ```
3178
+ */
2737
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
+ */
2738
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
+ */
2739
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
+ */
2740
3207
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
2741
3208
  CopyAndEdit = "context-menu-item-copy-and-edit",
2742
3209
  /**
@@ -2745,89 +3212,266 @@ export enum Action {
2745
3212
  DrillEdit = "context-menu-item-edit",
2746
3213
  EditMeasure = "context-menu-item-edit-measure",
2747
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
+ */
2748
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
+ */
2749
3233
  RequestAccess = "requestAccess",
2750
- QueryDetailsButtons = "queryDetailsButtons",
2751
3234
  /**
2752
- * @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
2753
3250
  */
2754
3251
  AnswerDelete = "onDeleteAnswer",
2755
3252
  /**
2756
- * @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
2757
3259
  */
2758
3260
  AnswerChartSwitcher = "answerChartSwitcher",
2759
3261
  /**
2760
- * @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
2761
3268
  */
2762
3269
  AddToFavorites = "addToFavorites",
2763
3270
  /**
2764
- * @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
2765
3277
  */
2766
3278
  EditDetails = "editDetails",
2767
3279
  /**
2768
- * @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
2769
3286
  */
2770
3287
  CreateMonitor = "createMonitor",
2771
3288
  /**
2772
- * @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
2773
3294
  */
2774
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
+ */
2775
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
+ */
2776
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
+ */
2777
3326
  ManagePipelines = "manage-pipeline",
2778
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
+ * ```
2779
3334
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2780
3335
  */
2781
3336
  CrossFilter = "context-menu-item-cross-filter",
2782
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
+ * ```
2783
3345
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2784
3346
  */
2785
3347
  RemoveCrossFilter = "context-menu-item-remove-cross-filter",
2786
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
+ * ```
2787
3356
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2788
3357
  */
2789
3358
  AxisMenuAggregate = "axisMenuAggregate",
2790
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
+ * ```
2791
3367
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2792
3368
  */
2793
3369
  AxisMenuTimeBucket = "axisMenuTimeBucket",
2794
3370
  /**
3371
+ * The **Filter** action in the chart axis or table column
3372
+ * customization menu.
3373
+ * @example
3374
+ * ```js
3375
+ * disabledActions: [Action.AxisMenuFilter]
3376
+ * ```
2795
3377
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2796
3378
  */
2797
3379
  AxisMenuFilter = "axisMenuFilter",
2798
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
+ * ```
2799
3388
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2800
3389
  */
2801
3390
  AxisMenuConditionalFormat = "axisMenuConditionalFormat",
2802
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
+ * ```
2803
3399
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2804
3400
  */
2805
3401
  AxisMenuSort = "axisMenuSort",
2806
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
+ * ```
2807
3411
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2808
3412
  */
2809
3413
  AxisMenuGroup = "axisMenuGroup",
2810
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
+ * ```
2811
3422
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2812
3423
  */
2813
3424
  AxisMenuPosition = "axisMenuPosition",
2814
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
+ * ```
2815
3432
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2816
3433
  */
2817
3434
  AxisMenuRename = "axisMenuRename",
2818
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
+ * ```
2819
3443
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2820
3444
  */
2821
3445
  AxisMenuEdit = "axisMenuEdit",
2822
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
+ * ```
2823
3453
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2824
3454
  */
2825
3455
  AxisMenuNumberFormat = "axisMenuNumberFormat",
2826
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
+ * ```
2827
3463
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2828
3464
  */
2829
3465
  AxisMenuTextWrapping = "axisMenuTextWrapping",
2830
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
+ * ```
2831
3475
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2832
3476
  */
2833
3477
  AxisMenuRemove = "axisMenuRemove",
@@ -2836,9 +3480,31 @@ export enum Action {
2836
3480
  */
2837
3481
  InsertInToSlide = "insertInToSlide",
2838
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
+ * ```
2839
3489
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2840
3490
  */
2841
- 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"
2842
3508
  }
2843
3509
  export interface SessionInterface {
2844
3510
  sessionId: string;
@@ -2993,7 +3659,7 @@ export interface CustomCssVariables {
2993
3659
  * Background color of the primary buttons. For example, the primary buttons such as
2994
3660
  * Pin* and *Save*.
2995
3661
  */
2996
- '---ts-var-button--primary-background'?: string;
3662
+ '--ts-var-button--primary-background'?: string;
2997
3663
  /**
2998
3664
  * Background color of the primary buttons on hover.
2999
3665
  */
@@ -3209,6 +3875,7 @@ export const HiddenActionItemByDefaultForSageEmbed: Action[];
3209
3875
  /**
3210
3876
  * Embed ThoughtSpot LLM and GPT based natural language search component.
3211
3877
  *
3878
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
3212
3879
  * @group Embed components
3213
3880
  */
3214
3881
  export class SageEmbed extends V1Embed {