@thoughtspot/visual-embed-sdk 1.23.0-alpha.0 → 1.23.1

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 (113) 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/app.d.ts +1 -1
  6. package/cjs/src/embed/app.d.ts.map +1 -1
  7. package/cjs/src/embed/app.js +1 -1
  8. package/cjs/src/embed/app.js.map +1 -1
  9. package/cjs/src/embed/base.d.ts +8 -0
  10. package/cjs/src/embed/base.d.ts.map +1 -1
  11. package/cjs/src/embed/base.js +8 -0
  12. package/cjs/src/embed/base.js.map +1 -1
  13. package/cjs/src/embed/liveboard.d.ts +6 -0
  14. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  15. package/cjs/src/embed/liveboard.js +4 -1
  16. package/cjs/src/embed/liveboard.js.map +1 -1
  17. package/cjs/src/embed/liveboard.spec.js +12 -0
  18. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  19. package/cjs/src/embed/sage.d.ts +15 -0
  20. package/cjs/src/embed/sage.d.ts.map +1 -1
  21. package/cjs/src/embed/sage.js +13 -3
  22. package/cjs/src/embed/sage.js.map +1 -1
  23. package/cjs/src/embed/sage.spec.js +1 -1
  24. package/cjs/src/embed/sage.spec.js.map +1 -1
  25. package/cjs/src/embed/search.d.ts +4 -0
  26. package/cjs/src/embed/search.d.ts.map +1 -1
  27. package/cjs/src/embed/search.js +1 -1
  28. package/cjs/src/embed/search.js.map +1 -1
  29. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  30. package/cjs/src/embed/ts-embed.js +11 -1
  31. package/cjs/src/embed/ts-embed.js.map +1 -1
  32. package/cjs/src/embed/ts-embed.spec.js +69 -0
  33. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  34. package/cjs/src/react/index.spec.js +12 -0
  35. package/cjs/src/react/index.spec.js.map +1 -1
  36. package/cjs/src/types.d.ts +972 -199
  37. package/cjs/src/types.d.ts.map +1 -1
  38. package/cjs/src/types.js +914 -180
  39. package/cjs/src/types.js.map +1 -1
  40. package/dist/src/css-variables.d.ts +1 -1
  41. package/dist/src/css-variables.d.ts.map +1 -1
  42. package/dist/src/embed/app.d.ts +1 -1
  43. package/dist/src/embed/app.d.ts.map +1 -1
  44. package/dist/src/embed/base.d.ts +8 -0
  45. package/dist/src/embed/base.d.ts.map +1 -1
  46. package/dist/src/embed/liveboard.d.ts +6 -0
  47. package/dist/src/embed/liveboard.d.ts.map +1 -1
  48. package/dist/src/embed/sage.d.ts +15 -0
  49. package/dist/src/embed/sage.d.ts.map +1 -1
  50. package/dist/src/embed/search.d.ts +4 -0
  51. package/dist/src/embed/search.d.ts.map +1 -1
  52. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  53. package/dist/src/types.d.ts +972 -199
  54. package/dist/src/types.d.ts.map +1 -1
  55. package/dist/tsembed-react.es.js +945 -188
  56. package/dist/tsembed-react.js +927 -180
  57. package/dist/tsembed.es.js +953 -188
  58. package/dist/tsembed.js +935 -180
  59. package/dist/visual-embed-sdk-react-full.d.ts +1008 -202
  60. package/dist/visual-embed-sdk-react.d.ts +1018 -212
  61. package/dist/visual-embed-sdk.d.ts +1018 -212
  62. package/lib/package.json +8 -1
  63. package/lib/src/css-variables.d.ts +1 -1
  64. package/lib/src/css-variables.d.ts.map +1 -1
  65. package/lib/src/embed/app.d.ts +1 -1
  66. package/lib/src/embed/app.d.ts.map +1 -1
  67. package/lib/src/embed/app.js +1 -1
  68. package/lib/src/embed/app.js.map +1 -1
  69. package/lib/src/embed/base.d.ts +8 -0
  70. package/lib/src/embed/base.d.ts.map +1 -1
  71. package/lib/src/embed/base.js +8 -0
  72. package/lib/src/embed/base.js.map +1 -1
  73. package/lib/src/embed/liveboard.d.ts +6 -0
  74. package/lib/src/embed/liveboard.d.ts.map +1 -1
  75. package/lib/src/embed/liveboard.js +4 -1
  76. package/lib/src/embed/liveboard.js.map +1 -1
  77. package/lib/src/embed/liveboard.spec.js +12 -0
  78. package/lib/src/embed/liveboard.spec.js.map +1 -1
  79. package/lib/src/embed/sage.d.ts +15 -0
  80. package/lib/src/embed/sage.d.ts.map +1 -1
  81. package/lib/src/embed/sage.js +13 -3
  82. package/lib/src/embed/sage.js.map +1 -1
  83. package/lib/src/embed/sage.spec.js +1 -1
  84. package/lib/src/embed/sage.spec.js.map +1 -1
  85. package/lib/src/embed/search.d.ts +4 -0
  86. package/lib/src/embed/search.d.ts.map +1 -1
  87. package/lib/src/embed/search.js +1 -1
  88. package/lib/src/embed/search.js.map +1 -1
  89. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  90. package/lib/src/embed/ts-embed.js +11 -1
  91. package/lib/src/embed/ts-embed.js.map +1 -1
  92. package/lib/src/embed/ts-embed.spec.js +69 -0
  93. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  94. package/lib/src/react/index.spec.js +12 -0
  95. package/lib/src/react/index.spec.js.map +1 -1
  96. package/lib/src/types.d.ts +972 -199
  97. package/lib/src/types.d.ts.map +1 -1
  98. package/lib/src/types.js +914 -180
  99. package/lib/src/types.js.map +1 -1
  100. package/lib/src/visual-embed-sdk.d.ts +1018 -212
  101. package/package.json +8 -1
  102. package/src/css-variables.ts +1 -1
  103. package/src/embed/app.ts +1 -1
  104. package/src/embed/base.ts +8 -0
  105. package/src/embed/liveboard.spec.ts +16 -0
  106. package/src/embed/liveboard.ts +10 -0
  107. package/src/embed/sage.spec.ts +1 -1
  108. package/src/embed/sage.ts +25 -2
  109. package/src/embed/search.ts +5 -0
  110. package/src/embed/ts-embed.spec.ts +79 -0
  111. package/src/embed/ts-embed.ts +13 -1
  112. package/src/react/index.spec.tsx +29 -0
  113. package/src/types.ts +973 -199
@@ -161,6 +161,7 @@ export declare class SearchBarEmbed extends TsEmbed {
161
161
  * The configuration attributes for the embedded Natural language search view. Based on
162
162
  * GPT and LLM.
163
163
  *
164
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
164
165
  * @group Embed components
165
166
  */
166
167
  export interface SageViewConfig extends ViewConfig {
@@ -181,11 +182,25 @@ export interface SageViewConfig extends ViewConfig {
181
182
  *
182
183
  */
183
184
  showObjectSuggestions?: boolean;
185
+ /**
186
+ * The query string to pre-fill in natual language search bar
187
+ */
188
+ searchQuery?: string;
189
+ /**
190
+ * If set to true, sample questions would be hidden to user.
191
+ * These sample questions are autogenerated based on selected datasource.
192
+ */
193
+ hideSampleQuestions?: boolean;
194
+ /**
195
+ * The data source GUID to set on load.
196
+ */
197
+ dataSource?: string;
184
198
  }
185
199
  export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
186
200
  /**
187
201
  * Embed ThoughtSpot LLM and GPT based natural language search component.
188
202
  *
203
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
189
204
  * @group Embed components
190
205
  */
191
206
  export declare class SageEmbed extends V1Embed {
@@ -255,6 +270,10 @@ export interface SearchViewConfig extends ViewConfig {
255
270
  * using raw answer data.
256
271
  */
257
272
  hideResults?: boolean;
273
+ /**
274
+ * If set to true, expands all the data sources panel.
275
+ */
276
+ expandAllDataSource?: boolean;
258
277
  /**
259
278
  * If set to true, the Search Assist feature is enabled.
260
279
  *
@@ -361,7 +380,7 @@ export declare enum Page {
361
380
  /**
362
381
  * SpotIQ listing page
363
382
  */
364
- SpotIQ = "spotiq"
383
+ SpotIQ = "insights"
365
384
  }
366
385
  /**
367
386
  * The view configuration for full app embedding.
@@ -560,6 +579,12 @@ export interface LiveboardViewConfig extends ViewConfig {
560
579
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
561
580
  */
562
581
  activeTabId?: string;
582
+ /**
583
+ * Hide tab Panel of embedded LB
584
+ *
585
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
586
+ */
587
+ hideTabPanel?: boolean;
563
588
  }
564
589
  /**
565
590
  * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -1026,7 +1051,7 @@ export declare enum AuthType {
1026
1051
  * .then((data) => data.token);
1027
1052
  * }
1028
1053
  * ```
1029
- * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
1054
+ * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
1030
1055
  */
1031
1056
  TrustedAuthTokenCookieless = "AuthServerCookieless",
1032
1057
  /**
@@ -1116,6 +1141,9 @@ export interface CustomStyles {
1116
1141
  export interface CustomisationsInterface {
1117
1142
  style?: CustomStyles;
1118
1143
  content?: {
1144
+ /**
1145
+ * @version SDK: 1.26.0 | 9.7.0.cl
1146
+ */
1119
1147
  strings?: Record<string, any>;
1120
1148
  [key: string]: any;
1121
1149
  };
@@ -1197,7 +1225,7 @@ export interface EmbedConfig {
1197
1225
  *
1198
1226
  * Eg: "/dashboard", "#/foo" [Do not include the host]
1199
1227
  *
1200
- * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1-sw
1228
+ * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
1201
1229
  */
1202
1230
  redirectPath?: string;
1203
1231
  /** @internal */
@@ -1239,14 +1267,14 @@ export interface EmbedConfig {
1239
1267
  * This flag is typically used alongside the combination of auth modes such as {@link
1240
1268
  * AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
1241
1269
  *
1242
- * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1270
+ * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1243
1271
  * @default false
1244
1272
  */
1245
1273
  disableLoginRedirect?: boolean;
1246
1274
  /**
1247
1275
  * This message is displayed on the embed view when the login fails.
1248
1276
  *
1249
- * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1277
+ * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1250
1278
  */
1251
1279
  loginFailedMessage?: string;
1252
1280
  /**
@@ -1268,7 +1296,7 @@ export interface EmbedConfig {
1268
1296
  * Dynamic CSS Url to be injected in the loaded application.
1269
1297
  * You would also need to set `style-src` in the CSP settings.
1270
1298
  *
1271
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1299
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1272
1300
  * @default ''
1273
1301
  */
1274
1302
  customCssUrl?: string;
@@ -1280,13 +1308,13 @@ export interface EmbedConfig {
1280
1308
  * This is slightly slower than letting the browser handle the cookie check, as it
1281
1309
  * involves an extra network call.
1282
1310
  *
1283
- * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1311
+ * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1284
1312
  */
1285
1313
  detectCookieAccessSlow?: boolean;
1286
1314
  /**
1287
1315
  * Hide beta alert warning message for SearchEmbed.
1288
1316
  *
1289
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw*
1317
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
1290
1318
  */
1291
1319
  suppressSearchEmbedBetaWarning?: boolean;
1292
1320
  /**
@@ -1334,7 +1362,7 @@ export interface EmbedConfig {
1334
1362
  * Disable Full App access of Embedded app outside of the iFrame.
1335
1363
  *
1336
1364
  * @default true
1337
- * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1-sw
1365
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1338
1366
  */
1339
1367
  blockNonEmbedFullAppAccess?: boolean;
1340
1368
  /**
@@ -1437,14 +1465,14 @@ export interface ViewConfig {
1437
1465
  *
1438
1466
  * Use either this or hiddenActions.
1439
1467
  *
1440
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1468
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1441
1469
  * @important
1442
1470
  */
1443
1471
  visibleActions?: Action[];
1444
1472
  /**
1445
1473
  * Show alert messages and toast messages in the embedded view.
1446
1474
  *
1447
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1475
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1448
1476
  */
1449
1477
  showAlerts?: boolean;
1450
1478
  /**
@@ -1455,7 +1483,7 @@ export interface ViewConfig {
1455
1483
  /**
1456
1484
  * The locale/language to use for the embedded view.
1457
1485
  *
1458
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
1486
+ * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1459
1487
  */
1460
1488
  locale?: string;
1461
1489
  /**
@@ -1466,7 +1494,7 @@ export interface ViewConfig {
1466
1494
  * to control embed behavior in non-regular ways. We do not publish the
1467
1495
  * list of supported keys and values associated with each.
1468
1496
  *
1469
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1497
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1470
1498
  */
1471
1499
  additionalFlags?: {
1472
1500
  [key: string]: string | number | boolean;
@@ -1475,7 +1503,7 @@ export interface ViewConfig {
1475
1503
  * Dynamic CSSUrl and customCSS to be injected in the loaded application.
1476
1504
  * You would also need to set `style-src` in the CSP settings.
1477
1505
  *
1478
- * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1-sw, 8.4.0.cl
1506
+ * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
1479
1507
  * @default ''
1480
1508
  */
1481
1509
  customizations?: CustomisationsInterface;
@@ -1523,24 +1551,60 @@ export interface ViewConfig {
1523
1551
  /**
1524
1552
  * Boolean to hide liveboard header
1525
1553
  *
1526
- * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
1554
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1527
1555
  * @default false
1528
1556
  */
1529
1557
  hideLiveboardHeader?: boolean;
1530
1558
  /**
1531
1559
  * Boolean to show liveboard title
1532
1560
  *
1533
- * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
1561
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1534
1562
  * @default false
1535
1563
  */
1536
1564
  showLiveboardTitle?: boolean;
1537
1565
  /**
1538
1566
  * Boolean to show liveboard description
1539
1567
  *
1540
- * @version SDK: 1.23.0 | Thoughtspot: 9.6.0.cl
1568
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1541
1569
  * @default false
1542
1570
  */
1543
1571
  showLiveboardDescription?: boolean;
1572
+ /**
1573
+ * The list of tab IDs to hide from the embedded.
1574
+ * This Tabs will be hidden from their respective LBs.
1575
+ * Use this to hide an tabID.
1576
+ *
1577
+ * @example
1578
+ * ```js
1579
+ * const embed = new LiveboardEmbed('#embed', {
1580
+ * ... // other liveboard view config
1581
+ * hiddenTabs: [
1582
+ * '430496d6-6903-4601-937e-2c691821af3c',
1583
+ * 'f547ec54-2a37-4516-a222-2b06719af726']
1584
+ * });
1585
+ * ```
1586
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1587
+ */
1588
+ hiddenTabs?: string[];
1589
+ /**
1590
+ * The list of tab IDs to show in the embedded.
1591
+ * Only this Tabs will be shown in their respective LBs.
1592
+ * Use this to show an tabID.
1593
+ *
1594
+ * Use either this or hiddenTabs.
1595
+ *
1596
+ * @example
1597
+ * ```js
1598
+ * const embed = new LiveboardEmbed('#embed', {
1599
+ * ... // other liveboard view config
1600
+ * visibleTabs: [
1601
+ * '430496d6-6903-4601-937e-2c691821af3c',
1602
+ * 'f547ec54-2a37-4516-a222-2b06719af726']
1603
+ * });
1604
+ * ```
1605
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1606
+ */
1607
+ visibleTabs?: string[];
1544
1608
  }
1545
1609
  /**
1546
1610
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1746,7 +1810,7 @@ export declare enum EmbedEvent {
1746
1810
  * One or more data columns have been selected.
1747
1811
  *
1748
1812
  * @returns columnIds - the list of columns
1749
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1813
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1750
1814
  */
1751
1815
  AddRemoveColumns = "addRemoveColumns",
1752
1816
  /**
@@ -1779,7 +1843,7 @@ export declare enum EmbedEvent {
1779
1843
  * });
1780
1844
  * ```
1781
1845
  * @return viz, clickedPoint - metadata about point that is clicked
1782
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1846
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1783
1847
  * @important
1784
1848
  */
1785
1849
  VizPointClick = "vizPointClick",
@@ -1829,7 +1893,7 @@ export declare enum EmbedEvent {
1829
1893
  * Emitted when the "Get Data" button in Search Bar embed
1830
1894
  * is clicked.
1831
1895
  *
1832
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
1896
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
1833
1897
  */
1834
1898
  GetDataClick = "getDataClick",
1835
1899
  /**
@@ -1859,13 +1923,13 @@ export declare enum EmbedEvent {
1859
1923
  /**
1860
1924
  * Emitted when any modal is opened in the app
1861
1925
  *
1862
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1926
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1863
1927
  */
1864
1928
  DialogOpen = "dialog-open",
1865
1929
  /**
1866
1930
  * Emitted when any modal is closed in the app
1867
1931
  *
1868
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1932
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1869
1933
  */
1870
1934
  DialogClose = "dialog-close",
1871
1935
  /**
@@ -1873,136 +1937,136 @@ export declare enum EmbedEvent {
1873
1937
  * You can use this event as a hook to trigger
1874
1938
  * other events on the rendered Liveboard.
1875
1939
  *
1876
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1940
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1877
1941
  */
1878
1942
  LiveboardRendered = "PinboardRendered",
1879
1943
  /**
1880
1944
  * This can be used to register an event listener which
1881
1945
  * is triggered on all events.
1882
1946
  *
1883
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
1947
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1884
1948
  */
1885
1949
  ALL = "*",
1886
1950
  /**
1887
- * Emitted when answer is saved in the app
1951
+ * Emitted when an Answer is saved in the app
1888
1952
  *
1889
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1953
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1890
1954
  */
1891
1955
  Save = "save",
1892
1956
  /**
1893
1957
  * Emitted when the download action is triggered on an answer
1894
1958
  *
1895
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1959
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1896
1960
  */
1897
1961
  Download = "download",
1898
1962
  /**
1899
1963
  * Emitted when the download action is triggered on an answer
1900
1964
  *
1901
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
1965
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
1902
1966
  */
1903
1967
  DownloadAsPng = "downloadAsPng",
1904
1968
  /**
1905
1969
  * Emitted when the Download as PDF action is triggered on an answer
1906
1970
  *
1907
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1971
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1908
1972
  */
1909
1973
  DownloadAsPdf = "downloadAsPdf",
1910
1974
  /**
1911
1975
  * Emitted when the Download as CSV action is triggered on an answer
1912
1976
  *
1913
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1977
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1914
1978
  */
1915
1979
  DownloadAsCsv = "downloadAsCsv",
1916
1980
  /**
1917
1981
  * Emitted when the Download as XLSX action is triggered on an answer
1918
1982
  *
1919
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1983
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1920
1984
  */
1921
1985
  DownloadAsXlsx = "downloadAsXlsx",
1922
1986
  /**
1923
1987
  * Emitted when an answer is deleted in the app
1924
1988
  *
1925
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1989
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1926
1990
  */
1927
1991
  AnswerDelete = "answerDelete",
1928
1992
  /**
1929
1993
  * Emitted when an answer is pinned to a Liveboard
1930
1994
  *
1931
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1995
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1932
1996
  */
1933
1997
  Pin = "pin",
1934
1998
  /**
1935
1999
  * Emitted when SpotIQ analysis is triggered
1936
2000
  *
1937
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2001
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1938
2002
  */
1939
2003
  SpotIQAnalyze = "spotIQAnalyze",
1940
2004
  /**
1941
2005
  * Emitted when a user shares an object with another user or group
1942
2006
  *
1943
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2007
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1944
2008
  */
1945
2009
  Share = "share",
1946
2010
  /**
1947
2011
  * Emitted when a user clicks the Include action to include a specific value or data
1948
2012
  * on a chart or table
1949
2013
  *
1950
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2014
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1951
2015
  */
1952
2016
  DrillInclude = "context-menu-item-include",
1953
2017
  /**
1954
2018
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
1955
2019
  * on a chart or table
1956
2020
  *
1957
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2021
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1958
2022
  */
1959
2023
  DrillExclude = "context-menu-item-exclude",
1960
2024
  /**
1961
2025
  * Emitted when copied column value on the app
1962
2026
  *
1963
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2027
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1964
2028
  */
1965
2029
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
1966
2030
  /**
1967
2031
  * Emitted when a user clicks the Update TML action
1968
2032
  *
1969
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2033
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1970
2034
  */
1971
2035
  UpdateTML = "updateTSL",
1972
2036
  /**
1973
2037
  * Emitted when a user clicks the Edit TML action
1974
2038
  *
1975
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2039
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1976
2040
  */
1977
2041
  EditTML = "editTSL",
1978
2042
  /**
1979
2043
  * Emitted when ExportTML trigger in answer on the app
1980
2044
  *
1981
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2045
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1982
2046
  */
1983
2047
  ExportTML = "exportTSL",
1984
2048
  /**
1985
2049
  * Emitted when an answer is saved as a view
1986
2050
  *
1987
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2051
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1988
2052
  */
1989
2053
  SaveAsView = "saveAsView",
1990
2054
  /**
1991
2055
  * Emitted when copy of existing answer on the app
1992
2056
  *
1993
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2057
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1994
2058
  */
1995
2059
  CopyAEdit = "copyAEdit",
1996
2060
  /**
1997
2061
  * Emitted when a user clicks Show underlying data on an answe
1998
2062
  *
1999
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2063
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2000
2064
  */
2001
2065
  ShowUnderlyingData = "showUnderlyingData",
2002
2066
  /**
2003
2067
  * Emitted when an answer is switched to a chart or table view
2004
2068
  *
2005
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2069
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2006
2070
  */
2007
2071
  AnswerChartSwitcher = "answerChartSwitcher",
2008
2072
  /**
@@ -2014,67 +2078,67 @@ export declare enum EmbedEvent {
2014
2078
  /**
2015
2079
  * Emitted when a user clicks Show Liveboard details on a Liveboard
2016
2080
  *
2017
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2081
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2018
2082
  */
2019
2083
  LiveboardInfo = "pinboardInfo",
2020
2084
  /**
2021
2085
  * Emitted when a user clicks on the Favorite icon on a Liveboard
2022
2086
  *
2023
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2087
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2024
2088
  */
2025
2089
  AddToFavorites = "addToFavorites",
2026
2090
  /**
2027
2091
  * Emitted when a user clicks Schedule on a Liveboard
2028
2092
  *
2029
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2093
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2030
2094
  */
2031
2095
  Schedule = "subscription",
2032
2096
  /**
2033
2097
  * Emitted when a user clicks Edit on a Liveboard or visualization
2034
2098
  *
2035
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2099
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2036
2100
  */
2037
2101
  Edit = "edit",
2038
2102
  /**
2039
2103
  * Emitted when a user clicks Make a copy on a Liveboard
2040
2104
  *
2041
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2105
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2042
2106
  */
2043
2107
  MakeACopy = "makeACopy",
2044
2108
  /**
2045
2109
  * Emitted when a user clicks Present on a Liveboard or visualization
2046
2110
  *
2047
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2111
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2048
2112
  */
2049
2113
  Present = "present",
2050
2114
  /**
2051
2115
  * Emitted when a user clicks Delete on a Liveboard
2052
2116
  *
2053
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2117
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2054
2118
  */
2055
2119
  Delete = "delete",
2056
2120
  /**
2057
2121
  * Emitted when a user clicks Manage schedules on a Liveboard
2058
2122
  *
2059
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2123
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2060
2124
  */
2061
2125
  SchedulesList = "schedule-list",
2062
2126
  /**
2063
2127
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
2064
2128
  *
2065
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2129
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2066
2130
  */
2067
2131
  Cancel = "cancel",
2068
2132
  /**
2069
2133
  * Emitted when a user clicks Explore on a visualization
2070
2134
  *
2071
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2135
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2072
2136
  */
2073
2137
  Explore = "explore",
2074
2138
  /**
2075
2139
  * Emitted when a user clicks Copy link action on a visualization
2076
2140
  *
2077
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2141
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2078
2142
  */
2079
2143
  CopyLink = "embedDocument",
2080
2144
  /**
@@ -2094,7 +2158,25 @@ export declare enum EmbedEvent {
2094
2158
  *
2095
2159
  * @hidden
2096
2160
  */
2097
- InsertIntoSlide = "insertInToSlide"
2161
+ InsertIntoSlide = "insertInToSlide",
2162
+ /**
2163
+ * Emitted when a user changes any filter on a Liveboard.
2164
+ *
2165
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2166
+ */
2167
+ FilterChanged = "filterChanged",
2168
+ /**
2169
+ * Emitted when a user click on Go button in Sage Embed
2170
+ *
2171
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2172
+ */
2173
+ SageEmbedQuery = "sageEmbedQuery",
2174
+ /**
2175
+ * Emitten when a user select data source in Sage Embed
2176
+ *
2177
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2178
+ */
2179
+ SageWorksheetUpdated = "sageWorksheetUpdated"
2098
2180
  }
2099
2181
  /**
2100
2182
  * Event types that can be triggered by the host application
@@ -2120,13 +2202,15 @@ export declare enum EmbedEvent {
2120
2202
  */
2121
2203
  export declare enum HostEvent {
2122
2204
  /**
2123
- * Trigger a search
2205
+ * Triggers a search query in AppEmbed and SearchEmbed
2206
+ * deployments.
2207
+ * Includes the following properties:
2124
2208
  *
2125
2209
  * @param - dataSourceIds - The data source GUID to Search on
2126
2210
  * - Although an array, only a single source
2127
- * is supported at this time.
2128
- * @param - searchQuery - The search query
2129
- * @param - execute - execute the existing / updated query
2211
+ * is supported.
2212
+ * @param - searchQuery - Query string with search tokens
2213
+ * @param - execute - executes the existing / updated query
2130
2214
  * @example
2131
2215
  * ```js
2132
2216
  * searchEmbed.trigger(HostEvent.Search, {
@@ -2138,13 +2222,14 @@ export declare enum HostEvent {
2138
2222
  */
2139
2223
  Search = "search",
2140
2224
  /**
2141
- * Trigger a drill on certain points by certain column
2225
+ * Triggers a drill on certain points of the specified column
2226
+ * Includes the following properties:
2142
2227
  *
2143
2228
  * @param - points - an object containing selectedPoints/clickedPoints
2144
- * eg. { selectedPoints: []}
2145
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
2146
- * if not provided it will auto drill by the configured
2147
- * column.
2229
+ * to drill to. For example, { selectedPoints: []}
2230
+ * @param - columnGuid - Optional. GUID of the column to drill
2231
+ * by. If not provided it will auto drill by the configured
2232
+ * column.
2148
2233
  * @example
2149
2234
  * ```js
2150
2235
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -2177,17 +2262,17 @@ export declare enum HostEvent {
2177
2262
  */
2178
2263
  Reload = "reload",
2179
2264
  /**
2180
- * Set the visible visualizations on a Liveboard.
2265
+ * Sets the visible visualizations on a Liveboard.
2181
2266
  *
2182
- * @param - an array of ids of visualizations to show, the ids not passed
2183
- * will be hidden.
2267
+ * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
2268
+ * in this parameter will be hidden.
2184
2269
  * @example
2185
2270
  * ```js
2186
2271
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
2187
2272
  * '730496d6-6903-4601-937e-2c691821af3c',
2188
2273
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
2189
2274
  * ```
2190
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
2275
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2191
2276
  */
2192
2277
  SetVisibleVizs = "SetPinboardVisibleVizs",
2193
2278
  /**
@@ -2204,8 +2289,18 @@ export declare enum HostEvent {
2204
2289
  */
2205
2290
  SetActiveTab = "SetActiveTab",
2206
2291
  /**
2207
- * Update the runtime filters. The runtime filters passed here are extended
2208
- * on to the existing runtime filters if they exist.
2292
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
2293
+ * runtime filters passed here are appended to the existing runtime
2294
+ * filters.
2295
+ * Pass an array of runtime filters with the following attributes:
2296
+ * `columnName`
2297
+ * _String_. The name of the column to filter on.
2298
+ * `operator`
2299
+ * Runtime filter operator to apply. For information,
2300
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2301
+ * `values`
2302
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
2303
+ * operators such as BW and IN accept multiple operands.
2209
2304
  *
2210
2305
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
2211
2306
  * @example
@@ -2215,12 +2310,12 @@ export declare enum HostEvent {
2215
2310
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
2216
2311
  * ])
2217
2312
  * ```
2218
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2313
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2219
2314
  * @important
2220
2315
  */
2221
2316
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
2222
2317
  /**
2223
- * Navigate to a specific page in App embed without any reload.
2318
+ * Navigate to a specific page in the embedded application without reloading the page.
2224
2319
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
2225
2320
  *
2226
2321
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
@@ -2228,12 +2323,12 @@ export declare enum HostEvent {
2228
2323
  * ```js
2229
2324
  * appEmbed.navigateToPage(-1)
2230
2325
  * ```
2231
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
2326
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
2232
2327
  */
2233
2328
  Navigate = "Navigate",
2234
2329
  /**
2235
2330
  * Opens the filter panel for a particular column.
2236
- * Works with Search embed.
2331
+ * Works with Search and Liveboard embed.
2237
2332
  *
2238
2333
  * @param - { columnId: string,
2239
2334
  * name: string,
@@ -2242,233 +2337,257 @@ export declare enum HostEvent {
2242
2337
  * @example
2243
2338
  * ```js
2244
2339
  * searchEmbed.trigger(HostEvent.OpenFilter,
2245
- * { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
2340
+ * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
2341
+ * LiveboardEmbed.trigger(HostEvent.OpenFilter,
2342
+ * { columnId: '<column-GUID>'})
2246
2343
  * ```
2247
2344
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2248
2345
  */
2249
2346
  OpenFilter = "openFilter",
2250
2347
  /**
2251
- * Adds the columns to the current Search.
2348
+ * Adds columns to the current search query.
2252
2349
  *
2253
2350
  * @param - { columnIds: string[] }
2254
2351
  * @example
2255
2352
  * ```js
2256
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
2353
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
2257
2354
  * ```
2258
2355
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2259
2356
  */
2260
2357
  AddColumns = "addColumns",
2261
2358
  /**
2262
- * Removes a column from the current Search.
2359
+ * Removes a column from the current search query.
2263
2360
  *
2264
2361
  * @param - { columnId: string }
2265
2362
  * @example
2266
2363
  * ```js
2267
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
2364
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
2268
2365
  * ```
2269
2366
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2270
2367
  */
2271
2368
  RemoveColumn = "removeColumn",
2272
2369
  /**
2273
- * Gets the current pinboard content.
2370
+ * Gets the current Liveboard content.
2274
2371
  *
2275
2372
  * @example
2276
2373
  * ```js
2277
2374
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
2278
2375
  * ```
2279
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
2376
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
2280
2377
  */
2281
2378
  getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
2282
2379
  /**
2283
- * Triggers the Pin action on an embedded object
2380
+ * Triggers the **Pin** action on an embedded object
2284
2381
  *
2285
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2286
- * can be left empty for search and visualization embeds
2382
+ * @param - Liveboard embed takes the `vizId` as a
2383
+ * key. Can be left undefined when embedding Search, full app or
2384
+ * a visualization.
2287
2385
  * @example
2288
2386
  * ```js
2289
2387
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2388
+ * ```
2389
+ * ```js
2290
2390
  * vizEmbed.trigger(HostEvent.Pin)
2391
+ * ```
2392
+ * ```js
2291
2393
  * searchEmbed.trigger(HostEvent.Pin)
2292
2394
  * ```
2293
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2395
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2294
2396
  */
2295
2397
  Pin = "pin",
2296
2398
  /**
2297
- * Triggers the Show Liveboard details action on a Liveboard
2399
+ * Triggers the **Show Liveboard details** action on a Liveboard
2298
2400
  *
2299
2401
  * @example
2300
2402
  * ```js
2301
2403
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
2302
2404
  * ```
2303
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2405
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2304
2406
  */
2305
2407
  LiveboardInfo = "pinboardInfo",
2306
2408
  /**
2307
- * Triggers the Schedule action on a Liveboard
2409
+ * Triggers the **Schedule** action on a Liveboard
2308
2410
  *
2309
2411
  * @example
2310
2412
  * ```js
2311
2413
  * liveboardEmbed.trigger(HostEvent.Schedule)
2312
2414
  * ```
2313
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2415
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2314
2416
  */
2315
2417
  Schedule = "subscription",
2316
2418
  /**
2317
- * Triggers the Manage schedule action on a Liveboard
2419
+ * Triggers the **Manage schedule** action on a Liveboard
2318
2420
  *
2319
2421
  * @example
2320
2422
  * ```js
2321
2423
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
2322
2424
  * ```
2323
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2425
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2324
2426
  */
2325
2427
  SchedulesList = "schedule-list",
2326
2428
  /**
2327
- * Triggers the Export TML action on a Liveboard
2429
+ * Triggers the **Export TML** action on a Liveboard
2328
2430
  *
2329
2431
  * @example
2330
2432
  * ```js
2331
2433
  * liveboardEmbed.trigger(HostEvent.ExportTML)
2332
2434
  * ```
2333
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2435
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2334
2436
  */
2335
2437
  ExportTML = "exportTSL",
2336
2438
  /**
2337
- * Triggers the Edit TML action on a Liveboard
2439
+ * Triggers the **Edit TML** action on a Liveboard
2338
2440
  *
2339
2441
  * @example
2340
2442
  * ```js
2341
2443
  * liveboardEmbed.trigger(HostEvent.EditTML)
2342
2444
  * ```
2343
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2445
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2344
2446
  */
2345
2447
  EditTML = "editTSL",
2346
2448
  /**
2347
- * Triggers the Update TML action on a Liveboard
2449
+ * Triggers the **Update TML** action on a Liveboard
2348
2450
  *
2349
2451
  * @example
2350
2452
  * ```js
2351
2453
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
2352
2454
  * ```
2353
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2455
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2354
2456
  */
2355
2457
  UpdateTML = "updateTSL",
2356
2458
  /**
2357
- * Triggers the Download PDF action on a Liveboard
2459
+ * Triggers the **Download PDF** action on a Liveboard
2358
2460
  *
2359
2461
  * @example
2360
2462
  * ```js
2361
2463
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
2362
2464
  * ```
2363
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2465
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2364
2466
  */
2365
2467
  DownloadAsPdf = "downloadAsPdf",
2366
2468
  /**
2367
- * Triggers the Make a copy action on a Liveboard, search or visualization
2469
+ * Triggers the **Make a copy** action on a Liveboard, Search, or
2470
+ * visualization page
2368
2471
  *
2369
2472
  * @example
2370
2473
  * ```js
2371
2474
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2475
+ * ```
2476
+ * ```js
2372
2477
  * vizEmbed.trigger(HostEvent.MakeACopy)
2478
+ * ```
2479
+ * ```js
2373
2480
  * searchEmbed.trigger(HostEvent.MakeACopy)
2374
2481
  * ```
2375
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2482
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2376
2483
  */
2377
2484
  MakeACopy = "makeACopy",
2378
2485
  /**
2379
- * Triggers the Delete action on a Liveboard
2486
+ * Triggers the **Delete** action on a Liveboard
2380
2487
  *
2381
2488
  * @example
2382
2489
  * ```js
2383
2490
  * appEmbed.trigger(HostEvent.Remove)
2384
2491
  * ```
2385
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2492
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2386
2493
  */
2387
2494
  Remove = "delete",
2388
2495
  /**
2389
- * Triggers the Explore action on a visualization
2496
+ * Triggers the **Explore* action on a visualization
2390
2497
  *
2391
- * @param - an object with vizId as a key
2498
+ * @param - an object with `vizId` as a key
2392
2499
  * @example
2393
2500
  * ```js
2394
2501
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2395
2502
  * ```
2396
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2503
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2397
2504
  */
2398
2505
  Explore = "explore",
2399
2506
  /**
2400
- * Triggers the Create alert action on a visualization
2507
+ * Triggers the **Create alert** action on a visualization
2401
2508
  *
2402
- * @param - an object with vizId as a key
2509
+ * @param - an object with `vizId` as a key
2403
2510
  * @example
2404
2511
  * ```js
2405
2512
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
2406
2513
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2407
2514
  * })
2408
2515
  * ```
2409
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2516
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2410
2517
  */
2411
2518
  CreateMonitor = "createMonitor",
2412
2519
  /**
2413
- * Triggers the Manage alert action on a visualization
2520
+ * Triggers the **Manage alerts** action on a visualization
2414
2521
  *
2415
- * @param - an object with vizId as a key
2522
+ * @param - an object with `vizId` as a key
2416
2523
  * @example
2417
2524
  * ```js
2418
2525
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
2419
2526
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2420
2527
  * })
2421
2528
  * ```
2422
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2529
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2423
2530
  */
2424
2531
  ManageMonitor = "manageMonitor",
2425
2532
  /**
2426
- * Triggers the Edit action on a Liveboard or visualization
2533
+ * Triggers the **Edit** action on a Liveboard or visualization
2427
2534
  *
2428
- * @param - object - to trigger the action for a specfic visualization
2429
- * in Liveboard embed, pass in vizId as a key
2535
+ * @param - object - To trigger the action for a specific visualization
2536
+ * in Liveboard embed, pass in `vizId` as a key.
2537
+ * Can be left undefined when embedding Search, full app, or
2538
+ * a visualization.
2430
2539
  * @example
2431
2540
  * ```js
2432
2541
  * liveboardEmbed.trigger(HostEvent.Edit)
2433
- *
2542
+ * ```
2543
+ * ```js
2434
2544
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
2435
2545
  * '730496d6-6903-4601-937e-2c691821af3c'})
2436
- *
2546
+ * ```
2547
+ * ```js
2437
2548
  * vizEmbed.trigger((HostEvent.Edit)
2438
2549
  * ```
2439
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2550
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2440
2551
  */
2441
2552
  Edit = "edit",
2442
2553
  /**
2443
- * Triggers the Copy link action on a Liveboard or visualization
2554
+ * Triggers the **Copy link** action on a Liveboard or visualization
2444
2555
  *
2445
- * @param - object - to trigger the action for a s
2446
- * pecfic visualization in Liveboard embed, pass in vizId as a key
2556
+ * @param - object - to trigger the action for a
2557
+ * specific visualization in Liveboard embed, pass in `vizId` as a key
2447
2558
  * @example
2448
2559
  * ```js
2449
2560
  * liveboardEmbed.trigger(HostEvent.CopyLink)
2561
+ * ```
2562
+ * ```js
2450
2563
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2564
+ * ```
2565
+ * ```js
2451
2566
  * vizEmbed.trigger((HostEvent.CopyLink)
2452
2567
  * ```
2453
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2568
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2454
2569
  */
2455
2570
  CopyLink = "embedDocument",
2456
2571
  /**
2457
- * Triggers the Present action on a Liveboard or visualization
2572
+ * Triggers the **Present** action on a Liveboard or visualization
2458
2573
  *
2459
- * @param - object - to trigger the action for a specfic visualization
2460
- * in Liveboard embed, pass in vizId as a key
2574
+ * @param - object - to trigger the action for a specific visualization
2575
+ * in Liveboard embed, pass in `vizId` as a key
2461
2576
  * @example
2462
2577
  * ```js
2463
2578
  * liveboardEmbed.trigger(HostEvent.Present)
2579
+ * ```
2580
+ * ```js
2464
2581
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2582
+ * ```
2583
+ * ```js
2465
2584
  * vizEmbed.trigger((HostEvent.Present)
2466
2585
  * ```
2467
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
2586
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2468
2587
  */
2469
2588
  Present = "present",
2470
2589
  /**
2471
- * Get TML for the current search.
2590
+ * Gets TML for the current search.
2472
2591
  *
2473
2592
  * @example
2474
2593
  * ```js
@@ -2478,78 +2597,90 @@ export declare enum HostEvent {
2478
2597
  * );
2479
2598
  * })
2480
2599
  * ```
2481
- * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
2600
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2482
2601
  * @important
2483
2602
  */
2484
2603
  GetTML = "getTML",
2485
2604
  /**
2486
- * Triggers the ShowUnderlyingData action on visualization or search
2605
+ * Triggers the **Show underlying data** action on visualization or search
2487
2606
  *
2488
2607
  * @param - an object with vizId as a key
2489
2608
  * @example
2490
2609
  * ```js
2491
2610
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
2492
2611
  * '730496d6-6903-4601-937e-2c691821af3c'})
2493
- *
2612
+ * ```
2613
+ * ```js
2494
2614
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
2495
- *
2615
+ * ```
2616
+ * ```js
2496
2617
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
2497
2618
  * ```
2498
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2619
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2499
2620
  */
2500
2621
  ShowUnderlyingData = "showUnderlyingData",
2501
2622
  /**
2502
- * Triggers the Delete action on visualization or search
2623
+ * Triggers the **Delete** action on visualization or search
2503
2624
  *
2504
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2505
- * can be left empty for search and visualization embeds
2625
+ * @param - Liveboard embed takes an object with `vizId` as a key.
2626
+ * Can be left empty if embedding Search or visualization.
2506
2627
  * @example
2507
2628
  * ```js
2508
2629
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
2509
2630
  * '730496d6-6903-4601-937e-2c691821af3c'})
2510
- *
2631
+ * ```
2632
+ * ```js
2511
2633
  * vizEmbed.trigger(HostEvent.Delete)
2512
- *
2634
+ * ```
2635
+ * ```js
2513
2636
  * searchEmbed.trigger(HostEvent.Delete)
2514
2637
  * ```
2515
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2638
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2516
2639
  */
2517
2640
  Delete = "onDeleteAnswer",
2518
2641
  /**
2519
- * Triggers the SpotIQAnalyze action on visualization or search
2642
+ * Triggers the **SpotIQ analyze** action on visualization
2643
+ * or search.
2520
2644
  *
2521
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
2522
- * can be left empty for search and visualization embeds
2645
+ * @param - Liveboard embed takes `vizId` as a
2646
+ * key. Can be left undefined when embedding Search or
2647
+ * visualization.
2523
2648
  * @example
2524
2649
  * ```js
2525
2650
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
2526
2651
  * '730496d6-6903-4601-937e-2c691821af3c'})
2527
- *
2652
+ * ```
2653
+ * ```js
2528
2654
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
2529
- *
2655
+ * ```
2656
+ * ```js
2530
2657
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
2531
2658
  * ```
2532
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2659
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2533
2660
  */
2534
2661
  SpotIQAnalyze = "spotIQAnalyze",
2535
2662
  /**
2536
- * Triggers the Download action on visualization or search when Displaymode is Chart
2663
+ * Triggers the **Download** action on charts in
2664
+ * the embedded view.
2537
2665
  *
2538
2666
  * @example
2539
2667
  * ```js
2540
2668
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
2541
2669
  * '730496d6-6903-4601-937e-2c691821af3c'})
2542
- *
2670
+ * ```
2671
+ * ```js
2543
2672
  * vizEmbed.trigger(HostEvent.Download)
2544
- *
2673
+ * ```
2674
+ * ```js
2545
2675
  * searchEmbed.trigger(HostEvent.Download)
2546
2676
  * ```
2547
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
2548
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2677
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
2678
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2549
2679
  */
2550
2680
  Download = "downloadAsPng",
2551
2681
  /**
2552
- * Triggers the Download action on visualization or search when Displaymode is Chart
2682
+ * Triggers the **Download** > **PNG** action on
2683
+ * charts in the embedded view.
2553
2684
  *
2554
2685
  * @example
2555
2686
  * ```js
@@ -2560,115 +2691,197 @@ export declare enum HostEvent {
2560
2691
  *
2561
2692
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
2562
2693
  * ```
2563
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
2694
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
2564
2695
  */
2565
2696
  DownloadAsPng = "downloadAsPng",
2566
2697
  /**
2567
- * Triggers the downloadAsCSV action on visualization or search
2698
+ * Triggers the **Download** > **CSV** action on tables in
2699
+ * the embedded view.
2568
2700
  *
2569
2701
  * @example
2570
2702
  * ```js
2571
2703
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
2572
2704
  * '730496d6-6903-4601-937e-2c691821af3c'})
2573
- *
2705
+ * ```
2706
+ * ```js
2574
2707
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
2575
- *
2708
+ * ```
2709
+ * ```js
2576
2710
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
2577
2711
  * ```
2578
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2712
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2579
2713
  */
2580
2714
  DownloadAsCsv = "downloadAsCSV",
2581
2715
  /**
2582
- * Triggers the downloadAsXLSX action on visualization or search
2716
+ * Triggers the **Download** > **XLSX** action on tables
2717
+ * in the embedded view.
2583
2718
  *
2584
2719
  * @example
2585
2720
  * ```js
2586
2721
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
2587
2722
  * '730496d6-6903-4601-937e-2c691821af3c'})
2588
- *
2723
+ * ```
2724
+ * ```js
2589
2725
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
2590
- *
2726
+ * ```
2727
+ * ```js
2591
2728
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
2592
2729
  * ```
2593
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2730
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2594
2731
  */
2595
2732
  DownloadAsXlsx = "downloadAsXLSX",
2596
2733
  /**
2597
- * Triggers the Share action on a liveboard or answer
2734
+ * Triggers the **Share** action on an embedded
2735
+ * Liveboard or Answer.
2598
2736
  *
2599
2737
  * @example
2600
2738
  * ```js
2601
2739
  * liveboardEmbed.trigger(HostEvent.Share)
2602
- *
2740
+ * ```
2741
+ * ```js
2603
2742
  * searchEmbed.trigger(HostEvent.Share)
2604
2743
  * ```
2605
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2744
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2606
2745
  */
2607
2746
  Share = "share",
2608
2747
  /**
2609
- * Trigger the Save action on a liveboard or answer
2748
+ * Triggers the **Save** action on a Liveboard or Answer.
2749
+ * Saves the changes.
2610
2750
  *
2611
2751
  * @example
2612
2752
  * ```js
2613
2753
  * liveboardEmbed.trigger(HostEvent.Save)
2614
- *
2754
+ * ```
2755
+ * ```js
2615
2756
  * searchEmbed.trigger(HostEvent.Save)
2616
2757
  * ```
2617
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2758
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2618
2759
  */
2619
2760
  Save = "save",
2620
2761
  /**
2621
- * Triggers the SyncToSheets action on visualization
2762
+ * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
2763
+ * Sends data from an Answer or Liveboard visualization to a Google sheet.
2622
2764
  *
2623
- * @param - an object with vizId as a key
2765
+ * @param - an object with `vizId` as a key
2624
2766
  * @example
2625
2767
  * ```js
2626
2768
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
2627
2769
  * '730496d6-6903-4601-937e-2c691821af3c'})
2628
- *
2770
+ * ```
2771
+ * ```js
2629
2772
  * vizEmbed.trigger(HostEvent.SyncToSheets)
2630
2773
  * ```
2631
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2774
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2632
2775
  */
2633
2776
  SyncToSheets = "sync-to-sheets",
2634
2777
  /**
2635
- * Triggers the SyncToOtherApps action on visualization
2778
+ * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
2779
+ * Sends data from an Answer or Liveboard visualization to third-party apps such
2780
+ * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
2636
2781
  *
2637
2782
  * @param - an object with vizId as a key
2638
2783
  * @example
2639
2784
  * ```js
2640
2785
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
2641
2786
  * '730496d6-6903-4601-937e-2c691821af3c'})
2642
- *
2787
+ * ```
2788
+ * ```js
2643
2789
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
2644
2790
  * ```
2645
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2791
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2646
2792
  */
2647
2793
  SyncToOtherApps = "sync-to-other-apps",
2648
2794
  /**
2649
- * Triggers the ManagePipelines action on visualization
2795
+ * Triggers the **Manage pipelines** action on an embedded
2796
+ * visualization or Answer.
2797
+ * Allows users to manage ThoughtSpot Sync pipelines.
2650
2798
  *
2651
- * @param - an object with vizId as a key
2799
+ * @param - an object with `vizId` as a key
2652
2800
  * @example
2653
2801
  * ```js
2654
2802
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
2655
2803
  * '730496d6-6903-4601-937e-2c691821af3c'})
2656
- *
2804
+ * ```
2805
+ * ```js
2657
2806
  * vizEmbed.trigger(HostEvent.ManagePipelines)
2658
2807
  * ```
2659
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
2808
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2660
2809
  */
2661
2810
  ManagePipelines = "manage-pipeline",
2662
2811
  /**
2663
- * Triggers the Reset search in answer
2812
+ * Triggers the Reset search on the Search page
2664
2813
  *
2665
2814
  * @example
2666
2815
  * ```js
2667
2816
  * searchEmbed.trigger(HostEvent.ResetSearch)
2668
2817
  * ```
2669
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
2818
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
2819
+ */
2820
+ ResetSearch = "resetSearch",
2821
+ /**
2822
+ * Gets the currents visible and runtime filters applied on a Liveboard
2823
+ *
2824
+ * @example
2825
+ * liveboardEmbed.trigger(HostEvent.GetFilters)
2826
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2827
+ */
2828
+ GetFilters = "getFilters",
2829
+ /**
2830
+ * Updates the visible filters on the Liveboard.
2831
+ *
2832
+ * @param - filter: filter object containing column name and filter operation and values
2833
+ * @example
2834
+ *
2835
+ * ```js
2836
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
2837
+ * filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
2838
+ * })
2839
+ * ```
2840
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2841
+ */
2842
+ UpdateFilters = "updateFilters",
2843
+ /**
2844
+ * Get Tab for the current Liveboard.
2845
+ *
2846
+ * @example
2847
+ * ```js
2848
+ * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
2849
+ * console.log(
2850
+ * tabDetails // TabDetails of current LB
2851
+ * );
2852
+ * })
2853
+ * ```
2854
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
2855
+ */
2856
+ GetTabs = "getTabs",
2857
+ /**
2858
+ * Set the visible Tabs on a Liveboard.
2859
+ *
2860
+ * @param - an array of ids of Tabs to show, the ids not passed
2861
+ * will be hidden.
2862
+ * @example
2863
+ * ```js
2864
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
2865
+ * '430496d6-6903-4601-937e-2c691821af3c',
2866
+ * 'f547ec54-2a37-4516-a222-2b06719af726'])
2867
+ * ```
2868
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2869
+ */
2870
+ SetVisibleTabs = "SetPinboardVisibleTabs",
2871
+ /**
2872
+ * Set the hidden tabs on a Liveboard.
2873
+ *
2874
+ * @param - an array of ids of Tabs to hide, the ids not passed
2875
+ * will be shown.
2876
+ * @example
2877
+ * ```js
2878
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
2879
+ * '630496d6-6903-4601-937e-2c691821af3c',
2880
+ * 'i547ec54-2a37-4516-a222-2b06719af726'])
2881
+ * ```
2882
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2670
2883
  */
2671
- ResetSearch = "resetSearch"
2884
+ SetHiddenTabs = "SetPinboardHiddenTabs"
2672
2885
  }
2673
2886
  /**
2674
2887
  * The different visual modes that the data sources panel within
@@ -2745,26 +2958,51 @@ export declare enum Param {
2745
2958
  HideEurekaSuggestions = "hideEurekaSuggestions",
2746
2959
  HideLiveboardHeader = "hideLiveboardHeader",
2747
2960
  ShowLiveboardDescription = "showLiveboardDescription",
2748
- ShowLiveboardTitle = "showLiveboardTitle"
2961
+ ShowLiveboardTitle = "showLiveboardTitle",
2962
+ HiddenTabs = "hideTabs",
2963
+ VisibleTabs = "visibleTabs",
2964
+ HideTabPanel = "hideTabPanel",
2965
+ HideSampleQuestions = "hideSampleQuestions",
2966
+ WorksheetId = "worksheetId",
2967
+ Query = "query,"
2749
2968
  }
2750
2969
  /**
2751
- * The list of actions that can be performed on visual ThoughtSpot
2752
- * entities, such as answers and Liveboards.
2753
- *
2754
- * This enum is used to specify the actions that could be disabled,
2755
- * hidden or made visible.
2970
+ * ThoughtSpot application pages include actions and menu commands
2971
+ * for various user-initiated operations. These actions are represented
2972
+ * as enumeration members in the SDK. To show, hide, or disable
2973
+ * specific actions in the embedded view, define the Action
2974
+ * enumeration members in the `disabledActions`, `visibleActions`,
2975
+ * or `hiddenActions` array.
2756
2976
  *
2757
2977
  * @example
2758
2978
  * ```js
2759
2979
  * const embed = new LiveboardEmbed('#embed-container', {
2760
2980
  * ... // other options
2761
- * visibleActions: [Action.Save, Action.Explore],
2762
- * disableActions: [Action.Save],
2763
- * hiddenActions: [Action.Download], // Set either this or visibleActions
2981
+ * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
2982
+ * disabledActions: [Action.Download],
2983
+ * //hiddenActions: [], // Set either this or visibleActions
2984
+ * })
2985
+ * ```
2986
+ * @example
2987
+ * ```js
2988
+ * const embed = new LiveboardEmbed('#embed-container', {
2989
+ * ... // other options
2990
+ * //visibleActions: [],
2991
+ * disabledActions: [Action.Download],
2992
+ * hiddenActions: [Action.Edit, ActionAction.Explore],
2764
2993
  * })
2765
2994
  * ```
2766
2995
  */
2767
2996
  export declare enum Action {
2997
+ /**
2998
+ * The **Save** action on an Answer or Liveboard.
2999
+ * Allows users to save the changes.
3000
+ *
3001
+ * @example
3002
+ * ```js
3003
+ * disabledActions: [Action.SaveAsView]
3004
+ * ```
3005
+ */
2768
3006
  Save = "save",
2769
3007
  /**
2770
3008
  * @hidden
@@ -2774,27 +3012,147 @@ export declare enum Action {
2774
3012
  * @hidden
2775
3013
  */
2776
3014
  SaveUntitled = "saveUntitled",
3015
+ /**
3016
+ * The **Save as View** action on the Answer
3017
+ * page. Saves an Answer as a View object.
3018
+ *
3019
+ * @example
3020
+ * ```js
3021
+ * disabledActions: [Action.SaveAsView]
3022
+ * ```
3023
+ */
2777
3024
  SaveAsView = "saveAsView",
3025
+ /**
3026
+ * The **Make a copy** action on a Liveboard or Answer
3027
+ * page.
3028
+ * Creates a copy of the Liveboard, visualization,
3029
+ * or Answer.
3030
+ *
3031
+ * @example
3032
+ * ```js
3033
+ * disabledActions: [Action.MakeACopy]
3034
+ * ```
3035
+ */
2778
3036
  MakeACopy = "makeACopy",
3037
+ /**
3038
+ * The **Copy and Edit** action on a Liveboard.
3039
+ * This action is now replaced with `Action.MakeACopy`.
3040
+ *
3041
+ * @example
3042
+ * ```js
3043
+ * disabledActions: [Action.EditACopy]
3044
+ * ```
3045
+ */
2779
3046
  EditACopy = "editACopy",
3047
+ /**
3048
+ * The **Copy link** menu action on a Liveboard visualization.
3049
+ * Copies the visualization URL
3050
+ *
3051
+ * @example
3052
+ * ```js
3053
+ * disabledActions: [Action.CopyLink]
3054
+ * ```
3055
+ */
2780
3056
  CopyLink = "embedDocument",
2781
3057
  /**
2782
3058
  * @hidden
2783
3059
  */
2784
3060
  ResetLayout = "resetLayout",
2785
- Schedule = "subscription",
2786
- SchedulesList = "schedule-list",
2787
- Share = "share",
2788
- AddFilter = "addFilter",
2789
- ConfigureFilter = "configureFilter",
2790
- CollapseDataSources = "collapseDataSources",
2791
- ChooseDataSources = "chooseDataSources",
2792
- AddFormula = "addFormula",
2793
- AddParameter = "addParameter",
2794
3061
  /**
2795
- * @hidden
2796
- */
3062
+ * The **Schedule** menu action on a Liveboard.
3063
+ * Allows scheduling a Liveboard notification.
3064
+ *
3065
+ * @example
3066
+ * ```js
3067
+ * disabledActions: [Action.Schedule]
3068
+ * ```
3069
+ */
3070
+ Schedule = "subscription",
3071
+ /**
3072
+ * The **Manage schedules** menu action on a Liveboard.
3073
+ * Allows users to manage scheduled Liveboard jobs.
3074
+ *
3075
+ * @example
3076
+ * ```js
3077
+ * disabledActions: [Action.SchedulesList]
3078
+ * ```
3079
+ */
3080
+ SchedulesList = "schedule-list",
3081
+ /**
3082
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
3083
+ * Allows users to share an object with other users and groups.
3084
+ *
3085
+ * @example
3086
+ * ```js
3087
+ * disabledActions: [Action.Share]
3088
+ * ```
3089
+ */
3090
+ Share = "share",
3091
+ /**
3092
+ * The **Add filter** action on a Liveboard and Search page.
3093
+ * Allows adding filters to Answers and visualizations on a Liveboard.
3094
+ *
3095
+ * @example
3096
+ * ```js
3097
+ * disabledActions: [Action.AddFilter]
3098
+ * ```
3099
+ */
3100
+ AddFilter = "addFilter",
3101
+ /**
3102
+ * Filter configuration options on a Liveboard and Search page.
3103
+ * Allows configuring filter options when adding filters to a
3104
+ * Liveboard or Answer.
3105
+ *
3106
+ * @example
3107
+ * ```js
3108
+ * disabledActions: [Action.ConfigureFilter]
3109
+ * ```
3110
+ */
3111
+ ConfigureFilter = "configureFilter",
3112
+ CollapseDataSources = "collapseDataSources",
3113
+ /**
3114
+ * The **Choose sources** button on Search page.
3115
+ * Allows selecting data sources for search queries.
3116
+ *
3117
+ * @example
3118
+ * ```js
3119
+ * disabledActions: [Action.ChooseDataSources]
3120
+ * ```
3121
+ */
3122
+ ChooseDataSources = "chooseDataSources",
3123
+ /**
3124
+ * The **Create formula** action on a Search or Answer page.
3125
+ * Allows adding formulas to an Answer.
3126
+ *
3127
+ * @example
3128
+ * ```js
3129
+ * disabledActions: [Action.AddFormula]
3130
+ * ```
3131
+ */
3132
+ AddFormula = "addFormula",
3133
+ /**
3134
+ * The **Add parameter** action on a Liveboard or Answer.
3135
+ * Allows adding Parameters to a Liveboard or Answer.
3136
+ *
3137
+ * @example
3138
+ * ```js
3139
+ * disabledActions: [Action.AddParameter]
3140
+ * ```
3141
+ */
3142
+ AddParameter = "addParameter",
3143
+ /**
3144
+ * @hidden
3145
+ */
2797
3146
  SearchOnTop = "searchOnTop",
3147
+ /**
3148
+ * The **SpotIQ analyze** menu action on a visualization or
3149
+ * Answer page.
3150
+ *
3151
+ * @example
3152
+ * ```js
3153
+ * disabledActions: [Action.SpotIQAnalyze]
3154
+ * ```
3155
+ */
2798
3156
  SpotIQAnalyze = "spotIQAnalyze",
2799
3157
  /**
2800
3158
  * @hidden
@@ -2809,24 +3167,165 @@ export declare enum Action {
2809
3167
  * @hidden
2810
3168
  */
2811
3169
  ReplaySearch = "replaySearch",
3170
+ /**
3171
+ * The **Show underlying data** menu action on a visualization or
3172
+ * Answer page.
3173
+ *
3174
+ * @example
3175
+ * ```js
3176
+ * disabledActions: [Action.ShowUnderlyingData]
3177
+ * ```
3178
+ */
2812
3179
  ShowUnderlyingData = "showUnderlyingData",
3180
+ /**
3181
+ * The **Download** menu action on Liveboard visualizations
3182
+ * and Answers.
3183
+ * Allows downloading a visualization or Answer.
3184
+ *
3185
+ * @example
3186
+ * ```js
3187
+ * disabledActions: [Action.DownloadAsPng]
3188
+ * ```
3189
+ */
2813
3190
  Download = "download",
3191
+ /**
3192
+ * The **Download** > **PNG** menu action for charts on a Liveboard
3193
+ * or Answer page.
3194
+ * Downloads a visualization or Answer as a PNG file.
3195
+ *
3196
+ * @example
3197
+ * ```js
3198
+ * disabledActions: [Action.DownloadAsPng]
3199
+ * ```
3200
+ */
2814
3201
  DownloadAsPng = "downloadAsPng",
3202
+ /**
3203
+ * The **Download** > **PDF** menu action on a Liveboard.
3204
+ * Downloads a visualization or Answer as a PDF file.
3205
+ *
3206
+ * @example
3207
+ * ```js
3208
+ * disabledActions: [Action.DownloadAsPdf]
3209
+ * ```
3210
+ */
2815
3211
  DownloadAsPdf = "downloadAsPdf",
3212
+ /**
3213
+ * The **Download** > **CSV** menu action for tables on a Liveboard
3214
+ * or Answer page.
3215
+ * Downloads a visualization or Answer in the XLSX format.
3216
+ *
3217
+ * @example
3218
+ * ```js
3219
+ * disabledActions: [Action.DownloadAsCsv]
3220
+ * ```
3221
+ */
2816
3222
  DownloadAsCsv = "downloadAsCSV",
3223
+ /**
3224
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
3225
+ * or Answer page.
3226
+ * Downloads a visualization or Answer in the XLSX format.
3227
+ *
3228
+ * @example
3229
+ * ```js
3230
+ * disabledActions: [Action.DownloadAsXlsx]
3231
+ * ```
3232
+ */
2817
3233
  DownloadAsXlsx = "downloadAsXLSX",
2818
3234
  /**
2819
3235
  * @hidden
2820
3236
  */
2821
3237
  DownloadTrace = "downloadTrace",
3238
+ /**
3239
+ * The **Export TML** menu action on Liveboard, Answers
3240
+ * Worksheets and Data Connections page.
3241
+ * Exports an object as a TML file.
3242
+ *
3243
+ * @example
3244
+ * ```js
3245
+ * disabledActions: [Action.ExportTML]
3246
+ * ```
3247
+ */
2822
3248
  ExportTML = "exportTSL",
3249
+ /**
3250
+ * The **Import TML** menu action for Liveboards and Answers.
3251
+ * Imports TML representation of ThoughtSpot objects.
3252
+ *
3253
+ * @example
3254
+ * ```js
3255
+ * disabledActions: [Action.ImportTML]
3256
+ * ```
3257
+ */
2823
3258
  ImportTML = "importTSL",
3259
+ /**
3260
+ * The **Update TML** menu action for Liveboards and Answers.
3261
+ * Update TML representation of ThoughtSpot objects.
3262
+ *
3263
+ * @example
3264
+ * ```js
3265
+ * disabledActions: [Action.UpdateTML]
3266
+ * ```
3267
+ */
2824
3268
  UpdateTML = "updateTSL",
3269
+ /**
3270
+ * The **Edit TML** menu action for Liveboards and Answers.
3271
+ * Opens the TML editor.
3272
+ *
3273
+ * @example
3274
+ * ```js
3275
+ * disabledActions: [Action.EditTML]
3276
+ * ```
3277
+ */
2825
3278
  EditTML = "editTSL",
3279
+ /**
3280
+ * The **Present** menu action for Liveboards and Answers.
3281
+ * Allows presenting a Liveboard or visualization in
3282
+ * slideshow mode.
3283
+ *
3284
+ * @example
3285
+ * ```js
3286
+ * disabledActions: [Action.Present]
3287
+ * ```
3288
+ */
2826
3289
  Present = "present",
3290
+ /**
3291
+ * The tile resize options in the visualization menu.
3292
+ * Allows switching between different preset layouts.
3293
+ *
3294
+ * @example
3295
+ * ```js
3296
+ * disabledActions: [Action.ToggleSize]
3297
+ * ```
3298
+ */
2827
3299
  ToggleSize = "toggleSize",
3300
+ /**
3301
+ * The *Edit* action on the Liveboard page and in the
3302
+ * visualization menu.
3303
+ * Opens a Liveboard or visualization in edit mode.
3304
+ *
3305
+ * @example
3306
+ * ```js
3307
+ * disabledActions: [Action.Edit]
3308
+ * ```
3309
+ */
2828
3310
  Edit = "edit",
3311
+ /**
3312
+ * The text edit option for Liveboard and visualization titles.
3313
+ *
3314
+ * @example
3315
+ * ```js
3316
+ * disabledActions: [Action.EditTitle]
3317
+ * ```
3318
+ */
2829
3319
  EditTitle = "editTitle",
3320
+ /**
3321
+ * The **Delete** menu action on Liveboards and visualizations.
3322
+ * Deletes a Liveboard or a visualization from a Liveboard.
3323
+ *
3324
+ * @example
3325
+ * ```js
3326
+ * disabledActions: [Action.Remove]
3327
+ * ```
3328
+ */
2830
3329
  Remove = "delete",
2831
3330
  /**
2832
3331
  * @hidden
@@ -2848,6 +3347,17 @@ export declare enum Action {
2848
3347
  * @hidden
2849
3348
  */
2850
3349
  PinboardInfo = "pinboardInfo",
3350
+ /**
3351
+ * The **Show Liveboard details** menu action on a Liveboard.
3352
+ * Displays details such as the name, description, and
3353
+ * author of the Liveboard, and timestamp of Liveboard creation
3354
+ * and update.
3355
+ *
3356
+ * @example
3357
+ * ```js
3358
+ * disabledActions: [Action.LiveboardInfo]
3359
+ * ```
3360
+ */
2851
3361
  LiveboardInfo = "pinboardInfo",
2852
3362
  /**
2853
3363
  * @hidden
@@ -2858,20 +3368,67 @@ export declare enum Action {
2858
3368
  */
2859
3369
  DownloadEmbraceQueries = "downloadEmbraceQueries",
2860
3370
  /**
2861
- * Pin action.
3371
+ * The **Pin** menu action on an Answer or
3372
+ * Search results page.
3373
+ *
3374
+ * @example
3375
+ * ```js
3376
+ * disabledActions: [Action.Pin]
3377
+ * ```
2862
3378
  */
2863
3379
  Pin = "pin",
2864
3380
  /**
2865
3381
  * @hidden
2866
3382
  */
2867
3383
  AnalysisInfo = "analysisInfo",
3384
+ /**
3385
+ * The **Schedule** menu action on a Liveboard.
3386
+ *
3387
+ * @example
3388
+ * ```js
3389
+ * disabledActions: [Action.Subscription]
3390
+ * ```
3391
+ */
2868
3392
  Subscription = "subscription",
2869
3393
  /**
2870
- * Explore action.
3394
+ * The **Explore** action on Liveboard visualizations
3395
+ *
3396
+ * @example
3397
+ * ```js
3398
+ * disabledActions: [Action.Explore]
3399
+ * ```
2871
3400
  */
2872
3401
  Explore = "explore",
3402
+ /**
3403
+ * The action to include data points on a drilled-down Answer
3404
+ * or visualization
3405
+ *
3406
+ * @example
3407
+ * ```js
3408
+ * disabledActions: [Action.DrillInclude]
3409
+ * ```
3410
+ */
2873
3411
  DrillInclude = "context-menu-item-include",
3412
+ /**
3413
+ * The action to exclude data points on a drilled-down Answer
3414
+ * or visualization
3415
+ *
3416
+ * @example
3417
+ * ```js
3418
+ * disabledActions: [Action.DrillInclude]
3419
+ * ```
3420
+ */
2874
3421
  DrillExclude = "context-menu-item-exclude",
3422
+ /**
3423
+ * The **Copy to clipboard** menu action on tables in an Answer
3424
+ * or Liveboard.
3425
+ * Copies the selected data point.
3426
+ *
3427
+ * @example
3428
+ * ```js
3429
+ * disabledActions: [Action.CopyToClipboard]
3430
+ * ```
3431
+ */
2875
3432
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
2876
3433
  CopyAndEdit = "context-menu-item-copy-and-edit",
2877
3434
  /**
@@ -2880,89 +3437,291 @@ export declare enum Action {
2880
3437
  DrillEdit = "context-menu-item-edit",
2881
3438
  EditMeasure = "context-menu-item-edit-measure",
2882
3439
  Separator = "context-menu-item-separator",
3440
+ /**
3441
+ * The **Drill down** menu action on Answers and Liveboard
3442
+ * visualizations.
3443
+ * Allows drilling down to a specific data point on a chart or table.
3444
+ *
3445
+ * @example
3446
+ * ```js
3447
+ * disabledActions: [Action.DrillDown]
3448
+ * ```
3449
+ */
2883
3450
  DrillDown = "DRILL",
3451
+ /**
3452
+ * The request access action on Liveboards.
3453
+ * Allows users with view permissions to request edit access to a Liveboard.
3454
+ *
3455
+ * @example
3456
+ * ```js
3457
+ * disabledActions: [Action.RequestAccess]
3458
+ * ```
3459
+ */
2884
3460
  RequestAccess = "requestAccess",
2885
- QueryDetailsButtons = "queryDetailsButtons",
2886
3461
  /**
2887
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3462
+ * The **Query visualizer** and **Query SQL** buttons in Query details panel
3463
+ * of the Answer page
3464
+ *
3465
+ * @example
3466
+ * ```js
3467
+ * disabledActions: [Action.QueryDetailsButtons]
3468
+ * ```
3469
+ */
3470
+ QueryDetailsButtons = "QueryDetailsButtons",
3471
+ /**
3472
+ * The **Delete** action for Answers.
3473
+ *
3474
+ * @example
3475
+ * ```js
3476
+ * disabledActions: [Action.AnswerDelete]
3477
+ * ```
3478
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2888
3479
  */
2889
3480
  AnswerDelete = "onDeleteAnswer",
2890
3481
  /**
2891
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3482
+ * The Chart switcher icon on Answer and visualization pages.
3483
+ *
3484
+ * @example
3485
+ * ```js
3486
+ * disabledActions: [Action.AnswerChartSwitcher]
3487
+ * ```
3488
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2892
3489
  */
2893
3490
  AnswerChartSwitcher = "answerChartSwitcher",
2894
3491
  /**
2895
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3492
+ * Favorites icon (*) on Answers, Liveboard, and Data pages
3493
+ *
3494
+ * @example
3495
+ * ```js
3496
+ * disabledActions: [Action.AddToFavorites]
3497
+ * ```
3498
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2896
3499
  */
2897
3500
  AddToFavorites = "addToFavorites",
2898
3501
  /**
2899
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
3502
+ * The edit icon on Liveboards (Classic experience).
3503
+ *
3504
+ * @example
3505
+ * ```js
3506
+ * disabledActions: [Action.EditDetails]
3507
+ * ```
3508
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2900
3509
  */
2901
3510
  EditDetails = "editDetails",
2902
3511
  /**
2903
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
3512
+ * The Create alert action on KPI charts.
3513
+ *
3514
+ * @example
3515
+ * ```js
3516
+ * disabledActions: [Action.CreateMonitor ]
3517
+ * ```
3518
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2904
3519
  */
2905
3520
  CreateMonitor = "createMonitor",
2906
3521
  /**
2907
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
3522
+ * @example
3523
+ * ```js
3524
+ * disabledActions: [Action.ReportError]
3525
+ * ```
3526
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2908
3527
  */
2909
3528
  ReportError = "reportError",
3529
+ /**
3530
+ * The **Sync to sheets** action on Answers and Liveboard visualizations.
3531
+ * Allows sending data to a Google Sheet.
3532
+ *
3533
+ * @example
3534
+ * ```js
3535
+ * disabledActions: [Action.SyncToSheets]
3536
+ * ```
3537
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3538
+ */
2910
3539
  SyncToSheets = "sync-to-sheets",
3540
+ /**
3541
+ * The **Sync to other apps** action on Answers and Liveboard visualizations.
3542
+ * Allows sending data to third-party apps like Slack, Salesforce,
3543
+ * Microsoft Teams, and so on.
3544
+ *
3545
+ * @example
3546
+ * ```js
3547
+ * disabledActions: [Action.SyncToOtherApps]
3548
+ * ```
3549
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3550
+ */
2911
3551
  SyncToOtherApps = "sync-to-other-apps",
3552
+ /**
3553
+ * The **Manage pipelines** action on Answers and Liveboard visualizations.
3554
+ * Allows users to manage data sync pipelines to third-party apps.
3555
+ *
3556
+ * @example
3557
+ * ```js
3558
+ * disabledActions: [Action.SyncToOtherApps]
3559
+ * ```
3560
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
3561
+ */
2912
3562
  ManagePipelines = "manage-pipeline",
2913
3563
  /**
3564
+ * The **Filter** action on Liveboard visualizations.
3565
+ * Allows users to apply cross-filters on a Liveboard.
3566
+ *
3567
+ * @example
3568
+ * ```js
3569
+ * disabledActions: [Action.CrossFilter]
3570
+ * ```
2914
3571
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2915
3572
  */
2916
3573
  CrossFilter = "context-menu-item-cross-filter",
2917
3574
  /**
3575
+ * The **Remove** action that appears when cross filters are applied
3576
+ * on a Liveboard.
3577
+ * Removes filters applied o a visualization.
3578
+ *
3579
+ * @example
3580
+ * ```js
3581
+ * disabledActions: [Action.RemoveCrossFilter]
3582
+ * ```
2918
3583
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2919
3584
  */
2920
3585
  RemoveCrossFilter = "context-menu-item-remove-cross-filter",
2921
3586
  /**
3587
+ * The **Aggregate** option in the chart axis or the
3588
+ * table column customization menu.
3589
+ * Provides aggregation options to analyze the data on a chart or table.
3590
+ *
3591
+ * @example
3592
+ * ```js
3593
+ * disabledActions: [Action.AxisMenuAggregate]
3594
+ * ```
2922
3595
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2923
3596
  */
2924
3597
  AxisMenuAggregate = "axisMenuAggregate",
2925
3598
  /**
3599
+ * The **Time bucket** option in the chart axis or table column
3600
+ * customization menu.
3601
+ * Allows defining time metric for date comparison.
3602
+ *
3603
+ * @example
3604
+ * ```js
3605
+ * disabledActions: [Action.AxisMenuTimeBucket]
3606
+ * ```
2926
3607
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2927
3608
  */
2928
3609
  AxisMenuTimeBucket = "axisMenuTimeBucket",
2929
3610
  /**
3611
+ * The **Filter** action in the chart axis or table column
3612
+ * customization menu.
3613
+ *
3614
+ * @example
3615
+ * ```js
3616
+ * disabledActions: [Action.AxisMenuFilter]
3617
+ * ```
2930
3618
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2931
3619
  */
2932
3620
  AxisMenuFilter = "axisMenuFilter",
2933
3621
  /**
3622
+ * The **Conditional formatting** action on chart or table.
3623
+ * Allows adding rules for conditional formatting of data
3624
+ * points on a chart or table.
3625
+ *
3626
+ * @example
3627
+ * ```js
3628
+ * disabledActions: [Action.AxisMenuConditionalFormat]
3629
+ * ```
2934
3630
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2935
3631
  */
2936
3632
  AxisMenuConditionalFormat = "axisMenuConditionalFormat",
2937
3633
  /**
3634
+ * The **Sort** menu action on a table or chart axis
3635
+ * Sorts data in ascending or descending order.
3636
+ * Allows adding, editing, or removing filters.
3637
+ *
3638
+ * @example
3639
+ * ```js
3640
+ * disabledActions: [Action.AxisMenuConditionalFormat]
3641
+ * ```
2938
3642
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2939
3643
  */
2940
3644
  AxisMenuSort = "axisMenuSort",
2941
3645
  /**
3646
+ * The **Group** option in the chart axis or table column
3647
+ * customization menu.
3648
+ * Allows grouping data points if the axes use the same
3649
+ * unit of measurement and a similar scale.
3650
+ *
3651
+ * @example
3652
+ * ```js
3653
+ * disabledActions: [Action.AxisMenuGroup]
3654
+ * ```
2942
3655
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2943
3656
  */
2944
3657
  AxisMenuGroup = "axisMenuGroup",
2945
3658
  /**
3659
+ * The **Position** option in the axis customization menu.
3660
+ * Allows changing the position of the axis to the
3661
+ * left or right side of the chart.
3662
+ *
3663
+ * @example
3664
+ * ```js
3665
+ * disabledActions: [Action.AxisMenuPosition]
3666
+ * ```
2946
3667
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2947
3668
  */
2948
3669
  AxisMenuPosition = "axisMenuPosition",
2949
3670
  /**
3671
+ * The **Rename** option in the chart axis or table column customization menu.
3672
+ * Renames the axis label on a chart or the column header on a table.
3673
+ *
3674
+ * @example
3675
+ * ```js
3676
+ * disabledActions: [Action.AxisMenuRename]
3677
+ * ```
2950
3678
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2951
3679
  */
2952
3680
  AxisMenuRename = "axisMenuRename",
2953
3681
  /**
3682
+ * The **Edit** action in the axis customization menu.
3683
+ * Allows editing the axis name, position, minimum and maximum values,
3684
+ * and format of a column.
3685
+ *
3686
+ * @example
3687
+ * ```js
3688
+ * disabledActions: [Action.AxisMenuEdit]
3689
+ * ```
2954
3690
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2955
3691
  */
2956
3692
  AxisMenuEdit = "axisMenuEdit",
2957
3693
  /**
3694
+ * The **Number format** action to customize the format of
3695
+ * the data labels on a chart or table.
3696
+ *
3697
+ * @example
3698
+ * ```js
3699
+ * disabledActions: [Action.AxisMenuNumberFormat]
3700
+ * ```
2958
3701
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2959
3702
  */
2960
3703
  AxisMenuNumberFormat = "axisMenuNumberFormat",
2961
3704
  /**
3705
+ * The **Text wrapping** action on a table.
3706
+ * Wraps or clips column text on a table.
3707
+ *
3708
+ * @example
3709
+ * ```js
3710
+ * disabledActions: [Action.AxisMenuTextWrapping]
3711
+ * ```
2962
3712
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2963
3713
  */
2964
3714
  AxisMenuTextWrapping = "axisMenuTextWrapping",
2965
3715
  /**
3716
+ * The **Remove** action in the chart axis or table column
3717
+ * customization menu.
3718
+ * Removes the data labels from a chart or the column of a
3719
+ * table visualization.
3720
+ *
3721
+ * @example
3722
+ * ```js
3723
+ * disabledActions: [Action.AxisMenuRemove]
3724
+ * ```
2966
3725
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2967
3726
  */
2968
3727
  AxisMenuRemove = "axisMenuRemove",
@@ -2971,9 +3730,48 @@ export declare enum Action {
2971
3730
  */
2972
3731
  InsertInToSlide = "insertInToSlide",
2973
3732
  /**
3733
+ * The **Rename** menu action on Liveboards and visualizations.
3734
+ * Allows renaming a Liveboard or visualization.
3735
+ *
3736
+ * @example
3737
+ * ```js
3738
+ * disabledActions: [Action.RenameModalTitleDescription]
3739
+ * ```
2974
3740
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2975
3741
  */
2976
- RenameModalTitleDescription = "renameModalTitleDescription"
3742
+ RenameModalTitleDescription = "renameModalTitleDescription",
3743
+ /**
3744
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3745
+ */
3746
+ RequestVerification = "requestVerification",
3747
+ /**
3748
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3749
+ */
3750
+ MarkAsVerified = "markAsVerified",
3751
+ /**
3752
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3753
+ */
3754
+ AddTab = "addTab",
3755
+ /**
3756
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3757
+ */
3758
+ EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
3759
+ /**
3760
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3761
+ */
3762
+ ShowSageQuery = "showSageQuery",
3763
+ /**
3764
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3765
+ */
3766
+ EditSageAnswer = "editSageAnswer",
3767
+ /**
3768
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3769
+ */
3770
+ SageAnswerFeedback = "sageAnswerFeedback",
3771
+ /**
3772
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3773
+ */
3774
+ ModifySageAnswer = "modifySageAnswer"
2977
3775
  }
2978
3776
  export interface SessionInterface {
2979
3777
  sessionId: string;
@@ -3090,7 +3888,15 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
3090
3888
  * @param fn The function being registered
3091
3889
  */
3092
3890
  export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
3891
+ /**
3892
+ * @param data
3893
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3894
+ */
3093
3895
  export declare const executeTML: (data: executeTMLInput) => Promise<any>;
3896
+ /**
3897
+ * @param data
3898
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3899
+ */
3094
3900
  export declare const exportTML: (data: exportTMLInput) => Promise<any>;
3095
3901
  /**
3096
3902
  *
@@ -3404,7 +4210,7 @@ export interface CustomCssVariables {
3404
4210
  * Background color of the primary buttons. For example, the primary buttons such as
3405
4211
  * Pin* and *Save*.
3406
4212
  */
3407
- '---ts-var-button--primary-background'?: string;
4213
+ '--ts-var-button--primary-background'?: string;
3408
4214
  /**
3409
4215
  * Background color of the primary buttons on hover.
3410
4216
  */