@thoughtspot/visual-embed-sdk 1.23.0 → 1.23.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/embed/app.d.ts +1 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +8 -0
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +8 -0
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +14 -0
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +12 -3
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/sage.spec.js +1 -1
- package/cjs/src/embed/sage.spec.js.map +1 -1
- package/cjs/src/types.d.ts +364 -247
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +342 -241
- package/cjs/src/types.js.map +1 -1
- package/dist/src/embed/app.d.ts +1 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +8 -0
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +14 -0
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/types.d.ts +364 -247
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +356 -246
- package/dist/tsembed-react.js +355 -245
- package/dist/tsembed.es.js +364 -246
- package/dist/tsembed.js +363 -245
- package/dist/visual-embed-sdk-react-full.d.ts +387 -248
- package/dist/visual-embed-sdk-react.d.ts +387 -248
- package/dist/visual-embed-sdk.d.ts +387 -248
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +1 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +8 -0
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +8 -0
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/sage.d.ts +14 -0
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +12 -3
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/sage.spec.js +1 -1
- package/lib/src/embed/sage.spec.js.map +1 -1
- package/lib/src/types.d.ts +364 -247
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +342 -241
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +387 -248
- package/package.json +1 -1
- package/src/embed/app.ts +1 -1
- package/src/embed/base.ts +8 -0
- package/src/embed/sage.spec.ts +1 -1
- package/src/embed/sage.ts +24 -2
- package/src/types.ts +351 -247
|
@@ -56,7 +56,7 @@ export enum Page {
|
|
|
56
56
|
/**
|
|
57
57
|
* SpotIQ listing page
|
|
58
58
|
*/
|
|
59
|
-
SpotIQ = "
|
|
59
|
+
SpotIQ = "insights"
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
62
|
* The view configuration for full app embedding.
|
|
@@ -255,7 +255,15 @@ export const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
|
|
|
255
255
|
* @param fn The function being registered
|
|
256
256
|
*/
|
|
257
257
|
export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
258
|
+
/**
|
|
259
|
+
* @param data
|
|
260
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
261
|
+
*/
|
|
258
262
|
export const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
263
|
+
/**
|
|
264
|
+
* @param data
|
|
265
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
266
|
+
*/
|
|
259
267
|
export const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
260
268
|
/**
|
|
261
269
|
*
|
|
@@ -991,6 +999,9 @@ export interface CustomStyles {
|
|
|
991
999
|
export interface CustomisationsInterface {
|
|
992
1000
|
style?: CustomStyles;
|
|
993
1001
|
content?: {
|
|
1002
|
+
/**
|
|
1003
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
1004
|
+
*/
|
|
994
1005
|
strings?: Record<string, any>;
|
|
995
1006
|
[key: string]: any;
|
|
996
1007
|
};
|
|
@@ -1398,21 +1409,21 @@ export interface ViewConfig {
|
|
|
1398
1409
|
/**
|
|
1399
1410
|
* Boolean to hide liveboard header
|
|
1400
1411
|
*
|
|
1401
|
-
* @version SDK: 1.
|
|
1412
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1402
1413
|
* @default false
|
|
1403
1414
|
*/
|
|
1404
1415
|
hideLiveboardHeader?: boolean;
|
|
1405
1416
|
/**
|
|
1406
1417
|
* Boolean to show liveboard title
|
|
1407
1418
|
*
|
|
1408
|
-
* @version SDK: 1.
|
|
1419
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1409
1420
|
* @default false
|
|
1410
1421
|
*/
|
|
1411
1422
|
showLiveboardTitle?: boolean;
|
|
1412
1423
|
/**
|
|
1413
1424
|
* Boolean to show liveboard description
|
|
1414
1425
|
*
|
|
1415
|
-
* @version SDK: 1.
|
|
1426
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1416
1427
|
* @default false
|
|
1417
1428
|
*/
|
|
1418
1429
|
showLiveboardDescription?: boolean;
|
|
@@ -1430,7 +1441,7 @@ export interface ViewConfig {
|
|
|
1430
1441
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1431
1442
|
* });
|
|
1432
1443
|
* ```
|
|
1433
|
-
* @version SDK: 1.
|
|
1444
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1434
1445
|
*/
|
|
1435
1446
|
hiddenTabs?: string[];
|
|
1436
1447
|
/**
|
|
@@ -1449,7 +1460,7 @@ export interface ViewConfig {
|
|
|
1449
1460
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1450
1461
|
* });
|
|
1451
1462
|
* ```
|
|
1452
|
-
* @version SDK: 1.
|
|
1463
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1453
1464
|
*/
|
|
1454
1465
|
visibleTabs?: string[];
|
|
1455
1466
|
}
|
|
@@ -2011,7 +2022,19 @@ export enum EmbedEvent {
|
|
|
2011
2022
|
*
|
|
2012
2023
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2013
2024
|
*/
|
|
2014
|
-
FilterChanged = "filterChanged"
|
|
2025
|
+
FilterChanged = "filterChanged",
|
|
2026
|
+
/**
|
|
2027
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
2028
|
+
*
|
|
2029
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2030
|
+
*/
|
|
2031
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
2032
|
+
/**
|
|
2033
|
+
* Emitten when a user select data source in Sage Embed
|
|
2034
|
+
*
|
|
2035
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2036
|
+
*/
|
|
2037
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
2015
2038
|
}
|
|
2016
2039
|
/**
|
|
2017
2040
|
* Event types that can be triggered by the host application
|
|
@@ -2040,6 +2063,7 @@ export enum HostEvent {
|
|
|
2040
2063
|
* Triggers a search query in AppEmbed and SearchEmbed
|
|
2041
2064
|
* deployments.
|
|
2042
2065
|
* Includes the following properties:
|
|
2066
|
+
*
|
|
2043
2067
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
2044
2068
|
* - Although an array, only a single source
|
|
2045
2069
|
* is supported.
|
|
@@ -2058,6 +2082,7 @@ export enum HostEvent {
|
|
|
2058
2082
|
/**
|
|
2059
2083
|
* Triggers a drill on certain points of the specified column
|
|
2060
2084
|
* Includes the following properties:
|
|
2085
|
+
*
|
|
2061
2086
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2062
2087
|
* to drill to. For example, { selectedPoints: []}
|
|
2063
2088
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -2122,18 +2147,19 @@ export enum HostEvent {
|
|
|
2122
2147
|
*/
|
|
2123
2148
|
SetActiveTab = "SetActiveTab",
|
|
2124
2149
|
/**
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
|
|
2136
|
-
|
|
2150
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
2151
|
+
* runtime filters passed here are appended to the existing runtime
|
|
2152
|
+
* filters.
|
|
2153
|
+
* Pass an array of runtime filters with the following attributes:
|
|
2154
|
+
* `columnName`
|
|
2155
|
+
* _String_. The name of the column to filter on.
|
|
2156
|
+
* `operator`
|
|
2157
|
+
* Runtime filter operator to apply. For information,
|
|
2158
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
2159
|
+
* `values`
|
|
2160
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2161
|
+
* operators such as BW and IN accept multiple operands.
|
|
2162
|
+
*
|
|
2137
2163
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2138
2164
|
* @example
|
|
2139
2165
|
* ```js
|
|
@@ -2149,6 +2175,7 @@ export enum HostEvent {
|
|
|
2149
2175
|
/**
|
|
2150
2176
|
* Navigate to a specific page in the embedded application without reloading the page.
|
|
2151
2177
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2178
|
+
*
|
|
2152
2179
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
2153
2180
|
* @example
|
|
2154
2181
|
* ```js
|
|
@@ -2472,6 +2499,7 @@ export enum HostEvent {
|
|
|
2472
2499
|
/**
|
|
2473
2500
|
* Triggers the **SpotIQ analyze** action on visualization
|
|
2474
2501
|
* or search.
|
|
2502
|
+
*
|
|
2475
2503
|
* @param - Liveboard embed takes `vizId` as a
|
|
2476
2504
|
* key. Can be left undefined when embedding Search or
|
|
2477
2505
|
* visualization.
|
|
@@ -2511,6 +2539,7 @@ export enum HostEvent {
|
|
|
2511
2539
|
/**
|
|
2512
2540
|
* Triggers the **Download** > **PNG** action on
|
|
2513
2541
|
* charts in the embedded view.
|
|
2542
|
+
*
|
|
2514
2543
|
* @example
|
|
2515
2544
|
* ```js
|
|
2516
2545
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -2544,6 +2573,7 @@ export enum HostEvent {
|
|
|
2544
2573
|
/**
|
|
2545
2574
|
* Triggers the **Download** > **XLSX** action on tables
|
|
2546
2575
|
* in the embedded view.
|
|
2576
|
+
*
|
|
2547
2577
|
* @example
|
|
2548
2578
|
* ```js
|
|
2549
2579
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -2575,6 +2605,7 @@ export enum HostEvent {
|
|
|
2575
2605
|
/**
|
|
2576
2606
|
* Triggers the **Save** action on a Liveboard or Answer.
|
|
2577
2607
|
* Saves the changes.
|
|
2608
|
+
*
|
|
2578
2609
|
* @example
|
|
2579
2610
|
* ```js
|
|
2580
2611
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -2588,6 +2619,7 @@ export enum HostEvent {
|
|
|
2588
2619
|
/**
|
|
2589
2620
|
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
2590
2621
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
2622
|
+
*
|
|
2591
2623
|
* @param - an object with `vizId` as a key
|
|
2592
2624
|
* @example
|
|
2593
2625
|
* ```js
|
|
@@ -2604,6 +2636,7 @@ export enum HostEvent {
|
|
|
2604
2636
|
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
2605
2637
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
2606
2638
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
2639
|
+
*
|
|
2607
2640
|
* @param - an object with vizId as a key
|
|
2608
2641
|
* @example
|
|
2609
2642
|
* ```js
|
|
@@ -2620,6 +2653,7 @@ export enum HostEvent {
|
|
|
2620
2653
|
* Triggers the **Manage pipelines** action on an embedded
|
|
2621
2654
|
* visualization or Answer.
|
|
2622
2655
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
2656
|
+
*
|
|
2623
2657
|
* @param - an object with `vizId` as a key
|
|
2624
2658
|
* @example
|
|
2625
2659
|
* ```js
|
|
@@ -2664,6 +2698,19 @@ export enum HostEvent {
|
|
|
2664
2698
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2665
2699
|
*/
|
|
2666
2700
|
UpdateFilters = "updateFilters",
|
|
2701
|
+
/**
|
|
2702
|
+
* Get Tab for the current Liveboard.
|
|
2703
|
+
*
|
|
2704
|
+
* @example
|
|
2705
|
+
* ```js
|
|
2706
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
2707
|
+
* console.log(
|
|
2708
|
+
* tabDetails // TabDetails of current LB
|
|
2709
|
+
* );
|
|
2710
|
+
* })
|
|
2711
|
+
* ```
|
|
2712
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2713
|
+
*/
|
|
2667
2714
|
GetTabs = "getTabs",
|
|
2668
2715
|
/**
|
|
2669
2716
|
* Set the visible Tabs on a Liveboard.
|
|
@@ -2676,7 +2723,7 @@ export enum HostEvent {
|
|
|
2676
2723
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
2677
2724
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
2678
2725
|
* ```
|
|
2679
|
-
* @version SDK: 1.
|
|
2726
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2680
2727
|
*/
|
|
2681
2728
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
2682
2729
|
/**
|
|
@@ -2690,7 +2737,7 @@ export enum HostEvent {
|
|
|
2690
2737
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
2691
2738
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
2692
2739
|
* ```
|
|
2693
|
-
* @version SDK: 1.
|
|
2740
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2694
2741
|
*/
|
|
2695
2742
|
SetHiddenTabs = "SetPinboardHiddenTabs"
|
|
2696
2743
|
}
|
|
@@ -2772,7 +2819,10 @@ export enum Param {
|
|
|
2772
2819
|
ShowLiveboardTitle = "showLiveboardTitle",
|
|
2773
2820
|
HiddenTabs = "hideTabs",
|
|
2774
2821
|
VisibleTabs = "visibleTabs",
|
|
2775
|
-
HideTabPanel = "hideTabPanel"
|
|
2822
|
+
HideTabPanel = "hideTabPanel",
|
|
2823
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
2824
|
+
WorksheetId = "worksheetId",
|
|
2825
|
+
Query = "query,"
|
|
2776
2826
|
}
|
|
2777
2827
|
/**
|
|
2778
2828
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -2781,6 +2831,7 @@ export enum Param {
|
|
|
2781
2831
|
* specific actions in the embedded view, define the Action
|
|
2782
2832
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
2783
2833
|
* or `hiddenActions` array.
|
|
2834
|
+
*
|
|
2784
2835
|
* @example
|
|
2785
2836
|
* ```js
|
|
2786
2837
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2799,12 +2850,12 @@ export enum Param {
|
|
|
2799
2850
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
2800
2851
|
* })
|
|
2801
2852
|
* ```
|
|
2802
|
-
|
|
2803
2853
|
*/
|
|
2804
2854
|
export enum Action {
|
|
2805
2855
|
/**
|
|
2806
2856
|
* The **Save** action on an Answer or Liveboard.
|
|
2807
2857
|
* Allows users to save the changes.
|
|
2858
|
+
*
|
|
2808
2859
|
* @example
|
|
2809
2860
|
* ```js
|
|
2810
2861
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -2820,136 +2871,146 @@ export enum Action {
|
|
|
2820
2871
|
*/
|
|
2821
2872
|
SaveUntitled = "saveUntitled",
|
|
2822
2873
|
/**
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2874
|
+
* The **Save as View** action on the Answer
|
|
2875
|
+
* page. Saves an Answer as a View object.
|
|
2876
|
+
*
|
|
2877
|
+
* @example
|
|
2878
|
+
* ```js
|
|
2879
|
+
* disabledActions: [Action.SaveAsView]
|
|
2880
|
+
* ```
|
|
2881
|
+
*/
|
|
2831
2882
|
SaveAsView = "saveAsView",
|
|
2832
2883
|
/**
|
|
2833
|
-
|
|
2834
|
-
|
|
2835
|
-
|
|
2836
|
-
|
|
2837
|
-
|
|
2838
|
-
|
|
2839
|
-
|
|
2840
|
-
|
|
2841
|
-
|
|
2842
|
-
|
|
2884
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
2885
|
+
* page.
|
|
2886
|
+
* Creates a copy of the Liveboard, visualization,
|
|
2887
|
+
* or Answer.
|
|
2888
|
+
*
|
|
2889
|
+
* @example
|
|
2890
|
+
* ```js
|
|
2891
|
+
* disabledActions: [Action.MakeACopy]
|
|
2892
|
+
* ```
|
|
2893
|
+
*/
|
|
2843
2894
|
MakeACopy = "makeACopy",
|
|
2844
2895
|
/**
|
|
2845
|
-
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
|
|
2850
|
-
|
|
2851
|
-
|
|
2852
|
-
|
|
2896
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
2897
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
2898
|
+
*
|
|
2899
|
+
* @example
|
|
2900
|
+
* ```js
|
|
2901
|
+
* disabledActions: [Action.EditACopy]
|
|
2902
|
+
* ```
|
|
2903
|
+
*/
|
|
2853
2904
|
EditACopy = "editACopy",
|
|
2854
2905
|
/**
|
|
2855
|
-
|
|
2856
|
-
|
|
2857
|
-
|
|
2858
|
-
|
|
2859
|
-
|
|
2860
|
-
|
|
2861
|
-
|
|
2906
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
2907
|
+
* Copies the visualization URL
|
|
2908
|
+
*
|
|
2909
|
+
* @example
|
|
2910
|
+
* ```js
|
|
2911
|
+
* disabledActions: [Action.CopyLink]
|
|
2912
|
+
* ```
|
|
2913
|
+
*/
|
|
2862
2914
|
CopyLink = "embedDocument",
|
|
2863
2915
|
/**
|
|
2864
2916
|
* @hidden
|
|
2865
2917
|
*/
|
|
2866
2918
|
ResetLayout = "resetLayout",
|
|
2867
2919
|
/**
|
|
2868
|
-
|
|
2869
|
-
|
|
2870
|
-
|
|
2871
|
-
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
|
|
2920
|
+
* The **Schedule** menu action on a Liveboard.
|
|
2921
|
+
* Allows scheduling a Liveboard notification.
|
|
2922
|
+
*
|
|
2923
|
+
* @example
|
|
2924
|
+
* ```js
|
|
2925
|
+
* disabledActions: [Action.Schedule]
|
|
2926
|
+
* ```
|
|
2927
|
+
*/
|
|
2875
2928
|
Schedule = "subscription",
|
|
2876
2929
|
/**
|
|
2877
|
-
|
|
2878
|
-
|
|
2879
|
-
|
|
2880
|
-
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
|
|
2930
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
2931
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
2932
|
+
*
|
|
2933
|
+
* @example
|
|
2934
|
+
* ```js
|
|
2935
|
+
* disabledActions: [Action.SchedulesList]
|
|
2936
|
+
* ```
|
|
2937
|
+
*/
|
|
2884
2938
|
SchedulesList = "schedule-list",
|
|
2885
2939
|
/**
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
2889
|
-
|
|
2890
|
-
|
|
2891
|
-
|
|
2892
|
-
|
|
2940
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
2941
|
+
* Allows users to share an object with other users and groups.
|
|
2942
|
+
*
|
|
2943
|
+
* @example
|
|
2944
|
+
* ```js
|
|
2945
|
+
* disabledActions: [Action.Share]
|
|
2946
|
+
* ```
|
|
2947
|
+
*/
|
|
2893
2948
|
Share = "share",
|
|
2894
2949
|
/**
|
|
2895
|
-
|
|
2896
|
-
|
|
2897
|
-
|
|
2898
|
-
|
|
2899
|
-
|
|
2900
|
-
|
|
2901
|
-
|
|
2950
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
2951
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
2952
|
+
*
|
|
2953
|
+
* @example
|
|
2954
|
+
* ```js
|
|
2955
|
+
* disabledActions: [Action.AddFilter]
|
|
2956
|
+
* ```
|
|
2957
|
+
*/
|
|
2902
2958
|
AddFilter = "addFilter",
|
|
2903
2959
|
/**
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
|
|
2911
|
-
|
|
2960
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
2961
|
+
* Allows configuring filter options when adding filters to a
|
|
2962
|
+
* Liveboard or Answer.
|
|
2963
|
+
*
|
|
2964
|
+
* @example
|
|
2965
|
+
* ```js
|
|
2966
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
2967
|
+
* ```
|
|
2968
|
+
*/
|
|
2912
2969
|
ConfigureFilter = "configureFilter",
|
|
2913
2970
|
CollapseDataSources = "collapseDataSources",
|
|
2914
2971
|
/**
|
|
2915
|
-
|
|
2916
|
-
|
|
2917
|
-
|
|
2918
|
-
|
|
2919
|
-
|
|
2920
|
-
|
|
2921
|
-
|
|
2972
|
+
* The **Choose sources** button on Search page.
|
|
2973
|
+
* Allows selecting data sources for search queries.
|
|
2974
|
+
*
|
|
2975
|
+
* @example
|
|
2976
|
+
* ```js
|
|
2977
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
2978
|
+
* ```
|
|
2979
|
+
*/
|
|
2922
2980
|
ChooseDataSources = "chooseDataSources",
|
|
2923
2981
|
/**
|
|
2924
|
-
|
|
2925
|
-
|
|
2926
|
-
|
|
2927
|
-
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
|
|
2982
|
+
* The **Create formula** action on a Search or Answer page.
|
|
2983
|
+
* Allows adding formulas to an Answer.
|
|
2984
|
+
*
|
|
2985
|
+
* @example
|
|
2986
|
+
* ```js
|
|
2987
|
+
* disabledActions: [Action.AddFormula]
|
|
2988
|
+
* ```
|
|
2989
|
+
*/
|
|
2931
2990
|
AddFormula = "addFormula",
|
|
2932
2991
|
/**
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
|
|
2936
|
-
|
|
2937
|
-
|
|
2938
|
-
|
|
2939
|
-
|
|
2992
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
2993
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
2994
|
+
*
|
|
2995
|
+
* @example
|
|
2996
|
+
* ```js
|
|
2997
|
+
* disabledActions: [Action.AddParameter]
|
|
2998
|
+
* ```
|
|
2999
|
+
*/
|
|
2940
3000
|
AddParameter = "addParameter",
|
|
2941
3001
|
/**
|
|
2942
3002
|
* @hidden
|
|
2943
3003
|
*/
|
|
2944
3004
|
SearchOnTop = "searchOnTop",
|
|
2945
3005
|
/**
|
|
2946
|
-
|
|
2947
|
-
|
|
2948
|
-
|
|
2949
|
-
|
|
2950
|
-
|
|
2951
|
-
|
|
2952
|
-
|
|
3006
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
3007
|
+
* Answer page.
|
|
3008
|
+
*
|
|
3009
|
+
* @example
|
|
3010
|
+
* ```js
|
|
3011
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
3012
|
+
* ```
|
|
3013
|
+
*/
|
|
2953
3014
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2954
3015
|
/**
|
|
2955
3016
|
* @hidden
|
|
@@ -2965,89 +3026,98 @@ export enum Action {
|
|
|
2965
3026
|
*/
|
|
2966
3027
|
ReplaySearch = "replaySearch",
|
|
2967
3028
|
/**
|
|
2968
|
-
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
|
|
3029
|
+
* The **Show underlying data** menu action on a visualization or
|
|
3030
|
+
* Answer page.
|
|
3031
|
+
*
|
|
3032
|
+
* @example
|
|
3033
|
+
* ```js
|
|
3034
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
3035
|
+
* ```
|
|
3036
|
+
*/
|
|
2975
3037
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2976
3038
|
/**
|
|
2977
|
-
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
3039
|
+
* The **Download** menu action on Liveboard visualizations
|
|
3040
|
+
* and Answers.
|
|
3041
|
+
* Allows downloading a visualization or Answer.
|
|
3042
|
+
*
|
|
3043
|
+
* @example
|
|
3044
|
+
* ```js
|
|
3045
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3046
|
+
* ```
|
|
3047
|
+
*/
|
|
2985
3048
|
Download = "download",
|
|
2986
3049
|
/**
|
|
2987
|
-
|
|
2988
|
-
|
|
2989
|
-
|
|
2990
|
-
|
|
2991
|
-
|
|
2992
|
-
|
|
2993
|
-
|
|
2994
|
-
|
|
3050
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3051
|
+
* or Answer page.
|
|
3052
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
3053
|
+
*
|
|
3054
|
+
* @example
|
|
3055
|
+
* ```js
|
|
3056
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3057
|
+
* ```
|
|
3058
|
+
*/
|
|
2995
3059
|
DownloadAsPng = "downloadAsPng",
|
|
2996
3060
|
/**
|
|
2997
|
-
|
|
2998
|
-
|
|
2999
|
-
|
|
3000
|
-
|
|
3001
|
-
|
|
3002
|
-
|
|
3003
|
-
|
|
3061
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3062
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
3063
|
+
*
|
|
3064
|
+
* @example
|
|
3065
|
+
* ```js
|
|
3066
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
3067
|
+
* ```
|
|
3068
|
+
*/
|
|
3004
3069
|
DownloadAsPdf = "downloadAsPdf",
|
|
3005
3070
|
/**
|
|
3006
|
-
|
|
3007
|
-
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
|
|
3011
|
-
|
|
3012
|
-
|
|
3013
|
-
|
|
3071
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3072
|
+
* or Answer page.
|
|
3073
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3074
|
+
*
|
|
3075
|
+
* @example
|
|
3076
|
+
* ```js
|
|
3077
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
3078
|
+
* ```
|
|
3079
|
+
*/
|
|
3014
3080
|
DownloadAsCsv = "downloadAsCSV",
|
|
3015
3081
|
/**
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
|
|
3021
|
-
|
|
3022
|
-
|
|
3023
|
-
|
|
3082
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3083
|
+
* or Answer page.
|
|
3084
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3085
|
+
*
|
|
3086
|
+
* @example
|
|
3087
|
+
* ```js
|
|
3088
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
3089
|
+
* ```
|
|
3090
|
+
*/
|
|
3024
3091
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
3025
3092
|
/**
|
|
3026
3093
|
* @hidden
|
|
3027
3094
|
*/
|
|
3028
3095
|
DownloadTrace = "downloadTrace",
|
|
3029
3096
|
/**
|
|
3030
|
-
|
|
3031
|
-
|
|
3032
|
-
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
|
|
3097
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
3098
|
+
* Worksheets and Data Connections page.
|
|
3099
|
+
* Exports an object as a TML file.
|
|
3100
|
+
*
|
|
3101
|
+
* @example
|
|
3102
|
+
* ```js
|
|
3103
|
+
* disabledActions: [Action.ExportTML]
|
|
3104
|
+
* ```
|
|
3105
|
+
*/
|
|
3038
3106
|
ExportTML = "exportTSL",
|
|
3039
3107
|
/**
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3108
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
3109
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
3110
|
+
*
|
|
3111
|
+
* @example
|
|
3112
|
+
* ```js
|
|
3113
|
+
* disabledActions: [Action.ImportTML]
|
|
3114
|
+
* ```
|
|
3115
|
+
*/
|
|
3047
3116
|
ImportTML = "importTSL",
|
|
3048
3117
|
/**
|
|
3049
3118
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
3050
3119
|
* Update TML representation of ThoughtSpot objects.
|
|
3120
|
+
*
|
|
3051
3121
|
* @example
|
|
3052
3122
|
* ```js
|
|
3053
3123
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -3057,6 +3127,7 @@ export enum Action {
|
|
|
3057
3127
|
/**
|
|
3058
3128
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3059
3129
|
* Opens the TML editor.
|
|
3130
|
+
*
|
|
3060
3131
|
* @example
|
|
3061
3132
|
* ```js
|
|
3062
3133
|
* disabledActions: [Action.EditTML]
|
|
@@ -3064,50 +3135,55 @@ export enum Action {
|
|
|
3064
3135
|
*/
|
|
3065
3136
|
EditTML = "editTSL",
|
|
3066
3137
|
/**
|
|
3067
|
-
|
|
3068
|
-
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
|
|
3074
|
-
|
|
3138
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
3139
|
+
* Allows presenting a Liveboard or visualization in
|
|
3140
|
+
* slideshow mode.
|
|
3141
|
+
*
|
|
3142
|
+
* @example
|
|
3143
|
+
* ```js
|
|
3144
|
+
* disabledActions: [Action.Present]
|
|
3145
|
+
* ```
|
|
3146
|
+
*/
|
|
3075
3147
|
Present = "present",
|
|
3076
3148
|
/**
|
|
3077
|
-
|
|
3078
|
-
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
|
|
3083
|
-
|
|
3149
|
+
* The tile resize options in the visualization menu.
|
|
3150
|
+
* Allows switching between different preset layouts.
|
|
3151
|
+
*
|
|
3152
|
+
* @example
|
|
3153
|
+
* ```js
|
|
3154
|
+
* disabledActions: [Action.ToggleSize]
|
|
3155
|
+
* ```
|
|
3156
|
+
*/
|
|
3084
3157
|
ToggleSize = "toggleSize",
|
|
3085
3158
|
/**
|
|
3086
|
-
|
|
3087
|
-
|
|
3088
|
-
|
|
3089
|
-
|
|
3090
|
-
|
|
3091
|
-
|
|
3092
|
-
|
|
3093
|
-
|
|
3159
|
+
* The *Edit* action on the Liveboard page and in the
|
|
3160
|
+
* visualization menu.
|
|
3161
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
3162
|
+
*
|
|
3163
|
+
* @example
|
|
3164
|
+
* ```js
|
|
3165
|
+
* disabledActions: [Action.Edit]
|
|
3166
|
+
* ```
|
|
3167
|
+
*/
|
|
3094
3168
|
Edit = "edit",
|
|
3095
3169
|
/**
|
|
3096
|
-
|
|
3097
|
-
|
|
3098
|
-
|
|
3099
|
-
|
|
3100
|
-
|
|
3101
|
-
|
|
3170
|
+
* The text edit option for Liveboard and visualization titles.
|
|
3171
|
+
*
|
|
3172
|
+
* @example
|
|
3173
|
+
* ```js
|
|
3174
|
+
* disabledActions: [Action.EditTitle]
|
|
3175
|
+
* ```
|
|
3176
|
+
*/
|
|
3102
3177
|
EditTitle = "editTitle",
|
|
3103
3178
|
/**
|
|
3104
|
-
|
|
3105
|
-
|
|
3106
|
-
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
|
|
3179
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
3180
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3181
|
+
*
|
|
3182
|
+
* @example
|
|
3183
|
+
* ```js
|
|
3184
|
+
* disabledActions: [Action.Remove]
|
|
3185
|
+
* ```
|
|
3186
|
+
*/
|
|
3111
3187
|
Remove = "delete",
|
|
3112
3188
|
/**
|
|
3113
3189
|
* @hidden
|
|
@@ -3130,15 +3206,16 @@ export enum Action {
|
|
|
3130
3206
|
*/
|
|
3131
3207
|
PinboardInfo = "pinboardInfo",
|
|
3132
3208
|
/**
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
|
|
3138
|
-
|
|
3139
|
-
|
|
3140
|
-
|
|
3141
|
-
|
|
3209
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
3210
|
+
* Displays details such as the name, description, and
|
|
3211
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3212
|
+
* and update.
|
|
3213
|
+
*
|
|
3214
|
+
* @example
|
|
3215
|
+
* ```js
|
|
3216
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
3217
|
+
* ```
|
|
3218
|
+
*/
|
|
3142
3219
|
LiveboardInfo = "pinboardInfo",
|
|
3143
3220
|
/**
|
|
3144
3221
|
* @hidden
|
|
@@ -3149,13 +3226,14 @@ export enum Action {
|
|
|
3149
3226
|
*/
|
|
3150
3227
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
3151
3228
|
/**
|
|
3152
|
-
|
|
3153
|
-
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
|
|
3158
|
-
|
|
3229
|
+
* The **Pin** menu action on an Answer or
|
|
3230
|
+
* Search results page.
|
|
3231
|
+
*
|
|
3232
|
+
* @example
|
|
3233
|
+
* ```js
|
|
3234
|
+
* disabledActions: [Action.Pin]
|
|
3235
|
+
* ```
|
|
3236
|
+
*/
|
|
3159
3237
|
Pin = "pin",
|
|
3160
3238
|
/**
|
|
3161
3239
|
* @hidden
|
|
@@ -3163,6 +3241,7 @@ export enum Action {
|
|
|
3163
3241
|
AnalysisInfo = "analysisInfo",
|
|
3164
3242
|
/**
|
|
3165
3243
|
* The **Schedule** menu action on a Liveboard.
|
|
3244
|
+
*
|
|
3166
3245
|
* @example
|
|
3167
3246
|
* ```js
|
|
3168
3247
|
* disabledActions: [Action.Subscription]
|
|
@@ -3170,25 +3249,28 @@ export enum Action {
|
|
|
3170
3249
|
*/
|
|
3171
3250
|
Subscription = "subscription",
|
|
3172
3251
|
/**
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3252
|
+
* The **Explore** action on Liveboard visualizations
|
|
3253
|
+
*
|
|
3254
|
+
* @example
|
|
3255
|
+
* ```js
|
|
3256
|
+
* disabledActions: [Action.Explore]
|
|
3257
|
+
* ```
|
|
3258
|
+
*/
|
|
3179
3259
|
Explore = "explore",
|
|
3180
3260
|
/**
|
|
3181
|
-
|
|
3182
|
-
|
|
3183
|
-
|
|
3184
|
-
|
|
3185
|
-
|
|
3186
|
-
|
|
3187
|
-
|
|
3261
|
+
* The action to include data points on a drilled-down Answer
|
|
3262
|
+
* or visualization
|
|
3263
|
+
*
|
|
3264
|
+
* @example
|
|
3265
|
+
* ```js
|
|
3266
|
+
* disabledActions: [Action.DrillInclude]
|
|
3267
|
+
* ```
|
|
3268
|
+
*/
|
|
3188
3269
|
DrillInclude = "context-menu-item-include",
|
|
3189
3270
|
/**
|
|
3190
3271
|
* The action to exclude data points on a drilled-down Answer
|
|
3191
3272
|
* or visualization
|
|
3273
|
+
*
|
|
3192
3274
|
* @example
|
|
3193
3275
|
* ```js
|
|
3194
3276
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3199,6 +3281,7 @@ export enum Action {
|
|
|
3199
3281
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3200
3282
|
* or Liveboard.
|
|
3201
3283
|
* Copies the selected data point.
|
|
3284
|
+
*
|
|
3202
3285
|
* @example
|
|
3203
3286
|
* ```js
|
|
3204
3287
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -3216,6 +3299,7 @@ export enum Action {
|
|
|
3216
3299
|
* The **Drill down** menu action on Answers and Liveboard
|
|
3217
3300
|
* visualizations.
|
|
3218
3301
|
* Allows drilling down to a specific data point on a chart or table.
|
|
3302
|
+
*
|
|
3219
3303
|
* @example
|
|
3220
3304
|
* ```js
|
|
3221
3305
|
* disabledActions: [Action.DrillDown]
|
|
@@ -3225,6 +3309,7 @@ export enum Action {
|
|
|
3225
3309
|
/**
|
|
3226
3310
|
* The request access action on Liveboards.
|
|
3227
3311
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3312
|
+
*
|
|
3228
3313
|
* @example
|
|
3229
3314
|
* ```js
|
|
3230
3315
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -3234,6 +3319,7 @@ export enum Action {
|
|
|
3234
3319
|
/**
|
|
3235
3320
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3236
3321
|
* of the Answer page
|
|
3322
|
+
*
|
|
3237
3323
|
* @example
|
|
3238
3324
|
* ```js
|
|
3239
3325
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3242,6 +3328,7 @@ export enum Action {
|
|
|
3242
3328
|
QueryDetailsButtons = "QueryDetailsButtons",
|
|
3243
3329
|
/**
|
|
3244
3330
|
* The **Delete** action for Answers.
|
|
3331
|
+
*
|
|
3245
3332
|
* @example
|
|
3246
3333
|
* ```js
|
|
3247
3334
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -3251,6 +3338,7 @@ export enum Action {
|
|
|
3251
3338
|
AnswerDelete = "onDeleteAnswer",
|
|
3252
3339
|
/**
|
|
3253
3340
|
* The Chart switcher icon on Answer and visualization pages.
|
|
3341
|
+
*
|
|
3254
3342
|
* @example
|
|
3255
3343
|
* ```js
|
|
3256
3344
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3260,6 +3348,7 @@ export enum Action {
|
|
|
3260
3348
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3261
3349
|
/**
|
|
3262
3350
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3351
|
+
*
|
|
3263
3352
|
* @example
|
|
3264
3353
|
* ```js
|
|
3265
3354
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3269,6 +3358,7 @@ export enum Action {
|
|
|
3269
3358
|
AddToFavorites = "addToFavorites",
|
|
3270
3359
|
/**
|
|
3271
3360
|
* The edit icon on Liveboards (Classic experience).
|
|
3361
|
+
*
|
|
3272
3362
|
* @example
|
|
3273
3363
|
* ```js
|
|
3274
3364
|
* disabledActions: [Action.EditDetails]
|
|
@@ -3278,6 +3368,7 @@ export enum Action {
|
|
|
3278
3368
|
EditDetails = "editDetails",
|
|
3279
3369
|
/**
|
|
3280
3370
|
* The Create alert action on KPI charts.
|
|
3371
|
+
*
|
|
3281
3372
|
* @example
|
|
3282
3373
|
* ```js
|
|
3283
3374
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -3296,6 +3387,7 @@ export enum Action {
|
|
|
3296
3387
|
/**
|
|
3297
3388
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3298
3389
|
* Allows sending data to a Google Sheet.
|
|
3390
|
+
*
|
|
3299
3391
|
* @example
|
|
3300
3392
|
* ```js
|
|
3301
3393
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -3307,6 +3399,7 @@ export enum Action {
|
|
|
3307
3399
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3308
3400
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3309
3401
|
* Microsoft Teams, and so on.
|
|
3402
|
+
*
|
|
3310
3403
|
* @example
|
|
3311
3404
|
* ```js
|
|
3312
3405
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3317,6 +3410,7 @@ export enum Action {
|
|
|
3317
3410
|
/**
|
|
3318
3411
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3319
3412
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
3413
|
+
*
|
|
3320
3414
|
* @example
|
|
3321
3415
|
* ```js
|
|
3322
3416
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3327,6 +3421,7 @@ export enum Action {
|
|
|
3327
3421
|
/**
|
|
3328
3422
|
* The **Filter** action on Liveboard visualizations.
|
|
3329
3423
|
* Allows users to apply cross-filters on a Liveboard.
|
|
3424
|
+
*
|
|
3330
3425
|
* @example
|
|
3331
3426
|
* ```js
|
|
3332
3427
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -3338,6 +3433,7 @@ export enum Action {
|
|
|
3338
3433
|
* The **Remove** action that appears when cross filters are applied
|
|
3339
3434
|
* on a Liveboard.
|
|
3340
3435
|
* Removes filters applied o a visualization.
|
|
3436
|
+
*
|
|
3341
3437
|
* @example
|
|
3342
3438
|
* ```js
|
|
3343
3439
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3349,6 +3445,7 @@ export enum Action {
|
|
|
3349
3445
|
* The **Aggregate** option in the chart axis or the
|
|
3350
3446
|
* table column customization menu.
|
|
3351
3447
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3448
|
+
*
|
|
3352
3449
|
* @example
|
|
3353
3450
|
* ```js
|
|
3354
3451
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3360,6 +3457,7 @@ export enum Action {
|
|
|
3360
3457
|
* The **Time bucket** option in the chart axis or table column
|
|
3361
3458
|
* customization menu.
|
|
3362
3459
|
* Allows defining time metric for date comparison.
|
|
3460
|
+
*
|
|
3363
3461
|
* @example
|
|
3364
3462
|
* ```js
|
|
3365
3463
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3370,6 +3468,7 @@ export enum Action {
|
|
|
3370
3468
|
/**
|
|
3371
3469
|
* The **Filter** action in the chart axis or table column
|
|
3372
3470
|
* customization menu.
|
|
3471
|
+
*
|
|
3373
3472
|
* @example
|
|
3374
3473
|
* ```js
|
|
3375
3474
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3381,6 +3480,7 @@ export enum Action {
|
|
|
3381
3480
|
* The **Conditional formatting** action on chart or table.
|
|
3382
3481
|
* Allows adding rules for conditional formatting of data
|
|
3383
3482
|
* points on a chart or table.
|
|
3483
|
+
*
|
|
3384
3484
|
* @example
|
|
3385
3485
|
* ```js
|
|
3386
3486
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3392,6 +3492,7 @@ export enum Action {
|
|
|
3392
3492
|
* The **Sort** menu action on a table or chart axis
|
|
3393
3493
|
* Sorts data in ascending or descending order.
|
|
3394
3494
|
* Allows adding, editing, or removing filters.
|
|
3495
|
+
*
|
|
3395
3496
|
* @example
|
|
3396
3497
|
* ```js
|
|
3397
3498
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3404,6 +3505,7 @@ export enum Action {
|
|
|
3404
3505
|
* customization menu.
|
|
3405
3506
|
* Allows grouping data points if the axes use the same
|
|
3406
3507
|
* unit of measurement and a similar scale.
|
|
3508
|
+
*
|
|
3407
3509
|
* @example
|
|
3408
3510
|
* ```js
|
|
3409
3511
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3415,6 +3517,7 @@ export enum Action {
|
|
|
3415
3517
|
* The **Position** option in the axis customization menu.
|
|
3416
3518
|
* Allows changing the position of the axis to the
|
|
3417
3519
|
* left or right side of the chart.
|
|
3520
|
+
*
|
|
3418
3521
|
* @example
|
|
3419
3522
|
* ```js
|
|
3420
3523
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3425,6 +3528,7 @@ export enum Action {
|
|
|
3425
3528
|
/**
|
|
3426
3529
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3427
3530
|
* Renames the axis label on a chart or the column header on a table.
|
|
3531
|
+
*
|
|
3428
3532
|
* @example
|
|
3429
3533
|
* ```js
|
|
3430
3534
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3436,6 +3540,7 @@ export enum Action {
|
|
|
3436
3540
|
* The **Edit** action in the axis customization menu.
|
|
3437
3541
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3438
3542
|
* and format of a column.
|
|
3543
|
+
*
|
|
3439
3544
|
* @example
|
|
3440
3545
|
* ```js
|
|
3441
3546
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3446,6 +3551,7 @@ export enum Action {
|
|
|
3446
3551
|
/**
|
|
3447
3552
|
* The **Number format** action to customize the format of
|
|
3448
3553
|
* the data labels on a chart or table.
|
|
3554
|
+
*
|
|
3449
3555
|
* @example
|
|
3450
3556
|
* ```js
|
|
3451
3557
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3456,6 +3562,7 @@ export enum Action {
|
|
|
3456
3562
|
/**
|
|
3457
3563
|
* The **Text wrapping** action on a table.
|
|
3458
3564
|
* Wraps or clips column text on a table.
|
|
3565
|
+
*
|
|
3459
3566
|
* @example
|
|
3460
3567
|
* ```js
|
|
3461
3568
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3468,6 +3575,7 @@ export enum Action {
|
|
|
3468
3575
|
* customization menu.
|
|
3469
3576
|
* Removes the data labels from a chart or the column of a
|
|
3470
3577
|
* table visualization.
|
|
3578
|
+
*
|
|
3471
3579
|
* @example
|
|
3472
3580
|
* ```js
|
|
3473
3581
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3482,6 +3590,7 @@ export enum Action {
|
|
|
3482
3590
|
/**
|
|
3483
3591
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3484
3592
|
* Allows renaming a Liveboard or visualization.
|
|
3593
|
+
*
|
|
3485
3594
|
* @example
|
|
3486
3595
|
* ```js
|
|
3487
3596
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3498,13 +3607,29 @@ export enum Action {
|
|
|
3498
3607
|
*/
|
|
3499
3608
|
MarkAsVerified = "markAsVerified",
|
|
3500
3609
|
/**
|
|
3501
|
-
* @version SDK: 1.
|
|
3610
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3502
3611
|
*/
|
|
3503
3612
|
AddTab = "addTab",
|
|
3504
3613
|
/**
|
|
3505
3614
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
3506
3615
|
*/
|
|
3507
|
-
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
|
|
3616
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
3617
|
+
/**
|
|
3618
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3619
|
+
*/
|
|
3620
|
+
ShowSageQuery = "showSageQuery",
|
|
3621
|
+
/**
|
|
3622
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3623
|
+
*/
|
|
3624
|
+
EditSageAnswer = "editSageAnswer",
|
|
3625
|
+
/**
|
|
3626
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3627
|
+
*/
|
|
3628
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
3629
|
+
/**
|
|
3630
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3631
|
+
*/
|
|
3632
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
3508
3633
|
}
|
|
3509
3634
|
export interface SessionInterface {
|
|
3510
3635
|
sessionId: string;
|
|
@@ -3850,6 +3975,7 @@ export interface CustomCssVariables {
|
|
|
3850
3975
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
3851
3976
|
* GPT and LLM.
|
|
3852
3977
|
*
|
|
3978
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
3853
3979
|
* @group Embed components
|
|
3854
3980
|
*/
|
|
3855
3981
|
export interface SageViewConfig extends ViewConfig {
|
|
@@ -3870,6 +3996,19 @@ export interface SageViewConfig extends ViewConfig {
|
|
|
3870
3996
|
*
|
|
3871
3997
|
*/
|
|
3872
3998
|
showObjectSuggestions?: boolean;
|
|
3999
|
+
/**
|
|
4000
|
+
* The query string to pre-fill in natual language search bar
|
|
4001
|
+
*/
|
|
4002
|
+
searchQuery?: string;
|
|
4003
|
+
/**
|
|
4004
|
+
* If set to true, sample questions would be hidden to user.
|
|
4005
|
+
* These sample questions are autogenerated based on selected datasource.
|
|
4006
|
+
*/
|
|
4007
|
+
hideSampleQuestions?: boolean;
|
|
4008
|
+
/**
|
|
4009
|
+
* The data source GUID to set on load.
|
|
4010
|
+
*/
|
|
4011
|
+
dataSource?: string;
|
|
3873
4012
|
}
|
|
3874
4013
|
export const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
3875
4014
|
/**
|