@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
|
@@ -112,7 +112,7 @@ export const useEmbedRef: () => React.MutableRefObject<TsEmbed>;
|
|
|
112
112
|
/**
|
|
113
113
|
* @group Embed components
|
|
114
114
|
*/
|
|
115
|
-
export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
|
|
115
|
+
export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
|
|
116
116
|
/**
|
|
117
117
|
* The array of data source GUIDs to set on load.
|
|
118
118
|
* Only a single dataSource supported currently.
|
|
@@ -157,15 +157,34 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
157
157
|
* @summary TS Sage embed
|
|
158
158
|
* @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
|
|
159
159
|
*/
|
|
160
|
+
/**
|
|
161
|
+
* Configuration for search options
|
|
162
|
+
*/
|
|
163
|
+
export interface SearchOptions {
|
|
164
|
+
/**
|
|
165
|
+
* The tml string to load the answer
|
|
166
|
+
*/
|
|
167
|
+
searchQuery: string;
|
|
168
|
+
/**
|
|
169
|
+
* Boolean to determine if the search should be executed or not.
|
|
170
|
+
* if it is executed, put the focus on the results.
|
|
171
|
+
* if it’s not executed, put the focus in the search bar - at the end of
|
|
172
|
+
* the tokens
|
|
173
|
+
*/
|
|
174
|
+
executeSearch?: boolean;
|
|
175
|
+
}
|
|
160
176
|
/**
|
|
161
177
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
162
178
|
* GPT and LLM.
|
|
163
179
|
*
|
|
180
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
164
181
|
* @group Embed components
|
|
165
182
|
*/
|
|
166
183
|
export interface SageViewConfig extends ViewConfig {
|
|
167
184
|
/**
|
|
168
|
-
* If set to true,
|
|
185
|
+
* If set to true, a list of liveboard and answers related
|
|
186
|
+
* to the natural language search will be shown below the
|
|
187
|
+
* AI generated answer.
|
|
169
188
|
*/
|
|
170
189
|
showObjectResults?: boolean;
|
|
171
190
|
/**
|
|
@@ -177,10 +196,28 @@ export interface SageViewConfig extends ViewConfig {
|
|
|
177
196
|
*/
|
|
178
197
|
hideWorksheetSelector?: boolean;
|
|
179
198
|
/**
|
|
180
|
-
* If set to true, the
|
|
199
|
+
* If set to true, the search suggestions will contain existing
|
|
200
|
+
* liveboards and answers in addition with the autocomplete
|
|
181
201
|
*
|
|
182
202
|
*/
|
|
183
203
|
showObjectSuggestions?: boolean;
|
|
204
|
+
/**
|
|
205
|
+
* The query string to pre-fill in natual language search bar
|
|
206
|
+
*/
|
|
207
|
+
searchQuery?: string;
|
|
208
|
+
/**
|
|
209
|
+
* If set to true, sample questions would be hidden to user.
|
|
210
|
+
* These sample questions are autogenerated based on selected datasource.
|
|
211
|
+
*/
|
|
212
|
+
hideSampleQuestions?: boolean;
|
|
213
|
+
/**
|
|
214
|
+
* The data source GUID to set on load.
|
|
215
|
+
*/
|
|
216
|
+
dataSource?: string;
|
|
217
|
+
/**
|
|
218
|
+
* Configuration for search options
|
|
219
|
+
*/
|
|
220
|
+
searchOptions?: SearchOptions;
|
|
184
221
|
}
|
|
185
222
|
export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
186
223
|
/**
|
|
@@ -305,6 +342,14 @@ export interface SearchViewConfig extends ViewConfig {
|
|
|
305
342
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
306
343
|
*/
|
|
307
344
|
hideSearchBar?: boolean;
|
|
345
|
+
/**
|
|
346
|
+
* Flag to control Data panel experience
|
|
347
|
+
*
|
|
348
|
+
* @default false
|
|
349
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
350
|
+
* @hidden
|
|
351
|
+
*/
|
|
352
|
+
dataPanelV2?: boolean;
|
|
308
353
|
}
|
|
309
354
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
310
355
|
/**
|
|
@@ -366,7 +411,7 @@ export declare enum Page {
|
|
|
366
411
|
/**
|
|
367
412
|
* SpotIQ listing page
|
|
368
413
|
*/
|
|
369
|
-
SpotIQ = "
|
|
414
|
+
SpotIQ = "insights"
|
|
370
415
|
}
|
|
371
416
|
/**
|
|
372
417
|
* The view configuration for full app embedding.
|
|
@@ -436,6 +481,14 @@ export interface AppViewConfig extends ViewConfig {
|
|
|
436
481
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
437
482
|
*/
|
|
438
483
|
fullHeight?: boolean;
|
|
484
|
+
/**
|
|
485
|
+
* Flag to control Data panel experience
|
|
486
|
+
*
|
|
487
|
+
* @default false
|
|
488
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
489
|
+
* @hidden
|
|
490
|
+
*/
|
|
491
|
+
dataPanelV2?: boolean;
|
|
439
492
|
}
|
|
440
493
|
/**
|
|
441
494
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -1127,6 +1180,9 @@ export interface CustomStyles {
|
|
|
1127
1180
|
export interface CustomisationsInterface {
|
|
1128
1181
|
style?: CustomStyles;
|
|
1129
1182
|
content?: {
|
|
1183
|
+
/**
|
|
1184
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
1185
|
+
*/
|
|
1130
1186
|
strings?: Record<string, any>;
|
|
1131
1187
|
[key: string]: any;
|
|
1132
1188
|
};
|
|
@@ -1534,21 +1590,21 @@ export interface ViewConfig {
|
|
|
1534
1590
|
/**
|
|
1535
1591
|
* Boolean to hide liveboard header
|
|
1536
1592
|
*
|
|
1537
|
-
* @version SDK: 1.
|
|
1593
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1538
1594
|
* @default false
|
|
1539
1595
|
*/
|
|
1540
1596
|
hideLiveboardHeader?: boolean;
|
|
1541
1597
|
/**
|
|
1542
1598
|
* Boolean to show liveboard title
|
|
1543
1599
|
*
|
|
1544
|
-
* @version SDK: 1.
|
|
1600
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1545
1601
|
* @default false
|
|
1546
1602
|
*/
|
|
1547
1603
|
showLiveboardTitle?: boolean;
|
|
1548
1604
|
/**
|
|
1549
1605
|
* Boolean to show liveboard description
|
|
1550
1606
|
*
|
|
1551
|
-
* @version SDK: 1.
|
|
1607
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1552
1608
|
* @default false
|
|
1553
1609
|
*/
|
|
1554
1610
|
showLiveboardDescription?: boolean;
|
|
@@ -1566,7 +1622,7 @@ export interface ViewConfig {
|
|
|
1566
1622
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1567
1623
|
* });
|
|
1568
1624
|
* ```
|
|
1569
|
-
* @version SDK: 1.
|
|
1625
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1570
1626
|
*/
|
|
1571
1627
|
hiddenTabs?: string[];
|
|
1572
1628
|
/**
|
|
@@ -1585,7 +1641,7 @@ export interface ViewConfig {
|
|
|
1585
1641
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1586
1642
|
* });
|
|
1587
1643
|
* ```
|
|
1588
|
-
* @version SDK: 1.
|
|
1644
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1589
1645
|
*/
|
|
1590
1646
|
visibleTabs?: string[];
|
|
1591
1647
|
}
|
|
@@ -2147,7 +2203,19 @@ export declare enum EmbedEvent {
|
|
|
2147
2203
|
*
|
|
2148
2204
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2149
2205
|
*/
|
|
2150
|
-
FilterChanged = "filterChanged"
|
|
2206
|
+
FilterChanged = "filterChanged",
|
|
2207
|
+
/**
|
|
2208
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
2209
|
+
*
|
|
2210
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2211
|
+
*/
|
|
2212
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
2213
|
+
/**
|
|
2214
|
+
* Emitten when a user select data source in Sage Embed
|
|
2215
|
+
*
|
|
2216
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2217
|
+
*/
|
|
2218
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
2151
2219
|
}
|
|
2152
2220
|
/**
|
|
2153
2221
|
* Event types that can be triggered by the host application
|
|
@@ -2176,6 +2244,7 @@ export declare enum HostEvent {
|
|
|
2176
2244
|
* Triggers a search query in AppEmbed and SearchEmbed
|
|
2177
2245
|
* deployments.
|
|
2178
2246
|
* Includes the following properties:
|
|
2247
|
+
*
|
|
2179
2248
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
2180
2249
|
* - Although an array, only a single source
|
|
2181
2250
|
* is supported.
|
|
@@ -2194,6 +2263,7 @@ export declare enum HostEvent {
|
|
|
2194
2263
|
/**
|
|
2195
2264
|
* Triggers a drill on certain points of the specified column
|
|
2196
2265
|
* Includes the following properties:
|
|
2266
|
+
*
|
|
2197
2267
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2198
2268
|
* to drill to. For example, { selectedPoints: []}
|
|
2199
2269
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -2258,18 +2328,19 @@ export declare enum HostEvent {
|
|
|
2258
2328
|
*/
|
|
2259
2329
|
SetActiveTab = "SetActiveTab",
|
|
2260
2330
|
/**
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
|
|
2331
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
2332
|
+
* runtime filters passed here are appended to the existing runtime
|
|
2333
|
+
* filters.
|
|
2334
|
+
* Pass an array of runtime filters with the following attributes:
|
|
2335
|
+
* `columnName`
|
|
2336
|
+
* _String_. The name of the column to filter on.
|
|
2337
|
+
* `operator`
|
|
2338
|
+
* Runtime filter operator to apply. For information,
|
|
2339
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
2340
|
+
* `values`
|
|
2341
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2342
|
+
* operators such as BW and IN accept multiple operands.
|
|
2343
|
+
*
|
|
2273
2344
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2274
2345
|
* @example
|
|
2275
2346
|
* ```js
|
|
@@ -2285,6 +2356,7 @@ export declare enum HostEvent {
|
|
|
2285
2356
|
/**
|
|
2286
2357
|
* Navigate to a specific page in the embedded application without reloading the page.
|
|
2287
2358
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2359
|
+
*
|
|
2288
2360
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
2289
2361
|
* @example
|
|
2290
2362
|
* ```js
|
|
@@ -2608,6 +2680,7 @@ export declare enum HostEvent {
|
|
|
2608
2680
|
/**
|
|
2609
2681
|
* Triggers the **SpotIQ analyze** action on visualization
|
|
2610
2682
|
* or search.
|
|
2683
|
+
*
|
|
2611
2684
|
* @param - Liveboard embed takes `vizId` as a
|
|
2612
2685
|
* key. Can be left undefined when embedding Search or
|
|
2613
2686
|
* visualization.
|
|
@@ -2647,6 +2720,7 @@ export declare enum HostEvent {
|
|
|
2647
2720
|
/**
|
|
2648
2721
|
* Triggers the **Download** > **PNG** action on
|
|
2649
2722
|
* charts in the embedded view.
|
|
2723
|
+
*
|
|
2650
2724
|
* @example
|
|
2651
2725
|
* ```js
|
|
2652
2726
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -2680,6 +2754,7 @@ export declare enum HostEvent {
|
|
|
2680
2754
|
/**
|
|
2681
2755
|
* Triggers the **Download** > **XLSX** action on tables
|
|
2682
2756
|
* in the embedded view.
|
|
2757
|
+
*
|
|
2683
2758
|
* @example
|
|
2684
2759
|
* ```js
|
|
2685
2760
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -2711,6 +2786,7 @@ export declare enum HostEvent {
|
|
|
2711
2786
|
/**
|
|
2712
2787
|
* Triggers the **Save** action on a Liveboard or Answer.
|
|
2713
2788
|
* Saves the changes.
|
|
2789
|
+
*
|
|
2714
2790
|
* @example
|
|
2715
2791
|
* ```js
|
|
2716
2792
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -2724,6 +2800,7 @@ export declare enum HostEvent {
|
|
|
2724
2800
|
/**
|
|
2725
2801
|
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
2726
2802
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
2803
|
+
*
|
|
2727
2804
|
* @param - an object with `vizId` as a key
|
|
2728
2805
|
* @example
|
|
2729
2806
|
* ```js
|
|
@@ -2740,6 +2817,7 @@ export declare enum HostEvent {
|
|
|
2740
2817
|
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
2741
2818
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
2742
2819
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
2820
|
+
*
|
|
2743
2821
|
* @param - an object with vizId as a key
|
|
2744
2822
|
* @example
|
|
2745
2823
|
* ```js
|
|
@@ -2756,6 +2834,7 @@ export declare enum HostEvent {
|
|
|
2756
2834
|
* Triggers the **Manage pipelines** action on an embedded
|
|
2757
2835
|
* visualization or Answer.
|
|
2758
2836
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
2837
|
+
*
|
|
2759
2838
|
* @param - an object with `vizId` as a key
|
|
2760
2839
|
* @example
|
|
2761
2840
|
* ```js
|
|
@@ -2800,6 +2879,19 @@ export declare enum HostEvent {
|
|
|
2800
2879
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2801
2880
|
*/
|
|
2802
2881
|
UpdateFilters = "updateFilters",
|
|
2882
|
+
/**
|
|
2883
|
+
* Get Tab for the current Liveboard.
|
|
2884
|
+
*
|
|
2885
|
+
* @example
|
|
2886
|
+
* ```js
|
|
2887
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
2888
|
+
* console.log(
|
|
2889
|
+
* tabDetails // TabDetails of current LB
|
|
2890
|
+
* );
|
|
2891
|
+
* })
|
|
2892
|
+
* ```
|
|
2893
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2894
|
+
*/
|
|
2803
2895
|
GetTabs = "getTabs",
|
|
2804
2896
|
/**
|
|
2805
2897
|
* Set the visible Tabs on a Liveboard.
|
|
@@ -2812,7 +2904,7 @@ export declare enum HostEvent {
|
|
|
2812
2904
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
2813
2905
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
2814
2906
|
* ```
|
|
2815
|
-
* @version SDK: 1.
|
|
2907
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2816
2908
|
*/
|
|
2817
2909
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
2818
2910
|
/**
|
|
@@ -2826,9 +2918,23 @@ export declare enum HostEvent {
|
|
|
2826
2918
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
2827
2919
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
2828
2920
|
* ```
|
|
2829
|
-
* @version SDK: 1.
|
|
2921
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2830
2922
|
*/
|
|
2831
|
-
SetHiddenTabs = "SetPinboardHiddenTabs"
|
|
2923
|
+
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
2924
|
+
/**
|
|
2925
|
+
* Updates the search query for sage embed.
|
|
2926
|
+
*
|
|
2927
|
+
* @param - searchOptions: an object queryString and option to execute the query.
|
|
2928
|
+
* @example
|
|
2929
|
+
* ```js
|
|
2930
|
+
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
2931
|
+
* queryString: 'revenue per year',
|
|
2932
|
+
* executeSearch: true,
|
|
2933
|
+
* })
|
|
2934
|
+
* ```
|
|
2935
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2936
|
+
*/
|
|
2937
|
+
UpdateSageQuery = "updateSageQuery"
|
|
2832
2938
|
}
|
|
2833
2939
|
/**
|
|
2834
2940
|
* The different visual modes that the data sources panel within
|
|
@@ -2883,6 +2989,7 @@ export declare enum Param {
|
|
|
2883
2989
|
DisableLoginRedirect = "disableLoginRedirect",
|
|
2884
2990
|
visibleVizs = "pinboardVisibleVizs",
|
|
2885
2991
|
LiveboardV2Enabled = "isPinboardV2Enabled",
|
|
2992
|
+
DataPanelV2Enabled = "enableDataPanelV2",
|
|
2886
2993
|
ShowAlerts = "showAlerts",
|
|
2887
2994
|
Locale = "locale",
|
|
2888
2995
|
CustomStyle = "customStyle",
|
|
@@ -2908,7 +3015,10 @@ export declare enum Param {
|
|
|
2908
3015
|
ShowLiveboardTitle = "showLiveboardTitle",
|
|
2909
3016
|
HiddenTabs = "hideTabs",
|
|
2910
3017
|
VisibleTabs = "visibleTabs",
|
|
2911
|
-
HideTabPanel = "hideTabPanel"
|
|
3018
|
+
HideTabPanel = "hideTabPanel",
|
|
3019
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
3020
|
+
WorksheetId = "worksheet",
|
|
3021
|
+
Query = "query"
|
|
2912
3022
|
}
|
|
2913
3023
|
/**
|
|
2914
3024
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -2917,6 +3027,7 @@ export declare enum Param {
|
|
|
2917
3027
|
* specific actions in the embedded view, define the Action
|
|
2918
3028
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
2919
3029
|
* or `hiddenActions` array.
|
|
3030
|
+
*
|
|
2920
3031
|
* @example
|
|
2921
3032
|
* ```js
|
|
2922
3033
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2935,12 +3046,12 @@ export declare enum Param {
|
|
|
2935
3046
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
2936
3047
|
* })
|
|
2937
3048
|
* ```
|
|
2938
|
-
|
|
2939
3049
|
*/
|
|
2940
3050
|
export declare enum Action {
|
|
2941
3051
|
/**
|
|
2942
3052
|
* The **Save** action on an Answer or Liveboard.
|
|
2943
3053
|
* Allows users to save the changes.
|
|
3054
|
+
*
|
|
2944
3055
|
* @example
|
|
2945
3056
|
* ```js
|
|
2946
3057
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -2956,136 +3067,146 @@ export declare enum Action {
|
|
|
2956
3067
|
*/
|
|
2957
3068
|
SaveUntitled = "saveUntitled",
|
|
2958
3069
|
/**
|
|
2959
|
-
|
|
2960
|
-
|
|
2961
|
-
|
|
2962
|
-
|
|
2963
|
-
|
|
2964
|
-
|
|
2965
|
-
|
|
2966
|
-
|
|
3070
|
+
* The **Save as View** action on the Answer
|
|
3071
|
+
* page. Saves an Answer as a View object.
|
|
3072
|
+
*
|
|
3073
|
+
* @example
|
|
3074
|
+
* ```js
|
|
3075
|
+
* disabledActions: [Action.SaveAsView]
|
|
3076
|
+
* ```
|
|
3077
|
+
*/
|
|
2967
3078
|
SaveAsView = "saveAsView",
|
|
2968
3079
|
/**
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2978
|
-
|
|
3080
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
3081
|
+
* page.
|
|
3082
|
+
* Creates a copy of the Liveboard, visualization,
|
|
3083
|
+
* or Answer.
|
|
3084
|
+
*
|
|
3085
|
+
* @example
|
|
3086
|
+
* ```js
|
|
3087
|
+
* disabledActions: [Action.MakeACopy]
|
|
3088
|
+
* ```
|
|
3089
|
+
*/
|
|
2979
3090
|
MakeACopy = "makeACopy",
|
|
2980
3091
|
/**
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
|
|
2987
|
-
|
|
2988
|
-
|
|
3092
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
3093
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
3094
|
+
*
|
|
3095
|
+
* @example
|
|
3096
|
+
* ```js
|
|
3097
|
+
* disabledActions: [Action.EditACopy]
|
|
3098
|
+
* ```
|
|
3099
|
+
*/
|
|
2989
3100
|
EditACopy = "editACopy",
|
|
2990
3101
|
/**
|
|
2991
|
-
|
|
2992
|
-
|
|
2993
|
-
|
|
2994
|
-
|
|
2995
|
-
|
|
2996
|
-
|
|
2997
|
-
|
|
3102
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
3103
|
+
* Copies the visualization URL
|
|
3104
|
+
*
|
|
3105
|
+
* @example
|
|
3106
|
+
* ```js
|
|
3107
|
+
* disabledActions: [Action.CopyLink]
|
|
3108
|
+
* ```
|
|
3109
|
+
*/
|
|
2998
3110
|
CopyLink = "embedDocument",
|
|
2999
3111
|
/**
|
|
3000
3112
|
* @hidden
|
|
3001
3113
|
*/
|
|
3002
3114
|
ResetLayout = "resetLayout",
|
|
3003
3115
|
/**
|
|
3004
|
-
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
|
|
3116
|
+
* The **Schedule** menu action on a Liveboard.
|
|
3117
|
+
* Allows scheduling a Liveboard notification.
|
|
3118
|
+
*
|
|
3119
|
+
* @example
|
|
3120
|
+
* ```js
|
|
3121
|
+
* disabledActions: [Action.Schedule]
|
|
3122
|
+
* ```
|
|
3123
|
+
*/
|
|
3011
3124
|
Schedule = "subscription",
|
|
3012
3125
|
/**
|
|
3013
|
-
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
|
|
3126
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
3127
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
3128
|
+
*
|
|
3129
|
+
* @example
|
|
3130
|
+
* ```js
|
|
3131
|
+
* disabledActions: [Action.SchedulesList]
|
|
3132
|
+
* ```
|
|
3133
|
+
*/
|
|
3020
3134
|
SchedulesList = "schedule-list",
|
|
3021
3135
|
/**
|
|
3022
|
-
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
|
|
3026
|
-
|
|
3027
|
-
|
|
3028
|
-
|
|
3136
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
3137
|
+
* Allows users to share an object with other users and groups.
|
|
3138
|
+
*
|
|
3139
|
+
* @example
|
|
3140
|
+
* ```js
|
|
3141
|
+
* disabledActions: [Action.Share]
|
|
3142
|
+
* ```
|
|
3143
|
+
*/
|
|
3029
3144
|
Share = "share",
|
|
3030
3145
|
/**
|
|
3031
|
-
|
|
3032
|
-
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
|
|
3146
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
3147
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
3148
|
+
*
|
|
3149
|
+
* @example
|
|
3150
|
+
* ```js
|
|
3151
|
+
* disabledActions: [Action.AddFilter]
|
|
3152
|
+
* ```
|
|
3153
|
+
*/
|
|
3038
3154
|
AddFilter = "addFilter",
|
|
3039
3155
|
/**
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3156
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
3157
|
+
* Allows configuring filter options when adding filters to a
|
|
3158
|
+
* Liveboard or Answer.
|
|
3159
|
+
*
|
|
3160
|
+
* @example
|
|
3161
|
+
* ```js
|
|
3162
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
3163
|
+
* ```
|
|
3164
|
+
*/
|
|
3048
3165
|
ConfigureFilter = "configureFilter",
|
|
3049
3166
|
CollapseDataSources = "collapseDataSources",
|
|
3050
3167
|
/**
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
|
|
3055
|
-
|
|
3056
|
-
|
|
3057
|
-
|
|
3168
|
+
* The **Choose sources** button on Search page.
|
|
3169
|
+
* Allows selecting data sources for search queries.
|
|
3170
|
+
*
|
|
3171
|
+
* @example
|
|
3172
|
+
* ```js
|
|
3173
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
3174
|
+
* ```
|
|
3175
|
+
*/
|
|
3058
3176
|
ChooseDataSources = "chooseDataSources",
|
|
3059
3177
|
/**
|
|
3060
|
-
|
|
3061
|
-
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
|
|
3065
|
-
|
|
3066
|
-
|
|
3178
|
+
* The **Create formula** action on a Search or Answer page.
|
|
3179
|
+
* Allows adding formulas to an Answer.
|
|
3180
|
+
*
|
|
3181
|
+
* @example
|
|
3182
|
+
* ```js
|
|
3183
|
+
* disabledActions: [Action.AddFormula]
|
|
3184
|
+
* ```
|
|
3185
|
+
*/
|
|
3067
3186
|
AddFormula = "addFormula",
|
|
3068
3187
|
/**
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
|
|
3188
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
3189
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
3190
|
+
*
|
|
3191
|
+
* @example
|
|
3192
|
+
* ```js
|
|
3193
|
+
* disabledActions: [Action.AddParameter]
|
|
3194
|
+
* ```
|
|
3195
|
+
*/
|
|
3076
3196
|
AddParameter = "addParameter",
|
|
3077
3197
|
/**
|
|
3078
3198
|
* @hidden
|
|
3079
3199
|
*/
|
|
3080
3200
|
SearchOnTop = "searchOnTop",
|
|
3081
3201
|
/**
|
|
3082
|
-
|
|
3083
|
-
|
|
3084
|
-
|
|
3085
|
-
|
|
3086
|
-
|
|
3087
|
-
|
|
3088
|
-
|
|
3202
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
3203
|
+
* Answer page.
|
|
3204
|
+
*
|
|
3205
|
+
* @example
|
|
3206
|
+
* ```js
|
|
3207
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
3208
|
+
* ```
|
|
3209
|
+
*/
|
|
3089
3210
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3090
3211
|
/**
|
|
3091
3212
|
* @hidden
|
|
@@ -3101,89 +3222,98 @@ export declare enum Action {
|
|
|
3101
3222
|
*/
|
|
3102
3223
|
ReplaySearch = "replaySearch",
|
|
3103
3224
|
/**
|
|
3104
|
-
|
|
3105
|
-
|
|
3106
|
-
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
|
|
3225
|
+
* The **Show underlying data** menu action on a visualization or
|
|
3226
|
+
* Answer page.
|
|
3227
|
+
*
|
|
3228
|
+
* @example
|
|
3229
|
+
* ```js
|
|
3230
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
3231
|
+
* ```
|
|
3232
|
+
*/
|
|
3111
3233
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3112
3234
|
/**
|
|
3113
|
-
|
|
3114
|
-
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
|
|
3120
|
-
|
|
3235
|
+
* The **Download** menu action on Liveboard visualizations
|
|
3236
|
+
* and Answers.
|
|
3237
|
+
* Allows downloading a visualization or Answer.
|
|
3238
|
+
*
|
|
3239
|
+
* @example
|
|
3240
|
+
* ```js
|
|
3241
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3242
|
+
* ```
|
|
3243
|
+
*/
|
|
3121
3244
|
Download = "download",
|
|
3122
3245
|
/**
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
|
|
3127
|
-
|
|
3128
|
-
|
|
3129
|
-
|
|
3130
|
-
|
|
3246
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3247
|
+
* or Answer page.
|
|
3248
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
3249
|
+
*
|
|
3250
|
+
* @example
|
|
3251
|
+
* ```js
|
|
3252
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3253
|
+
* ```
|
|
3254
|
+
*/
|
|
3131
3255
|
DownloadAsPng = "downloadAsPng",
|
|
3132
3256
|
/**
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
|
|
3138
|
-
|
|
3139
|
-
|
|
3257
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3258
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
3259
|
+
*
|
|
3260
|
+
* @example
|
|
3261
|
+
* ```js
|
|
3262
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
3263
|
+
* ```
|
|
3264
|
+
*/
|
|
3140
3265
|
DownloadAsPdf = "downloadAsPdf",
|
|
3141
3266
|
/**
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
|
|
3267
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3268
|
+
* or Answer page.
|
|
3269
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3270
|
+
*
|
|
3271
|
+
* @example
|
|
3272
|
+
* ```js
|
|
3273
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
3274
|
+
* ```
|
|
3275
|
+
*/
|
|
3150
3276
|
DownloadAsCsv = "downloadAsCSV",
|
|
3151
3277
|
/**
|
|
3152
|
-
|
|
3153
|
-
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
|
|
3158
|
-
|
|
3159
|
-
|
|
3278
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3279
|
+
* or Answer page.
|
|
3280
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3281
|
+
*
|
|
3282
|
+
* @example
|
|
3283
|
+
* ```js
|
|
3284
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
3285
|
+
* ```
|
|
3286
|
+
*/
|
|
3160
3287
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
3161
3288
|
/**
|
|
3162
3289
|
* @hidden
|
|
3163
3290
|
*/
|
|
3164
3291
|
DownloadTrace = "downloadTrace",
|
|
3165
3292
|
/**
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3293
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
3294
|
+
* Worksheets and Data Connections page.
|
|
3295
|
+
* Exports an object as a TML file.
|
|
3296
|
+
*
|
|
3297
|
+
* @example
|
|
3298
|
+
* ```js
|
|
3299
|
+
* disabledActions: [Action.ExportTML]
|
|
3300
|
+
* ```
|
|
3301
|
+
*/
|
|
3174
3302
|
ExportTML = "exportTSL",
|
|
3175
3303
|
/**
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
|
|
3304
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
3305
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
3306
|
+
*
|
|
3307
|
+
* @example
|
|
3308
|
+
* ```js
|
|
3309
|
+
* disabledActions: [Action.ImportTML]
|
|
3310
|
+
* ```
|
|
3311
|
+
*/
|
|
3183
3312
|
ImportTML = "importTSL",
|
|
3184
3313
|
/**
|
|
3185
3314
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
3186
3315
|
* Update TML representation of ThoughtSpot objects.
|
|
3316
|
+
*
|
|
3187
3317
|
* @example
|
|
3188
3318
|
* ```js
|
|
3189
3319
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -3193,6 +3323,7 @@ export declare enum Action {
|
|
|
3193
3323
|
/**
|
|
3194
3324
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3195
3325
|
* Opens the TML editor.
|
|
3326
|
+
*
|
|
3196
3327
|
* @example
|
|
3197
3328
|
* ```js
|
|
3198
3329
|
* disabledActions: [Action.EditTML]
|
|
@@ -3200,50 +3331,55 @@ export declare enum Action {
|
|
|
3200
3331
|
*/
|
|
3201
3332
|
EditTML = "editTSL",
|
|
3202
3333
|
/**
|
|
3203
|
-
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
|
|
3207
|
-
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
|
|
3334
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
3335
|
+
* Allows presenting a Liveboard or visualization in
|
|
3336
|
+
* slideshow mode.
|
|
3337
|
+
*
|
|
3338
|
+
* @example
|
|
3339
|
+
* ```js
|
|
3340
|
+
* disabledActions: [Action.Present]
|
|
3341
|
+
* ```
|
|
3342
|
+
*/
|
|
3211
3343
|
Present = "present",
|
|
3212
3344
|
/**
|
|
3213
|
-
|
|
3214
|
-
|
|
3215
|
-
|
|
3216
|
-
|
|
3217
|
-
|
|
3218
|
-
|
|
3219
|
-
|
|
3345
|
+
* The tile resize options in the visualization menu.
|
|
3346
|
+
* Allows switching between different preset layouts.
|
|
3347
|
+
*
|
|
3348
|
+
* @example
|
|
3349
|
+
* ```js
|
|
3350
|
+
* disabledActions: [Action.ToggleSize]
|
|
3351
|
+
* ```
|
|
3352
|
+
*/
|
|
3220
3353
|
ToggleSize = "toggleSize",
|
|
3221
3354
|
/**
|
|
3222
|
-
|
|
3223
|
-
|
|
3224
|
-
|
|
3225
|
-
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
|
-
|
|
3229
|
-
|
|
3355
|
+
* The *Edit* action on the Liveboard page and in the
|
|
3356
|
+
* visualization menu.
|
|
3357
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
3358
|
+
*
|
|
3359
|
+
* @example
|
|
3360
|
+
* ```js
|
|
3361
|
+
* disabledActions: [Action.Edit]
|
|
3362
|
+
* ```
|
|
3363
|
+
*/
|
|
3230
3364
|
Edit = "edit",
|
|
3231
3365
|
/**
|
|
3232
|
-
|
|
3233
|
-
|
|
3234
|
-
|
|
3235
|
-
|
|
3236
|
-
|
|
3237
|
-
|
|
3366
|
+
* The text edit option for Liveboard and visualization titles.
|
|
3367
|
+
*
|
|
3368
|
+
* @example
|
|
3369
|
+
* ```js
|
|
3370
|
+
* disabledActions: [Action.EditTitle]
|
|
3371
|
+
* ```
|
|
3372
|
+
*/
|
|
3238
3373
|
EditTitle = "editTitle",
|
|
3239
3374
|
/**
|
|
3240
|
-
|
|
3241
|
-
|
|
3242
|
-
|
|
3243
|
-
|
|
3244
|
-
|
|
3245
|
-
|
|
3246
|
-
|
|
3375
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
3376
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3377
|
+
*
|
|
3378
|
+
* @example
|
|
3379
|
+
* ```js
|
|
3380
|
+
* disabledActions: [Action.Remove]
|
|
3381
|
+
* ```
|
|
3382
|
+
*/
|
|
3247
3383
|
Remove = "delete",
|
|
3248
3384
|
/**
|
|
3249
3385
|
* @hidden
|
|
@@ -3266,15 +3402,16 @@ export declare enum Action {
|
|
|
3266
3402
|
*/
|
|
3267
3403
|
PinboardInfo = "pinboardInfo",
|
|
3268
3404
|
/**
|
|
3269
|
-
|
|
3270
|
-
|
|
3271
|
-
|
|
3272
|
-
|
|
3273
|
-
|
|
3274
|
-
|
|
3275
|
-
|
|
3276
|
-
|
|
3277
|
-
|
|
3405
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
3406
|
+
* Displays details such as the name, description, and
|
|
3407
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3408
|
+
* and update.
|
|
3409
|
+
*
|
|
3410
|
+
* @example
|
|
3411
|
+
* ```js
|
|
3412
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
3413
|
+
* ```
|
|
3414
|
+
*/
|
|
3278
3415
|
LiveboardInfo = "pinboardInfo",
|
|
3279
3416
|
/**
|
|
3280
3417
|
* @hidden
|
|
@@ -3285,13 +3422,14 @@ export declare enum Action {
|
|
|
3285
3422
|
*/
|
|
3286
3423
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
3287
3424
|
/**
|
|
3288
|
-
|
|
3289
|
-
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
|
|
3293
|
-
|
|
3294
|
-
|
|
3425
|
+
* The **Pin** menu action on an Answer or
|
|
3426
|
+
* Search results page.
|
|
3427
|
+
*
|
|
3428
|
+
* @example
|
|
3429
|
+
* ```js
|
|
3430
|
+
* disabledActions: [Action.Pin]
|
|
3431
|
+
* ```
|
|
3432
|
+
*/
|
|
3295
3433
|
Pin = "pin",
|
|
3296
3434
|
/**
|
|
3297
3435
|
* @hidden
|
|
@@ -3299,6 +3437,7 @@ export declare enum Action {
|
|
|
3299
3437
|
AnalysisInfo = "analysisInfo",
|
|
3300
3438
|
/**
|
|
3301
3439
|
* The **Schedule** menu action on a Liveboard.
|
|
3440
|
+
*
|
|
3302
3441
|
* @example
|
|
3303
3442
|
* ```js
|
|
3304
3443
|
* disabledActions: [Action.Subscription]
|
|
@@ -3306,25 +3445,28 @@ export declare enum Action {
|
|
|
3306
3445
|
*/
|
|
3307
3446
|
Subscription = "subscription",
|
|
3308
3447
|
/**
|
|
3309
|
-
|
|
3310
|
-
|
|
3311
|
-
|
|
3312
|
-
|
|
3313
|
-
|
|
3314
|
-
|
|
3448
|
+
* The **Explore** action on Liveboard visualizations
|
|
3449
|
+
*
|
|
3450
|
+
* @example
|
|
3451
|
+
* ```js
|
|
3452
|
+
* disabledActions: [Action.Explore]
|
|
3453
|
+
* ```
|
|
3454
|
+
*/
|
|
3315
3455
|
Explore = "explore",
|
|
3316
3456
|
/**
|
|
3317
|
-
|
|
3318
|
-
|
|
3319
|
-
|
|
3320
|
-
|
|
3321
|
-
|
|
3322
|
-
|
|
3323
|
-
|
|
3457
|
+
* The action to include data points on a drilled-down Answer
|
|
3458
|
+
* or visualization
|
|
3459
|
+
*
|
|
3460
|
+
* @example
|
|
3461
|
+
* ```js
|
|
3462
|
+
* disabledActions: [Action.DrillInclude]
|
|
3463
|
+
* ```
|
|
3464
|
+
*/
|
|
3324
3465
|
DrillInclude = "context-menu-item-include",
|
|
3325
3466
|
/**
|
|
3326
3467
|
* The action to exclude data points on a drilled-down Answer
|
|
3327
3468
|
* or visualization
|
|
3469
|
+
*
|
|
3328
3470
|
* @example
|
|
3329
3471
|
* ```js
|
|
3330
3472
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3335,6 +3477,7 @@ export declare enum Action {
|
|
|
3335
3477
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3336
3478
|
* or Liveboard.
|
|
3337
3479
|
* Copies the selected data point.
|
|
3480
|
+
*
|
|
3338
3481
|
* @example
|
|
3339
3482
|
* ```js
|
|
3340
3483
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -3352,6 +3495,7 @@ export declare enum Action {
|
|
|
3352
3495
|
* The **Drill down** menu action on Answers and Liveboard
|
|
3353
3496
|
* visualizations.
|
|
3354
3497
|
* Allows drilling down to a specific data point on a chart or table.
|
|
3498
|
+
*
|
|
3355
3499
|
* @example
|
|
3356
3500
|
* ```js
|
|
3357
3501
|
* disabledActions: [Action.DrillDown]
|
|
@@ -3361,6 +3505,7 @@ export declare enum Action {
|
|
|
3361
3505
|
/**
|
|
3362
3506
|
* The request access action on Liveboards.
|
|
3363
3507
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3508
|
+
*
|
|
3364
3509
|
* @example
|
|
3365
3510
|
* ```js
|
|
3366
3511
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -3370,6 +3515,7 @@ export declare enum Action {
|
|
|
3370
3515
|
/**
|
|
3371
3516
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3372
3517
|
* of the Answer page
|
|
3518
|
+
*
|
|
3373
3519
|
* @example
|
|
3374
3520
|
* ```js
|
|
3375
3521
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3378,6 +3524,7 @@ export declare enum Action {
|
|
|
3378
3524
|
QueryDetailsButtons = "QueryDetailsButtons",
|
|
3379
3525
|
/**
|
|
3380
3526
|
* The **Delete** action for Answers.
|
|
3527
|
+
*
|
|
3381
3528
|
* @example
|
|
3382
3529
|
* ```js
|
|
3383
3530
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -3387,6 +3534,7 @@ export declare enum Action {
|
|
|
3387
3534
|
AnswerDelete = "onDeleteAnswer",
|
|
3388
3535
|
/**
|
|
3389
3536
|
* The Chart switcher icon on Answer and visualization pages.
|
|
3537
|
+
*
|
|
3390
3538
|
* @example
|
|
3391
3539
|
* ```js
|
|
3392
3540
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3396,6 +3544,7 @@ export declare enum Action {
|
|
|
3396
3544
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3397
3545
|
/**
|
|
3398
3546
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3547
|
+
*
|
|
3399
3548
|
* @example
|
|
3400
3549
|
* ```js
|
|
3401
3550
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3405,6 +3554,7 @@ export declare enum Action {
|
|
|
3405
3554
|
AddToFavorites = "addToFavorites",
|
|
3406
3555
|
/**
|
|
3407
3556
|
* The edit icon on Liveboards (Classic experience).
|
|
3557
|
+
*
|
|
3408
3558
|
* @example
|
|
3409
3559
|
* ```js
|
|
3410
3560
|
* disabledActions: [Action.EditDetails]
|
|
@@ -3414,6 +3564,7 @@ export declare enum Action {
|
|
|
3414
3564
|
EditDetails = "editDetails",
|
|
3415
3565
|
/**
|
|
3416
3566
|
* The Create alert action on KPI charts.
|
|
3567
|
+
*
|
|
3417
3568
|
* @example
|
|
3418
3569
|
* ```js
|
|
3419
3570
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -3432,6 +3583,7 @@ export declare enum Action {
|
|
|
3432
3583
|
/**
|
|
3433
3584
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3434
3585
|
* Allows sending data to a Google Sheet.
|
|
3586
|
+
*
|
|
3435
3587
|
* @example
|
|
3436
3588
|
* ```js
|
|
3437
3589
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -3443,6 +3595,7 @@ export declare enum Action {
|
|
|
3443
3595
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3444
3596
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3445
3597
|
* Microsoft Teams, and so on.
|
|
3598
|
+
*
|
|
3446
3599
|
* @example
|
|
3447
3600
|
* ```js
|
|
3448
3601
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3453,6 +3606,7 @@ export declare enum Action {
|
|
|
3453
3606
|
/**
|
|
3454
3607
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3455
3608
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
3609
|
+
*
|
|
3456
3610
|
* @example
|
|
3457
3611
|
* ```js
|
|
3458
3612
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3463,6 +3617,7 @@ export declare enum Action {
|
|
|
3463
3617
|
/**
|
|
3464
3618
|
* The **Filter** action on Liveboard visualizations.
|
|
3465
3619
|
* Allows users to apply cross-filters on a Liveboard.
|
|
3620
|
+
*
|
|
3466
3621
|
* @example
|
|
3467
3622
|
* ```js
|
|
3468
3623
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -3474,6 +3629,7 @@ export declare enum Action {
|
|
|
3474
3629
|
* The **Remove** action that appears when cross filters are applied
|
|
3475
3630
|
* on a Liveboard.
|
|
3476
3631
|
* Removes filters applied o a visualization.
|
|
3632
|
+
*
|
|
3477
3633
|
* @example
|
|
3478
3634
|
* ```js
|
|
3479
3635
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3485,6 +3641,7 @@ export declare enum Action {
|
|
|
3485
3641
|
* The **Aggregate** option in the chart axis or the
|
|
3486
3642
|
* table column customization menu.
|
|
3487
3643
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3644
|
+
*
|
|
3488
3645
|
* @example
|
|
3489
3646
|
* ```js
|
|
3490
3647
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3496,6 +3653,7 @@ export declare enum Action {
|
|
|
3496
3653
|
* The **Time bucket** option in the chart axis or table column
|
|
3497
3654
|
* customization menu.
|
|
3498
3655
|
* Allows defining time metric for date comparison.
|
|
3656
|
+
*
|
|
3499
3657
|
* @example
|
|
3500
3658
|
* ```js
|
|
3501
3659
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3506,6 +3664,7 @@ export declare enum Action {
|
|
|
3506
3664
|
/**
|
|
3507
3665
|
* The **Filter** action in the chart axis or table column
|
|
3508
3666
|
* customization menu.
|
|
3667
|
+
*
|
|
3509
3668
|
* @example
|
|
3510
3669
|
* ```js
|
|
3511
3670
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3517,6 +3676,7 @@ export declare enum Action {
|
|
|
3517
3676
|
* The **Conditional formatting** action on chart or table.
|
|
3518
3677
|
* Allows adding rules for conditional formatting of data
|
|
3519
3678
|
* points on a chart or table.
|
|
3679
|
+
*
|
|
3520
3680
|
* @example
|
|
3521
3681
|
* ```js
|
|
3522
3682
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3528,6 +3688,7 @@ export declare enum Action {
|
|
|
3528
3688
|
* The **Sort** menu action on a table or chart axis
|
|
3529
3689
|
* Sorts data in ascending or descending order.
|
|
3530
3690
|
* Allows adding, editing, or removing filters.
|
|
3691
|
+
*
|
|
3531
3692
|
* @example
|
|
3532
3693
|
* ```js
|
|
3533
3694
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3540,6 +3701,7 @@ export declare enum Action {
|
|
|
3540
3701
|
* customization menu.
|
|
3541
3702
|
* Allows grouping data points if the axes use the same
|
|
3542
3703
|
* unit of measurement and a similar scale.
|
|
3704
|
+
*
|
|
3543
3705
|
* @example
|
|
3544
3706
|
* ```js
|
|
3545
3707
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3551,6 +3713,7 @@ export declare enum Action {
|
|
|
3551
3713
|
* The **Position** option in the axis customization menu.
|
|
3552
3714
|
* Allows changing the position of the axis to the
|
|
3553
3715
|
* left or right side of the chart.
|
|
3716
|
+
*
|
|
3554
3717
|
* @example
|
|
3555
3718
|
* ```js
|
|
3556
3719
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3561,6 +3724,7 @@ export declare enum Action {
|
|
|
3561
3724
|
/**
|
|
3562
3725
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3563
3726
|
* Renames the axis label on a chart or the column header on a table.
|
|
3727
|
+
*
|
|
3564
3728
|
* @example
|
|
3565
3729
|
* ```js
|
|
3566
3730
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3572,6 +3736,7 @@ export declare enum Action {
|
|
|
3572
3736
|
* The **Edit** action in the axis customization menu.
|
|
3573
3737
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3574
3738
|
* and format of a column.
|
|
3739
|
+
*
|
|
3575
3740
|
* @example
|
|
3576
3741
|
* ```js
|
|
3577
3742
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3582,6 +3747,7 @@ export declare enum Action {
|
|
|
3582
3747
|
/**
|
|
3583
3748
|
* The **Number format** action to customize the format of
|
|
3584
3749
|
* the data labels on a chart or table.
|
|
3750
|
+
*
|
|
3585
3751
|
* @example
|
|
3586
3752
|
* ```js
|
|
3587
3753
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3592,6 +3758,7 @@ export declare enum Action {
|
|
|
3592
3758
|
/**
|
|
3593
3759
|
* The **Text wrapping** action on a table.
|
|
3594
3760
|
* Wraps or clips column text on a table.
|
|
3761
|
+
*
|
|
3595
3762
|
* @example
|
|
3596
3763
|
* ```js
|
|
3597
3764
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3604,6 +3771,7 @@ export declare enum Action {
|
|
|
3604
3771
|
* customization menu.
|
|
3605
3772
|
* Removes the data labels from a chart or the column of a
|
|
3606
3773
|
* table visualization.
|
|
3774
|
+
*
|
|
3607
3775
|
* @example
|
|
3608
3776
|
* ```js
|
|
3609
3777
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3618,6 +3786,7 @@ export declare enum Action {
|
|
|
3618
3786
|
/**
|
|
3619
3787
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3620
3788
|
* Allows renaming a Liveboard or visualization.
|
|
3789
|
+
*
|
|
3621
3790
|
* @example
|
|
3622
3791
|
* ```js
|
|
3623
3792
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3634,13 +3803,29 @@ export declare enum Action {
|
|
|
3634
3803
|
*/
|
|
3635
3804
|
MarkAsVerified = "markAsVerified",
|
|
3636
3805
|
/**
|
|
3637
|
-
* @version SDK: 1.
|
|
3806
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3638
3807
|
*/
|
|
3639
3808
|
AddTab = "addTab",
|
|
3640
3809
|
/**
|
|
3641
3810
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
3642
3811
|
*/
|
|
3643
|
-
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
|
|
3812
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
3813
|
+
/**
|
|
3814
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3815
|
+
*/
|
|
3816
|
+
ShowSageQuery = "showSageQuery",
|
|
3817
|
+
/**
|
|
3818
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3819
|
+
*/
|
|
3820
|
+
EditSageAnswer = "editSageAnswer",
|
|
3821
|
+
/**
|
|
3822
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3823
|
+
*/
|
|
3824
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
3825
|
+
/**
|
|
3826
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3827
|
+
*/
|
|
3828
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
3644
3829
|
}
|
|
3645
3830
|
export interface SessionInterface {
|
|
3646
3831
|
sessionId: string;
|
|
@@ -3757,7 +3942,15 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
3757
3942
|
* @param fn The function being registered
|
|
3758
3943
|
*/
|
|
3759
3944
|
export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
3945
|
+
/**
|
|
3946
|
+
* @param data
|
|
3947
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3948
|
+
*/
|
|
3760
3949
|
export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
3950
|
+
/**
|
|
3951
|
+
* @param data
|
|
3952
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3953
|
+
*/
|
|
3761
3954
|
export declare const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
3762
3955
|
/**
|
|
3763
3956
|
*
|