@thoughtspot/visual-embed-sdk 1.23.0 → 1.23.2
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 +1 -1
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +1 -3
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/embed/app.d.ts +9 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +3 -2
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +10 -0
- package/cjs/src/embed/app.spec.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/sage.d.ts +39 -2
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +17 -3
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/sage.spec.js +27 -1
- package/cjs/src/embed/sage.spec.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +1 -1
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search.d.ts +8 -0
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +2 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +11 -1
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/react/index.spec.js +1 -1
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/types.d.ts +380 -248
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +357 -241
- package/cjs/src/types.js.map +1 -1
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +9 -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/sage.d.ts +39 -2
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +1 -1
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +8 -0
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/types.d.ts +380 -248
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +381 -17448
- package/dist/tsembed-react.js +380 -17447
- package/dist/tsembed.es.js +389 -17448
- package/dist/tsembed.js +388 -17447
- package/dist/visual-embed-sdk-react-full.d.ts +445 -252
- package/dist/visual-embed-sdk-react.d.ts +445 -252
- package/dist/visual-embed-sdk.d.ts +445 -252
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +1 -2
- package/lib/src/auth.js.map +1 -1
- package/lib/src/embed/app.d.ts +9 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +3 -2
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +10 -0
- package/lib/src/embed/app.spec.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/sage.d.ts +39 -2
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +17 -3
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/sage.spec.js +27 -1
- package/lib/src/embed/sage.spec.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +1 -1
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search.d.ts +8 -0
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +2 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +11 -1
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/react/index.spec.js +1 -1
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +380 -248
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +357 -241
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +445 -252
- package/package.json +1 -1
- package/src/auth.ts +1 -2
- package/src/embed/app.spec.ts +15 -0
- package/src/embed/app.ts +11 -1
- package/src/embed/base.ts +8 -0
- package/src/embed/sage.spec.ts +33 -1
- package/src/embed/sage.ts +59 -4
- package/src/embed/search-bar.tsx +1 -1
- package/src/embed/search.spec.ts +15 -1
- package/src/embed/search.ts +10 -0
- package/src/react/index.spec.tsx +1 -1
- package/src/types.ts +366 -247
package/dist/src/types.d.ts
CHANGED
|
@@ -253,6 +253,9 @@ export interface CustomStyles {
|
|
|
253
253
|
export interface CustomisationsInterface {
|
|
254
254
|
style?: CustomStyles;
|
|
255
255
|
content?: {
|
|
256
|
+
/**
|
|
257
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
258
|
+
*/
|
|
256
259
|
strings?: Record<string, any>;
|
|
257
260
|
[key: string]: any;
|
|
258
261
|
};
|
|
@@ -660,21 +663,21 @@ export interface ViewConfig {
|
|
|
660
663
|
/**
|
|
661
664
|
* Boolean to hide liveboard header
|
|
662
665
|
*
|
|
663
|
-
* @version SDK: 1.
|
|
666
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
664
667
|
* @default false
|
|
665
668
|
*/
|
|
666
669
|
hideLiveboardHeader?: boolean;
|
|
667
670
|
/**
|
|
668
671
|
* Boolean to show liveboard title
|
|
669
672
|
*
|
|
670
|
-
* @version SDK: 1.
|
|
673
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
671
674
|
* @default false
|
|
672
675
|
*/
|
|
673
676
|
showLiveboardTitle?: boolean;
|
|
674
677
|
/**
|
|
675
678
|
* Boolean to show liveboard description
|
|
676
679
|
*
|
|
677
|
-
* @version SDK: 1.
|
|
680
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
678
681
|
* @default false
|
|
679
682
|
*/
|
|
680
683
|
showLiveboardDescription?: boolean;
|
|
@@ -692,7 +695,7 @@ export interface ViewConfig {
|
|
|
692
695
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
693
696
|
* });
|
|
694
697
|
* ```
|
|
695
|
-
* @version SDK: 1.
|
|
698
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
696
699
|
*/
|
|
697
700
|
hiddenTabs?: string[];
|
|
698
701
|
/**
|
|
@@ -711,7 +714,7 @@ export interface ViewConfig {
|
|
|
711
714
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
712
715
|
* });
|
|
713
716
|
* ```
|
|
714
|
-
* @version SDK: 1.
|
|
717
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
715
718
|
*/
|
|
716
719
|
visibleTabs?: string[];
|
|
717
720
|
}
|
|
@@ -1273,7 +1276,19 @@ export declare enum EmbedEvent {
|
|
|
1273
1276
|
*
|
|
1274
1277
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1275
1278
|
*/
|
|
1276
|
-
FilterChanged = "filterChanged"
|
|
1279
|
+
FilterChanged = "filterChanged",
|
|
1280
|
+
/**
|
|
1281
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
1282
|
+
*
|
|
1283
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
1284
|
+
*/
|
|
1285
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
1286
|
+
/**
|
|
1287
|
+
* Emitten when a user select data source in Sage Embed
|
|
1288
|
+
*
|
|
1289
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
1290
|
+
*/
|
|
1291
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
1277
1292
|
}
|
|
1278
1293
|
/**
|
|
1279
1294
|
* Event types that can be triggered by the host application
|
|
@@ -1302,6 +1317,7 @@ export declare enum HostEvent {
|
|
|
1302
1317
|
* Triggers a search query in AppEmbed and SearchEmbed
|
|
1303
1318
|
* deployments.
|
|
1304
1319
|
* Includes the following properties:
|
|
1320
|
+
*
|
|
1305
1321
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
1306
1322
|
* - Although an array, only a single source
|
|
1307
1323
|
* is supported.
|
|
@@ -1320,6 +1336,7 @@ export declare enum HostEvent {
|
|
|
1320
1336
|
/**
|
|
1321
1337
|
* Triggers a drill on certain points of the specified column
|
|
1322
1338
|
* Includes the following properties:
|
|
1339
|
+
*
|
|
1323
1340
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
1324
1341
|
* to drill to. For example, { selectedPoints: []}
|
|
1325
1342
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -1384,18 +1401,19 @@ export declare enum HostEvent {
|
|
|
1384
1401
|
*/
|
|
1385
1402
|
SetActiveTab = "SetActiveTab",
|
|
1386
1403
|
/**
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1404
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
1405
|
+
* runtime filters passed here are appended to the existing runtime
|
|
1406
|
+
* filters.
|
|
1407
|
+
* Pass an array of runtime filters with the following attributes:
|
|
1408
|
+
* `columnName`
|
|
1409
|
+
* _String_. The name of the column to filter on.
|
|
1410
|
+
* `operator`
|
|
1411
|
+
* Runtime filter operator to apply. For information,
|
|
1412
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
1413
|
+
* `values`
|
|
1414
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
1415
|
+
* operators such as BW and IN accept multiple operands.
|
|
1416
|
+
*
|
|
1399
1417
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
1400
1418
|
* @example
|
|
1401
1419
|
* ```js
|
|
@@ -1411,6 +1429,7 @@ export declare enum HostEvent {
|
|
|
1411
1429
|
/**
|
|
1412
1430
|
* Navigate to a specific page in the embedded application without reloading the page.
|
|
1413
1431
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
1432
|
+
*
|
|
1414
1433
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
1415
1434
|
* @example
|
|
1416
1435
|
* ```js
|
|
@@ -1734,6 +1753,7 @@ export declare enum HostEvent {
|
|
|
1734
1753
|
/**
|
|
1735
1754
|
* Triggers the **SpotIQ analyze** action on visualization
|
|
1736
1755
|
* or search.
|
|
1756
|
+
*
|
|
1737
1757
|
* @param - Liveboard embed takes `vizId` as a
|
|
1738
1758
|
* key. Can be left undefined when embedding Search or
|
|
1739
1759
|
* visualization.
|
|
@@ -1773,6 +1793,7 @@ export declare enum HostEvent {
|
|
|
1773
1793
|
/**
|
|
1774
1794
|
* Triggers the **Download** > **PNG** action on
|
|
1775
1795
|
* charts in the embedded view.
|
|
1796
|
+
*
|
|
1776
1797
|
* @example
|
|
1777
1798
|
* ```js
|
|
1778
1799
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -1806,6 +1827,7 @@ export declare enum HostEvent {
|
|
|
1806
1827
|
/**
|
|
1807
1828
|
* Triggers the **Download** > **XLSX** action on tables
|
|
1808
1829
|
* in the embedded view.
|
|
1830
|
+
*
|
|
1809
1831
|
* @example
|
|
1810
1832
|
* ```js
|
|
1811
1833
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -1837,6 +1859,7 @@ export declare enum HostEvent {
|
|
|
1837
1859
|
/**
|
|
1838
1860
|
* Triggers the **Save** action on a Liveboard or Answer.
|
|
1839
1861
|
* Saves the changes.
|
|
1862
|
+
*
|
|
1840
1863
|
* @example
|
|
1841
1864
|
* ```js
|
|
1842
1865
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -1850,6 +1873,7 @@ export declare enum HostEvent {
|
|
|
1850
1873
|
/**
|
|
1851
1874
|
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
1852
1875
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
1876
|
+
*
|
|
1853
1877
|
* @param - an object with `vizId` as a key
|
|
1854
1878
|
* @example
|
|
1855
1879
|
* ```js
|
|
@@ -1866,6 +1890,7 @@ export declare enum HostEvent {
|
|
|
1866
1890
|
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
1867
1891
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
1868
1892
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
1893
|
+
*
|
|
1869
1894
|
* @param - an object with vizId as a key
|
|
1870
1895
|
* @example
|
|
1871
1896
|
* ```js
|
|
@@ -1882,6 +1907,7 @@ export declare enum HostEvent {
|
|
|
1882
1907
|
* Triggers the **Manage pipelines** action on an embedded
|
|
1883
1908
|
* visualization or Answer.
|
|
1884
1909
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
1910
|
+
*
|
|
1885
1911
|
* @param - an object with `vizId` as a key
|
|
1886
1912
|
* @example
|
|
1887
1913
|
* ```js
|
|
@@ -1926,6 +1952,19 @@ export declare enum HostEvent {
|
|
|
1926
1952
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1927
1953
|
*/
|
|
1928
1954
|
UpdateFilters = "updateFilters",
|
|
1955
|
+
/**
|
|
1956
|
+
* Get Tab for the current Liveboard.
|
|
1957
|
+
*
|
|
1958
|
+
* @example
|
|
1959
|
+
* ```js
|
|
1960
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
1961
|
+
* console.log(
|
|
1962
|
+
* tabDetails // TabDetails of current LB
|
|
1963
|
+
* );
|
|
1964
|
+
* })
|
|
1965
|
+
* ```
|
|
1966
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1967
|
+
*/
|
|
1929
1968
|
GetTabs = "getTabs",
|
|
1930
1969
|
/**
|
|
1931
1970
|
* Set the visible Tabs on a Liveboard.
|
|
@@ -1938,7 +1977,7 @@ export declare enum HostEvent {
|
|
|
1938
1977
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1939
1978
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
1940
1979
|
* ```
|
|
1941
|
-
* @version SDK: 1.
|
|
1980
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1942
1981
|
*/
|
|
1943
1982
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
1944
1983
|
/**
|
|
@@ -1952,9 +1991,23 @@ export declare enum HostEvent {
|
|
|
1952
1991
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
1953
1992
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
1954
1993
|
* ```
|
|
1955
|
-
* @version SDK: 1.
|
|
1994
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1956
1995
|
*/
|
|
1957
|
-
SetHiddenTabs = "SetPinboardHiddenTabs"
|
|
1996
|
+
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
1997
|
+
/**
|
|
1998
|
+
* Updates the search query for sage embed.
|
|
1999
|
+
*
|
|
2000
|
+
* @param - searchOptions: an object queryString and option to execute the query.
|
|
2001
|
+
* @example
|
|
2002
|
+
* ```js
|
|
2003
|
+
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
2004
|
+
* queryString: 'revenue per year',
|
|
2005
|
+
* executeSearch: true,
|
|
2006
|
+
* })
|
|
2007
|
+
* ```
|
|
2008
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2009
|
+
*/
|
|
2010
|
+
UpdateSageQuery = "updateSageQuery"
|
|
1958
2011
|
}
|
|
1959
2012
|
/**
|
|
1960
2013
|
* The different visual modes that the data sources panel within
|
|
@@ -2009,6 +2062,7 @@ export declare enum Param {
|
|
|
2009
2062
|
DisableLoginRedirect = "disableLoginRedirect",
|
|
2010
2063
|
visibleVizs = "pinboardVisibleVizs",
|
|
2011
2064
|
LiveboardV2Enabled = "isPinboardV2Enabled",
|
|
2065
|
+
DataPanelV2Enabled = "enableDataPanelV2",
|
|
2012
2066
|
ShowAlerts = "showAlerts",
|
|
2013
2067
|
Locale = "locale",
|
|
2014
2068
|
CustomStyle = "customStyle",
|
|
@@ -2034,7 +2088,10 @@ export declare enum Param {
|
|
|
2034
2088
|
ShowLiveboardTitle = "showLiveboardTitle",
|
|
2035
2089
|
HiddenTabs = "hideTabs",
|
|
2036
2090
|
VisibleTabs = "visibleTabs",
|
|
2037
|
-
HideTabPanel = "hideTabPanel"
|
|
2091
|
+
HideTabPanel = "hideTabPanel",
|
|
2092
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
2093
|
+
WorksheetId = "worksheet",
|
|
2094
|
+
Query = "query"
|
|
2038
2095
|
}
|
|
2039
2096
|
/**
|
|
2040
2097
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -2043,6 +2100,7 @@ export declare enum Param {
|
|
|
2043
2100
|
* specific actions in the embedded view, define the Action
|
|
2044
2101
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
2045
2102
|
* or `hiddenActions` array.
|
|
2103
|
+
*
|
|
2046
2104
|
* @example
|
|
2047
2105
|
* ```js
|
|
2048
2106
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2061,12 +2119,12 @@ export declare enum Param {
|
|
|
2061
2119
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
2062
2120
|
* })
|
|
2063
2121
|
* ```
|
|
2064
|
-
|
|
2065
2122
|
*/
|
|
2066
2123
|
export declare enum Action {
|
|
2067
2124
|
/**
|
|
2068
2125
|
* The **Save** action on an Answer or Liveboard.
|
|
2069
2126
|
* Allows users to save the changes.
|
|
2127
|
+
*
|
|
2070
2128
|
* @example
|
|
2071
2129
|
* ```js
|
|
2072
2130
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -2082,136 +2140,146 @@ export declare enum Action {
|
|
|
2082
2140
|
*/
|
|
2083
2141
|
SaveUntitled = "saveUntitled",
|
|
2084
2142
|
/**
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
|
|
2143
|
+
* The **Save as View** action on the Answer
|
|
2144
|
+
* page. Saves an Answer as a View object.
|
|
2145
|
+
*
|
|
2146
|
+
* @example
|
|
2147
|
+
* ```js
|
|
2148
|
+
* disabledActions: [Action.SaveAsView]
|
|
2149
|
+
* ```
|
|
2150
|
+
*/
|
|
2093
2151
|
SaveAsView = "saveAsView",
|
|
2094
2152
|
/**
|
|
2095
|
-
|
|
2096
|
-
|
|
2097
|
-
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
|
-
|
|
2104
|
-
|
|
2153
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
2154
|
+
* page.
|
|
2155
|
+
* Creates a copy of the Liveboard, visualization,
|
|
2156
|
+
* or Answer.
|
|
2157
|
+
*
|
|
2158
|
+
* @example
|
|
2159
|
+
* ```js
|
|
2160
|
+
* disabledActions: [Action.MakeACopy]
|
|
2161
|
+
* ```
|
|
2162
|
+
*/
|
|
2105
2163
|
MakeACopy = "makeACopy",
|
|
2106
2164
|
/**
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2165
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
2166
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
2167
|
+
*
|
|
2168
|
+
* @example
|
|
2169
|
+
* ```js
|
|
2170
|
+
* disabledActions: [Action.EditACopy]
|
|
2171
|
+
* ```
|
|
2172
|
+
*/
|
|
2115
2173
|
EditACopy = "editACopy",
|
|
2116
2174
|
/**
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
|
|
2122
|
-
|
|
2123
|
-
|
|
2175
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
2176
|
+
* Copies the visualization URL
|
|
2177
|
+
*
|
|
2178
|
+
* @example
|
|
2179
|
+
* ```js
|
|
2180
|
+
* disabledActions: [Action.CopyLink]
|
|
2181
|
+
* ```
|
|
2182
|
+
*/
|
|
2124
2183
|
CopyLink = "embedDocument",
|
|
2125
2184
|
/**
|
|
2126
2185
|
* @hidden
|
|
2127
2186
|
*/
|
|
2128
2187
|
ResetLayout = "resetLayout",
|
|
2129
2188
|
/**
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
|
|
2136
|
-
|
|
2189
|
+
* The **Schedule** menu action on a Liveboard.
|
|
2190
|
+
* Allows scheduling a Liveboard notification.
|
|
2191
|
+
*
|
|
2192
|
+
* @example
|
|
2193
|
+
* ```js
|
|
2194
|
+
* disabledActions: [Action.Schedule]
|
|
2195
|
+
* ```
|
|
2196
|
+
*/
|
|
2137
2197
|
Schedule = "subscription",
|
|
2138
2198
|
/**
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
|
|
2145
|
-
|
|
2199
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
2200
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
2201
|
+
*
|
|
2202
|
+
* @example
|
|
2203
|
+
* ```js
|
|
2204
|
+
* disabledActions: [Action.SchedulesList]
|
|
2205
|
+
* ```
|
|
2206
|
+
*/
|
|
2146
2207
|
SchedulesList = "schedule-list",
|
|
2147
2208
|
/**
|
|
2148
|
-
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
|
|
2153
|
-
|
|
2154
|
-
|
|
2209
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
2210
|
+
* Allows users to share an object with other users and groups.
|
|
2211
|
+
*
|
|
2212
|
+
* @example
|
|
2213
|
+
* ```js
|
|
2214
|
+
* disabledActions: [Action.Share]
|
|
2215
|
+
* ```
|
|
2216
|
+
*/
|
|
2155
2217
|
Share = "share",
|
|
2156
2218
|
/**
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2219
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
2220
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
2221
|
+
*
|
|
2222
|
+
* @example
|
|
2223
|
+
* ```js
|
|
2224
|
+
* disabledActions: [Action.AddFilter]
|
|
2225
|
+
* ```
|
|
2226
|
+
*/
|
|
2164
2227
|
AddFilter = "addFilter",
|
|
2165
2228
|
/**
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2229
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
2230
|
+
* Allows configuring filter options when adding filters to a
|
|
2231
|
+
* Liveboard or Answer.
|
|
2232
|
+
*
|
|
2233
|
+
* @example
|
|
2234
|
+
* ```js
|
|
2235
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
2236
|
+
* ```
|
|
2237
|
+
*/
|
|
2174
2238
|
ConfigureFilter = "configureFilter",
|
|
2175
2239
|
CollapseDataSources = "collapseDataSources",
|
|
2176
2240
|
/**
|
|
2177
|
-
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2241
|
+
* The **Choose sources** button on Search page.
|
|
2242
|
+
* Allows selecting data sources for search queries.
|
|
2243
|
+
*
|
|
2244
|
+
* @example
|
|
2245
|
+
* ```js
|
|
2246
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
2247
|
+
* ```
|
|
2248
|
+
*/
|
|
2184
2249
|
ChooseDataSources = "chooseDataSources",
|
|
2185
2250
|
/**
|
|
2186
|
-
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2251
|
+
* The **Create formula** action on a Search or Answer page.
|
|
2252
|
+
* Allows adding formulas to an Answer.
|
|
2253
|
+
*
|
|
2254
|
+
* @example
|
|
2255
|
+
* ```js
|
|
2256
|
+
* disabledActions: [Action.AddFormula]
|
|
2257
|
+
* ```
|
|
2258
|
+
*/
|
|
2193
2259
|
AddFormula = "addFormula",
|
|
2194
2260
|
/**
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
|
|
2200
|
-
|
|
2201
|
-
|
|
2261
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
2262
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
2263
|
+
*
|
|
2264
|
+
* @example
|
|
2265
|
+
* ```js
|
|
2266
|
+
* disabledActions: [Action.AddParameter]
|
|
2267
|
+
* ```
|
|
2268
|
+
*/
|
|
2202
2269
|
AddParameter = "addParameter",
|
|
2203
2270
|
/**
|
|
2204
2271
|
* @hidden
|
|
2205
2272
|
*/
|
|
2206
2273
|
SearchOnTop = "searchOnTop",
|
|
2207
2274
|
/**
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2275
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
2276
|
+
* Answer page.
|
|
2277
|
+
*
|
|
2278
|
+
* @example
|
|
2279
|
+
* ```js
|
|
2280
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
2281
|
+
* ```
|
|
2282
|
+
*/
|
|
2215
2283
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2216
2284
|
/**
|
|
2217
2285
|
* @hidden
|
|
@@ -2227,89 +2295,98 @@ export declare enum Action {
|
|
|
2227
2295
|
*/
|
|
2228
2296
|
ReplaySearch = "replaySearch",
|
|
2229
2297
|
/**
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
|
|
2298
|
+
* The **Show underlying data** menu action on a visualization or
|
|
2299
|
+
* Answer page.
|
|
2300
|
+
*
|
|
2301
|
+
* @example
|
|
2302
|
+
* ```js
|
|
2303
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
2304
|
+
* ```
|
|
2305
|
+
*/
|
|
2237
2306
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2238
2307
|
/**
|
|
2239
|
-
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
|
-
|
|
2246
|
-
|
|
2308
|
+
* The **Download** menu action on Liveboard visualizations
|
|
2309
|
+
* and Answers.
|
|
2310
|
+
* Allows downloading a visualization or Answer.
|
|
2311
|
+
*
|
|
2312
|
+
* @example
|
|
2313
|
+
* ```js
|
|
2314
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
2315
|
+
* ```
|
|
2316
|
+
*/
|
|
2247
2317
|
Download = "download",
|
|
2248
2318
|
/**
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2319
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
2320
|
+
* or Answer page.
|
|
2321
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
2322
|
+
*
|
|
2323
|
+
* @example
|
|
2324
|
+
* ```js
|
|
2325
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
2326
|
+
* ```
|
|
2327
|
+
*/
|
|
2257
2328
|
DownloadAsPng = "downloadAsPng",
|
|
2258
2329
|
/**
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2330
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
2331
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
2332
|
+
*
|
|
2333
|
+
* @example
|
|
2334
|
+
* ```js
|
|
2335
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
2336
|
+
* ```
|
|
2337
|
+
*/
|
|
2266
2338
|
DownloadAsPdf = "downloadAsPdf",
|
|
2267
2339
|
/**
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
|
|
2340
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
2341
|
+
* or Answer page.
|
|
2342
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
2343
|
+
*
|
|
2344
|
+
* @example
|
|
2345
|
+
* ```js
|
|
2346
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
2347
|
+
* ```
|
|
2348
|
+
*/
|
|
2276
2349
|
DownloadAsCsv = "downloadAsCSV",
|
|
2277
2350
|
/**
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
|
|
2351
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
2352
|
+
* or Answer page.
|
|
2353
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
2354
|
+
*
|
|
2355
|
+
* @example
|
|
2356
|
+
* ```js
|
|
2357
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
2358
|
+
* ```
|
|
2359
|
+
*/
|
|
2286
2360
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
2287
2361
|
/**
|
|
2288
2362
|
* @hidden
|
|
2289
2363
|
*/
|
|
2290
2364
|
DownloadTrace = "downloadTrace",
|
|
2291
2365
|
/**
|
|
2292
|
-
|
|
2293
|
-
|
|
2294
|
-
|
|
2295
|
-
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
|
|
2366
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
2367
|
+
* Worksheets and Data Connections page.
|
|
2368
|
+
* Exports an object as a TML file.
|
|
2369
|
+
*
|
|
2370
|
+
* @example
|
|
2371
|
+
* ```js
|
|
2372
|
+
* disabledActions: [Action.ExportTML]
|
|
2373
|
+
* ```
|
|
2374
|
+
*/
|
|
2300
2375
|
ExportTML = "exportTSL",
|
|
2301
2376
|
/**
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
|
|
2377
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
2378
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
2379
|
+
*
|
|
2380
|
+
* @example
|
|
2381
|
+
* ```js
|
|
2382
|
+
* disabledActions: [Action.ImportTML]
|
|
2383
|
+
* ```
|
|
2384
|
+
*/
|
|
2309
2385
|
ImportTML = "importTSL",
|
|
2310
2386
|
/**
|
|
2311
2387
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
2312
2388
|
* Update TML representation of ThoughtSpot objects.
|
|
2389
|
+
*
|
|
2313
2390
|
* @example
|
|
2314
2391
|
* ```js
|
|
2315
2392
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -2319,6 +2396,7 @@ export declare enum Action {
|
|
|
2319
2396
|
/**
|
|
2320
2397
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
2321
2398
|
* Opens the TML editor.
|
|
2399
|
+
*
|
|
2322
2400
|
* @example
|
|
2323
2401
|
* ```js
|
|
2324
2402
|
* disabledActions: [Action.EditTML]
|
|
@@ -2326,50 +2404,55 @@ export declare enum Action {
|
|
|
2326
2404
|
*/
|
|
2327
2405
|
EditTML = "editTSL",
|
|
2328
2406
|
/**
|
|
2329
|
-
|
|
2330
|
-
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2407
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
2408
|
+
* Allows presenting a Liveboard or visualization in
|
|
2409
|
+
* slideshow mode.
|
|
2410
|
+
*
|
|
2411
|
+
* @example
|
|
2412
|
+
* ```js
|
|
2413
|
+
* disabledActions: [Action.Present]
|
|
2414
|
+
* ```
|
|
2415
|
+
*/
|
|
2337
2416
|
Present = "present",
|
|
2338
2417
|
/**
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2418
|
+
* The tile resize options in the visualization menu.
|
|
2419
|
+
* Allows switching between different preset layouts.
|
|
2420
|
+
*
|
|
2421
|
+
* @example
|
|
2422
|
+
* ```js
|
|
2423
|
+
* disabledActions: [Action.ToggleSize]
|
|
2424
|
+
* ```
|
|
2425
|
+
*/
|
|
2346
2426
|
ToggleSize = "toggleSize",
|
|
2347
2427
|
/**
|
|
2348
|
-
|
|
2349
|
-
|
|
2350
|
-
|
|
2351
|
-
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2428
|
+
* The *Edit* action on the Liveboard page and in the
|
|
2429
|
+
* visualization menu.
|
|
2430
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
2431
|
+
*
|
|
2432
|
+
* @example
|
|
2433
|
+
* ```js
|
|
2434
|
+
* disabledActions: [Action.Edit]
|
|
2435
|
+
* ```
|
|
2436
|
+
*/
|
|
2356
2437
|
Edit = "edit",
|
|
2357
2438
|
/**
|
|
2358
|
-
|
|
2359
|
-
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
|
|
2439
|
+
* The text edit option for Liveboard and visualization titles.
|
|
2440
|
+
*
|
|
2441
|
+
* @example
|
|
2442
|
+
* ```js
|
|
2443
|
+
* disabledActions: [Action.EditTitle]
|
|
2444
|
+
* ```
|
|
2445
|
+
*/
|
|
2364
2446
|
EditTitle = "editTitle",
|
|
2365
2447
|
/**
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
|
|
2372
|
-
|
|
2448
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
2449
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
2450
|
+
*
|
|
2451
|
+
* @example
|
|
2452
|
+
* ```js
|
|
2453
|
+
* disabledActions: [Action.Remove]
|
|
2454
|
+
* ```
|
|
2455
|
+
*/
|
|
2373
2456
|
Remove = "delete",
|
|
2374
2457
|
/**
|
|
2375
2458
|
* @hidden
|
|
@@ -2392,15 +2475,16 @@ export declare enum Action {
|
|
|
2392
2475
|
*/
|
|
2393
2476
|
PinboardInfo = "pinboardInfo",
|
|
2394
2477
|
/**
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
|
|
2478
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
2479
|
+
* Displays details such as the name, description, and
|
|
2480
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
2481
|
+
* and update.
|
|
2482
|
+
*
|
|
2483
|
+
* @example
|
|
2484
|
+
* ```js
|
|
2485
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
2486
|
+
* ```
|
|
2487
|
+
*/
|
|
2404
2488
|
LiveboardInfo = "pinboardInfo",
|
|
2405
2489
|
/**
|
|
2406
2490
|
* @hidden
|
|
@@ -2411,13 +2495,14 @@ export declare enum Action {
|
|
|
2411
2495
|
*/
|
|
2412
2496
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
2413
2497
|
/**
|
|
2414
|
-
|
|
2415
|
-
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2419
|
-
|
|
2420
|
-
|
|
2498
|
+
* The **Pin** menu action on an Answer or
|
|
2499
|
+
* Search results page.
|
|
2500
|
+
*
|
|
2501
|
+
* @example
|
|
2502
|
+
* ```js
|
|
2503
|
+
* disabledActions: [Action.Pin]
|
|
2504
|
+
* ```
|
|
2505
|
+
*/
|
|
2421
2506
|
Pin = "pin",
|
|
2422
2507
|
/**
|
|
2423
2508
|
* @hidden
|
|
@@ -2425,6 +2510,7 @@ export declare enum Action {
|
|
|
2425
2510
|
AnalysisInfo = "analysisInfo",
|
|
2426
2511
|
/**
|
|
2427
2512
|
* The **Schedule** menu action on a Liveboard.
|
|
2513
|
+
*
|
|
2428
2514
|
* @example
|
|
2429
2515
|
* ```js
|
|
2430
2516
|
* disabledActions: [Action.Subscription]
|
|
@@ -2432,25 +2518,28 @@ export declare enum Action {
|
|
|
2432
2518
|
*/
|
|
2433
2519
|
Subscription = "subscription",
|
|
2434
2520
|
/**
|
|
2435
|
-
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
|
|
2440
|
-
|
|
2521
|
+
* The **Explore** action on Liveboard visualizations
|
|
2522
|
+
*
|
|
2523
|
+
* @example
|
|
2524
|
+
* ```js
|
|
2525
|
+
* disabledActions: [Action.Explore]
|
|
2526
|
+
* ```
|
|
2527
|
+
*/
|
|
2441
2528
|
Explore = "explore",
|
|
2442
2529
|
/**
|
|
2443
|
-
|
|
2444
|
-
|
|
2445
|
-
|
|
2446
|
-
|
|
2447
|
-
|
|
2448
|
-
|
|
2449
|
-
|
|
2530
|
+
* The action to include data points on a drilled-down Answer
|
|
2531
|
+
* or visualization
|
|
2532
|
+
*
|
|
2533
|
+
* @example
|
|
2534
|
+
* ```js
|
|
2535
|
+
* disabledActions: [Action.DrillInclude]
|
|
2536
|
+
* ```
|
|
2537
|
+
*/
|
|
2450
2538
|
DrillInclude = "context-menu-item-include",
|
|
2451
2539
|
/**
|
|
2452
2540
|
* The action to exclude data points on a drilled-down Answer
|
|
2453
2541
|
* or visualization
|
|
2542
|
+
*
|
|
2454
2543
|
* @example
|
|
2455
2544
|
* ```js
|
|
2456
2545
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -2461,6 +2550,7 @@ export declare enum Action {
|
|
|
2461
2550
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
2462
2551
|
* or Liveboard.
|
|
2463
2552
|
* Copies the selected data point.
|
|
2553
|
+
*
|
|
2464
2554
|
* @example
|
|
2465
2555
|
* ```js
|
|
2466
2556
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -2478,6 +2568,7 @@ export declare enum Action {
|
|
|
2478
2568
|
* The **Drill down** menu action on Answers and Liveboard
|
|
2479
2569
|
* visualizations.
|
|
2480
2570
|
* Allows drilling down to a specific data point on a chart or table.
|
|
2571
|
+
*
|
|
2481
2572
|
* @example
|
|
2482
2573
|
* ```js
|
|
2483
2574
|
* disabledActions: [Action.DrillDown]
|
|
@@ -2487,6 +2578,7 @@ export declare enum Action {
|
|
|
2487
2578
|
/**
|
|
2488
2579
|
* The request access action on Liveboards.
|
|
2489
2580
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
2581
|
+
*
|
|
2490
2582
|
* @example
|
|
2491
2583
|
* ```js
|
|
2492
2584
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -2496,6 +2588,7 @@ export declare enum Action {
|
|
|
2496
2588
|
/**
|
|
2497
2589
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
2498
2590
|
* of the Answer page
|
|
2591
|
+
*
|
|
2499
2592
|
* @example
|
|
2500
2593
|
* ```js
|
|
2501
2594
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -2504,6 +2597,7 @@ export declare enum Action {
|
|
|
2504
2597
|
QueryDetailsButtons = "QueryDetailsButtons",
|
|
2505
2598
|
/**
|
|
2506
2599
|
* The **Delete** action for Answers.
|
|
2600
|
+
*
|
|
2507
2601
|
* @example
|
|
2508
2602
|
* ```js
|
|
2509
2603
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -2513,6 +2607,7 @@ export declare enum Action {
|
|
|
2513
2607
|
AnswerDelete = "onDeleteAnswer",
|
|
2514
2608
|
/**
|
|
2515
2609
|
* The Chart switcher icon on Answer and visualization pages.
|
|
2610
|
+
*
|
|
2516
2611
|
* @example
|
|
2517
2612
|
* ```js
|
|
2518
2613
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -2522,6 +2617,7 @@ export declare enum Action {
|
|
|
2522
2617
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
2523
2618
|
/**
|
|
2524
2619
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
2620
|
+
*
|
|
2525
2621
|
* @example
|
|
2526
2622
|
* ```js
|
|
2527
2623
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -2531,6 +2627,7 @@ export declare enum Action {
|
|
|
2531
2627
|
AddToFavorites = "addToFavorites",
|
|
2532
2628
|
/**
|
|
2533
2629
|
* The edit icon on Liveboards (Classic experience).
|
|
2630
|
+
*
|
|
2534
2631
|
* @example
|
|
2535
2632
|
* ```js
|
|
2536
2633
|
* disabledActions: [Action.EditDetails]
|
|
@@ -2540,6 +2637,7 @@ export declare enum Action {
|
|
|
2540
2637
|
EditDetails = "editDetails",
|
|
2541
2638
|
/**
|
|
2542
2639
|
* The Create alert action on KPI charts.
|
|
2640
|
+
*
|
|
2543
2641
|
* @example
|
|
2544
2642
|
* ```js
|
|
2545
2643
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -2558,6 +2656,7 @@ export declare enum Action {
|
|
|
2558
2656
|
/**
|
|
2559
2657
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
2560
2658
|
* Allows sending data to a Google Sheet.
|
|
2659
|
+
*
|
|
2561
2660
|
* @example
|
|
2562
2661
|
* ```js
|
|
2563
2662
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -2569,6 +2668,7 @@ export declare enum Action {
|
|
|
2569
2668
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
2570
2669
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
2571
2670
|
* Microsoft Teams, and so on.
|
|
2671
|
+
*
|
|
2572
2672
|
* @example
|
|
2573
2673
|
* ```js
|
|
2574
2674
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -2579,6 +2679,7 @@ export declare enum Action {
|
|
|
2579
2679
|
/**
|
|
2580
2680
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
2581
2681
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
2682
|
+
*
|
|
2582
2683
|
* @example
|
|
2583
2684
|
* ```js
|
|
2584
2685
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -2589,6 +2690,7 @@ export declare enum Action {
|
|
|
2589
2690
|
/**
|
|
2590
2691
|
* The **Filter** action on Liveboard visualizations.
|
|
2591
2692
|
* Allows users to apply cross-filters on a Liveboard.
|
|
2693
|
+
*
|
|
2592
2694
|
* @example
|
|
2593
2695
|
* ```js
|
|
2594
2696
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -2600,6 +2702,7 @@ export declare enum Action {
|
|
|
2600
2702
|
* The **Remove** action that appears when cross filters are applied
|
|
2601
2703
|
* on a Liveboard.
|
|
2602
2704
|
* Removes filters applied o a visualization.
|
|
2705
|
+
*
|
|
2603
2706
|
* @example
|
|
2604
2707
|
* ```js
|
|
2605
2708
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -2611,6 +2714,7 @@ export declare enum Action {
|
|
|
2611
2714
|
* The **Aggregate** option in the chart axis or the
|
|
2612
2715
|
* table column customization menu.
|
|
2613
2716
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
2717
|
+
*
|
|
2614
2718
|
* @example
|
|
2615
2719
|
* ```js
|
|
2616
2720
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -2622,6 +2726,7 @@ export declare enum Action {
|
|
|
2622
2726
|
* The **Time bucket** option in the chart axis or table column
|
|
2623
2727
|
* customization menu.
|
|
2624
2728
|
* Allows defining time metric for date comparison.
|
|
2729
|
+
*
|
|
2625
2730
|
* @example
|
|
2626
2731
|
* ```js
|
|
2627
2732
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -2632,6 +2737,7 @@ export declare enum Action {
|
|
|
2632
2737
|
/**
|
|
2633
2738
|
* The **Filter** action in the chart axis or table column
|
|
2634
2739
|
* customization menu.
|
|
2740
|
+
*
|
|
2635
2741
|
* @example
|
|
2636
2742
|
* ```js
|
|
2637
2743
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -2643,6 +2749,7 @@ export declare enum Action {
|
|
|
2643
2749
|
* The **Conditional formatting** action on chart or table.
|
|
2644
2750
|
* Allows adding rules for conditional formatting of data
|
|
2645
2751
|
* points on a chart or table.
|
|
2752
|
+
*
|
|
2646
2753
|
* @example
|
|
2647
2754
|
* ```js
|
|
2648
2755
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -2654,6 +2761,7 @@ export declare enum Action {
|
|
|
2654
2761
|
* The **Sort** menu action on a table or chart axis
|
|
2655
2762
|
* Sorts data in ascending or descending order.
|
|
2656
2763
|
* Allows adding, editing, or removing filters.
|
|
2764
|
+
*
|
|
2657
2765
|
* @example
|
|
2658
2766
|
* ```js
|
|
2659
2767
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -2666,6 +2774,7 @@ export declare enum Action {
|
|
|
2666
2774
|
* customization menu.
|
|
2667
2775
|
* Allows grouping data points if the axes use the same
|
|
2668
2776
|
* unit of measurement and a similar scale.
|
|
2777
|
+
*
|
|
2669
2778
|
* @example
|
|
2670
2779
|
* ```js
|
|
2671
2780
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -2677,6 +2786,7 @@ export declare enum Action {
|
|
|
2677
2786
|
* The **Position** option in the axis customization menu.
|
|
2678
2787
|
* Allows changing the position of the axis to the
|
|
2679
2788
|
* left or right side of the chart.
|
|
2789
|
+
*
|
|
2680
2790
|
* @example
|
|
2681
2791
|
* ```js
|
|
2682
2792
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -2687,6 +2797,7 @@ export declare enum Action {
|
|
|
2687
2797
|
/**
|
|
2688
2798
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
2689
2799
|
* Renames the axis label on a chart or the column header on a table.
|
|
2800
|
+
*
|
|
2690
2801
|
* @example
|
|
2691
2802
|
* ```js
|
|
2692
2803
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -2698,6 +2809,7 @@ export declare enum Action {
|
|
|
2698
2809
|
* The **Edit** action in the axis customization menu.
|
|
2699
2810
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
2700
2811
|
* and format of a column.
|
|
2812
|
+
*
|
|
2701
2813
|
* @example
|
|
2702
2814
|
* ```js
|
|
2703
2815
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -2708,6 +2820,7 @@ export declare enum Action {
|
|
|
2708
2820
|
/**
|
|
2709
2821
|
* The **Number format** action to customize the format of
|
|
2710
2822
|
* the data labels on a chart or table.
|
|
2823
|
+
*
|
|
2711
2824
|
* @example
|
|
2712
2825
|
* ```js
|
|
2713
2826
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -2718,6 +2831,7 @@ export declare enum Action {
|
|
|
2718
2831
|
/**
|
|
2719
2832
|
* The **Text wrapping** action on a table.
|
|
2720
2833
|
* Wraps or clips column text on a table.
|
|
2834
|
+
*
|
|
2721
2835
|
* @example
|
|
2722
2836
|
* ```js
|
|
2723
2837
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -2730,6 +2844,7 @@ export declare enum Action {
|
|
|
2730
2844
|
* customization menu.
|
|
2731
2845
|
* Removes the data labels from a chart or the column of a
|
|
2732
2846
|
* table visualization.
|
|
2847
|
+
*
|
|
2733
2848
|
* @example
|
|
2734
2849
|
* ```js
|
|
2735
2850
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -2744,6 +2859,7 @@ export declare enum Action {
|
|
|
2744
2859
|
/**
|
|
2745
2860
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
2746
2861
|
* Allows renaming a Liveboard or visualization.
|
|
2862
|
+
*
|
|
2747
2863
|
* @example
|
|
2748
2864
|
* ```js
|
|
2749
2865
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -2760,13 +2876,29 @@ export declare enum Action {
|
|
|
2760
2876
|
*/
|
|
2761
2877
|
MarkAsVerified = "markAsVerified",
|
|
2762
2878
|
/**
|
|
2763
|
-
* @version SDK: 1.
|
|
2879
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2764
2880
|
*/
|
|
2765
2881
|
AddTab = "addTab",
|
|
2766
2882
|
/**
|
|
2767
2883
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2768
2884
|
*/
|
|
2769
|
-
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
|
|
2885
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
2886
|
+
/**
|
|
2887
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2888
|
+
*/
|
|
2889
|
+
ShowSageQuery = "showSageQuery",
|
|
2890
|
+
/**
|
|
2891
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2892
|
+
*/
|
|
2893
|
+
EditSageAnswer = "editSageAnswer",
|
|
2894
|
+
/**
|
|
2895
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2896
|
+
*/
|
|
2897
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
2898
|
+
/**
|
|
2899
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2900
|
+
*/
|
|
2901
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
2770
2902
|
}
|
|
2771
2903
|
export interface SessionInterface {
|
|
2772
2904
|
sessionId: string;
|