@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
|
@@ -161,6 +161,7 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
161
161
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
162
162
|
* GPT and LLM.
|
|
163
163
|
*
|
|
164
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
164
165
|
* @group Embed components
|
|
165
166
|
*/
|
|
166
167
|
export interface SageViewConfig extends ViewConfig {
|
|
@@ -181,6 +182,19 @@ export interface SageViewConfig extends ViewConfig {
|
|
|
181
182
|
*
|
|
182
183
|
*/
|
|
183
184
|
showObjectSuggestions?: boolean;
|
|
185
|
+
/**
|
|
186
|
+
* The query string to pre-fill in natual language search bar
|
|
187
|
+
*/
|
|
188
|
+
searchQuery?: string;
|
|
189
|
+
/**
|
|
190
|
+
* If set to true, sample questions would be hidden to user.
|
|
191
|
+
* These sample questions are autogenerated based on selected datasource.
|
|
192
|
+
*/
|
|
193
|
+
hideSampleQuestions?: boolean;
|
|
194
|
+
/**
|
|
195
|
+
* The data source GUID to set on load.
|
|
196
|
+
*/
|
|
197
|
+
dataSource?: string;
|
|
184
198
|
}
|
|
185
199
|
export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
186
200
|
/**
|
|
@@ -366,7 +380,7 @@ export declare enum Page {
|
|
|
366
380
|
/**
|
|
367
381
|
* SpotIQ listing page
|
|
368
382
|
*/
|
|
369
|
-
SpotIQ = "
|
|
383
|
+
SpotIQ = "insights"
|
|
370
384
|
}
|
|
371
385
|
/**
|
|
372
386
|
* The view configuration for full app embedding.
|
|
@@ -1127,6 +1141,9 @@ export interface CustomStyles {
|
|
|
1127
1141
|
export interface CustomisationsInterface {
|
|
1128
1142
|
style?: CustomStyles;
|
|
1129
1143
|
content?: {
|
|
1144
|
+
/**
|
|
1145
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
1146
|
+
*/
|
|
1130
1147
|
strings?: Record<string, any>;
|
|
1131
1148
|
[key: string]: any;
|
|
1132
1149
|
};
|
|
@@ -1534,21 +1551,21 @@ export interface ViewConfig {
|
|
|
1534
1551
|
/**
|
|
1535
1552
|
* Boolean to hide liveboard header
|
|
1536
1553
|
*
|
|
1537
|
-
* @version SDK: 1.
|
|
1554
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1538
1555
|
* @default false
|
|
1539
1556
|
*/
|
|
1540
1557
|
hideLiveboardHeader?: boolean;
|
|
1541
1558
|
/**
|
|
1542
1559
|
* Boolean to show liveboard title
|
|
1543
1560
|
*
|
|
1544
|
-
* @version SDK: 1.
|
|
1561
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1545
1562
|
* @default false
|
|
1546
1563
|
*/
|
|
1547
1564
|
showLiveboardTitle?: boolean;
|
|
1548
1565
|
/**
|
|
1549
1566
|
* Boolean to show liveboard description
|
|
1550
1567
|
*
|
|
1551
|
-
* @version SDK: 1.
|
|
1568
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1552
1569
|
* @default false
|
|
1553
1570
|
*/
|
|
1554
1571
|
showLiveboardDescription?: boolean;
|
|
@@ -1566,7 +1583,7 @@ export interface ViewConfig {
|
|
|
1566
1583
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1567
1584
|
* });
|
|
1568
1585
|
* ```
|
|
1569
|
-
* @version SDK: 1.
|
|
1586
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1570
1587
|
*/
|
|
1571
1588
|
hiddenTabs?: string[];
|
|
1572
1589
|
/**
|
|
@@ -1585,7 +1602,7 @@ export interface ViewConfig {
|
|
|
1585
1602
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1586
1603
|
* });
|
|
1587
1604
|
* ```
|
|
1588
|
-
* @version SDK: 1.
|
|
1605
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1589
1606
|
*/
|
|
1590
1607
|
visibleTabs?: string[];
|
|
1591
1608
|
}
|
|
@@ -2147,7 +2164,19 @@ export declare enum EmbedEvent {
|
|
|
2147
2164
|
*
|
|
2148
2165
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2149
2166
|
*/
|
|
2150
|
-
FilterChanged = "filterChanged"
|
|
2167
|
+
FilterChanged = "filterChanged",
|
|
2168
|
+
/**
|
|
2169
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
2170
|
+
*
|
|
2171
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2172
|
+
*/
|
|
2173
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
2174
|
+
/**
|
|
2175
|
+
* Emitten when a user select data source in Sage Embed
|
|
2176
|
+
*
|
|
2177
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2178
|
+
*/
|
|
2179
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
2151
2180
|
}
|
|
2152
2181
|
/**
|
|
2153
2182
|
* Event types that can be triggered by the host application
|
|
@@ -2176,6 +2205,7 @@ export declare enum HostEvent {
|
|
|
2176
2205
|
* Triggers a search query in AppEmbed and SearchEmbed
|
|
2177
2206
|
* deployments.
|
|
2178
2207
|
* Includes the following properties:
|
|
2208
|
+
*
|
|
2179
2209
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
2180
2210
|
* - Although an array, only a single source
|
|
2181
2211
|
* is supported.
|
|
@@ -2194,6 +2224,7 @@ export declare enum HostEvent {
|
|
|
2194
2224
|
/**
|
|
2195
2225
|
* Triggers a drill on certain points of the specified column
|
|
2196
2226
|
* Includes the following properties:
|
|
2227
|
+
*
|
|
2197
2228
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2198
2229
|
* to drill to. For example, { selectedPoints: []}
|
|
2199
2230
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -2258,18 +2289,19 @@ export declare enum HostEvent {
|
|
|
2258
2289
|
*/
|
|
2259
2290
|
SetActiveTab = "SetActiveTab",
|
|
2260
2291
|
/**
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
|
|
2292
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
2293
|
+
* runtime filters passed here are appended to the existing runtime
|
|
2294
|
+
* filters.
|
|
2295
|
+
* Pass an array of runtime filters with the following attributes:
|
|
2296
|
+
* `columnName`
|
|
2297
|
+
* _String_. The name of the column to filter on.
|
|
2298
|
+
* `operator`
|
|
2299
|
+
* Runtime filter operator to apply. For information,
|
|
2300
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
2301
|
+
* `values`
|
|
2302
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2303
|
+
* operators such as BW and IN accept multiple operands.
|
|
2304
|
+
*
|
|
2273
2305
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2274
2306
|
* @example
|
|
2275
2307
|
* ```js
|
|
@@ -2285,6 +2317,7 @@ export declare enum HostEvent {
|
|
|
2285
2317
|
/**
|
|
2286
2318
|
* Navigate to a specific page in the embedded application without reloading the page.
|
|
2287
2319
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2320
|
+
*
|
|
2288
2321
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
2289
2322
|
* @example
|
|
2290
2323
|
* ```js
|
|
@@ -2608,6 +2641,7 @@ export declare enum HostEvent {
|
|
|
2608
2641
|
/**
|
|
2609
2642
|
* Triggers the **SpotIQ analyze** action on visualization
|
|
2610
2643
|
* or search.
|
|
2644
|
+
*
|
|
2611
2645
|
* @param - Liveboard embed takes `vizId` as a
|
|
2612
2646
|
* key. Can be left undefined when embedding Search or
|
|
2613
2647
|
* visualization.
|
|
@@ -2647,6 +2681,7 @@ export declare enum HostEvent {
|
|
|
2647
2681
|
/**
|
|
2648
2682
|
* Triggers the **Download** > **PNG** action on
|
|
2649
2683
|
* charts in the embedded view.
|
|
2684
|
+
*
|
|
2650
2685
|
* @example
|
|
2651
2686
|
* ```js
|
|
2652
2687
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -2680,6 +2715,7 @@ export declare enum HostEvent {
|
|
|
2680
2715
|
/**
|
|
2681
2716
|
* Triggers the **Download** > **XLSX** action on tables
|
|
2682
2717
|
* in the embedded view.
|
|
2718
|
+
*
|
|
2683
2719
|
* @example
|
|
2684
2720
|
* ```js
|
|
2685
2721
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -2711,6 +2747,7 @@ export declare enum HostEvent {
|
|
|
2711
2747
|
/**
|
|
2712
2748
|
* Triggers the **Save** action on a Liveboard or Answer.
|
|
2713
2749
|
* Saves the changes.
|
|
2750
|
+
*
|
|
2714
2751
|
* @example
|
|
2715
2752
|
* ```js
|
|
2716
2753
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -2724,6 +2761,7 @@ export declare enum HostEvent {
|
|
|
2724
2761
|
/**
|
|
2725
2762
|
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
2726
2763
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
2764
|
+
*
|
|
2727
2765
|
* @param - an object with `vizId` as a key
|
|
2728
2766
|
* @example
|
|
2729
2767
|
* ```js
|
|
@@ -2740,6 +2778,7 @@ export declare enum HostEvent {
|
|
|
2740
2778
|
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
2741
2779
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
2742
2780
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
2781
|
+
*
|
|
2743
2782
|
* @param - an object with vizId as a key
|
|
2744
2783
|
* @example
|
|
2745
2784
|
* ```js
|
|
@@ -2756,6 +2795,7 @@ export declare enum HostEvent {
|
|
|
2756
2795
|
* Triggers the **Manage pipelines** action on an embedded
|
|
2757
2796
|
* visualization or Answer.
|
|
2758
2797
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
2798
|
+
*
|
|
2759
2799
|
* @param - an object with `vizId` as a key
|
|
2760
2800
|
* @example
|
|
2761
2801
|
* ```js
|
|
@@ -2800,6 +2840,19 @@ export declare enum HostEvent {
|
|
|
2800
2840
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2801
2841
|
*/
|
|
2802
2842
|
UpdateFilters = "updateFilters",
|
|
2843
|
+
/**
|
|
2844
|
+
* Get Tab for the current Liveboard.
|
|
2845
|
+
*
|
|
2846
|
+
* @example
|
|
2847
|
+
* ```js
|
|
2848
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
2849
|
+
* console.log(
|
|
2850
|
+
* tabDetails // TabDetails of current LB
|
|
2851
|
+
* );
|
|
2852
|
+
* })
|
|
2853
|
+
* ```
|
|
2854
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2855
|
+
*/
|
|
2803
2856
|
GetTabs = "getTabs",
|
|
2804
2857
|
/**
|
|
2805
2858
|
* Set the visible Tabs on a Liveboard.
|
|
@@ -2812,7 +2865,7 @@ export declare enum HostEvent {
|
|
|
2812
2865
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
2813
2866
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
2814
2867
|
* ```
|
|
2815
|
-
* @version SDK: 1.
|
|
2868
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2816
2869
|
*/
|
|
2817
2870
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
2818
2871
|
/**
|
|
@@ -2826,7 +2879,7 @@ export declare enum HostEvent {
|
|
|
2826
2879
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
2827
2880
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
2828
2881
|
* ```
|
|
2829
|
-
* @version SDK: 1.
|
|
2882
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2830
2883
|
*/
|
|
2831
2884
|
SetHiddenTabs = "SetPinboardHiddenTabs"
|
|
2832
2885
|
}
|
|
@@ -2908,7 +2961,10 @@ export declare enum Param {
|
|
|
2908
2961
|
ShowLiveboardTitle = "showLiveboardTitle",
|
|
2909
2962
|
HiddenTabs = "hideTabs",
|
|
2910
2963
|
VisibleTabs = "visibleTabs",
|
|
2911
|
-
HideTabPanel = "hideTabPanel"
|
|
2964
|
+
HideTabPanel = "hideTabPanel",
|
|
2965
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
2966
|
+
WorksheetId = "worksheetId",
|
|
2967
|
+
Query = "query,"
|
|
2912
2968
|
}
|
|
2913
2969
|
/**
|
|
2914
2970
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -2917,6 +2973,7 @@ export declare enum Param {
|
|
|
2917
2973
|
* specific actions in the embedded view, define the Action
|
|
2918
2974
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
2919
2975
|
* or `hiddenActions` array.
|
|
2976
|
+
*
|
|
2920
2977
|
* @example
|
|
2921
2978
|
* ```js
|
|
2922
2979
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2935,12 +2992,12 @@ export declare enum Param {
|
|
|
2935
2992
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
2936
2993
|
* })
|
|
2937
2994
|
* ```
|
|
2938
|
-
|
|
2939
2995
|
*/
|
|
2940
2996
|
export declare enum Action {
|
|
2941
2997
|
/**
|
|
2942
2998
|
* The **Save** action on an Answer or Liveboard.
|
|
2943
2999
|
* Allows users to save the changes.
|
|
3000
|
+
*
|
|
2944
3001
|
* @example
|
|
2945
3002
|
* ```js
|
|
2946
3003
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -2956,136 +3013,146 @@ export declare enum Action {
|
|
|
2956
3013
|
*/
|
|
2957
3014
|
SaveUntitled = "saveUntitled",
|
|
2958
3015
|
/**
|
|
2959
|
-
|
|
2960
|
-
|
|
2961
|
-
|
|
2962
|
-
|
|
2963
|
-
|
|
2964
|
-
|
|
2965
|
-
|
|
2966
|
-
|
|
3016
|
+
* The **Save as View** action on the Answer
|
|
3017
|
+
* page. Saves an Answer as a View object.
|
|
3018
|
+
*
|
|
3019
|
+
* @example
|
|
3020
|
+
* ```js
|
|
3021
|
+
* disabledActions: [Action.SaveAsView]
|
|
3022
|
+
* ```
|
|
3023
|
+
*/
|
|
2967
3024
|
SaveAsView = "saveAsView",
|
|
2968
3025
|
/**
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2978
|
-
|
|
3026
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
3027
|
+
* page.
|
|
3028
|
+
* Creates a copy of the Liveboard, visualization,
|
|
3029
|
+
* or Answer.
|
|
3030
|
+
*
|
|
3031
|
+
* @example
|
|
3032
|
+
* ```js
|
|
3033
|
+
* disabledActions: [Action.MakeACopy]
|
|
3034
|
+
* ```
|
|
3035
|
+
*/
|
|
2979
3036
|
MakeACopy = "makeACopy",
|
|
2980
3037
|
/**
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
|
|
2987
|
-
|
|
2988
|
-
|
|
3038
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
3039
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
3040
|
+
*
|
|
3041
|
+
* @example
|
|
3042
|
+
* ```js
|
|
3043
|
+
* disabledActions: [Action.EditACopy]
|
|
3044
|
+
* ```
|
|
3045
|
+
*/
|
|
2989
3046
|
EditACopy = "editACopy",
|
|
2990
3047
|
/**
|
|
2991
|
-
|
|
2992
|
-
|
|
2993
|
-
|
|
2994
|
-
|
|
2995
|
-
|
|
2996
|
-
|
|
2997
|
-
|
|
3048
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
3049
|
+
* Copies the visualization URL
|
|
3050
|
+
*
|
|
3051
|
+
* @example
|
|
3052
|
+
* ```js
|
|
3053
|
+
* disabledActions: [Action.CopyLink]
|
|
3054
|
+
* ```
|
|
3055
|
+
*/
|
|
2998
3056
|
CopyLink = "embedDocument",
|
|
2999
3057
|
/**
|
|
3000
3058
|
* @hidden
|
|
3001
3059
|
*/
|
|
3002
3060
|
ResetLayout = "resetLayout",
|
|
3003
3061
|
/**
|
|
3004
|
-
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
|
|
3062
|
+
* The **Schedule** menu action on a Liveboard.
|
|
3063
|
+
* Allows scheduling a Liveboard notification.
|
|
3064
|
+
*
|
|
3065
|
+
* @example
|
|
3066
|
+
* ```js
|
|
3067
|
+
* disabledActions: [Action.Schedule]
|
|
3068
|
+
* ```
|
|
3069
|
+
*/
|
|
3011
3070
|
Schedule = "subscription",
|
|
3012
3071
|
/**
|
|
3013
|
-
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
|
|
3072
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
3073
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
3074
|
+
*
|
|
3075
|
+
* @example
|
|
3076
|
+
* ```js
|
|
3077
|
+
* disabledActions: [Action.SchedulesList]
|
|
3078
|
+
* ```
|
|
3079
|
+
*/
|
|
3020
3080
|
SchedulesList = "schedule-list",
|
|
3021
3081
|
/**
|
|
3022
|
-
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
|
|
3026
|
-
|
|
3027
|
-
|
|
3028
|
-
|
|
3082
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
3083
|
+
* Allows users to share an object with other users and groups.
|
|
3084
|
+
*
|
|
3085
|
+
* @example
|
|
3086
|
+
* ```js
|
|
3087
|
+
* disabledActions: [Action.Share]
|
|
3088
|
+
* ```
|
|
3089
|
+
*/
|
|
3029
3090
|
Share = "share",
|
|
3030
3091
|
/**
|
|
3031
|
-
|
|
3032
|
-
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
|
|
3092
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
3093
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
3094
|
+
*
|
|
3095
|
+
* @example
|
|
3096
|
+
* ```js
|
|
3097
|
+
* disabledActions: [Action.AddFilter]
|
|
3098
|
+
* ```
|
|
3099
|
+
*/
|
|
3038
3100
|
AddFilter = "addFilter",
|
|
3039
3101
|
/**
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3102
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
3103
|
+
* Allows configuring filter options when adding filters to a
|
|
3104
|
+
* Liveboard or Answer.
|
|
3105
|
+
*
|
|
3106
|
+
* @example
|
|
3107
|
+
* ```js
|
|
3108
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
3109
|
+
* ```
|
|
3110
|
+
*/
|
|
3048
3111
|
ConfigureFilter = "configureFilter",
|
|
3049
3112
|
CollapseDataSources = "collapseDataSources",
|
|
3050
3113
|
/**
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
|
|
3055
|
-
|
|
3056
|
-
|
|
3057
|
-
|
|
3114
|
+
* The **Choose sources** button on Search page.
|
|
3115
|
+
* Allows selecting data sources for search queries.
|
|
3116
|
+
*
|
|
3117
|
+
* @example
|
|
3118
|
+
* ```js
|
|
3119
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
3120
|
+
* ```
|
|
3121
|
+
*/
|
|
3058
3122
|
ChooseDataSources = "chooseDataSources",
|
|
3059
3123
|
/**
|
|
3060
|
-
|
|
3061
|
-
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
|
|
3065
|
-
|
|
3066
|
-
|
|
3124
|
+
* The **Create formula** action on a Search or Answer page.
|
|
3125
|
+
* Allows adding formulas to an Answer.
|
|
3126
|
+
*
|
|
3127
|
+
* @example
|
|
3128
|
+
* ```js
|
|
3129
|
+
* disabledActions: [Action.AddFormula]
|
|
3130
|
+
* ```
|
|
3131
|
+
*/
|
|
3067
3132
|
AddFormula = "addFormula",
|
|
3068
3133
|
/**
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
|
|
3134
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
3135
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
3136
|
+
*
|
|
3137
|
+
* @example
|
|
3138
|
+
* ```js
|
|
3139
|
+
* disabledActions: [Action.AddParameter]
|
|
3140
|
+
* ```
|
|
3141
|
+
*/
|
|
3076
3142
|
AddParameter = "addParameter",
|
|
3077
3143
|
/**
|
|
3078
3144
|
* @hidden
|
|
3079
3145
|
*/
|
|
3080
3146
|
SearchOnTop = "searchOnTop",
|
|
3081
3147
|
/**
|
|
3082
|
-
|
|
3083
|
-
|
|
3084
|
-
|
|
3085
|
-
|
|
3086
|
-
|
|
3087
|
-
|
|
3088
|
-
|
|
3148
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
3149
|
+
* Answer page.
|
|
3150
|
+
*
|
|
3151
|
+
* @example
|
|
3152
|
+
* ```js
|
|
3153
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
3154
|
+
* ```
|
|
3155
|
+
*/
|
|
3089
3156
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3090
3157
|
/**
|
|
3091
3158
|
* @hidden
|
|
@@ -3101,89 +3168,98 @@ export declare enum Action {
|
|
|
3101
3168
|
*/
|
|
3102
3169
|
ReplaySearch = "replaySearch",
|
|
3103
3170
|
/**
|
|
3104
|
-
|
|
3105
|
-
|
|
3106
|
-
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
|
|
3171
|
+
* The **Show underlying data** menu action on a visualization or
|
|
3172
|
+
* Answer page.
|
|
3173
|
+
*
|
|
3174
|
+
* @example
|
|
3175
|
+
* ```js
|
|
3176
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
3177
|
+
* ```
|
|
3178
|
+
*/
|
|
3111
3179
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3112
3180
|
/**
|
|
3113
|
-
|
|
3114
|
-
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
|
|
3120
|
-
|
|
3181
|
+
* The **Download** menu action on Liveboard visualizations
|
|
3182
|
+
* and Answers.
|
|
3183
|
+
* Allows downloading a visualization or Answer.
|
|
3184
|
+
*
|
|
3185
|
+
* @example
|
|
3186
|
+
* ```js
|
|
3187
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3188
|
+
* ```
|
|
3189
|
+
*/
|
|
3121
3190
|
Download = "download",
|
|
3122
3191
|
/**
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
|
|
3127
|
-
|
|
3128
|
-
|
|
3129
|
-
|
|
3130
|
-
|
|
3192
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3193
|
+
* or Answer page.
|
|
3194
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
3195
|
+
*
|
|
3196
|
+
* @example
|
|
3197
|
+
* ```js
|
|
3198
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3199
|
+
* ```
|
|
3200
|
+
*/
|
|
3131
3201
|
DownloadAsPng = "downloadAsPng",
|
|
3132
3202
|
/**
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
|
|
3138
|
-
|
|
3139
|
-
|
|
3203
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3204
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
3205
|
+
*
|
|
3206
|
+
* @example
|
|
3207
|
+
* ```js
|
|
3208
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
3209
|
+
* ```
|
|
3210
|
+
*/
|
|
3140
3211
|
DownloadAsPdf = "downloadAsPdf",
|
|
3141
3212
|
/**
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
|
|
3213
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3214
|
+
* or Answer page.
|
|
3215
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3216
|
+
*
|
|
3217
|
+
* @example
|
|
3218
|
+
* ```js
|
|
3219
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
3220
|
+
* ```
|
|
3221
|
+
*/
|
|
3150
3222
|
DownloadAsCsv = "downloadAsCSV",
|
|
3151
3223
|
/**
|
|
3152
|
-
|
|
3153
|
-
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
|
|
3158
|
-
|
|
3159
|
-
|
|
3224
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3225
|
+
* or Answer page.
|
|
3226
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3227
|
+
*
|
|
3228
|
+
* @example
|
|
3229
|
+
* ```js
|
|
3230
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
3231
|
+
* ```
|
|
3232
|
+
*/
|
|
3160
3233
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
3161
3234
|
/**
|
|
3162
3235
|
* @hidden
|
|
3163
3236
|
*/
|
|
3164
3237
|
DownloadTrace = "downloadTrace",
|
|
3165
3238
|
/**
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3239
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
3240
|
+
* Worksheets and Data Connections page.
|
|
3241
|
+
* Exports an object as a TML file.
|
|
3242
|
+
*
|
|
3243
|
+
* @example
|
|
3244
|
+
* ```js
|
|
3245
|
+
* disabledActions: [Action.ExportTML]
|
|
3246
|
+
* ```
|
|
3247
|
+
*/
|
|
3174
3248
|
ExportTML = "exportTSL",
|
|
3175
3249
|
/**
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
|
|
3250
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
3251
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
3252
|
+
*
|
|
3253
|
+
* @example
|
|
3254
|
+
* ```js
|
|
3255
|
+
* disabledActions: [Action.ImportTML]
|
|
3256
|
+
* ```
|
|
3257
|
+
*/
|
|
3183
3258
|
ImportTML = "importTSL",
|
|
3184
3259
|
/**
|
|
3185
3260
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
3186
3261
|
* Update TML representation of ThoughtSpot objects.
|
|
3262
|
+
*
|
|
3187
3263
|
* @example
|
|
3188
3264
|
* ```js
|
|
3189
3265
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -3193,6 +3269,7 @@ export declare enum Action {
|
|
|
3193
3269
|
/**
|
|
3194
3270
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3195
3271
|
* Opens the TML editor.
|
|
3272
|
+
*
|
|
3196
3273
|
* @example
|
|
3197
3274
|
* ```js
|
|
3198
3275
|
* disabledActions: [Action.EditTML]
|
|
@@ -3200,50 +3277,55 @@ export declare enum Action {
|
|
|
3200
3277
|
*/
|
|
3201
3278
|
EditTML = "editTSL",
|
|
3202
3279
|
/**
|
|
3203
|
-
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
|
|
3207
|
-
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
|
|
3280
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
3281
|
+
* Allows presenting a Liveboard or visualization in
|
|
3282
|
+
* slideshow mode.
|
|
3283
|
+
*
|
|
3284
|
+
* @example
|
|
3285
|
+
* ```js
|
|
3286
|
+
* disabledActions: [Action.Present]
|
|
3287
|
+
* ```
|
|
3288
|
+
*/
|
|
3211
3289
|
Present = "present",
|
|
3212
3290
|
/**
|
|
3213
|
-
|
|
3214
|
-
|
|
3215
|
-
|
|
3216
|
-
|
|
3217
|
-
|
|
3218
|
-
|
|
3219
|
-
|
|
3291
|
+
* The tile resize options in the visualization menu.
|
|
3292
|
+
* Allows switching between different preset layouts.
|
|
3293
|
+
*
|
|
3294
|
+
* @example
|
|
3295
|
+
* ```js
|
|
3296
|
+
* disabledActions: [Action.ToggleSize]
|
|
3297
|
+
* ```
|
|
3298
|
+
*/
|
|
3220
3299
|
ToggleSize = "toggleSize",
|
|
3221
3300
|
/**
|
|
3222
|
-
|
|
3223
|
-
|
|
3224
|
-
|
|
3225
|
-
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
|
-
|
|
3229
|
-
|
|
3301
|
+
* The *Edit* action on the Liveboard page and in the
|
|
3302
|
+
* visualization menu.
|
|
3303
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
3304
|
+
*
|
|
3305
|
+
* @example
|
|
3306
|
+
* ```js
|
|
3307
|
+
* disabledActions: [Action.Edit]
|
|
3308
|
+
* ```
|
|
3309
|
+
*/
|
|
3230
3310
|
Edit = "edit",
|
|
3231
3311
|
/**
|
|
3232
|
-
|
|
3233
|
-
|
|
3234
|
-
|
|
3235
|
-
|
|
3236
|
-
|
|
3237
|
-
|
|
3312
|
+
* The text edit option for Liveboard and visualization titles.
|
|
3313
|
+
*
|
|
3314
|
+
* @example
|
|
3315
|
+
* ```js
|
|
3316
|
+
* disabledActions: [Action.EditTitle]
|
|
3317
|
+
* ```
|
|
3318
|
+
*/
|
|
3238
3319
|
EditTitle = "editTitle",
|
|
3239
3320
|
/**
|
|
3240
|
-
|
|
3241
|
-
|
|
3242
|
-
|
|
3243
|
-
|
|
3244
|
-
|
|
3245
|
-
|
|
3246
|
-
|
|
3321
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
3322
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3323
|
+
*
|
|
3324
|
+
* @example
|
|
3325
|
+
* ```js
|
|
3326
|
+
* disabledActions: [Action.Remove]
|
|
3327
|
+
* ```
|
|
3328
|
+
*/
|
|
3247
3329
|
Remove = "delete",
|
|
3248
3330
|
/**
|
|
3249
3331
|
* @hidden
|
|
@@ -3266,15 +3348,16 @@ export declare enum Action {
|
|
|
3266
3348
|
*/
|
|
3267
3349
|
PinboardInfo = "pinboardInfo",
|
|
3268
3350
|
/**
|
|
3269
|
-
|
|
3270
|
-
|
|
3271
|
-
|
|
3272
|
-
|
|
3273
|
-
|
|
3274
|
-
|
|
3275
|
-
|
|
3276
|
-
|
|
3277
|
-
|
|
3351
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
3352
|
+
* Displays details such as the name, description, and
|
|
3353
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3354
|
+
* and update.
|
|
3355
|
+
*
|
|
3356
|
+
* @example
|
|
3357
|
+
* ```js
|
|
3358
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
3359
|
+
* ```
|
|
3360
|
+
*/
|
|
3278
3361
|
LiveboardInfo = "pinboardInfo",
|
|
3279
3362
|
/**
|
|
3280
3363
|
* @hidden
|
|
@@ -3285,13 +3368,14 @@ export declare enum Action {
|
|
|
3285
3368
|
*/
|
|
3286
3369
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
3287
3370
|
/**
|
|
3288
|
-
|
|
3289
|
-
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
|
|
3293
|
-
|
|
3294
|
-
|
|
3371
|
+
* The **Pin** menu action on an Answer or
|
|
3372
|
+
* Search results page.
|
|
3373
|
+
*
|
|
3374
|
+
* @example
|
|
3375
|
+
* ```js
|
|
3376
|
+
* disabledActions: [Action.Pin]
|
|
3377
|
+
* ```
|
|
3378
|
+
*/
|
|
3295
3379
|
Pin = "pin",
|
|
3296
3380
|
/**
|
|
3297
3381
|
* @hidden
|
|
@@ -3299,6 +3383,7 @@ export declare enum Action {
|
|
|
3299
3383
|
AnalysisInfo = "analysisInfo",
|
|
3300
3384
|
/**
|
|
3301
3385
|
* The **Schedule** menu action on a Liveboard.
|
|
3386
|
+
*
|
|
3302
3387
|
* @example
|
|
3303
3388
|
* ```js
|
|
3304
3389
|
* disabledActions: [Action.Subscription]
|
|
@@ -3306,25 +3391,28 @@ export declare enum Action {
|
|
|
3306
3391
|
*/
|
|
3307
3392
|
Subscription = "subscription",
|
|
3308
3393
|
/**
|
|
3309
|
-
|
|
3310
|
-
|
|
3311
|
-
|
|
3312
|
-
|
|
3313
|
-
|
|
3314
|
-
|
|
3394
|
+
* The **Explore** action on Liveboard visualizations
|
|
3395
|
+
*
|
|
3396
|
+
* @example
|
|
3397
|
+
* ```js
|
|
3398
|
+
* disabledActions: [Action.Explore]
|
|
3399
|
+
* ```
|
|
3400
|
+
*/
|
|
3315
3401
|
Explore = "explore",
|
|
3316
3402
|
/**
|
|
3317
|
-
|
|
3318
|
-
|
|
3319
|
-
|
|
3320
|
-
|
|
3321
|
-
|
|
3322
|
-
|
|
3323
|
-
|
|
3403
|
+
* The action to include data points on a drilled-down Answer
|
|
3404
|
+
* or visualization
|
|
3405
|
+
*
|
|
3406
|
+
* @example
|
|
3407
|
+
* ```js
|
|
3408
|
+
* disabledActions: [Action.DrillInclude]
|
|
3409
|
+
* ```
|
|
3410
|
+
*/
|
|
3324
3411
|
DrillInclude = "context-menu-item-include",
|
|
3325
3412
|
/**
|
|
3326
3413
|
* The action to exclude data points on a drilled-down Answer
|
|
3327
3414
|
* or visualization
|
|
3415
|
+
*
|
|
3328
3416
|
* @example
|
|
3329
3417
|
* ```js
|
|
3330
3418
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3335,6 +3423,7 @@ export declare enum Action {
|
|
|
3335
3423
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3336
3424
|
* or Liveboard.
|
|
3337
3425
|
* Copies the selected data point.
|
|
3426
|
+
*
|
|
3338
3427
|
* @example
|
|
3339
3428
|
* ```js
|
|
3340
3429
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -3352,6 +3441,7 @@ export declare enum Action {
|
|
|
3352
3441
|
* The **Drill down** menu action on Answers and Liveboard
|
|
3353
3442
|
* visualizations.
|
|
3354
3443
|
* Allows drilling down to a specific data point on a chart or table.
|
|
3444
|
+
*
|
|
3355
3445
|
* @example
|
|
3356
3446
|
* ```js
|
|
3357
3447
|
* disabledActions: [Action.DrillDown]
|
|
@@ -3361,6 +3451,7 @@ export declare enum Action {
|
|
|
3361
3451
|
/**
|
|
3362
3452
|
* The request access action on Liveboards.
|
|
3363
3453
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3454
|
+
*
|
|
3364
3455
|
* @example
|
|
3365
3456
|
* ```js
|
|
3366
3457
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -3370,6 +3461,7 @@ export declare enum Action {
|
|
|
3370
3461
|
/**
|
|
3371
3462
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3372
3463
|
* of the Answer page
|
|
3464
|
+
*
|
|
3373
3465
|
* @example
|
|
3374
3466
|
* ```js
|
|
3375
3467
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3378,6 +3470,7 @@ export declare enum Action {
|
|
|
3378
3470
|
QueryDetailsButtons = "QueryDetailsButtons",
|
|
3379
3471
|
/**
|
|
3380
3472
|
* The **Delete** action for Answers.
|
|
3473
|
+
*
|
|
3381
3474
|
* @example
|
|
3382
3475
|
* ```js
|
|
3383
3476
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -3387,6 +3480,7 @@ export declare enum Action {
|
|
|
3387
3480
|
AnswerDelete = "onDeleteAnswer",
|
|
3388
3481
|
/**
|
|
3389
3482
|
* The Chart switcher icon on Answer and visualization pages.
|
|
3483
|
+
*
|
|
3390
3484
|
* @example
|
|
3391
3485
|
* ```js
|
|
3392
3486
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3396,6 +3490,7 @@ export declare enum Action {
|
|
|
3396
3490
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3397
3491
|
/**
|
|
3398
3492
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3493
|
+
*
|
|
3399
3494
|
* @example
|
|
3400
3495
|
* ```js
|
|
3401
3496
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3405,6 +3500,7 @@ export declare enum Action {
|
|
|
3405
3500
|
AddToFavorites = "addToFavorites",
|
|
3406
3501
|
/**
|
|
3407
3502
|
* The edit icon on Liveboards (Classic experience).
|
|
3503
|
+
*
|
|
3408
3504
|
* @example
|
|
3409
3505
|
* ```js
|
|
3410
3506
|
* disabledActions: [Action.EditDetails]
|
|
@@ -3414,6 +3510,7 @@ export declare enum Action {
|
|
|
3414
3510
|
EditDetails = "editDetails",
|
|
3415
3511
|
/**
|
|
3416
3512
|
* The Create alert action on KPI charts.
|
|
3513
|
+
*
|
|
3417
3514
|
* @example
|
|
3418
3515
|
* ```js
|
|
3419
3516
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -3432,6 +3529,7 @@ export declare enum Action {
|
|
|
3432
3529
|
/**
|
|
3433
3530
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3434
3531
|
* Allows sending data to a Google Sheet.
|
|
3532
|
+
*
|
|
3435
3533
|
* @example
|
|
3436
3534
|
* ```js
|
|
3437
3535
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -3443,6 +3541,7 @@ export declare enum Action {
|
|
|
3443
3541
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3444
3542
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3445
3543
|
* Microsoft Teams, and so on.
|
|
3544
|
+
*
|
|
3446
3545
|
* @example
|
|
3447
3546
|
* ```js
|
|
3448
3547
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3453,6 +3552,7 @@ export declare enum Action {
|
|
|
3453
3552
|
/**
|
|
3454
3553
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3455
3554
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
3555
|
+
*
|
|
3456
3556
|
* @example
|
|
3457
3557
|
* ```js
|
|
3458
3558
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3463,6 +3563,7 @@ export declare enum Action {
|
|
|
3463
3563
|
/**
|
|
3464
3564
|
* The **Filter** action on Liveboard visualizations.
|
|
3465
3565
|
* Allows users to apply cross-filters on a Liveboard.
|
|
3566
|
+
*
|
|
3466
3567
|
* @example
|
|
3467
3568
|
* ```js
|
|
3468
3569
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -3474,6 +3575,7 @@ export declare enum Action {
|
|
|
3474
3575
|
* The **Remove** action that appears when cross filters are applied
|
|
3475
3576
|
* on a Liveboard.
|
|
3476
3577
|
* Removes filters applied o a visualization.
|
|
3578
|
+
*
|
|
3477
3579
|
* @example
|
|
3478
3580
|
* ```js
|
|
3479
3581
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3485,6 +3587,7 @@ export declare enum Action {
|
|
|
3485
3587
|
* The **Aggregate** option in the chart axis or the
|
|
3486
3588
|
* table column customization menu.
|
|
3487
3589
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3590
|
+
*
|
|
3488
3591
|
* @example
|
|
3489
3592
|
* ```js
|
|
3490
3593
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3496,6 +3599,7 @@ export declare enum Action {
|
|
|
3496
3599
|
* The **Time bucket** option in the chart axis or table column
|
|
3497
3600
|
* customization menu.
|
|
3498
3601
|
* Allows defining time metric for date comparison.
|
|
3602
|
+
*
|
|
3499
3603
|
* @example
|
|
3500
3604
|
* ```js
|
|
3501
3605
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3506,6 +3610,7 @@ export declare enum Action {
|
|
|
3506
3610
|
/**
|
|
3507
3611
|
* The **Filter** action in the chart axis or table column
|
|
3508
3612
|
* customization menu.
|
|
3613
|
+
*
|
|
3509
3614
|
* @example
|
|
3510
3615
|
* ```js
|
|
3511
3616
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3517,6 +3622,7 @@ export declare enum Action {
|
|
|
3517
3622
|
* The **Conditional formatting** action on chart or table.
|
|
3518
3623
|
* Allows adding rules for conditional formatting of data
|
|
3519
3624
|
* points on a chart or table.
|
|
3625
|
+
*
|
|
3520
3626
|
* @example
|
|
3521
3627
|
* ```js
|
|
3522
3628
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3528,6 +3634,7 @@ export declare enum Action {
|
|
|
3528
3634
|
* The **Sort** menu action on a table or chart axis
|
|
3529
3635
|
* Sorts data in ascending or descending order.
|
|
3530
3636
|
* Allows adding, editing, or removing filters.
|
|
3637
|
+
*
|
|
3531
3638
|
* @example
|
|
3532
3639
|
* ```js
|
|
3533
3640
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3540,6 +3647,7 @@ export declare enum Action {
|
|
|
3540
3647
|
* customization menu.
|
|
3541
3648
|
* Allows grouping data points if the axes use the same
|
|
3542
3649
|
* unit of measurement and a similar scale.
|
|
3650
|
+
*
|
|
3543
3651
|
* @example
|
|
3544
3652
|
* ```js
|
|
3545
3653
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3551,6 +3659,7 @@ export declare enum Action {
|
|
|
3551
3659
|
* The **Position** option in the axis customization menu.
|
|
3552
3660
|
* Allows changing the position of the axis to the
|
|
3553
3661
|
* left or right side of the chart.
|
|
3662
|
+
*
|
|
3554
3663
|
* @example
|
|
3555
3664
|
* ```js
|
|
3556
3665
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3561,6 +3670,7 @@ export declare enum Action {
|
|
|
3561
3670
|
/**
|
|
3562
3671
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3563
3672
|
* Renames the axis label on a chart or the column header on a table.
|
|
3673
|
+
*
|
|
3564
3674
|
* @example
|
|
3565
3675
|
* ```js
|
|
3566
3676
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3572,6 +3682,7 @@ export declare enum Action {
|
|
|
3572
3682
|
* The **Edit** action in the axis customization menu.
|
|
3573
3683
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3574
3684
|
* and format of a column.
|
|
3685
|
+
*
|
|
3575
3686
|
* @example
|
|
3576
3687
|
* ```js
|
|
3577
3688
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3582,6 +3693,7 @@ export declare enum Action {
|
|
|
3582
3693
|
/**
|
|
3583
3694
|
* The **Number format** action to customize the format of
|
|
3584
3695
|
* the data labels on a chart or table.
|
|
3696
|
+
*
|
|
3585
3697
|
* @example
|
|
3586
3698
|
* ```js
|
|
3587
3699
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3592,6 +3704,7 @@ export declare enum Action {
|
|
|
3592
3704
|
/**
|
|
3593
3705
|
* The **Text wrapping** action on a table.
|
|
3594
3706
|
* Wraps or clips column text on a table.
|
|
3707
|
+
*
|
|
3595
3708
|
* @example
|
|
3596
3709
|
* ```js
|
|
3597
3710
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3604,6 +3717,7 @@ export declare enum Action {
|
|
|
3604
3717
|
* customization menu.
|
|
3605
3718
|
* Removes the data labels from a chart or the column of a
|
|
3606
3719
|
* table visualization.
|
|
3720
|
+
*
|
|
3607
3721
|
* @example
|
|
3608
3722
|
* ```js
|
|
3609
3723
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3618,6 +3732,7 @@ export declare enum Action {
|
|
|
3618
3732
|
/**
|
|
3619
3733
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3620
3734
|
* Allows renaming a Liveboard or visualization.
|
|
3735
|
+
*
|
|
3621
3736
|
* @example
|
|
3622
3737
|
* ```js
|
|
3623
3738
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3634,13 +3749,29 @@ export declare enum Action {
|
|
|
3634
3749
|
*/
|
|
3635
3750
|
MarkAsVerified = "markAsVerified",
|
|
3636
3751
|
/**
|
|
3637
|
-
* @version SDK: 1.
|
|
3752
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3638
3753
|
*/
|
|
3639
3754
|
AddTab = "addTab",
|
|
3640
3755
|
/**
|
|
3641
3756
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
3642
3757
|
*/
|
|
3643
|
-
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
|
|
3758
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
3759
|
+
/**
|
|
3760
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3761
|
+
*/
|
|
3762
|
+
ShowSageQuery = "showSageQuery",
|
|
3763
|
+
/**
|
|
3764
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3765
|
+
*/
|
|
3766
|
+
EditSageAnswer = "editSageAnswer",
|
|
3767
|
+
/**
|
|
3768
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3769
|
+
*/
|
|
3770
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
3771
|
+
/**
|
|
3772
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3773
|
+
*/
|
|
3774
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
3644
3775
|
}
|
|
3645
3776
|
export interface SessionInterface {
|
|
3646
3777
|
sessionId: string;
|
|
@@ -3757,7 +3888,15 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
3757
3888
|
* @param fn The function being registered
|
|
3758
3889
|
*/
|
|
3759
3890
|
export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
3891
|
+
/**
|
|
3892
|
+
* @param data
|
|
3893
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3894
|
+
*/
|
|
3760
3895
|
export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
3896
|
+
/**
|
|
3897
|
+
* @param data
|
|
3898
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3899
|
+
*/
|
|
3761
3900
|
export declare const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
3762
3901
|
/**
|
|
3763
3902
|
*
|