@thoughtspot/visual-embed-sdk 1.35.9 → 1.35.11
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 +11 -2
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +1 -1
- package/cjs/src/embed/liveboard.d.ts +2 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +1 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +16 -0
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
- package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
- package/cjs/src/embed/searchEmbed-basic-auth.spec.js +104 -0
- package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
- package/cjs/src/hostEventsTypeMapping.d.ts +2 -0
- package/cjs/src/hostEventsTypeMapping.d.ts.map +1 -0
- package/cjs/src/hostEventsTypeMapping.js +4 -0
- package/cjs/src/hostEventsTypeMapping.js.map +1 -0
- package/cjs/src/react/all-types-export.d.ts +1 -1
- package/cjs/src/react/all-types-export.d.ts.map +1 -1
- package/cjs/src/react/all-types-export.js +3 -1
- package/cjs/src/react/all-types-export.js.map +1 -1
- package/cjs/src/types.d.ts +253 -155
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +229 -131
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/embedApi/contracts.d.ts +101 -0
- package/cjs/src/utils/embedApi/contracts.d.ts.map +1 -0
- package/cjs/src/utils/embedApi/contracts.js +17 -0
- package/cjs/src/utils/embedApi/contracts.js.map +1 -0
- package/cjs/src/utils/embedApi/embedApiClient.d.ts +12 -0
- package/cjs/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
- package/cjs/src/utils/embedApi/embedApiClient.js +46 -0
- package/cjs/src/utils/embedApi/embedApiClient.js.map +1 -0
- package/cjs/src/utils/embedApi/processEmbedApi.d.ts +9 -0
- package/cjs/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
- package/cjs/src/utils/embedApi/processEmbedApi.js +18 -0
- package/cjs/src/utils/embedApi/processEmbedApi.js.map +1 -0
- package/dist/{index-VzrsEH43.js → index-BBBimG1x.js} +1 -1
- package/dist/index-BGnxP5NY.js +7370 -0
- package/dist/index-CENLvayL.js +7370 -0
- package/dist/index-CbltIawo.js +7370 -0
- package/dist/index-CoQfqaHj.js +7370 -0
- package/dist/index-CzwzS0P4.js +7370 -0
- package/dist/index-DFwi_pV_.js +7370 -0
- package/dist/index-DOIjN0N_.js +7370 -0
- package/dist/index-DYBx8SuE.js +7370 -0
- package/dist/index-DaLHJaLd.js +7370 -0
- package/dist/index-DnJX-gN2.js +7370 -0
- package/dist/index-IDmSUe93.js +7370 -0
- package/dist/index-nWevLycs.js +7370 -0
- package/dist/src/embed/app.d.ts +11 -2
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +1 -1
- package/dist/src/embed/liveboard.d.ts +2 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
- package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
- package/dist/src/hostEventsTypeMapping.d.ts +2 -0
- package/dist/src/hostEventsTypeMapping.d.ts.map +1 -0
- package/dist/src/react/all-types-export.d.ts +1 -1
- package/dist/src/react/all-types-export.d.ts.map +1 -1
- package/dist/src/types.d.ts +253 -155
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/embedApi/contracts.d.ts +101 -0
- package/dist/src/utils/embedApi/contracts.d.ts.map +1 -0
- package/dist/src/utils/embedApi/embedApiClient.d.ts +12 -0
- package/dist/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
- package/dist/src/utils/embedApi/processEmbedApi.d.ts +9 -0
- package/dist/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
- package/dist/tsembed-react.es.js +234 -136
- package/dist/tsembed-react.js +233 -135
- package/dist/tsembed.es.js +234 -136
- package/dist/tsembed.js +233 -135
- package/dist/visual-embed-sdk-react-full.d.ts +267 -158
- package/dist/visual-embed-sdk-react.d.ts +267 -158
- package/dist/visual-embed-sdk.d.ts +267 -158
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +11 -2
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +1 -1
- package/lib/src/embed/liveboard.d.ts +2 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +1 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +16 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
- package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
- package/lib/src/embed/searchEmbed-basic-auth.spec.js +101 -0
- package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
- package/lib/src/hostEventsTypeMapping.d.ts +2 -0
- package/lib/src/hostEventsTypeMapping.d.ts.map +1 -0
- package/lib/src/hostEventsTypeMapping.js +2 -0
- package/lib/src/hostEventsTypeMapping.js.map +1 -0
- package/lib/src/react/all-types-export.d.ts +1 -1
- package/lib/src/react/all-types-export.d.ts.map +1 -1
- package/lib/src/react/all-types-export.js +1 -1
- package/lib/src/react/all-types-export.js.map +1 -1
- package/lib/src/types.d.ts +253 -155
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +229 -131
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/embedApi/contracts.d.ts +101 -0
- package/lib/src/utils/embedApi/contracts.d.ts.map +1 -0
- package/lib/src/utils/embedApi/contracts.js +14 -0
- package/lib/src/utils/embedApi/contracts.js.map +1 -0
- package/lib/src/utils/embedApi/embedApiClient.d.ts +12 -0
- package/lib/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
- package/lib/src/utils/embedApi/embedApiClient.js +42 -0
- package/lib/src/utils/embedApi/embedApiClient.js.map +1 -0
- package/lib/src/utils/embedApi/processEmbedApi.d.ts +9 -0
- package/lib/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
- package/lib/src/utils/embedApi/processEmbedApi.js +14 -0
- package/lib/src/utils/embedApi/processEmbedApi.js.map +1 -0
- package/lib/src/visual-embed-sdk.d.ts +267 -158
- package/package.json +1 -1
- package/src/embed/app.ts +11 -2
- package/src/embed/hostEventClient/contracts.ts +1 -1
- package/src/embed/liveboard.spec.ts +22 -1
- package/src/embed/liveboard.ts +3 -1
- package/src/react/all-types-export.ts +2 -0
- package/src/types.ts +253 -161
|
@@ -280,8 +280,17 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
|
|
|
280
280
|
*/
|
|
281
281
|
enableSearchAssist?: boolean;
|
|
282
282
|
/**
|
|
283
|
-
* If set to true, the
|
|
284
|
-
* according to the height of the
|
|
283
|
+
* If set to true, the Liveboard container dynamically resizes
|
|
284
|
+
* according to the height of the Liveboard.
|
|
285
|
+
*
|
|
286
|
+
* **Note**: Using fullHeight loads all visualizations
|
|
287
|
+
* on the Liveboard simultaneously, which results in
|
|
288
|
+
* multiple warehouse queries and potentially a
|
|
289
|
+
* longer wait for the topmost visualizations to
|
|
290
|
+
* display on the screen. Setting fullHeight to
|
|
291
|
+
* `false` fetches visualizations incrementally as
|
|
292
|
+
* users scroll the page to view the charts and tables.
|
|
293
|
+
*
|
|
285
294
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
286
295
|
* @example
|
|
287
296
|
* ```js
|
|
@@ -689,12 +698,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
|
|
|
689
698
|
/**
|
|
690
699
|
* If set to true, the embedded object container dynamically resizes
|
|
691
700
|
* according to the height of the Liveboard.
|
|
701
|
+
*
|
|
692
702
|
* **Note**: Using fullHeight loads all visualizations on the
|
|
693
703
|
* Liveboard simultaneously, which results in multiple warehouse
|
|
694
704
|
* queries and potentially a longer wait for the topmost
|
|
695
705
|
* visualizations to display on the screen.
|
|
696
706
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
697
707
|
* incrementally as users scroll the page to view the charts and tables.
|
|
708
|
+
*
|
|
698
709
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
699
710
|
* @example
|
|
700
711
|
* ```js
|
|
@@ -1864,7 +1875,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1864
1875
|
*/
|
|
1865
1876
|
export enum AuthType {
|
|
1866
1877
|
/**
|
|
1867
|
-
* No authentication on the SDK.
|
|
1878
|
+
* No authentication on the SDK. Pass-through to the embedded App. Alias for
|
|
1868
1879
|
* `Passthrough`.
|
|
1869
1880
|
* @example
|
|
1870
1881
|
* ```js
|
|
@@ -2061,8 +2072,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2061
2072
|
/**
|
|
2062
2073
|
* The custom css variables, which can be set.
|
|
2063
2074
|
* The allowed list is in the CustomCssVariables
|
|
2064
|
-
* interface.
|
|
2065
|
-
*
|
|
2075
|
+
* interface. For more information, see
|
|
2076
|
+
* link:https://developers.thoughtspot.com/docs/css-variables-reference
|
|
2066
2077
|
*/
|
|
2067
2078
|
variables?: CustomCssVariables;
|
|
2068
2079
|
/**
|
|
@@ -2104,7 +2115,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2104
2115
|
}
|
|
2105
2116
|
/**
|
|
2106
2117
|
* Configuration to define the customization on the Embedded
|
|
2107
|
-
*
|
|
2118
|
+
* ThoughtSpot components.
|
|
2108
2119
|
* You can customize styles, text strings, and icons.
|
|
2109
2120
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
2110
2121
|
* @example
|
|
@@ -2224,7 +2235,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2224
2235
|
/**
|
|
2225
2236
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
2226
2237
|
* should be encoded in base64. This provides additional security to
|
|
2227
|
-
*
|
|
2238
|
+
* ThoughtSpot clusters against cross-site scripting attacks.
|
|
2228
2239
|
* @default false
|
|
2229
2240
|
*/
|
|
2230
2241
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -2377,18 +2388,18 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2377
2388
|
*/
|
|
2378
2389
|
disableSDKTracking?: boolean;
|
|
2379
2390
|
/**
|
|
2380
|
-
* Overrides default/user
|
|
2381
|
-
* @version SDK: 1.28.4 |
|
|
2391
|
+
* Overrides default/user preferred locale for date formatting
|
|
2392
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2382
2393
|
*/
|
|
2383
2394
|
dateFormatLocale?: string;
|
|
2384
2395
|
/**
|
|
2385
|
-
* Overrides default/user
|
|
2386
|
-
* @version SDK: 1.28.4 |
|
|
2396
|
+
* Overrides default/user preferred locale for number formatting
|
|
2397
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2387
2398
|
*/
|
|
2388
2399
|
numberFormatLocale?: string;
|
|
2389
2400
|
/**
|
|
2390
2401
|
* Format to be used for currency when currency format is set to infer from browser
|
|
2391
|
-
* @version SDK: 1.28.4 |
|
|
2402
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2392
2403
|
*/
|
|
2393
2404
|
currencyFormat?: string;
|
|
2394
2405
|
/**
|
|
@@ -2402,12 +2413,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2402
2413
|
* disableTokenVerification : true
|
|
2403
2414
|
* })
|
|
2404
2415
|
* ```
|
|
2405
|
-
* @version SDK: 1.28.5 |
|
|
2416
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
2406
2417
|
*/
|
|
2407
2418
|
disableTokenVerification?: boolean;
|
|
2408
2419
|
/**
|
|
2409
2420
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
2410
|
-
* @version SDK 1.32.3 |
|
|
2421
|
+
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
2411
2422
|
*/
|
|
2412
2423
|
disableLoginFailurePage?: boolean;
|
|
2413
2424
|
/**
|
|
@@ -2445,7 +2456,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2445
2456
|
* }
|
|
2446
2457
|
* });
|
|
2447
2458
|
* ```
|
|
2448
|
-
* @version SDK 1.37.0 |
|
|
2459
|
+
* @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
|
|
2449
2460
|
*/
|
|
2450
2461
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
2451
2462
|
}
|
|
@@ -2604,7 +2615,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2604
2615
|
/**
|
|
2605
2616
|
* The list of parameter override to apply to a search answer,
|
|
2606
2617
|
* visualization, or Liveboard.
|
|
2607
|
-
* @version SDK : 1.25.0 |
|
|
2618
|
+
* @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2608
2619
|
* @example
|
|
2609
2620
|
* ```js
|
|
2610
2621
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2664,7 +2675,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2664
2675
|
/**
|
|
2665
2676
|
* Insert as a sibling of the target container, instead of appending to a
|
|
2666
2677
|
* child inside it.
|
|
2667
|
-
* @version SDK: 1.2.0 |
|
|
2678
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
2668
2679
|
* @example
|
|
2669
2680
|
* ```js
|
|
2670
2681
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2737,7 +2748,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2737
2748
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
2738
2749
|
* });
|
|
2739
2750
|
* ```
|
|
2740
|
-
* @version SDK: 1.26.0 |
|
|
2751
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
2741
2752
|
*/
|
|
2742
2753
|
hiddenTabs?: string[];
|
|
2743
2754
|
/**
|
|
@@ -2747,7 +2758,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2747
2758
|
* **Note**: This option does not apply to the classic homepage.
|
|
2748
2759
|
* To access the updated modular homepage, set
|
|
2749
2760
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2750
|
-
* @version SDK: 1.28.0 |
|
|
2761
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2751
2762
|
* @example
|
|
2752
2763
|
* ```js
|
|
2753
2764
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2764,7 +2775,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2764
2775
|
* **Note**: This option does not apply to the classic homepage.
|
|
2765
2776
|
* To access the updated modular homepage, set
|
|
2766
2777
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2767
|
-
* @version SDK: 1.28.0|
|
|
2778
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2768
2779
|
* @example
|
|
2769
2780
|
* ```js
|
|
2770
2781
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2779,7 +2790,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2779
2790
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2780
2791
|
*
|
|
2781
2792
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2782
|
-
* @version SDK: 1.26.0 |
|
|
2793
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
2783
2794
|
* @example
|
|
2784
2795
|
* ```js
|
|
2785
2796
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2807,7 +2818,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2807
2818
|
* **Note**: This option does not apply to the classic homepage.
|
|
2808
2819
|
* To access the updated modular homepage, set
|
|
2809
2820
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2810
|
-
* @version SDK: 1.28.0 |
|
|
2821
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2811
2822
|
*/
|
|
2812
2823
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2813
2824
|
/**
|
|
@@ -2822,7 +2833,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2822
2833
|
* });
|
|
2823
2834
|
* embed.showPreRender();
|
|
2824
2835
|
* ```
|
|
2825
|
-
* @version SDK: 1.25.0 |
|
|
2836
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
2826
2837
|
*/
|
|
2827
2838
|
preRenderId?: string;
|
|
2828
2839
|
/**
|
|
@@ -2876,7 +2887,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2876
2887
|
/**
|
|
2877
2888
|
* To set the initial state of the search bar in case of saved Answers.
|
|
2878
2889
|
* @default true
|
|
2879
|
-
* @version SDK: 1.34.0 |
|
|
2890
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
2880
2891
|
* @example
|
|
2881
2892
|
* ```js
|
|
2882
2893
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2900,7 +2911,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2900
2911
|
/**
|
|
2901
2912
|
* Flag to control Data panel experience
|
|
2902
2913
|
* @default false
|
|
2903
|
-
* @version SDK: 1.34.0 |
|
|
2914
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
2904
2915
|
* @example
|
|
2905
2916
|
* ```js
|
|
2906
2917
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2912,7 +2923,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2912
2923
|
dataPanelV2?: boolean;
|
|
2913
2924
|
/**
|
|
2914
2925
|
* To enable custom column groups in data panel v2
|
|
2915
|
-
* @version SDK: 1.32.0 |
|
|
2926
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
2916
2927
|
* @default false
|
|
2917
2928
|
* @example
|
|
2918
2929
|
* ```js
|
|
@@ -2942,7 +2953,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
2942
2953
|
/**
|
|
2943
2954
|
* Flag to control new flip tooltip context menu experience
|
|
2944
2955
|
* @default false
|
|
2945
|
-
* @version SDK: 1.36.0 |
|
|
2956
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2946
2957
|
*/
|
|
2947
2958
|
enableFlipTooltipToContextMenu?: boolean;
|
|
2948
2959
|
}
|
|
@@ -3062,7 +3073,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3062
3073
|
* **Note**: This option does not apply to the classic homepage.
|
|
3063
3074
|
* To access the updated modular homepage, set
|
|
3064
3075
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3065
|
-
* @version SDK: 1.28.0 |
|
|
3076
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3066
3077
|
*/
|
|
3067
3078
|
export enum HomepageModule {
|
|
3068
3079
|
/**
|
|
@@ -3905,7 +3916,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3905
3916
|
*/
|
|
3906
3917
|
Explore = "explore",
|
|
3907
3918
|
/**
|
|
3908
|
-
* Emitted when a user clicks **Copy link** action on a visualization
|
|
3919
|
+
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
3909
3920
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3910
3921
|
* @example
|
|
3911
3922
|
*```js
|
|
@@ -3955,23 +3966,26 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3955
3966
|
*/
|
|
3956
3967
|
FilterChanged = "filterChanged",
|
|
3957
3968
|
/**
|
|
3958
|
-
* Emitted when a user clicks the **Go** button
|
|
3959
|
-
*
|
|
3969
|
+
* Emitted when a user clicks the **Go** button to initiate
|
|
3970
|
+
* a Natural Language Search query
|
|
3971
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3960
3972
|
*/
|
|
3961
3973
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3962
3974
|
/**
|
|
3963
|
-
* Emitted when a user selects a data source on the
|
|
3964
|
-
*
|
|
3975
|
+
* Emitted when a user selects a data source on the embedded
|
|
3976
|
+
* Natural Language Search interface.
|
|
3977
|
+
*
|
|
3978
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3965
3979
|
*/
|
|
3966
3980
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3967
3981
|
/**
|
|
3968
3982
|
* Emitted when a user updates a connection on the **Data** page
|
|
3969
|
-
* @version SDK : 1.27.0 |
|
|
3983
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3970
3984
|
*/
|
|
3971
3985
|
UpdateConnection = "updateConnection",
|
|
3972
3986
|
/**
|
|
3973
3987
|
* Emitted when a user updates a connection on the **Data** page
|
|
3974
|
-
* @version SDK : 1.27.0 |
|
|
3988
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3975
3989
|
*/
|
|
3976
3990
|
CreateConnection = "createConnection",
|
|
3977
3991
|
/**
|
|
@@ -3981,7 +3995,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3981
3995
|
* @returns viewId: string
|
|
3982
3996
|
* @returns liveboardId: string
|
|
3983
3997
|
* @returns isPublic: boolean
|
|
3984
|
-
* @version SDK : 1.26.0 |
|
|
3998
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3985
3999
|
*/
|
|
3986
4000
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3987
4001
|
/**
|
|
@@ -3990,7 +4004,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3990
4004
|
* @returns viewId: string
|
|
3991
4005
|
* @returns liveboardId: string
|
|
3992
4006
|
* @returns isPublic: boolean
|
|
3993
|
-
* @version SDK : 1.26.0 |
|
|
4007
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3994
4008
|
*/
|
|
3995
4009
|
SavePersonalisedView = "savePersonalisedView",
|
|
3996
4010
|
/**
|
|
@@ -3999,28 +4013,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3999
4013
|
* @returns viewId: string
|
|
4000
4014
|
* @returns liveboardId: string
|
|
4001
4015
|
* @returns isPublic: boolean
|
|
4002
|
-
* @version SDK : 1.26.0 |
|
|
4016
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4003
4017
|
*/
|
|
4004
4018
|
ResetLiveboard = "resetLiveboard",
|
|
4005
4019
|
/**
|
|
4006
4020
|
* Emitted when a PersonalisedView is deleted.
|
|
4007
4021
|
* @returns views: string[]
|
|
4008
4022
|
* @returns liveboardId: string
|
|
4009
|
-
* @version SDK : 1.26.0 |
|
|
4023
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4010
4024
|
*/
|
|
4011
4025
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
4012
4026
|
/**
|
|
4013
4027
|
* Emitted when a user creates a new worksheet
|
|
4014
|
-
* @version SDK : 1.27.0 |
|
|
4028
|
+
* @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
4015
4029
|
*/
|
|
4016
4030
|
CreateWorksheet = "createWorksheet",
|
|
4017
4031
|
/**
|
|
4018
|
-
* Emitted when Ask Sage is initialized.
|
|
4032
|
+
* Emitted when the *Ask Sage* is initialized.
|
|
4019
4033
|
* @returns viewName: string
|
|
4020
4034
|
* @returns viewId: string
|
|
4021
4035
|
* @returns liveboardId: string
|
|
4022
4036
|
* @returns isPublic: boolean
|
|
4023
|
-
* @version SDK : 1.29.0 |
|
|
4037
|
+
* @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
4024
4038
|
*/
|
|
4025
4039
|
AskSageInit = "AskSageInit",
|
|
4026
4040
|
/**
|
|
@@ -4048,7 +4062,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4048
4062
|
*
|
|
4049
4063
|
* error: Developers can customize the error message text when `execute`
|
|
4050
4064
|
* returns `false` using the error parameter in responder.
|
|
4051
|
-
* @version SDK : 1.29.0 |
|
|
4065
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
4052
4066
|
* @example
|
|
4053
4067
|
*```js
|
|
4054
4068
|
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
@@ -4096,7 +4110,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4096
4110
|
* console.log('payload', payload);
|
|
4097
4111
|
* })
|
|
4098
4112
|
*```
|
|
4099
|
-
* @version SDK : 1.29.0 |
|
|
4113
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
4100
4114
|
*/
|
|
4101
4115
|
ParameterChanged = "parameterChanged"
|
|
4102
4116
|
}
|
|
@@ -4243,7 +4257,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4243
4257
|
* const url = embed.trigger(HostEvent.GetIframeUrl);
|
|
4244
4258
|
* console.log("iFrameURL",url);
|
|
4245
4259
|
* ```
|
|
4246
|
-
* @version SDK: 1.35.0 |
|
|
4260
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
4247
4261
|
*/
|
|
4248
4262
|
GetIframeUrl = "GetIframeUrl",
|
|
4249
4263
|
/**
|
|
@@ -4276,6 +4290,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4276
4290
|
* attributes passed with this event are appended to the existing runtime
|
|
4277
4291
|
* filters applied on a Liveboard.
|
|
4278
4292
|
*
|
|
4293
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
|
|
4294
|
+
* and `AppEmbed` only. In full application embedding, this event updates
|
|
4295
|
+
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
4296
|
+
*
|
|
4297
|
+
*
|
|
4279
4298
|
* Pass an array of runtime filters with the following attributes:
|
|
4280
4299
|
*
|
|
4281
4300
|
* `columnName` - _String_. The name of the column to filter on.
|
|
@@ -4286,9 +4305,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4286
4305
|
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
4287
4306
|
* single value, whereas BW and IN accept multiple values.
|
|
4288
4307
|
*
|
|
4289
|
-
* **Note**:
|
|
4290
|
-
*
|
|
4291
|
-
*
|
|
4308
|
+
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
4309
|
+
* object to its original state and applies new filter conditions.
|
|
4310
|
+
* Any user changes (like drilling into a visualization)
|
|
4311
|
+
* will be cleared, restoring the original visualization
|
|
4312
|
+
* with the updated filters.
|
|
4313
|
+
*
|
|
4292
4314
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
4293
4315
|
* @example
|
|
4294
4316
|
* ```js
|
|
@@ -4303,7 +4325,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4303
4325
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
4304
4326
|
/**
|
|
4305
4327
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4306
|
-
* This is the same as calling `appEmbed.navigateToPage(path, true)
|
|
4328
|
+
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
4307
4329
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
4308
4330
|
* be a number; for example, `1`, `-1`.
|
|
4309
4331
|
* @example
|
|
@@ -4598,7 +4620,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4598
4620
|
*/
|
|
4599
4621
|
GetTML = "getTML",
|
|
4600
4622
|
/**
|
|
4601
|
-
* Trigger the **Show underlying data** action on
|
|
4623
|
+
* Trigger the **Show underlying data** action on a
|
|
4624
|
+
* chart or table.
|
|
4625
|
+
*
|
|
4602
4626
|
* @param - an object with vizId as a key
|
|
4603
4627
|
* @example
|
|
4604
4628
|
* ```js
|
|
@@ -4632,8 +4656,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4632
4656
|
*/
|
|
4633
4657
|
Delete = "onDeleteAnswer",
|
|
4634
4658
|
/**
|
|
4635
|
-
* Trigger the **SpotIQ analyze** action on
|
|
4636
|
-
* or
|
|
4659
|
+
* Trigger the **SpotIQ analyze** action on a
|
|
4660
|
+
* chart or table.
|
|
4637
4661
|
* @param - Liveboard embed takes `vizId` as a
|
|
4638
4662
|
* key. Can be left undefined when embedding Search or
|
|
4639
4663
|
* visualization.
|
|
@@ -4906,7 +4930,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4906
4930
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
4907
4931
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
4908
4932
|
* ```
|
|
4909
|
-
* @version SDK: 1.26.0 |
|
|
4933
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4910
4934
|
*/
|
|
4911
4935
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
4912
4936
|
/**
|
|
@@ -4919,7 +4943,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4919
4943
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
4920
4944
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
4921
4945
|
* ```
|
|
4922
|
-
* @version SDK: 1.26.0 |
|
|
4946
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4923
4947
|
*/
|
|
4924
4948
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4925
4949
|
/**
|
|
@@ -4933,7 +4957,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4933
4957
|
* executeSearch: true,
|
|
4934
4958
|
* })
|
|
4935
4959
|
* ```
|
|
4936
|
-
* @version SDK: 1.26.0 |
|
|
4960
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
4937
4961
|
*/
|
|
4938
4962
|
UpdateSageQuery = "updateSageQuery",
|
|
4939
4963
|
/**
|
|
@@ -4950,21 +4974,22 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4950
4974
|
* ```js
|
|
4951
4975
|
* const {session} = await embed.trigger( HostEvent.GetAnswerSession )
|
|
4952
4976
|
* ```
|
|
4953
|
-
* @version SDK: 1.26.0 |
|
|
4977
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
4954
4978
|
*/
|
|
4955
4979
|
GetAnswerSession = "getAnswerSession",
|
|
4956
4980
|
/**
|
|
4957
|
-
* Trigger Ask Sage for
|
|
4981
|
+
* Trigger the *Ask Sage* action for visualizations
|
|
4958
4982
|
* @example
|
|
4959
4983
|
* ```js
|
|
4960
4984
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
4961
4985
|
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
4962
4986
|
* ```
|
|
4963
|
-
* @version SDK: 1.29.0 |
|
|
4987
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
4964
4988
|
*/
|
|
4965
4989
|
AskSage = "AskSage",
|
|
4966
4990
|
/**
|
|
4967
|
-
* Trigger cross filter update action on a Liveboard
|
|
4991
|
+
* Trigger cross filter update action on a Liveboard.
|
|
4992
|
+
*
|
|
4968
4993
|
* @example
|
|
4969
4994
|
* ```js
|
|
4970
4995
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -4975,7 +5000,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4975
5000
|
* ],
|
|
4976
5001
|
* });
|
|
4977
5002
|
* ```
|
|
4978
|
-
* @version SDK: 1.29.0 |
|
|
5003
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
|
|
4979
5004
|
*/
|
|
4980
5005
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
4981
5006
|
/**
|
|
@@ -4984,11 +5009,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4984
5009
|
* ```js
|
|
4985
5010
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
4986
5011
|
* ```
|
|
4987
|
-
* @version SDK: 1.29.0 |
|
|
5012
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
|
|
4988
5013
|
*/
|
|
4989
5014
|
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4990
5015
|
/**
|
|
4991
|
-
* Triggers an
|
|
5016
|
+
* Triggers an action to update Parameter values on embedded
|
|
5017
|
+
* Answers and Liveboard.
|
|
5018
|
+
*
|
|
4992
5019
|
* @example
|
|
4993
5020
|
* ```js
|
|
4994
5021
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -4996,30 +5023,30 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4996
5023
|
* value: "almond"
|
|
4997
5024
|
* }])
|
|
4998
5025
|
*
|
|
4999
|
-
* @version SDK: 1.29.0 |
|
|
5026
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
5000
5027
|
*/
|
|
5001
5028
|
UpdateParameters = "UpdateParameters",
|
|
5002
5029
|
/**
|
|
5003
|
-
* Triggers GetParameters to fetch the runtime
|
|
5030
|
+
* Triggers GetParameters to fetch the runtime Parameters.
|
|
5004
5031
|
* ```js
|
|
5005
5032
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
5006
5033
|
* console.log('parameters', parameter);
|
|
5007
5034
|
* });
|
|
5008
5035
|
*```
|
|
5009
|
-
* @version SDK: 1.29.0 |
|
|
5036
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
5010
5037
|
*/
|
|
5011
5038
|
GetParameters = "GetParameters",
|
|
5012
5039
|
/**
|
|
5013
|
-
* Triggers an event to update a
|
|
5040
|
+
* Triggers an event to update a personalized view of a Liveboard.
|
|
5014
5041
|
* ```js
|
|
5015
5042
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
5016
5043
|
* ```
|
|
5017
|
-
* @version SDK: 1.36.0 |
|
|
5044
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5018
5045
|
*/
|
|
5019
5046
|
UpdatePersonalisedView = "UpdatePersonalisedView",
|
|
5020
5047
|
/**
|
|
5021
|
-
* Triggers the action to get the current view of the
|
|
5022
|
-
* @version SDK: 1.36.0 |
|
|
5048
|
+
* Triggers the action to get the current view of the Liveboard.
|
|
5049
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5023
5050
|
*/
|
|
5024
5051
|
SaveAnswer = "saveAnswer",
|
|
5025
5052
|
/**
|
|
@@ -5239,7 +5266,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5239
5266
|
ResetLayout = "resetLayout",
|
|
5240
5267
|
/**
|
|
5241
5268
|
* The **Schedule** menu action on a Liveboard.
|
|
5242
|
-
* Allows scheduling a Liveboard
|
|
5269
|
+
* Allows scheduling a Liveboard job, for example,
|
|
5270
|
+
* sending periodic notifications.
|
|
5243
5271
|
* @example
|
|
5244
5272
|
* ```js
|
|
5245
5273
|
* disabledActions: [Action.Schedule]
|
|
@@ -5281,7 +5309,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5281
5309
|
* ```js
|
|
5282
5310
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
5283
5311
|
* ```
|
|
5284
|
-
* @version SDK: 1.32.0 |
|
|
5312
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5285
5313
|
*/
|
|
5286
5314
|
AddDataPanelObjects = "addDataPanelObjects",
|
|
5287
5315
|
/**
|
|
@@ -5294,7 +5322,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5294
5322
|
* ```
|
|
5295
5323
|
*/
|
|
5296
5324
|
ConfigureFilter = "configureFilter",
|
|
5325
|
+
/**
|
|
5326
|
+
* The **Collapse data sources** icon on the Search page.
|
|
5327
|
+
* Collapses the panel showing data sources.
|
|
5328
|
+
*
|
|
5329
|
+
* @example
|
|
5330
|
+
* ```js
|
|
5331
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
5332
|
+
* ```
|
|
5333
|
+
* @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5334
|
+
*/
|
|
5297
5335
|
CollapseDataSources = "collapseDataSources",
|
|
5336
|
+
/**
|
|
5337
|
+
* The **Collapse data panel** icon on the Search page.
|
|
5338
|
+
* Collapses the data panel view.
|
|
5339
|
+
*
|
|
5340
|
+
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
|
|
5341
|
+
*
|
|
5342
|
+
* @example
|
|
5343
|
+
* ```js
|
|
5344
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
5345
|
+
* ```
|
|
5346
|
+
*/
|
|
5298
5347
|
CollapseDataPanel = "collapseDataPanel",
|
|
5299
5348
|
/**
|
|
5300
5349
|
* The **Choose sources** button on Search page.
|
|
@@ -5330,7 +5379,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5330
5379
|
* ```js
|
|
5331
5380
|
* disabledActions: [Action.AddColumnSet]
|
|
5332
5381
|
* ```
|
|
5333
|
-
* @version SDK: 1.32.0 |
|
|
5382
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5334
5383
|
*/
|
|
5335
5384
|
AddColumnSet = "addSimpleCohort",
|
|
5336
5385
|
/**
|
|
@@ -5340,7 +5389,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5340
5389
|
* ```js
|
|
5341
5390
|
* disabledActions: [Action.AddQuerySet]
|
|
5342
5391
|
* ```
|
|
5343
|
-
* @version SDK: 1.32.0 |
|
|
5392
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5344
5393
|
*/
|
|
5345
5394
|
AddQuerySet = "addAdvancedCohort",
|
|
5346
5395
|
/**
|
|
@@ -5372,6 +5421,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5372
5421
|
/**
|
|
5373
5422
|
* The **Show underlying data** menu action on a visualization or
|
|
5374
5423
|
* Answer page.
|
|
5424
|
+
* Displays detailed information and raw data
|
|
5425
|
+
* for a given visualization.
|
|
5375
5426
|
* @example
|
|
5376
5427
|
* ```js
|
|
5377
5428
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -5573,6 +5624,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5573
5624
|
AnalysisInfo = "analysisInfo",
|
|
5574
5625
|
/**
|
|
5575
5626
|
* The **Schedule** menu action on a Liveboard.
|
|
5627
|
+
* Allows scheduling a Liveboard job.
|
|
5576
5628
|
* @example
|
|
5577
5629
|
* ```js
|
|
5578
5630
|
* disabledActions: [Action.Subscription]
|
|
@@ -5642,8 +5694,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5642
5694
|
*/
|
|
5643
5695
|
RequestAccess = "requestAccess",
|
|
5644
5696
|
/**
|
|
5645
|
-
* The **Query visualizer** and **Query SQL** buttons in
|
|
5646
|
-
* of the Answer page
|
|
5697
|
+
* The **Query visualizer** and **Query SQL** buttons in
|
|
5698
|
+
* Query details panel of the Answer page.
|
|
5699
|
+
*
|
|
5700
|
+
* **Query visualizer** - Displays the tables
|
|
5701
|
+
* and filters used in a search query.
|
|
5702
|
+
* **Query SQL** - Displays the SQL statements used
|
|
5703
|
+
* in a search query to fetch data.
|
|
5647
5704
|
* @example
|
|
5648
5705
|
* ```js
|
|
5649
5706
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5661,7 +5718,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5661
5718
|
*/
|
|
5662
5719
|
AnswerDelete = "onDeleteAnswer",
|
|
5663
5720
|
/**
|
|
5664
|
-
* The
|
|
5721
|
+
* The chart switcher icon on Answer page and
|
|
5722
|
+
* visualizations in edit mode.
|
|
5723
|
+
* Allows switching to the table or chart mode
|
|
5724
|
+
* when editing a visualization.
|
|
5665
5725
|
* @example
|
|
5666
5726
|
* ```js
|
|
5667
5727
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -5670,7 +5730,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5670
5730
|
*/
|
|
5671
5731
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5672
5732
|
/**
|
|
5673
|
-
* Favorites icon (*)
|
|
5733
|
+
* The Favorites icon (*) for Answers,
|
|
5734
|
+
* Liveboard, and data objects like Worksheet, Model,
|
|
5735
|
+
* Tables and Views.
|
|
5736
|
+
* Allows adding an object to the user’s favorites list.
|
|
5674
5737
|
* @example
|
|
5675
5738
|
* ```js
|
|
5676
5739
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -5688,7 +5751,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5688
5751
|
*/
|
|
5689
5752
|
EditDetails = "editDetails",
|
|
5690
5753
|
/**
|
|
5691
|
-
* The Create alert action
|
|
5754
|
+
* The *Create alert* action for KPI charts.
|
|
5755
|
+
* Allows users to schedule threshold-based alerts
|
|
5756
|
+
* for KPI charts.
|
|
5692
5757
|
* @example
|
|
5693
5758
|
* ```js
|
|
5694
5759
|
* disabledActions: [Action.CreateMonitor]
|
|
@@ -5744,7 +5809,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5744
5809
|
* ```js
|
|
5745
5810
|
* disabledActions: [Action.CrossFilter]
|
|
5746
5811
|
* ```
|
|
5747
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5812
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
|
|
5748
5813
|
*/
|
|
5749
5814
|
CrossFilter = "context-menu-item-cross-filter",
|
|
5750
5815
|
/**
|
|
@@ -5754,7 +5819,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5754
5819
|
* ```js
|
|
5755
5820
|
* disabledActions: [Action.SyncToSlack]
|
|
5756
5821
|
* ```
|
|
5757
|
-
* @version @version SDK : 1.32.0 |
|
|
5822
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5758
5823
|
*/
|
|
5759
5824
|
SyncToSlack = "syncToSlack",
|
|
5760
5825
|
/**
|
|
@@ -5764,7 +5829,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5764
5829
|
* ```js
|
|
5765
5830
|
* disabledActions: [Action.SyncToTeams]
|
|
5766
5831
|
* ```
|
|
5767
|
-
* @version @version SDK : 1.32.0 |
|
|
5832
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5768
5833
|
*/
|
|
5769
5834
|
SyncToTeams = "syncToTeams",
|
|
5770
5835
|
/**
|
|
@@ -5775,7 +5840,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5775
5840
|
* ```js
|
|
5776
5841
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
5777
5842
|
* ```
|
|
5778
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5843
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5779
5844
|
*/
|
|
5780
5845
|
RemoveCrossFilter = "context-menu-item-remove-cross-filter",
|
|
5781
5846
|
/**
|
|
@@ -5786,7 +5851,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5786
5851
|
* ```js
|
|
5787
5852
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
5788
5853
|
* ```
|
|
5789
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5854
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5790
5855
|
*/
|
|
5791
5856
|
AxisMenuAggregate = "axisMenuAggregate",
|
|
5792
5857
|
/**
|
|
@@ -5797,17 +5862,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5797
5862
|
* ```js
|
|
5798
5863
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
5799
5864
|
* ```
|
|
5800
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5865
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5801
5866
|
*/
|
|
5802
5867
|
AxisMenuTimeBucket = "axisMenuTimeBucket",
|
|
5803
5868
|
/**
|
|
5804
5869
|
* The **Filter** action in the chart axis or table column
|
|
5805
5870
|
* customization menu.
|
|
5871
|
+
* Allows adding, editing, or removing filters.
|
|
5872
|
+
*
|
|
5806
5873
|
* @example
|
|
5807
5874
|
* ```js
|
|
5808
5875
|
* disabledActions: [Action.AxisMenuFilter]
|
|
5809
5876
|
* ```
|
|
5810
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5877
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5811
5878
|
*/
|
|
5812
5879
|
AxisMenuFilter = "axisMenuFilter",
|
|
5813
5880
|
/**
|
|
@@ -5818,7 +5885,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5818
5885
|
* ```js
|
|
5819
5886
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
5820
5887
|
* ```
|
|
5821
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5888
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5822
5889
|
*/
|
|
5823
5890
|
AxisMenuConditionalFormat = "axisMenuConditionalFormat",
|
|
5824
5891
|
/**
|
|
@@ -5829,7 +5896,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5829
5896
|
* ```js
|
|
5830
5897
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
5831
5898
|
* ```
|
|
5832
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5899
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5833
5900
|
*/
|
|
5834
5901
|
AxisMenuSort = "axisMenuSort",
|
|
5835
5902
|
/**
|
|
@@ -5841,7 +5908,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5841
5908
|
* ```js
|
|
5842
5909
|
* disabledActions: [Action.AxisMenuGroup]
|
|
5843
5910
|
* ```
|
|
5844
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5911
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5845
5912
|
*/
|
|
5846
5913
|
AxisMenuGroup = "axisMenuGroup",
|
|
5847
5914
|
/**
|
|
@@ -5852,7 +5919,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5852
5919
|
* ```js
|
|
5853
5920
|
* disabledActions: [Action.AxisMenuPosition]
|
|
5854
5921
|
* ```
|
|
5855
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5922
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5856
5923
|
*/
|
|
5857
5924
|
AxisMenuPosition = "axisMenuPosition",
|
|
5858
5925
|
/**
|
|
@@ -5862,7 +5929,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5862
5929
|
* ```js
|
|
5863
5930
|
* disabledActions: [Action.AxisMenuRename]
|
|
5864
5931
|
* ```
|
|
5865
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5932
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5866
5933
|
*/
|
|
5867
5934
|
AxisMenuRename = "axisMenuRename",
|
|
5868
5935
|
/**
|
|
@@ -5873,7 +5940,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5873
5940
|
* ```js
|
|
5874
5941
|
* disabledActions: [Action.AxisMenuEdit]
|
|
5875
5942
|
* ```
|
|
5876
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5943
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5877
5944
|
*/
|
|
5878
5945
|
AxisMenuEdit = "axisMenuEdit",
|
|
5879
5946
|
/**
|
|
@@ -5883,7 +5950,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5883
5950
|
* ```js
|
|
5884
5951
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
5885
5952
|
* ```
|
|
5886
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5953
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5887
5954
|
*/
|
|
5888
5955
|
AxisMenuNumberFormat = "axisMenuNumberFormat",
|
|
5889
5956
|
/**
|
|
@@ -5893,7 +5960,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5893
5960
|
* ```js
|
|
5894
5961
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
5895
5962
|
* ```
|
|
5896
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5963
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5897
5964
|
*/
|
|
5898
5965
|
AxisMenuTextWrapping = "axisMenuTextWrapping",
|
|
5899
5966
|
/**
|
|
@@ -5905,7 +5972,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5905
5972
|
* ```js
|
|
5906
5973
|
* disabledActions: [Action.AxisMenuRemove]
|
|
5907
5974
|
* ```
|
|
5908
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5975
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5909
5976
|
*/
|
|
5910
5977
|
AxisMenuRemove = "axisMenuRemove",
|
|
5911
5978
|
/**
|
|
@@ -5919,26 +5986,27 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5919
5986
|
* ```js
|
|
5920
5987
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
5921
5988
|
* ```
|
|
5922
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
5989
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
|
|
5923
5990
|
*/
|
|
5924
5991
|
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
5925
5992
|
/**
|
|
5926
|
-
*
|
|
5993
|
+
* The *Request verification* action on a Liveboard.
|
|
5994
|
+
* Initiates a request for Liveboard verification.
|
|
5927
5995
|
* @example
|
|
5928
5996
|
* ```js
|
|
5929
5997
|
* disabledActions: [Action.RequestVerification]
|
|
5930
5998
|
* ```
|
|
5931
|
-
* @version SDK: 1.25.0 |
|
|
5999
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
5932
6000
|
*/
|
|
5933
6001
|
RequestVerification = "requestVerification",
|
|
5934
6002
|
/**
|
|
5935
6003
|
*
|
|
5936
|
-
*Allows users to mark a Liveboard as verified.
|
|
6004
|
+
* Allows users to mark a Liveboard as verified.
|
|
5937
6005
|
* @example
|
|
5938
6006
|
* ```js
|
|
5939
6007
|
* disabledActions: [Action.MarkAsVerified]
|
|
5940
6008
|
* ```
|
|
5941
|
-
* @version SDK: 1.25.0 |
|
|
6009
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
5942
6010
|
*/
|
|
5943
6011
|
MarkAsVerified = "markAsVerified",
|
|
5944
6012
|
/**
|
|
@@ -5948,7 +6016,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5948
6016
|
* ```js
|
|
5949
6017
|
* disabledActions: [Action.AddTab]
|
|
5950
6018
|
* ```
|
|
5951
|
-
* @version SDK: 1.26.0 |
|
|
6019
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5952
6020
|
*/
|
|
5953
6021
|
AddTab = "addTab",
|
|
5954
6022
|
/**
|
|
@@ -5958,35 +6026,42 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5958
6026
|
* ```js
|
|
5959
6027
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
5960
6028
|
* ```
|
|
5961
|
-
* @version SDK: 1.25.0 |
|
|
6029
|
+
* @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
|
|
5962
6030
|
*/
|
|
5963
6031
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
5964
6032
|
/**
|
|
6033
|
+
* Action ID to hide or disable Natural Language Search query.
|
|
5965
6034
|
*
|
|
5966
6035
|
* @example
|
|
5967
6036
|
* ```js
|
|
5968
6037
|
* disabledActions: [Action.ShowSageQuery]
|
|
5969
6038
|
* ```
|
|
5970
|
-
* @version SDK: 1.26.0 |
|
|
6039
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
5971
6040
|
*/
|
|
5972
6041
|
ShowSageQuery = "showSageQuery",
|
|
5973
6042
|
/**
|
|
6043
|
+
*
|
|
6044
|
+
* Action ID to hide or disable the edit option for the
|
|
6045
|
+
* results generated from the
|
|
6046
|
+
* Natural Language Search query.
|
|
5974
6047
|
*
|
|
5975
6048
|
* @example
|
|
5976
6049
|
* ```js
|
|
5977
6050
|
* disabledActions: [Action.EditSageAnswer]
|
|
5978
6051
|
* ```
|
|
5979
|
-
* @version SDK: 1.26.0 |
|
|
6052
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
5980
6053
|
*/
|
|
5981
6054
|
EditSageAnswer = "editSageAnswer",
|
|
5982
6055
|
/**
|
|
6056
|
+
* The feedback widget for AI-generated Answers.
|
|
6057
|
+
* Allows users to send feedback on the Answers generated
|
|
6058
|
+
* from a Natural Language Search query.
|
|
5983
6059
|
*
|
|
5984
|
-
*This action allows users to send feedback on AI-generated Answers.
|
|
5985
6060
|
* @example
|
|
5986
6061
|
* ```js
|
|
5987
6062
|
* disabledActions: [Action.SageAnswerFeedback]
|
|
5988
6063
|
* ```
|
|
5989
|
-
* @version SDK: 1.26.0 |
|
|
6064
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
5990
6065
|
*/
|
|
5991
6066
|
SageAnswerFeedback = "sageAnswerFeedback",
|
|
5992
6067
|
/**
|
|
@@ -5995,7 +6070,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5995
6070
|
* ```js
|
|
5996
6071
|
* disabledActions: [Action.ModifySageAnswer]
|
|
5997
6072
|
* ```
|
|
5998
|
-
* @version SDK: 1.26.0 |
|
|
6073
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
5999
6074
|
*/
|
|
6000
6075
|
ModifySageAnswer = "modifySageAnswer",
|
|
6001
6076
|
/**
|
|
@@ -6008,7 +6083,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6008
6083
|
*/
|
|
6009
6084
|
MoveToTab = "onContainerMove",
|
|
6010
6085
|
/**
|
|
6011
|
-
* The **Manage
|
|
6086
|
+
* The **Manage Alerts** menu action on KPI visualizations.
|
|
6087
|
+
* Allows creating, viewing, and editing monitor
|
|
6088
|
+
* alerts for a KPI chart.
|
|
6089
|
+
*
|
|
6012
6090
|
* @example
|
|
6013
6091
|
* ```js
|
|
6014
6092
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -6016,21 +6094,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6016
6094
|
*/
|
|
6017
6095
|
ManageMonitor = "manageMonitor",
|
|
6018
6096
|
/**
|
|
6019
|
-
*
|
|
6097
|
+
* The Liveboard Personalised Views dropdown.
|
|
6098
|
+
* Allows navigating to a personalized Liveboard View.
|
|
6020
6099
|
* @example
|
|
6021
6100
|
* ```js
|
|
6022
6101
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
6023
6102
|
* ```
|
|
6024
|
-
* @version SDK : 1.26.0 |
|
|
6103
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6025
6104
|
*/
|
|
6026
6105
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
6027
6106
|
/**
|
|
6028
|
-
* Action ID for
|
|
6107
|
+
* Action ID for show or hide the user details on a
|
|
6108
|
+
* Liveboard (Recently visited / social proof)
|
|
6029
6109
|
* @example
|
|
6030
6110
|
* ```js
|
|
6031
6111
|
* disabledActions: [Action.LiveboardUsers]
|
|
6032
6112
|
* ```
|
|
6033
|
-
* @version SDK : 1.26.0 |
|
|
6113
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6034
6114
|
*/
|
|
6035
6115
|
LiveboardUsers = "liveboardUsers",
|
|
6036
6116
|
/**
|
|
@@ -6048,108 +6128,124 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6048
6128
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
6049
6129
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
6050
6130
|
* ```
|
|
6051
|
-
* @version SDK : 1.28.3 |
|
|
6131
|
+
* @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
6052
6132
|
*/
|
|
6053
6133
|
TML = "tml",
|
|
6054
6134
|
/**
|
|
6055
|
-
*
|
|
6056
|
-
* and Pin modal
|
|
6135
|
+
* The **Create Liveboard* action on
|
|
6136
|
+
* the Liveboards page and the Pin modal.
|
|
6137
|
+
* Allows users to create a Liveboard.
|
|
6138
|
+
*
|
|
6057
6139
|
* @example
|
|
6058
6140
|
* ```js
|
|
6059
6141
|
* hiddenAction: [Action.CreateLiveboard]
|
|
6060
6142
|
* disabledActions: [Action.CreateLiveboard]
|
|
6061
6143
|
* ```
|
|
6062
|
-
* @version SDK: 1.32.0 |
|
|
6144
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
6063
6145
|
*/
|
|
6064
6146
|
CreateLiveboard = "createLiveboard",
|
|
6065
6147
|
/**
|
|
6066
|
-
* Action ID for to hide
|
|
6148
|
+
* Action ID for to hide or disable the
|
|
6149
|
+
* Verified Liveboard banner.
|
|
6067
6150
|
* @example
|
|
6068
6151
|
* ```js
|
|
6069
6152
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
6070
6153
|
* ```
|
|
6071
|
-
* @version SDK: 1.29.0 |
|
|
6154
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
6072
6155
|
*/
|
|
6073
6156
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
6074
6157
|
/**
|
|
6075
|
-
*
|
|
6158
|
+
* The *Ask Sage* action for Answers and visualizations.
|
|
6159
|
+
* Allows initiating a Natural Language Search query.
|
|
6160
|
+
*
|
|
6076
6161
|
* @example
|
|
6077
6162
|
* ```js
|
|
6078
6163
|
* hiddenAction: [Action.AskAi]
|
|
6079
6164
|
* ```
|
|
6080
|
-
* @version SDK: 1.29.0 |
|
|
6165
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
6081
6166
|
*/
|
|
6082
6167
|
AskAi = "AskAi",
|
|
6083
6168
|
/**
|
|
6084
6169
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
6170
|
+
* Adds a KPI chart to the watchlist on the Home page.
|
|
6085
6171
|
* @example
|
|
6086
6172
|
* ```js
|
|
6087
6173
|
* disabledActions: [Action.AddToWatchlist]
|
|
6088
6174
|
* ```
|
|
6089
|
-
* @version SDK : 1.27.9 |
|
|
6175
|
+
* @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6090
6176
|
*/
|
|
6091
6177
|
AddToWatchlist = "addToWatchlist",
|
|
6092
6178
|
/**
|
|
6093
6179
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
6180
|
+
* Removes a KPI chart from the watchlist on the Home page.
|
|
6094
6181
|
* @example
|
|
6095
6182
|
* ```js
|
|
6096
6183
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6097
6184
|
* ```
|
|
6098
|
-
* @version SDK : 1.27.9 |
|
|
6185
|
+
* @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6099
6186
|
*/
|
|
6100
6187
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6101
6188
|
/**
|
|
6102
|
-
* The **
|
|
6189
|
+
* The **Organize Favourites** action on Homepage
|
|
6190
|
+
* *Favorites* module.
|
|
6191
|
+
*
|
|
6103
6192
|
* @example
|
|
6104
6193
|
* ```js
|
|
6105
6194
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6106
6195
|
* ```
|
|
6107
|
-
* @version SDK : 1.32.0 |
|
|
6196
|
+
* @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6108
6197
|
*/
|
|
6109
6198
|
OrganiseFavourites = "organiseFavourites",
|
|
6110
6199
|
/**
|
|
6111
|
-
*
|
|
6200
|
+
* The **AI Highlights** action on a Liveboard.
|
|
6201
|
+
*
|
|
6112
6202
|
* @example
|
|
6113
6203
|
* ```js
|
|
6114
6204
|
* hiddenAction: [Action.AIHighlights]
|
|
6115
6205
|
* ```
|
|
6116
|
-
* @version SDK: 1.27.10 |
|
|
6206
|
+
* @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6117
6207
|
*/
|
|
6118
6208
|
AIHighlights = "AIHighlights",
|
|
6119
6209
|
/**
|
|
6120
|
-
*
|
|
6210
|
+
* The *Edit* action on the *Liveboard Schedules* page
|
|
6211
|
+
* (new Homepage experience).
|
|
6212
|
+
* Allows editing Liveboard schedules.
|
|
6213
|
+
*
|
|
6121
6214
|
* @example
|
|
6122
6215
|
* ```js
|
|
6123
6216
|
* disabledActions: [Action.EditScheduleHomepage]
|
|
6124
6217
|
* ```
|
|
6125
|
-
* @version SDK: 1.34.0 |
|
|
6218
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6126
6219
|
*/
|
|
6127
6220
|
EditScheduleHomepage = "editScheduleHomepage",
|
|
6128
6221
|
/**
|
|
6129
|
-
*
|
|
6222
|
+
* The *Pause* action on the *Liveboard Schedules* page
|
|
6223
|
+
* Pauses a scheduled Liveboard job.
|
|
6130
6224
|
* @example
|
|
6131
6225
|
* ```js
|
|
6132
6226
|
* disabledActions: [Action.PauseScheduleHomepage]
|
|
6133
6227
|
* ```
|
|
6134
|
-
* @version SDK: 1.34.0 |
|
|
6228
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6135
6229
|
*/
|
|
6136
6230
|
PauseScheduleHomepage = "pauseScheduleHomepage",
|
|
6137
6231
|
/**
|
|
6138
|
-
*
|
|
6232
|
+
* The **View run history** action **Liveboard Schedules** page.
|
|
6233
|
+
* Allows viewing schedule run history.
|
|
6139
6234
|
* @example
|
|
6140
6235
|
* ```js
|
|
6141
6236
|
* disabledActions: [Action.ViewScheduleRunHomepage]
|
|
6142
6237
|
* ```
|
|
6143
|
-
* @version SDK: 1.34.0 |
|
|
6238
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6144
6239
|
*/
|
|
6145
6240
|
ViewScheduleRunHomepage = "viewScheduleRunHomepage",
|
|
6146
6241
|
/**
|
|
6147
|
-
* Action ID
|
|
6242
|
+
* Action ID to hide or disable the
|
|
6243
|
+
* unsubscribe option for Liveboard schedules.
|
|
6148
6244
|
* @example
|
|
6149
6245
|
* ```js
|
|
6150
6246
|
* disabledActions: [Action.UnsubscribeScheduleHomepage]
|
|
6151
6247
|
* ```
|
|
6152
|
-
* @version SDK: 1.34.0 |
|
|
6248
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6153
6249
|
*/
|
|
6154
6250
|
UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
|
|
6155
6251
|
/**
|
|
@@ -6158,16 +6254,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6158
6254
|
* ```js
|
|
6159
6255
|
* disabledActions: [Action.ManageTags]
|
|
6160
6256
|
* ```
|
|
6161
|
-
* @version SDK : 1.34.0 |
|
|
6257
|
+
* @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6162
6258
|
*/
|
|
6163
6259
|
ManageTags = "manageTags",
|
|
6164
6260
|
/**
|
|
6165
|
-
*
|
|
6261
|
+
* The **Delete** action on the **Liveboard Schedules* page.
|
|
6262
|
+
* Deletes a Liveboard schedule.
|
|
6166
6263
|
* @example
|
|
6167
6264
|
* ```js
|
|
6168
6265
|
* disabledActions: [Action.DeleteScheduleHomepage]
|
|
6169
6266
|
* ```
|
|
6170
|
-
* @version SDK: 1.34.0 |
|
|
6267
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6171
6268
|
*/
|
|
6172
6269
|
DeleteScheduleHomepage = "deleteScheduleHomepage",
|
|
6173
6270
|
/**
|
|
@@ -6176,7 +6273,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6176
6273
|
* ```js
|
|
6177
6274
|
* disabledActions: [Action.KPIAnalysisCTA]
|
|
6178
6275
|
* ```
|
|
6179
|
-
* @version SDK: 1.34.0 |
|
|
6276
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6180
6277
|
*/
|
|
6181
6278
|
KPIAnalysisCTA = "kpiAnalysisCTA",
|
|
6182
6279
|
/**
|
|
@@ -6185,61 +6282,73 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6185
6282
|
* ```js
|
|
6186
6283
|
* const disabledActions = [Action.DisableChipReorder]
|
|
6187
6284
|
* ```
|
|
6188
|
-
* @version SDK: 1.36.0 |
|
|
6285
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6189
6286
|
*/
|
|
6190
6287
|
DisableChipReorder = "disableChipReorder",
|
|
6191
6288
|
/**
|
|
6192
|
-
* Action ID
|
|
6289
|
+
* Action ID to show, hide, or disable filters
|
|
6290
|
+
* in a Liveboard tab.
|
|
6291
|
+
*
|
|
6193
6292
|
* @example
|
|
6194
6293
|
* ```js
|
|
6195
6294
|
* hiddenAction: [Action.ChangeFilterVisibilityInTab]
|
|
6196
6295
|
* ```
|
|
6197
|
-
* @version SDK: 1.36.0 |
|
|
6296
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6198
6297
|
*/
|
|
6199
6298
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
6200
6299
|
/**
|
|
6201
|
-
*
|
|
6300
|
+
* The **Preview data** button on the Spotter interface.
|
|
6301
|
+
* Allows previewing the data used for Spotter queries.
|
|
6302
|
+
*
|
|
6202
6303
|
* @example
|
|
6203
6304
|
* ```js
|
|
6204
6305
|
* hiddenAction: [Action.PreviewDataSpotter]
|
|
6205
6306
|
* ```
|
|
6206
|
-
* @version SDK: 1.36.0 |
|
|
6307
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6207
6308
|
*/
|
|
6208
6309
|
PreviewDataSpotter = "previewDataSpotter",
|
|
6209
6310
|
/**
|
|
6210
|
-
*
|
|
6311
|
+
* The **Reset** link on the Spotter interface.
|
|
6312
|
+
* Resets the conversation with Spotter.
|
|
6313
|
+
*
|
|
6211
6314
|
* @example
|
|
6212
6315
|
* ```js
|
|
6213
6316
|
* hiddenAction: [Action.ResetSpotterChat]
|
|
6214
6317
|
* ```
|
|
6215
|
-
* @version SDK: 1.36.0 |
|
|
6318
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6216
6319
|
*/
|
|
6217
6320
|
ResetSpotterChat = "resetSpotterChat",
|
|
6218
6321
|
/**
|
|
6219
|
-
* Action ID for hide
|
|
6322
|
+
* Action ID for hide or disable the
|
|
6323
|
+
* Spotter feedback widget.
|
|
6324
|
+
*
|
|
6220
6325
|
* @example
|
|
6221
6326
|
* ```js
|
|
6222
6327
|
* hiddenAction: [Action.SpotterFeedback]
|
|
6223
6328
|
* ```
|
|
6224
|
-
* @version SDK: 1.36.0 |
|
|
6329
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6225
6330
|
*/
|
|
6226
6331
|
SpotterFeedback = "spotterFeedback",
|
|
6227
6332
|
/**
|
|
6228
|
-
* Action ID for hide
|
|
6333
|
+
* Action ID for hide or disable
|
|
6334
|
+
* the previous prompt edit option in Spotter.
|
|
6335
|
+
*
|
|
6229
6336
|
* @example
|
|
6230
6337
|
* ```js
|
|
6231
6338
|
* hiddenAction: [Action.EditPreviousPrompt]
|
|
6232
6339
|
* ```
|
|
6233
|
-
* @version SDK: 1.36.0 |
|
|
6340
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6234
6341
|
*/
|
|
6235
6342
|
EditPreviousPrompt = "editPreviousPrompt",
|
|
6236
6343
|
/**
|
|
6237
|
-
* Action ID for hide
|
|
6344
|
+
* Action ID for hide or disable
|
|
6345
|
+
* the previous prompt deletion option in Spotter.
|
|
6346
|
+
*
|
|
6238
6347
|
* @example
|
|
6239
6348
|
* ```js
|
|
6240
6349
|
* hiddenAction: [Action.DeletePreviousPrompt]
|
|
6241
6350
|
* ```
|
|
6242
|
-
* @version SDK: 1.36.0 |
|
|
6351
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6243
6352
|
*/
|
|
6244
6353
|
DeletePreviousPrompt = "deletePreviousPrompt",
|
|
6245
6354
|
/**
|
|
@@ -6248,7 +6357,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6248
6357
|
* ```js
|
|
6249
6358
|
* hiddenAction: [Action.EditTokens]
|
|
6250
6359
|
* ```
|
|
6251
|
-
* @version SDK: 1.36.0 |
|
|
6360
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6252
6361
|
*/
|
|
6253
6362
|
EditTokens = "editTokens"
|
|
6254
6363
|
}
|
|
@@ -6319,7 +6428,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6319
6428
|
* logLevel: LogLevel.SILENT,
|
|
6320
6429
|
* })
|
|
6321
6430
|
* ```
|
|
6322
|
-
* @version SDK: 1.26.7 |
|
|
6431
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6323
6432
|
*/
|
|
6324
6433
|
SILENT = "SILENT",
|
|
6325
6434
|
/**
|
|
@@ -6331,7 +6440,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6331
6440
|
* logLevel: LogLevel.ERROR,
|
|
6332
6441
|
* })
|
|
6333
6442
|
* ```
|
|
6334
|
-
* @version SDK: 1.26.7 |
|
|
6443
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6335
6444
|
*/
|
|
6336
6445
|
ERROR = "ERROR",
|
|
6337
6446
|
/**
|
|
@@ -6343,7 +6452,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6343
6452
|
* logLevel: LogLevel.WARN,
|
|
6344
6453
|
* })
|
|
6345
6454
|
* ```
|
|
6346
|
-
* @version SDK: 1.26.7 |
|
|
6455
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6347
6456
|
*/
|
|
6348
6457
|
WARN = "WARN",
|
|
6349
6458
|
/**
|
|
@@ -6355,7 +6464,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6355
6464
|
* logLevel: LogLevel.INFO,
|
|
6356
6465
|
* })
|
|
6357
6466
|
* ```
|
|
6358
|
-
* @version SDK: 1.26.7 |
|
|
6467
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6359
6468
|
*/
|
|
6360
6469
|
INFO = "INFO",
|
|
6361
6470
|
/**
|
|
@@ -6367,7 +6476,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6367
6476
|
* logLevel: LogLevel.DEBUG,
|
|
6368
6477
|
* })
|
|
6369
6478
|
* ```
|
|
6370
|
-
* @version SDK: 1.26.7 |
|
|
6479
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6371
6480
|
*/
|
|
6372
6481
|
DEBUG = "DEBUG",
|
|
6373
6482
|
/**
|
|
@@ -6379,7 +6488,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6379
6488
|
* logLevel: LogLevel.TRACE,
|
|
6380
6489
|
* })
|
|
6381
6490
|
* ```
|
|
6382
|
-
* @version SDK: 1.26.7 |
|
|
6491
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6383
6492
|
*/
|
|
6384
6493
|
TRACE = "TRACE"
|
|
6385
6494
|
}
|
|
@@ -7227,7 +7336,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts' {
|
|
|
7227
7336
|
PinAnswerToLiveboard = "addVizToPinboard",
|
|
7228
7337
|
SaveAnswer = "saveAnswer",
|
|
7229
7338
|
GetDiscoverabilityStatus = "getDiscoverabilityStatus",
|
|
7230
|
-
GetAvailableUIPassthroughs = "
|
|
7339
|
+
GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
|
|
7231
7340
|
GetAnswerConfig = "getAnswerPageConfig",
|
|
7232
7341
|
GetLiveboardConfig = "getPinboardPageConfig"
|
|
7233
7342
|
}
|