@thoughtspot/visual-embed-sdk 1.23.0 → 1.23.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/embed/app.d.ts +1 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +8 -0
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +8 -0
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +14 -0
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +12 -3
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/sage.spec.js +1 -1
- package/cjs/src/embed/sage.spec.js.map +1 -1
- package/cjs/src/types.d.ts +364 -247
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +342 -241
- package/cjs/src/types.js.map +1 -1
- package/dist/src/embed/app.d.ts +1 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +8 -0
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +14 -0
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/types.d.ts +364 -247
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +356 -246
- package/dist/tsembed-react.js +355 -245
- package/dist/tsembed.es.js +364 -246
- package/dist/tsembed.js +363 -245
- package/dist/visual-embed-sdk-react-full.d.ts +387 -248
- package/dist/visual-embed-sdk-react.d.ts +387 -248
- package/dist/visual-embed-sdk.d.ts +387 -248
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +1 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +8 -0
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +8 -0
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/sage.d.ts +14 -0
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +12 -3
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/sage.spec.js +1 -1
- package/lib/src/embed/sage.spec.js.map +1 -1
- package/lib/src/types.d.ts +364 -247
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +342 -241
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +387 -248
- package/package.json +1 -1
- package/src/embed/app.ts +1 -1
- package/src/embed/base.ts +8 -0
- package/src/embed/sage.spec.ts +1 -1
- package/src/embed/sage.ts +24 -2
- package/src/types.ts +351 -247
|
@@ -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.
|
|
@@ -271,7 +271,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
|
|
|
271
271
|
* @param fn The function being registered
|
|
272
272
|
*/
|
|
273
273
|
export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
274
|
+
/**
|
|
275
|
+
* @param data
|
|
276
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
277
|
+
*/
|
|
274
278
|
export const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
279
|
+
/**
|
|
280
|
+
* @param data
|
|
281
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
282
|
+
*/
|
|
275
283
|
export const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
276
284
|
/**
|
|
277
285
|
*
|
|
@@ -1027,6 +1035,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1027
1035
|
export interface CustomisationsInterface {
|
|
1028
1036
|
style?: CustomStyles;
|
|
1029
1037
|
content?: {
|
|
1038
|
+
/**
|
|
1039
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
1040
|
+
*/
|
|
1030
1041
|
strings?: Record<string, any>;
|
|
1031
1042
|
[key: string]: any;
|
|
1032
1043
|
};
|
|
@@ -1434,21 +1445,21 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1434
1445
|
/**
|
|
1435
1446
|
* Boolean to hide liveboard header
|
|
1436
1447
|
*
|
|
1437
|
-
* @version SDK: 1.
|
|
1448
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1438
1449
|
* @default false
|
|
1439
1450
|
*/
|
|
1440
1451
|
hideLiveboardHeader?: boolean;
|
|
1441
1452
|
/**
|
|
1442
1453
|
* Boolean to show liveboard title
|
|
1443
1454
|
*
|
|
1444
|
-
* @version SDK: 1.
|
|
1455
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1445
1456
|
* @default false
|
|
1446
1457
|
*/
|
|
1447
1458
|
showLiveboardTitle?: boolean;
|
|
1448
1459
|
/**
|
|
1449
1460
|
* Boolean to show liveboard description
|
|
1450
1461
|
*
|
|
1451
|
-
* @version SDK: 1.
|
|
1462
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1452
1463
|
* @default false
|
|
1453
1464
|
*/
|
|
1454
1465
|
showLiveboardDescription?: boolean;
|
|
@@ -1466,7 +1477,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1466
1477
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1467
1478
|
* });
|
|
1468
1479
|
* ```
|
|
1469
|
-
* @version SDK: 1.
|
|
1480
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1470
1481
|
*/
|
|
1471
1482
|
hiddenTabs?: string[];
|
|
1472
1483
|
/**
|
|
@@ -1485,7 +1496,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1485
1496
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1486
1497
|
* });
|
|
1487
1498
|
* ```
|
|
1488
|
-
* @version SDK: 1.
|
|
1499
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1489
1500
|
*/
|
|
1490
1501
|
visibleTabs?: string[];
|
|
1491
1502
|
}
|
|
@@ -2047,7 +2058,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2047
2058
|
*
|
|
2048
2059
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2049
2060
|
*/
|
|
2050
|
-
FilterChanged = "filterChanged"
|
|
2061
|
+
FilterChanged = "filterChanged",
|
|
2062
|
+
/**
|
|
2063
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
2064
|
+
*
|
|
2065
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2066
|
+
*/
|
|
2067
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
2068
|
+
/**
|
|
2069
|
+
* Emitten when a user select data source in Sage Embed
|
|
2070
|
+
*
|
|
2071
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
2072
|
+
*/
|
|
2073
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
2051
2074
|
}
|
|
2052
2075
|
/**
|
|
2053
2076
|
* Event types that can be triggered by the host application
|
|
@@ -2076,6 +2099,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2076
2099
|
* Triggers a search query in AppEmbed and SearchEmbed
|
|
2077
2100
|
* deployments.
|
|
2078
2101
|
* Includes the following properties:
|
|
2102
|
+
*
|
|
2079
2103
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
2080
2104
|
* - Although an array, only a single source
|
|
2081
2105
|
* is supported.
|
|
@@ -2094,6 +2118,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2094
2118
|
/**
|
|
2095
2119
|
* Triggers a drill on certain points of the specified column
|
|
2096
2120
|
* Includes the following properties:
|
|
2121
|
+
*
|
|
2097
2122
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2098
2123
|
* to drill to. For example, { selectedPoints: []}
|
|
2099
2124
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -2158,18 +2183,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2158
2183
|
*/
|
|
2159
2184
|
SetActiveTab = "SetActiveTab",
|
|
2160
2185
|
/**
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2186
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
2187
|
+
* runtime filters passed here are appended to the existing runtime
|
|
2188
|
+
* filters.
|
|
2189
|
+
* Pass an array of runtime filters with the following attributes:
|
|
2190
|
+
* `columnName`
|
|
2191
|
+
* _String_. The name of the column to filter on.
|
|
2192
|
+
* `operator`
|
|
2193
|
+
* Runtime filter operator to apply. For information,
|
|
2194
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
2195
|
+
* `values`
|
|
2196
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2197
|
+
* operators such as BW and IN accept multiple operands.
|
|
2198
|
+
*
|
|
2173
2199
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2174
2200
|
* @example
|
|
2175
2201
|
* ```js
|
|
@@ -2185,6 +2211,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2185
2211
|
/**
|
|
2186
2212
|
* Navigate to a specific page in the embedded application without reloading the page.
|
|
2187
2213
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2214
|
+
*
|
|
2188
2215
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
2189
2216
|
* @example
|
|
2190
2217
|
* ```js
|
|
@@ -2508,6 +2535,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2508
2535
|
/**
|
|
2509
2536
|
* Triggers the **SpotIQ analyze** action on visualization
|
|
2510
2537
|
* or search.
|
|
2538
|
+
*
|
|
2511
2539
|
* @param - Liveboard embed takes `vizId` as a
|
|
2512
2540
|
* key. Can be left undefined when embedding Search or
|
|
2513
2541
|
* visualization.
|
|
@@ -2547,6 +2575,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2547
2575
|
/**
|
|
2548
2576
|
* Triggers the **Download** > **PNG** action on
|
|
2549
2577
|
* charts in the embedded view.
|
|
2578
|
+
*
|
|
2550
2579
|
* @example
|
|
2551
2580
|
* ```js
|
|
2552
2581
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -2580,6 +2609,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2580
2609
|
/**
|
|
2581
2610
|
* Triggers the **Download** > **XLSX** action on tables
|
|
2582
2611
|
* in the embedded view.
|
|
2612
|
+
*
|
|
2583
2613
|
* @example
|
|
2584
2614
|
* ```js
|
|
2585
2615
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -2611,6 +2641,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2611
2641
|
/**
|
|
2612
2642
|
* Triggers the **Save** action on a Liveboard or Answer.
|
|
2613
2643
|
* Saves the changes.
|
|
2644
|
+
*
|
|
2614
2645
|
* @example
|
|
2615
2646
|
* ```js
|
|
2616
2647
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -2624,6 +2655,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2624
2655
|
/**
|
|
2625
2656
|
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
2626
2657
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
2658
|
+
*
|
|
2627
2659
|
* @param - an object with `vizId` as a key
|
|
2628
2660
|
* @example
|
|
2629
2661
|
* ```js
|
|
@@ -2640,6 +2672,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2640
2672
|
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
2641
2673
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
2642
2674
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
2675
|
+
*
|
|
2643
2676
|
* @param - an object with vizId as a key
|
|
2644
2677
|
* @example
|
|
2645
2678
|
* ```js
|
|
@@ -2656,6 +2689,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2656
2689
|
* Triggers the **Manage pipelines** action on an embedded
|
|
2657
2690
|
* visualization or Answer.
|
|
2658
2691
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
2692
|
+
*
|
|
2659
2693
|
* @param - an object with `vizId` as a key
|
|
2660
2694
|
* @example
|
|
2661
2695
|
* ```js
|
|
@@ -2700,6 +2734,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2700
2734
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2701
2735
|
*/
|
|
2702
2736
|
UpdateFilters = "updateFilters",
|
|
2737
|
+
/**
|
|
2738
|
+
* Get Tab for the current Liveboard.
|
|
2739
|
+
*
|
|
2740
|
+
* @example
|
|
2741
|
+
* ```js
|
|
2742
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
2743
|
+
* console.log(
|
|
2744
|
+
* tabDetails // TabDetails of current LB
|
|
2745
|
+
* );
|
|
2746
|
+
* })
|
|
2747
|
+
* ```
|
|
2748
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2749
|
+
*/
|
|
2703
2750
|
GetTabs = "getTabs",
|
|
2704
2751
|
/**
|
|
2705
2752
|
* Set the visible Tabs on a Liveboard.
|
|
@@ -2712,7 +2759,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2712
2759
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
2713
2760
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
2714
2761
|
* ```
|
|
2715
|
-
* @version SDK: 1.
|
|
2762
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2716
2763
|
*/
|
|
2717
2764
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
2718
2765
|
/**
|
|
@@ -2726,7 +2773,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2726
2773
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
2727
2774
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
2728
2775
|
* ```
|
|
2729
|
-
* @version SDK: 1.
|
|
2776
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2730
2777
|
*/
|
|
2731
2778
|
SetHiddenTabs = "SetPinboardHiddenTabs"
|
|
2732
2779
|
}
|
|
@@ -2808,7 +2855,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2808
2855
|
ShowLiveboardTitle = "showLiveboardTitle",
|
|
2809
2856
|
HiddenTabs = "hideTabs",
|
|
2810
2857
|
VisibleTabs = "visibleTabs",
|
|
2811
|
-
HideTabPanel = "hideTabPanel"
|
|
2858
|
+
HideTabPanel = "hideTabPanel",
|
|
2859
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
2860
|
+
WorksheetId = "worksheetId",
|
|
2861
|
+
Query = "query,"
|
|
2812
2862
|
}
|
|
2813
2863
|
/**
|
|
2814
2864
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -2817,6 +2867,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2817
2867
|
* specific actions in the embedded view, define the Action
|
|
2818
2868
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
2819
2869
|
* or `hiddenActions` array.
|
|
2870
|
+
*
|
|
2820
2871
|
* @example
|
|
2821
2872
|
* ```js
|
|
2822
2873
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2835,12 +2886,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2835
2886
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
2836
2887
|
* })
|
|
2837
2888
|
* ```
|
|
2838
|
-
|
|
2839
2889
|
*/
|
|
2840
2890
|
export enum Action {
|
|
2841
2891
|
/**
|
|
2842
2892
|
* The **Save** action on an Answer or Liveboard.
|
|
2843
2893
|
* Allows users to save the changes.
|
|
2894
|
+
*
|
|
2844
2895
|
* @example
|
|
2845
2896
|
* ```js
|
|
2846
2897
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -2856,136 +2907,146 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2856
2907
|
*/
|
|
2857
2908
|
SaveUntitled = "saveUntitled",
|
|
2858
2909
|
/**
|
|
2859
|
-
|
|
2860
|
-
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
|
|
2866
|
-
|
|
2910
|
+
* The **Save as View** action on the Answer
|
|
2911
|
+
* page. Saves an Answer as a View object.
|
|
2912
|
+
*
|
|
2913
|
+
* @example
|
|
2914
|
+
* ```js
|
|
2915
|
+
* disabledActions: [Action.SaveAsView]
|
|
2916
|
+
* ```
|
|
2917
|
+
*/
|
|
2867
2918
|
SaveAsView = "saveAsView",
|
|
2868
2919
|
/**
|
|
2869
|
-
|
|
2870
|
-
|
|
2871
|
-
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
|
|
2875
|
-
|
|
2876
|
-
|
|
2877
|
-
|
|
2878
|
-
|
|
2920
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
2921
|
+
* page.
|
|
2922
|
+
* Creates a copy of the Liveboard, visualization,
|
|
2923
|
+
* or Answer.
|
|
2924
|
+
*
|
|
2925
|
+
* @example
|
|
2926
|
+
* ```js
|
|
2927
|
+
* disabledActions: [Action.MakeACopy]
|
|
2928
|
+
* ```
|
|
2929
|
+
*/
|
|
2879
2930
|
MakeACopy = "makeACopy",
|
|
2880
2931
|
/**
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
|
|
2884
|
-
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
2932
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
2933
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
2934
|
+
*
|
|
2935
|
+
* @example
|
|
2936
|
+
* ```js
|
|
2937
|
+
* disabledActions: [Action.EditACopy]
|
|
2938
|
+
* ```
|
|
2939
|
+
*/
|
|
2889
2940
|
EditACopy = "editACopy",
|
|
2890
2941
|
/**
|
|
2891
|
-
|
|
2892
|
-
|
|
2893
|
-
|
|
2894
|
-
|
|
2895
|
-
|
|
2896
|
-
|
|
2897
|
-
|
|
2942
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
2943
|
+
* Copies the visualization URL
|
|
2944
|
+
*
|
|
2945
|
+
* @example
|
|
2946
|
+
* ```js
|
|
2947
|
+
* disabledActions: [Action.CopyLink]
|
|
2948
|
+
* ```
|
|
2949
|
+
*/
|
|
2898
2950
|
CopyLink = "embedDocument",
|
|
2899
2951
|
/**
|
|
2900
2952
|
* @hidden
|
|
2901
2953
|
*/
|
|
2902
2954
|
ResetLayout = "resetLayout",
|
|
2903
2955
|
/**
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
|
|
2956
|
+
* The **Schedule** menu action on a Liveboard.
|
|
2957
|
+
* Allows scheduling a Liveboard notification.
|
|
2958
|
+
*
|
|
2959
|
+
* @example
|
|
2960
|
+
* ```js
|
|
2961
|
+
* disabledActions: [Action.Schedule]
|
|
2962
|
+
* ```
|
|
2963
|
+
*/
|
|
2911
2964
|
Schedule = "subscription",
|
|
2912
2965
|
/**
|
|
2913
|
-
|
|
2914
|
-
|
|
2915
|
-
|
|
2916
|
-
|
|
2917
|
-
|
|
2918
|
-
|
|
2919
|
-
|
|
2966
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
2967
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
2968
|
+
*
|
|
2969
|
+
* @example
|
|
2970
|
+
* ```js
|
|
2971
|
+
* disabledActions: [Action.SchedulesList]
|
|
2972
|
+
* ```
|
|
2973
|
+
*/
|
|
2920
2974
|
SchedulesList = "schedule-list",
|
|
2921
2975
|
/**
|
|
2922
|
-
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
|
|
2926
|
-
|
|
2927
|
-
|
|
2928
|
-
|
|
2976
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
2977
|
+
* Allows users to share an object with other users and groups.
|
|
2978
|
+
*
|
|
2979
|
+
* @example
|
|
2980
|
+
* ```js
|
|
2981
|
+
* disabledActions: [Action.Share]
|
|
2982
|
+
* ```
|
|
2983
|
+
*/
|
|
2929
2984
|
Share = "share",
|
|
2930
2985
|
/**
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
|
|
2936
|
-
|
|
2937
|
-
|
|
2986
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
2987
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
2988
|
+
*
|
|
2989
|
+
* @example
|
|
2990
|
+
* ```js
|
|
2991
|
+
* disabledActions: [Action.AddFilter]
|
|
2992
|
+
* ```
|
|
2993
|
+
*/
|
|
2938
2994
|
AddFilter = "addFilter",
|
|
2939
2995
|
/**
|
|
2940
|
-
|
|
2941
|
-
|
|
2942
|
-
|
|
2943
|
-
|
|
2944
|
-
|
|
2945
|
-
|
|
2946
|
-
|
|
2947
|
-
|
|
2996
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
2997
|
+
* Allows configuring filter options when adding filters to a
|
|
2998
|
+
* Liveboard or Answer.
|
|
2999
|
+
*
|
|
3000
|
+
* @example
|
|
3001
|
+
* ```js
|
|
3002
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
3003
|
+
* ```
|
|
3004
|
+
*/
|
|
2948
3005
|
ConfigureFilter = "configureFilter",
|
|
2949
3006
|
CollapseDataSources = "collapseDataSources",
|
|
2950
3007
|
/**
|
|
2951
|
-
|
|
2952
|
-
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
|
|
2956
|
-
|
|
2957
|
-
|
|
3008
|
+
* The **Choose sources** button on Search page.
|
|
3009
|
+
* Allows selecting data sources for search queries.
|
|
3010
|
+
*
|
|
3011
|
+
* @example
|
|
3012
|
+
* ```js
|
|
3013
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
3014
|
+
* ```
|
|
3015
|
+
*/
|
|
2958
3016
|
ChooseDataSources = "chooseDataSources",
|
|
2959
3017
|
/**
|
|
2960
|
-
|
|
2961
|
-
|
|
2962
|
-
|
|
2963
|
-
|
|
2964
|
-
|
|
2965
|
-
|
|
2966
|
-
|
|
3018
|
+
* The **Create formula** action on a Search or Answer page.
|
|
3019
|
+
* Allows adding formulas to an Answer.
|
|
3020
|
+
*
|
|
3021
|
+
* @example
|
|
3022
|
+
* ```js
|
|
3023
|
+
* disabledActions: [Action.AddFormula]
|
|
3024
|
+
* ```
|
|
3025
|
+
*/
|
|
2967
3026
|
AddFormula = "addFormula",
|
|
2968
3027
|
/**
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
|
|
2975
|
-
|
|
3028
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
3029
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
3030
|
+
*
|
|
3031
|
+
* @example
|
|
3032
|
+
* ```js
|
|
3033
|
+
* disabledActions: [Action.AddParameter]
|
|
3034
|
+
* ```
|
|
3035
|
+
*/
|
|
2976
3036
|
AddParameter = "addParameter",
|
|
2977
3037
|
/**
|
|
2978
3038
|
* @hidden
|
|
2979
3039
|
*/
|
|
2980
3040
|
SearchOnTop = "searchOnTop",
|
|
2981
3041
|
/**
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
|
|
2987
|
-
|
|
2988
|
-
|
|
3042
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
3043
|
+
* Answer page.
|
|
3044
|
+
*
|
|
3045
|
+
* @example
|
|
3046
|
+
* ```js
|
|
3047
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
3048
|
+
* ```
|
|
3049
|
+
*/
|
|
2989
3050
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2990
3051
|
/**
|
|
2991
3052
|
* @hidden
|
|
@@ -3001,89 +3062,98 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3001
3062
|
*/
|
|
3002
3063
|
ReplaySearch = "replaySearch",
|
|
3003
3064
|
/**
|
|
3004
|
-
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
|
|
3065
|
+
* The **Show underlying data** menu action on a visualization or
|
|
3066
|
+
* Answer page.
|
|
3067
|
+
*
|
|
3068
|
+
* @example
|
|
3069
|
+
* ```js
|
|
3070
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
3071
|
+
* ```
|
|
3072
|
+
*/
|
|
3011
3073
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3012
3074
|
/**
|
|
3013
|
-
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
|
|
3075
|
+
* The **Download** menu action on Liveboard visualizations
|
|
3076
|
+
* and Answers.
|
|
3077
|
+
* Allows downloading a visualization or Answer.
|
|
3078
|
+
*
|
|
3079
|
+
* @example
|
|
3080
|
+
* ```js
|
|
3081
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3082
|
+
* ```
|
|
3083
|
+
*/
|
|
3021
3084
|
Download = "download",
|
|
3022
3085
|
/**
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
|
|
3026
|
-
|
|
3027
|
-
|
|
3028
|
-
|
|
3029
|
-
|
|
3030
|
-
|
|
3086
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3087
|
+
* or Answer page.
|
|
3088
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
3089
|
+
*
|
|
3090
|
+
* @example
|
|
3091
|
+
* ```js
|
|
3092
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3093
|
+
* ```
|
|
3094
|
+
*/
|
|
3031
3095
|
DownloadAsPng = "downloadAsPng",
|
|
3032
3096
|
/**
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
|
|
3038
|
-
|
|
3039
|
-
|
|
3097
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3098
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
3099
|
+
*
|
|
3100
|
+
* @example
|
|
3101
|
+
* ```js
|
|
3102
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
3103
|
+
* ```
|
|
3104
|
+
*/
|
|
3040
3105
|
DownloadAsPdf = "downloadAsPdf",
|
|
3041
3106
|
/**
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3107
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3108
|
+
* or Answer page.
|
|
3109
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3110
|
+
*
|
|
3111
|
+
* @example
|
|
3112
|
+
* ```js
|
|
3113
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
3114
|
+
* ```
|
|
3115
|
+
*/
|
|
3050
3116
|
DownloadAsCsv = "downloadAsCSV",
|
|
3051
3117
|
/**
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
|
|
3055
|
-
|
|
3056
|
-
|
|
3057
|
-
|
|
3058
|
-
|
|
3059
|
-
|
|
3118
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3119
|
+
* or Answer page.
|
|
3120
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3121
|
+
*
|
|
3122
|
+
* @example
|
|
3123
|
+
* ```js
|
|
3124
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
3125
|
+
* ```
|
|
3126
|
+
*/
|
|
3060
3127
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
3061
3128
|
/**
|
|
3062
3129
|
* @hidden
|
|
3063
3130
|
*/
|
|
3064
3131
|
DownloadTrace = "downloadTrace",
|
|
3065
3132
|
/**
|
|
3066
|
-
|
|
3067
|
-
|
|
3068
|
-
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
|
|
3133
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
3134
|
+
* Worksheets and Data Connections page.
|
|
3135
|
+
* Exports an object as a TML file.
|
|
3136
|
+
*
|
|
3137
|
+
* @example
|
|
3138
|
+
* ```js
|
|
3139
|
+
* disabledActions: [Action.ExportTML]
|
|
3140
|
+
* ```
|
|
3141
|
+
*/
|
|
3074
3142
|
ExportTML = "exportTSL",
|
|
3075
3143
|
/**
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
|
|
3144
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
3145
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
3146
|
+
*
|
|
3147
|
+
* @example
|
|
3148
|
+
* ```js
|
|
3149
|
+
* disabledActions: [Action.ImportTML]
|
|
3150
|
+
* ```
|
|
3151
|
+
*/
|
|
3083
3152
|
ImportTML = "importTSL",
|
|
3084
3153
|
/**
|
|
3085
3154
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
3086
3155
|
* Update TML representation of ThoughtSpot objects.
|
|
3156
|
+
*
|
|
3087
3157
|
* @example
|
|
3088
3158
|
* ```js
|
|
3089
3159
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -3093,6 +3163,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3093
3163
|
/**
|
|
3094
3164
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3095
3165
|
* Opens the TML editor.
|
|
3166
|
+
*
|
|
3096
3167
|
* @example
|
|
3097
3168
|
* ```js
|
|
3098
3169
|
* disabledActions: [Action.EditTML]
|
|
@@ -3100,50 +3171,55 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3100
3171
|
*/
|
|
3101
3172
|
EditTML = "editTSL",
|
|
3102
3173
|
/**
|
|
3103
|
-
|
|
3104
|
-
|
|
3105
|
-
|
|
3106
|
-
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
|
|
3174
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
3175
|
+
* Allows presenting a Liveboard or visualization in
|
|
3176
|
+
* slideshow mode.
|
|
3177
|
+
*
|
|
3178
|
+
* @example
|
|
3179
|
+
* ```js
|
|
3180
|
+
* disabledActions: [Action.Present]
|
|
3181
|
+
* ```
|
|
3182
|
+
*/
|
|
3111
3183
|
Present = "present",
|
|
3112
3184
|
/**
|
|
3113
|
-
|
|
3114
|
-
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
|
|
3185
|
+
* The tile resize options in the visualization menu.
|
|
3186
|
+
* Allows switching between different preset layouts.
|
|
3187
|
+
*
|
|
3188
|
+
* @example
|
|
3189
|
+
* ```js
|
|
3190
|
+
* disabledActions: [Action.ToggleSize]
|
|
3191
|
+
* ```
|
|
3192
|
+
*/
|
|
3120
3193
|
ToggleSize = "toggleSize",
|
|
3121
3194
|
/**
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
|
|
3127
|
-
|
|
3128
|
-
|
|
3129
|
-
|
|
3195
|
+
* The *Edit* action on the Liveboard page and in the
|
|
3196
|
+
* visualization menu.
|
|
3197
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
3198
|
+
*
|
|
3199
|
+
* @example
|
|
3200
|
+
* ```js
|
|
3201
|
+
* disabledActions: [Action.Edit]
|
|
3202
|
+
* ```
|
|
3203
|
+
*/
|
|
3130
3204
|
Edit = "edit",
|
|
3131
3205
|
/**
|
|
3132
|
-
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
|
|
3206
|
+
* The text edit option for Liveboard and visualization titles.
|
|
3207
|
+
*
|
|
3208
|
+
* @example
|
|
3209
|
+
* ```js
|
|
3210
|
+
* disabledActions: [Action.EditTitle]
|
|
3211
|
+
* ```
|
|
3212
|
+
*/
|
|
3138
3213
|
EditTitle = "editTitle",
|
|
3139
3214
|
/**
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3215
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
3216
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3217
|
+
*
|
|
3218
|
+
* @example
|
|
3219
|
+
* ```js
|
|
3220
|
+
* disabledActions: [Action.Remove]
|
|
3221
|
+
* ```
|
|
3222
|
+
*/
|
|
3147
3223
|
Remove = "delete",
|
|
3148
3224
|
/**
|
|
3149
3225
|
* @hidden
|
|
@@ -3166,15 +3242,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3166
3242
|
*/
|
|
3167
3243
|
PinboardInfo = "pinboardInfo",
|
|
3168
3244
|
/**
|
|
3169
|
-
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3245
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
3246
|
+
* Displays details such as the name, description, and
|
|
3247
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3248
|
+
* and update.
|
|
3249
|
+
*
|
|
3250
|
+
* @example
|
|
3251
|
+
* ```js
|
|
3252
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
3253
|
+
* ```
|
|
3254
|
+
*/
|
|
3178
3255
|
LiveboardInfo = "pinboardInfo",
|
|
3179
3256
|
/**
|
|
3180
3257
|
* @hidden
|
|
@@ -3185,13 +3262,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3185
3262
|
*/
|
|
3186
3263
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
3187
3264
|
/**
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
3191
|
-
|
|
3192
|
-
|
|
3193
|
-
|
|
3194
|
-
|
|
3265
|
+
* The **Pin** menu action on an Answer or
|
|
3266
|
+
* Search results page.
|
|
3267
|
+
*
|
|
3268
|
+
* @example
|
|
3269
|
+
* ```js
|
|
3270
|
+
* disabledActions: [Action.Pin]
|
|
3271
|
+
* ```
|
|
3272
|
+
*/
|
|
3195
3273
|
Pin = "pin",
|
|
3196
3274
|
/**
|
|
3197
3275
|
* @hidden
|
|
@@ -3199,6 +3277,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3199
3277
|
AnalysisInfo = "analysisInfo",
|
|
3200
3278
|
/**
|
|
3201
3279
|
* The **Schedule** menu action on a Liveboard.
|
|
3280
|
+
*
|
|
3202
3281
|
* @example
|
|
3203
3282
|
* ```js
|
|
3204
3283
|
* disabledActions: [Action.Subscription]
|
|
@@ -3206,25 +3285,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3206
3285
|
*/
|
|
3207
3286
|
Subscription = "subscription",
|
|
3208
3287
|
/**
|
|
3209
|
-
|
|
3210
|
-
|
|
3211
|
-
|
|
3212
|
-
|
|
3213
|
-
|
|
3214
|
-
|
|
3288
|
+
* The **Explore** action on Liveboard visualizations
|
|
3289
|
+
*
|
|
3290
|
+
* @example
|
|
3291
|
+
* ```js
|
|
3292
|
+
* disabledActions: [Action.Explore]
|
|
3293
|
+
* ```
|
|
3294
|
+
*/
|
|
3215
3295
|
Explore = "explore",
|
|
3216
3296
|
/**
|
|
3217
|
-
|
|
3218
|
-
|
|
3219
|
-
|
|
3220
|
-
|
|
3221
|
-
|
|
3222
|
-
|
|
3223
|
-
|
|
3297
|
+
* The action to include data points on a drilled-down Answer
|
|
3298
|
+
* or visualization
|
|
3299
|
+
*
|
|
3300
|
+
* @example
|
|
3301
|
+
* ```js
|
|
3302
|
+
* disabledActions: [Action.DrillInclude]
|
|
3303
|
+
* ```
|
|
3304
|
+
*/
|
|
3224
3305
|
DrillInclude = "context-menu-item-include",
|
|
3225
3306
|
/**
|
|
3226
3307
|
* The action to exclude data points on a drilled-down Answer
|
|
3227
3308
|
* or visualization
|
|
3309
|
+
*
|
|
3228
3310
|
* @example
|
|
3229
3311
|
* ```js
|
|
3230
3312
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3235,6 +3317,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3235
3317
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3236
3318
|
* or Liveboard.
|
|
3237
3319
|
* Copies the selected data point.
|
|
3320
|
+
*
|
|
3238
3321
|
* @example
|
|
3239
3322
|
* ```js
|
|
3240
3323
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -3252,6 +3335,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3252
3335
|
* The **Drill down** menu action on Answers and Liveboard
|
|
3253
3336
|
* visualizations.
|
|
3254
3337
|
* Allows drilling down to a specific data point on a chart or table.
|
|
3338
|
+
*
|
|
3255
3339
|
* @example
|
|
3256
3340
|
* ```js
|
|
3257
3341
|
* disabledActions: [Action.DrillDown]
|
|
@@ -3261,6 +3345,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3261
3345
|
/**
|
|
3262
3346
|
* The request access action on Liveboards.
|
|
3263
3347
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3348
|
+
*
|
|
3264
3349
|
* @example
|
|
3265
3350
|
* ```js
|
|
3266
3351
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -3270,6 +3355,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3270
3355
|
/**
|
|
3271
3356
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3272
3357
|
* of the Answer page
|
|
3358
|
+
*
|
|
3273
3359
|
* @example
|
|
3274
3360
|
* ```js
|
|
3275
3361
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3278,6 +3364,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3278
3364
|
QueryDetailsButtons = "QueryDetailsButtons",
|
|
3279
3365
|
/**
|
|
3280
3366
|
* The **Delete** action for Answers.
|
|
3367
|
+
*
|
|
3281
3368
|
* @example
|
|
3282
3369
|
* ```js
|
|
3283
3370
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -3287,6 +3374,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3287
3374
|
AnswerDelete = "onDeleteAnswer",
|
|
3288
3375
|
/**
|
|
3289
3376
|
* The Chart switcher icon on Answer and visualization pages.
|
|
3377
|
+
*
|
|
3290
3378
|
* @example
|
|
3291
3379
|
* ```js
|
|
3292
3380
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3296,6 +3384,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3296
3384
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3297
3385
|
/**
|
|
3298
3386
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3387
|
+
*
|
|
3299
3388
|
* @example
|
|
3300
3389
|
* ```js
|
|
3301
3390
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3305,6 +3394,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3305
3394
|
AddToFavorites = "addToFavorites",
|
|
3306
3395
|
/**
|
|
3307
3396
|
* The edit icon on Liveboards (Classic experience).
|
|
3397
|
+
*
|
|
3308
3398
|
* @example
|
|
3309
3399
|
* ```js
|
|
3310
3400
|
* disabledActions: [Action.EditDetails]
|
|
@@ -3314,6 +3404,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3314
3404
|
EditDetails = "editDetails",
|
|
3315
3405
|
/**
|
|
3316
3406
|
* The Create alert action on KPI charts.
|
|
3407
|
+
*
|
|
3317
3408
|
* @example
|
|
3318
3409
|
* ```js
|
|
3319
3410
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -3332,6 +3423,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3332
3423
|
/**
|
|
3333
3424
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3334
3425
|
* Allows sending data to a Google Sheet.
|
|
3426
|
+
*
|
|
3335
3427
|
* @example
|
|
3336
3428
|
* ```js
|
|
3337
3429
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -3343,6 +3435,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3343
3435
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3344
3436
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3345
3437
|
* Microsoft Teams, and so on.
|
|
3438
|
+
*
|
|
3346
3439
|
* @example
|
|
3347
3440
|
* ```js
|
|
3348
3441
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3353,6 +3446,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3353
3446
|
/**
|
|
3354
3447
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3355
3448
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
3449
|
+
*
|
|
3356
3450
|
* @example
|
|
3357
3451
|
* ```js
|
|
3358
3452
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3363,6 +3457,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3363
3457
|
/**
|
|
3364
3458
|
* The **Filter** action on Liveboard visualizations.
|
|
3365
3459
|
* Allows users to apply cross-filters on a Liveboard.
|
|
3460
|
+
*
|
|
3366
3461
|
* @example
|
|
3367
3462
|
* ```js
|
|
3368
3463
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -3374,6 +3469,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3374
3469
|
* The **Remove** action that appears when cross filters are applied
|
|
3375
3470
|
* on a Liveboard.
|
|
3376
3471
|
* Removes filters applied o a visualization.
|
|
3472
|
+
*
|
|
3377
3473
|
* @example
|
|
3378
3474
|
* ```js
|
|
3379
3475
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3385,6 +3481,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3385
3481
|
* The **Aggregate** option in the chart axis or the
|
|
3386
3482
|
* table column customization menu.
|
|
3387
3483
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3484
|
+
*
|
|
3388
3485
|
* @example
|
|
3389
3486
|
* ```js
|
|
3390
3487
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3396,6 +3493,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3396
3493
|
* The **Time bucket** option in the chart axis or table column
|
|
3397
3494
|
* customization menu.
|
|
3398
3495
|
* Allows defining time metric for date comparison.
|
|
3496
|
+
*
|
|
3399
3497
|
* @example
|
|
3400
3498
|
* ```js
|
|
3401
3499
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3406,6 +3504,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3406
3504
|
/**
|
|
3407
3505
|
* The **Filter** action in the chart axis or table column
|
|
3408
3506
|
* customization menu.
|
|
3507
|
+
*
|
|
3409
3508
|
* @example
|
|
3410
3509
|
* ```js
|
|
3411
3510
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3417,6 +3516,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3417
3516
|
* The **Conditional formatting** action on chart or table.
|
|
3418
3517
|
* Allows adding rules for conditional formatting of data
|
|
3419
3518
|
* points on a chart or table.
|
|
3519
|
+
*
|
|
3420
3520
|
* @example
|
|
3421
3521
|
* ```js
|
|
3422
3522
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3428,6 +3528,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3428
3528
|
* The **Sort** menu action on a table or chart axis
|
|
3429
3529
|
* Sorts data in ascending or descending order.
|
|
3430
3530
|
* Allows adding, editing, or removing filters.
|
|
3531
|
+
*
|
|
3431
3532
|
* @example
|
|
3432
3533
|
* ```js
|
|
3433
3534
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3440,6 +3541,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3440
3541
|
* customization menu.
|
|
3441
3542
|
* Allows grouping data points if the axes use the same
|
|
3442
3543
|
* unit of measurement and a similar scale.
|
|
3544
|
+
*
|
|
3443
3545
|
* @example
|
|
3444
3546
|
* ```js
|
|
3445
3547
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3451,6 +3553,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3451
3553
|
* The **Position** option in the axis customization menu.
|
|
3452
3554
|
* Allows changing the position of the axis to the
|
|
3453
3555
|
* left or right side of the chart.
|
|
3556
|
+
*
|
|
3454
3557
|
* @example
|
|
3455
3558
|
* ```js
|
|
3456
3559
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3461,6 +3564,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3461
3564
|
/**
|
|
3462
3565
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3463
3566
|
* Renames the axis label on a chart or the column header on a table.
|
|
3567
|
+
*
|
|
3464
3568
|
* @example
|
|
3465
3569
|
* ```js
|
|
3466
3570
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3472,6 +3576,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3472
3576
|
* The **Edit** action in the axis customization menu.
|
|
3473
3577
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3474
3578
|
* and format of a column.
|
|
3579
|
+
*
|
|
3475
3580
|
* @example
|
|
3476
3581
|
* ```js
|
|
3477
3582
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3482,6 +3587,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3482
3587
|
/**
|
|
3483
3588
|
* The **Number format** action to customize the format of
|
|
3484
3589
|
* the data labels on a chart or table.
|
|
3590
|
+
*
|
|
3485
3591
|
* @example
|
|
3486
3592
|
* ```js
|
|
3487
3593
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3492,6 +3598,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3492
3598
|
/**
|
|
3493
3599
|
* The **Text wrapping** action on a table.
|
|
3494
3600
|
* Wraps or clips column text on a table.
|
|
3601
|
+
*
|
|
3495
3602
|
* @example
|
|
3496
3603
|
* ```js
|
|
3497
3604
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3504,6 +3611,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3504
3611
|
* customization menu.
|
|
3505
3612
|
* Removes the data labels from a chart or the column of a
|
|
3506
3613
|
* table visualization.
|
|
3614
|
+
*
|
|
3507
3615
|
* @example
|
|
3508
3616
|
* ```js
|
|
3509
3617
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3518,6 +3626,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3518
3626
|
/**
|
|
3519
3627
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3520
3628
|
* Allows renaming a Liveboard or visualization.
|
|
3629
|
+
*
|
|
3521
3630
|
* @example
|
|
3522
3631
|
* ```js
|
|
3523
3632
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3534,13 +3643,29 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3534
3643
|
*/
|
|
3535
3644
|
MarkAsVerified = "markAsVerified",
|
|
3536
3645
|
/**
|
|
3537
|
-
* @version SDK: 1.
|
|
3646
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3538
3647
|
*/
|
|
3539
3648
|
AddTab = "addTab",
|
|
3540
3649
|
/**
|
|
3541
3650
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
3542
3651
|
*/
|
|
3543
|
-
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
|
|
3652
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
3653
|
+
/**
|
|
3654
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3655
|
+
*/
|
|
3656
|
+
ShowSageQuery = "showSageQuery",
|
|
3657
|
+
/**
|
|
3658
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3659
|
+
*/
|
|
3660
|
+
EditSageAnswer = "editSageAnswer",
|
|
3661
|
+
/**
|
|
3662
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3663
|
+
*/
|
|
3664
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
3665
|
+
/**
|
|
3666
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3667
|
+
*/
|
|
3668
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
3544
3669
|
}
|
|
3545
3670
|
export interface SessionInterface {
|
|
3546
3671
|
sessionId: string;
|
|
@@ -3892,6 +4017,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
|
|
|
3892
4017
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
3893
4018
|
* GPT and LLM.
|
|
3894
4019
|
*
|
|
4020
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
3895
4021
|
* @group Embed components
|
|
3896
4022
|
*/
|
|
3897
4023
|
export interface SageViewConfig extends ViewConfig {
|
|
@@ -3912,6 +4038,19 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
|
|
|
3912
4038
|
*
|
|
3913
4039
|
*/
|
|
3914
4040
|
showObjectSuggestions?: boolean;
|
|
4041
|
+
/**
|
|
4042
|
+
* The query string to pre-fill in natual language search bar
|
|
4043
|
+
*/
|
|
4044
|
+
searchQuery?: string;
|
|
4045
|
+
/**
|
|
4046
|
+
* If set to true, sample questions would be hidden to user.
|
|
4047
|
+
* These sample questions are autogenerated based on selected datasource.
|
|
4048
|
+
*/
|
|
4049
|
+
hideSampleQuestions?: boolean;
|
|
4050
|
+
/**
|
|
4051
|
+
* The data source GUID to set on load.
|
|
4052
|
+
*/
|
|
4053
|
+
dataSource?: string;
|
|
3915
4054
|
}
|
|
3916
4055
|
export const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
3917
4056
|
/**
|