@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/src/types.ts
CHANGED
|
@@ -260,6 +260,9 @@ export interface CustomStyles {
|
|
|
260
260
|
export interface CustomisationsInterface {
|
|
261
261
|
style?: CustomStyles;
|
|
262
262
|
content?: {
|
|
263
|
+
/**
|
|
264
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
265
|
+
*/
|
|
263
266
|
strings?: Record<string, any>;
|
|
264
267
|
[key: string]: any;
|
|
265
268
|
};
|
|
@@ -686,21 +689,21 @@ export interface ViewConfig {
|
|
|
686
689
|
/**
|
|
687
690
|
* Boolean to hide liveboard header
|
|
688
691
|
*
|
|
689
|
-
* @version SDK: 1.
|
|
692
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
690
693
|
* @default false
|
|
691
694
|
*/
|
|
692
695
|
hideLiveboardHeader?: boolean;
|
|
693
696
|
/**
|
|
694
697
|
* Boolean to show liveboard title
|
|
695
698
|
*
|
|
696
|
-
* @version SDK: 1.
|
|
699
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
697
700
|
* @default false
|
|
698
701
|
*/
|
|
699
702
|
showLiveboardTitle?: boolean;
|
|
700
703
|
/**
|
|
701
704
|
* Boolean to show liveboard description
|
|
702
705
|
*
|
|
703
|
-
* @version SDK: 1.
|
|
706
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
704
707
|
* @default false
|
|
705
708
|
*/
|
|
706
709
|
showLiveboardDescription?: boolean;
|
|
@@ -718,7 +721,7 @@ export interface ViewConfig {
|
|
|
718
721
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
719
722
|
* });
|
|
720
723
|
* ```
|
|
721
|
-
* @version SDK: 1.
|
|
724
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
722
725
|
*/
|
|
723
726
|
hiddenTabs?: string[];
|
|
724
727
|
/**
|
|
@@ -737,7 +740,7 @@ export interface ViewConfig {
|
|
|
737
740
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
738
741
|
* });
|
|
739
742
|
* ```
|
|
740
|
-
* @version SDK: 1.
|
|
743
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
741
744
|
*/
|
|
742
745
|
visibleTabs?: string[];
|
|
743
746
|
}
|
|
@@ -1315,6 +1318,18 @@ export enum EmbedEvent {
|
|
|
1315
1318
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1316
1319
|
*/
|
|
1317
1320
|
FilterChanged = 'filterChanged',
|
|
1321
|
+
/**
|
|
1322
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
1323
|
+
*
|
|
1324
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
1325
|
+
*/
|
|
1326
|
+
SageEmbedQuery = 'sageEmbedQuery',
|
|
1327
|
+
/**
|
|
1328
|
+
* Emitten when a user select data source in Sage Embed
|
|
1329
|
+
*
|
|
1330
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
1331
|
+
*/
|
|
1332
|
+
SageWorksheetUpdated = 'sageWorksheetUpdated',
|
|
1318
1333
|
}
|
|
1319
1334
|
|
|
1320
1335
|
/**
|
|
@@ -1345,6 +1360,7 @@ export enum HostEvent {
|
|
|
1345
1360
|
* Triggers a search query in AppEmbed and SearchEmbed
|
|
1346
1361
|
* deployments.
|
|
1347
1362
|
* Includes the following properties:
|
|
1363
|
+
*
|
|
1348
1364
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
1349
1365
|
* - Although an array, only a single source
|
|
1350
1366
|
* is supported.
|
|
@@ -1363,6 +1379,7 @@ export enum HostEvent {
|
|
|
1363
1379
|
/**
|
|
1364
1380
|
* Triggers a drill on certain points of the specified column
|
|
1365
1381
|
* Includes the following properties:
|
|
1382
|
+
*
|
|
1366
1383
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
1367
1384
|
* to drill to. For example, { selectedPoints: []}
|
|
1368
1385
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -1427,18 +1444,19 @@ export enum HostEvent {
|
|
|
1427
1444
|
*/
|
|
1428
1445
|
SetActiveTab = 'SetActiveTab',
|
|
1429
1446
|
/**
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1447
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
1448
|
+
* runtime filters passed here are appended to the existing runtime
|
|
1449
|
+
* filters.
|
|
1450
|
+
* Pass an array of runtime filters with the following attributes:
|
|
1451
|
+
* `columnName`
|
|
1452
|
+
* _String_. The name of the column to filter on.
|
|
1453
|
+
* `operator`
|
|
1454
|
+
* Runtime filter operator to apply. For information,
|
|
1455
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
1456
|
+
* `values`
|
|
1457
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
1458
|
+
* operators such as BW and IN accept multiple operands.
|
|
1459
|
+
*
|
|
1442
1460
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
1443
1461
|
* @example
|
|
1444
1462
|
* ```js
|
|
@@ -1454,6 +1472,7 @@ export enum HostEvent {
|
|
|
1454
1472
|
/**
|
|
1455
1473
|
* Navigate to a specific page in the embedded application without reloading the page.
|
|
1456
1474
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
1475
|
+
*
|
|
1457
1476
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
1458
1477
|
* @example
|
|
1459
1478
|
* ```js
|
|
@@ -1777,6 +1796,7 @@ export enum HostEvent {
|
|
|
1777
1796
|
/**
|
|
1778
1797
|
* Triggers the **SpotIQ analyze** action on visualization
|
|
1779
1798
|
* or search.
|
|
1799
|
+
*
|
|
1780
1800
|
* @param - Liveboard embed takes `vizId` as a
|
|
1781
1801
|
* key. Can be left undefined when embedding Search or
|
|
1782
1802
|
* visualization.
|
|
@@ -1816,6 +1836,7 @@ export enum HostEvent {
|
|
|
1816
1836
|
/**
|
|
1817
1837
|
* Triggers the **Download** > **PNG** action on
|
|
1818
1838
|
* charts in the embedded view.
|
|
1839
|
+
*
|
|
1819
1840
|
* @example
|
|
1820
1841
|
* ```js
|
|
1821
1842
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -1849,6 +1870,7 @@ export enum HostEvent {
|
|
|
1849
1870
|
/**
|
|
1850
1871
|
* Triggers the **Download** > **XLSX** action on tables
|
|
1851
1872
|
* in the embedded view.
|
|
1873
|
+
*
|
|
1852
1874
|
* @example
|
|
1853
1875
|
* ```js
|
|
1854
1876
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -1880,6 +1902,7 @@ export enum HostEvent {
|
|
|
1880
1902
|
/**
|
|
1881
1903
|
* Triggers the **Save** action on a Liveboard or Answer.
|
|
1882
1904
|
* Saves the changes.
|
|
1905
|
+
*
|
|
1883
1906
|
* @example
|
|
1884
1907
|
* ```js
|
|
1885
1908
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -1893,6 +1916,7 @@ export enum HostEvent {
|
|
|
1893
1916
|
/**
|
|
1894
1917
|
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
1895
1918
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
1919
|
+
*
|
|
1896
1920
|
* @param - an object with `vizId` as a key
|
|
1897
1921
|
* @example
|
|
1898
1922
|
* ```js
|
|
@@ -1909,6 +1933,7 @@ export enum HostEvent {
|
|
|
1909
1933
|
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
1910
1934
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
1911
1935
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
1936
|
+
*
|
|
1912
1937
|
* @param - an object with vizId as a key
|
|
1913
1938
|
* @example
|
|
1914
1939
|
* ```js
|
|
@@ -1925,6 +1950,7 @@ export enum HostEvent {
|
|
|
1925
1950
|
* Triggers the **Manage pipelines** action on an embedded
|
|
1926
1951
|
* visualization or Answer.
|
|
1927
1952
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
1953
|
+
*
|
|
1928
1954
|
* @param - an object with `vizId` as a key
|
|
1929
1955
|
* @example
|
|
1930
1956
|
* ```js
|
|
@@ -1969,7 +1995,7 @@ export enum HostEvent {
|
|
|
1969
1995
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1970
1996
|
*/
|
|
1971
1997
|
UpdateFilters = 'updateFilters',
|
|
1972
|
-
|
|
1998
|
+
/**
|
|
1973
1999
|
* Get Tab for the current Liveboard.
|
|
1974
2000
|
*
|
|
1975
2001
|
* @example
|
|
@@ -1980,7 +2006,7 @@ export enum HostEvent {
|
|
|
1980
2006
|
* );
|
|
1981
2007
|
* })
|
|
1982
2008
|
* ```
|
|
1983
|
-
* @version SDK: 1.
|
|
2009
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1984
2010
|
*/
|
|
1985
2011
|
GetTabs = 'getTabs',
|
|
1986
2012
|
/**
|
|
@@ -1994,7 +2020,7 @@ export enum HostEvent {
|
|
|
1994
2020
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1995
2021
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
1996
2022
|
* ```
|
|
1997
|
-
* @version SDK: 1.
|
|
2023
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1998
2024
|
*/
|
|
1999
2025
|
SetVisibleTabs = 'SetPinboardVisibleTabs',
|
|
2000
2026
|
/**
|
|
@@ -2008,9 +2034,23 @@ export enum HostEvent {
|
|
|
2008
2034
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
2009
2035
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
2010
2036
|
* ```
|
|
2011
|
-
* @version SDK: 1.
|
|
2037
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2012
2038
|
*/
|
|
2013
2039
|
SetHiddenTabs = 'SetPinboardHiddenTabs',
|
|
2040
|
+
/**
|
|
2041
|
+
* Updates the search query for sage embed.
|
|
2042
|
+
*
|
|
2043
|
+
* @param - searchOptions: an object queryString and option to execute the query.
|
|
2044
|
+
* @example
|
|
2045
|
+
* ```js
|
|
2046
|
+
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
2047
|
+
* queryString: 'revenue per year',
|
|
2048
|
+
* executeSearch: true,
|
|
2049
|
+
* })
|
|
2050
|
+
* ```
|
|
2051
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2052
|
+
*/
|
|
2053
|
+
UpdateSageQuery = 'updateSageQuery',
|
|
2014
2054
|
}
|
|
2015
2055
|
|
|
2016
2056
|
/**
|
|
@@ -2069,6 +2109,7 @@ export enum Param {
|
|
|
2069
2109
|
DisableLoginRedirect = 'disableLoginRedirect',
|
|
2070
2110
|
visibleVizs = 'pinboardVisibleVizs',
|
|
2071
2111
|
LiveboardV2Enabled = 'isPinboardV2Enabled',
|
|
2112
|
+
DataPanelV2Enabled ='enableDataPanelV2',
|
|
2072
2113
|
ShowAlerts = 'showAlerts',
|
|
2073
2114
|
Locale = 'locale',
|
|
2074
2115
|
CustomStyle = 'customStyle',
|
|
@@ -2095,7 +2136,10 @@ export enum Param {
|
|
|
2095
2136
|
ShowLiveboardTitle = 'showLiveboardTitle',
|
|
2096
2137
|
HiddenTabs = 'hideTabs',
|
|
2097
2138
|
VisibleTabs = 'visibleTabs',
|
|
2098
|
-
HideTabPanel = 'hideTabPanel'
|
|
2139
|
+
HideTabPanel = 'hideTabPanel',
|
|
2140
|
+
HideSampleQuestions = 'hideSampleQuestions',
|
|
2141
|
+
WorksheetId = 'worksheet',
|
|
2142
|
+
Query = 'query'
|
|
2099
2143
|
}
|
|
2100
2144
|
|
|
2101
2145
|
/**
|
|
@@ -2105,6 +2149,7 @@ export enum Param {
|
|
|
2105
2149
|
* specific actions in the embedded view, define the Action
|
|
2106
2150
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
2107
2151
|
* or `hiddenActions` array.
|
|
2152
|
+
*
|
|
2108
2153
|
* @example
|
|
2109
2154
|
* ```js
|
|
2110
2155
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2123,13 +2168,13 @@ export enum Param {
|
|
|
2123
2168
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
2124
2169
|
* })
|
|
2125
2170
|
* ```
|
|
2126
|
-
|
|
2127
2171
|
*/
|
|
2128
2172
|
// eslint-disable-next-line no-shadow
|
|
2129
2173
|
export enum Action {
|
|
2130
2174
|
/**
|
|
2131
2175
|
* The **Save** action on an Answer or Liveboard.
|
|
2132
2176
|
* Allows users to save the changes.
|
|
2177
|
+
*
|
|
2133
2178
|
* @example
|
|
2134
2179
|
* ```js
|
|
2135
2180
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -2145,136 +2190,146 @@ export enum Action {
|
|
|
2145
2190
|
*/
|
|
2146
2191
|
SaveUntitled = 'saveUntitled',
|
|
2147
2192
|
/**
|
|
2148
|
-
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
|
|
2193
|
+
* The **Save as View** action on the Answer
|
|
2194
|
+
* page. Saves an Answer as a View object.
|
|
2195
|
+
*
|
|
2196
|
+
* @example
|
|
2197
|
+
* ```js
|
|
2198
|
+
* disabledActions: [Action.SaveAsView]
|
|
2199
|
+
* ```
|
|
2200
|
+
*/
|
|
2156
2201
|
SaveAsView = 'saveAsView',
|
|
2157
2202
|
/**
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2203
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
2204
|
+
* page.
|
|
2205
|
+
* Creates a copy of the Liveboard, visualization,
|
|
2206
|
+
* or Answer.
|
|
2207
|
+
*
|
|
2208
|
+
* @example
|
|
2209
|
+
* ```js
|
|
2210
|
+
* disabledActions: [Action.MakeACopy]
|
|
2211
|
+
* ```
|
|
2212
|
+
*/
|
|
2168
2213
|
MakeACopy = 'makeACopy',
|
|
2169
2214
|
/**
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
|
|
2215
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
2216
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
2217
|
+
*
|
|
2218
|
+
* @example
|
|
2219
|
+
* ```js
|
|
2220
|
+
* disabledActions: [Action.EditACopy]
|
|
2221
|
+
* ```
|
|
2222
|
+
*/
|
|
2178
2223
|
EditACopy = 'editACopy',
|
|
2179
2224
|
/**
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2225
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
2226
|
+
* Copies the visualization URL
|
|
2227
|
+
*
|
|
2228
|
+
* @example
|
|
2229
|
+
* ```js
|
|
2230
|
+
* disabledActions: [Action.CopyLink]
|
|
2231
|
+
* ```
|
|
2232
|
+
*/
|
|
2187
2233
|
CopyLink = 'embedDocument',
|
|
2188
2234
|
/**
|
|
2189
2235
|
* @hidden
|
|
2190
2236
|
*/
|
|
2191
2237
|
ResetLayout = 'resetLayout',
|
|
2192
2238
|
/**
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
|
|
2239
|
+
* The **Schedule** menu action on a Liveboard.
|
|
2240
|
+
* Allows scheduling a Liveboard notification.
|
|
2241
|
+
*
|
|
2242
|
+
* @example
|
|
2243
|
+
* ```js
|
|
2244
|
+
* disabledActions: [Action.Schedule]
|
|
2245
|
+
* ```
|
|
2246
|
+
*/
|
|
2200
2247
|
Schedule = 'subscription',
|
|
2201
2248
|
/**
|
|
2202
|
-
|
|
2203
|
-
|
|
2204
|
-
|
|
2205
|
-
|
|
2206
|
-
|
|
2207
|
-
|
|
2208
|
-
|
|
2249
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
2250
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
2251
|
+
*
|
|
2252
|
+
* @example
|
|
2253
|
+
* ```js
|
|
2254
|
+
* disabledActions: [Action.SchedulesList]
|
|
2255
|
+
* ```
|
|
2256
|
+
*/
|
|
2209
2257
|
SchedulesList = 'schedule-list',
|
|
2210
2258
|
/**
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
|
|
2259
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
2260
|
+
* Allows users to share an object with other users and groups.
|
|
2261
|
+
*
|
|
2262
|
+
* @example
|
|
2263
|
+
* ```js
|
|
2264
|
+
* disabledActions: [Action.Share]
|
|
2265
|
+
* ```
|
|
2266
|
+
*/
|
|
2218
2267
|
Share = 'share',
|
|
2219
2268
|
/**
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
|
-
|
|
2269
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
2270
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
2271
|
+
*
|
|
2272
|
+
* @example
|
|
2273
|
+
* ```js
|
|
2274
|
+
* disabledActions: [Action.AddFilter]
|
|
2275
|
+
* ```
|
|
2276
|
+
*/
|
|
2227
2277
|
AddFilter = 'addFilter',
|
|
2228
2278
|
/**
|
|
2229
|
-
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
|
|
2279
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
2280
|
+
* Allows configuring filter options when adding filters to a
|
|
2281
|
+
* Liveboard or Answer.
|
|
2282
|
+
*
|
|
2283
|
+
* @example
|
|
2284
|
+
* ```js
|
|
2285
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
2286
|
+
* ```
|
|
2287
|
+
*/
|
|
2237
2288
|
ConfigureFilter = 'configureFilter',
|
|
2238
2289
|
CollapseDataSources = 'collapseDataSources',
|
|
2239
2290
|
/**
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
|
-
|
|
2246
|
-
|
|
2291
|
+
* The **Choose sources** button on Search page.
|
|
2292
|
+
* Allows selecting data sources for search queries.
|
|
2293
|
+
*
|
|
2294
|
+
* @example
|
|
2295
|
+
* ```js
|
|
2296
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
2297
|
+
* ```
|
|
2298
|
+
*/
|
|
2247
2299
|
ChooseDataSources = 'chooseDataSources',
|
|
2248
2300
|
/**
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2301
|
+
* The **Create formula** action on a Search or Answer page.
|
|
2302
|
+
* Allows adding formulas to an Answer.
|
|
2303
|
+
*
|
|
2304
|
+
* @example
|
|
2305
|
+
* ```js
|
|
2306
|
+
* disabledActions: [Action.AddFormula]
|
|
2307
|
+
* ```
|
|
2308
|
+
*/
|
|
2256
2309
|
AddFormula = 'addFormula',
|
|
2257
2310
|
/**
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2311
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
2312
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
2313
|
+
*
|
|
2314
|
+
* @example
|
|
2315
|
+
* ```js
|
|
2316
|
+
* disabledActions: [Action.AddParameter]
|
|
2317
|
+
* ```
|
|
2318
|
+
*/
|
|
2265
2319
|
AddParameter = 'addParameter',
|
|
2266
2320
|
/**
|
|
2267
2321
|
* @hidden
|
|
2268
2322
|
*/
|
|
2269
2323
|
SearchOnTop = 'searchOnTop',
|
|
2270
2324
|
/**
|
|
2271
|
-
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
|
|
2325
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
2326
|
+
* Answer page.
|
|
2327
|
+
*
|
|
2328
|
+
* @example
|
|
2329
|
+
* ```js
|
|
2330
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
2331
|
+
* ```
|
|
2332
|
+
*/
|
|
2278
2333
|
SpotIQAnalyze = 'spotIQAnalyze',
|
|
2279
2334
|
/**
|
|
2280
2335
|
* @hidden
|
|
@@ -2290,89 +2345,98 @@ export enum Action {
|
|
|
2290
2345
|
*/
|
|
2291
2346
|
ReplaySearch = 'replaySearch',
|
|
2292
2347
|
/**
|
|
2293
|
-
|
|
2294
|
-
|
|
2295
|
-
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
|
|
2348
|
+
* The **Show underlying data** menu action on a visualization or
|
|
2349
|
+
* Answer page.
|
|
2350
|
+
*
|
|
2351
|
+
* @example
|
|
2352
|
+
* ```js
|
|
2353
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
2354
|
+
* ```
|
|
2355
|
+
*/
|
|
2300
2356
|
ShowUnderlyingData = 'showUnderlyingData',
|
|
2301
2357
|
/**
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
|
|
2309
|
-
|
|
2358
|
+
* The **Download** menu action on Liveboard visualizations
|
|
2359
|
+
* and Answers.
|
|
2360
|
+
* Allows downloading a visualization or Answer.
|
|
2361
|
+
*
|
|
2362
|
+
* @example
|
|
2363
|
+
* ```js
|
|
2364
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
2365
|
+
* ```
|
|
2366
|
+
*/
|
|
2310
2367
|
Download = 'download',
|
|
2311
2368
|
/**
|
|
2312
|
-
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
|
|
2319
|
-
|
|
2369
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
2370
|
+
* or Answer page.
|
|
2371
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
2372
|
+
*
|
|
2373
|
+
* @example
|
|
2374
|
+
* ```js
|
|
2375
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
2376
|
+
* ```
|
|
2377
|
+
*/
|
|
2320
2378
|
DownloadAsPng = 'downloadAsPng',
|
|
2321
2379
|
/**
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2380
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
2381
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
2382
|
+
*
|
|
2383
|
+
* @example
|
|
2384
|
+
* ```js
|
|
2385
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
2386
|
+
* ```
|
|
2387
|
+
*/
|
|
2329
2388
|
DownloadAsPdf = 'downloadAsPdf',
|
|
2330
2389
|
/**
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
|
-
|
|
2390
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
2391
|
+
* or Answer page.
|
|
2392
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
2393
|
+
*
|
|
2394
|
+
* @example
|
|
2395
|
+
* ```js
|
|
2396
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
2397
|
+
* ```
|
|
2398
|
+
*/
|
|
2339
2399
|
DownloadAsCsv = 'downloadAsCSV',
|
|
2340
2400
|
/**
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2347
|
-
|
|
2348
|
-
|
|
2401
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
2402
|
+
* or Answer page.
|
|
2403
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
2404
|
+
*
|
|
2405
|
+
* @example
|
|
2406
|
+
* ```js
|
|
2407
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
2408
|
+
* ```
|
|
2409
|
+
*/
|
|
2349
2410
|
DownloadAsXlsx = 'downloadAsXLSX',
|
|
2350
2411
|
/**
|
|
2351
2412
|
* @hidden
|
|
2352
2413
|
*/
|
|
2353
2414
|
DownloadTrace = 'downloadTrace',
|
|
2354
2415
|
/**
|
|
2355
|
-
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
|
|
2416
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
2417
|
+
* Worksheets and Data Connections page.
|
|
2418
|
+
* Exports an object as a TML file.
|
|
2419
|
+
*
|
|
2420
|
+
* @example
|
|
2421
|
+
* ```js
|
|
2422
|
+
* disabledActions: [Action.ExportTML]
|
|
2423
|
+
* ```
|
|
2424
|
+
*/
|
|
2363
2425
|
ExportTML = 'exportTSL',
|
|
2364
2426
|
/**
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
|
|
2427
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
2428
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
2429
|
+
*
|
|
2430
|
+
* @example
|
|
2431
|
+
* ```js
|
|
2432
|
+
* disabledActions: [Action.ImportTML]
|
|
2433
|
+
* ```
|
|
2434
|
+
*/
|
|
2372
2435
|
ImportTML = 'importTSL',
|
|
2373
2436
|
/**
|
|
2374
2437
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
2375
2438
|
* Update TML representation of ThoughtSpot objects.
|
|
2439
|
+
*
|
|
2376
2440
|
* @example
|
|
2377
2441
|
* ```js
|
|
2378
2442
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -2382,6 +2446,7 @@ export enum Action {
|
|
|
2382
2446
|
/**
|
|
2383
2447
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
2384
2448
|
* Opens the TML editor.
|
|
2449
|
+
*
|
|
2385
2450
|
* @example
|
|
2386
2451
|
* ```js
|
|
2387
2452
|
* disabledActions: [Action.EditTML]
|
|
@@ -2389,50 +2454,55 @@ export enum Action {
|
|
|
2389
2454
|
*/
|
|
2390
2455
|
EditTML = 'editTSL',
|
|
2391
2456
|
/**
|
|
2392
|
-
|
|
2393
|
-
|
|
2394
|
-
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
|
|
2457
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
2458
|
+
* Allows presenting a Liveboard or visualization in
|
|
2459
|
+
* slideshow mode.
|
|
2460
|
+
*
|
|
2461
|
+
* @example
|
|
2462
|
+
* ```js
|
|
2463
|
+
* disabledActions: [Action.Present]
|
|
2464
|
+
* ```
|
|
2465
|
+
*/
|
|
2400
2466
|
Present = 'present',
|
|
2401
2467
|
/**
|
|
2402
|
-
|
|
2403
|
-
|
|
2404
|
-
|
|
2405
|
-
|
|
2406
|
-
|
|
2407
|
-
|
|
2408
|
-
|
|
2468
|
+
* The tile resize options in the visualization menu.
|
|
2469
|
+
* Allows switching between different preset layouts.
|
|
2470
|
+
*
|
|
2471
|
+
* @example
|
|
2472
|
+
* ```js
|
|
2473
|
+
* disabledActions: [Action.ToggleSize]
|
|
2474
|
+
* ```
|
|
2475
|
+
*/
|
|
2409
2476
|
ToggleSize = 'toggleSize',
|
|
2410
2477
|
/**
|
|
2411
|
-
|
|
2412
|
-
|
|
2413
|
-
|
|
2414
|
-
|
|
2415
|
-
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2478
|
+
* The *Edit* action on the Liveboard page and in the
|
|
2479
|
+
* visualization menu.
|
|
2480
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
2481
|
+
*
|
|
2482
|
+
* @example
|
|
2483
|
+
* ```js
|
|
2484
|
+
* disabledActions: [Action.Edit]
|
|
2485
|
+
* ```
|
|
2486
|
+
*/
|
|
2419
2487
|
Edit = 'edit',
|
|
2420
2488
|
/**
|
|
2421
|
-
|
|
2422
|
-
|
|
2423
|
-
|
|
2424
|
-
|
|
2425
|
-
|
|
2426
|
-
|
|
2489
|
+
* The text edit option for Liveboard and visualization titles.
|
|
2490
|
+
*
|
|
2491
|
+
* @example
|
|
2492
|
+
* ```js
|
|
2493
|
+
* disabledActions: [Action.EditTitle]
|
|
2494
|
+
* ```
|
|
2495
|
+
*/
|
|
2427
2496
|
EditTitle = 'editTitle',
|
|
2428
2497
|
/**
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
|
|
2432
|
-
|
|
2433
|
-
|
|
2434
|
-
|
|
2435
|
-
|
|
2498
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
2499
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
2500
|
+
*
|
|
2501
|
+
* @example
|
|
2502
|
+
* ```js
|
|
2503
|
+
* disabledActions: [Action.Remove]
|
|
2504
|
+
* ```
|
|
2505
|
+
*/
|
|
2436
2506
|
Remove = 'delete',
|
|
2437
2507
|
/**
|
|
2438
2508
|
* @hidden
|
|
@@ -2455,15 +2525,16 @@ export enum Action {
|
|
|
2455
2525
|
*/
|
|
2456
2526
|
PinboardInfo = 'pinboardInfo',
|
|
2457
2527
|
/**
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
|
|
2461
|
-
|
|
2462
|
-
|
|
2463
|
-
|
|
2464
|
-
|
|
2465
|
-
|
|
2466
|
-
|
|
2528
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
2529
|
+
* Displays details such as the name, description, and
|
|
2530
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
2531
|
+
* and update.
|
|
2532
|
+
*
|
|
2533
|
+
* @example
|
|
2534
|
+
* ```js
|
|
2535
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
2536
|
+
* ```
|
|
2537
|
+
*/
|
|
2467
2538
|
LiveboardInfo = 'pinboardInfo',
|
|
2468
2539
|
/**
|
|
2469
2540
|
* @hidden
|
|
@@ -2474,13 +2545,14 @@ export enum Action {
|
|
|
2474
2545
|
*/
|
|
2475
2546
|
DownloadEmbraceQueries = 'downloadEmbraceQueries',
|
|
2476
2547
|
/**
|
|
2477
|
-
|
|
2478
|
-
|
|
2479
|
-
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
|
|
2548
|
+
* The **Pin** menu action on an Answer or
|
|
2549
|
+
* Search results page.
|
|
2550
|
+
*
|
|
2551
|
+
* @example
|
|
2552
|
+
* ```js
|
|
2553
|
+
* disabledActions: [Action.Pin]
|
|
2554
|
+
* ```
|
|
2555
|
+
*/
|
|
2484
2556
|
Pin = 'pin',
|
|
2485
2557
|
/**
|
|
2486
2558
|
* @hidden
|
|
@@ -2488,6 +2560,7 @@ export enum Action {
|
|
|
2488
2560
|
AnalysisInfo = 'analysisInfo',
|
|
2489
2561
|
/**
|
|
2490
2562
|
* The **Schedule** menu action on a Liveboard.
|
|
2563
|
+
*
|
|
2491
2564
|
* @example
|
|
2492
2565
|
* ```js
|
|
2493
2566
|
* disabledActions: [Action.Subscription]
|
|
@@ -2495,26 +2568,29 @@ export enum Action {
|
|
|
2495
2568
|
*/
|
|
2496
2569
|
Subscription = 'subscription',
|
|
2497
2570
|
/**
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
2571
|
+
* The **Explore** action on Liveboard visualizations
|
|
2572
|
+
*
|
|
2573
|
+
* @example
|
|
2574
|
+
* ```js
|
|
2575
|
+
* disabledActions: [Action.Explore]
|
|
2576
|
+
* ```
|
|
2577
|
+
*/
|
|
2504
2578
|
Explore = 'explore',
|
|
2505
2579
|
/**
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
|
|
2580
|
+
* The action to include data points on a drilled-down Answer
|
|
2581
|
+
* or visualization
|
|
2582
|
+
*
|
|
2583
|
+
* @example
|
|
2584
|
+
* ```js
|
|
2585
|
+
* disabledActions: [Action.DrillInclude]
|
|
2586
|
+
* ```
|
|
2587
|
+
*/
|
|
2513
2588
|
|
|
2514
2589
|
DrillInclude = 'context-menu-item-include',
|
|
2515
2590
|
/**
|
|
2516
2591
|
* The action to exclude data points on a drilled-down Answer
|
|
2517
2592
|
* or visualization
|
|
2593
|
+
*
|
|
2518
2594
|
* @example
|
|
2519
2595
|
* ```js
|
|
2520
2596
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -2525,6 +2601,7 @@ export enum Action {
|
|
|
2525
2601
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
2526
2602
|
* or Liveboard.
|
|
2527
2603
|
* Copies the selected data point.
|
|
2604
|
+
*
|
|
2528
2605
|
* @example
|
|
2529
2606
|
* ```js
|
|
2530
2607
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -2542,6 +2619,7 @@ export enum Action {
|
|
|
2542
2619
|
* The **Drill down** menu action on Answers and Liveboard
|
|
2543
2620
|
* visualizations.
|
|
2544
2621
|
* Allows drilling down to a specific data point on a chart or table.
|
|
2622
|
+
*
|
|
2545
2623
|
* @example
|
|
2546
2624
|
* ```js
|
|
2547
2625
|
* disabledActions: [Action.DrillDown]
|
|
@@ -2551,6 +2629,7 @@ export enum Action {
|
|
|
2551
2629
|
/**
|
|
2552
2630
|
* The request access action on Liveboards.
|
|
2553
2631
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
2632
|
+
*
|
|
2554
2633
|
* @example
|
|
2555
2634
|
* ```js
|
|
2556
2635
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -2560,6 +2639,7 @@ export enum Action {
|
|
|
2560
2639
|
/**
|
|
2561
2640
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
2562
2641
|
* of the Answer page
|
|
2642
|
+
*
|
|
2563
2643
|
* @example
|
|
2564
2644
|
* ```js
|
|
2565
2645
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -2568,6 +2648,7 @@ export enum Action {
|
|
|
2568
2648
|
QueryDetailsButtons = 'QueryDetailsButtons',
|
|
2569
2649
|
/**
|
|
2570
2650
|
* The **Delete** action for Answers.
|
|
2651
|
+
*
|
|
2571
2652
|
* @example
|
|
2572
2653
|
* ```js
|
|
2573
2654
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -2577,6 +2658,7 @@ export enum Action {
|
|
|
2577
2658
|
AnswerDelete = 'onDeleteAnswer',
|
|
2578
2659
|
/**
|
|
2579
2660
|
* The Chart switcher icon on Answer and visualization pages.
|
|
2661
|
+
*
|
|
2580
2662
|
* @example
|
|
2581
2663
|
* ```js
|
|
2582
2664
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -2586,6 +2668,7 @@ export enum Action {
|
|
|
2586
2668
|
AnswerChartSwitcher = 'answerChartSwitcher',
|
|
2587
2669
|
/**
|
|
2588
2670
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
2671
|
+
*
|
|
2589
2672
|
* @example
|
|
2590
2673
|
* ```js
|
|
2591
2674
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -2595,6 +2678,7 @@ export enum Action {
|
|
|
2595
2678
|
AddToFavorites = 'addToFavorites',
|
|
2596
2679
|
/**
|
|
2597
2680
|
* The edit icon on Liveboards (Classic experience).
|
|
2681
|
+
*
|
|
2598
2682
|
* @example
|
|
2599
2683
|
* ```js
|
|
2600
2684
|
* disabledActions: [Action.EditDetails]
|
|
@@ -2604,6 +2688,7 @@ export enum Action {
|
|
|
2604
2688
|
EditDetails = 'editDetails',
|
|
2605
2689
|
/**
|
|
2606
2690
|
* The Create alert action on KPI charts.
|
|
2691
|
+
*
|
|
2607
2692
|
* @example
|
|
2608
2693
|
* ```js
|
|
2609
2694
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -2622,6 +2707,7 @@ export enum Action {
|
|
|
2622
2707
|
/**
|
|
2623
2708
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
2624
2709
|
* Allows sending data to a Google Sheet.
|
|
2710
|
+
*
|
|
2625
2711
|
* @example
|
|
2626
2712
|
* ```js
|
|
2627
2713
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -2633,6 +2719,7 @@ export enum Action {
|
|
|
2633
2719
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
2634
2720
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
2635
2721
|
* Microsoft Teams, and so on.
|
|
2722
|
+
*
|
|
2636
2723
|
* @example
|
|
2637
2724
|
* ```js
|
|
2638
2725
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -2643,6 +2730,7 @@ export enum Action {
|
|
|
2643
2730
|
/**
|
|
2644
2731
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
2645
2732
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
2733
|
+
*
|
|
2646
2734
|
* @example
|
|
2647
2735
|
* ```js
|
|
2648
2736
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -2653,6 +2741,7 @@ export enum Action {
|
|
|
2653
2741
|
/**
|
|
2654
2742
|
* The **Filter** action on Liveboard visualizations.
|
|
2655
2743
|
* Allows users to apply cross-filters on a Liveboard.
|
|
2744
|
+
*
|
|
2656
2745
|
* @example
|
|
2657
2746
|
* ```js
|
|
2658
2747
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -2664,6 +2753,7 @@ export enum Action {
|
|
|
2664
2753
|
* The **Remove** action that appears when cross filters are applied
|
|
2665
2754
|
* on a Liveboard.
|
|
2666
2755
|
* Removes filters applied o a visualization.
|
|
2756
|
+
*
|
|
2667
2757
|
* @example
|
|
2668
2758
|
* ```js
|
|
2669
2759
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -2675,6 +2765,7 @@ export enum Action {
|
|
|
2675
2765
|
* The **Aggregate** option in the chart axis or the
|
|
2676
2766
|
* table column customization menu.
|
|
2677
2767
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
2768
|
+
*
|
|
2678
2769
|
* @example
|
|
2679
2770
|
* ```js
|
|
2680
2771
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -2686,6 +2777,7 @@ export enum Action {
|
|
|
2686
2777
|
* The **Time bucket** option in the chart axis or table column
|
|
2687
2778
|
* customization menu.
|
|
2688
2779
|
* Allows defining time metric for date comparison.
|
|
2780
|
+
*
|
|
2689
2781
|
* @example
|
|
2690
2782
|
* ```js
|
|
2691
2783
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -2696,6 +2788,7 @@ export enum Action {
|
|
|
2696
2788
|
/**
|
|
2697
2789
|
* The **Filter** action in the chart axis or table column
|
|
2698
2790
|
* customization menu.
|
|
2791
|
+
*
|
|
2699
2792
|
* @example
|
|
2700
2793
|
* ```js
|
|
2701
2794
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -2707,6 +2800,7 @@ export enum Action {
|
|
|
2707
2800
|
* The **Conditional formatting** action on chart or table.
|
|
2708
2801
|
* Allows adding rules for conditional formatting of data
|
|
2709
2802
|
* points on a chart or table.
|
|
2803
|
+
*
|
|
2710
2804
|
* @example
|
|
2711
2805
|
* ```js
|
|
2712
2806
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -2718,6 +2812,7 @@ export enum Action {
|
|
|
2718
2812
|
* The **Sort** menu action on a table or chart axis
|
|
2719
2813
|
* Sorts data in ascending or descending order.
|
|
2720
2814
|
* Allows adding, editing, or removing filters.
|
|
2815
|
+
*
|
|
2721
2816
|
* @example
|
|
2722
2817
|
* ```js
|
|
2723
2818
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -2730,6 +2825,7 @@ export enum Action {
|
|
|
2730
2825
|
* customization menu.
|
|
2731
2826
|
* Allows grouping data points if the axes use the same
|
|
2732
2827
|
* unit of measurement and a similar scale.
|
|
2828
|
+
*
|
|
2733
2829
|
* @example
|
|
2734
2830
|
* ```js
|
|
2735
2831
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -2741,6 +2837,7 @@ export enum Action {
|
|
|
2741
2837
|
* The **Position** option in the axis customization menu.
|
|
2742
2838
|
* Allows changing the position of the axis to the
|
|
2743
2839
|
* left or right side of the chart.
|
|
2840
|
+
*
|
|
2744
2841
|
* @example
|
|
2745
2842
|
* ```js
|
|
2746
2843
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -2751,6 +2848,7 @@ export enum Action {
|
|
|
2751
2848
|
/**
|
|
2752
2849
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
2753
2850
|
* Renames the axis label on a chart or the column header on a table.
|
|
2851
|
+
*
|
|
2754
2852
|
* @example
|
|
2755
2853
|
* ```js
|
|
2756
2854
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -2762,6 +2860,7 @@ export enum Action {
|
|
|
2762
2860
|
* The **Edit** action in the axis customization menu.
|
|
2763
2861
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
2764
2862
|
* and format of a column.
|
|
2863
|
+
*
|
|
2765
2864
|
* @example
|
|
2766
2865
|
* ```js
|
|
2767
2866
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -2772,6 +2871,7 @@ export enum Action {
|
|
|
2772
2871
|
/**
|
|
2773
2872
|
* The **Number format** action to customize the format of
|
|
2774
2873
|
* the data labels on a chart or table.
|
|
2874
|
+
*
|
|
2775
2875
|
* @example
|
|
2776
2876
|
* ```js
|
|
2777
2877
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -2782,6 +2882,7 @@ export enum Action {
|
|
|
2782
2882
|
/**
|
|
2783
2883
|
* The **Text wrapping** action on a table.
|
|
2784
2884
|
* Wraps or clips column text on a table.
|
|
2885
|
+
*
|
|
2785
2886
|
* @example
|
|
2786
2887
|
* ```js
|
|
2787
2888
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -2794,6 +2895,7 @@ export enum Action {
|
|
|
2794
2895
|
* customization menu.
|
|
2795
2896
|
* Removes the data labels from a chart or the column of a
|
|
2796
2897
|
* table visualization.
|
|
2898
|
+
*
|
|
2797
2899
|
* @example
|
|
2798
2900
|
* ```js
|
|
2799
2901
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -2808,6 +2910,7 @@ export enum Action {
|
|
|
2808
2910
|
/**
|
|
2809
2911
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
2810
2912
|
* Allows renaming a Liveboard or visualization.
|
|
2913
|
+
*
|
|
2811
2914
|
* @example
|
|
2812
2915
|
* ```js
|
|
2813
2916
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -2824,13 +2927,29 @@ export enum Action {
|
|
|
2824
2927
|
*/
|
|
2825
2928
|
MarkAsVerified = 'markAsVerified',
|
|
2826
2929
|
/**
|
|
2827
|
-
* @version SDK: 1.
|
|
2930
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2828
2931
|
*/
|
|
2829
2932
|
AddTab = 'addTab',
|
|
2830
2933
|
/**
|
|
2831
2934
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2832
2935
|
*/
|
|
2833
2936
|
EnableContextualChangeAnalysis = 'enableContextualChangeAnalysis',
|
|
2937
|
+
/**
|
|
2938
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2939
|
+
*/
|
|
2940
|
+
ShowSageQuery = 'showSageQuery',
|
|
2941
|
+
/**
|
|
2942
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2943
|
+
*/
|
|
2944
|
+
EditSageAnswer = 'editSageAnswer',
|
|
2945
|
+
/**
|
|
2946
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2947
|
+
*/
|
|
2948
|
+
SageAnswerFeedback = 'sageAnswerFeedback',
|
|
2949
|
+
/**
|
|
2950
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2951
|
+
*/
|
|
2952
|
+
ModifySageAnswer = 'modifySageAnswer',
|
|
2834
2953
|
}
|
|
2835
2954
|
|
|
2836
2955
|
export interface SessionInterface {
|