@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
|
@@ -172,6 +172,7 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
172
172
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
173
173
|
* GPT and LLM.
|
|
174
174
|
*
|
|
175
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
175
176
|
* @group Embed components
|
|
176
177
|
*/
|
|
177
178
|
export interface SageViewConfig extends ViewConfig {
|
|
@@ -192,6 +193,19 @@ export interface SageViewConfig extends ViewConfig {
|
|
|
192
193
|
*
|
|
193
194
|
*/
|
|
194
195
|
showObjectSuggestions?: boolean;
|
|
196
|
+
/**
|
|
197
|
+
* The query string to pre-fill in natual language search bar
|
|
198
|
+
*/
|
|
199
|
+
searchQuery?: string;
|
|
200
|
+
/**
|
|
201
|
+
* If set to true, sample questions would be hidden to user.
|
|
202
|
+
* These sample questions are autogenerated based on selected datasource.
|
|
203
|
+
*/
|
|
204
|
+
hideSampleQuestions?: boolean;
|
|
205
|
+
/**
|
|
206
|
+
* The data source GUID to set on load.
|
|
207
|
+
*/
|
|
208
|
+
dataSource?: string;
|
|
195
209
|
}
|
|
196
210
|
export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
197
211
|
/**
|
|
@@ -377,7 +391,7 @@ export declare enum Page {
|
|
|
377
391
|
/**
|
|
378
392
|
* SpotIQ listing page
|
|
379
393
|
*/
|
|
380
|
-
SpotIQ = "
|
|
394
|
+
SpotIQ = "insights"
|
|
381
395
|
}
|
|
382
396
|
/**
|
|
383
397
|
* The view configuration for full app embedding.
|
|
@@ -959,7 +973,15 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
959
973
|
* @param fn The function being registered
|
|
960
974
|
*/
|
|
961
975
|
export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
976
|
+
/**
|
|
977
|
+
* @param data
|
|
978
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
979
|
+
*/
|
|
962
980
|
export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
981
|
+
/**
|
|
982
|
+
* @param data
|
|
983
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
984
|
+
*/
|
|
963
985
|
export declare const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
964
986
|
/**
|
|
965
987
|
*
|
|
@@ -1403,6 +1425,9 @@ export interface CustomStyles {
|
|
|
1403
1425
|
export interface CustomisationsInterface {
|
|
1404
1426
|
style?: CustomStyles;
|
|
1405
1427
|
content?: {
|
|
1428
|
+
/**
|
|
1429
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
1430
|
+
*/
|
|
1406
1431
|
strings?: Record<string, any>;
|
|
1407
1432
|
[key: string]: any;
|
|
1408
1433
|
};
|
|
@@ -1810,21 +1835,21 @@ export interface ViewConfig {
|
|
|
1810
1835
|
/**
|
|
1811
1836
|
* Boolean to hide liveboard header
|
|
1812
1837
|
*
|
|
1813
|
-
* @version SDK: 1.
|
|
1838
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1814
1839
|
* @default false
|
|
1815
1840
|
*/
|
|
1816
1841
|
hideLiveboardHeader?: boolean;
|
|
1817
1842
|
/**
|
|
1818
1843
|
* Boolean to show liveboard title
|
|
1819
1844
|
*
|
|
1820
|
-
* @version SDK: 1.
|
|
1845
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1821
1846
|
* @default false
|
|
1822
1847
|
*/
|
|
1823
1848
|
showLiveboardTitle?: boolean;
|
|
1824
1849
|
/**
|
|
1825
1850
|
* Boolean to show liveboard description
|
|
1826
1851
|
*
|
|
1827
|
-
* @version SDK: 1.
|
|
1852
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1828
1853
|
* @default false
|
|
1829
1854
|
*/
|
|
1830
1855
|
showLiveboardDescription?: boolean;
|
|
@@ -1842,7 +1867,7 @@ export interface ViewConfig {
|
|
|
1842
1867
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1843
1868
|
* });
|
|
1844
1869
|
* ```
|
|
1845
|
-
* @version SDK: 1.
|
|
1870
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1846
1871
|
*/
|
|
1847
1872
|
hiddenTabs?: string[];
|
|
1848
1873
|
/**
|
|
@@ -1861,7 +1886,7 @@ export interface ViewConfig {
|
|
|
1861
1886
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1862
1887
|
* });
|
|
1863
1888
|
* ```
|
|
1864
|
-
* @version SDK: 1.
|
|
1889
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1865
1890
|
*/
|
|
1866
1891
|
visibleTabs?: string[];
|
|
1867
1892
|
}
|
|
@@ -2423,7 +2448,19 @@ export declare enum EmbedEvent {
|
|
|
2423
2448
|
*
|
|
2424
2449
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2425
2450
|
*/
|
|
2426
|
-
FilterChanged = "filterChanged"
|
|
2451
|
+
FilterChanged = "filterChanged",
|
|
2452
|
+
/**
|
|
2453
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
2454
|
+
*
|
|
2455
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2456
|
+
*/
|
|
2457
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
2458
|
+
/**
|
|
2459
|
+
* Emitten when a user select data source in Sage Embed
|
|
2460
|
+
*
|
|
2461
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2462
|
+
*/
|
|
2463
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
2427
2464
|
}
|
|
2428
2465
|
/**
|
|
2429
2466
|
* Event types that can be triggered by the host application
|
|
@@ -2452,6 +2489,7 @@ export declare enum HostEvent {
|
|
|
2452
2489
|
* Triggers a search query in AppEmbed and SearchEmbed
|
|
2453
2490
|
* deployments.
|
|
2454
2491
|
* Includes the following properties:
|
|
2492
|
+
*
|
|
2455
2493
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
2456
2494
|
* - Although an array, only a single source
|
|
2457
2495
|
* is supported.
|
|
@@ -2470,6 +2508,7 @@ export declare enum HostEvent {
|
|
|
2470
2508
|
/**
|
|
2471
2509
|
* Triggers a drill on certain points of the specified column
|
|
2472
2510
|
* Includes the following properties:
|
|
2511
|
+
*
|
|
2473
2512
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2474
2513
|
* to drill to. For example, { selectedPoints: []}
|
|
2475
2514
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -2534,18 +2573,19 @@ export declare enum HostEvent {
|
|
|
2534
2573
|
*/
|
|
2535
2574
|
SetActiveTab = "SetActiveTab",
|
|
2536
2575
|
/**
|
|
2537
|
-
|
|
2538
|
-
|
|
2539
|
-
|
|
2540
|
-
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
|
|
2545
|
-
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
|
|
2576
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
2577
|
+
* runtime filters passed here are appended to the existing runtime
|
|
2578
|
+
* filters.
|
|
2579
|
+
* Pass an array of runtime filters with the following attributes:
|
|
2580
|
+
* `columnName`
|
|
2581
|
+
* _String_. The name of the column to filter on.
|
|
2582
|
+
* `operator`
|
|
2583
|
+
* Runtime filter operator to apply. For information,
|
|
2584
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
2585
|
+
* `values`
|
|
2586
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2587
|
+
* operators such as BW and IN accept multiple operands.
|
|
2588
|
+
*
|
|
2549
2589
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2550
2590
|
* @example
|
|
2551
2591
|
* ```js
|
|
@@ -2561,6 +2601,7 @@ export declare enum HostEvent {
|
|
|
2561
2601
|
/**
|
|
2562
2602
|
* Navigate to a specific page in the embedded application without reloading the page.
|
|
2563
2603
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2604
|
+
*
|
|
2564
2605
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
2565
2606
|
* @example
|
|
2566
2607
|
* ```js
|
|
@@ -2884,6 +2925,7 @@ export declare enum HostEvent {
|
|
|
2884
2925
|
/**
|
|
2885
2926
|
* Triggers the **SpotIQ analyze** action on visualization
|
|
2886
2927
|
* or search.
|
|
2928
|
+
*
|
|
2887
2929
|
* @param - Liveboard embed takes `vizId` as a
|
|
2888
2930
|
* key. Can be left undefined when embedding Search or
|
|
2889
2931
|
* visualization.
|
|
@@ -2923,6 +2965,7 @@ export declare enum HostEvent {
|
|
|
2923
2965
|
/**
|
|
2924
2966
|
* Triggers the **Download** > **PNG** action on
|
|
2925
2967
|
* charts in the embedded view.
|
|
2968
|
+
*
|
|
2926
2969
|
* @example
|
|
2927
2970
|
* ```js
|
|
2928
2971
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -2956,6 +2999,7 @@ export declare enum HostEvent {
|
|
|
2956
2999
|
/**
|
|
2957
3000
|
* Triggers the **Download** > **XLSX** action on tables
|
|
2958
3001
|
* in the embedded view.
|
|
3002
|
+
*
|
|
2959
3003
|
* @example
|
|
2960
3004
|
* ```js
|
|
2961
3005
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -2987,6 +3031,7 @@ export declare enum HostEvent {
|
|
|
2987
3031
|
/**
|
|
2988
3032
|
* Triggers the **Save** action on a Liveboard or Answer.
|
|
2989
3033
|
* Saves the changes.
|
|
3034
|
+
*
|
|
2990
3035
|
* @example
|
|
2991
3036
|
* ```js
|
|
2992
3037
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -3000,6 +3045,7 @@ export declare enum HostEvent {
|
|
|
3000
3045
|
/**
|
|
3001
3046
|
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
3002
3047
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
3048
|
+
*
|
|
3003
3049
|
* @param - an object with `vizId` as a key
|
|
3004
3050
|
* @example
|
|
3005
3051
|
* ```js
|
|
@@ -3016,6 +3062,7 @@ export declare enum HostEvent {
|
|
|
3016
3062
|
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
3017
3063
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
3018
3064
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
3065
|
+
*
|
|
3019
3066
|
* @param - an object with vizId as a key
|
|
3020
3067
|
* @example
|
|
3021
3068
|
* ```js
|
|
@@ -3032,6 +3079,7 @@ export declare enum HostEvent {
|
|
|
3032
3079
|
* Triggers the **Manage pipelines** action on an embedded
|
|
3033
3080
|
* visualization or Answer.
|
|
3034
3081
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
3082
|
+
*
|
|
3035
3083
|
* @param - an object with `vizId` as a key
|
|
3036
3084
|
* @example
|
|
3037
3085
|
* ```js
|
|
@@ -3076,6 +3124,19 @@ export declare enum HostEvent {
|
|
|
3076
3124
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3077
3125
|
*/
|
|
3078
3126
|
UpdateFilters = "updateFilters",
|
|
3127
|
+
/**
|
|
3128
|
+
* Get Tab for the current Liveboard.
|
|
3129
|
+
*
|
|
3130
|
+
* @example
|
|
3131
|
+
* ```js
|
|
3132
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
3133
|
+
* console.log(
|
|
3134
|
+
* tabDetails // TabDetails of current LB
|
|
3135
|
+
* );
|
|
3136
|
+
* })
|
|
3137
|
+
* ```
|
|
3138
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
3139
|
+
*/
|
|
3079
3140
|
GetTabs = "getTabs",
|
|
3080
3141
|
/**
|
|
3081
3142
|
* Set the visible Tabs on a Liveboard.
|
|
@@ -3088,7 +3149,7 @@ export declare enum HostEvent {
|
|
|
3088
3149
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
3089
3150
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
3090
3151
|
* ```
|
|
3091
|
-
* @version SDK: 1.
|
|
3152
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3092
3153
|
*/
|
|
3093
3154
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
3094
3155
|
/**
|
|
@@ -3102,7 +3163,7 @@ export declare enum HostEvent {
|
|
|
3102
3163
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
3103
3164
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
3104
3165
|
* ```
|
|
3105
|
-
* @version SDK: 1.
|
|
3166
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3106
3167
|
*/
|
|
3107
3168
|
SetHiddenTabs = "SetPinboardHiddenTabs"
|
|
3108
3169
|
}
|
|
@@ -3184,7 +3245,10 @@ export declare enum Param {
|
|
|
3184
3245
|
ShowLiveboardTitle = "showLiveboardTitle",
|
|
3185
3246
|
HiddenTabs = "hideTabs",
|
|
3186
3247
|
VisibleTabs = "visibleTabs",
|
|
3187
|
-
HideTabPanel = "hideTabPanel"
|
|
3248
|
+
HideTabPanel = "hideTabPanel",
|
|
3249
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
3250
|
+
WorksheetId = "worksheetId",
|
|
3251
|
+
Query = "query,"
|
|
3188
3252
|
}
|
|
3189
3253
|
/**
|
|
3190
3254
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3193,6 +3257,7 @@ export declare enum Param {
|
|
|
3193
3257
|
* specific actions in the embedded view, define the Action
|
|
3194
3258
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
3195
3259
|
* or `hiddenActions` array.
|
|
3260
|
+
*
|
|
3196
3261
|
* @example
|
|
3197
3262
|
* ```js
|
|
3198
3263
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -3211,12 +3276,12 @@ export declare enum Param {
|
|
|
3211
3276
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
3212
3277
|
* })
|
|
3213
3278
|
* ```
|
|
3214
|
-
|
|
3215
3279
|
*/
|
|
3216
3280
|
export declare enum Action {
|
|
3217
3281
|
/**
|
|
3218
3282
|
* The **Save** action on an Answer or Liveboard.
|
|
3219
3283
|
* Allows users to save the changes.
|
|
3284
|
+
*
|
|
3220
3285
|
* @example
|
|
3221
3286
|
* ```js
|
|
3222
3287
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -3232,136 +3297,146 @@ export declare enum Action {
|
|
|
3232
3297
|
*/
|
|
3233
3298
|
SaveUntitled = "saveUntitled",
|
|
3234
3299
|
/**
|
|
3235
|
-
|
|
3236
|
-
|
|
3237
|
-
|
|
3238
|
-
|
|
3239
|
-
|
|
3240
|
-
|
|
3241
|
-
|
|
3242
|
-
|
|
3300
|
+
* The **Save as View** action on the Answer
|
|
3301
|
+
* page. Saves an Answer as a View object.
|
|
3302
|
+
*
|
|
3303
|
+
* @example
|
|
3304
|
+
* ```js
|
|
3305
|
+
* disabledActions: [Action.SaveAsView]
|
|
3306
|
+
* ```
|
|
3307
|
+
*/
|
|
3243
3308
|
SaveAsView = "saveAsView",
|
|
3244
3309
|
/**
|
|
3245
|
-
|
|
3246
|
-
|
|
3247
|
-
|
|
3248
|
-
|
|
3249
|
-
|
|
3250
|
-
|
|
3251
|
-
|
|
3252
|
-
|
|
3253
|
-
|
|
3254
|
-
|
|
3310
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
3311
|
+
* page.
|
|
3312
|
+
* Creates a copy of the Liveboard, visualization,
|
|
3313
|
+
* or Answer.
|
|
3314
|
+
*
|
|
3315
|
+
* @example
|
|
3316
|
+
* ```js
|
|
3317
|
+
* disabledActions: [Action.MakeACopy]
|
|
3318
|
+
* ```
|
|
3319
|
+
*/
|
|
3255
3320
|
MakeACopy = "makeACopy",
|
|
3256
3321
|
/**
|
|
3257
|
-
|
|
3258
|
-
|
|
3259
|
-
|
|
3260
|
-
|
|
3261
|
-
|
|
3262
|
-
|
|
3263
|
-
|
|
3264
|
-
|
|
3322
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
3323
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
3324
|
+
*
|
|
3325
|
+
* @example
|
|
3326
|
+
* ```js
|
|
3327
|
+
* disabledActions: [Action.EditACopy]
|
|
3328
|
+
* ```
|
|
3329
|
+
*/
|
|
3265
3330
|
EditACopy = "editACopy",
|
|
3266
3331
|
/**
|
|
3267
|
-
|
|
3268
|
-
|
|
3269
|
-
|
|
3270
|
-
|
|
3271
|
-
|
|
3272
|
-
|
|
3273
|
-
|
|
3332
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
3333
|
+
* Copies the visualization URL
|
|
3334
|
+
*
|
|
3335
|
+
* @example
|
|
3336
|
+
* ```js
|
|
3337
|
+
* disabledActions: [Action.CopyLink]
|
|
3338
|
+
* ```
|
|
3339
|
+
*/
|
|
3274
3340
|
CopyLink = "embedDocument",
|
|
3275
3341
|
/**
|
|
3276
3342
|
* @hidden
|
|
3277
3343
|
*/
|
|
3278
3344
|
ResetLayout = "resetLayout",
|
|
3279
3345
|
/**
|
|
3280
|
-
|
|
3281
|
-
|
|
3282
|
-
|
|
3283
|
-
|
|
3284
|
-
|
|
3285
|
-
|
|
3286
|
-
|
|
3346
|
+
* The **Schedule** menu action on a Liveboard.
|
|
3347
|
+
* Allows scheduling a Liveboard notification.
|
|
3348
|
+
*
|
|
3349
|
+
* @example
|
|
3350
|
+
* ```js
|
|
3351
|
+
* disabledActions: [Action.Schedule]
|
|
3352
|
+
* ```
|
|
3353
|
+
*/
|
|
3287
3354
|
Schedule = "subscription",
|
|
3288
3355
|
/**
|
|
3289
|
-
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
|
|
3293
|
-
|
|
3294
|
-
|
|
3295
|
-
|
|
3356
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
3357
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
3358
|
+
*
|
|
3359
|
+
* @example
|
|
3360
|
+
* ```js
|
|
3361
|
+
* disabledActions: [Action.SchedulesList]
|
|
3362
|
+
* ```
|
|
3363
|
+
*/
|
|
3296
3364
|
SchedulesList = "schedule-list",
|
|
3297
3365
|
/**
|
|
3298
|
-
|
|
3299
|
-
|
|
3300
|
-
|
|
3301
|
-
|
|
3302
|
-
|
|
3303
|
-
|
|
3304
|
-
|
|
3366
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
3367
|
+
* Allows users to share an object with other users and groups.
|
|
3368
|
+
*
|
|
3369
|
+
* @example
|
|
3370
|
+
* ```js
|
|
3371
|
+
* disabledActions: [Action.Share]
|
|
3372
|
+
* ```
|
|
3373
|
+
*/
|
|
3305
3374
|
Share = "share",
|
|
3306
3375
|
/**
|
|
3307
|
-
|
|
3308
|
-
|
|
3309
|
-
|
|
3310
|
-
|
|
3311
|
-
|
|
3312
|
-
|
|
3313
|
-
|
|
3376
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
3377
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
3378
|
+
*
|
|
3379
|
+
* @example
|
|
3380
|
+
* ```js
|
|
3381
|
+
* disabledActions: [Action.AddFilter]
|
|
3382
|
+
* ```
|
|
3383
|
+
*/
|
|
3314
3384
|
AddFilter = "addFilter",
|
|
3315
3385
|
/**
|
|
3316
|
-
|
|
3317
|
-
|
|
3318
|
-
|
|
3319
|
-
|
|
3320
|
-
|
|
3321
|
-
|
|
3322
|
-
|
|
3323
|
-
|
|
3386
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
3387
|
+
* Allows configuring filter options when adding filters to a
|
|
3388
|
+
* Liveboard or Answer.
|
|
3389
|
+
*
|
|
3390
|
+
* @example
|
|
3391
|
+
* ```js
|
|
3392
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
3393
|
+
* ```
|
|
3394
|
+
*/
|
|
3324
3395
|
ConfigureFilter = "configureFilter",
|
|
3325
3396
|
CollapseDataSources = "collapseDataSources",
|
|
3326
3397
|
/**
|
|
3327
|
-
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
|
-
|
|
3332
|
-
|
|
3333
|
-
|
|
3398
|
+
* The **Choose sources** button on Search page.
|
|
3399
|
+
* Allows selecting data sources for search queries.
|
|
3400
|
+
*
|
|
3401
|
+
* @example
|
|
3402
|
+
* ```js
|
|
3403
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
3404
|
+
* ```
|
|
3405
|
+
*/
|
|
3334
3406
|
ChooseDataSources = "chooseDataSources",
|
|
3335
3407
|
/**
|
|
3336
|
-
|
|
3337
|
-
|
|
3338
|
-
|
|
3339
|
-
|
|
3340
|
-
|
|
3341
|
-
|
|
3342
|
-
|
|
3408
|
+
* The **Create formula** action on a Search or Answer page.
|
|
3409
|
+
* Allows adding formulas to an Answer.
|
|
3410
|
+
*
|
|
3411
|
+
* @example
|
|
3412
|
+
* ```js
|
|
3413
|
+
* disabledActions: [Action.AddFormula]
|
|
3414
|
+
* ```
|
|
3415
|
+
*/
|
|
3343
3416
|
AddFormula = "addFormula",
|
|
3344
3417
|
/**
|
|
3345
|
-
|
|
3346
|
-
|
|
3347
|
-
|
|
3348
|
-
|
|
3349
|
-
|
|
3350
|
-
|
|
3351
|
-
|
|
3418
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
3419
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
3420
|
+
*
|
|
3421
|
+
* @example
|
|
3422
|
+
* ```js
|
|
3423
|
+
* disabledActions: [Action.AddParameter]
|
|
3424
|
+
* ```
|
|
3425
|
+
*/
|
|
3352
3426
|
AddParameter = "addParameter",
|
|
3353
3427
|
/**
|
|
3354
3428
|
* @hidden
|
|
3355
3429
|
*/
|
|
3356
3430
|
SearchOnTop = "searchOnTop",
|
|
3357
3431
|
/**
|
|
3358
|
-
|
|
3359
|
-
|
|
3360
|
-
|
|
3361
|
-
|
|
3362
|
-
|
|
3363
|
-
|
|
3364
|
-
|
|
3432
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
3433
|
+
* Answer page.
|
|
3434
|
+
*
|
|
3435
|
+
* @example
|
|
3436
|
+
* ```js
|
|
3437
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
3438
|
+
* ```
|
|
3439
|
+
*/
|
|
3365
3440
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3366
3441
|
/**
|
|
3367
3442
|
* @hidden
|
|
@@ -3377,89 +3452,98 @@ export declare enum Action {
|
|
|
3377
3452
|
*/
|
|
3378
3453
|
ReplaySearch = "replaySearch",
|
|
3379
3454
|
/**
|
|
3380
|
-
|
|
3381
|
-
|
|
3382
|
-
|
|
3383
|
-
|
|
3384
|
-
|
|
3385
|
-
|
|
3386
|
-
|
|
3455
|
+
* The **Show underlying data** menu action on a visualization or
|
|
3456
|
+
* Answer page.
|
|
3457
|
+
*
|
|
3458
|
+
* @example
|
|
3459
|
+
* ```js
|
|
3460
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
3461
|
+
* ```
|
|
3462
|
+
*/
|
|
3387
3463
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3388
3464
|
/**
|
|
3389
|
-
|
|
3390
|
-
|
|
3391
|
-
|
|
3392
|
-
|
|
3393
|
-
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
|
|
3465
|
+
* The **Download** menu action on Liveboard visualizations
|
|
3466
|
+
* and Answers.
|
|
3467
|
+
* Allows downloading a visualization or Answer.
|
|
3468
|
+
*
|
|
3469
|
+
* @example
|
|
3470
|
+
* ```js
|
|
3471
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3472
|
+
* ```
|
|
3473
|
+
*/
|
|
3397
3474
|
Download = "download",
|
|
3398
3475
|
/**
|
|
3399
|
-
|
|
3400
|
-
|
|
3401
|
-
|
|
3402
|
-
|
|
3403
|
-
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
|
-
|
|
3476
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3477
|
+
* or Answer page.
|
|
3478
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
3479
|
+
*
|
|
3480
|
+
* @example
|
|
3481
|
+
* ```js
|
|
3482
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3483
|
+
* ```
|
|
3484
|
+
*/
|
|
3407
3485
|
DownloadAsPng = "downloadAsPng",
|
|
3408
3486
|
/**
|
|
3409
|
-
|
|
3410
|
-
|
|
3411
|
-
|
|
3412
|
-
|
|
3413
|
-
|
|
3414
|
-
|
|
3415
|
-
|
|
3487
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3488
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
3489
|
+
*
|
|
3490
|
+
* @example
|
|
3491
|
+
* ```js
|
|
3492
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
3493
|
+
* ```
|
|
3494
|
+
*/
|
|
3416
3495
|
DownloadAsPdf = "downloadAsPdf",
|
|
3417
3496
|
/**
|
|
3418
|
-
|
|
3419
|
-
|
|
3420
|
-
|
|
3421
|
-
|
|
3422
|
-
|
|
3423
|
-
|
|
3424
|
-
|
|
3425
|
-
|
|
3497
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3498
|
+
* or Answer page.
|
|
3499
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3500
|
+
*
|
|
3501
|
+
* @example
|
|
3502
|
+
* ```js
|
|
3503
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
3504
|
+
* ```
|
|
3505
|
+
*/
|
|
3426
3506
|
DownloadAsCsv = "downloadAsCSV",
|
|
3427
3507
|
/**
|
|
3428
|
-
|
|
3429
|
-
|
|
3430
|
-
|
|
3431
|
-
|
|
3432
|
-
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
|
|
3508
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3509
|
+
* or Answer page.
|
|
3510
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3511
|
+
*
|
|
3512
|
+
* @example
|
|
3513
|
+
* ```js
|
|
3514
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
3515
|
+
* ```
|
|
3516
|
+
*/
|
|
3436
3517
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
3437
3518
|
/**
|
|
3438
3519
|
* @hidden
|
|
3439
3520
|
*/
|
|
3440
3521
|
DownloadTrace = "downloadTrace",
|
|
3441
3522
|
/**
|
|
3442
|
-
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
|
|
3448
|
-
|
|
3449
|
-
|
|
3523
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
3524
|
+
* Worksheets and Data Connections page.
|
|
3525
|
+
* Exports an object as a TML file.
|
|
3526
|
+
*
|
|
3527
|
+
* @example
|
|
3528
|
+
* ```js
|
|
3529
|
+
* disabledActions: [Action.ExportTML]
|
|
3530
|
+
* ```
|
|
3531
|
+
*/
|
|
3450
3532
|
ExportTML = "exportTSL",
|
|
3451
3533
|
/**
|
|
3452
|
-
|
|
3453
|
-
|
|
3454
|
-
|
|
3455
|
-
|
|
3456
|
-
|
|
3457
|
-
|
|
3458
|
-
|
|
3534
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
3535
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
3536
|
+
*
|
|
3537
|
+
* @example
|
|
3538
|
+
* ```js
|
|
3539
|
+
* disabledActions: [Action.ImportTML]
|
|
3540
|
+
* ```
|
|
3541
|
+
*/
|
|
3459
3542
|
ImportTML = "importTSL",
|
|
3460
3543
|
/**
|
|
3461
3544
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
3462
3545
|
* Update TML representation of ThoughtSpot objects.
|
|
3546
|
+
*
|
|
3463
3547
|
* @example
|
|
3464
3548
|
* ```js
|
|
3465
3549
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -3469,6 +3553,7 @@ export declare enum Action {
|
|
|
3469
3553
|
/**
|
|
3470
3554
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3471
3555
|
* Opens the TML editor.
|
|
3556
|
+
*
|
|
3472
3557
|
* @example
|
|
3473
3558
|
* ```js
|
|
3474
3559
|
* disabledActions: [Action.EditTML]
|
|
@@ -3476,50 +3561,55 @@ export declare enum Action {
|
|
|
3476
3561
|
*/
|
|
3477
3562
|
EditTML = "editTSL",
|
|
3478
3563
|
/**
|
|
3479
|
-
|
|
3480
|
-
|
|
3481
|
-
|
|
3482
|
-
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3564
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
3565
|
+
* Allows presenting a Liveboard or visualization in
|
|
3566
|
+
* slideshow mode.
|
|
3567
|
+
*
|
|
3568
|
+
* @example
|
|
3569
|
+
* ```js
|
|
3570
|
+
* disabledActions: [Action.Present]
|
|
3571
|
+
* ```
|
|
3572
|
+
*/
|
|
3487
3573
|
Present = "present",
|
|
3488
3574
|
/**
|
|
3489
|
-
|
|
3490
|
-
|
|
3491
|
-
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
3575
|
+
* The tile resize options in the visualization menu.
|
|
3576
|
+
* Allows switching between different preset layouts.
|
|
3577
|
+
*
|
|
3578
|
+
* @example
|
|
3579
|
+
* ```js
|
|
3580
|
+
* disabledActions: [Action.ToggleSize]
|
|
3581
|
+
* ```
|
|
3582
|
+
*/
|
|
3496
3583
|
ToggleSize = "toggleSize",
|
|
3497
3584
|
/**
|
|
3498
|
-
|
|
3499
|
-
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3585
|
+
* The *Edit* action on the Liveboard page and in the
|
|
3586
|
+
* visualization menu.
|
|
3587
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
3588
|
+
*
|
|
3589
|
+
* @example
|
|
3590
|
+
* ```js
|
|
3591
|
+
* disabledActions: [Action.Edit]
|
|
3592
|
+
* ```
|
|
3593
|
+
*/
|
|
3506
3594
|
Edit = "edit",
|
|
3507
3595
|
/**
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3596
|
+
* The text edit option for Liveboard and visualization titles.
|
|
3597
|
+
*
|
|
3598
|
+
* @example
|
|
3599
|
+
* ```js
|
|
3600
|
+
* disabledActions: [Action.EditTitle]
|
|
3601
|
+
* ```
|
|
3602
|
+
*/
|
|
3514
3603
|
EditTitle = "editTitle",
|
|
3515
3604
|
/**
|
|
3516
|
-
|
|
3517
|
-
|
|
3518
|
-
|
|
3519
|
-
|
|
3520
|
-
|
|
3521
|
-
|
|
3522
|
-
|
|
3605
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
3606
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3607
|
+
*
|
|
3608
|
+
* @example
|
|
3609
|
+
* ```js
|
|
3610
|
+
* disabledActions: [Action.Remove]
|
|
3611
|
+
* ```
|
|
3612
|
+
*/
|
|
3523
3613
|
Remove = "delete",
|
|
3524
3614
|
/**
|
|
3525
3615
|
* @hidden
|
|
@@ -3542,15 +3632,16 @@ export declare enum Action {
|
|
|
3542
3632
|
*/
|
|
3543
3633
|
PinboardInfo = "pinboardInfo",
|
|
3544
3634
|
/**
|
|
3545
|
-
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
|
|
3553
|
-
|
|
3635
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
3636
|
+
* Displays details such as the name, description, and
|
|
3637
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3638
|
+
* and update.
|
|
3639
|
+
*
|
|
3640
|
+
* @example
|
|
3641
|
+
* ```js
|
|
3642
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
3643
|
+
* ```
|
|
3644
|
+
*/
|
|
3554
3645
|
LiveboardInfo = "pinboardInfo",
|
|
3555
3646
|
/**
|
|
3556
3647
|
* @hidden
|
|
@@ -3561,13 +3652,14 @@ export declare enum Action {
|
|
|
3561
3652
|
*/
|
|
3562
3653
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
3563
3654
|
/**
|
|
3564
|
-
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
|
|
3655
|
+
* The **Pin** menu action on an Answer or
|
|
3656
|
+
* Search results page.
|
|
3657
|
+
*
|
|
3658
|
+
* @example
|
|
3659
|
+
* ```js
|
|
3660
|
+
* disabledActions: [Action.Pin]
|
|
3661
|
+
* ```
|
|
3662
|
+
*/
|
|
3571
3663
|
Pin = "pin",
|
|
3572
3664
|
/**
|
|
3573
3665
|
* @hidden
|
|
@@ -3575,6 +3667,7 @@ export declare enum Action {
|
|
|
3575
3667
|
AnalysisInfo = "analysisInfo",
|
|
3576
3668
|
/**
|
|
3577
3669
|
* The **Schedule** menu action on a Liveboard.
|
|
3670
|
+
*
|
|
3578
3671
|
* @example
|
|
3579
3672
|
* ```js
|
|
3580
3673
|
* disabledActions: [Action.Subscription]
|
|
@@ -3582,25 +3675,28 @@ export declare enum Action {
|
|
|
3582
3675
|
*/
|
|
3583
3676
|
Subscription = "subscription",
|
|
3584
3677
|
/**
|
|
3585
|
-
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
|
|
3589
|
-
|
|
3590
|
-
|
|
3678
|
+
* The **Explore** action on Liveboard visualizations
|
|
3679
|
+
*
|
|
3680
|
+
* @example
|
|
3681
|
+
* ```js
|
|
3682
|
+
* disabledActions: [Action.Explore]
|
|
3683
|
+
* ```
|
|
3684
|
+
*/
|
|
3591
3685
|
Explore = "explore",
|
|
3592
3686
|
/**
|
|
3593
|
-
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
|
|
3597
|
-
|
|
3598
|
-
|
|
3599
|
-
|
|
3687
|
+
* The action to include data points on a drilled-down Answer
|
|
3688
|
+
* or visualization
|
|
3689
|
+
*
|
|
3690
|
+
* @example
|
|
3691
|
+
* ```js
|
|
3692
|
+
* disabledActions: [Action.DrillInclude]
|
|
3693
|
+
* ```
|
|
3694
|
+
*/
|
|
3600
3695
|
DrillInclude = "context-menu-item-include",
|
|
3601
3696
|
/**
|
|
3602
3697
|
* The action to exclude data points on a drilled-down Answer
|
|
3603
3698
|
* or visualization
|
|
3699
|
+
*
|
|
3604
3700
|
* @example
|
|
3605
3701
|
* ```js
|
|
3606
3702
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3611,6 +3707,7 @@ export declare enum Action {
|
|
|
3611
3707
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3612
3708
|
* or Liveboard.
|
|
3613
3709
|
* Copies the selected data point.
|
|
3710
|
+
*
|
|
3614
3711
|
* @example
|
|
3615
3712
|
* ```js
|
|
3616
3713
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -3628,6 +3725,7 @@ export declare enum Action {
|
|
|
3628
3725
|
* The **Drill down** menu action on Answers and Liveboard
|
|
3629
3726
|
* visualizations.
|
|
3630
3727
|
* Allows drilling down to a specific data point on a chart or table.
|
|
3728
|
+
*
|
|
3631
3729
|
* @example
|
|
3632
3730
|
* ```js
|
|
3633
3731
|
* disabledActions: [Action.DrillDown]
|
|
@@ -3637,6 +3735,7 @@ export declare enum Action {
|
|
|
3637
3735
|
/**
|
|
3638
3736
|
* The request access action on Liveboards.
|
|
3639
3737
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3738
|
+
*
|
|
3640
3739
|
* @example
|
|
3641
3740
|
* ```js
|
|
3642
3741
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -3646,6 +3745,7 @@ export declare enum Action {
|
|
|
3646
3745
|
/**
|
|
3647
3746
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3648
3747
|
* of the Answer page
|
|
3748
|
+
*
|
|
3649
3749
|
* @example
|
|
3650
3750
|
* ```js
|
|
3651
3751
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3654,6 +3754,7 @@ export declare enum Action {
|
|
|
3654
3754
|
QueryDetailsButtons = "QueryDetailsButtons",
|
|
3655
3755
|
/**
|
|
3656
3756
|
* The **Delete** action for Answers.
|
|
3757
|
+
*
|
|
3657
3758
|
* @example
|
|
3658
3759
|
* ```js
|
|
3659
3760
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -3663,6 +3764,7 @@ export declare enum Action {
|
|
|
3663
3764
|
AnswerDelete = "onDeleteAnswer",
|
|
3664
3765
|
/**
|
|
3665
3766
|
* The Chart switcher icon on Answer and visualization pages.
|
|
3767
|
+
*
|
|
3666
3768
|
* @example
|
|
3667
3769
|
* ```js
|
|
3668
3770
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3672,6 +3774,7 @@ export declare enum Action {
|
|
|
3672
3774
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3673
3775
|
/**
|
|
3674
3776
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3777
|
+
*
|
|
3675
3778
|
* @example
|
|
3676
3779
|
* ```js
|
|
3677
3780
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3681,6 +3784,7 @@ export declare enum Action {
|
|
|
3681
3784
|
AddToFavorites = "addToFavorites",
|
|
3682
3785
|
/**
|
|
3683
3786
|
* The edit icon on Liveboards (Classic experience).
|
|
3787
|
+
*
|
|
3684
3788
|
* @example
|
|
3685
3789
|
* ```js
|
|
3686
3790
|
* disabledActions: [Action.EditDetails]
|
|
@@ -3690,6 +3794,7 @@ export declare enum Action {
|
|
|
3690
3794
|
EditDetails = "editDetails",
|
|
3691
3795
|
/**
|
|
3692
3796
|
* The Create alert action on KPI charts.
|
|
3797
|
+
*
|
|
3693
3798
|
* @example
|
|
3694
3799
|
* ```js
|
|
3695
3800
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -3708,6 +3813,7 @@ export declare enum Action {
|
|
|
3708
3813
|
/**
|
|
3709
3814
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3710
3815
|
* Allows sending data to a Google Sheet.
|
|
3816
|
+
*
|
|
3711
3817
|
* @example
|
|
3712
3818
|
* ```js
|
|
3713
3819
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -3719,6 +3825,7 @@ export declare enum Action {
|
|
|
3719
3825
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3720
3826
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3721
3827
|
* Microsoft Teams, and so on.
|
|
3828
|
+
*
|
|
3722
3829
|
* @example
|
|
3723
3830
|
* ```js
|
|
3724
3831
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3729,6 +3836,7 @@ export declare enum Action {
|
|
|
3729
3836
|
/**
|
|
3730
3837
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3731
3838
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
3839
|
+
*
|
|
3732
3840
|
* @example
|
|
3733
3841
|
* ```js
|
|
3734
3842
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3739,6 +3847,7 @@ export declare enum Action {
|
|
|
3739
3847
|
/**
|
|
3740
3848
|
* The **Filter** action on Liveboard visualizations.
|
|
3741
3849
|
* Allows users to apply cross-filters on a Liveboard.
|
|
3850
|
+
*
|
|
3742
3851
|
* @example
|
|
3743
3852
|
* ```js
|
|
3744
3853
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -3750,6 +3859,7 @@ export declare enum Action {
|
|
|
3750
3859
|
* The **Remove** action that appears when cross filters are applied
|
|
3751
3860
|
* on a Liveboard.
|
|
3752
3861
|
* Removes filters applied o a visualization.
|
|
3862
|
+
*
|
|
3753
3863
|
* @example
|
|
3754
3864
|
* ```js
|
|
3755
3865
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3761,6 +3871,7 @@ export declare enum Action {
|
|
|
3761
3871
|
* The **Aggregate** option in the chart axis or the
|
|
3762
3872
|
* table column customization menu.
|
|
3763
3873
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3874
|
+
*
|
|
3764
3875
|
* @example
|
|
3765
3876
|
* ```js
|
|
3766
3877
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3772,6 +3883,7 @@ export declare enum Action {
|
|
|
3772
3883
|
* The **Time bucket** option in the chart axis or table column
|
|
3773
3884
|
* customization menu.
|
|
3774
3885
|
* Allows defining time metric for date comparison.
|
|
3886
|
+
*
|
|
3775
3887
|
* @example
|
|
3776
3888
|
* ```js
|
|
3777
3889
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3782,6 +3894,7 @@ export declare enum Action {
|
|
|
3782
3894
|
/**
|
|
3783
3895
|
* The **Filter** action in the chart axis or table column
|
|
3784
3896
|
* customization menu.
|
|
3897
|
+
*
|
|
3785
3898
|
* @example
|
|
3786
3899
|
* ```js
|
|
3787
3900
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3793,6 +3906,7 @@ export declare enum Action {
|
|
|
3793
3906
|
* The **Conditional formatting** action on chart or table.
|
|
3794
3907
|
* Allows adding rules for conditional formatting of data
|
|
3795
3908
|
* points on a chart or table.
|
|
3909
|
+
*
|
|
3796
3910
|
* @example
|
|
3797
3911
|
* ```js
|
|
3798
3912
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3804,6 +3918,7 @@ export declare enum Action {
|
|
|
3804
3918
|
* The **Sort** menu action on a table or chart axis
|
|
3805
3919
|
* Sorts data in ascending or descending order.
|
|
3806
3920
|
* Allows adding, editing, or removing filters.
|
|
3921
|
+
*
|
|
3807
3922
|
* @example
|
|
3808
3923
|
* ```js
|
|
3809
3924
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3816,6 +3931,7 @@ export declare enum Action {
|
|
|
3816
3931
|
* customization menu.
|
|
3817
3932
|
* Allows grouping data points if the axes use the same
|
|
3818
3933
|
* unit of measurement and a similar scale.
|
|
3934
|
+
*
|
|
3819
3935
|
* @example
|
|
3820
3936
|
* ```js
|
|
3821
3937
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3827,6 +3943,7 @@ export declare enum Action {
|
|
|
3827
3943
|
* The **Position** option in the axis customization menu.
|
|
3828
3944
|
* Allows changing the position of the axis to the
|
|
3829
3945
|
* left or right side of the chart.
|
|
3946
|
+
*
|
|
3830
3947
|
* @example
|
|
3831
3948
|
* ```js
|
|
3832
3949
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3837,6 +3954,7 @@ export declare enum Action {
|
|
|
3837
3954
|
/**
|
|
3838
3955
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3839
3956
|
* Renames the axis label on a chart or the column header on a table.
|
|
3957
|
+
*
|
|
3840
3958
|
* @example
|
|
3841
3959
|
* ```js
|
|
3842
3960
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3848,6 +3966,7 @@ export declare enum Action {
|
|
|
3848
3966
|
* The **Edit** action in the axis customization menu.
|
|
3849
3967
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3850
3968
|
* and format of a column.
|
|
3969
|
+
*
|
|
3851
3970
|
* @example
|
|
3852
3971
|
* ```js
|
|
3853
3972
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3858,6 +3977,7 @@ export declare enum Action {
|
|
|
3858
3977
|
/**
|
|
3859
3978
|
* The **Number format** action to customize the format of
|
|
3860
3979
|
* the data labels on a chart or table.
|
|
3980
|
+
*
|
|
3861
3981
|
* @example
|
|
3862
3982
|
* ```js
|
|
3863
3983
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3868,6 +3988,7 @@ export declare enum Action {
|
|
|
3868
3988
|
/**
|
|
3869
3989
|
* The **Text wrapping** action on a table.
|
|
3870
3990
|
* Wraps or clips column text on a table.
|
|
3991
|
+
*
|
|
3871
3992
|
* @example
|
|
3872
3993
|
* ```js
|
|
3873
3994
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3880,6 +4001,7 @@ export declare enum Action {
|
|
|
3880
4001
|
* customization menu.
|
|
3881
4002
|
* Removes the data labels from a chart or the column of a
|
|
3882
4003
|
* table visualization.
|
|
4004
|
+
*
|
|
3883
4005
|
* @example
|
|
3884
4006
|
* ```js
|
|
3885
4007
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3894,6 +4016,7 @@ export declare enum Action {
|
|
|
3894
4016
|
/**
|
|
3895
4017
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3896
4018
|
* Allows renaming a Liveboard or visualization.
|
|
4019
|
+
*
|
|
3897
4020
|
* @example
|
|
3898
4021
|
* ```js
|
|
3899
4022
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3910,13 +4033,29 @@ export declare enum Action {
|
|
|
3910
4033
|
*/
|
|
3911
4034
|
MarkAsVerified = "markAsVerified",
|
|
3912
4035
|
/**
|
|
3913
|
-
* @version SDK: 1.
|
|
4036
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3914
4037
|
*/
|
|
3915
4038
|
AddTab = "addTab",
|
|
3916
4039
|
/**
|
|
3917
4040
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
3918
4041
|
*/
|
|
3919
|
-
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
|
|
4042
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
4043
|
+
/**
|
|
4044
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4045
|
+
*/
|
|
4046
|
+
ShowSageQuery = "showSageQuery",
|
|
4047
|
+
/**
|
|
4048
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4049
|
+
*/
|
|
4050
|
+
EditSageAnswer = "editSageAnswer",
|
|
4051
|
+
/**
|
|
4052
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4053
|
+
*/
|
|
4054
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
4055
|
+
/**
|
|
4056
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4057
|
+
*/
|
|
4058
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
3920
4059
|
}
|
|
3921
4060
|
export interface SessionInterface {
|
|
3922
4061
|
sessionId: string;
|