@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.
- package/README.md +1 -1
- package/cjs/package.json +8 -1
- package/cjs/src/css-variables.d.ts +1 -1
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +1 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +8 -0
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +8 -0
- package/cjs/src/embed/base.js.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 +15 -0
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +13 -3
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/sage.spec.js +1 -1
- package/cjs/src/embed/sage.spec.js.map +1 -1
- package/cjs/src/embed/search.d.ts +4 -0
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +1 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +11 -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/react/index.spec.js +12 -0
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/types.d.ts +972 -199
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +914 -180
- 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/app.d.ts +1 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +8 -0
- package/dist/src/embed/base.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 +15 -0
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +4 -0
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +972 -199
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +945 -188
- package/dist/tsembed-react.js +927 -180
- package/dist/tsembed.es.js +953 -188
- package/dist/tsembed.js +935 -180
- package/dist/visual-embed-sdk-react-full.d.ts +1008 -202
- package/dist/visual-embed-sdk-react.d.ts +1018 -212
- package/dist/visual-embed-sdk.d.ts +1018 -212
- package/lib/package.json +8 -1
- package/lib/src/css-variables.d.ts +1 -1
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +1 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +8 -0
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +8 -0
- package/lib/src/embed/base.js.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 +15 -0
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +13 -3
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/sage.spec.js +1 -1
- package/lib/src/embed/sage.spec.js.map +1 -1
- package/lib/src/embed/search.d.ts +4 -0
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +1 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +11 -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/react/index.spec.js +12 -0
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +972 -199
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +914 -180
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +1018 -212
- package/package.json +8 -1
- package/src/css-variables.ts +1 -1
- package/src/embed/app.ts +1 -1
- package/src/embed/base.ts +8 -0
- package/src/embed/liveboard.spec.ts +16 -0
- package/src/embed/liveboard.ts +10 -0
- package/src/embed/sage.spec.ts +1 -1
- package/src/embed/sage.ts +25 -2
- package/src/embed/search.ts +5 -0
- package/src/embed/ts-embed.spec.ts +79 -0
- package/src/embed/ts-embed.ts +13 -1
- package/src/react/index.spec.tsx +29 -0
- package/src/types.ts +973 -199
|
@@ -172,6 +172,7 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
172
172
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
173
173
|
* GPT and LLM.
|
|
174
174
|
*
|
|
175
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
175
176
|
* @group Embed components
|
|
176
177
|
*/
|
|
177
178
|
export interface SageViewConfig extends ViewConfig {
|
|
@@ -192,11 +193,25 @@ export interface SageViewConfig extends ViewConfig {
|
|
|
192
193
|
*
|
|
193
194
|
*/
|
|
194
195
|
showObjectSuggestions?: boolean;
|
|
196
|
+
/**
|
|
197
|
+
* The query string to pre-fill in natual language search bar
|
|
198
|
+
*/
|
|
199
|
+
searchQuery?: string;
|
|
200
|
+
/**
|
|
201
|
+
* If set to true, sample questions would be hidden to user.
|
|
202
|
+
* These sample questions are autogenerated based on selected datasource.
|
|
203
|
+
*/
|
|
204
|
+
hideSampleQuestions?: boolean;
|
|
205
|
+
/**
|
|
206
|
+
* The data source GUID to set on load.
|
|
207
|
+
*/
|
|
208
|
+
dataSource?: string;
|
|
195
209
|
}
|
|
196
210
|
export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
197
211
|
/**
|
|
198
212
|
* Embed ThoughtSpot LLM and GPT based natural language search component.
|
|
199
213
|
*
|
|
214
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
200
215
|
* @group Embed components
|
|
201
216
|
*/
|
|
202
217
|
export declare class SageEmbed extends V1Embed {
|
|
@@ -266,6 +281,10 @@ export interface SearchViewConfig extends ViewConfig {
|
|
|
266
281
|
* using raw answer data.
|
|
267
282
|
*/
|
|
268
283
|
hideResults?: boolean;
|
|
284
|
+
/**
|
|
285
|
+
* If set to true, expands all the data sources panel.
|
|
286
|
+
*/
|
|
287
|
+
expandAllDataSource?: boolean;
|
|
269
288
|
/**
|
|
270
289
|
* If set to true, the Search Assist feature is enabled.
|
|
271
290
|
*
|
|
@@ -372,7 +391,7 @@ export declare enum Page {
|
|
|
372
391
|
/**
|
|
373
392
|
* SpotIQ listing page
|
|
374
393
|
*/
|
|
375
|
-
SpotIQ = "
|
|
394
|
+
SpotIQ = "insights"
|
|
376
395
|
}
|
|
377
396
|
/**
|
|
378
397
|
* The view configuration for full app embedding.
|
|
@@ -571,6 +590,12 @@ export interface LiveboardViewConfig extends ViewConfig {
|
|
|
571
590
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
572
591
|
*/
|
|
573
592
|
activeTabId?: string;
|
|
593
|
+
/**
|
|
594
|
+
* Hide tab Panel of embedded LB
|
|
595
|
+
*
|
|
596
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
597
|
+
*/
|
|
598
|
+
hideTabPanel?: boolean;
|
|
574
599
|
}
|
|
575
600
|
/**
|
|
576
601
|
* Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
|
|
@@ -948,7 +973,15 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
948
973
|
* @param fn The function being registered
|
|
949
974
|
*/
|
|
950
975
|
export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
976
|
+
/**
|
|
977
|
+
* @param data
|
|
978
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
979
|
+
*/
|
|
951
980
|
export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
981
|
+
/**
|
|
982
|
+
* @param data
|
|
983
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
984
|
+
*/
|
|
952
985
|
export declare const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
953
986
|
/**
|
|
954
987
|
*
|
|
@@ -1302,7 +1335,7 @@ export declare enum AuthType {
|
|
|
1302
1335
|
* .then((data) => data.token);
|
|
1303
1336
|
* }
|
|
1304
1337
|
* ```
|
|
1305
|
-
* @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1
|
|
1338
|
+
* @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1306
1339
|
*/
|
|
1307
1340
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
1308
1341
|
/**
|
|
@@ -1392,6 +1425,9 @@ export interface CustomStyles {
|
|
|
1392
1425
|
export interface CustomisationsInterface {
|
|
1393
1426
|
style?: CustomStyles;
|
|
1394
1427
|
content?: {
|
|
1428
|
+
/**
|
|
1429
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
1430
|
+
*/
|
|
1395
1431
|
strings?: Record<string, any>;
|
|
1396
1432
|
[key: string]: any;
|
|
1397
1433
|
};
|
|
@@ -1473,7 +1509,7 @@ export interface EmbedConfig {
|
|
|
1473
1509
|
*
|
|
1474
1510
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1475
1511
|
*
|
|
1476
|
-
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1
|
|
1512
|
+
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
|
|
1477
1513
|
*/
|
|
1478
1514
|
redirectPath?: string;
|
|
1479
1515
|
/** @internal */
|
|
@@ -1515,14 +1551,14 @@ export interface EmbedConfig {
|
|
|
1515
1551
|
* This flag is typically used alongside the combination of auth modes such as {@link
|
|
1516
1552
|
* AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
|
|
1517
1553
|
*
|
|
1518
|
-
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
1554
|
+
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1519
1555
|
* @default false
|
|
1520
1556
|
*/
|
|
1521
1557
|
disableLoginRedirect?: boolean;
|
|
1522
1558
|
/**
|
|
1523
1559
|
* This message is displayed on the embed view when the login fails.
|
|
1524
1560
|
*
|
|
1525
|
-
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
1561
|
+
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1526
1562
|
*/
|
|
1527
1563
|
loginFailedMessage?: string;
|
|
1528
1564
|
/**
|
|
@@ -1544,7 +1580,7 @@ export interface EmbedConfig {
|
|
|
1544
1580
|
* Dynamic CSS Url to be injected in the loaded application.
|
|
1545
1581
|
* You would also need to set `style-src` in the CSP settings.
|
|
1546
1582
|
*
|
|
1547
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
1583
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1548
1584
|
* @default ''
|
|
1549
1585
|
*/
|
|
1550
1586
|
customCssUrl?: string;
|
|
@@ -1556,13 +1592,13 @@ export interface EmbedConfig {
|
|
|
1556
1592
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
1557
1593
|
* involves an extra network call.
|
|
1558
1594
|
*
|
|
1559
|
-
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
1595
|
+
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1560
1596
|
*/
|
|
1561
1597
|
detectCookieAccessSlow?: boolean;
|
|
1562
1598
|
/**
|
|
1563
1599
|
* Hide beta alert warning message for SearchEmbed.
|
|
1564
1600
|
*
|
|
1565
|
-
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1
|
|
1601
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
1566
1602
|
*/
|
|
1567
1603
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
1568
1604
|
/**
|
|
@@ -1610,7 +1646,7 @@ export interface EmbedConfig {
|
|
|
1610
1646
|
* Disable Full App access of Embedded app outside of the iFrame.
|
|
1611
1647
|
*
|
|
1612
1648
|
* @default true
|
|
1613
|
-
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1
|
|
1649
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1614
1650
|
*/
|
|
1615
1651
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1616
1652
|
/**
|
|
@@ -1713,14 +1749,14 @@ export interface ViewConfig {
|
|
|
1713
1749
|
*
|
|
1714
1750
|
* Use either this or hiddenActions.
|
|
1715
1751
|
*
|
|
1716
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
1752
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1717
1753
|
* @important
|
|
1718
1754
|
*/
|
|
1719
1755
|
visibleActions?: Action[];
|
|
1720
1756
|
/**
|
|
1721
1757
|
* Show alert messages and toast messages in the embedded view.
|
|
1722
1758
|
*
|
|
1723
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1759
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1724
1760
|
*/
|
|
1725
1761
|
showAlerts?: boolean;
|
|
1726
1762
|
/**
|
|
@@ -1731,7 +1767,7 @@ export interface ViewConfig {
|
|
|
1731
1767
|
/**
|
|
1732
1768
|
* The locale/language to use for the embedded view.
|
|
1733
1769
|
*
|
|
1734
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1
|
|
1770
|
+
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
1735
1771
|
*/
|
|
1736
1772
|
locale?: string;
|
|
1737
1773
|
/**
|
|
@@ -1742,7 +1778,7 @@ export interface ViewConfig {
|
|
|
1742
1778
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1743
1779
|
* list of supported keys and values associated with each.
|
|
1744
1780
|
*
|
|
1745
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
1781
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1746
1782
|
*/
|
|
1747
1783
|
additionalFlags?: {
|
|
1748
1784
|
[key: string]: string | number | boolean;
|
|
@@ -1751,7 +1787,7 @@ export interface ViewConfig {
|
|
|
1751
1787
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
1752
1788
|
* You would also need to set `style-src` in the CSP settings.
|
|
1753
1789
|
*
|
|
1754
|
-
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1
|
|
1790
|
+
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
1755
1791
|
* @default ''
|
|
1756
1792
|
*/
|
|
1757
1793
|
customizations?: CustomisationsInterface;
|
|
@@ -1799,24 +1835,60 @@ export interface ViewConfig {
|
|
|
1799
1835
|
/**
|
|
1800
1836
|
* Boolean to hide liveboard header
|
|
1801
1837
|
*
|
|
1802
|
-
* @version SDK: 1.
|
|
1838
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1803
1839
|
* @default false
|
|
1804
1840
|
*/
|
|
1805
1841
|
hideLiveboardHeader?: boolean;
|
|
1806
1842
|
/**
|
|
1807
1843
|
* Boolean to show liveboard title
|
|
1808
1844
|
*
|
|
1809
|
-
* @version SDK: 1.
|
|
1845
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1810
1846
|
* @default false
|
|
1811
1847
|
*/
|
|
1812
1848
|
showLiveboardTitle?: boolean;
|
|
1813
1849
|
/**
|
|
1814
1850
|
* Boolean to show liveboard description
|
|
1815
1851
|
*
|
|
1816
|
-
* @version SDK: 1.
|
|
1852
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1817
1853
|
* @default false
|
|
1818
1854
|
*/
|
|
1819
1855
|
showLiveboardDescription?: boolean;
|
|
1856
|
+
/**
|
|
1857
|
+
* The list of tab IDs to hide from the embedded.
|
|
1858
|
+
* This Tabs will be hidden from their respective LBs.
|
|
1859
|
+
* Use this to hide an tabID.
|
|
1860
|
+
*
|
|
1861
|
+
* @example
|
|
1862
|
+
* ```js
|
|
1863
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
1864
|
+
* ... // other liveboard view config
|
|
1865
|
+
* hiddenTabs: [
|
|
1866
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1867
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1868
|
+
* });
|
|
1869
|
+
* ```
|
|
1870
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1871
|
+
*/
|
|
1872
|
+
hiddenTabs?: string[];
|
|
1873
|
+
/**
|
|
1874
|
+
* The list of tab IDs to show in the embedded.
|
|
1875
|
+
* Only this Tabs will be shown in their respective LBs.
|
|
1876
|
+
* Use this to show an tabID.
|
|
1877
|
+
*
|
|
1878
|
+
* Use either this or hiddenTabs.
|
|
1879
|
+
*
|
|
1880
|
+
* @example
|
|
1881
|
+
* ```js
|
|
1882
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
1883
|
+
* ... // other liveboard view config
|
|
1884
|
+
* visibleTabs: [
|
|
1885
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1886
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1887
|
+
* });
|
|
1888
|
+
* ```
|
|
1889
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1890
|
+
*/
|
|
1891
|
+
visibleTabs?: string[];
|
|
1820
1892
|
}
|
|
1821
1893
|
/**
|
|
1822
1894
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
@@ -2022,7 +2094,7 @@ export declare enum EmbedEvent {
|
|
|
2022
2094
|
* One or more data columns have been selected.
|
|
2023
2095
|
*
|
|
2024
2096
|
* @returns columnIds - the list of columns
|
|
2025
|
-
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
2097
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2026
2098
|
*/
|
|
2027
2099
|
AddRemoveColumns = "addRemoveColumns",
|
|
2028
2100
|
/**
|
|
@@ -2055,7 +2127,7 @@ export declare enum EmbedEvent {
|
|
|
2055
2127
|
* });
|
|
2056
2128
|
* ```
|
|
2057
2129
|
* @return viz, clickedPoint - metadata about point that is clicked
|
|
2058
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2130
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2059
2131
|
* @important
|
|
2060
2132
|
*/
|
|
2061
2133
|
VizPointClick = "vizPointClick",
|
|
@@ -2105,7 +2177,7 @@ export declare enum EmbedEvent {
|
|
|
2105
2177
|
* Emitted when the "Get Data" button in Search Bar embed
|
|
2106
2178
|
* is clicked.
|
|
2107
2179
|
*
|
|
2108
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0
|
|
2180
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
2109
2181
|
*/
|
|
2110
2182
|
GetDataClick = "getDataClick",
|
|
2111
2183
|
/**
|
|
@@ -2135,13 +2207,13 @@ export declare enum EmbedEvent {
|
|
|
2135
2207
|
/**
|
|
2136
2208
|
* Emitted when any modal is opened in the app
|
|
2137
2209
|
*
|
|
2138
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
2210
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2139
2211
|
*/
|
|
2140
2212
|
DialogOpen = "dialog-open",
|
|
2141
2213
|
/**
|
|
2142
2214
|
* Emitted when any modal is closed in the app
|
|
2143
2215
|
*
|
|
2144
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
2216
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2145
2217
|
*/
|
|
2146
2218
|
DialogClose = "dialog-close",
|
|
2147
2219
|
/**
|
|
@@ -2149,136 +2221,136 @@ export declare enum EmbedEvent {
|
|
|
2149
2221
|
* You can use this event as a hook to trigger
|
|
2150
2222
|
* other events on the rendered Liveboard.
|
|
2151
2223
|
*
|
|
2152
|
-
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
2224
|
+
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2153
2225
|
*/
|
|
2154
2226
|
LiveboardRendered = "PinboardRendered",
|
|
2155
2227
|
/**
|
|
2156
2228
|
* This can be used to register an event listener which
|
|
2157
2229
|
* is triggered on all events.
|
|
2158
2230
|
*
|
|
2159
|
-
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
2231
|
+
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2160
2232
|
*/
|
|
2161
2233
|
ALL = "*",
|
|
2162
2234
|
/**
|
|
2163
|
-
* Emitted when
|
|
2235
|
+
* Emitted when an Answer is saved in the app
|
|
2164
2236
|
*
|
|
2165
|
-
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2237
|
+
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2166
2238
|
*/
|
|
2167
2239
|
Save = "save",
|
|
2168
2240
|
/**
|
|
2169
2241
|
* Emitted when the download action is triggered on an answer
|
|
2170
2242
|
*
|
|
2171
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2243
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2172
2244
|
*/
|
|
2173
2245
|
Download = "download",
|
|
2174
2246
|
/**
|
|
2175
2247
|
* Emitted when the download action is triggered on an answer
|
|
2176
2248
|
*
|
|
2177
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0
|
|
2249
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
2178
2250
|
*/
|
|
2179
2251
|
DownloadAsPng = "downloadAsPng",
|
|
2180
2252
|
/**
|
|
2181
2253
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
2182
2254
|
*
|
|
2183
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2255
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2184
2256
|
*/
|
|
2185
2257
|
DownloadAsPdf = "downloadAsPdf",
|
|
2186
2258
|
/**
|
|
2187
2259
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
2188
2260
|
*
|
|
2189
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2261
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2190
2262
|
*/
|
|
2191
2263
|
DownloadAsCsv = "downloadAsCsv",
|
|
2192
2264
|
/**
|
|
2193
2265
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
2194
2266
|
*
|
|
2195
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2267
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2196
2268
|
*/
|
|
2197
2269
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
2198
2270
|
/**
|
|
2199
2271
|
* Emitted when an answer is deleted in the app
|
|
2200
2272
|
*
|
|
2201
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2273
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2202
2274
|
*/
|
|
2203
2275
|
AnswerDelete = "answerDelete",
|
|
2204
2276
|
/**
|
|
2205
2277
|
* Emitted when an answer is pinned to a Liveboard
|
|
2206
2278
|
*
|
|
2207
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2279
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2208
2280
|
*/
|
|
2209
2281
|
Pin = "pin",
|
|
2210
2282
|
/**
|
|
2211
2283
|
* Emitted when SpotIQ analysis is triggered
|
|
2212
2284
|
*
|
|
2213
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2285
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2214
2286
|
*/
|
|
2215
2287
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2216
2288
|
/**
|
|
2217
2289
|
* Emitted when a user shares an object with another user or group
|
|
2218
2290
|
*
|
|
2219
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2291
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2220
2292
|
*/
|
|
2221
2293
|
Share = "share",
|
|
2222
2294
|
/**
|
|
2223
2295
|
* Emitted when a user clicks the Include action to include a specific value or data
|
|
2224
2296
|
* on a chart or table
|
|
2225
2297
|
*
|
|
2226
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2298
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2227
2299
|
*/
|
|
2228
2300
|
DrillInclude = "context-menu-item-include",
|
|
2229
2301
|
/**
|
|
2230
2302
|
* Emitted when a user clicks the Exclude action to exclude a specific value or data
|
|
2231
2303
|
* on a chart or table
|
|
2232
2304
|
*
|
|
2233
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2305
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2234
2306
|
*/
|
|
2235
2307
|
DrillExclude = "context-menu-item-exclude",
|
|
2236
2308
|
/**
|
|
2237
2309
|
* Emitted when copied column value on the app
|
|
2238
2310
|
*
|
|
2239
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2311
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2240
2312
|
*/
|
|
2241
2313
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
2242
2314
|
/**
|
|
2243
2315
|
* Emitted when a user clicks the Update TML action
|
|
2244
2316
|
*
|
|
2245
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2317
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2246
2318
|
*/
|
|
2247
2319
|
UpdateTML = "updateTSL",
|
|
2248
2320
|
/**
|
|
2249
2321
|
* Emitted when a user clicks the Edit TML action
|
|
2250
2322
|
*
|
|
2251
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2323
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2252
2324
|
*/
|
|
2253
2325
|
EditTML = "editTSL",
|
|
2254
2326
|
/**
|
|
2255
2327
|
* Emitted when ExportTML trigger in answer on the app
|
|
2256
2328
|
*
|
|
2257
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2329
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2258
2330
|
*/
|
|
2259
2331
|
ExportTML = "exportTSL",
|
|
2260
2332
|
/**
|
|
2261
2333
|
* Emitted when an answer is saved as a view
|
|
2262
2334
|
*
|
|
2263
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2335
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2264
2336
|
*/
|
|
2265
2337
|
SaveAsView = "saveAsView",
|
|
2266
2338
|
/**
|
|
2267
2339
|
* Emitted when copy of existing answer on the app
|
|
2268
2340
|
*
|
|
2269
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2341
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2270
2342
|
*/
|
|
2271
2343
|
CopyAEdit = "copyAEdit",
|
|
2272
2344
|
/**
|
|
2273
2345
|
* Emitted when a user clicks Show underlying data on an answe
|
|
2274
2346
|
*
|
|
2275
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2347
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2276
2348
|
*/
|
|
2277
2349
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2278
2350
|
/**
|
|
2279
2351
|
* Emitted when an answer is switched to a chart or table view
|
|
2280
2352
|
*
|
|
2281
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
2353
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2282
2354
|
*/
|
|
2283
2355
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
2284
2356
|
/**
|
|
@@ -2290,67 +2362,67 @@ export declare enum EmbedEvent {
|
|
|
2290
2362
|
/**
|
|
2291
2363
|
* Emitted when a user clicks Show Liveboard details on a Liveboard
|
|
2292
2364
|
*
|
|
2293
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2365
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2294
2366
|
*/
|
|
2295
2367
|
LiveboardInfo = "pinboardInfo",
|
|
2296
2368
|
/**
|
|
2297
2369
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
2298
2370
|
*
|
|
2299
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2371
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2300
2372
|
*/
|
|
2301
2373
|
AddToFavorites = "addToFavorites",
|
|
2302
2374
|
/**
|
|
2303
2375
|
* Emitted when a user clicks Schedule on a Liveboard
|
|
2304
2376
|
*
|
|
2305
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2377
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2306
2378
|
*/
|
|
2307
2379
|
Schedule = "subscription",
|
|
2308
2380
|
/**
|
|
2309
2381
|
* Emitted when a user clicks Edit on a Liveboard or visualization
|
|
2310
2382
|
*
|
|
2311
|
-
* @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
|
|
2312
2384
|
*/
|
|
2313
2385
|
Edit = "edit",
|
|
2314
2386
|
/**
|
|
2315
2387
|
* Emitted when a user clicks Make a copy on a Liveboard
|
|
2316
2388
|
*
|
|
2317
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2389
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2318
2390
|
*/
|
|
2319
2391
|
MakeACopy = "makeACopy",
|
|
2320
2392
|
/**
|
|
2321
2393
|
* Emitted when a user clicks Present on a Liveboard or visualization
|
|
2322
2394
|
*
|
|
2323
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2395
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2324
2396
|
*/
|
|
2325
2397
|
Present = "present",
|
|
2326
2398
|
/**
|
|
2327
2399
|
* Emitted when a user clicks Delete on a Liveboard
|
|
2328
2400
|
*
|
|
2329
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2401
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2330
2402
|
*/
|
|
2331
2403
|
Delete = "delete",
|
|
2332
2404
|
/**
|
|
2333
2405
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
2334
2406
|
*
|
|
2335
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2407
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2336
2408
|
*/
|
|
2337
2409
|
SchedulesList = "schedule-list",
|
|
2338
2410
|
/**
|
|
2339
2411
|
* Emitted when a user clicks Cancel in edit mode on a Liveboard
|
|
2340
2412
|
*
|
|
2341
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2413
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2342
2414
|
*/
|
|
2343
2415
|
Cancel = "cancel",
|
|
2344
2416
|
/**
|
|
2345
2417
|
* Emitted when a user clicks Explore on a visualization
|
|
2346
2418
|
*
|
|
2347
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2419
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2348
2420
|
*/
|
|
2349
2421
|
Explore = "explore",
|
|
2350
2422
|
/**
|
|
2351
2423
|
* Emitted when a user clicks Copy link action on a visualization
|
|
2352
2424
|
*
|
|
2353
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2425
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2354
2426
|
*/
|
|
2355
2427
|
CopyLink = "embedDocument",
|
|
2356
2428
|
/**
|
|
@@ -2370,7 +2442,25 @@ export declare enum EmbedEvent {
|
|
|
2370
2442
|
*
|
|
2371
2443
|
* @hidden
|
|
2372
2444
|
*/
|
|
2373
|
-
InsertIntoSlide = "insertInToSlide"
|
|
2445
|
+
InsertIntoSlide = "insertInToSlide",
|
|
2446
|
+
/**
|
|
2447
|
+
* Emitted when a user changes any filter on a Liveboard.
|
|
2448
|
+
*
|
|
2449
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2450
|
+
*/
|
|
2451
|
+
FilterChanged = "filterChanged",
|
|
2452
|
+
/**
|
|
2453
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
2454
|
+
*
|
|
2455
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2456
|
+
*/
|
|
2457
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
2458
|
+
/**
|
|
2459
|
+
* Emitten when a user select data source in Sage Embed
|
|
2460
|
+
*
|
|
2461
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2462
|
+
*/
|
|
2463
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
2374
2464
|
}
|
|
2375
2465
|
/**
|
|
2376
2466
|
* Event types that can be triggered by the host application
|
|
@@ -2396,13 +2486,15 @@ export declare enum EmbedEvent {
|
|
|
2396
2486
|
*/
|
|
2397
2487
|
export declare enum HostEvent {
|
|
2398
2488
|
/**
|
|
2399
|
-
*
|
|
2489
|
+
* Triggers a search query in AppEmbed and SearchEmbed
|
|
2490
|
+
* deployments.
|
|
2491
|
+
* Includes the following properties:
|
|
2400
2492
|
*
|
|
2401
2493
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
2402
2494
|
* - Although an array, only a single source
|
|
2403
|
-
* is supported
|
|
2404
|
-
* @param - searchQuery -
|
|
2405
|
-
* @param - execute -
|
|
2495
|
+
* is supported.
|
|
2496
|
+
* @param - searchQuery - Query string with search tokens
|
|
2497
|
+
* @param - execute - executes the existing / updated query
|
|
2406
2498
|
* @example
|
|
2407
2499
|
* ```js
|
|
2408
2500
|
* searchEmbed.trigger(HostEvent.Search, {
|
|
@@ -2414,13 +2506,14 @@ export declare enum HostEvent {
|
|
|
2414
2506
|
*/
|
|
2415
2507
|
Search = "search",
|
|
2416
2508
|
/**
|
|
2417
|
-
*
|
|
2509
|
+
* Triggers a drill on certain points of the specified column
|
|
2510
|
+
* Includes the following properties:
|
|
2418
2511
|
*
|
|
2419
2512
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2420
|
-
*
|
|
2421
|
-
* @param - columnGuid -
|
|
2422
|
-
*
|
|
2423
|
-
*
|
|
2513
|
+
* to drill to. For example, { selectedPoints: []}
|
|
2514
|
+
* @param - columnGuid - Optional. GUID of the column to drill
|
|
2515
|
+
* by. If not provided it will auto drill by the configured
|
|
2516
|
+
* column.
|
|
2424
2517
|
* @example
|
|
2425
2518
|
* ```js
|
|
2426
2519
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -2453,17 +2546,17 @@ export declare enum HostEvent {
|
|
|
2453
2546
|
*/
|
|
2454
2547
|
Reload = "reload",
|
|
2455
2548
|
/**
|
|
2456
|
-
*
|
|
2549
|
+
* Sets the visible visualizations on a Liveboard.
|
|
2457
2550
|
*
|
|
2458
|
-
* @param -
|
|
2459
|
-
*
|
|
2551
|
+
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
2552
|
+
* in this parameter will be hidden.
|
|
2460
2553
|
* @example
|
|
2461
2554
|
* ```js
|
|
2462
2555
|
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
|
|
2463
2556
|
* '730496d6-6903-4601-937e-2c691821af3c',
|
|
2464
2557
|
* 'd547ec54-2a37-4516-a222-2b06719af726'])
|
|
2465
2558
|
* ```
|
|
2466
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
2559
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2467
2560
|
*/
|
|
2468
2561
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
2469
2562
|
/**
|
|
@@ -2480,8 +2573,18 @@ export declare enum HostEvent {
|
|
|
2480
2573
|
*/
|
|
2481
2574
|
SetActiveTab = "SetActiveTab",
|
|
2482
2575
|
/**
|
|
2483
|
-
*
|
|
2484
|
-
*
|
|
2576
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
2577
|
+
* runtime filters passed here are appended to the existing runtime
|
|
2578
|
+
* filters.
|
|
2579
|
+
* Pass an array of runtime filters with the following attributes:
|
|
2580
|
+
* `columnName`
|
|
2581
|
+
* _String_. The name of the column to filter on.
|
|
2582
|
+
* `operator`
|
|
2583
|
+
* Runtime filter operator to apply. For information,
|
|
2584
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
2585
|
+
* `values`
|
|
2586
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2587
|
+
* operators such as BW and IN accept multiple operands.
|
|
2485
2588
|
*
|
|
2486
2589
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2487
2590
|
* @example
|
|
@@ -2491,12 +2594,12 @@ export declare enum HostEvent {
|
|
|
2491
2594
|
* {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
|
|
2492
2595
|
* ])
|
|
2493
2596
|
* ```
|
|
2494
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
2597
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2495
2598
|
* @important
|
|
2496
2599
|
*/
|
|
2497
2600
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
2498
2601
|
/**
|
|
2499
|
-
* Navigate to a specific page in
|
|
2602
|
+
* Navigate to a specific page in the embedded application without reloading the page.
|
|
2500
2603
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2501
2604
|
*
|
|
2502
2605
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
@@ -2504,12 +2607,12 @@ export declare enum HostEvent {
|
|
|
2504
2607
|
* ```js
|
|
2505
2608
|
* appEmbed.navigateToPage(-1)
|
|
2506
2609
|
* ```
|
|
2507
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1
|
|
2610
|
+
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
2508
2611
|
*/
|
|
2509
2612
|
Navigate = "Navigate",
|
|
2510
2613
|
/**
|
|
2511
2614
|
* Opens the filter panel for a particular column.
|
|
2512
|
-
* Works with Search embed.
|
|
2615
|
+
* Works with Search and Liveboard embed.
|
|
2513
2616
|
*
|
|
2514
2617
|
* @param - { columnId: string,
|
|
2515
2618
|
* name: string,
|
|
@@ -2518,233 +2621,257 @@ export declare enum HostEvent {
|
|
|
2518
2621
|
* @example
|
|
2519
2622
|
* ```js
|
|
2520
2623
|
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
2521
|
-
*
|
|
2624
|
+
* { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
|
|
2625
|
+
* LiveboardEmbed.trigger(HostEvent.OpenFilter,
|
|
2626
|
+
* { columnId: '<column-GUID>'})
|
|
2522
2627
|
* ```
|
|
2523
2628
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2524
2629
|
*/
|
|
2525
2630
|
OpenFilter = "openFilter",
|
|
2526
2631
|
/**
|
|
2527
|
-
* Adds
|
|
2632
|
+
* Adds columns to the current search query.
|
|
2528
2633
|
*
|
|
2529
2634
|
* @param - { columnIds: string[] }
|
|
2530
2635
|
* @example
|
|
2531
2636
|
* ```js
|
|
2532
|
-
* searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['
|
|
2637
|
+
* searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
|
|
2533
2638
|
* ```
|
|
2534
2639
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2535
2640
|
*/
|
|
2536
2641
|
AddColumns = "addColumns",
|
|
2537
2642
|
/**
|
|
2538
|
-
* Removes a column from the current
|
|
2643
|
+
* Removes a column from the current search query.
|
|
2539
2644
|
*
|
|
2540
2645
|
* @param - { columnId: string }
|
|
2541
2646
|
* @example
|
|
2542
2647
|
* ```js
|
|
2543
|
-
* searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '
|
|
2648
|
+
* searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
|
|
2544
2649
|
* ```
|
|
2545
2650
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2546
2651
|
*/
|
|
2547
2652
|
RemoveColumn = "removeColumn",
|
|
2548
2653
|
/**
|
|
2549
|
-
* Gets the current
|
|
2654
|
+
* Gets the current Liveboard content.
|
|
2550
2655
|
*
|
|
2551
2656
|
* @example
|
|
2552
2657
|
* ```js
|
|
2553
2658
|
* liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
|
|
2554
2659
|
* ```
|
|
2555
|
-
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1
|
|
2660
|
+
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
2556
2661
|
*/
|
|
2557
2662
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
2558
2663
|
/**
|
|
2559
|
-
* Triggers the Pin action on an embedded object
|
|
2664
|
+
* Triggers the **Pin** action on an embedded object
|
|
2560
2665
|
*
|
|
2561
|
-
* @param -
|
|
2562
|
-
*
|
|
2666
|
+
* @param - Liveboard embed takes the `vizId` as a
|
|
2667
|
+
* key. Can be left undefined when embedding Search, full app or
|
|
2668
|
+
* a visualization.
|
|
2563
2669
|
* @example
|
|
2564
2670
|
* ```js
|
|
2565
2671
|
* liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2672
|
+
* ```
|
|
2673
|
+
* ```js
|
|
2566
2674
|
* vizEmbed.trigger(HostEvent.Pin)
|
|
2675
|
+
* ```
|
|
2676
|
+
* ```js
|
|
2567
2677
|
* searchEmbed.trigger(HostEvent.Pin)
|
|
2568
2678
|
* ```
|
|
2569
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2679
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2570
2680
|
*/
|
|
2571
2681
|
Pin = "pin",
|
|
2572
2682
|
/**
|
|
2573
|
-
* Triggers the Show Liveboard details action on a Liveboard
|
|
2683
|
+
* Triggers the **Show Liveboard details** action on a Liveboard
|
|
2574
2684
|
*
|
|
2575
2685
|
* @example
|
|
2576
2686
|
* ```js
|
|
2577
2687
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
2578
2688
|
* ```
|
|
2579
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2689
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2580
2690
|
*/
|
|
2581
2691
|
LiveboardInfo = "pinboardInfo",
|
|
2582
2692
|
/**
|
|
2583
|
-
* Triggers the Schedule action on a Liveboard
|
|
2693
|
+
* Triggers the **Schedule** action on a Liveboard
|
|
2584
2694
|
*
|
|
2585
2695
|
* @example
|
|
2586
2696
|
* ```js
|
|
2587
2697
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
2588
2698
|
* ```
|
|
2589
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2699
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2590
2700
|
*/
|
|
2591
2701
|
Schedule = "subscription",
|
|
2592
2702
|
/**
|
|
2593
|
-
* Triggers the Manage schedule action on a Liveboard
|
|
2703
|
+
* Triggers the **Manage schedule** action on a Liveboard
|
|
2594
2704
|
*
|
|
2595
2705
|
* @example
|
|
2596
2706
|
* ```js
|
|
2597
2707
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
2598
2708
|
* ```
|
|
2599
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2709
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2600
2710
|
*/
|
|
2601
2711
|
SchedulesList = "schedule-list",
|
|
2602
2712
|
/**
|
|
2603
|
-
* Triggers the Export TML action on a Liveboard
|
|
2713
|
+
* Triggers the **Export TML** action on a Liveboard
|
|
2604
2714
|
*
|
|
2605
2715
|
* @example
|
|
2606
2716
|
* ```js
|
|
2607
2717
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
2608
2718
|
* ```
|
|
2609
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2719
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2610
2720
|
*/
|
|
2611
2721
|
ExportTML = "exportTSL",
|
|
2612
2722
|
/**
|
|
2613
|
-
* Triggers the Edit TML action on a Liveboard
|
|
2723
|
+
* Triggers the **Edit TML** action on a Liveboard
|
|
2614
2724
|
*
|
|
2615
2725
|
* @example
|
|
2616
2726
|
* ```js
|
|
2617
2727
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
2618
2728
|
* ```
|
|
2619
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2729
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2620
2730
|
*/
|
|
2621
2731
|
EditTML = "editTSL",
|
|
2622
2732
|
/**
|
|
2623
|
-
* Triggers the Update TML action on a Liveboard
|
|
2733
|
+
* Triggers the **Update TML** action on a Liveboard
|
|
2624
2734
|
*
|
|
2625
2735
|
* @example
|
|
2626
2736
|
* ```js
|
|
2627
2737
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
2628
2738
|
* ```
|
|
2629
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2739
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2630
2740
|
*/
|
|
2631
2741
|
UpdateTML = "updateTSL",
|
|
2632
2742
|
/**
|
|
2633
|
-
* Triggers the Download PDF action on a Liveboard
|
|
2743
|
+
* Triggers the **Download PDF** action on a Liveboard
|
|
2634
2744
|
*
|
|
2635
2745
|
* @example
|
|
2636
2746
|
* ```js
|
|
2637
2747
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
2638
2748
|
* ```
|
|
2639
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2749
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2640
2750
|
*/
|
|
2641
2751
|
DownloadAsPdf = "downloadAsPdf",
|
|
2642
2752
|
/**
|
|
2643
|
-
* Triggers the Make a copy action on a Liveboard,
|
|
2753
|
+
* Triggers the **Make a copy** action on a Liveboard, Search, or
|
|
2754
|
+
* visualization page
|
|
2644
2755
|
*
|
|
2645
2756
|
* @example
|
|
2646
2757
|
* ```js
|
|
2647
2758
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2759
|
+
* ```
|
|
2760
|
+
* ```js
|
|
2648
2761
|
* vizEmbed.trigger(HostEvent.MakeACopy)
|
|
2762
|
+
* ```
|
|
2763
|
+
* ```js
|
|
2649
2764
|
* searchEmbed.trigger(HostEvent.MakeACopy)
|
|
2650
2765
|
* ```
|
|
2651
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2766
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2652
2767
|
*/
|
|
2653
2768
|
MakeACopy = "makeACopy",
|
|
2654
2769
|
/**
|
|
2655
|
-
* Triggers the Delete action on a Liveboard
|
|
2770
|
+
* Triggers the **Delete** action on a Liveboard
|
|
2656
2771
|
*
|
|
2657
2772
|
* @example
|
|
2658
2773
|
* ```js
|
|
2659
2774
|
* appEmbed.trigger(HostEvent.Remove)
|
|
2660
2775
|
* ```
|
|
2661
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2776
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2662
2777
|
*/
|
|
2663
2778
|
Remove = "delete",
|
|
2664
2779
|
/**
|
|
2665
|
-
* Triggers the Explore action on a visualization
|
|
2780
|
+
* Triggers the **Explore* action on a visualization
|
|
2666
2781
|
*
|
|
2667
|
-
* @param - an object with vizId as a key
|
|
2782
|
+
* @param - an object with `vizId` as a key
|
|
2668
2783
|
* @example
|
|
2669
2784
|
* ```js
|
|
2670
2785
|
* liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2671
2786
|
* ```
|
|
2672
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2787
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2673
2788
|
*/
|
|
2674
2789
|
Explore = "explore",
|
|
2675
2790
|
/**
|
|
2676
|
-
* Triggers the Create alert action on a visualization
|
|
2791
|
+
* Triggers the **Create alert** action on a visualization
|
|
2677
2792
|
*
|
|
2678
|
-
* @param - an object with vizId as a key
|
|
2793
|
+
* @param - an object with `vizId` as a key
|
|
2679
2794
|
* @example
|
|
2680
2795
|
* ```js
|
|
2681
2796
|
* liveboardEmbed.trigger(HostEvent.CreateMonitor {
|
|
2682
2797
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2683
2798
|
* })
|
|
2684
2799
|
* ```
|
|
2685
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2800
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2686
2801
|
*/
|
|
2687
2802
|
CreateMonitor = "createMonitor",
|
|
2688
2803
|
/**
|
|
2689
|
-
* Triggers the Manage
|
|
2804
|
+
* Triggers the **Manage alerts** action on a visualization
|
|
2690
2805
|
*
|
|
2691
|
-
* @param - an object with vizId as a key
|
|
2806
|
+
* @param - an object with `vizId` as a key
|
|
2692
2807
|
* @example
|
|
2693
2808
|
* ```js
|
|
2694
2809
|
* liveboardEmbed.trigger(HostEvent.ManageMonitor, {
|
|
2695
2810
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2696
2811
|
* })
|
|
2697
2812
|
* ```
|
|
2698
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2813
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2699
2814
|
*/
|
|
2700
2815
|
ManageMonitor = "manageMonitor",
|
|
2701
2816
|
/**
|
|
2702
|
-
* Triggers the Edit action on a Liveboard or visualization
|
|
2817
|
+
* Triggers the **Edit** action on a Liveboard or visualization
|
|
2703
2818
|
*
|
|
2704
|
-
* @param - object -
|
|
2705
|
-
*
|
|
2819
|
+
* @param - object - To trigger the action for a specific visualization
|
|
2820
|
+
* in Liveboard embed, pass in `vizId` as a key.
|
|
2821
|
+
* Can be left undefined when embedding Search, full app, or
|
|
2822
|
+
* a visualization.
|
|
2706
2823
|
* @example
|
|
2707
2824
|
* ```js
|
|
2708
2825
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
2709
|
-
*
|
|
2826
|
+
* ```
|
|
2827
|
+
* ```js
|
|
2710
2828
|
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
2711
2829
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2712
|
-
*
|
|
2830
|
+
* ```
|
|
2831
|
+
* ```js
|
|
2713
2832
|
* vizEmbed.trigger((HostEvent.Edit)
|
|
2714
2833
|
* ```
|
|
2715
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2834
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2716
2835
|
*/
|
|
2717
2836
|
Edit = "edit",
|
|
2718
2837
|
/**
|
|
2719
|
-
* Triggers the Copy link action on a Liveboard or visualization
|
|
2838
|
+
* Triggers the **Copy link** action on a Liveboard or visualization
|
|
2720
2839
|
*
|
|
2721
|
-
* @param - object - to trigger the action for a
|
|
2722
|
-
*
|
|
2840
|
+
* @param - object - to trigger the action for a
|
|
2841
|
+
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
2723
2842
|
* @example
|
|
2724
2843
|
* ```js
|
|
2725
2844
|
* liveboardEmbed.trigger(HostEvent.CopyLink)
|
|
2845
|
+
* ```
|
|
2846
|
+
* ```js
|
|
2726
2847
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2848
|
+
* ```
|
|
2849
|
+
* ```js
|
|
2727
2850
|
* vizEmbed.trigger((HostEvent.CopyLink)
|
|
2728
2851
|
* ```
|
|
2729
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2852
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2730
2853
|
*/
|
|
2731
2854
|
CopyLink = "embedDocument",
|
|
2732
2855
|
/**
|
|
2733
|
-
* Triggers the Present action on a Liveboard or visualization
|
|
2856
|
+
* Triggers the **Present** action on a Liveboard or visualization
|
|
2734
2857
|
*
|
|
2735
|
-
* @param - object - to trigger the action for a
|
|
2736
|
-
* in Liveboard embed, pass in vizId as a key
|
|
2858
|
+
* @param - object - to trigger the action for a specific visualization
|
|
2859
|
+
* in Liveboard embed, pass in `vizId` as a key
|
|
2737
2860
|
* @example
|
|
2738
2861
|
* ```js
|
|
2739
2862
|
* liveboardEmbed.trigger(HostEvent.Present)
|
|
2863
|
+
* ```
|
|
2864
|
+
* ```js
|
|
2740
2865
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2866
|
+
* ```
|
|
2867
|
+
* ```js
|
|
2741
2868
|
* vizEmbed.trigger((HostEvent.Present)
|
|
2742
2869
|
* ```
|
|
2743
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
2870
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2744
2871
|
*/
|
|
2745
2872
|
Present = "present",
|
|
2746
2873
|
/**
|
|
2747
|
-
*
|
|
2874
|
+
* Gets TML for the current search.
|
|
2748
2875
|
*
|
|
2749
2876
|
* @example
|
|
2750
2877
|
* ```js
|
|
@@ -2754,78 +2881,90 @@ export declare enum HostEvent {
|
|
|
2754
2881
|
* );
|
|
2755
2882
|
* })
|
|
2756
2883
|
* ```
|
|
2757
|
-
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1
|
|
2884
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2758
2885
|
* @important
|
|
2759
2886
|
*/
|
|
2760
2887
|
GetTML = "getTML",
|
|
2761
2888
|
/**
|
|
2762
|
-
* Triggers the
|
|
2889
|
+
* Triggers the **Show underlying data** action on visualization or search
|
|
2763
2890
|
*
|
|
2764
2891
|
* @param - an object with vizId as a key
|
|
2765
2892
|
* @example
|
|
2766
2893
|
* ```js
|
|
2767
2894
|
* liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
|
|
2768
2895
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2769
|
-
*
|
|
2896
|
+
* ```
|
|
2897
|
+
* ```js
|
|
2770
2898
|
* vizEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
2771
|
-
*
|
|
2899
|
+
* ```
|
|
2900
|
+
* ```js
|
|
2772
2901
|
* searchEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
2773
2902
|
* ```
|
|
2774
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
2903
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2775
2904
|
*/
|
|
2776
2905
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2777
2906
|
/**
|
|
2778
|
-
* Triggers the Delete action on visualization or search
|
|
2907
|
+
* Triggers the **Delete** action on visualization or search
|
|
2779
2908
|
*
|
|
2780
|
-
* @param -
|
|
2781
|
-
*
|
|
2909
|
+
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
2910
|
+
* Can be left empty if embedding Search or visualization.
|
|
2782
2911
|
* @example
|
|
2783
2912
|
* ```js
|
|
2784
2913
|
* liveboardEmbed.trigger(HostEvent.Delete, {vizId:
|
|
2785
2914
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2786
|
-
*
|
|
2915
|
+
* ```
|
|
2916
|
+
* ```js
|
|
2787
2917
|
* vizEmbed.trigger(HostEvent.Delete)
|
|
2788
|
-
*
|
|
2918
|
+
* ```
|
|
2919
|
+
* ```js
|
|
2789
2920
|
* searchEmbed.trigger(HostEvent.Delete)
|
|
2790
2921
|
* ```
|
|
2791
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
2922
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2792
2923
|
*/
|
|
2793
2924
|
Delete = "onDeleteAnswer",
|
|
2794
2925
|
/**
|
|
2795
|
-
* Triggers the
|
|
2926
|
+
* Triggers the **SpotIQ analyze** action on visualization
|
|
2927
|
+
* or search.
|
|
2796
2928
|
*
|
|
2797
|
-
* @param -
|
|
2798
|
-
*
|
|
2929
|
+
* @param - Liveboard embed takes `vizId` as a
|
|
2930
|
+
* key. Can be left undefined when embedding Search or
|
|
2931
|
+
* visualization.
|
|
2799
2932
|
* @example
|
|
2800
2933
|
* ```js
|
|
2801
2934
|
* liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
|
|
2802
2935
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2803
|
-
*
|
|
2936
|
+
* ```
|
|
2937
|
+
* ```js
|
|
2804
2938
|
* vizEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
2805
|
-
*
|
|
2939
|
+
* ```
|
|
2940
|
+
* ```js
|
|
2806
2941
|
* searchEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
2807
2942
|
* ```
|
|
2808
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
2943
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2809
2944
|
*/
|
|
2810
2945
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2811
2946
|
/**
|
|
2812
|
-
* Triggers the Download action on
|
|
2947
|
+
* Triggers the **Download** action on charts in
|
|
2948
|
+
* the embedded view.
|
|
2813
2949
|
*
|
|
2814
2950
|
* @example
|
|
2815
2951
|
* ```js
|
|
2816
2952
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
2817
2953
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2818
|
-
*
|
|
2954
|
+
* ```
|
|
2955
|
+
* ```js
|
|
2819
2956
|
* vizEmbed.trigger(HostEvent.Download)
|
|
2820
|
-
*
|
|
2957
|
+
* ```
|
|
2958
|
+
* ```js
|
|
2821
2959
|
* searchEmbed.trigger(HostEvent.Download)
|
|
2822
2960
|
* ```
|
|
2823
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1
|
|
2824
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
2961
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
|
|
2962
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2825
2963
|
*/
|
|
2826
2964
|
Download = "downloadAsPng",
|
|
2827
2965
|
/**
|
|
2828
|
-
* Triggers the Download action on
|
|
2966
|
+
* Triggers the **Download** > **PNG** action on
|
|
2967
|
+
* charts in the embedded view.
|
|
2829
2968
|
*
|
|
2830
2969
|
* @example
|
|
2831
2970
|
* ```js
|
|
@@ -2836,115 +2975,197 @@ export declare enum HostEvent {
|
|
|
2836
2975
|
*
|
|
2837
2976
|
* searchEmbed.trigger(HostEvent.DownloadAsPng)
|
|
2838
2977
|
* ```
|
|
2839
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1
|
|
2978
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
|
|
2840
2979
|
*/
|
|
2841
2980
|
DownloadAsPng = "downloadAsPng",
|
|
2842
2981
|
/**
|
|
2843
|
-
* Triggers the
|
|
2982
|
+
* Triggers the **Download** > **CSV** action on tables in
|
|
2983
|
+
* the embedded view.
|
|
2844
2984
|
*
|
|
2845
2985
|
* @example
|
|
2846
2986
|
* ```js
|
|
2847
2987
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
2848
2988
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2849
|
-
*
|
|
2989
|
+
* ```
|
|
2990
|
+
* ```js
|
|
2850
2991
|
* vizEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
2851
|
-
*
|
|
2992
|
+
* ```
|
|
2993
|
+
* ```js
|
|
2852
2994
|
* searchEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
2853
2995
|
* ```
|
|
2854
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
2996
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2855
2997
|
*/
|
|
2856
2998
|
DownloadAsCsv = "downloadAsCSV",
|
|
2857
2999
|
/**
|
|
2858
|
-
* Triggers the
|
|
3000
|
+
* Triggers the **Download** > **XLSX** action on tables
|
|
3001
|
+
* in the embedded view.
|
|
2859
3002
|
*
|
|
2860
3003
|
* @example
|
|
2861
3004
|
* ```js
|
|
2862
3005
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
2863
3006
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2864
|
-
*
|
|
3007
|
+
* ```
|
|
3008
|
+
* ```js
|
|
2865
3009
|
* vizEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
2866
|
-
*
|
|
3010
|
+
* ```
|
|
3011
|
+
* ```js
|
|
2867
3012
|
* searchEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
2868
3013
|
* ```
|
|
2869
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
3014
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2870
3015
|
*/
|
|
2871
3016
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
2872
3017
|
/**
|
|
2873
|
-
* Triggers the Share action on
|
|
3018
|
+
* Triggers the **Share** action on an embedded
|
|
3019
|
+
* Liveboard or Answer.
|
|
2874
3020
|
*
|
|
2875
3021
|
* @example
|
|
2876
3022
|
* ```js
|
|
2877
3023
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
2878
|
-
*
|
|
3024
|
+
* ```
|
|
3025
|
+
* ```js
|
|
2879
3026
|
* searchEmbed.trigger(HostEvent.Share)
|
|
2880
3027
|
* ```
|
|
2881
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
3028
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2882
3029
|
*/
|
|
2883
3030
|
Share = "share",
|
|
2884
3031
|
/**
|
|
2885
|
-
*
|
|
3032
|
+
* Triggers the **Save** action on a Liveboard or Answer.
|
|
3033
|
+
* Saves the changes.
|
|
2886
3034
|
*
|
|
2887
3035
|
* @example
|
|
2888
3036
|
* ```js
|
|
2889
3037
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
2890
|
-
*
|
|
3038
|
+
* ```
|
|
3039
|
+
* ```js
|
|
2891
3040
|
* searchEmbed.trigger(HostEvent.Save)
|
|
2892
3041
|
* ```
|
|
2893
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
3042
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2894
3043
|
*/
|
|
2895
3044
|
Save = "save",
|
|
2896
3045
|
/**
|
|
2897
|
-
* Triggers the
|
|
3046
|
+
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
3047
|
+
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
2898
3048
|
*
|
|
2899
|
-
* @param - an object with vizId as a key
|
|
3049
|
+
* @param - an object with `vizId` as a key
|
|
2900
3050
|
* @example
|
|
2901
3051
|
* ```js
|
|
2902
3052
|
* liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
|
|
2903
3053
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2904
|
-
*
|
|
3054
|
+
* ```
|
|
3055
|
+
* ```js
|
|
2905
3056
|
* vizEmbed.trigger(HostEvent.SyncToSheets)
|
|
2906
3057
|
* ```
|
|
2907
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
3058
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2908
3059
|
*/
|
|
2909
3060
|
SyncToSheets = "sync-to-sheets",
|
|
2910
3061
|
/**
|
|
2911
|
-
* Triggers the
|
|
3062
|
+
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
3063
|
+
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
3064
|
+
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
2912
3065
|
*
|
|
2913
3066
|
* @param - an object with vizId as a key
|
|
2914
3067
|
* @example
|
|
2915
3068
|
* ```js
|
|
2916
3069
|
* liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
|
|
2917
3070
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2918
|
-
*
|
|
3071
|
+
* ```
|
|
3072
|
+
* ```js
|
|
2919
3073
|
* vizEmbed.trigger(HostEvent.SyncToOtherApps)
|
|
2920
3074
|
* ```
|
|
2921
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
3075
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2922
3076
|
*/
|
|
2923
3077
|
SyncToOtherApps = "sync-to-other-apps",
|
|
2924
3078
|
/**
|
|
2925
|
-
* Triggers the
|
|
3079
|
+
* Triggers the **Manage pipelines** action on an embedded
|
|
3080
|
+
* visualization or Answer.
|
|
3081
|
+
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
2926
3082
|
*
|
|
2927
|
-
* @param - an object with vizId as a key
|
|
3083
|
+
* @param - an object with `vizId` as a key
|
|
2928
3084
|
* @example
|
|
2929
3085
|
* ```js
|
|
2930
3086
|
* liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
|
|
2931
3087
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2932
|
-
*
|
|
3088
|
+
* ```
|
|
3089
|
+
* ```js
|
|
2933
3090
|
* vizEmbed.trigger(HostEvent.ManagePipelines)
|
|
2934
3091
|
* ```
|
|
2935
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
3092
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2936
3093
|
*/
|
|
2937
3094
|
ManagePipelines = "manage-pipeline",
|
|
2938
3095
|
/**
|
|
2939
|
-
* Triggers the Reset search
|
|
3096
|
+
* Triggers the Reset search on the Search page
|
|
2940
3097
|
*
|
|
2941
3098
|
* @example
|
|
2942
3099
|
* ```js
|
|
2943
3100
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
2944
3101
|
* ```
|
|
2945
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1
|
|
3102
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
|
|
3103
|
+
*/
|
|
3104
|
+
ResetSearch = "resetSearch",
|
|
3105
|
+
/**
|
|
3106
|
+
* Gets the currents visible and runtime filters applied on a Liveboard
|
|
3107
|
+
*
|
|
3108
|
+
* @example
|
|
3109
|
+
* liveboardEmbed.trigger(HostEvent.GetFilters)
|
|
3110
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3111
|
+
*/
|
|
3112
|
+
GetFilters = "getFilters",
|
|
3113
|
+
/**
|
|
3114
|
+
* Updates the visible filters on the Liveboard.
|
|
3115
|
+
*
|
|
3116
|
+
* @param - filter: filter object containing column name and filter operation and values
|
|
3117
|
+
* @example
|
|
3118
|
+
*
|
|
3119
|
+
* ```js
|
|
3120
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
3121
|
+
* filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
|
|
3122
|
+
* })
|
|
3123
|
+
* ```
|
|
3124
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3125
|
+
*/
|
|
3126
|
+
UpdateFilters = "updateFilters",
|
|
3127
|
+
/**
|
|
3128
|
+
* Get Tab for the current Liveboard.
|
|
3129
|
+
*
|
|
3130
|
+
* @example
|
|
3131
|
+
* ```js
|
|
3132
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
3133
|
+
* console.log(
|
|
3134
|
+
* tabDetails // TabDetails of current LB
|
|
3135
|
+
* );
|
|
3136
|
+
* })
|
|
3137
|
+
* ```
|
|
3138
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
3139
|
+
*/
|
|
3140
|
+
GetTabs = "getTabs",
|
|
3141
|
+
/**
|
|
3142
|
+
* Set the visible Tabs on a Liveboard.
|
|
3143
|
+
*
|
|
3144
|
+
* @param - an array of ids of Tabs to show, the ids not passed
|
|
3145
|
+
* will be hidden.
|
|
3146
|
+
* @example
|
|
3147
|
+
* ```js
|
|
3148
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
|
|
3149
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
3150
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
3151
|
+
* ```
|
|
3152
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3153
|
+
*/
|
|
3154
|
+
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
3155
|
+
/**
|
|
3156
|
+
* Set the hidden tabs on a Liveboard.
|
|
3157
|
+
*
|
|
3158
|
+
* @param - an array of ids of Tabs to hide, the ids not passed
|
|
3159
|
+
* will be shown.
|
|
3160
|
+
* @example
|
|
3161
|
+
* ```js
|
|
3162
|
+
* liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
|
|
3163
|
+
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
3164
|
+
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
3165
|
+
* ```
|
|
3166
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2946
3167
|
*/
|
|
2947
|
-
|
|
3168
|
+
SetHiddenTabs = "SetPinboardHiddenTabs"
|
|
2948
3169
|
}
|
|
2949
3170
|
/**
|
|
2950
3171
|
* The different visual modes that the data sources panel within
|
|
@@ -3021,26 +3242,51 @@ export declare enum Param {
|
|
|
3021
3242
|
HideEurekaSuggestions = "hideEurekaSuggestions",
|
|
3022
3243
|
HideLiveboardHeader = "hideLiveboardHeader",
|
|
3023
3244
|
ShowLiveboardDescription = "showLiveboardDescription",
|
|
3024
|
-
ShowLiveboardTitle = "showLiveboardTitle"
|
|
3245
|
+
ShowLiveboardTitle = "showLiveboardTitle",
|
|
3246
|
+
HiddenTabs = "hideTabs",
|
|
3247
|
+
VisibleTabs = "visibleTabs",
|
|
3248
|
+
HideTabPanel = "hideTabPanel",
|
|
3249
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
3250
|
+
WorksheetId = "worksheetId",
|
|
3251
|
+
Query = "query,"
|
|
3025
3252
|
}
|
|
3026
3253
|
/**
|
|
3027
|
-
*
|
|
3028
|
-
*
|
|
3029
|
-
*
|
|
3030
|
-
*
|
|
3031
|
-
*
|
|
3254
|
+
* ThoughtSpot application pages include actions and menu commands
|
|
3255
|
+
* for various user-initiated operations. These actions are represented
|
|
3256
|
+
* as enumeration members in the SDK. To show, hide, or disable
|
|
3257
|
+
* specific actions in the embedded view, define the Action
|
|
3258
|
+
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
3259
|
+
* or `hiddenActions` array.
|
|
3032
3260
|
*
|
|
3033
3261
|
* @example
|
|
3034
3262
|
* ```js
|
|
3035
3263
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
3036
3264
|
* ... // other options
|
|
3037
|
-
* visibleActions: [Action.Save, Action.Explore],
|
|
3038
|
-
*
|
|
3039
|
-
* hiddenActions: [
|
|
3265
|
+
* visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
|
|
3266
|
+
* disabledActions: [Action.Download],
|
|
3267
|
+
* //hiddenActions: [], // Set either this or visibleActions
|
|
3268
|
+
* })
|
|
3269
|
+
* ```
|
|
3270
|
+
* @example
|
|
3271
|
+
* ```js
|
|
3272
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
3273
|
+
* ... // other options
|
|
3274
|
+
* //visibleActions: [],
|
|
3275
|
+
* disabledActions: [Action.Download],
|
|
3276
|
+
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
3040
3277
|
* })
|
|
3041
3278
|
* ```
|
|
3042
3279
|
*/
|
|
3043
3280
|
export declare enum Action {
|
|
3281
|
+
/**
|
|
3282
|
+
* The **Save** action on an Answer or Liveboard.
|
|
3283
|
+
* Allows users to save the changes.
|
|
3284
|
+
*
|
|
3285
|
+
* @example
|
|
3286
|
+
* ```js
|
|
3287
|
+
* disabledActions: [Action.SaveAsView]
|
|
3288
|
+
* ```
|
|
3289
|
+
*/
|
|
3044
3290
|
Save = "save",
|
|
3045
3291
|
/**
|
|
3046
3292
|
* @hidden
|
|
@@ -3050,27 +3296,147 @@ export declare enum Action {
|
|
|
3050
3296
|
* @hidden
|
|
3051
3297
|
*/
|
|
3052
3298
|
SaveUntitled = "saveUntitled",
|
|
3299
|
+
/**
|
|
3300
|
+
* The **Save as View** action on the Answer
|
|
3301
|
+
* page. Saves an Answer as a View object.
|
|
3302
|
+
*
|
|
3303
|
+
* @example
|
|
3304
|
+
* ```js
|
|
3305
|
+
* disabledActions: [Action.SaveAsView]
|
|
3306
|
+
* ```
|
|
3307
|
+
*/
|
|
3053
3308
|
SaveAsView = "saveAsView",
|
|
3309
|
+
/**
|
|
3310
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
3311
|
+
* page.
|
|
3312
|
+
* Creates a copy of the Liveboard, visualization,
|
|
3313
|
+
* or Answer.
|
|
3314
|
+
*
|
|
3315
|
+
* @example
|
|
3316
|
+
* ```js
|
|
3317
|
+
* disabledActions: [Action.MakeACopy]
|
|
3318
|
+
* ```
|
|
3319
|
+
*/
|
|
3054
3320
|
MakeACopy = "makeACopy",
|
|
3321
|
+
/**
|
|
3322
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
3323
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
3324
|
+
*
|
|
3325
|
+
* @example
|
|
3326
|
+
* ```js
|
|
3327
|
+
* disabledActions: [Action.EditACopy]
|
|
3328
|
+
* ```
|
|
3329
|
+
*/
|
|
3055
3330
|
EditACopy = "editACopy",
|
|
3331
|
+
/**
|
|
3332
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
3333
|
+
* Copies the visualization URL
|
|
3334
|
+
*
|
|
3335
|
+
* @example
|
|
3336
|
+
* ```js
|
|
3337
|
+
* disabledActions: [Action.CopyLink]
|
|
3338
|
+
* ```
|
|
3339
|
+
*/
|
|
3056
3340
|
CopyLink = "embedDocument",
|
|
3057
3341
|
/**
|
|
3058
3342
|
* @hidden
|
|
3059
3343
|
*/
|
|
3060
3344
|
ResetLayout = "resetLayout",
|
|
3345
|
+
/**
|
|
3346
|
+
* The **Schedule** menu action on a Liveboard.
|
|
3347
|
+
* Allows scheduling a Liveboard notification.
|
|
3348
|
+
*
|
|
3349
|
+
* @example
|
|
3350
|
+
* ```js
|
|
3351
|
+
* disabledActions: [Action.Schedule]
|
|
3352
|
+
* ```
|
|
3353
|
+
*/
|
|
3061
3354
|
Schedule = "subscription",
|
|
3062
|
-
|
|
3355
|
+
/**
|
|
3356
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
3357
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
3358
|
+
*
|
|
3359
|
+
* @example
|
|
3360
|
+
* ```js
|
|
3361
|
+
* disabledActions: [Action.SchedulesList]
|
|
3362
|
+
* ```
|
|
3363
|
+
*/
|
|
3364
|
+
SchedulesList = "schedule-list",
|
|
3365
|
+
/**
|
|
3366
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
3367
|
+
* Allows users to share an object with other users and groups.
|
|
3368
|
+
*
|
|
3369
|
+
* @example
|
|
3370
|
+
* ```js
|
|
3371
|
+
* disabledActions: [Action.Share]
|
|
3372
|
+
* ```
|
|
3373
|
+
*/
|
|
3063
3374
|
Share = "share",
|
|
3375
|
+
/**
|
|
3376
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
3377
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
3378
|
+
*
|
|
3379
|
+
* @example
|
|
3380
|
+
* ```js
|
|
3381
|
+
* disabledActions: [Action.AddFilter]
|
|
3382
|
+
* ```
|
|
3383
|
+
*/
|
|
3064
3384
|
AddFilter = "addFilter",
|
|
3385
|
+
/**
|
|
3386
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
3387
|
+
* Allows configuring filter options when adding filters to a
|
|
3388
|
+
* Liveboard or Answer.
|
|
3389
|
+
*
|
|
3390
|
+
* @example
|
|
3391
|
+
* ```js
|
|
3392
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
3393
|
+
* ```
|
|
3394
|
+
*/
|
|
3065
3395
|
ConfigureFilter = "configureFilter",
|
|
3066
3396
|
CollapseDataSources = "collapseDataSources",
|
|
3397
|
+
/**
|
|
3398
|
+
* The **Choose sources** button on Search page.
|
|
3399
|
+
* Allows selecting data sources for search queries.
|
|
3400
|
+
*
|
|
3401
|
+
* @example
|
|
3402
|
+
* ```js
|
|
3403
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
3404
|
+
* ```
|
|
3405
|
+
*/
|
|
3067
3406
|
ChooseDataSources = "chooseDataSources",
|
|
3407
|
+
/**
|
|
3408
|
+
* The **Create formula** action on a Search or Answer page.
|
|
3409
|
+
* Allows adding formulas to an Answer.
|
|
3410
|
+
*
|
|
3411
|
+
* @example
|
|
3412
|
+
* ```js
|
|
3413
|
+
* disabledActions: [Action.AddFormula]
|
|
3414
|
+
* ```
|
|
3415
|
+
*/
|
|
3068
3416
|
AddFormula = "addFormula",
|
|
3417
|
+
/**
|
|
3418
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
3419
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
3420
|
+
*
|
|
3421
|
+
* @example
|
|
3422
|
+
* ```js
|
|
3423
|
+
* disabledActions: [Action.AddParameter]
|
|
3424
|
+
* ```
|
|
3425
|
+
*/
|
|
3069
3426
|
AddParameter = "addParameter",
|
|
3070
3427
|
/**
|
|
3071
3428
|
* @hidden
|
|
3072
3429
|
*/
|
|
3073
3430
|
SearchOnTop = "searchOnTop",
|
|
3431
|
+
/**
|
|
3432
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
3433
|
+
* Answer page.
|
|
3434
|
+
*
|
|
3435
|
+
* @example
|
|
3436
|
+
* ```js
|
|
3437
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
3438
|
+
* ```
|
|
3439
|
+
*/
|
|
3074
3440
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3075
3441
|
/**
|
|
3076
3442
|
* @hidden
|
|
@@ -3085,24 +3451,165 @@ export declare enum Action {
|
|
|
3085
3451
|
* @hidden
|
|
3086
3452
|
*/
|
|
3087
3453
|
ReplaySearch = "replaySearch",
|
|
3454
|
+
/**
|
|
3455
|
+
* The **Show underlying data** menu action on a visualization or
|
|
3456
|
+
* Answer page.
|
|
3457
|
+
*
|
|
3458
|
+
* @example
|
|
3459
|
+
* ```js
|
|
3460
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
3461
|
+
* ```
|
|
3462
|
+
*/
|
|
3088
3463
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3464
|
+
/**
|
|
3465
|
+
* The **Download** menu action on Liveboard visualizations
|
|
3466
|
+
* and Answers.
|
|
3467
|
+
* Allows downloading a visualization or Answer.
|
|
3468
|
+
*
|
|
3469
|
+
* @example
|
|
3470
|
+
* ```js
|
|
3471
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3472
|
+
* ```
|
|
3473
|
+
*/
|
|
3089
3474
|
Download = "download",
|
|
3475
|
+
/**
|
|
3476
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3477
|
+
* or Answer page.
|
|
3478
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
3479
|
+
*
|
|
3480
|
+
* @example
|
|
3481
|
+
* ```js
|
|
3482
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3483
|
+
* ```
|
|
3484
|
+
*/
|
|
3090
3485
|
DownloadAsPng = "downloadAsPng",
|
|
3486
|
+
/**
|
|
3487
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3488
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
3489
|
+
*
|
|
3490
|
+
* @example
|
|
3491
|
+
* ```js
|
|
3492
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
3493
|
+
* ```
|
|
3494
|
+
*/
|
|
3091
3495
|
DownloadAsPdf = "downloadAsPdf",
|
|
3496
|
+
/**
|
|
3497
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3498
|
+
* or Answer page.
|
|
3499
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3500
|
+
*
|
|
3501
|
+
* @example
|
|
3502
|
+
* ```js
|
|
3503
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
3504
|
+
* ```
|
|
3505
|
+
*/
|
|
3092
3506
|
DownloadAsCsv = "downloadAsCSV",
|
|
3507
|
+
/**
|
|
3508
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3509
|
+
* or Answer page.
|
|
3510
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3511
|
+
*
|
|
3512
|
+
* @example
|
|
3513
|
+
* ```js
|
|
3514
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
3515
|
+
* ```
|
|
3516
|
+
*/
|
|
3093
3517
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
3094
3518
|
/**
|
|
3095
3519
|
* @hidden
|
|
3096
3520
|
*/
|
|
3097
3521
|
DownloadTrace = "downloadTrace",
|
|
3522
|
+
/**
|
|
3523
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
3524
|
+
* Worksheets and Data Connections page.
|
|
3525
|
+
* Exports an object as a TML file.
|
|
3526
|
+
*
|
|
3527
|
+
* @example
|
|
3528
|
+
* ```js
|
|
3529
|
+
* disabledActions: [Action.ExportTML]
|
|
3530
|
+
* ```
|
|
3531
|
+
*/
|
|
3098
3532
|
ExportTML = "exportTSL",
|
|
3533
|
+
/**
|
|
3534
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
3535
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
3536
|
+
*
|
|
3537
|
+
* @example
|
|
3538
|
+
* ```js
|
|
3539
|
+
* disabledActions: [Action.ImportTML]
|
|
3540
|
+
* ```
|
|
3541
|
+
*/
|
|
3099
3542
|
ImportTML = "importTSL",
|
|
3543
|
+
/**
|
|
3544
|
+
* The **Update TML** menu action for Liveboards and Answers.
|
|
3545
|
+
* Update TML representation of ThoughtSpot objects.
|
|
3546
|
+
*
|
|
3547
|
+
* @example
|
|
3548
|
+
* ```js
|
|
3549
|
+
* disabledActions: [Action.UpdateTML]
|
|
3550
|
+
* ```
|
|
3551
|
+
*/
|
|
3100
3552
|
UpdateTML = "updateTSL",
|
|
3553
|
+
/**
|
|
3554
|
+
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3555
|
+
* Opens the TML editor.
|
|
3556
|
+
*
|
|
3557
|
+
* @example
|
|
3558
|
+
* ```js
|
|
3559
|
+
* disabledActions: [Action.EditTML]
|
|
3560
|
+
* ```
|
|
3561
|
+
*/
|
|
3101
3562
|
EditTML = "editTSL",
|
|
3563
|
+
/**
|
|
3564
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
3565
|
+
* Allows presenting a Liveboard or visualization in
|
|
3566
|
+
* slideshow mode.
|
|
3567
|
+
*
|
|
3568
|
+
* @example
|
|
3569
|
+
* ```js
|
|
3570
|
+
* disabledActions: [Action.Present]
|
|
3571
|
+
* ```
|
|
3572
|
+
*/
|
|
3102
3573
|
Present = "present",
|
|
3574
|
+
/**
|
|
3575
|
+
* The tile resize options in the visualization menu.
|
|
3576
|
+
* Allows switching between different preset layouts.
|
|
3577
|
+
*
|
|
3578
|
+
* @example
|
|
3579
|
+
* ```js
|
|
3580
|
+
* disabledActions: [Action.ToggleSize]
|
|
3581
|
+
* ```
|
|
3582
|
+
*/
|
|
3103
3583
|
ToggleSize = "toggleSize",
|
|
3584
|
+
/**
|
|
3585
|
+
* The *Edit* action on the Liveboard page and in the
|
|
3586
|
+
* visualization menu.
|
|
3587
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
3588
|
+
*
|
|
3589
|
+
* @example
|
|
3590
|
+
* ```js
|
|
3591
|
+
* disabledActions: [Action.Edit]
|
|
3592
|
+
* ```
|
|
3593
|
+
*/
|
|
3104
3594
|
Edit = "edit",
|
|
3595
|
+
/**
|
|
3596
|
+
* The text edit option for Liveboard and visualization titles.
|
|
3597
|
+
*
|
|
3598
|
+
* @example
|
|
3599
|
+
* ```js
|
|
3600
|
+
* disabledActions: [Action.EditTitle]
|
|
3601
|
+
* ```
|
|
3602
|
+
*/
|
|
3105
3603
|
EditTitle = "editTitle",
|
|
3604
|
+
/**
|
|
3605
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
3606
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3607
|
+
*
|
|
3608
|
+
* @example
|
|
3609
|
+
* ```js
|
|
3610
|
+
* disabledActions: [Action.Remove]
|
|
3611
|
+
* ```
|
|
3612
|
+
*/
|
|
3106
3613
|
Remove = "delete",
|
|
3107
3614
|
/**
|
|
3108
3615
|
* @hidden
|
|
@@ -3124,6 +3631,17 @@ export declare enum Action {
|
|
|
3124
3631
|
* @hidden
|
|
3125
3632
|
*/
|
|
3126
3633
|
PinboardInfo = "pinboardInfo",
|
|
3634
|
+
/**
|
|
3635
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
3636
|
+
* Displays details such as the name, description, and
|
|
3637
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3638
|
+
* and update.
|
|
3639
|
+
*
|
|
3640
|
+
* @example
|
|
3641
|
+
* ```js
|
|
3642
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
3643
|
+
* ```
|
|
3644
|
+
*/
|
|
3127
3645
|
LiveboardInfo = "pinboardInfo",
|
|
3128
3646
|
/**
|
|
3129
3647
|
* @hidden
|
|
@@ -3134,20 +3652,67 @@ export declare enum Action {
|
|
|
3134
3652
|
*/
|
|
3135
3653
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
3136
3654
|
/**
|
|
3137
|
-
* Pin action
|
|
3655
|
+
* The **Pin** menu action on an Answer or
|
|
3656
|
+
* Search results page.
|
|
3657
|
+
*
|
|
3658
|
+
* @example
|
|
3659
|
+
* ```js
|
|
3660
|
+
* disabledActions: [Action.Pin]
|
|
3661
|
+
* ```
|
|
3138
3662
|
*/
|
|
3139
3663
|
Pin = "pin",
|
|
3140
3664
|
/**
|
|
3141
3665
|
* @hidden
|
|
3142
3666
|
*/
|
|
3143
3667
|
AnalysisInfo = "analysisInfo",
|
|
3668
|
+
/**
|
|
3669
|
+
* The **Schedule** menu action on a Liveboard.
|
|
3670
|
+
*
|
|
3671
|
+
* @example
|
|
3672
|
+
* ```js
|
|
3673
|
+
* disabledActions: [Action.Subscription]
|
|
3674
|
+
* ```
|
|
3675
|
+
*/
|
|
3144
3676
|
Subscription = "subscription",
|
|
3145
3677
|
/**
|
|
3146
|
-
* Explore action
|
|
3678
|
+
* The **Explore** action on Liveboard visualizations
|
|
3679
|
+
*
|
|
3680
|
+
* @example
|
|
3681
|
+
* ```js
|
|
3682
|
+
* disabledActions: [Action.Explore]
|
|
3683
|
+
* ```
|
|
3147
3684
|
*/
|
|
3148
3685
|
Explore = "explore",
|
|
3686
|
+
/**
|
|
3687
|
+
* The action to include data points on a drilled-down Answer
|
|
3688
|
+
* or visualization
|
|
3689
|
+
*
|
|
3690
|
+
* @example
|
|
3691
|
+
* ```js
|
|
3692
|
+
* disabledActions: [Action.DrillInclude]
|
|
3693
|
+
* ```
|
|
3694
|
+
*/
|
|
3149
3695
|
DrillInclude = "context-menu-item-include",
|
|
3696
|
+
/**
|
|
3697
|
+
* The action to exclude data points on a drilled-down Answer
|
|
3698
|
+
* or visualization
|
|
3699
|
+
*
|
|
3700
|
+
* @example
|
|
3701
|
+
* ```js
|
|
3702
|
+
* disabledActions: [Action.DrillInclude]
|
|
3703
|
+
* ```
|
|
3704
|
+
*/
|
|
3150
3705
|
DrillExclude = "context-menu-item-exclude",
|
|
3706
|
+
/**
|
|
3707
|
+
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3708
|
+
* or Liveboard.
|
|
3709
|
+
* Copies the selected data point.
|
|
3710
|
+
*
|
|
3711
|
+
* @example
|
|
3712
|
+
* ```js
|
|
3713
|
+
* disabledActions: [Action.CopyToClipboard]
|
|
3714
|
+
* ```
|
|
3715
|
+
*/
|
|
3151
3716
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3152
3717
|
CopyAndEdit = "context-menu-item-copy-and-edit",
|
|
3153
3718
|
/**
|
|
@@ -3156,89 +3721,291 @@ export declare enum Action {
|
|
|
3156
3721
|
DrillEdit = "context-menu-item-edit",
|
|
3157
3722
|
EditMeasure = "context-menu-item-edit-measure",
|
|
3158
3723
|
Separator = "context-menu-item-separator",
|
|
3724
|
+
/**
|
|
3725
|
+
* The **Drill down** menu action on Answers and Liveboard
|
|
3726
|
+
* visualizations.
|
|
3727
|
+
* Allows drilling down to a specific data point on a chart or table.
|
|
3728
|
+
*
|
|
3729
|
+
* @example
|
|
3730
|
+
* ```js
|
|
3731
|
+
* disabledActions: [Action.DrillDown]
|
|
3732
|
+
* ```
|
|
3733
|
+
*/
|
|
3159
3734
|
DrillDown = "DRILL",
|
|
3735
|
+
/**
|
|
3736
|
+
* The request access action on Liveboards.
|
|
3737
|
+
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3738
|
+
*
|
|
3739
|
+
* @example
|
|
3740
|
+
* ```js
|
|
3741
|
+
* disabledActions: [Action.RequestAccess]
|
|
3742
|
+
* ```
|
|
3743
|
+
*/
|
|
3160
3744
|
RequestAccess = "requestAccess",
|
|
3161
|
-
QueryDetailsButtons = "queryDetailsButtons",
|
|
3162
3745
|
/**
|
|
3163
|
-
*
|
|
3746
|
+
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3747
|
+
* of the Answer page
|
|
3748
|
+
*
|
|
3749
|
+
* @example
|
|
3750
|
+
* ```js
|
|
3751
|
+
* disabledActions: [Action.QueryDetailsButtons]
|
|
3752
|
+
* ```
|
|
3753
|
+
*/
|
|
3754
|
+
QueryDetailsButtons = "QueryDetailsButtons",
|
|
3755
|
+
/**
|
|
3756
|
+
* The **Delete** action for Answers.
|
|
3757
|
+
*
|
|
3758
|
+
* @example
|
|
3759
|
+
* ```js
|
|
3760
|
+
* disabledActions: [Action.AnswerDelete]
|
|
3761
|
+
* ```
|
|
3762
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3164
3763
|
*/
|
|
3165
3764
|
AnswerDelete = "onDeleteAnswer",
|
|
3166
3765
|
/**
|
|
3167
|
-
*
|
|
3766
|
+
* The Chart switcher icon on Answer and visualization pages.
|
|
3767
|
+
*
|
|
3768
|
+
* @example
|
|
3769
|
+
* ```js
|
|
3770
|
+
* disabledActions: [Action.AnswerChartSwitcher]
|
|
3771
|
+
* ```
|
|
3772
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3168
3773
|
*/
|
|
3169
3774
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3170
3775
|
/**
|
|
3171
|
-
*
|
|
3776
|
+
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3777
|
+
*
|
|
3778
|
+
* @example
|
|
3779
|
+
* ```js
|
|
3780
|
+
* disabledActions: [Action.AddToFavorites]
|
|
3781
|
+
* ```
|
|
3782
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3172
3783
|
*/
|
|
3173
3784
|
AddToFavorites = "addToFavorites",
|
|
3174
3785
|
/**
|
|
3175
|
-
*
|
|
3786
|
+
* The edit icon on Liveboards (Classic experience).
|
|
3787
|
+
*
|
|
3788
|
+
* @example
|
|
3789
|
+
* ```js
|
|
3790
|
+
* disabledActions: [Action.EditDetails]
|
|
3791
|
+
* ```
|
|
3792
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3176
3793
|
*/
|
|
3177
3794
|
EditDetails = "editDetails",
|
|
3178
3795
|
/**
|
|
3179
|
-
*
|
|
3796
|
+
* The Create alert action on KPI charts.
|
|
3797
|
+
*
|
|
3798
|
+
* @example
|
|
3799
|
+
* ```js
|
|
3800
|
+
* disabledActions: [Action.CreateMonitor ]
|
|
3801
|
+
* ```
|
|
3802
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3180
3803
|
*/
|
|
3181
3804
|
CreateMonitor = "createMonitor",
|
|
3182
3805
|
/**
|
|
3183
|
-
* @
|
|
3806
|
+
* @example
|
|
3807
|
+
* ```js
|
|
3808
|
+
* disabledActions: [Action.ReportError]
|
|
3809
|
+
* ```
|
|
3810
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3184
3811
|
*/
|
|
3185
3812
|
ReportError = "reportError",
|
|
3813
|
+
/**
|
|
3814
|
+
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3815
|
+
* Allows sending data to a Google Sheet.
|
|
3816
|
+
*
|
|
3817
|
+
* @example
|
|
3818
|
+
* ```js
|
|
3819
|
+
* disabledActions: [Action.SyncToSheets]
|
|
3820
|
+
* ```
|
|
3821
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3822
|
+
*/
|
|
3186
3823
|
SyncToSheets = "sync-to-sheets",
|
|
3824
|
+
/**
|
|
3825
|
+
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3826
|
+
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3827
|
+
* Microsoft Teams, and so on.
|
|
3828
|
+
*
|
|
3829
|
+
* @example
|
|
3830
|
+
* ```js
|
|
3831
|
+
* disabledActions: [Action.SyncToOtherApps]
|
|
3832
|
+
* ```
|
|
3833
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3834
|
+
*/
|
|
3187
3835
|
SyncToOtherApps = "sync-to-other-apps",
|
|
3836
|
+
/**
|
|
3837
|
+
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3838
|
+
* Allows users to manage data sync pipelines to third-party apps.
|
|
3839
|
+
*
|
|
3840
|
+
* @example
|
|
3841
|
+
* ```js
|
|
3842
|
+
* disabledActions: [Action.SyncToOtherApps]
|
|
3843
|
+
* ```
|
|
3844
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3845
|
+
*/
|
|
3188
3846
|
ManagePipelines = "manage-pipeline",
|
|
3189
3847
|
/**
|
|
3848
|
+
* The **Filter** action on Liveboard visualizations.
|
|
3849
|
+
* Allows users to apply cross-filters on a Liveboard.
|
|
3850
|
+
*
|
|
3851
|
+
* @example
|
|
3852
|
+
* ```js
|
|
3853
|
+
* disabledActions: [Action.CrossFilter]
|
|
3854
|
+
* ```
|
|
3190
3855
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3191
3856
|
*/
|
|
3192
3857
|
CrossFilter = "context-menu-item-cross-filter",
|
|
3193
3858
|
/**
|
|
3859
|
+
* The **Remove** action that appears when cross filters are applied
|
|
3860
|
+
* on a Liveboard.
|
|
3861
|
+
* Removes filters applied o a visualization.
|
|
3862
|
+
*
|
|
3863
|
+
* @example
|
|
3864
|
+
* ```js
|
|
3865
|
+
* disabledActions: [Action.RemoveCrossFilter]
|
|
3866
|
+
* ```
|
|
3194
3867
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3195
3868
|
*/
|
|
3196
3869
|
RemoveCrossFilter = "context-menu-item-remove-cross-filter",
|
|
3197
3870
|
/**
|
|
3871
|
+
* The **Aggregate** option in the chart axis or the
|
|
3872
|
+
* table column customization menu.
|
|
3873
|
+
* Provides aggregation options to analyze the data on a chart or table.
|
|
3874
|
+
*
|
|
3875
|
+
* @example
|
|
3876
|
+
* ```js
|
|
3877
|
+
* disabledActions: [Action.AxisMenuAggregate]
|
|
3878
|
+
* ```
|
|
3198
3879
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3199
3880
|
*/
|
|
3200
3881
|
AxisMenuAggregate = "axisMenuAggregate",
|
|
3201
3882
|
/**
|
|
3883
|
+
* The **Time bucket** option in the chart axis or table column
|
|
3884
|
+
* customization menu.
|
|
3885
|
+
* Allows defining time metric for date comparison.
|
|
3886
|
+
*
|
|
3887
|
+
* @example
|
|
3888
|
+
* ```js
|
|
3889
|
+
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
3890
|
+
* ```
|
|
3202
3891
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3203
3892
|
*/
|
|
3204
3893
|
AxisMenuTimeBucket = "axisMenuTimeBucket",
|
|
3205
3894
|
/**
|
|
3895
|
+
* The **Filter** action in the chart axis or table column
|
|
3896
|
+
* customization menu.
|
|
3897
|
+
*
|
|
3898
|
+
* @example
|
|
3899
|
+
* ```js
|
|
3900
|
+
* disabledActions: [Action.AxisMenuFilter]
|
|
3901
|
+
* ```
|
|
3206
3902
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3207
3903
|
*/
|
|
3208
3904
|
AxisMenuFilter = "axisMenuFilter",
|
|
3209
3905
|
/**
|
|
3906
|
+
* The **Conditional formatting** action on chart or table.
|
|
3907
|
+
* Allows adding rules for conditional formatting of data
|
|
3908
|
+
* points on a chart or table.
|
|
3909
|
+
*
|
|
3910
|
+
* @example
|
|
3911
|
+
* ```js
|
|
3912
|
+
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
3913
|
+
* ```
|
|
3210
3914
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3211
3915
|
*/
|
|
3212
3916
|
AxisMenuConditionalFormat = "axisMenuConditionalFormat",
|
|
3213
3917
|
/**
|
|
3918
|
+
* The **Sort** menu action on a table or chart axis
|
|
3919
|
+
* Sorts data in ascending or descending order.
|
|
3920
|
+
* Allows adding, editing, or removing filters.
|
|
3921
|
+
*
|
|
3922
|
+
* @example
|
|
3923
|
+
* ```js
|
|
3924
|
+
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
3925
|
+
* ```
|
|
3214
3926
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3215
3927
|
*/
|
|
3216
3928
|
AxisMenuSort = "axisMenuSort",
|
|
3217
3929
|
/**
|
|
3930
|
+
* The **Group** option in the chart axis or table column
|
|
3931
|
+
* customization menu.
|
|
3932
|
+
* Allows grouping data points if the axes use the same
|
|
3933
|
+
* unit of measurement and a similar scale.
|
|
3934
|
+
*
|
|
3935
|
+
* @example
|
|
3936
|
+
* ```js
|
|
3937
|
+
* disabledActions: [Action.AxisMenuGroup]
|
|
3938
|
+
* ```
|
|
3218
3939
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3219
3940
|
*/
|
|
3220
3941
|
AxisMenuGroup = "axisMenuGroup",
|
|
3221
3942
|
/**
|
|
3943
|
+
* The **Position** option in the axis customization menu.
|
|
3944
|
+
* Allows changing the position of the axis to the
|
|
3945
|
+
* left or right side of the chart.
|
|
3946
|
+
*
|
|
3947
|
+
* @example
|
|
3948
|
+
* ```js
|
|
3949
|
+
* disabledActions: [Action.AxisMenuPosition]
|
|
3950
|
+
* ```
|
|
3222
3951
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3223
3952
|
*/
|
|
3224
3953
|
AxisMenuPosition = "axisMenuPosition",
|
|
3225
3954
|
/**
|
|
3955
|
+
* The **Rename** option in the chart axis or table column customization menu.
|
|
3956
|
+
* Renames the axis label on a chart or the column header on a table.
|
|
3957
|
+
*
|
|
3958
|
+
* @example
|
|
3959
|
+
* ```js
|
|
3960
|
+
* disabledActions: [Action.AxisMenuRename]
|
|
3961
|
+
* ```
|
|
3226
3962
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3227
3963
|
*/
|
|
3228
3964
|
AxisMenuRename = "axisMenuRename",
|
|
3229
3965
|
/**
|
|
3966
|
+
* The **Edit** action in the axis customization menu.
|
|
3967
|
+
* Allows editing the axis name, position, minimum and maximum values,
|
|
3968
|
+
* and format of a column.
|
|
3969
|
+
*
|
|
3970
|
+
* @example
|
|
3971
|
+
* ```js
|
|
3972
|
+
* disabledActions: [Action.AxisMenuEdit]
|
|
3973
|
+
* ```
|
|
3230
3974
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3231
3975
|
*/
|
|
3232
3976
|
AxisMenuEdit = "axisMenuEdit",
|
|
3233
3977
|
/**
|
|
3978
|
+
* The **Number format** action to customize the format of
|
|
3979
|
+
* the data labels on a chart or table.
|
|
3980
|
+
*
|
|
3981
|
+
* @example
|
|
3982
|
+
* ```js
|
|
3983
|
+
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
3984
|
+
* ```
|
|
3234
3985
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3235
3986
|
*/
|
|
3236
3987
|
AxisMenuNumberFormat = "axisMenuNumberFormat",
|
|
3237
3988
|
/**
|
|
3989
|
+
* The **Text wrapping** action on a table.
|
|
3990
|
+
* Wraps or clips column text on a table.
|
|
3991
|
+
*
|
|
3992
|
+
* @example
|
|
3993
|
+
* ```js
|
|
3994
|
+
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
3995
|
+
* ```
|
|
3238
3996
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3239
3997
|
*/
|
|
3240
3998
|
AxisMenuTextWrapping = "axisMenuTextWrapping",
|
|
3241
3999
|
/**
|
|
4000
|
+
* The **Remove** action in the chart axis or table column
|
|
4001
|
+
* customization menu.
|
|
4002
|
+
* Removes the data labels from a chart or the column of a
|
|
4003
|
+
* table visualization.
|
|
4004
|
+
*
|
|
4005
|
+
* @example
|
|
4006
|
+
* ```js
|
|
4007
|
+
* disabledActions: [Action.AxisMenuRemove]
|
|
4008
|
+
* ```
|
|
3242
4009
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3243
4010
|
*/
|
|
3244
4011
|
AxisMenuRemove = "axisMenuRemove",
|
|
@@ -3247,9 +4014,48 @@ export declare enum Action {
|
|
|
3247
4014
|
*/
|
|
3248
4015
|
InsertInToSlide = "insertInToSlide",
|
|
3249
4016
|
/**
|
|
4017
|
+
* The **Rename** menu action on Liveboards and visualizations.
|
|
4018
|
+
* Allows renaming a Liveboard or visualization.
|
|
4019
|
+
*
|
|
4020
|
+
* @example
|
|
4021
|
+
* ```js
|
|
4022
|
+
* disabledActions: [Action.RenameModalTitleDescription]
|
|
4023
|
+
* ```
|
|
3250
4024
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3251
4025
|
*/
|
|
3252
|
-
RenameModalTitleDescription = "renameModalTitleDescription"
|
|
4026
|
+
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
4027
|
+
/**
|
|
4028
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
4029
|
+
*/
|
|
4030
|
+
RequestVerification = "requestVerification",
|
|
4031
|
+
/**
|
|
4032
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
4033
|
+
*/
|
|
4034
|
+
MarkAsVerified = "markAsVerified",
|
|
4035
|
+
/**
|
|
4036
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4037
|
+
*/
|
|
4038
|
+
AddTab = "addTab",
|
|
4039
|
+
/**
|
|
4040
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
4041
|
+
*/
|
|
4042
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
4043
|
+
/**
|
|
4044
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4045
|
+
*/
|
|
4046
|
+
ShowSageQuery = "showSageQuery",
|
|
4047
|
+
/**
|
|
4048
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4049
|
+
*/
|
|
4050
|
+
EditSageAnswer = "editSageAnswer",
|
|
4051
|
+
/**
|
|
4052
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4053
|
+
*/
|
|
4054
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
4055
|
+
/**
|
|
4056
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4057
|
+
*/
|
|
4058
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
3253
4059
|
}
|
|
3254
4060
|
export interface SessionInterface {
|
|
3255
4061
|
sessionId: string;
|
|
@@ -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
|
-
'
|
|
4213
|
+
'--ts-var-button--primary-background'?: string;
|
|
3408
4214
|
/**
|
|
3409
4215
|
* Background color of the primary buttons on hover.
|
|
3410
4216
|
*/
|