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