@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
|
@@ -1047,8 +1047,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1047
1047
|
*/
|
|
1048
1048
|
enableSearchAssist?: boolean;
|
|
1049
1049
|
/**
|
|
1050
|
-
* If set to true, the
|
|
1051
|
-
* according to the height of the
|
|
1050
|
+
* If set to true, the Liveboard container dynamically resizes
|
|
1051
|
+
* according to the height of the Liveboard.
|
|
1052
|
+
*
|
|
1053
|
+
* **Note**: Using fullHeight loads all visualizations
|
|
1054
|
+
* on the Liveboard simultaneously, which results in
|
|
1055
|
+
* multiple warehouse queries and potentially a
|
|
1056
|
+
* longer wait for the topmost visualizations to
|
|
1057
|
+
* display on the screen. Setting fullHeight to
|
|
1058
|
+
* `false` fetches visualizations incrementally as
|
|
1059
|
+
* users scroll the page to view the charts and tables.
|
|
1060
|
+
*
|
|
1052
1061
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
1053
1062
|
* @example
|
|
1054
1063
|
* ```js
|
|
@@ -1310,12 +1319,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1310
1319
|
/**
|
|
1311
1320
|
* If set to true, the embedded object container dynamically resizes
|
|
1312
1321
|
* according to the height of the Liveboard.
|
|
1322
|
+
*
|
|
1313
1323
|
* **Note**: Using fullHeight loads all visualizations on the
|
|
1314
1324
|
* Liveboard simultaneously, which results in multiple warehouse
|
|
1315
1325
|
* queries and potentially a longer wait for the topmost
|
|
1316
1326
|
* visualizations to display on the screen.
|
|
1317
1327
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
1318
1328
|
* incrementally as users scroll the page to view the charts and tables.
|
|
1329
|
+
*
|
|
1319
1330
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
1320
1331
|
* @example
|
|
1321
1332
|
* ```js
|
|
@@ -1809,7 +1820,7 @@ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportT
|
|
|
1809
1820
|
*/
|
|
1810
1821
|
export declare enum AuthType {
|
|
1811
1822
|
/**
|
|
1812
|
-
* No authentication on the SDK.
|
|
1823
|
+
* No authentication on the SDK. Pass-through to the embedded App. Alias for
|
|
1813
1824
|
* `Passthrough`.
|
|
1814
1825
|
* @example
|
|
1815
1826
|
* ```js
|
|
@@ -2006,8 +2017,8 @@ export interface customCssInterface {
|
|
|
2006
2017
|
/**
|
|
2007
2018
|
* The custom css variables, which can be set.
|
|
2008
2019
|
* The allowed list is in the CustomCssVariables
|
|
2009
|
-
* interface.
|
|
2010
|
-
*
|
|
2020
|
+
* interface. For more information, see
|
|
2021
|
+
* link:https://developers.thoughtspot.com/docs/css-variables-reference
|
|
2011
2022
|
*/
|
|
2012
2023
|
variables?: CustomCssVariables;
|
|
2013
2024
|
/**
|
|
@@ -2049,7 +2060,7 @@ export interface CustomStyles {
|
|
|
2049
2060
|
}
|
|
2050
2061
|
/**
|
|
2051
2062
|
* Configuration to define the customization on the Embedded
|
|
2052
|
-
*
|
|
2063
|
+
* ThoughtSpot components.
|
|
2053
2064
|
* You can customize styles, text strings, and icons.
|
|
2054
2065
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
2055
2066
|
* @example
|
|
@@ -2169,7 +2180,7 @@ export interface EmbedConfig {
|
|
|
2169
2180
|
/**
|
|
2170
2181
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
2171
2182
|
* should be encoded in base64. This provides additional security to
|
|
2172
|
-
*
|
|
2183
|
+
* ThoughtSpot clusters against cross-site scripting attacks.
|
|
2173
2184
|
* @default false
|
|
2174
2185
|
*/
|
|
2175
2186
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -2322,18 +2333,18 @@ export interface EmbedConfig {
|
|
|
2322
2333
|
*/
|
|
2323
2334
|
disableSDKTracking?: boolean;
|
|
2324
2335
|
/**
|
|
2325
|
-
* Overrides default/user
|
|
2326
|
-
* @version SDK: 1.28.4 |
|
|
2336
|
+
* Overrides default/user preferred locale for date formatting
|
|
2337
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2327
2338
|
*/
|
|
2328
2339
|
dateFormatLocale?: string;
|
|
2329
2340
|
/**
|
|
2330
|
-
* Overrides default/user
|
|
2331
|
-
* @version SDK: 1.28.4 |
|
|
2341
|
+
* Overrides default/user preferred locale for number formatting
|
|
2342
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2332
2343
|
*/
|
|
2333
2344
|
numberFormatLocale?: string;
|
|
2334
2345
|
/**
|
|
2335
2346
|
* Format to be used for currency when currency format is set to infer from browser
|
|
2336
|
-
* @version SDK: 1.28.4 |
|
|
2347
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2337
2348
|
*/
|
|
2338
2349
|
currencyFormat?: string;
|
|
2339
2350
|
/**
|
|
@@ -2347,12 +2358,12 @@ export interface EmbedConfig {
|
|
|
2347
2358
|
* disableTokenVerification : true
|
|
2348
2359
|
* })
|
|
2349
2360
|
* ```
|
|
2350
|
-
* @version SDK: 1.28.5 |
|
|
2361
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
2351
2362
|
*/
|
|
2352
2363
|
disableTokenVerification?: boolean;
|
|
2353
2364
|
/**
|
|
2354
2365
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
2355
|
-
* @version SDK 1.32.3 |
|
|
2366
|
+
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
2356
2367
|
*/
|
|
2357
2368
|
disableLoginFailurePage?: boolean;
|
|
2358
2369
|
/**
|
|
@@ -2390,7 +2401,7 @@ export interface EmbedConfig {
|
|
|
2390
2401
|
* }
|
|
2391
2402
|
* });
|
|
2392
2403
|
* ```
|
|
2393
|
-
* @version SDK 1.37.0 |
|
|
2404
|
+
* @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
|
|
2394
2405
|
*/
|
|
2395
2406
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
2396
2407
|
}
|
|
@@ -2549,7 +2560,7 @@ export interface ViewConfig {
|
|
|
2549
2560
|
/**
|
|
2550
2561
|
* The list of parameter override to apply to a search answer,
|
|
2551
2562
|
* visualization, or Liveboard.
|
|
2552
|
-
* @version SDK : 1.25.0 |
|
|
2563
|
+
* @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2553
2564
|
* @example
|
|
2554
2565
|
* ```js
|
|
2555
2566
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2609,7 +2620,7 @@ export interface ViewConfig {
|
|
|
2609
2620
|
/**
|
|
2610
2621
|
* Insert as a sibling of the target container, instead of appending to a
|
|
2611
2622
|
* child inside it.
|
|
2612
|
-
* @version SDK: 1.2.0 |
|
|
2623
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
2613
2624
|
* @example
|
|
2614
2625
|
* ```js
|
|
2615
2626
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2682,7 +2693,7 @@ export interface ViewConfig {
|
|
|
2682
2693
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
2683
2694
|
* });
|
|
2684
2695
|
* ```
|
|
2685
|
-
* @version SDK: 1.26.0 |
|
|
2696
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
2686
2697
|
*/
|
|
2687
2698
|
hiddenTabs?: string[];
|
|
2688
2699
|
/**
|
|
@@ -2692,7 +2703,7 @@ export interface ViewConfig {
|
|
|
2692
2703
|
* **Note**: This option does not apply to the classic homepage.
|
|
2693
2704
|
* To access the updated modular homepage, set
|
|
2694
2705
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2695
|
-
* @version SDK: 1.28.0 |
|
|
2706
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2696
2707
|
* @example
|
|
2697
2708
|
* ```js
|
|
2698
2709
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2709,7 +2720,7 @@ export interface ViewConfig {
|
|
|
2709
2720
|
* **Note**: This option does not apply to the classic homepage.
|
|
2710
2721
|
* To access the updated modular homepage, set
|
|
2711
2722
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2712
|
-
* @version SDK: 1.28.0|
|
|
2723
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2713
2724
|
* @example
|
|
2714
2725
|
* ```js
|
|
2715
2726
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2724,7 +2735,7 @@ export interface ViewConfig {
|
|
|
2724
2735
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2725
2736
|
*
|
|
2726
2737
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2727
|
-
* @version SDK: 1.26.0 |
|
|
2738
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
2728
2739
|
* @example
|
|
2729
2740
|
* ```js
|
|
2730
2741
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2752,7 +2763,7 @@ export interface ViewConfig {
|
|
|
2752
2763
|
* **Note**: This option does not apply to the classic homepage.
|
|
2753
2764
|
* To access the updated modular homepage, set
|
|
2754
2765
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2755
|
-
* @version SDK: 1.28.0 |
|
|
2766
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2756
2767
|
*/
|
|
2757
2768
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2758
2769
|
/**
|
|
@@ -2767,7 +2778,7 @@ export interface ViewConfig {
|
|
|
2767
2778
|
* });
|
|
2768
2779
|
* embed.showPreRender();
|
|
2769
2780
|
* ```
|
|
2770
|
-
* @version SDK: 1.25.0 |
|
|
2781
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
2771
2782
|
*/
|
|
2772
2783
|
preRenderId?: string;
|
|
2773
2784
|
/**
|
|
@@ -2821,7 +2832,7 @@ export interface ViewConfig {
|
|
|
2821
2832
|
/**
|
|
2822
2833
|
* To set the initial state of the search bar in case of saved Answers.
|
|
2823
2834
|
* @default true
|
|
2824
|
-
* @version SDK: 1.34.0 |
|
|
2835
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
2825
2836
|
* @example
|
|
2826
2837
|
* ```js
|
|
2827
2838
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2845,7 +2856,7 @@ export interface ViewConfig {
|
|
|
2845
2856
|
/**
|
|
2846
2857
|
* Flag to control Data panel experience
|
|
2847
2858
|
* @default false
|
|
2848
|
-
* @version SDK: 1.34.0 |
|
|
2859
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
2849
2860
|
* @example
|
|
2850
2861
|
* ```js
|
|
2851
2862
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2857,7 +2868,7 @@ export interface ViewConfig {
|
|
|
2857
2868
|
dataPanelV2?: boolean;
|
|
2858
2869
|
/**
|
|
2859
2870
|
* To enable custom column groups in data panel v2
|
|
2860
|
-
* @version SDK: 1.32.0 |
|
|
2871
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
2861
2872
|
* @default false
|
|
2862
2873
|
* @example
|
|
2863
2874
|
* ```js
|
|
@@ -2887,7 +2898,7 @@ export interface ViewConfig {
|
|
|
2887
2898
|
/**
|
|
2888
2899
|
* Flag to control new flip tooltip context menu experience
|
|
2889
2900
|
* @default false
|
|
2890
|
-
* @version SDK: 1.36.0 |
|
|
2901
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2891
2902
|
*/
|
|
2892
2903
|
enableFlipTooltipToContextMenu?: boolean;
|
|
2893
2904
|
}
|
|
@@ -3007,7 +3018,7 @@ export declare enum RuntimeFilterOp {
|
|
|
3007
3018
|
* **Note**: This option does not apply to the classic homepage.
|
|
3008
3019
|
* To access the updated modular homepage, set
|
|
3009
3020
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3010
|
-
* @version SDK: 1.28.0 |
|
|
3021
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3011
3022
|
*/
|
|
3012
3023
|
export declare enum HomepageModule {
|
|
3013
3024
|
/**
|
|
@@ -3850,7 +3861,7 @@ export declare enum EmbedEvent {
|
|
|
3850
3861
|
*/
|
|
3851
3862
|
Explore = "explore",
|
|
3852
3863
|
/**
|
|
3853
|
-
* Emitted when a user clicks **Copy link** action on a visualization
|
|
3864
|
+
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
3854
3865
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3855
3866
|
* @example
|
|
3856
3867
|
*```js
|
|
@@ -3900,23 +3911,26 @@ export declare enum EmbedEvent {
|
|
|
3900
3911
|
*/
|
|
3901
3912
|
FilterChanged = "filterChanged",
|
|
3902
3913
|
/**
|
|
3903
|
-
* Emitted when a user clicks the **Go** button
|
|
3904
|
-
*
|
|
3914
|
+
* Emitted when a user clicks the **Go** button to initiate
|
|
3915
|
+
* a Natural Language Search query
|
|
3916
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3905
3917
|
*/
|
|
3906
3918
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3907
3919
|
/**
|
|
3908
|
-
* Emitted when a user selects a data source on the
|
|
3909
|
-
*
|
|
3920
|
+
* Emitted when a user selects a data source on the embedded
|
|
3921
|
+
* Natural Language Search interface.
|
|
3922
|
+
*
|
|
3923
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3910
3924
|
*/
|
|
3911
3925
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3912
3926
|
/**
|
|
3913
3927
|
* Emitted when a user updates a connection on the **Data** page
|
|
3914
|
-
* @version SDK : 1.27.0 |
|
|
3928
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3915
3929
|
*/
|
|
3916
3930
|
UpdateConnection = "updateConnection",
|
|
3917
3931
|
/**
|
|
3918
3932
|
* Emitted when a user updates a connection on the **Data** page
|
|
3919
|
-
* @version SDK : 1.27.0 |
|
|
3933
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3920
3934
|
*/
|
|
3921
3935
|
CreateConnection = "createConnection",
|
|
3922
3936
|
/**
|
|
@@ -3926,7 +3940,7 @@ export declare enum EmbedEvent {
|
|
|
3926
3940
|
* @returns viewId: string
|
|
3927
3941
|
* @returns liveboardId: string
|
|
3928
3942
|
* @returns isPublic: boolean
|
|
3929
|
-
* @version SDK : 1.26.0 |
|
|
3943
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3930
3944
|
*/
|
|
3931
3945
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3932
3946
|
/**
|
|
@@ -3935,7 +3949,7 @@ export declare enum EmbedEvent {
|
|
|
3935
3949
|
* @returns viewId: string
|
|
3936
3950
|
* @returns liveboardId: string
|
|
3937
3951
|
* @returns isPublic: boolean
|
|
3938
|
-
* @version SDK : 1.26.0 |
|
|
3952
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3939
3953
|
*/
|
|
3940
3954
|
SavePersonalisedView = "savePersonalisedView",
|
|
3941
3955
|
/**
|
|
@@ -3944,28 +3958,28 @@ export declare enum EmbedEvent {
|
|
|
3944
3958
|
* @returns viewId: string
|
|
3945
3959
|
* @returns liveboardId: string
|
|
3946
3960
|
* @returns isPublic: boolean
|
|
3947
|
-
* @version SDK : 1.26.0 |
|
|
3961
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3948
3962
|
*/
|
|
3949
3963
|
ResetLiveboard = "resetLiveboard",
|
|
3950
3964
|
/**
|
|
3951
3965
|
* Emitted when a PersonalisedView is deleted.
|
|
3952
3966
|
* @returns views: string[]
|
|
3953
3967
|
* @returns liveboardId: string
|
|
3954
|
-
* @version SDK : 1.26.0 |
|
|
3968
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3955
3969
|
*/
|
|
3956
3970
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3957
3971
|
/**
|
|
3958
3972
|
* Emitted when a user creates a new worksheet
|
|
3959
|
-
* @version SDK : 1.27.0 |
|
|
3973
|
+
* @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
3960
3974
|
*/
|
|
3961
3975
|
CreateWorksheet = "createWorksheet",
|
|
3962
3976
|
/**
|
|
3963
|
-
* Emitted when Ask Sage is initialized.
|
|
3977
|
+
* Emitted when the *Ask Sage* is initialized.
|
|
3964
3978
|
* @returns viewName: string
|
|
3965
3979
|
* @returns viewId: string
|
|
3966
3980
|
* @returns liveboardId: string
|
|
3967
3981
|
* @returns isPublic: boolean
|
|
3968
|
-
* @version SDK : 1.29.0 |
|
|
3982
|
+
* @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3969
3983
|
*/
|
|
3970
3984
|
AskSageInit = "AskSageInit",
|
|
3971
3985
|
/**
|
|
@@ -3993,7 +4007,7 @@ export declare enum EmbedEvent {
|
|
|
3993
4007
|
*
|
|
3994
4008
|
* error: Developers can customize the error message text when `execute`
|
|
3995
4009
|
* returns `false` using the error parameter in responder.
|
|
3996
|
-
* @version SDK : 1.29.0 |
|
|
4010
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
3997
4011
|
* @example
|
|
3998
4012
|
*```js
|
|
3999
4013
|
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
@@ -4041,7 +4055,7 @@ export declare enum EmbedEvent {
|
|
|
4041
4055
|
* console.log('payload', payload);
|
|
4042
4056
|
* })
|
|
4043
4057
|
*```
|
|
4044
|
-
* @version SDK : 1.29.0 |
|
|
4058
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
4045
4059
|
*/
|
|
4046
4060
|
ParameterChanged = "parameterChanged"
|
|
4047
4061
|
}
|
|
@@ -4188,7 +4202,7 @@ export declare enum HostEvent {
|
|
|
4188
4202
|
* const url = embed.trigger(HostEvent.GetIframeUrl);
|
|
4189
4203
|
* console.log("iFrameURL",url);
|
|
4190
4204
|
* ```
|
|
4191
|
-
* @version SDK: 1.35.0 |
|
|
4205
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
4192
4206
|
*/
|
|
4193
4207
|
GetIframeUrl = "GetIframeUrl",
|
|
4194
4208
|
/**
|
|
@@ -4221,6 +4235,11 @@ export declare enum HostEvent {
|
|
|
4221
4235
|
* attributes passed with this event are appended to the existing runtime
|
|
4222
4236
|
* filters applied on a Liveboard.
|
|
4223
4237
|
*
|
|
4238
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
|
|
4239
|
+
* and `AppEmbed` only. In full application embedding, this event updates
|
|
4240
|
+
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
4241
|
+
*
|
|
4242
|
+
*
|
|
4224
4243
|
* Pass an array of runtime filters with the following attributes:
|
|
4225
4244
|
*
|
|
4226
4245
|
* `columnName` - _String_. The name of the column to filter on.
|
|
@@ -4231,9 +4250,12 @@ export declare enum HostEvent {
|
|
|
4231
4250
|
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
4232
4251
|
* single value, whereas BW and IN accept multiple values.
|
|
4233
4252
|
*
|
|
4234
|
-
* **Note**:
|
|
4235
|
-
*
|
|
4236
|
-
*
|
|
4253
|
+
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
4254
|
+
* object to its original state and applies new filter conditions.
|
|
4255
|
+
* Any user changes (like drilling into a visualization)
|
|
4256
|
+
* will be cleared, restoring the original visualization
|
|
4257
|
+
* with the updated filters.
|
|
4258
|
+
*
|
|
4237
4259
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
4238
4260
|
* @example
|
|
4239
4261
|
* ```js
|
|
@@ -4248,7 +4270,7 @@ export declare enum HostEvent {
|
|
|
4248
4270
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
4249
4271
|
/**
|
|
4250
4272
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4251
|
-
* This is the same as calling `appEmbed.navigateToPage(path, true)
|
|
4273
|
+
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
4252
4274
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
4253
4275
|
* be a number; for example, `1`, `-1`.
|
|
4254
4276
|
* @example
|
|
@@ -4543,7 +4565,9 @@ export declare enum HostEvent {
|
|
|
4543
4565
|
*/
|
|
4544
4566
|
GetTML = "getTML",
|
|
4545
4567
|
/**
|
|
4546
|
-
* Trigger the **Show underlying data** action on
|
|
4568
|
+
* Trigger the **Show underlying data** action on a
|
|
4569
|
+
* chart or table.
|
|
4570
|
+
*
|
|
4547
4571
|
* @param - an object with vizId as a key
|
|
4548
4572
|
* @example
|
|
4549
4573
|
* ```js
|
|
@@ -4577,8 +4601,8 @@ export declare enum HostEvent {
|
|
|
4577
4601
|
*/
|
|
4578
4602
|
Delete = "onDeleteAnswer",
|
|
4579
4603
|
/**
|
|
4580
|
-
* Trigger the **SpotIQ analyze** action on
|
|
4581
|
-
* or
|
|
4604
|
+
* Trigger the **SpotIQ analyze** action on a
|
|
4605
|
+
* chart or table.
|
|
4582
4606
|
* @param - Liveboard embed takes `vizId` as a
|
|
4583
4607
|
* key. Can be left undefined when embedding Search or
|
|
4584
4608
|
* visualization.
|
|
@@ -4851,7 +4875,7 @@ export declare enum HostEvent {
|
|
|
4851
4875
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
4852
4876
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
4853
4877
|
* ```
|
|
4854
|
-
* @version SDK: 1.26.0 |
|
|
4878
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4855
4879
|
*/
|
|
4856
4880
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
4857
4881
|
/**
|
|
@@ -4864,7 +4888,7 @@ export declare enum HostEvent {
|
|
|
4864
4888
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
4865
4889
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
4866
4890
|
* ```
|
|
4867
|
-
* @version SDK: 1.26.0 |
|
|
4891
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4868
4892
|
*/
|
|
4869
4893
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4870
4894
|
/**
|
|
@@ -4878,7 +4902,7 @@ export declare enum HostEvent {
|
|
|
4878
4902
|
* executeSearch: true,
|
|
4879
4903
|
* })
|
|
4880
4904
|
* ```
|
|
4881
|
-
* @version SDK: 1.26.0 |
|
|
4905
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
4882
4906
|
*/
|
|
4883
4907
|
UpdateSageQuery = "updateSageQuery",
|
|
4884
4908
|
/**
|
|
@@ -4895,21 +4919,22 @@ export declare enum HostEvent {
|
|
|
4895
4919
|
* ```js
|
|
4896
4920
|
* const {session} = await embed.trigger( HostEvent.GetAnswerSession )
|
|
4897
4921
|
* ```
|
|
4898
|
-
* @version SDK: 1.26.0 |
|
|
4922
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
4899
4923
|
*/
|
|
4900
4924
|
GetAnswerSession = "getAnswerSession",
|
|
4901
4925
|
/**
|
|
4902
|
-
* Trigger Ask Sage for
|
|
4926
|
+
* Trigger the *Ask Sage* action for visualizations
|
|
4903
4927
|
* @example
|
|
4904
4928
|
* ```js
|
|
4905
4929
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
4906
4930
|
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
4907
4931
|
* ```
|
|
4908
|
-
* @version SDK: 1.29.0 |
|
|
4932
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
4909
4933
|
*/
|
|
4910
4934
|
AskSage = "AskSage",
|
|
4911
4935
|
/**
|
|
4912
|
-
* Trigger cross filter update action on a Liveboard
|
|
4936
|
+
* Trigger cross filter update action on a Liveboard.
|
|
4937
|
+
*
|
|
4913
4938
|
* @example
|
|
4914
4939
|
* ```js
|
|
4915
4940
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -4920,7 +4945,7 @@ export declare enum HostEvent {
|
|
|
4920
4945
|
* ],
|
|
4921
4946
|
* });
|
|
4922
4947
|
* ```
|
|
4923
|
-
* @version SDK: 1.29.0 |
|
|
4948
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
|
|
4924
4949
|
*/
|
|
4925
4950
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
4926
4951
|
/**
|
|
@@ -4929,11 +4954,13 @@ export declare enum HostEvent {
|
|
|
4929
4954
|
* ```js
|
|
4930
4955
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
4931
4956
|
* ```
|
|
4932
|
-
* @version SDK: 1.29.0 |
|
|
4957
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
|
|
4933
4958
|
*/
|
|
4934
4959
|
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4935
4960
|
/**
|
|
4936
|
-
* Triggers an
|
|
4961
|
+
* Triggers an action to update Parameter values on embedded
|
|
4962
|
+
* Answers and Liveboard.
|
|
4963
|
+
*
|
|
4937
4964
|
* @example
|
|
4938
4965
|
* ```js
|
|
4939
4966
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -4941,30 +4968,30 @@ export declare enum HostEvent {
|
|
|
4941
4968
|
* value: "almond"
|
|
4942
4969
|
* }])
|
|
4943
4970
|
*
|
|
4944
|
-
* @version SDK: 1.29.0 |
|
|
4971
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
4945
4972
|
*/
|
|
4946
4973
|
UpdateParameters = "UpdateParameters",
|
|
4947
4974
|
/**
|
|
4948
|
-
* Triggers GetParameters to fetch the runtime
|
|
4975
|
+
* Triggers GetParameters to fetch the runtime Parameters.
|
|
4949
4976
|
* ```js
|
|
4950
4977
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
4951
4978
|
* console.log('parameters', parameter);
|
|
4952
4979
|
* });
|
|
4953
4980
|
*```
|
|
4954
|
-
* @version SDK: 1.29.0 |
|
|
4981
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
4955
4982
|
*/
|
|
4956
4983
|
GetParameters = "GetParameters",
|
|
4957
4984
|
/**
|
|
4958
|
-
* Triggers an event to update a
|
|
4985
|
+
* Triggers an event to update a personalized view of a Liveboard.
|
|
4959
4986
|
* ```js
|
|
4960
4987
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
4961
4988
|
* ```
|
|
4962
|
-
* @version SDK: 1.36.0 |
|
|
4989
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
4963
4990
|
*/
|
|
4964
4991
|
UpdatePersonalisedView = "UpdatePersonalisedView",
|
|
4965
4992
|
/**
|
|
4966
|
-
* Triggers the action to get the current view of the
|
|
4967
|
-
* @version SDK: 1.36.0 |
|
|
4993
|
+
* Triggers the action to get the current view of the Liveboard.
|
|
4994
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
4968
4995
|
*/
|
|
4969
4996
|
SaveAnswer = "saveAnswer",
|
|
4970
4997
|
/**
|
|
@@ -5184,7 +5211,8 @@ export declare enum Action {
|
|
|
5184
5211
|
ResetLayout = "resetLayout",
|
|
5185
5212
|
/**
|
|
5186
5213
|
* The **Schedule** menu action on a Liveboard.
|
|
5187
|
-
* Allows scheduling a Liveboard
|
|
5214
|
+
* Allows scheduling a Liveboard job, for example,
|
|
5215
|
+
* sending periodic notifications.
|
|
5188
5216
|
* @example
|
|
5189
5217
|
* ```js
|
|
5190
5218
|
* disabledActions: [Action.Schedule]
|
|
@@ -5226,7 +5254,7 @@ export declare enum Action {
|
|
|
5226
5254
|
* ```js
|
|
5227
5255
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
5228
5256
|
* ```
|
|
5229
|
-
* @version SDK: 1.32.0 |
|
|
5257
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5230
5258
|
*/
|
|
5231
5259
|
AddDataPanelObjects = "addDataPanelObjects",
|
|
5232
5260
|
/**
|
|
@@ -5239,7 +5267,28 @@ export declare enum Action {
|
|
|
5239
5267
|
* ```
|
|
5240
5268
|
*/
|
|
5241
5269
|
ConfigureFilter = "configureFilter",
|
|
5270
|
+
/**
|
|
5271
|
+
* The **Collapse data sources** icon on the Search page.
|
|
5272
|
+
* Collapses the panel showing data sources.
|
|
5273
|
+
*
|
|
5274
|
+
* @example
|
|
5275
|
+
* ```js
|
|
5276
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
5277
|
+
* ```
|
|
5278
|
+
* @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5279
|
+
*/
|
|
5242
5280
|
CollapseDataSources = "collapseDataSources",
|
|
5281
|
+
/**
|
|
5282
|
+
* The **Collapse data panel** icon on the Search page.
|
|
5283
|
+
* Collapses the data panel view.
|
|
5284
|
+
*
|
|
5285
|
+
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
|
|
5286
|
+
*
|
|
5287
|
+
* @example
|
|
5288
|
+
* ```js
|
|
5289
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
5290
|
+
* ```
|
|
5291
|
+
*/
|
|
5243
5292
|
CollapseDataPanel = "collapseDataPanel",
|
|
5244
5293
|
/**
|
|
5245
5294
|
* The **Choose sources** button on Search page.
|
|
@@ -5275,7 +5324,7 @@ export declare enum Action {
|
|
|
5275
5324
|
* ```js
|
|
5276
5325
|
* disabledActions: [Action.AddColumnSet]
|
|
5277
5326
|
* ```
|
|
5278
|
-
* @version SDK: 1.32.0 |
|
|
5327
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5279
5328
|
*/
|
|
5280
5329
|
AddColumnSet = "addSimpleCohort",
|
|
5281
5330
|
/**
|
|
@@ -5285,7 +5334,7 @@ export declare enum Action {
|
|
|
5285
5334
|
* ```js
|
|
5286
5335
|
* disabledActions: [Action.AddQuerySet]
|
|
5287
5336
|
* ```
|
|
5288
|
-
* @version SDK: 1.32.0 |
|
|
5337
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5289
5338
|
*/
|
|
5290
5339
|
AddQuerySet = "addAdvancedCohort",
|
|
5291
5340
|
/**
|
|
@@ -5317,6 +5366,8 @@ export declare enum Action {
|
|
|
5317
5366
|
/**
|
|
5318
5367
|
* The **Show underlying data** menu action on a visualization or
|
|
5319
5368
|
* Answer page.
|
|
5369
|
+
* Displays detailed information and raw data
|
|
5370
|
+
* for a given visualization.
|
|
5320
5371
|
* @example
|
|
5321
5372
|
* ```js
|
|
5322
5373
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -5518,6 +5569,7 @@ export declare enum Action {
|
|
|
5518
5569
|
AnalysisInfo = "analysisInfo",
|
|
5519
5570
|
/**
|
|
5520
5571
|
* The **Schedule** menu action on a Liveboard.
|
|
5572
|
+
* Allows scheduling a Liveboard job.
|
|
5521
5573
|
* @example
|
|
5522
5574
|
* ```js
|
|
5523
5575
|
* disabledActions: [Action.Subscription]
|
|
@@ -5587,8 +5639,13 @@ export declare enum Action {
|
|
|
5587
5639
|
*/
|
|
5588
5640
|
RequestAccess = "requestAccess",
|
|
5589
5641
|
/**
|
|
5590
|
-
* The **Query visualizer** and **Query SQL** buttons in
|
|
5591
|
-
* of the Answer page
|
|
5642
|
+
* The **Query visualizer** and **Query SQL** buttons in
|
|
5643
|
+
* Query details panel of the Answer page.
|
|
5644
|
+
*
|
|
5645
|
+
* **Query visualizer** - Displays the tables
|
|
5646
|
+
* and filters used in a search query.
|
|
5647
|
+
* **Query SQL** - Displays the SQL statements used
|
|
5648
|
+
* in a search query to fetch data.
|
|
5592
5649
|
* @example
|
|
5593
5650
|
* ```js
|
|
5594
5651
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5606,7 +5663,10 @@ export declare enum Action {
|
|
|
5606
5663
|
*/
|
|
5607
5664
|
AnswerDelete = "onDeleteAnswer",
|
|
5608
5665
|
/**
|
|
5609
|
-
* The
|
|
5666
|
+
* The chart switcher icon on Answer page and
|
|
5667
|
+
* visualizations in edit mode.
|
|
5668
|
+
* Allows switching to the table or chart mode
|
|
5669
|
+
* when editing a visualization.
|
|
5610
5670
|
* @example
|
|
5611
5671
|
* ```js
|
|
5612
5672
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -5615,7 +5675,10 @@ export declare enum Action {
|
|
|
5615
5675
|
*/
|
|
5616
5676
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5617
5677
|
/**
|
|
5618
|
-
* Favorites icon (*)
|
|
5678
|
+
* The Favorites icon (*) for Answers,
|
|
5679
|
+
* Liveboard, and data objects like Worksheet, Model,
|
|
5680
|
+
* Tables and Views.
|
|
5681
|
+
* Allows adding an object to the user’s favorites list.
|
|
5619
5682
|
* @example
|
|
5620
5683
|
* ```js
|
|
5621
5684
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -5633,7 +5696,9 @@ export declare enum Action {
|
|
|
5633
5696
|
*/
|
|
5634
5697
|
EditDetails = "editDetails",
|
|
5635
5698
|
/**
|
|
5636
|
-
* The Create alert action
|
|
5699
|
+
* The *Create alert* action for KPI charts.
|
|
5700
|
+
* Allows users to schedule threshold-based alerts
|
|
5701
|
+
* for KPI charts.
|
|
5637
5702
|
* @example
|
|
5638
5703
|
* ```js
|
|
5639
5704
|
* disabledActions: [Action.CreateMonitor]
|
|
@@ -5689,7 +5754,7 @@ export declare enum Action {
|
|
|
5689
5754
|
* ```js
|
|
5690
5755
|
* disabledActions: [Action.CrossFilter]
|
|
5691
5756
|
* ```
|
|
5692
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5757
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
|
|
5693
5758
|
*/
|
|
5694
5759
|
CrossFilter = "context-menu-item-cross-filter",
|
|
5695
5760
|
/**
|
|
@@ -5699,7 +5764,7 @@ export declare enum Action {
|
|
|
5699
5764
|
* ```js
|
|
5700
5765
|
* disabledActions: [Action.SyncToSlack]
|
|
5701
5766
|
* ```
|
|
5702
|
-
* @version @version SDK : 1.32.0 |
|
|
5767
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5703
5768
|
*/
|
|
5704
5769
|
SyncToSlack = "syncToSlack",
|
|
5705
5770
|
/**
|
|
@@ -5709,7 +5774,7 @@ export declare enum Action {
|
|
|
5709
5774
|
* ```js
|
|
5710
5775
|
* disabledActions: [Action.SyncToTeams]
|
|
5711
5776
|
* ```
|
|
5712
|
-
* @version @version SDK : 1.32.0 |
|
|
5777
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5713
5778
|
*/
|
|
5714
5779
|
SyncToTeams = "syncToTeams",
|
|
5715
5780
|
/**
|
|
@@ -5720,7 +5785,7 @@ export declare enum Action {
|
|
|
5720
5785
|
* ```js
|
|
5721
5786
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
5722
5787
|
* ```
|
|
5723
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5788
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5724
5789
|
*/
|
|
5725
5790
|
RemoveCrossFilter = "context-menu-item-remove-cross-filter",
|
|
5726
5791
|
/**
|
|
@@ -5731,7 +5796,7 @@ export declare enum Action {
|
|
|
5731
5796
|
* ```js
|
|
5732
5797
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
5733
5798
|
* ```
|
|
5734
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5799
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5735
5800
|
*/
|
|
5736
5801
|
AxisMenuAggregate = "axisMenuAggregate",
|
|
5737
5802
|
/**
|
|
@@ -5742,17 +5807,19 @@ export declare enum Action {
|
|
|
5742
5807
|
* ```js
|
|
5743
5808
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
5744
5809
|
* ```
|
|
5745
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5810
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5746
5811
|
*/
|
|
5747
5812
|
AxisMenuTimeBucket = "axisMenuTimeBucket",
|
|
5748
5813
|
/**
|
|
5749
5814
|
* The **Filter** action in the chart axis or table column
|
|
5750
5815
|
* customization menu.
|
|
5816
|
+
* Allows adding, editing, or removing filters.
|
|
5817
|
+
*
|
|
5751
5818
|
* @example
|
|
5752
5819
|
* ```js
|
|
5753
5820
|
* disabledActions: [Action.AxisMenuFilter]
|
|
5754
5821
|
* ```
|
|
5755
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5822
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5756
5823
|
*/
|
|
5757
5824
|
AxisMenuFilter = "axisMenuFilter",
|
|
5758
5825
|
/**
|
|
@@ -5763,7 +5830,7 @@ export declare enum Action {
|
|
|
5763
5830
|
* ```js
|
|
5764
5831
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
5765
5832
|
* ```
|
|
5766
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5833
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5767
5834
|
*/
|
|
5768
5835
|
AxisMenuConditionalFormat = "axisMenuConditionalFormat",
|
|
5769
5836
|
/**
|
|
@@ -5774,7 +5841,7 @@ export declare enum Action {
|
|
|
5774
5841
|
* ```js
|
|
5775
5842
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
5776
5843
|
* ```
|
|
5777
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5844
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5778
5845
|
*/
|
|
5779
5846
|
AxisMenuSort = "axisMenuSort",
|
|
5780
5847
|
/**
|
|
@@ -5786,7 +5853,7 @@ export declare enum Action {
|
|
|
5786
5853
|
* ```js
|
|
5787
5854
|
* disabledActions: [Action.AxisMenuGroup]
|
|
5788
5855
|
* ```
|
|
5789
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5856
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5790
5857
|
*/
|
|
5791
5858
|
AxisMenuGroup = "axisMenuGroup",
|
|
5792
5859
|
/**
|
|
@@ -5797,7 +5864,7 @@ export declare enum Action {
|
|
|
5797
5864
|
* ```js
|
|
5798
5865
|
* disabledActions: [Action.AxisMenuPosition]
|
|
5799
5866
|
* ```
|
|
5800
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5867
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5801
5868
|
*/
|
|
5802
5869
|
AxisMenuPosition = "axisMenuPosition",
|
|
5803
5870
|
/**
|
|
@@ -5807,7 +5874,7 @@ export declare enum Action {
|
|
|
5807
5874
|
* ```js
|
|
5808
5875
|
* disabledActions: [Action.AxisMenuRename]
|
|
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
|
AxisMenuRename = "axisMenuRename",
|
|
5813
5880
|
/**
|
|
@@ -5818,7 +5885,7 @@ export declare enum Action {
|
|
|
5818
5885
|
* ```js
|
|
5819
5886
|
* disabledActions: [Action.AxisMenuEdit]
|
|
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
|
AxisMenuEdit = "axisMenuEdit",
|
|
5824
5891
|
/**
|
|
@@ -5828,7 +5895,7 @@ export declare enum Action {
|
|
|
5828
5895
|
* ```js
|
|
5829
5896
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
5830
5897
|
* ```
|
|
5831
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5898
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5832
5899
|
*/
|
|
5833
5900
|
AxisMenuNumberFormat = "axisMenuNumberFormat",
|
|
5834
5901
|
/**
|
|
@@ -5838,7 +5905,7 @@ export declare enum Action {
|
|
|
5838
5905
|
* ```js
|
|
5839
5906
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
5840
5907
|
* ```
|
|
5841
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5908
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5842
5909
|
*/
|
|
5843
5910
|
AxisMenuTextWrapping = "axisMenuTextWrapping",
|
|
5844
5911
|
/**
|
|
@@ -5850,7 +5917,7 @@ export declare enum Action {
|
|
|
5850
5917
|
* ```js
|
|
5851
5918
|
* disabledActions: [Action.AxisMenuRemove]
|
|
5852
5919
|
* ```
|
|
5853
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5920
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5854
5921
|
*/
|
|
5855
5922
|
AxisMenuRemove = "axisMenuRemove",
|
|
5856
5923
|
/**
|
|
@@ -5864,26 +5931,27 @@ export declare enum Action {
|
|
|
5864
5931
|
* ```js
|
|
5865
5932
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
5866
5933
|
* ```
|
|
5867
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
5934
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
|
|
5868
5935
|
*/
|
|
5869
5936
|
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
5870
5937
|
/**
|
|
5871
|
-
*
|
|
5938
|
+
* The *Request verification* action on a Liveboard.
|
|
5939
|
+
* Initiates a request for Liveboard verification.
|
|
5872
5940
|
* @example
|
|
5873
5941
|
* ```js
|
|
5874
5942
|
* disabledActions: [Action.RequestVerification]
|
|
5875
5943
|
* ```
|
|
5876
|
-
* @version SDK: 1.25.0 |
|
|
5944
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
5877
5945
|
*/
|
|
5878
5946
|
RequestVerification = "requestVerification",
|
|
5879
5947
|
/**
|
|
5880
5948
|
*
|
|
5881
|
-
*Allows users to mark a Liveboard as verified.
|
|
5949
|
+
* Allows users to mark a Liveboard as verified.
|
|
5882
5950
|
* @example
|
|
5883
5951
|
* ```js
|
|
5884
5952
|
* disabledActions: [Action.MarkAsVerified]
|
|
5885
5953
|
* ```
|
|
5886
|
-
* @version SDK: 1.25.0 |
|
|
5954
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
5887
5955
|
*/
|
|
5888
5956
|
MarkAsVerified = "markAsVerified",
|
|
5889
5957
|
/**
|
|
@@ -5893,7 +5961,7 @@ export declare enum Action {
|
|
|
5893
5961
|
* ```js
|
|
5894
5962
|
* disabledActions: [Action.AddTab]
|
|
5895
5963
|
* ```
|
|
5896
|
-
* @version SDK: 1.26.0 |
|
|
5964
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5897
5965
|
*/
|
|
5898
5966
|
AddTab = "addTab",
|
|
5899
5967
|
/**
|
|
@@ -5903,35 +5971,42 @@ export declare enum Action {
|
|
|
5903
5971
|
* ```js
|
|
5904
5972
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
5905
5973
|
* ```
|
|
5906
|
-
* @version SDK: 1.25.0 |
|
|
5974
|
+
* @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
|
|
5907
5975
|
*/
|
|
5908
5976
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
5909
5977
|
/**
|
|
5978
|
+
* Action ID to hide or disable Natural Language Search query.
|
|
5910
5979
|
*
|
|
5911
5980
|
* @example
|
|
5912
5981
|
* ```js
|
|
5913
5982
|
* disabledActions: [Action.ShowSageQuery]
|
|
5914
5983
|
* ```
|
|
5915
|
-
* @version SDK: 1.26.0 |
|
|
5984
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
5916
5985
|
*/
|
|
5917
5986
|
ShowSageQuery = "showSageQuery",
|
|
5918
5987
|
/**
|
|
5988
|
+
*
|
|
5989
|
+
* Action ID to hide or disable the edit option for the
|
|
5990
|
+
* results generated from the
|
|
5991
|
+
* Natural Language Search query.
|
|
5919
5992
|
*
|
|
5920
5993
|
* @example
|
|
5921
5994
|
* ```js
|
|
5922
5995
|
* disabledActions: [Action.EditSageAnswer]
|
|
5923
5996
|
* ```
|
|
5924
|
-
* @version SDK: 1.26.0 |
|
|
5997
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
5925
5998
|
*/
|
|
5926
5999
|
EditSageAnswer = "editSageAnswer",
|
|
5927
6000
|
/**
|
|
6001
|
+
* The feedback widget for AI-generated Answers.
|
|
6002
|
+
* Allows users to send feedback on the Answers generated
|
|
6003
|
+
* from a Natural Language Search query.
|
|
5928
6004
|
*
|
|
5929
|
-
*This action allows users to send feedback on AI-generated Answers.
|
|
5930
6005
|
* @example
|
|
5931
6006
|
* ```js
|
|
5932
6007
|
* disabledActions: [Action.SageAnswerFeedback]
|
|
5933
6008
|
* ```
|
|
5934
|
-
* @version SDK: 1.26.0 |
|
|
6009
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
5935
6010
|
*/
|
|
5936
6011
|
SageAnswerFeedback = "sageAnswerFeedback",
|
|
5937
6012
|
/**
|
|
@@ -5940,7 +6015,7 @@ export declare enum Action {
|
|
|
5940
6015
|
* ```js
|
|
5941
6016
|
* disabledActions: [Action.ModifySageAnswer]
|
|
5942
6017
|
* ```
|
|
5943
|
-
* @version SDK: 1.26.0 |
|
|
6018
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
5944
6019
|
*/
|
|
5945
6020
|
ModifySageAnswer = "modifySageAnswer",
|
|
5946
6021
|
/**
|
|
@@ -5953,7 +6028,10 @@ export declare enum Action {
|
|
|
5953
6028
|
*/
|
|
5954
6029
|
MoveToTab = "onContainerMove",
|
|
5955
6030
|
/**
|
|
5956
|
-
* The **Manage
|
|
6031
|
+
* The **Manage Alerts** menu action on KPI visualizations.
|
|
6032
|
+
* Allows creating, viewing, and editing monitor
|
|
6033
|
+
* alerts for a KPI chart.
|
|
6034
|
+
*
|
|
5957
6035
|
* @example
|
|
5958
6036
|
* ```js
|
|
5959
6037
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -5961,21 +6039,23 @@ export declare enum Action {
|
|
|
5961
6039
|
*/
|
|
5962
6040
|
ManageMonitor = "manageMonitor",
|
|
5963
6041
|
/**
|
|
5964
|
-
*
|
|
6042
|
+
* The Liveboard Personalised Views dropdown.
|
|
6043
|
+
* Allows navigating to a personalized Liveboard View.
|
|
5965
6044
|
* @example
|
|
5966
6045
|
* ```js
|
|
5967
6046
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
5968
6047
|
* ```
|
|
5969
|
-
* @version SDK : 1.26.0 |
|
|
6048
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
5970
6049
|
*/
|
|
5971
6050
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
5972
6051
|
/**
|
|
5973
|
-
* Action ID for
|
|
6052
|
+
* Action ID for show or hide the user details on a
|
|
6053
|
+
* Liveboard (Recently visited / social proof)
|
|
5974
6054
|
* @example
|
|
5975
6055
|
* ```js
|
|
5976
6056
|
* disabledActions: [Action.LiveboardUsers]
|
|
5977
6057
|
* ```
|
|
5978
|
-
* @version SDK : 1.26.0 |
|
|
6058
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
5979
6059
|
*/
|
|
5980
6060
|
LiveboardUsers = "liveboardUsers",
|
|
5981
6061
|
/**
|
|
@@ -5993,108 +6073,124 @@ export declare enum Action {
|
|
|
5993
6073
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
5994
6074
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
5995
6075
|
* ```
|
|
5996
|
-
* @version SDK : 1.28.3 |
|
|
6076
|
+
* @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
5997
6077
|
*/
|
|
5998
6078
|
TML = "tml",
|
|
5999
6079
|
/**
|
|
6000
|
-
*
|
|
6001
|
-
* and Pin modal
|
|
6080
|
+
* The **Create Liveboard* action on
|
|
6081
|
+
* the Liveboards page and the Pin modal.
|
|
6082
|
+
* Allows users to create a Liveboard.
|
|
6083
|
+
*
|
|
6002
6084
|
* @example
|
|
6003
6085
|
* ```js
|
|
6004
6086
|
* hiddenAction: [Action.CreateLiveboard]
|
|
6005
6087
|
* disabledActions: [Action.CreateLiveboard]
|
|
6006
6088
|
* ```
|
|
6007
|
-
* @version SDK: 1.32.0 |
|
|
6089
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
6008
6090
|
*/
|
|
6009
6091
|
CreateLiveboard = "createLiveboard",
|
|
6010
6092
|
/**
|
|
6011
|
-
* Action ID for to hide
|
|
6093
|
+
* Action ID for to hide or disable the
|
|
6094
|
+
* Verified Liveboard banner.
|
|
6012
6095
|
* @example
|
|
6013
6096
|
* ```js
|
|
6014
6097
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
6015
6098
|
* ```
|
|
6016
|
-
* @version SDK: 1.29.0 |
|
|
6099
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
6017
6100
|
*/
|
|
6018
6101
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
6019
6102
|
/**
|
|
6020
|
-
*
|
|
6103
|
+
* The *Ask Sage* action for Answers and visualizations.
|
|
6104
|
+
* Allows initiating a Natural Language Search query.
|
|
6105
|
+
*
|
|
6021
6106
|
* @example
|
|
6022
6107
|
* ```js
|
|
6023
6108
|
* hiddenAction: [Action.AskAi]
|
|
6024
6109
|
* ```
|
|
6025
|
-
* @version SDK: 1.29.0 |
|
|
6110
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
6026
6111
|
*/
|
|
6027
6112
|
AskAi = "AskAi",
|
|
6028
6113
|
/**
|
|
6029
6114
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
6115
|
+
* Adds a KPI chart to the watchlist on the Home page.
|
|
6030
6116
|
* @example
|
|
6031
6117
|
* ```js
|
|
6032
6118
|
* disabledActions: [Action.AddToWatchlist]
|
|
6033
6119
|
* ```
|
|
6034
|
-
* @version SDK : 1.27.9 |
|
|
6120
|
+
* @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6035
6121
|
*/
|
|
6036
6122
|
AddToWatchlist = "addToWatchlist",
|
|
6037
6123
|
/**
|
|
6038
6124
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
6125
|
+
* Removes a KPI chart from the watchlist on the Home page.
|
|
6039
6126
|
* @example
|
|
6040
6127
|
* ```js
|
|
6041
6128
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6042
6129
|
* ```
|
|
6043
|
-
* @version SDK : 1.27.9 |
|
|
6130
|
+
* @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6044
6131
|
*/
|
|
6045
6132
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6046
6133
|
/**
|
|
6047
|
-
* The **
|
|
6134
|
+
* The **Organize Favourites** action on Homepage
|
|
6135
|
+
* *Favorites* module.
|
|
6136
|
+
*
|
|
6048
6137
|
* @example
|
|
6049
6138
|
* ```js
|
|
6050
6139
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6051
6140
|
* ```
|
|
6052
|
-
* @version SDK : 1.32.0 |
|
|
6141
|
+
* @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6053
6142
|
*/
|
|
6054
6143
|
OrganiseFavourites = "organiseFavourites",
|
|
6055
6144
|
/**
|
|
6056
|
-
*
|
|
6145
|
+
* The **AI Highlights** action on a Liveboard.
|
|
6146
|
+
*
|
|
6057
6147
|
* @example
|
|
6058
6148
|
* ```js
|
|
6059
6149
|
* hiddenAction: [Action.AIHighlights]
|
|
6060
6150
|
* ```
|
|
6061
|
-
* @version SDK: 1.27.10 |
|
|
6151
|
+
* @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6062
6152
|
*/
|
|
6063
6153
|
AIHighlights = "AIHighlights",
|
|
6064
6154
|
/**
|
|
6065
|
-
*
|
|
6155
|
+
* The *Edit* action on the *Liveboard Schedules* page
|
|
6156
|
+
* (new Homepage experience).
|
|
6157
|
+
* Allows editing Liveboard schedules.
|
|
6158
|
+
*
|
|
6066
6159
|
* @example
|
|
6067
6160
|
* ```js
|
|
6068
6161
|
* disabledActions: [Action.EditScheduleHomepage]
|
|
6069
6162
|
* ```
|
|
6070
|
-
* @version SDK: 1.34.0 |
|
|
6163
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6071
6164
|
*/
|
|
6072
6165
|
EditScheduleHomepage = "editScheduleHomepage",
|
|
6073
6166
|
/**
|
|
6074
|
-
*
|
|
6167
|
+
* The *Pause* action on the *Liveboard Schedules* page
|
|
6168
|
+
* Pauses a scheduled Liveboard job.
|
|
6075
6169
|
* @example
|
|
6076
6170
|
* ```js
|
|
6077
6171
|
* disabledActions: [Action.PauseScheduleHomepage]
|
|
6078
6172
|
* ```
|
|
6079
|
-
* @version SDK: 1.34.0 |
|
|
6173
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6080
6174
|
*/
|
|
6081
6175
|
PauseScheduleHomepage = "pauseScheduleHomepage",
|
|
6082
6176
|
/**
|
|
6083
|
-
*
|
|
6177
|
+
* The **View run history** action **Liveboard Schedules** page.
|
|
6178
|
+
* Allows viewing schedule run history.
|
|
6084
6179
|
* @example
|
|
6085
6180
|
* ```js
|
|
6086
6181
|
* disabledActions: [Action.ViewScheduleRunHomepage]
|
|
6087
6182
|
* ```
|
|
6088
|
-
* @version SDK: 1.34.0 |
|
|
6183
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6089
6184
|
*/
|
|
6090
6185
|
ViewScheduleRunHomepage = "viewScheduleRunHomepage",
|
|
6091
6186
|
/**
|
|
6092
|
-
* Action ID
|
|
6187
|
+
* Action ID to hide or disable the
|
|
6188
|
+
* unsubscribe option for Liveboard schedules.
|
|
6093
6189
|
* @example
|
|
6094
6190
|
* ```js
|
|
6095
6191
|
* disabledActions: [Action.UnsubscribeScheduleHomepage]
|
|
6096
6192
|
* ```
|
|
6097
|
-
* @version SDK: 1.34.0 |
|
|
6193
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6098
6194
|
*/
|
|
6099
6195
|
UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
|
|
6100
6196
|
/**
|
|
@@ -6103,16 +6199,17 @@ export declare enum Action {
|
|
|
6103
6199
|
* ```js
|
|
6104
6200
|
* disabledActions: [Action.ManageTags]
|
|
6105
6201
|
* ```
|
|
6106
|
-
* @version SDK : 1.34.0 |
|
|
6202
|
+
* @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6107
6203
|
*/
|
|
6108
6204
|
ManageTags = "manageTags",
|
|
6109
6205
|
/**
|
|
6110
|
-
*
|
|
6206
|
+
* The **Delete** action on the **Liveboard Schedules* page.
|
|
6207
|
+
* Deletes a Liveboard schedule.
|
|
6111
6208
|
* @example
|
|
6112
6209
|
* ```js
|
|
6113
6210
|
* disabledActions: [Action.DeleteScheduleHomepage]
|
|
6114
6211
|
* ```
|
|
6115
|
-
* @version SDK: 1.34.0 |
|
|
6212
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6116
6213
|
*/
|
|
6117
6214
|
DeleteScheduleHomepage = "deleteScheduleHomepage",
|
|
6118
6215
|
/**
|
|
@@ -6121,7 +6218,7 @@ export declare enum Action {
|
|
|
6121
6218
|
* ```js
|
|
6122
6219
|
* disabledActions: [Action.KPIAnalysisCTA]
|
|
6123
6220
|
* ```
|
|
6124
|
-
* @version SDK: 1.34.0 |
|
|
6221
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6125
6222
|
*/
|
|
6126
6223
|
KPIAnalysisCTA = "kpiAnalysisCTA",
|
|
6127
6224
|
/**
|
|
@@ -6130,61 +6227,73 @@ export declare enum Action {
|
|
|
6130
6227
|
* ```js
|
|
6131
6228
|
* const disabledActions = [Action.DisableChipReorder]
|
|
6132
6229
|
* ```
|
|
6133
|
-
* @version SDK: 1.36.0 |
|
|
6230
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6134
6231
|
*/
|
|
6135
6232
|
DisableChipReorder = "disableChipReorder",
|
|
6136
6233
|
/**
|
|
6137
|
-
* Action ID
|
|
6234
|
+
* Action ID to show, hide, or disable filters
|
|
6235
|
+
* in a Liveboard tab.
|
|
6236
|
+
*
|
|
6138
6237
|
* @example
|
|
6139
6238
|
* ```js
|
|
6140
6239
|
* hiddenAction: [Action.ChangeFilterVisibilityInTab]
|
|
6141
6240
|
* ```
|
|
6142
|
-
* @version SDK: 1.36.0 |
|
|
6241
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6143
6242
|
*/
|
|
6144
6243
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
6145
6244
|
/**
|
|
6146
|
-
*
|
|
6245
|
+
* The **Preview data** button on the Spotter interface.
|
|
6246
|
+
* Allows previewing the data used for Spotter queries.
|
|
6247
|
+
*
|
|
6147
6248
|
* @example
|
|
6148
6249
|
* ```js
|
|
6149
6250
|
* hiddenAction: [Action.PreviewDataSpotter]
|
|
6150
6251
|
* ```
|
|
6151
|
-
* @version SDK: 1.36.0 |
|
|
6252
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6152
6253
|
*/
|
|
6153
6254
|
PreviewDataSpotter = "previewDataSpotter",
|
|
6154
6255
|
/**
|
|
6155
|
-
*
|
|
6256
|
+
* The **Reset** link on the Spotter interface.
|
|
6257
|
+
* Resets the conversation with Spotter.
|
|
6258
|
+
*
|
|
6156
6259
|
* @example
|
|
6157
6260
|
* ```js
|
|
6158
6261
|
* hiddenAction: [Action.ResetSpotterChat]
|
|
6159
6262
|
* ```
|
|
6160
|
-
* @version SDK: 1.36.0 |
|
|
6263
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6161
6264
|
*/
|
|
6162
6265
|
ResetSpotterChat = "resetSpotterChat",
|
|
6163
6266
|
/**
|
|
6164
|
-
* Action ID for hide
|
|
6267
|
+
* Action ID for hide or disable the
|
|
6268
|
+
* Spotter feedback widget.
|
|
6269
|
+
*
|
|
6165
6270
|
* @example
|
|
6166
6271
|
* ```js
|
|
6167
6272
|
* hiddenAction: [Action.SpotterFeedback]
|
|
6168
6273
|
* ```
|
|
6169
|
-
* @version SDK: 1.36.0 |
|
|
6274
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6170
6275
|
*/
|
|
6171
6276
|
SpotterFeedback = "spotterFeedback",
|
|
6172
6277
|
/**
|
|
6173
|
-
* Action ID for hide
|
|
6278
|
+
* Action ID for hide or disable
|
|
6279
|
+
* the previous prompt edit option in Spotter.
|
|
6280
|
+
*
|
|
6174
6281
|
* @example
|
|
6175
6282
|
* ```js
|
|
6176
6283
|
* hiddenAction: [Action.EditPreviousPrompt]
|
|
6177
6284
|
* ```
|
|
6178
|
-
* @version SDK: 1.36.0 |
|
|
6285
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6179
6286
|
*/
|
|
6180
6287
|
EditPreviousPrompt = "editPreviousPrompt",
|
|
6181
6288
|
/**
|
|
6182
|
-
* Action ID for hide
|
|
6289
|
+
* Action ID for hide or disable
|
|
6290
|
+
* the previous prompt deletion option in Spotter.
|
|
6291
|
+
*
|
|
6183
6292
|
* @example
|
|
6184
6293
|
* ```js
|
|
6185
6294
|
* hiddenAction: [Action.DeletePreviousPrompt]
|
|
6186
6295
|
* ```
|
|
6187
|
-
* @version SDK: 1.36.0 |
|
|
6296
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6188
6297
|
*/
|
|
6189
6298
|
DeletePreviousPrompt = "deletePreviousPrompt",
|
|
6190
6299
|
/**
|
|
@@ -6193,7 +6302,7 @@ export declare enum Action {
|
|
|
6193
6302
|
* ```js
|
|
6194
6303
|
* hiddenAction: [Action.EditTokens]
|
|
6195
6304
|
* ```
|
|
6196
|
-
* @version SDK: 1.36.0 |
|
|
6305
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6197
6306
|
*/
|
|
6198
6307
|
EditTokens = "editTokens"
|
|
6199
6308
|
}
|
|
@@ -6264,7 +6373,7 @@ export declare enum LogLevel {
|
|
|
6264
6373
|
* logLevel: LogLevel.SILENT,
|
|
6265
6374
|
* })
|
|
6266
6375
|
* ```
|
|
6267
|
-
* @version SDK: 1.26.7 |
|
|
6376
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6268
6377
|
*/
|
|
6269
6378
|
SILENT = "SILENT",
|
|
6270
6379
|
/**
|
|
@@ -6276,7 +6385,7 @@ export declare enum LogLevel {
|
|
|
6276
6385
|
* logLevel: LogLevel.ERROR,
|
|
6277
6386
|
* })
|
|
6278
6387
|
* ```
|
|
6279
|
-
* @version SDK: 1.26.7 |
|
|
6388
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6280
6389
|
*/
|
|
6281
6390
|
ERROR = "ERROR",
|
|
6282
6391
|
/**
|
|
@@ -6288,7 +6397,7 @@ export declare enum LogLevel {
|
|
|
6288
6397
|
* logLevel: LogLevel.WARN,
|
|
6289
6398
|
* })
|
|
6290
6399
|
* ```
|
|
6291
|
-
* @version SDK: 1.26.7 |
|
|
6400
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6292
6401
|
*/
|
|
6293
6402
|
WARN = "WARN",
|
|
6294
6403
|
/**
|
|
@@ -6300,7 +6409,7 @@ export declare enum LogLevel {
|
|
|
6300
6409
|
* logLevel: LogLevel.INFO,
|
|
6301
6410
|
* })
|
|
6302
6411
|
* ```
|
|
6303
|
-
* @version SDK: 1.26.7 |
|
|
6412
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6304
6413
|
*/
|
|
6305
6414
|
INFO = "INFO",
|
|
6306
6415
|
/**
|
|
@@ -6312,7 +6421,7 @@ export declare enum LogLevel {
|
|
|
6312
6421
|
* logLevel: LogLevel.DEBUG,
|
|
6313
6422
|
* })
|
|
6314
6423
|
* ```
|
|
6315
|
-
* @version SDK: 1.26.7 |
|
|
6424
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6316
6425
|
*/
|
|
6317
6426
|
DEBUG = "DEBUG",
|
|
6318
6427
|
/**
|
|
@@ -6324,7 +6433,7 @@ export declare enum LogLevel {
|
|
|
6324
6433
|
* logLevel: LogLevel.TRACE,
|
|
6325
6434
|
* })
|
|
6326
6435
|
* ```
|
|
6327
|
-
* @version SDK: 1.26.7 |
|
|
6436
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6328
6437
|
*/
|
|
6329
6438
|
TRACE = "TRACE"
|
|
6330
6439
|
}
|
|
@@ -6652,7 +6761,7 @@ export declare enum UIPassthroughEvent {
|
|
|
6652
6761
|
PinAnswerToLiveboard = "addVizToPinboard",
|
|
6653
6762
|
SaveAnswer = "saveAnswer",
|
|
6654
6763
|
GetDiscoverabilityStatus = "getDiscoverabilityStatus",
|
|
6655
|
-
GetAvailableUIPassthroughs = "
|
|
6764
|
+
GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
|
|
6656
6765
|
GetAnswerConfig = "getAnswerPageConfig",
|
|
6657
6766
|
GetLiveboardConfig = "getPinboardPageConfig"
|
|
6658
6767
|
}
|