@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
|
@@ -68,7 +68,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
|
|
|
68
68
|
/**
|
|
69
69
|
* SpotIQ listing page
|
|
70
70
|
*/
|
|
71
|
-
SpotIQ = "
|
|
71
|
+
SpotIQ = "insights"
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
74
|
* The view configuration for full app embedding.
|
|
@@ -138,6 +138,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
|
|
|
138
138
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
139
139
|
*/
|
|
140
140
|
fullHeight?: boolean;
|
|
141
|
+
/**
|
|
142
|
+
* Flag to control Data panel experience
|
|
143
|
+
*
|
|
144
|
+
* @default false
|
|
145
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
146
|
+
* @hidden
|
|
147
|
+
*/
|
|
148
|
+
dataPanelV2?: boolean;
|
|
141
149
|
}
|
|
142
150
|
/**
|
|
143
151
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -271,7 +279,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
|
|
|
271
279
|
* @param fn The function being registered
|
|
272
280
|
*/
|
|
273
281
|
export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
282
|
+
/**
|
|
283
|
+
* @param data
|
|
284
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
285
|
+
*/
|
|
274
286
|
export const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
287
|
+
/**
|
|
288
|
+
* @param data
|
|
289
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
290
|
+
*/
|
|
275
291
|
export const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
276
292
|
/**
|
|
277
293
|
*
|
|
@@ -518,6 +534,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
|
|
|
518
534
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
519
535
|
*/
|
|
520
536
|
hideSearchBar?: boolean;
|
|
537
|
+
/**
|
|
538
|
+
* Flag to control Data panel experience
|
|
539
|
+
*
|
|
540
|
+
* @default false
|
|
541
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
542
|
+
* @hidden
|
|
543
|
+
*/
|
|
544
|
+
dataPanelV2?: boolean;
|
|
521
545
|
}
|
|
522
546
|
export const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
523
547
|
/**
|
|
@@ -546,7 +570,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
|
|
|
546
570
|
/**
|
|
547
571
|
* @group Embed components
|
|
548
572
|
*/
|
|
549
|
-
export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
|
|
573
|
+
export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
|
|
550
574
|
/**
|
|
551
575
|
* The array of data source GUIDs to set on load.
|
|
552
576
|
* Only a single dataSource supported currently.
|
|
@@ -1027,6 +1051,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1027
1051
|
export interface CustomisationsInterface {
|
|
1028
1052
|
style?: CustomStyles;
|
|
1029
1053
|
content?: {
|
|
1054
|
+
/**
|
|
1055
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
1056
|
+
*/
|
|
1030
1057
|
strings?: Record<string, any>;
|
|
1031
1058
|
[key: string]: any;
|
|
1032
1059
|
};
|
|
@@ -1434,21 +1461,21 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1434
1461
|
/**
|
|
1435
1462
|
* Boolean to hide liveboard header
|
|
1436
1463
|
*
|
|
1437
|
-
* @version SDK: 1.
|
|
1464
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1438
1465
|
* @default false
|
|
1439
1466
|
*/
|
|
1440
1467
|
hideLiveboardHeader?: boolean;
|
|
1441
1468
|
/**
|
|
1442
1469
|
* Boolean to show liveboard title
|
|
1443
1470
|
*
|
|
1444
|
-
* @version SDK: 1.
|
|
1471
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1445
1472
|
* @default false
|
|
1446
1473
|
*/
|
|
1447
1474
|
showLiveboardTitle?: boolean;
|
|
1448
1475
|
/**
|
|
1449
1476
|
* Boolean to show liveboard description
|
|
1450
1477
|
*
|
|
1451
|
-
* @version SDK: 1.
|
|
1478
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1452
1479
|
* @default false
|
|
1453
1480
|
*/
|
|
1454
1481
|
showLiveboardDescription?: boolean;
|
|
@@ -1466,7 +1493,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1466
1493
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1467
1494
|
* });
|
|
1468
1495
|
* ```
|
|
1469
|
-
* @version SDK: 1.
|
|
1496
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1470
1497
|
*/
|
|
1471
1498
|
hiddenTabs?: string[];
|
|
1472
1499
|
/**
|
|
@@ -1485,7 +1512,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1485
1512
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1486
1513
|
* });
|
|
1487
1514
|
* ```
|
|
1488
|
-
* @version SDK: 1.
|
|
1515
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1489
1516
|
*/
|
|
1490
1517
|
visibleTabs?: string[];
|
|
1491
1518
|
}
|
|
@@ -2047,7 +2074,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2047
2074
|
*
|
|
2048
2075
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2049
2076
|
*/
|
|
2050
|
-
FilterChanged = "filterChanged"
|
|
2077
|
+
FilterChanged = "filterChanged",
|
|
2078
|
+
/**
|
|
2079
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
2080
|
+
*
|
|
2081
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2082
|
+
*/
|
|
2083
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
2084
|
+
/**
|
|
2085
|
+
* Emitten when a user select data source in Sage Embed
|
|
2086
|
+
*
|
|
2087
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2088
|
+
*/
|
|
2089
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
2051
2090
|
}
|
|
2052
2091
|
/**
|
|
2053
2092
|
* Event types that can be triggered by the host application
|
|
@@ -2076,6 +2115,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2076
2115
|
* Triggers a search query in AppEmbed and SearchEmbed
|
|
2077
2116
|
* deployments.
|
|
2078
2117
|
* Includes the following properties:
|
|
2118
|
+
*
|
|
2079
2119
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
2080
2120
|
* - Although an array, only a single source
|
|
2081
2121
|
* is supported.
|
|
@@ -2094,6 +2134,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2094
2134
|
/**
|
|
2095
2135
|
* Triggers a drill on certain points of the specified column
|
|
2096
2136
|
* Includes the following properties:
|
|
2137
|
+
*
|
|
2097
2138
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2098
2139
|
* to drill to. For example, { selectedPoints: []}
|
|
2099
2140
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -2158,18 +2199,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2158
2199
|
*/
|
|
2159
2200
|
SetActiveTab = "SetActiveTab",
|
|
2160
2201
|
/**
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2202
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
2203
|
+
* runtime filters passed here are appended to the existing runtime
|
|
2204
|
+
* filters.
|
|
2205
|
+
* Pass an array of runtime filters with the following attributes:
|
|
2206
|
+
* `columnName`
|
|
2207
|
+
* _String_. The name of the column to filter on.
|
|
2208
|
+
* `operator`
|
|
2209
|
+
* Runtime filter operator to apply. For information,
|
|
2210
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
2211
|
+
* `values`
|
|
2212
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2213
|
+
* operators such as BW and IN accept multiple operands.
|
|
2214
|
+
*
|
|
2173
2215
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2174
2216
|
* @example
|
|
2175
2217
|
* ```js
|
|
@@ -2185,6 +2227,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2185
2227
|
/**
|
|
2186
2228
|
* Navigate to a specific page in the embedded application without reloading the page.
|
|
2187
2229
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2230
|
+
*
|
|
2188
2231
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
2189
2232
|
* @example
|
|
2190
2233
|
* ```js
|
|
@@ -2508,6 +2551,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2508
2551
|
/**
|
|
2509
2552
|
* Triggers the **SpotIQ analyze** action on visualization
|
|
2510
2553
|
* or search.
|
|
2554
|
+
*
|
|
2511
2555
|
* @param - Liveboard embed takes `vizId` as a
|
|
2512
2556
|
* key. Can be left undefined when embedding Search or
|
|
2513
2557
|
* visualization.
|
|
@@ -2547,6 +2591,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2547
2591
|
/**
|
|
2548
2592
|
* Triggers the **Download** > **PNG** action on
|
|
2549
2593
|
* charts in the embedded view.
|
|
2594
|
+
*
|
|
2550
2595
|
* @example
|
|
2551
2596
|
* ```js
|
|
2552
2597
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -2580,6 +2625,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2580
2625
|
/**
|
|
2581
2626
|
* Triggers the **Download** > **XLSX** action on tables
|
|
2582
2627
|
* in the embedded view.
|
|
2628
|
+
*
|
|
2583
2629
|
* @example
|
|
2584
2630
|
* ```js
|
|
2585
2631
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -2611,6 +2657,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2611
2657
|
/**
|
|
2612
2658
|
* Triggers the **Save** action on a Liveboard or Answer.
|
|
2613
2659
|
* Saves the changes.
|
|
2660
|
+
*
|
|
2614
2661
|
* @example
|
|
2615
2662
|
* ```js
|
|
2616
2663
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -2624,6 +2671,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2624
2671
|
/**
|
|
2625
2672
|
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
2626
2673
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
2674
|
+
*
|
|
2627
2675
|
* @param - an object with `vizId` as a key
|
|
2628
2676
|
* @example
|
|
2629
2677
|
* ```js
|
|
@@ -2640,6 +2688,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2640
2688
|
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
2641
2689
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
2642
2690
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
2691
|
+
*
|
|
2643
2692
|
* @param - an object with vizId as a key
|
|
2644
2693
|
* @example
|
|
2645
2694
|
* ```js
|
|
@@ -2656,6 +2705,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2656
2705
|
* Triggers the **Manage pipelines** action on an embedded
|
|
2657
2706
|
* visualization or Answer.
|
|
2658
2707
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
2708
|
+
*
|
|
2659
2709
|
* @param - an object with `vizId` as a key
|
|
2660
2710
|
* @example
|
|
2661
2711
|
* ```js
|
|
@@ -2700,6 +2750,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2700
2750
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2701
2751
|
*/
|
|
2702
2752
|
UpdateFilters = "updateFilters",
|
|
2753
|
+
/**
|
|
2754
|
+
* Get Tab for the current Liveboard.
|
|
2755
|
+
*
|
|
2756
|
+
* @example
|
|
2757
|
+
* ```js
|
|
2758
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
2759
|
+
* console.log(
|
|
2760
|
+
* tabDetails // TabDetails of current LB
|
|
2761
|
+
* );
|
|
2762
|
+
* })
|
|
2763
|
+
* ```
|
|
2764
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2765
|
+
*/
|
|
2703
2766
|
GetTabs = "getTabs",
|
|
2704
2767
|
/**
|
|
2705
2768
|
* Set the visible Tabs on a Liveboard.
|
|
@@ -2712,7 +2775,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2712
2775
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
2713
2776
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
2714
2777
|
* ```
|
|
2715
|
-
* @version SDK: 1.
|
|
2778
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2716
2779
|
*/
|
|
2717
2780
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
2718
2781
|
/**
|
|
@@ -2726,9 +2789,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2726
2789
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
2727
2790
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
2728
2791
|
* ```
|
|
2729
|
-
* @version SDK: 1.
|
|
2792
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2730
2793
|
*/
|
|
2731
|
-
SetHiddenTabs = "SetPinboardHiddenTabs"
|
|
2794
|
+
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
2795
|
+
/**
|
|
2796
|
+
* Updates the search query for sage embed.
|
|
2797
|
+
*
|
|
2798
|
+
* @param - searchOptions: an object queryString and option to execute the query.
|
|
2799
|
+
* @example
|
|
2800
|
+
* ```js
|
|
2801
|
+
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
2802
|
+
* queryString: 'revenue per year',
|
|
2803
|
+
* executeSearch: true,
|
|
2804
|
+
* })
|
|
2805
|
+
* ```
|
|
2806
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2807
|
+
*/
|
|
2808
|
+
UpdateSageQuery = "updateSageQuery"
|
|
2732
2809
|
}
|
|
2733
2810
|
/**
|
|
2734
2811
|
* The different visual modes that the data sources panel within
|
|
@@ -2783,6 +2860,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2783
2860
|
DisableLoginRedirect = "disableLoginRedirect",
|
|
2784
2861
|
visibleVizs = "pinboardVisibleVizs",
|
|
2785
2862
|
LiveboardV2Enabled = "isPinboardV2Enabled",
|
|
2863
|
+
DataPanelV2Enabled = "enableDataPanelV2",
|
|
2786
2864
|
ShowAlerts = "showAlerts",
|
|
2787
2865
|
Locale = "locale",
|
|
2788
2866
|
CustomStyle = "customStyle",
|
|
@@ -2808,7 +2886,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2808
2886
|
ShowLiveboardTitle = "showLiveboardTitle",
|
|
2809
2887
|
HiddenTabs = "hideTabs",
|
|
2810
2888
|
VisibleTabs = "visibleTabs",
|
|
2811
|
-
HideTabPanel = "hideTabPanel"
|
|
2889
|
+
HideTabPanel = "hideTabPanel",
|
|
2890
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
2891
|
+
WorksheetId = "worksheet",
|
|
2892
|
+
Query = "query"
|
|
2812
2893
|
}
|
|
2813
2894
|
/**
|
|
2814
2895
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -2817,6 +2898,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2817
2898
|
* specific actions in the embedded view, define the Action
|
|
2818
2899
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
2819
2900
|
* or `hiddenActions` array.
|
|
2901
|
+
*
|
|
2820
2902
|
* @example
|
|
2821
2903
|
* ```js
|
|
2822
2904
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2835,12 +2917,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2835
2917
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
2836
2918
|
* })
|
|
2837
2919
|
* ```
|
|
2838
|
-
|
|
2839
2920
|
*/
|
|
2840
2921
|
export enum Action {
|
|
2841
2922
|
/**
|
|
2842
2923
|
* The **Save** action on an Answer or Liveboard.
|
|
2843
2924
|
* Allows users to save the changes.
|
|
2925
|
+
*
|
|
2844
2926
|
* @example
|
|
2845
2927
|
* ```js
|
|
2846
2928
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -2856,136 +2938,146 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2856
2938
|
*/
|
|
2857
2939
|
SaveUntitled = "saveUntitled",
|
|
2858
2940
|
/**
|
|
2859
|
-
|
|
2860
|
-
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
|
|
2866
|
-
|
|
2941
|
+
* The **Save as View** action on the Answer
|
|
2942
|
+
* page. Saves an Answer as a View object.
|
|
2943
|
+
*
|
|
2944
|
+
* @example
|
|
2945
|
+
* ```js
|
|
2946
|
+
* disabledActions: [Action.SaveAsView]
|
|
2947
|
+
* ```
|
|
2948
|
+
*/
|
|
2867
2949
|
SaveAsView = "saveAsView",
|
|
2868
2950
|
/**
|
|
2869
|
-
|
|
2870
|
-
|
|
2871
|
-
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
|
|
2875
|
-
|
|
2876
|
-
|
|
2877
|
-
|
|
2878
|
-
|
|
2951
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
2952
|
+
* page.
|
|
2953
|
+
* Creates a copy of the Liveboard, visualization,
|
|
2954
|
+
* or Answer.
|
|
2955
|
+
*
|
|
2956
|
+
* @example
|
|
2957
|
+
* ```js
|
|
2958
|
+
* disabledActions: [Action.MakeACopy]
|
|
2959
|
+
* ```
|
|
2960
|
+
*/
|
|
2879
2961
|
MakeACopy = "makeACopy",
|
|
2880
2962
|
/**
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
|
|
2884
|
-
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
2963
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
2964
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
2965
|
+
*
|
|
2966
|
+
* @example
|
|
2967
|
+
* ```js
|
|
2968
|
+
* disabledActions: [Action.EditACopy]
|
|
2969
|
+
* ```
|
|
2970
|
+
*/
|
|
2889
2971
|
EditACopy = "editACopy",
|
|
2890
2972
|
/**
|
|
2891
|
-
|
|
2892
|
-
|
|
2893
|
-
|
|
2894
|
-
|
|
2895
|
-
|
|
2896
|
-
|
|
2897
|
-
|
|
2973
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
2974
|
+
* Copies the visualization URL
|
|
2975
|
+
*
|
|
2976
|
+
* @example
|
|
2977
|
+
* ```js
|
|
2978
|
+
* disabledActions: [Action.CopyLink]
|
|
2979
|
+
* ```
|
|
2980
|
+
*/
|
|
2898
2981
|
CopyLink = "embedDocument",
|
|
2899
2982
|
/**
|
|
2900
2983
|
* @hidden
|
|
2901
2984
|
*/
|
|
2902
2985
|
ResetLayout = "resetLayout",
|
|
2903
2986
|
/**
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
|
|
2987
|
+
* The **Schedule** menu action on a Liveboard.
|
|
2988
|
+
* Allows scheduling a Liveboard notification.
|
|
2989
|
+
*
|
|
2990
|
+
* @example
|
|
2991
|
+
* ```js
|
|
2992
|
+
* disabledActions: [Action.Schedule]
|
|
2993
|
+
* ```
|
|
2994
|
+
*/
|
|
2911
2995
|
Schedule = "subscription",
|
|
2912
2996
|
/**
|
|
2913
|
-
|
|
2914
|
-
|
|
2915
|
-
|
|
2916
|
-
|
|
2917
|
-
|
|
2918
|
-
|
|
2919
|
-
|
|
2997
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
2998
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
2999
|
+
*
|
|
3000
|
+
* @example
|
|
3001
|
+
* ```js
|
|
3002
|
+
* disabledActions: [Action.SchedulesList]
|
|
3003
|
+
* ```
|
|
3004
|
+
*/
|
|
2920
3005
|
SchedulesList = "schedule-list",
|
|
2921
3006
|
/**
|
|
2922
|
-
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
|
|
2926
|
-
|
|
2927
|
-
|
|
2928
|
-
|
|
3007
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
3008
|
+
* Allows users to share an object with other users and groups.
|
|
3009
|
+
*
|
|
3010
|
+
* @example
|
|
3011
|
+
* ```js
|
|
3012
|
+
* disabledActions: [Action.Share]
|
|
3013
|
+
* ```
|
|
3014
|
+
*/
|
|
2929
3015
|
Share = "share",
|
|
2930
3016
|
/**
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
|
|
2936
|
-
|
|
2937
|
-
|
|
3017
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
3018
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
3019
|
+
*
|
|
3020
|
+
* @example
|
|
3021
|
+
* ```js
|
|
3022
|
+
* disabledActions: [Action.AddFilter]
|
|
3023
|
+
* ```
|
|
3024
|
+
*/
|
|
2938
3025
|
AddFilter = "addFilter",
|
|
2939
3026
|
/**
|
|
2940
|
-
|
|
2941
|
-
|
|
2942
|
-
|
|
2943
|
-
|
|
2944
|
-
|
|
2945
|
-
|
|
2946
|
-
|
|
2947
|
-
|
|
3027
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
3028
|
+
* Allows configuring filter options when adding filters to a
|
|
3029
|
+
* Liveboard or Answer.
|
|
3030
|
+
*
|
|
3031
|
+
* @example
|
|
3032
|
+
* ```js
|
|
3033
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
3034
|
+
* ```
|
|
3035
|
+
*/
|
|
2948
3036
|
ConfigureFilter = "configureFilter",
|
|
2949
3037
|
CollapseDataSources = "collapseDataSources",
|
|
2950
3038
|
/**
|
|
2951
|
-
|
|
2952
|
-
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
|
|
2956
|
-
|
|
2957
|
-
|
|
3039
|
+
* The **Choose sources** button on Search page.
|
|
3040
|
+
* Allows selecting data sources for search queries.
|
|
3041
|
+
*
|
|
3042
|
+
* @example
|
|
3043
|
+
* ```js
|
|
3044
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
3045
|
+
* ```
|
|
3046
|
+
*/
|
|
2958
3047
|
ChooseDataSources = "chooseDataSources",
|
|
2959
3048
|
/**
|
|
2960
|
-
|
|
2961
|
-
|
|
2962
|
-
|
|
2963
|
-
|
|
2964
|
-
|
|
2965
|
-
|
|
2966
|
-
|
|
3049
|
+
* The **Create formula** action on a Search or Answer page.
|
|
3050
|
+
* Allows adding formulas to an Answer.
|
|
3051
|
+
*
|
|
3052
|
+
* @example
|
|
3053
|
+
* ```js
|
|
3054
|
+
* disabledActions: [Action.AddFormula]
|
|
3055
|
+
* ```
|
|
3056
|
+
*/
|
|
2967
3057
|
AddFormula = "addFormula",
|
|
2968
3058
|
/**
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
|
|
2975
|
-
|
|
3059
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
3060
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
3061
|
+
*
|
|
3062
|
+
* @example
|
|
3063
|
+
* ```js
|
|
3064
|
+
* disabledActions: [Action.AddParameter]
|
|
3065
|
+
* ```
|
|
3066
|
+
*/
|
|
2976
3067
|
AddParameter = "addParameter",
|
|
2977
3068
|
/**
|
|
2978
3069
|
* @hidden
|
|
2979
3070
|
*/
|
|
2980
3071
|
SearchOnTop = "searchOnTop",
|
|
2981
3072
|
/**
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
|
|
2987
|
-
|
|
2988
|
-
|
|
3073
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
3074
|
+
* Answer page.
|
|
3075
|
+
*
|
|
3076
|
+
* @example
|
|
3077
|
+
* ```js
|
|
3078
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
3079
|
+
* ```
|
|
3080
|
+
*/
|
|
2989
3081
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2990
3082
|
/**
|
|
2991
3083
|
* @hidden
|
|
@@ -3001,89 +3093,98 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3001
3093
|
*/
|
|
3002
3094
|
ReplaySearch = "replaySearch",
|
|
3003
3095
|
/**
|
|
3004
|
-
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
|
|
3096
|
+
* The **Show underlying data** menu action on a visualization or
|
|
3097
|
+
* Answer page.
|
|
3098
|
+
*
|
|
3099
|
+
* @example
|
|
3100
|
+
* ```js
|
|
3101
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
3102
|
+
* ```
|
|
3103
|
+
*/
|
|
3011
3104
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3012
3105
|
/**
|
|
3013
|
-
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
|
|
3106
|
+
* The **Download** menu action on Liveboard visualizations
|
|
3107
|
+
* and Answers.
|
|
3108
|
+
* Allows downloading a visualization or Answer.
|
|
3109
|
+
*
|
|
3110
|
+
* @example
|
|
3111
|
+
* ```js
|
|
3112
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3113
|
+
* ```
|
|
3114
|
+
*/
|
|
3021
3115
|
Download = "download",
|
|
3022
3116
|
/**
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
|
|
3026
|
-
|
|
3027
|
-
|
|
3028
|
-
|
|
3029
|
-
|
|
3030
|
-
|
|
3117
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3118
|
+
* or Answer page.
|
|
3119
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
3120
|
+
*
|
|
3121
|
+
* @example
|
|
3122
|
+
* ```js
|
|
3123
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3124
|
+
* ```
|
|
3125
|
+
*/
|
|
3031
3126
|
DownloadAsPng = "downloadAsPng",
|
|
3032
3127
|
/**
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
|
|
3038
|
-
|
|
3039
|
-
|
|
3128
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3129
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
3130
|
+
*
|
|
3131
|
+
* @example
|
|
3132
|
+
* ```js
|
|
3133
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
3134
|
+
* ```
|
|
3135
|
+
*/
|
|
3040
3136
|
DownloadAsPdf = "downloadAsPdf",
|
|
3041
3137
|
/**
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3138
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3139
|
+
* or Answer page.
|
|
3140
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3141
|
+
*
|
|
3142
|
+
* @example
|
|
3143
|
+
* ```js
|
|
3144
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
3145
|
+
* ```
|
|
3146
|
+
*/
|
|
3050
3147
|
DownloadAsCsv = "downloadAsCSV",
|
|
3051
3148
|
/**
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
|
|
3055
|
-
|
|
3056
|
-
|
|
3057
|
-
|
|
3058
|
-
|
|
3059
|
-
|
|
3149
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3150
|
+
* or Answer page.
|
|
3151
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3152
|
+
*
|
|
3153
|
+
* @example
|
|
3154
|
+
* ```js
|
|
3155
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
3156
|
+
* ```
|
|
3157
|
+
*/
|
|
3060
3158
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
3061
3159
|
/**
|
|
3062
3160
|
* @hidden
|
|
3063
3161
|
*/
|
|
3064
3162
|
DownloadTrace = "downloadTrace",
|
|
3065
3163
|
/**
|
|
3066
|
-
|
|
3067
|
-
|
|
3068
|
-
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
|
|
3164
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
3165
|
+
* Worksheets and Data Connections page.
|
|
3166
|
+
* Exports an object as a TML file.
|
|
3167
|
+
*
|
|
3168
|
+
* @example
|
|
3169
|
+
* ```js
|
|
3170
|
+
* disabledActions: [Action.ExportTML]
|
|
3171
|
+
* ```
|
|
3172
|
+
*/
|
|
3074
3173
|
ExportTML = "exportTSL",
|
|
3075
3174
|
/**
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
|
|
3175
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
3176
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
3177
|
+
*
|
|
3178
|
+
* @example
|
|
3179
|
+
* ```js
|
|
3180
|
+
* disabledActions: [Action.ImportTML]
|
|
3181
|
+
* ```
|
|
3182
|
+
*/
|
|
3083
3183
|
ImportTML = "importTSL",
|
|
3084
3184
|
/**
|
|
3085
3185
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
3086
3186
|
* Update TML representation of ThoughtSpot objects.
|
|
3187
|
+
*
|
|
3087
3188
|
* @example
|
|
3088
3189
|
* ```js
|
|
3089
3190
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -3093,6 +3194,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3093
3194
|
/**
|
|
3094
3195
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3095
3196
|
* Opens the TML editor.
|
|
3197
|
+
*
|
|
3096
3198
|
* @example
|
|
3097
3199
|
* ```js
|
|
3098
3200
|
* disabledActions: [Action.EditTML]
|
|
@@ -3100,50 +3202,55 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3100
3202
|
*/
|
|
3101
3203
|
EditTML = "editTSL",
|
|
3102
3204
|
/**
|
|
3103
|
-
|
|
3104
|
-
|
|
3105
|
-
|
|
3106
|
-
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
|
|
3205
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
3206
|
+
* Allows presenting a Liveboard or visualization in
|
|
3207
|
+
* slideshow mode.
|
|
3208
|
+
*
|
|
3209
|
+
* @example
|
|
3210
|
+
* ```js
|
|
3211
|
+
* disabledActions: [Action.Present]
|
|
3212
|
+
* ```
|
|
3213
|
+
*/
|
|
3111
3214
|
Present = "present",
|
|
3112
3215
|
/**
|
|
3113
|
-
|
|
3114
|
-
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
|
|
3216
|
+
* The tile resize options in the visualization menu.
|
|
3217
|
+
* Allows switching between different preset layouts.
|
|
3218
|
+
*
|
|
3219
|
+
* @example
|
|
3220
|
+
* ```js
|
|
3221
|
+
* disabledActions: [Action.ToggleSize]
|
|
3222
|
+
* ```
|
|
3223
|
+
*/
|
|
3120
3224
|
ToggleSize = "toggleSize",
|
|
3121
3225
|
/**
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
|
|
3127
|
-
|
|
3128
|
-
|
|
3129
|
-
|
|
3226
|
+
* The *Edit* action on the Liveboard page and in the
|
|
3227
|
+
* visualization menu.
|
|
3228
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
3229
|
+
*
|
|
3230
|
+
* @example
|
|
3231
|
+
* ```js
|
|
3232
|
+
* disabledActions: [Action.Edit]
|
|
3233
|
+
* ```
|
|
3234
|
+
*/
|
|
3130
3235
|
Edit = "edit",
|
|
3131
3236
|
/**
|
|
3132
|
-
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
|
|
3237
|
+
* The text edit option for Liveboard and visualization titles.
|
|
3238
|
+
*
|
|
3239
|
+
* @example
|
|
3240
|
+
* ```js
|
|
3241
|
+
* disabledActions: [Action.EditTitle]
|
|
3242
|
+
* ```
|
|
3243
|
+
*/
|
|
3138
3244
|
EditTitle = "editTitle",
|
|
3139
3245
|
/**
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3246
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
3247
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3248
|
+
*
|
|
3249
|
+
* @example
|
|
3250
|
+
* ```js
|
|
3251
|
+
* disabledActions: [Action.Remove]
|
|
3252
|
+
* ```
|
|
3253
|
+
*/
|
|
3147
3254
|
Remove = "delete",
|
|
3148
3255
|
/**
|
|
3149
3256
|
* @hidden
|
|
@@ -3166,15 +3273,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3166
3273
|
*/
|
|
3167
3274
|
PinboardInfo = "pinboardInfo",
|
|
3168
3275
|
/**
|
|
3169
|
-
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3276
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
3277
|
+
* Displays details such as the name, description, and
|
|
3278
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3279
|
+
* and update.
|
|
3280
|
+
*
|
|
3281
|
+
* @example
|
|
3282
|
+
* ```js
|
|
3283
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
3284
|
+
* ```
|
|
3285
|
+
*/
|
|
3178
3286
|
LiveboardInfo = "pinboardInfo",
|
|
3179
3287
|
/**
|
|
3180
3288
|
* @hidden
|
|
@@ -3185,13 +3293,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3185
3293
|
*/
|
|
3186
3294
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
3187
3295
|
/**
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
3191
|
-
|
|
3192
|
-
|
|
3193
|
-
|
|
3194
|
-
|
|
3296
|
+
* The **Pin** menu action on an Answer or
|
|
3297
|
+
* Search results page.
|
|
3298
|
+
*
|
|
3299
|
+
* @example
|
|
3300
|
+
* ```js
|
|
3301
|
+
* disabledActions: [Action.Pin]
|
|
3302
|
+
* ```
|
|
3303
|
+
*/
|
|
3195
3304
|
Pin = "pin",
|
|
3196
3305
|
/**
|
|
3197
3306
|
* @hidden
|
|
@@ -3199,6 +3308,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3199
3308
|
AnalysisInfo = "analysisInfo",
|
|
3200
3309
|
/**
|
|
3201
3310
|
* The **Schedule** menu action on a Liveboard.
|
|
3311
|
+
*
|
|
3202
3312
|
* @example
|
|
3203
3313
|
* ```js
|
|
3204
3314
|
* disabledActions: [Action.Subscription]
|
|
@@ -3206,25 +3316,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3206
3316
|
*/
|
|
3207
3317
|
Subscription = "subscription",
|
|
3208
3318
|
/**
|
|
3209
|
-
|
|
3210
|
-
|
|
3211
|
-
|
|
3212
|
-
|
|
3213
|
-
|
|
3214
|
-
|
|
3319
|
+
* The **Explore** action on Liveboard visualizations
|
|
3320
|
+
*
|
|
3321
|
+
* @example
|
|
3322
|
+
* ```js
|
|
3323
|
+
* disabledActions: [Action.Explore]
|
|
3324
|
+
* ```
|
|
3325
|
+
*/
|
|
3215
3326
|
Explore = "explore",
|
|
3216
3327
|
/**
|
|
3217
|
-
|
|
3218
|
-
|
|
3219
|
-
|
|
3220
|
-
|
|
3221
|
-
|
|
3222
|
-
|
|
3223
|
-
|
|
3328
|
+
* The action to include data points on a drilled-down Answer
|
|
3329
|
+
* or visualization
|
|
3330
|
+
*
|
|
3331
|
+
* @example
|
|
3332
|
+
* ```js
|
|
3333
|
+
* disabledActions: [Action.DrillInclude]
|
|
3334
|
+
* ```
|
|
3335
|
+
*/
|
|
3224
3336
|
DrillInclude = "context-menu-item-include",
|
|
3225
3337
|
/**
|
|
3226
3338
|
* The action to exclude data points on a drilled-down Answer
|
|
3227
3339
|
* or visualization
|
|
3340
|
+
*
|
|
3228
3341
|
* @example
|
|
3229
3342
|
* ```js
|
|
3230
3343
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3235,6 +3348,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3235
3348
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3236
3349
|
* or Liveboard.
|
|
3237
3350
|
* Copies the selected data point.
|
|
3351
|
+
*
|
|
3238
3352
|
* @example
|
|
3239
3353
|
* ```js
|
|
3240
3354
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -3252,6 +3366,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3252
3366
|
* The **Drill down** menu action on Answers and Liveboard
|
|
3253
3367
|
* visualizations.
|
|
3254
3368
|
* Allows drilling down to a specific data point on a chart or table.
|
|
3369
|
+
*
|
|
3255
3370
|
* @example
|
|
3256
3371
|
* ```js
|
|
3257
3372
|
* disabledActions: [Action.DrillDown]
|
|
@@ -3261,6 +3376,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3261
3376
|
/**
|
|
3262
3377
|
* The request access action on Liveboards.
|
|
3263
3378
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3379
|
+
*
|
|
3264
3380
|
* @example
|
|
3265
3381
|
* ```js
|
|
3266
3382
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -3270,6 +3386,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3270
3386
|
/**
|
|
3271
3387
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3272
3388
|
* of the Answer page
|
|
3389
|
+
*
|
|
3273
3390
|
* @example
|
|
3274
3391
|
* ```js
|
|
3275
3392
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3278,6 +3395,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3278
3395
|
QueryDetailsButtons = "QueryDetailsButtons",
|
|
3279
3396
|
/**
|
|
3280
3397
|
* The **Delete** action for Answers.
|
|
3398
|
+
*
|
|
3281
3399
|
* @example
|
|
3282
3400
|
* ```js
|
|
3283
3401
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -3287,6 +3405,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3287
3405
|
AnswerDelete = "onDeleteAnswer",
|
|
3288
3406
|
/**
|
|
3289
3407
|
* The Chart switcher icon on Answer and visualization pages.
|
|
3408
|
+
*
|
|
3290
3409
|
* @example
|
|
3291
3410
|
* ```js
|
|
3292
3411
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3296,6 +3415,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3296
3415
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3297
3416
|
/**
|
|
3298
3417
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3418
|
+
*
|
|
3299
3419
|
* @example
|
|
3300
3420
|
* ```js
|
|
3301
3421
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3305,6 +3425,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3305
3425
|
AddToFavorites = "addToFavorites",
|
|
3306
3426
|
/**
|
|
3307
3427
|
* The edit icon on Liveboards (Classic experience).
|
|
3428
|
+
*
|
|
3308
3429
|
* @example
|
|
3309
3430
|
* ```js
|
|
3310
3431
|
* disabledActions: [Action.EditDetails]
|
|
@@ -3314,6 +3435,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3314
3435
|
EditDetails = "editDetails",
|
|
3315
3436
|
/**
|
|
3316
3437
|
* The Create alert action on KPI charts.
|
|
3438
|
+
*
|
|
3317
3439
|
* @example
|
|
3318
3440
|
* ```js
|
|
3319
3441
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -3332,6 +3454,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3332
3454
|
/**
|
|
3333
3455
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3334
3456
|
* Allows sending data to a Google Sheet.
|
|
3457
|
+
*
|
|
3335
3458
|
* @example
|
|
3336
3459
|
* ```js
|
|
3337
3460
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -3343,6 +3466,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3343
3466
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3344
3467
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3345
3468
|
* Microsoft Teams, and so on.
|
|
3469
|
+
*
|
|
3346
3470
|
* @example
|
|
3347
3471
|
* ```js
|
|
3348
3472
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3353,6 +3477,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3353
3477
|
/**
|
|
3354
3478
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3355
3479
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
3480
|
+
*
|
|
3356
3481
|
* @example
|
|
3357
3482
|
* ```js
|
|
3358
3483
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3363,6 +3488,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3363
3488
|
/**
|
|
3364
3489
|
* The **Filter** action on Liveboard visualizations.
|
|
3365
3490
|
* Allows users to apply cross-filters on a Liveboard.
|
|
3491
|
+
*
|
|
3366
3492
|
* @example
|
|
3367
3493
|
* ```js
|
|
3368
3494
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -3374,6 +3500,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3374
3500
|
* The **Remove** action that appears when cross filters are applied
|
|
3375
3501
|
* on a Liveboard.
|
|
3376
3502
|
* Removes filters applied o a visualization.
|
|
3503
|
+
*
|
|
3377
3504
|
* @example
|
|
3378
3505
|
* ```js
|
|
3379
3506
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3385,6 +3512,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3385
3512
|
* The **Aggregate** option in the chart axis or the
|
|
3386
3513
|
* table column customization menu.
|
|
3387
3514
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3515
|
+
*
|
|
3388
3516
|
* @example
|
|
3389
3517
|
* ```js
|
|
3390
3518
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3396,6 +3524,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3396
3524
|
* The **Time bucket** option in the chart axis or table column
|
|
3397
3525
|
* customization menu.
|
|
3398
3526
|
* Allows defining time metric for date comparison.
|
|
3527
|
+
*
|
|
3399
3528
|
* @example
|
|
3400
3529
|
* ```js
|
|
3401
3530
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3406,6 +3535,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3406
3535
|
/**
|
|
3407
3536
|
* The **Filter** action in the chart axis or table column
|
|
3408
3537
|
* customization menu.
|
|
3538
|
+
*
|
|
3409
3539
|
* @example
|
|
3410
3540
|
* ```js
|
|
3411
3541
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3417,6 +3547,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3417
3547
|
* The **Conditional formatting** action on chart or table.
|
|
3418
3548
|
* Allows adding rules for conditional formatting of data
|
|
3419
3549
|
* points on a chart or table.
|
|
3550
|
+
*
|
|
3420
3551
|
* @example
|
|
3421
3552
|
* ```js
|
|
3422
3553
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3428,6 +3559,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3428
3559
|
* The **Sort** menu action on a table or chart axis
|
|
3429
3560
|
* Sorts data in ascending or descending order.
|
|
3430
3561
|
* Allows adding, editing, or removing filters.
|
|
3562
|
+
*
|
|
3431
3563
|
* @example
|
|
3432
3564
|
* ```js
|
|
3433
3565
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3440,6 +3572,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3440
3572
|
* customization menu.
|
|
3441
3573
|
* Allows grouping data points if the axes use the same
|
|
3442
3574
|
* unit of measurement and a similar scale.
|
|
3575
|
+
*
|
|
3443
3576
|
* @example
|
|
3444
3577
|
* ```js
|
|
3445
3578
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3451,6 +3584,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3451
3584
|
* The **Position** option in the axis customization menu.
|
|
3452
3585
|
* Allows changing the position of the axis to the
|
|
3453
3586
|
* left or right side of the chart.
|
|
3587
|
+
*
|
|
3454
3588
|
* @example
|
|
3455
3589
|
* ```js
|
|
3456
3590
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3461,6 +3595,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3461
3595
|
/**
|
|
3462
3596
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3463
3597
|
* Renames the axis label on a chart or the column header on a table.
|
|
3598
|
+
*
|
|
3464
3599
|
* @example
|
|
3465
3600
|
* ```js
|
|
3466
3601
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3472,6 +3607,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3472
3607
|
* The **Edit** action in the axis customization menu.
|
|
3473
3608
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3474
3609
|
* and format of a column.
|
|
3610
|
+
*
|
|
3475
3611
|
* @example
|
|
3476
3612
|
* ```js
|
|
3477
3613
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3482,6 +3618,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3482
3618
|
/**
|
|
3483
3619
|
* The **Number format** action to customize the format of
|
|
3484
3620
|
* the data labels on a chart or table.
|
|
3621
|
+
*
|
|
3485
3622
|
* @example
|
|
3486
3623
|
* ```js
|
|
3487
3624
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3492,6 +3629,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3492
3629
|
/**
|
|
3493
3630
|
* The **Text wrapping** action on a table.
|
|
3494
3631
|
* Wraps or clips column text on a table.
|
|
3632
|
+
*
|
|
3495
3633
|
* @example
|
|
3496
3634
|
* ```js
|
|
3497
3635
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3504,6 +3642,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3504
3642
|
* customization menu.
|
|
3505
3643
|
* Removes the data labels from a chart or the column of a
|
|
3506
3644
|
* table visualization.
|
|
3645
|
+
*
|
|
3507
3646
|
* @example
|
|
3508
3647
|
* ```js
|
|
3509
3648
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3518,6 +3657,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3518
3657
|
/**
|
|
3519
3658
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3520
3659
|
* Allows renaming a Liveboard or visualization.
|
|
3660
|
+
*
|
|
3521
3661
|
* @example
|
|
3522
3662
|
* ```js
|
|
3523
3663
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3534,13 +3674,29 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3534
3674
|
*/
|
|
3535
3675
|
MarkAsVerified = "markAsVerified",
|
|
3536
3676
|
/**
|
|
3537
|
-
* @version SDK: 1.
|
|
3677
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3538
3678
|
*/
|
|
3539
3679
|
AddTab = "addTab",
|
|
3540
3680
|
/**
|
|
3541
3681
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
3542
3682
|
*/
|
|
3543
|
-
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
|
|
3683
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
3684
|
+
/**
|
|
3685
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3686
|
+
*/
|
|
3687
|
+
ShowSageQuery = "showSageQuery",
|
|
3688
|
+
/**
|
|
3689
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3690
|
+
*/
|
|
3691
|
+
EditSageAnswer = "editSageAnswer",
|
|
3692
|
+
/**
|
|
3693
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3694
|
+
*/
|
|
3695
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
3696
|
+
/**
|
|
3697
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3698
|
+
*/
|
|
3699
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
3544
3700
|
}
|
|
3545
3701
|
export interface SessionInterface {
|
|
3546
3702
|
sessionId: string;
|
|
@@ -3888,15 +4044,34 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
|
|
|
3888
4044
|
*/
|
|
3889
4045
|
import { Action, DOMSelector, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
|
|
3890
4046
|
import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
|
|
4047
|
+
/**
|
|
4048
|
+
* Configuration for search options
|
|
4049
|
+
*/
|
|
4050
|
+
export interface SearchOptions {
|
|
4051
|
+
/**
|
|
4052
|
+
* The tml string to load the answer
|
|
4053
|
+
*/
|
|
4054
|
+
searchQuery: string;
|
|
4055
|
+
/**
|
|
4056
|
+
* Boolean to determine if the search should be executed or not.
|
|
4057
|
+
* if it is executed, put the focus on the results.
|
|
4058
|
+
* if it’s not executed, put the focus in the search bar - at the end of
|
|
4059
|
+
* the tokens
|
|
4060
|
+
*/
|
|
4061
|
+
executeSearch?: boolean;
|
|
4062
|
+
}
|
|
3891
4063
|
/**
|
|
3892
4064
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
3893
4065
|
* GPT and LLM.
|
|
3894
4066
|
*
|
|
4067
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
3895
4068
|
* @group Embed components
|
|
3896
4069
|
*/
|
|
3897
4070
|
export interface SageViewConfig extends ViewConfig {
|
|
3898
4071
|
/**
|
|
3899
|
-
* If set to true,
|
|
4072
|
+
* If set to true, a list of liveboard and answers related
|
|
4073
|
+
* to the natural language search will be shown below the
|
|
4074
|
+
* AI generated answer.
|
|
3900
4075
|
*/
|
|
3901
4076
|
showObjectResults?: boolean;
|
|
3902
4077
|
/**
|
|
@@ -3908,10 +4083,28 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
|
|
|
3908
4083
|
*/
|
|
3909
4084
|
hideWorksheetSelector?: boolean;
|
|
3910
4085
|
/**
|
|
3911
|
-
* If set to true, the
|
|
4086
|
+
* If set to true, the search suggestions will contain existing
|
|
4087
|
+
* liveboards and answers in addition with the autocomplete
|
|
3912
4088
|
*
|
|
3913
4089
|
*/
|
|
3914
4090
|
showObjectSuggestions?: boolean;
|
|
4091
|
+
/**
|
|
4092
|
+
* The query string to pre-fill in natual language search bar
|
|
4093
|
+
*/
|
|
4094
|
+
searchQuery?: string;
|
|
4095
|
+
/**
|
|
4096
|
+
* If set to true, sample questions would be hidden to user.
|
|
4097
|
+
* These sample questions are autogenerated based on selected datasource.
|
|
4098
|
+
*/
|
|
4099
|
+
hideSampleQuestions?: boolean;
|
|
4100
|
+
/**
|
|
4101
|
+
* The data source GUID to set on load.
|
|
4102
|
+
*/
|
|
4103
|
+
dataSource?: string;
|
|
4104
|
+
/**
|
|
4105
|
+
* Configuration for search options
|
|
4106
|
+
*/
|
|
4107
|
+
searchOptions?: SearchOptions;
|
|
3915
4108
|
}
|
|
3916
4109
|
export const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
3917
4110
|
/**
|