@thoughtspot/visual-embed-sdk 1.23.0 → 1.23.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +1 -3
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/embed/app.d.ts +9 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +3 -2
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +10 -0
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +8 -0
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +8 -0
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +39 -2
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +17 -3
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/sage.spec.js +27 -1
- package/cjs/src/embed/sage.spec.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +1 -1
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search.d.ts +8 -0
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +2 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +11 -1
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/react/index.spec.js +1 -1
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/types.d.ts +380 -248
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +357 -241
- package/cjs/src/types.js.map +1 -1
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +9 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +8 -0
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +39 -2
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +1 -1
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +8 -0
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/types.d.ts +380 -248
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +381 -17448
- package/dist/tsembed-react.js +380 -17447
- package/dist/tsembed.es.js +389 -17448
- package/dist/tsembed.js +388 -17447
- package/dist/visual-embed-sdk-react-full.d.ts +445 -252
- package/dist/visual-embed-sdk-react.d.ts +445 -252
- package/dist/visual-embed-sdk.d.ts +445 -252
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +1 -2
- package/lib/src/auth.js.map +1 -1
- package/lib/src/embed/app.d.ts +9 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +3 -2
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +10 -0
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +8 -0
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +8 -0
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/sage.d.ts +39 -2
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +17 -3
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/sage.spec.js +27 -1
- package/lib/src/embed/sage.spec.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +1 -1
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search.d.ts +8 -0
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +2 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +11 -1
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/react/index.spec.js +1 -1
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +380 -248
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +357 -241
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +445 -252
- package/package.json +1 -1
- package/src/auth.ts +1 -2
- package/src/embed/app.spec.ts +15 -0
- package/src/embed/app.ts +11 -1
- package/src/embed/base.ts +8 -0
- package/src/embed/sage.spec.ts +33 -1
- package/src/embed/sage.ts +59 -4
- package/src/embed/search-bar.tsx +1 -1
- package/src/embed/search.spec.ts +15 -1
- package/src/embed/search.ts +10 -0
- package/src/react/index.spec.tsx +1 -1
- package/src/types.ts +366 -247
|
@@ -123,7 +123,7 @@ export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getIni
|
|
|
123
123
|
/**
|
|
124
124
|
* @group Embed components
|
|
125
125
|
*/
|
|
126
|
-
export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
|
|
126
|
+
export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
|
|
127
127
|
/**
|
|
128
128
|
* The array of data source GUIDs to set on load.
|
|
129
129
|
* Only a single dataSource supported currently.
|
|
@@ -168,15 +168,34 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
168
168
|
* @summary TS Sage embed
|
|
169
169
|
* @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
|
|
170
170
|
*/
|
|
171
|
+
/**
|
|
172
|
+
* Configuration for search options
|
|
173
|
+
*/
|
|
174
|
+
export interface SearchOptions {
|
|
175
|
+
/**
|
|
176
|
+
* The tml string to load the answer
|
|
177
|
+
*/
|
|
178
|
+
searchQuery: string;
|
|
179
|
+
/**
|
|
180
|
+
* Boolean to determine if the search should be executed or not.
|
|
181
|
+
* if it is executed, put the focus on the results.
|
|
182
|
+
* if it’s not executed, put the focus in the search bar - at the end of
|
|
183
|
+
* the tokens
|
|
184
|
+
*/
|
|
185
|
+
executeSearch?: boolean;
|
|
186
|
+
}
|
|
171
187
|
/**
|
|
172
188
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
173
189
|
* GPT and LLM.
|
|
174
190
|
*
|
|
191
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
175
192
|
* @group Embed components
|
|
176
193
|
*/
|
|
177
194
|
export interface SageViewConfig extends ViewConfig {
|
|
178
195
|
/**
|
|
179
|
-
* If set to true,
|
|
196
|
+
* If set to true, a list of liveboard and answers related
|
|
197
|
+
* to the natural language search will be shown below the
|
|
198
|
+
* AI generated answer.
|
|
180
199
|
*/
|
|
181
200
|
showObjectResults?: boolean;
|
|
182
201
|
/**
|
|
@@ -188,10 +207,28 @@ export interface SageViewConfig extends ViewConfig {
|
|
|
188
207
|
*/
|
|
189
208
|
hideWorksheetSelector?: boolean;
|
|
190
209
|
/**
|
|
191
|
-
* If set to true, the
|
|
210
|
+
* If set to true, the search suggestions will contain existing
|
|
211
|
+
* liveboards and answers in addition with the autocomplete
|
|
192
212
|
*
|
|
193
213
|
*/
|
|
194
214
|
showObjectSuggestions?: boolean;
|
|
215
|
+
/**
|
|
216
|
+
* The query string to pre-fill in natual language search bar
|
|
217
|
+
*/
|
|
218
|
+
searchQuery?: string;
|
|
219
|
+
/**
|
|
220
|
+
* If set to true, sample questions would be hidden to user.
|
|
221
|
+
* These sample questions are autogenerated based on selected datasource.
|
|
222
|
+
*/
|
|
223
|
+
hideSampleQuestions?: boolean;
|
|
224
|
+
/**
|
|
225
|
+
* The data source GUID to set on load.
|
|
226
|
+
*/
|
|
227
|
+
dataSource?: string;
|
|
228
|
+
/**
|
|
229
|
+
* Configuration for search options
|
|
230
|
+
*/
|
|
231
|
+
searchOptions?: SearchOptions;
|
|
195
232
|
}
|
|
196
233
|
export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
197
234
|
/**
|
|
@@ -316,6 +353,14 @@ export interface SearchViewConfig extends ViewConfig {
|
|
|
316
353
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
317
354
|
*/
|
|
318
355
|
hideSearchBar?: boolean;
|
|
356
|
+
/**
|
|
357
|
+
* Flag to control Data panel experience
|
|
358
|
+
*
|
|
359
|
+
* @default false
|
|
360
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
361
|
+
* @hidden
|
|
362
|
+
*/
|
|
363
|
+
dataPanelV2?: boolean;
|
|
319
364
|
}
|
|
320
365
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
321
366
|
/**
|
|
@@ -377,7 +422,7 @@ export declare enum Page {
|
|
|
377
422
|
/**
|
|
378
423
|
* SpotIQ listing page
|
|
379
424
|
*/
|
|
380
|
-
SpotIQ = "
|
|
425
|
+
SpotIQ = "insights"
|
|
381
426
|
}
|
|
382
427
|
/**
|
|
383
428
|
* The view configuration for full app embedding.
|
|
@@ -447,6 +492,14 @@ export interface AppViewConfig extends ViewConfig {
|
|
|
447
492
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
448
493
|
*/
|
|
449
494
|
fullHeight?: boolean;
|
|
495
|
+
/**
|
|
496
|
+
* Flag to control Data panel experience
|
|
497
|
+
*
|
|
498
|
+
* @default false
|
|
499
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
500
|
+
* @hidden
|
|
501
|
+
*/
|
|
502
|
+
dataPanelV2?: boolean;
|
|
450
503
|
}
|
|
451
504
|
/**
|
|
452
505
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -959,7 +1012,15 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
959
1012
|
* @param fn The function being registered
|
|
960
1013
|
*/
|
|
961
1014
|
export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
1015
|
+
/**
|
|
1016
|
+
* @param data
|
|
1017
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1018
|
+
*/
|
|
962
1019
|
export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
1020
|
+
/**
|
|
1021
|
+
* @param data
|
|
1022
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1023
|
+
*/
|
|
963
1024
|
export declare const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
964
1025
|
/**
|
|
965
1026
|
*
|
|
@@ -1403,6 +1464,9 @@ export interface CustomStyles {
|
|
|
1403
1464
|
export interface CustomisationsInterface {
|
|
1404
1465
|
style?: CustomStyles;
|
|
1405
1466
|
content?: {
|
|
1467
|
+
/**
|
|
1468
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
1469
|
+
*/
|
|
1406
1470
|
strings?: Record<string, any>;
|
|
1407
1471
|
[key: string]: any;
|
|
1408
1472
|
};
|
|
@@ -1810,21 +1874,21 @@ export interface ViewConfig {
|
|
|
1810
1874
|
/**
|
|
1811
1875
|
* Boolean to hide liveboard header
|
|
1812
1876
|
*
|
|
1813
|
-
* @version SDK: 1.
|
|
1877
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1814
1878
|
* @default false
|
|
1815
1879
|
*/
|
|
1816
1880
|
hideLiveboardHeader?: boolean;
|
|
1817
1881
|
/**
|
|
1818
1882
|
* Boolean to show liveboard title
|
|
1819
1883
|
*
|
|
1820
|
-
* @version SDK: 1.
|
|
1884
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1821
1885
|
* @default false
|
|
1822
1886
|
*/
|
|
1823
1887
|
showLiveboardTitle?: boolean;
|
|
1824
1888
|
/**
|
|
1825
1889
|
* Boolean to show liveboard description
|
|
1826
1890
|
*
|
|
1827
|
-
* @version SDK: 1.
|
|
1891
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1828
1892
|
* @default false
|
|
1829
1893
|
*/
|
|
1830
1894
|
showLiveboardDescription?: boolean;
|
|
@@ -1842,7 +1906,7 @@ export interface ViewConfig {
|
|
|
1842
1906
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1843
1907
|
* });
|
|
1844
1908
|
* ```
|
|
1845
|
-
* @version SDK: 1.
|
|
1909
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1846
1910
|
*/
|
|
1847
1911
|
hiddenTabs?: string[];
|
|
1848
1912
|
/**
|
|
@@ -1861,7 +1925,7 @@ export interface ViewConfig {
|
|
|
1861
1925
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1862
1926
|
* });
|
|
1863
1927
|
* ```
|
|
1864
|
-
* @version SDK: 1.
|
|
1928
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1865
1929
|
*/
|
|
1866
1930
|
visibleTabs?: string[];
|
|
1867
1931
|
}
|
|
@@ -2423,7 +2487,19 @@ export declare enum EmbedEvent {
|
|
|
2423
2487
|
*
|
|
2424
2488
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2425
2489
|
*/
|
|
2426
|
-
FilterChanged = "filterChanged"
|
|
2490
|
+
FilterChanged = "filterChanged",
|
|
2491
|
+
/**
|
|
2492
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
2493
|
+
*
|
|
2494
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2495
|
+
*/
|
|
2496
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
2497
|
+
/**
|
|
2498
|
+
* Emitten when a user select data source in Sage Embed
|
|
2499
|
+
*
|
|
2500
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2501
|
+
*/
|
|
2502
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
2427
2503
|
}
|
|
2428
2504
|
/**
|
|
2429
2505
|
* Event types that can be triggered by the host application
|
|
@@ -2452,6 +2528,7 @@ export declare enum HostEvent {
|
|
|
2452
2528
|
* Triggers a search query in AppEmbed and SearchEmbed
|
|
2453
2529
|
* deployments.
|
|
2454
2530
|
* Includes the following properties:
|
|
2531
|
+
*
|
|
2455
2532
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
2456
2533
|
* - Although an array, only a single source
|
|
2457
2534
|
* is supported.
|
|
@@ -2470,6 +2547,7 @@ export declare enum HostEvent {
|
|
|
2470
2547
|
/**
|
|
2471
2548
|
* Triggers a drill on certain points of the specified column
|
|
2472
2549
|
* Includes the following properties:
|
|
2550
|
+
*
|
|
2473
2551
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2474
2552
|
* to drill to. For example, { selectedPoints: []}
|
|
2475
2553
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -2534,18 +2612,19 @@ export declare enum HostEvent {
|
|
|
2534
2612
|
*/
|
|
2535
2613
|
SetActiveTab = "SetActiveTab",
|
|
2536
2614
|
/**
|
|
2537
|
-
|
|
2538
|
-
|
|
2539
|
-
|
|
2540
|
-
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
|
|
2545
|
-
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
|
|
2615
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
2616
|
+
* runtime filters passed here are appended to the existing runtime
|
|
2617
|
+
* filters.
|
|
2618
|
+
* Pass an array of runtime filters with the following attributes:
|
|
2619
|
+
* `columnName`
|
|
2620
|
+
* _String_. The name of the column to filter on.
|
|
2621
|
+
* `operator`
|
|
2622
|
+
* Runtime filter operator to apply. For information,
|
|
2623
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
2624
|
+
* `values`
|
|
2625
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2626
|
+
* operators such as BW and IN accept multiple operands.
|
|
2627
|
+
*
|
|
2549
2628
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2550
2629
|
* @example
|
|
2551
2630
|
* ```js
|
|
@@ -2561,6 +2640,7 @@ export declare enum HostEvent {
|
|
|
2561
2640
|
/**
|
|
2562
2641
|
* Navigate to a specific page in the embedded application without reloading the page.
|
|
2563
2642
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2643
|
+
*
|
|
2564
2644
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
2565
2645
|
* @example
|
|
2566
2646
|
* ```js
|
|
@@ -2884,6 +2964,7 @@ export declare enum HostEvent {
|
|
|
2884
2964
|
/**
|
|
2885
2965
|
* Triggers the **SpotIQ analyze** action on visualization
|
|
2886
2966
|
* or search.
|
|
2967
|
+
*
|
|
2887
2968
|
* @param - Liveboard embed takes `vizId` as a
|
|
2888
2969
|
* key. Can be left undefined when embedding Search or
|
|
2889
2970
|
* visualization.
|
|
@@ -2923,6 +3004,7 @@ export declare enum HostEvent {
|
|
|
2923
3004
|
/**
|
|
2924
3005
|
* Triggers the **Download** > **PNG** action on
|
|
2925
3006
|
* charts in the embedded view.
|
|
3007
|
+
*
|
|
2926
3008
|
* @example
|
|
2927
3009
|
* ```js
|
|
2928
3010
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -2956,6 +3038,7 @@ export declare enum HostEvent {
|
|
|
2956
3038
|
/**
|
|
2957
3039
|
* Triggers the **Download** > **XLSX** action on tables
|
|
2958
3040
|
* in the embedded view.
|
|
3041
|
+
*
|
|
2959
3042
|
* @example
|
|
2960
3043
|
* ```js
|
|
2961
3044
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -2987,6 +3070,7 @@ export declare enum HostEvent {
|
|
|
2987
3070
|
/**
|
|
2988
3071
|
* Triggers the **Save** action on a Liveboard or Answer.
|
|
2989
3072
|
* Saves the changes.
|
|
3073
|
+
*
|
|
2990
3074
|
* @example
|
|
2991
3075
|
* ```js
|
|
2992
3076
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -3000,6 +3084,7 @@ export declare enum HostEvent {
|
|
|
3000
3084
|
/**
|
|
3001
3085
|
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
3002
3086
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
3087
|
+
*
|
|
3003
3088
|
* @param - an object with `vizId` as a key
|
|
3004
3089
|
* @example
|
|
3005
3090
|
* ```js
|
|
@@ -3016,6 +3101,7 @@ export declare enum HostEvent {
|
|
|
3016
3101
|
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
3017
3102
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
3018
3103
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
3104
|
+
*
|
|
3019
3105
|
* @param - an object with vizId as a key
|
|
3020
3106
|
* @example
|
|
3021
3107
|
* ```js
|
|
@@ -3032,6 +3118,7 @@ export declare enum HostEvent {
|
|
|
3032
3118
|
* Triggers the **Manage pipelines** action on an embedded
|
|
3033
3119
|
* visualization or Answer.
|
|
3034
3120
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
3121
|
+
*
|
|
3035
3122
|
* @param - an object with `vizId` as a key
|
|
3036
3123
|
* @example
|
|
3037
3124
|
* ```js
|
|
@@ -3076,6 +3163,19 @@ export declare enum HostEvent {
|
|
|
3076
3163
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3077
3164
|
*/
|
|
3078
3165
|
UpdateFilters = "updateFilters",
|
|
3166
|
+
/**
|
|
3167
|
+
* Get Tab for the current Liveboard.
|
|
3168
|
+
*
|
|
3169
|
+
* @example
|
|
3170
|
+
* ```js
|
|
3171
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
3172
|
+
* console.log(
|
|
3173
|
+
* tabDetails // TabDetails of current LB
|
|
3174
|
+
* );
|
|
3175
|
+
* })
|
|
3176
|
+
* ```
|
|
3177
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
3178
|
+
*/
|
|
3079
3179
|
GetTabs = "getTabs",
|
|
3080
3180
|
/**
|
|
3081
3181
|
* Set the visible Tabs on a Liveboard.
|
|
@@ -3088,7 +3188,7 @@ export declare enum HostEvent {
|
|
|
3088
3188
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
3089
3189
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
3090
3190
|
* ```
|
|
3091
|
-
* @version SDK: 1.
|
|
3191
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3092
3192
|
*/
|
|
3093
3193
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
3094
3194
|
/**
|
|
@@ -3102,9 +3202,23 @@ export declare enum HostEvent {
|
|
|
3102
3202
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
3103
3203
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
3104
3204
|
* ```
|
|
3105
|
-
* @version SDK: 1.
|
|
3205
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3206
|
+
*/
|
|
3207
|
+
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
3208
|
+
/**
|
|
3209
|
+
* Updates the search query for sage embed.
|
|
3210
|
+
*
|
|
3211
|
+
* @param - searchOptions: an object queryString and option to execute the query.
|
|
3212
|
+
* @example
|
|
3213
|
+
* ```js
|
|
3214
|
+
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
3215
|
+
* queryString: 'revenue per year',
|
|
3216
|
+
* executeSearch: true,
|
|
3217
|
+
* })
|
|
3218
|
+
* ```
|
|
3219
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3106
3220
|
*/
|
|
3107
|
-
|
|
3221
|
+
UpdateSageQuery = "updateSageQuery"
|
|
3108
3222
|
}
|
|
3109
3223
|
/**
|
|
3110
3224
|
* The different visual modes that the data sources panel within
|
|
@@ -3159,6 +3273,7 @@ export declare enum Param {
|
|
|
3159
3273
|
DisableLoginRedirect = "disableLoginRedirect",
|
|
3160
3274
|
visibleVizs = "pinboardVisibleVizs",
|
|
3161
3275
|
LiveboardV2Enabled = "isPinboardV2Enabled",
|
|
3276
|
+
DataPanelV2Enabled = "enableDataPanelV2",
|
|
3162
3277
|
ShowAlerts = "showAlerts",
|
|
3163
3278
|
Locale = "locale",
|
|
3164
3279
|
CustomStyle = "customStyle",
|
|
@@ -3184,7 +3299,10 @@ export declare enum Param {
|
|
|
3184
3299
|
ShowLiveboardTitle = "showLiveboardTitle",
|
|
3185
3300
|
HiddenTabs = "hideTabs",
|
|
3186
3301
|
VisibleTabs = "visibleTabs",
|
|
3187
|
-
HideTabPanel = "hideTabPanel"
|
|
3302
|
+
HideTabPanel = "hideTabPanel",
|
|
3303
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
3304
|
+
WorksheetId = "worksheet",
|
|
3305
|
+
Query = "query"
|
|
3188
3306
|
}
|
|
3189
3307
|
/**
|
|
3190
3308
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3193,6 +3311,7 @@ export declare enum Param {
|
|
|
3193
3311
|
* specific actions in the embedded view, define the Action
|
|
3194
3312
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
3195
3313
|
* or `hiddenActions` array.
|
|
3314
|
+
*
|
|
3196
3315
|
* @example
|
|
3197
3316
|
* ```js
|
|
3198
3317
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -3211,12 +3330,12 @@ export declare enum Param {
|
|
|
3211
3330
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
3212
3331
|
* })
|
|
3213
3332
|
* ```
|
|
3214
|
-
|
|
3215
3333
|
*/
|
|
3216
3334
|
export declare enum Action {
|
|
3217
3335
|
/**
|
|
3218
3336
|
* The **Save** action on an Answer or Liveboard.
|
|
3219
3337
|
* Allows users to save the changes.
|
|
3338
|
+
*
|
|
3220
3339
|
* @example
|
|
3221
3340
|
* ```js
|
|
3222
3341
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -3232,136 +3351,146 @@ export declare enum Action {
|
|
|
3232
3351
|
*/
|
|
3233
3352
|
SaveUntitled = "saveUntitled",
|
|
3234
3353
|
/**
|
|
3235
|
-
|
|
3236
|
-
|
|
3237
|
-
|
|
3238
|
-
|
|
3239
|
-
|
|
3240
|
-
|
|
3241
|
-
|
|
3242
|
-
|
|
3354
|
+
* The **Save as View** action on the Answer
|
|
3355
|
+
* page. Saves an Answer as a View object.
|
|
3356
|
+
*
|
|
3357
|
+
* @example
|
|
3358
|
+
* ```js
|
|
3359
|
+
* disabledActions: [Action.SaveAsView]
|
|
3360
|
+
* ```
|
|
3361
|
+
*/
|
|
3243
3362
|
SaveAsView = "saveAsView",
|
|
3244
3363
|
/**
|
|
3245
|
-
|
|
3246
|
-
|
|
3247
|
-
|
|
3248
|
-
|
|
3249
|
-
|
|
3250
|
-
|
|
3251
|
-
|
|
3252
|
-
|
|
3253
|
-
|
|
3254
|
-
|
|
3364
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
3365
|
+
* page.
|
|
3366
|
+
* Creates a copy of the Liveboard, visualization,
|
|
3367
|
+
* or Answer.
|
|
3368
|
+
*
|
|
3369
|
+
* @example
|
|
3370
|
+
* ```js
|
|
3371
|
+
* disabledActions: [Action.MakeACopy]
|
|
3372
|
+
* ```
|
|
3373
|
+
*/
|
|
3255
3374
|
MakeACopy = "makeACopy",
|
|
3256
3375
|
/**
|
|
3257
|
-
|
|
3258
|
-
|
|
3259
|
-
|
|
3260
|
-
|
|
3261
|
-
|
|
3262
|
-
|
|
3263
|
-
|
|
3264
|
-
|
|
3376
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
3377
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
3378
|
+
*
|
|
3379
|
+
* @example
|
|
3380
|
+
* ```js
|
|
3381
|
+
* disabledActions: [Action.EditACopy]
|
|
3382
|
+
* ```
|
|
3383
|
+
*/
|
|
3265
3384
|
EditACopy = "editACopy",
|
|
3266
3385
|
/**
|
|
3267
|
-
|
|
3268
|
-
|
|
3269
|
-
|
|
3270
|
-
|
|
3271
|
-
|
|
3272
|
-
|
|
3273
|
-
|
|
3386
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
3387
|
+
* Copies the visualization URL
|
|
3388
|
+
*
|
|
3389
|
+
* @example
|
|
3390
|
+
* ```js
|
|
3391
|
+
* disabledActions: [Action.CopyLink]
|
|
3392
|
+
* ```
|
|
3393
|
+
*/
|
|
3274
3394
|
CopyLink = "embedDocument",
|
|
3275
3395
|
/**
|
|
3276
3396
|
* @hidden
|
|
3277
3397
|
*/
|
|
3278
3398
|
ResetLayout = "resetLayout",
|
|
3279
3399
|
/**
|
|
3280
|
-
|
|
3281
|
-
|
|
3282
|
-
|
|
3283
|
-
|
|
3284
|
-
|
|
3285
|
-
|
|
3286
|
-
|
|
3400
|
+
* The **Schedule** menu action on a Liveboard.
|
|
3401
|
+
* Allows scheduling a Liveboard notification.
|
|
3402
|
+
*
|
|
3403
|
+
* @example
|
|
3404
|
+
* ```js
|
|
3405
|
+
* disabledActions: [Action.Schedule]
|
|
3406
|
+
* ```
|
|
3407
|
+
*/
|
|
3287
3408
|
Schedule = "subscription",
|
|
3288
3409
|
/**
|
|
3289
|
-
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
|
|
3293
|
-
|
|
3294
|
-
|
|
3295
|
-
|
|
3410
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
3411
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
3412
|
+
*
|
|
3413
|
+
* @example
|
|
3414
|
+
* ```js
|
|
3415
|
+
* disabledActions: [Action.SchedulesList]
|
|
3416
|
+
* ```
|
|
3417
|
+
*/
|
|
3296
3418
|
SchedulesList = "schedule-list",
|
|
3297
3419
|
/**
|
|
3298
|
-
|
|
3299
|
-
|
|
3300
|
-
|
|
3301
|
-
|
|
3302
|
-
|
|
3303
|
-
|
|
3304
|
-
|
|
3420
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
3421
|
+
* Allows users to share an object with other users and groups.
|
|
3422
|
+
*
|
|
3423
|
+
* @example
|
|
3424
|
+
* ```js
|
|
3425
|
+
* disabledActions: [Action.Share]
|
|
3426
|
+
* ```
|
|
3427
|
+
*/
|
|
3305
3428
|
Share = "share",
|
|
3306
3429
|
/**
|
|
3307
|
-
|
|
3308
|
-
|
|
3309
|
-
|
|
3310
|
-
|
|
3311
|
-
|
|
3312
|
-
|
|
3313
|
-
|
|
3430
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
3431
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
3432
|
+
*
|
|
3433
|
+
* @example
|
|
3434
|
+
* ```js
|
|
3435
|
+
* disabledActions: [Action.AddFilter]
|
|
3436
|
+
* ```
|
|
3437
|
+
*/
|
|
3314
3438
|
AddFilter = "addFilter",
|
|
3315
3439
|
/**
|
|
3316
|
-
|
|
3317
|
-
|
|
3318
|
-
|
|
3319
|
-
|
|
3320
|
-
|
|
3321
|
-
|
|
3322
|
-
|
|
3323
|
-
|
|
3440
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
3441
|
+
* Allows configuring filter options when adding filters to a
|
|
3442
|
+
* Liveboard or Answer.
|
|
3443
|
+
*
|
|
3444
|
+
* @example
|
|
3445
|
+
* ```js
|
|
3446
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
3447
|
+
* ```
|
|
3448
|
+
*/
|
|
3324
3449
|
ConfigureFilter = "configureFilter",
|
|
3325
3450
|
CollapseDataSources = "collapseDataSources",
|
|
3326
3451
|
/**
|
|
3327
|
-
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
|
-
|
|
3332
|
-
|
|
3333
|
-
|
|
3452
|
+
* The **Choose sources** button on Search page.
|
|
3453
|
+
* Allows selecting data sources for search queries.
|
|
3454
|
+
*
|
|
3455
|
+
* @example
|
|
3456
|
+
* ```js
|
|
3457
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
3458
|
+
* ```
|
|
3459
|
+
*/
|
|
3334
3460
|
ChooseDataSources = "chooseDataSources",
|
|
3335
3461
|
/**
|
|
3336
|
-
|
|
3337
|
-
|
|
3338
|
-
|
|
3339
|
-
|
|
3340
|
-
|
|
3341
|
-
|
|
3342
|
-
|
|
3462
|
+
* The **Create formula** action on a Search or Answer page.
|
|
3463
|
+
* Allows adding formulas to an Answer.
|
|
3464
|
+
*
|
|
3465
|
+
* @example
|
|
3466
|
+
* ```js
|
|
3467
|
+
* disabledActions: [Action.AddFormula]
|
|
3468
|
+
* ```
|
|
3469
|
+
*/
|
|
3343
3470
|
AddFormula = "addFormula",
|
|
3344
3471
|
/**
|
|
3345
|
-
|
|
3346
|
-
|
|
3347
|
-
|
|
3348
|
-
|
|
3349
|
-
|
|
3350
|
-
|
|
3351
|
-
|
|
3472
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
3473
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
3474
|
+
*
|
|
3475
|
+
* @example
|
|
3476
|
+
* ```js
|
|
3477
|
+
* disabledActions: [Action.AddParameter]
|
|
3478
|
+
* ```
|
|
3479
|
+
*/
|
|
3352
3480
|
AddParameter = "addParameter",
|
|
3353
3481
|
/**
|
|
3354
3482
|
* @hidden
|
|
3355
3483
|
*/
|
|
3356
3484
|
SearchOnTop = "searchOnTop",
|
|
3357
3485
|
/**
|
|
3358
|
-
|
|
3359
|
-
|
|
3360
|
-
|
|
3361
|
-
|
|
3362
|
-
|
|
3363
|
-
|
|
3364
|
-
|
|
3486
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
3487
|
+
* Answer page.
|
|
3488
|
+
*
|
|
3489
|
+
* @example
|
|
3490
|
+
* ```js
|
|
3491
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
3492
|
+
* ```
|
|
3493
|
+
*/
|
|
3365
3494
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3366
3495
|
/**
|
|
3367
3496
|
* @hidden
|
|
@@ -3377,89 +3506,98 @@ export declare enum Action {
|
|
|
3377
3506
|
*/
|
|
3378
3507
|
ReplaySearch = "replaySearch",
|
|
3379
3508
|
/**
|
|
3380
|
-
|
|
3381
|
-
|
|
3382
|
-
|
|
3383
|
-
|
|
3384
|
-
|
|
3385
|
-
|
|
3386
|
-
|
|
3509
|
+
* The **Show underlying data** menu action on a visualization or
|
|
3510
|
+
* Answer page.
|
|
3511
|
+
*
|
|
3512
|
+
* @example
|
|
3513
|
+
* ```js
|
|
3514
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
3515
|
+
* ```
|
|
3516
|
+
*/
|
|
3387
3517
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3388
3518
|
/**
|
|
3389
|
-
|
|
3390
|
-
|
|
3391
|
-
|
|
3392
|
-
|
|
3393
|
-
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
|
|
3519
|
+
* The **Download** menu action on Liveboard visualizations
|
|
3520
|
+
* and Answers.
|
|
3521
|
+
* Allows downloading a visualization or Answer.
|
|
3522
|
+
*
|
|
3523
|
+
* @example
|
|
3524
|
+
* ```js
|
|
3525
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3526
|
+
* ```
|
|
3527
|
+
*/
|
|
3397
3528
|
Download = "download",
|
|
3398
3529
|
/**
|
|
3399
|
-
|
|
3400
|
-
|
|
3401
|
-
|
|
3402
|
-
|
|
3403
|
-
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
|
-
|
|
3530
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3531
|
+
* or Answer page.
|
|
3532
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
3533
|
+
*
|
|
3534
|
+
* @example
|
|
3535
|
+
* ```js
|
|
3536
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3537
|
+
* ```
|
|
3538
|
+
*/
|
|
3407
3539
|
DownloadAsPng = "downloadAsPng",
|
|
3408
3540
|
/**
|
|
3409
|
-
|
|
3410
|
-
|
|
3411
|
-
|
|
3412
|
-
|
|
3413
|
-
|
|
3414
|
-
|
|
3415
|
-
|
|
3541
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3542
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
3543
|
+
*
|
|
3544
|
+
* @example
|
|
3545
|
+
* ```js
|
|
3546
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
3547
|
+
* ```
|
|
3548
|
+
*/
|
|
3416
3549
|
DownloadAsPdf = "downloadAsPdf",
|
|
3417
3550
|
/**
|
|
3418
|
-
|
|
3419
|
-
|
|
3420
|
-
|
|
3421
|
-
|
|
3422
|
-
|
|
3423
|
-
|
|
3424
|
-
|
|
3425
|
-
|
|
3551
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3552
|
+
* or Answer page.
|
|
3553
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3554
|
+
*
|
|
3555
|
+
* @example
|
|
3556
|
+
* ```js
|
|
3557
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
3558
|
+
* ```
|
|
3559
|
+
*/
|
|
3426
3560
|
DownloadAsCsv = "downloadAsCSV",
|
|
3427
3561
|
/**
|
|
3428
|
-
|
|
3429
|
-
|
|
3430
|
-
|
|
3431
|
-
|
|
3432
|
-
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
|
|
3562
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3563
|
+
* or Answer page.
|
|
3564
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3565
|
+
*
|
|
3566
|
+
* @example
|
|
3567
|
+
* ```js
|
|
3568
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
3569
|
+
* ```
|
|
3570
|
+
*/
|
|
3436
3571
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
3437
3572
|
/**
|
|
3438
3573
|
* @hidden
|
|
3439
3574
|
*/
|
|
3440
3575
|
DownloadTrace = "downloadTrace",
|
|
3441
3576
|
/**
|
|
3442
|
-
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
|
|
3448
|
-
|
|
3449
|
-
|
|
3577
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
3578
|
+
* Worksheets and Data Connections page.
|
|
3579
|
+
* Exports an object as a TML file.
|
|
3580
|
+
*
|
|
3581
|
+
* @example
|
|
3582
|
+
* ```js
|
|
3583
|
+
* disabledActions: [Action.ExportTML]
|
|
3584
|
+
* ```
|
|
3585
|
+
*/
|
|
3450
3586
|
ExportTML = "exportTSL",
|
|
3451
3587
|
/**
|
|
3452
|
-
|
|
3453
|
-
|
|
3454
|
-
|
|
3455
|
-
|
|
3456
|
-
|
|
3457
|
-
|
|
3458
|
-
|
|
3588
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
3589
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
3590
|
+
*
|
|
3591
|
+
* @example
|
|
3592
|
+
* ```js
|
|
3593
|
+
* disabledActions: [Action.ImportTML]
|
|
3594
|
+
* ```
|
|
3595
|
+
*/
|
|
3459
3596
|
ImportTML = "importTSL",
|
|
3460
3597
|
/**
|
|
3461
3598
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
3462
3599
|
* Update TML representation of ThoughtSpot objects.
|
|
3600
|
+
*
|
|
3463
3601
|
* @example
|
|
3464
3602
|
* ```js
|
|
3465
3603
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -3469,6 +3607,7 @@ export declare enum Action {
|
|
|
3469
3607
|
/**
|
|
3470
3608
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3471
3609
|
* Opens the TML editor.
|
|
3610
|
+
*
|
|
3472
3611
|
* @example
|
|
3473
3612
|
* ```js
|
|
3474
3613
|
* disabledActions: [Action.EditTML]
|
|
@@ -3476,50 +3615,55 @@ export declare enum Action {
|
|
|
3476
3615
|
*/
|
|
3477
3616
|
EditTML = "editTSL",
|
|
3478
3617
|
/**
|
|
3479
|
-
|
|
3480
|
-
|
|
3481
|
-
|
|
3482
|
-
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3618
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
3619
|
+
* Allows presenting a Liveboard or visualization in
|
|
3620
|
+
* slideshow mode.
|
|
3621
|
+
*
|
|
3622
|
+
* @example
|
|
3623
|
+
* ```js
|
|
3624
|
+
* disabledActions: [Action.Present]
|
|
3625
|
+
* ```
|
|
3626
|
+
*/
|
|
3487
3627
|
Present = "present",
|
|
3488
3628
|
/**
|
|
3489
|
-
|
|
3490
|
-
|
|
3491
|
-
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
3629
|
+
* The tile resize options in the visualization menu.
|
|
3630
|
+
* Allows switching between different preset layouts.
|
|
3631
|
+
*
|
|
3632
|
+
* @example
|
|
3633
|
+
* ```js
|
|
3634
|
+
* disabledActions: [Action.ToggleSize]
|
|
3635
|
+
* ```
|
|
3636
|
+
*/
|
|
3496
3637
|
ToggleSize = "toggleSize",
|
|
3497
3638
|
/**
|
|
3498
|
-
|
|
3499
|
-
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3639
|
+
* The *Edit* action on the Liveboard page and in the
|
|
3640
|
+
* visualization menu.
|
|
3641
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
3642
|
+
*
|
|
3643
|
+
* @example
|
|
3644
|
+
* ```js
|
|
3645
|
+
* disabledActions: [Action.Edit]
|
|
3646
|
+
* ```
|
|
3647
|
+
*/
|
|
3506
3648
|
Edit = "edit",
|
|
3507
3649
|
/**
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3650
|
+
* The text edit option for Liveboard and visualization titles.
|
|
3651
|
+
*
|
|
3652
|
+
* @example
|
|
3653
|
+
* ```js
|
|
3654
|
+
* disabledActions: [Action.EditTitle]
|
|
3655
|
+
* ```
|
|
3656
|
+
*/
|
|
3514
3657
|
EditTitle = "editTitle",
|
|
3515
3658
|
/**
|
|
3516
|
-
|
|
3517
|
-
|
|
3518
|
-
|
|
3519
|
-
|
|
3520
|
-
|
|
3521
|
-
|
|
3522
|
-
|
|
3659
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
3660
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3661
|
+
*
|
|
3662
|
+
* @example
|
|
3663
|
+
* ```js
|
|
3664
|
+
* disabledActions: [Action.Remove]
|
|
3665
|
+
* ```
|
|
3666
|
+
*/
|
|
3523
3667
|
Remove = "delete",
|
|
3524
3668
|
/**
|
|
3525
3669
|
* @hidden
|
|
@@ -3542,15 +3686,16 @@ export declare enum Action {
|
|
|
3542
3686
|
*/
|
|
3543
3687
|
PinboardInfo = "pinboardInfo",
|
|
3544
3688
|
/**
|
|
3545
|
-
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
|
|
3553
|
-
|
|
3689
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
3690
|
+
* Displays details such as the name, description, and
|
|
3691
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3692
|
+
* and update.
|
|
3693
|
+
*
|
|
3694
|
+
* @example
|
|
3695
|
+
* ```js
|
|
3696
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
3697
|
+
* ```
|
|
3698
|
+
*/
|
|
3554
3699
|
LiveboardInfo = "pinboardInfo",
|
|
3555
3700
|
/**
|
|
3556
3701
|
* @hidden
|
|
@@ -3561,13 +3706,14 @@ export declare enum Action {
|
|
|
3561
3706
|
*/
|
|
3562
3707
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
3563
3708
|
/**
|
|
3564
|
-
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
|
|
3709
|
+
* The **Pin** menu action on an Answer or
|
|
3710
|
+
* Search results page.
|
|
3711
|
+
*
|
|
3712
|
+
* @example
|
|
3713
|
+
* ```js
|
|
3714
|
+
* disabledActions: [Action.Pin]
|
|
3715
|
+
* ```
|
|
3716
|
+
*/
|
|
3571
3717
|
Pin = "pin",
|
|
3572
3718
|
/**
|
|
3573
3719
|
* @hidden
|
|
@@ -3575,6 +3721,7 @@ export declare enum Action {
|
|
|
3575
3721
|
AnalysisInfo = "analysisInfo",
|
|
3576
3722
|
/**
|
|
3577
3723
|
* The **Schedule** menu action on a Liveboard.
|
|
3724
|
+
*
|
|
3578
3725
|
* @example
|
|
3579
3726
|
* ```js
|
|
3580
3727
|
* disabledActions: [Action.Subscription]
|
|
@@ -3582,25 +3729,28 @@ export declare enum Action {
|
|
|
3582
3729
|
*/
|
|
3583
3730
|
Subscription = "subscription",
|
|
3584
3731
|
/**
|
|
3585
|
-
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
|
|
3589
|
-
|
|
3590
|
-
|
|
3732
|
+
* The **Explore** action on Liveboard visualizations
|
|
3733
|
+
*
|
|
3734
|
+
* @example
|
|
3735
|
+
* ```js
|
|
3736
|
+
* disabledActions: [Action.Explore]
|
|
3737
|
+
* ```
|
|
3738
|
+
*/
|
|
3591
3739
|
Explore = "explore",
|
|
3592
3740
|
/**
|
|
3593
|
-
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
|
|
3597
|
-
|
|
3598
|
-
|
|
3599
|
-
|
|
3741
|
+
* The action to include data points on a drilled-down Answer
|
|
3742
|
+
* or visualization
|
|
3743
|
+
*
|
|
3744
|
+
* @example
|
|
3745
|
+
* ```js
|
|
3746
|
+
* disabledActions: [Action.DrillInclude]
|
|
3747
|
+
* ```
|
|
3748
|
+
*/
|
|
3600
3749
|
DrillInclude = "context-menu-item-include",
|
|
3601
3750
|
/**
|
|
3602
3751
|
* The action to exclude data points on a drilled-down Answer
|
|
3603
3752
|
* or visualization
|
|
3753
|
+
*
|
|
3604
3754
|
* @example
|
|
3605
3755
|
* ```js
|
|
3606
3756
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3611,6 +3761,7 @@ export declare enum Action {
|
|
|
3611
3761
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3612
3762
|
* or Liveboard.
|
|
3613
3763
|
* Copies the selected data point.
|
|
3764
|
+
*
|
|
3614
3765
|
* @example
|
|
3615
3766
|
* ```js
|
|
3616
3767
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -3628,6 +3779,7 @@ export declare enum Action {
|
|
|
3628
3779
|
* The **Drill down** menu action on Answers and Liveboard
|
|
3629
3780
|
* visualizations.
|
|
3630
3781
|
* Allows drilling down to a specific data point on a chart or table.
|
|
3782
|
+
*
|
|
3631
3783
|
* @example
|
|
3632
3784
|
* ```js
|
|
3633
3785
|
* disabledActions: [Action.DrillDown]
|
|
@@ -3637,6 +3789,7 @@ export declare enum Action {
|
|
|
3637
3789
|
/**
|
|
3638
3790
|
* The request access action on Liveboards.
|
|
3639
3791
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3792
|
+
*
|
|
3640
3793
|
* @example
|
|
3641
3794
|
* ```js
|
|
3642
3795
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -3646,6 +3799,7 @@ export declare enum Action {
|
|
|
3646
3799
|
/**
|
|
3647
3800
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3648
3801
|
* of the Answer page
|
|
3802
|
+
*
|
|
3649
3803
|
* @example
|
|
3650
3804
|
* ```js
|
|
3651
3805
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3654,6 +3808,7 @@ export declare enum Action {
|
|
|
3654
3808
|
QueryDetailsButtons = "QueryDetailsButtons",
|
|
3655
3809
|
/**
|
|
3656
3810
|
* The **Delete** action for Answers.
|
|
3811
|
+
*
|
|
3657
3812
|
* @example
|
|
3658
3813
|
* ```js
|
|
3659
3814
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -3663,6 +3818,7 @@ export declare enum Action {
|
|
|
3663
3818
|
AnswerDelete = "onDeleteAnswer",
|
|
3664
3819
|
/**
|
|
3665
3820
|
* The Chart switcher icon on Answer and visualization pages.
|
|
3821
|
+
*
|
|
3666
3822
|
* @example
|
|
3667
3823
|
* ```js
|
|
3668
3824
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3672,6 +3828,7 @@ export declare enum Action {
|
|
|
3672
3828
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3673
3829
|
/**
|
|
3674
3830
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3831
|
+
*
|
|
3675
3832
|
* @example
|
|
3676
3833
|
* ```js
|
|
3677
3834
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3681,6 +3838,7 @@ export declare enum Action {
|
|
|
3681
3838
|
AddToFavorites = "addToFavorites",
|
|
3682
3839
|
/**
|
|
3683
3840
|
* The edit icon on Liveboards (Classic experience).
|
|
3841
|
+
*
|
|
3684
3842
|
* @example
|
|
3685
3843
|
* ```js
|
|
3686
3844
|
* disabledActions: [Action.EditDetails]
|
|
@@ -3690,6 +3848,7 @@ export declare enum Action {
|
|
|
3690
3848
|
EditDetails = "editDetails",
|
|
3691
3849
|
/**
|
|
3692
3850
|
* The Create alert action on KPI charts.
|
|
3851
|
+
*
|
|
3693
3852
|
* @example
|
|
3694
3853
|
* ```js
|
|
3695
3854
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -3708,6 +3867,7 @@ export declare enum Action {
|
|
|
3708
3867
|
/**
|
|
3709
3868
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3710
3869
|
* Allows sending data to a Google Sheet.
|
|
3870
|
+
*
|
|
3711
3871
|
* @example
|
|
3712
3872
|
* ```js
|
|
3713
3873
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -3719,6 +3879,7 @@ export declare enum Action {
|
|
|
3719
3879
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3720
3880
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3721
3881
|
* Microsoft Teams, and so on.
|
|
3882
|
+
*
|
|
3722
3883
|
* @example
|
|
3723
3884
|
* ```js
|
|
3724
3885
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3729,6 +3890,7 @@ export declare enum Action {
|
|
|
3729
3890
|
/**
|
|
3730
3891
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3731
3892
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
3893
|
+
*
|
|
3732
3894
|
* @example
|
|
3733
3895
|
* ```js
|
|
3734
3896
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3739,6 +3901,7 @@ export declare enum Action {
|
|
|
3739
3901
|
/**
|
|
3740
3902
|
* The **Filter** action on Liveboard visualizations.
|
|
3741
3903
|
* Allows users to apply cross-filters on a Liveboard.
|
|
3904
|
+
*
|
|
3742
3905
|
* @example
|
|
3743
3906
|
* ```js
|
|
3744
3907
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -3750,6 +3913,7 @@ export declare enum Action {
|
|
|
3750
3913
|
* The **Remove** action that appears when cross filters are applied
|
|
3751
3914
|
* on a Liveboard.
|
|
3752
3915
|
* Removes filters applied o a visualization.
|
|
3916
|
+
*
|
|
3753
3917
|
* @example
|
|
3754
3918
|
* ```js
|
|
3755
3919
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3761,6 +3925,7 @@ export declare enum Action {
|
|
|
3761
3925
|
* The **Aggregate** option in the chart axis or the
|
|
3762
3926
|
* table column customization menu.
|
|
3763
3927
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3928
|
+
*
|
|
3764
3929
|
* @example
|
|
3765
3930
|
* ```js
|
|
3766
3931
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3772,6 +3937,7 @@ export declare enum Action {
|
|
|
3772
3937
|
* The **Time bucket** option in the chart axis or table column
|
|
3773
3938
|
* customization menu.
|
|
3774
3939
|
* Allows defining time metric for date comparison.
|
|
3940
|
+
*
|
|
3775
3941
|
* @example
|
|
3776
3942
|
* ```js
|
|
3777
3943
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3782,6 +3948,7 @@ export declare enum Action {
|
|
|
3782
3948
|
/**
|
|
3783
3949
|
* The **Filter** action in the chart axis or table column
|
|
3784
3950
|
* customization menu.
|
|
3951
|
+
*
|
|
3785
3952
|
* @example
|
|
3786
3953
|
* ```js
|
|
3787
3954
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3793,6 +3960,7 @@ export declare enum Action {
|
|
|
3793
3960
|
* The **Conditional formatting** action on chart or table.
|
|
3794
3961
|
* Allows adding rules for conditional formatting of data
|
|
3795
3962
|
* points on a chart or table.
|
|
3963
|
+
*
|
|
3796
3964
|
* @example
|
|
3797
3965
|
* ```js
|
|
3798
3966
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3804,6 +3972,7 @@ export declare enum Action {
|
|
|
3804
3972
|
* The **Sort** menu action on a table or chart axis
|
|
3805
3973
|
* Sorts data in ascending or descending order.
|
|
3806
3974
|
* Allows adding, editing, or removing filters.
|
|
3975
|
+
*
|
|
3807
3976
|
* @example
|
|
3808
3977
|
* ```js
|
|
3809
3978
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3816,6 +3985,7 @@ export declare enum Action {
|
|
|
3816
3985
|
* customization menu.
|
|
3817
3986
|
* Allows grouping data points if the axes use the same
|
|
3818
3987
|
* unit of measurement and a similar scale.
|
|
3988
|
+
*
|
|
3819
3989
|
* @example
|
|
3820
3990
|
* ```js
|
|
3821
3991
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3827,6 +3997,7 @@ export declare enum Action {
|
|
|
3827
3997
|
* The **Position** option in the axis customization menu.
|
|
3828
3998
|
* Allows changing the position of the axis to the
|
|
3829
3999
|
* left or right side of the chart.
|
|
4000
|
+
*
|
|
3830
4001
|
* @example
|
|
3831
4002
|
* ```js
|
|
3832
4003
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3837,6 +4008,7 @@ export declare enum Action {
|
|
|
3837
4008
|
/**
|
|
3838
4009
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3839
4010
|
* Renames the axis label on a chart or the column header on a table.
|
|
4011
|
+
*
|
|
3840
4012
|
* @example
|
|
3841
4013
|
* ```js
|
|
3842
4014
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3848,6 +4020,7 @@ export declare enum Action {
|
|
|
3848
4020
|
* The **Edit** action in the axis customization menu.
|
|
3849
4021
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3850
4022
|
* and format of a column.
|
|
4023
|
+
*
|
|
3851
4024
|
* @example
|
|
3852
4025
|
* ```js
|
|
3853
4026
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3858,6 +4031,7 @@ export declare enum Action {
|
|
|
3858
4031
|
/**
|
|
3859
4032
|
* The **Number format** action to customize the format of
|
|
3860
4033
|
* the data labels on a chart or table.
|
|
4034
|
+
*
|
|
3861
4035
|
* @example
|
|
3862
4036
|
* ```js
|
|
3863
4037
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3868,6 +4042,7 @@ export declare enum Action {
|
|
|
3868
4042
|
/**
|
|
3869
4043
|
* The **Text wrapping** action on a table.
|
|
3870
4044
|
* Wraps or clips column text on a table.
|
|
4045
|
+
*
|
|
3871
4046
|
* @example
|
|
3872
4047
|
* ```js
|
|
3873
4048
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3880,6 +4055,7 @@ export declare enum Action {
|
|
|
3880
4055
|
* customization menu.
|
|
3881
4056
|
* Removes the data labels from a chart or the column of a
|
|
3882
4057
|
* table visualization.
|
|
4058
|
+
*
|
|
3883
4059
|
* @example
|
|
3884
4060
|
* ```js
|
|
3885
4061
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3894,6 +4070,7 @@ export declare enum Action {
|
|
|
3894
4070
|
/**
|
|
3895
4071
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3896
4072
|
* Allows renaming a Liveboard or visualization.
|
|
4073
|
+
*
|
|
3897
4074
|
* @example
|
|
3898
4075
|
* ```js
|
|
3899
4076
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3910,13 +4087,29 @@ export declare enum Action {
|
|
|
3910
4087
|
*/
|
|
3911
4088
|
MarkAsVerified = "markAsVerified",
|
|
3912
4089
|
/**
|
|
3913
|
-
* @version SDK: 1.
|
|
4090
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3914
4091
|
*/
|
|
3915
4092
|
AddTab = "addTab",
|
|
3916
4093
|
/**
|
|
3917
4094
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
3918
4095
|
*/
|
|
3919
|
-
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
|
|
4096
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
4097
|
+
/**
|
|
4098
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4099
|
+
*/
|
|
4100
|
+
ShowSageQuery = "showSageQuery",
|
|
4101
|
+
/**
|
|
4102
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4103
|
+
*/
|
|
4104
|
+
EditSageAnswer = "editSageAnswer",
|
|
4105
|
+
/**
|
|
4106
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4107
|
+
*/
|
|
4108
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
4109
|
+
/**
|
|
4110
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4111
|
+
*/
|
|
4112
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
3920
4113
|
}
|
|
3921
4114
|
export interface SessionInterface {
|
|
3922
4115
|
sessionId: string;
|