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