@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
|
@@ -257,8 +257,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
257
257
|
*/
|
|
258
258
|
enableSearchAssist?: boolean;
|
|
259
259
|
/**
|
|
260
|
-
* If set to true, the
|
|
261
|
-
* according to the height of the
|
|
260
|
+
* If set to true, the Liveboard container dynamically resizes
|
|
261
|
+
* according to the height of the Liveboard.
|
|
262
|
+
*
|
|
263
|
+
* **Note**: Using fullHeight loads all visualizations
|
|
264
|
+
* on the Liveboard simultaneously, which results in
|
|
265
|
+
* multiple warehouse queries and potentially a
|
|
266
|
+
* longer wait for the topmost visualizations to
|
|
267
|
+
* display on the screen. Setting fullHeight to
|
|
268
|
+
* `false` fetches visualizations incrementally as
|
|
269
|
+
* users scroll the page to view the charts and tables.
|
|
270
|
+
*
|
|
262
271
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
263
272
|
* @example
|
|
264
273
|
* ```js
|
|
@@ -657,12 +666,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
657
666
|
/**
|
|
658
667
|
* If set to true, the embedded object container dynamically resizes
|
|
659
668
|
* according to the height of the Liveboard.
|
|
669
|
+
*
|
|
660
670
|
* **Note**: Using fullHeight loads all visualizations on the
|
|
661
671
|
* Liveboard simultaneously, which results in multiple warehouse
|
|
662
672
|
* queries and potentially a longer wait for the topmost
|
|
663
673
|
* visualizations to display on the screen.
|
|
664
674
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
665
675
|
* incrementally as users scroll the page to view the charts and tables.
|
|
676
|
+
*
|
|
666
677
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
667
678
|
* @example
|
|
668
679
|
* ```js
|
|
@@ -1806,7 +1817,7 @@ export function resetCachedSessionInfo(): void;
|
|
|
1806
1817
|
*/
|
|
1807
1818
|
export enum AuthType {
|
|
1808
1819
|
/**
|
|
1809
|
-
* No authentication on the SDK.
|
|
1820
|
+
* No authentication on the SDK. Pass-through to the embedded App. Alias for
|
|
1810
1821
|
* `Passthrough`.
|
|
1811
1822
|
* @example
|
|
1812
1823
|
* ```js
|
|
@@ -2003,8 +2014,8 @@ export interface customCssInterface {
|
|
|
2003
2014
|
/**
|
|
2004
2015
|
* The custom css variables, which can be set.
|
|
2005
2016
|
* The allowed list is in the CustomCssVariables
|
|
2006
|
-
* interface.
|
|
2007
|
-
*
|
|
2017
|
+
* interface. For more information, see
|
|
2018
|
+
* link:https://developers.thoughtspot.com/docs/css-variables-reference
|
|
2008
2019
|
*/
|
|
2009
2020
|
variables?: CustomCssVariables;
|
|
2010
2021
|
/**
|
|
@@ -2046,7 +2057,7 @@ export interface CustomStyles {
|
|
|
2046
2057
|
}
|
|
2047
2058
|
/**
|
|
2048
2059
|
* Configuration to define the customization on the Embedded
|
|
2049
|
-
*
|
|
2060
|
+
* ThoughtSpot components.
|
|
2050
2061
|
* You can customize styles, text strings, and icons.
|
|
2051
2062
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
2052
2063
|
* @example
|
|
@@ -2166,7 +2177,7 @@ export interface EmbedConfig {
|
|
|
2166
2177
|
/**
|
|
2167
2178
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
2168
2179
|
* should be encoded in base64. This provides additional security to
|
|
2169
|
-
*
|
|
2180
|
+
* ThoughtSpot clusters against cross-site scripting attacks.
|
|
2170
2181
|
* @default false
|
|
2171
2182
|
*/
|
|
2172
2183
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -2319,18 +2330,18 @@ export interface EmbedConfig {
|
|
|
2319
2330
|
*/
|
|
2320
2331
|
disableSDKTracking?: boolean;
|
|
2321
2332
|
/**
|
|
2322
|
-
* Overrides default/user
|
|
2323
|
-
* @version SDK: 1.28.4 |
|
|
2333
|
+
* Overrides default/user preferred locale for date formatting
|
|
2334
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2324
2335
|
*/
|
|
2325
2336
|
dateFormatLocale?: string;
|
|
2326
2337
|
/**
|
|
2327
|
-
* Overrides default/user
|
|
2328
|
-
* @version SDK: 1.28.4 |
|
|
2338
|
+
* Overrides default/user preferred locale for number formatting
|
|
2339
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2329
2340
|
*/
|
|
2330
2341
|
numberFormatLocale?: string;
|
|
2331
2342
|
/**
|
|
2332
2343
|
* Format to be used for currency when currency format is set to infer from browser
|
|
2333
|
-
* @version SDK: 1.28.4 |
|
|
2344
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2334
2345
|
*/
|
|
2335
2346
|
currencyFormat?: string;
|
|
2336
2347
|
/**
|
|
@@ -2344,12 +2355,12 @@ export interface EmbedConfig {
|
|
|
2344
2355
|
* disableTokenVerification : true
|
|
2345
2356
|
* })
|
|
2346
2357
|
* ```
|
|
2347
|
-
* @version SDK: 1.28.5 |
|
|
2358
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
2348
2359
|
*/
|
|
2349
2360
|
disableTokenVerification?: boolean;
|
|
2350
2361
|
/**
|
|
2351
2362
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
2352
|
-
* @version SDK 1.32.3 |
|
|
2363
|
+
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
2353
2364
|
*/
|
|
2354
2365
|
disableLoginFailurePage?: boolean;
|
|
2355
2366
|
/**
|
|
@@ -2387,7 +2398,7 @@ export interface EmbedConfig {
|
|
|
2387
2398
|
* }
|
|
2388
2399
|
* });
|
|
2389
2400
|
* ```
|
|
2390
|
-
* @version SDK 1.37.0 |
|
|
2401
|
+
* @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
|
|
2391
2402
|
*/
|
|
2392
2403
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
2393
2404
|
}
|
|
@@ -2546,7 +2557,7 @@ export interface ViewConfig {
|
|
|
2546
2557
|
/**
|
|
2547
2558
|
* The list of parameter override to apply to a search answer,
|
|
2548
2559
|
* visualization, or Liveboard.
|
|
2549
|
-
* @version SDK : 1.25.0 |
|
|
2560
|
+
* @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2550
2561
|
* @example
|
|
2551
2562
|
* ```js
|
|
2552
2563
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2606,7 +2617,7 @@ export interface ViewConfig {
|
|
|
2606
2617
|
/**
|
|
2607
2618
|
* Insert as a sibling of the target container, instead of appending to a
|
|
2608
2619
|
* child inside it.
|
|
2609
|
-
* @version SDK: 1.2.0 |
|
|
2620
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
2610
2621
|
* @example
|
|
2611
2622
|
* ```js
|
|
2612
2623
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2679,7 +2690,7 @@ export interface ViewConfig {
|
|
|
2679
2690
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
2680
2691
|
* });
|
|
2681
2692
|
* ```
|
|
2682
|
-
* @version SDK: 1.26.0 |
|
|
2693
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
2683
2694
|
*/
|
|
2684
2695
|
hiddenTabs?: string[];
|
|
2685
2696
|
/**
|
|
@@ -2689,7 +2700,7 @@ export interface ViewConfig {
|
|
|
2689
2700
|
* **Note**: This option does not apply to the classic homepage.
|
|
2690
2701
|
* To access the updated modular homepage, set
|
|
2691
2702
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2692
|
-
* @version SDK: 1.28.0 |
|
|
2703
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2693
2704
|
* @example
|
|
2694
2705
|
* ```js
|
|
2695
2706
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2706,7 +2717,7 @@ export interface ViewConfig {
|
|
|
2706
2717
|
* **Note**: This option does not apply to the classic homepage.
|
|
2707
2718
|
* To access the updated modular homepage, set
|
|
2708
2719
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2709
|
-
* @version SDK: 1.28.0|
|
|
2720
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2710
2721
|
* @example
|
|
2711
2722
|
* ```js
|
|
2712
2723
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2721,7 +2732,7 @@ export interface ViewConfig {
|
|
|
2721
2732
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2722
2733
|
*
|
|
2723
2734
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2724
|
-
* @version SDK: 1.26.0 |
|
|
2735
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
2725
2736
|
* @example
|
|
2726
2737
|
* ```js
|
|
2727
2738
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2749,7 +2760,7 @@ export interface ViewConfig {
|
|
|
2749
2760
|
* **Note**: This option does not apply to the classic homepage.
|
|
2750
2761
|
* To access the updated modular homepage, set
|
|
2751
2762
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2752
|
-
* @version SDK: 1.28.0 |
|
|
2763
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2753
2764
|
*/
|
|
2754
2765
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2755
2766
|
/**
|
|
@@ -2764,7 +2775,7 @@ export interface ViewConfig {
|
|
|
2764
2775
|
* });
|
|
2765
2776
|
* embed.showPreRender();
|
|
2766
2777
|
* ```
|
|
2767
|
-
* @version SDK: 1.25.0 |
|
|
2778
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
2768
2779
|
*/
|
|
2769
2780
|
preRenderId?: string;
|
|
2770
2781
|
/**
|
|
@@ -2818,7 +2829,7 @@ export interface ViewConfig {
|
|
|
2818
2829
|
/**
|
|
2819
2830
|
* To set the initial state of the search bar in case of saved Answers.
|
|
2820
2831
|
* @default true
|
|
2821
|
-
* @version SDK: 1.34.0 |
|
|
2832
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
2822
2833
|
* @example
|
|
2823
2834
|
* ```js
|
|
2824
2835
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2842,7 +2853,7 @@ export interface ViewConfig {
|
|
|
2842
2853
|
/**
|
|
2843
2854
|
* Flag to control Data panel experience
|
|
2844
2855
|
* @default false
|
|
2845
|
-
* @version SDK: 1.34.0 |
|
|
2856
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
2846
2857
|
* @example
|
|
2847
2858
|
* ```js
|
|
2848
2859
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2854,7 +2865,7 @@ export interface ViewConfig {
|
|
|
2854
2865
|
dataPanelV2?: boolean;
|
|
2855
2866
|
/**
|
|
2856
2867
|
* To enable custom column groups in data panel v2
|
|
2857
|
-
* @version SDK: 1.32.0 |
|
|
2868
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
2858
2869
|
* @default false
|
|
2859
2870
|
* @example
|
|
2860
2871
|
* ```js
|
|
@@ -2884,7 +2895,7 @@ export interface ViewConfig {
|
|
|
2884
2895
|
/**
|
|
2885
2896
|
* Flag to control new flip tooltip context menu experience
|
|
2886
2897
|
* @default false
|
|
2887
|
-
* @version SDK: 1.36.0 |
|
|
2898
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2888
2899
|
*/
|
|
2889
2900
|
enableFlipTooltipToContextMenu?: boolean;
|
|
2890
2901
|
}
|
|
@@ -3004,7 +3015,7 @@ export enum RuntimeFilterOp {
|
|
|
3004
3015
|
* **Note**: This option does not apply to the classic homepage.
|
|
3005
3016
|
* To access the updated modular homepage, set
|
|
3006
3017
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3007
|
-
* @version SDK: 1.28.0 |
|
|
3018
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3008
3019
|
*/
|
|
3009
3020
|
export enum HomepageModule {
|
|
3010
3021
|
/**
|
|
@@ -3847,7 +3858,7 @@ export enum EmbedEvent {
|
|
|
3847
3858
|
*/
|
|
3848
3859
|
Explore = "explore",
|
|
3849
3860
|
/**
|
|
3850
|
-
* Emitted when a user clicks **Copy link** action on a visualization
|
|
3861
|
+
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
3851
3862
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3852
3863
|
* @example
|
|
3853
3864
|
*```js
|
|
@@ -3897,23 +3908,26 @@ export enum EmbedEvent {
|
|
|
3897
3908
|
*/
|
|
3898
3909
|
FilterChanged = "filterChanged",
|
|
3899
3910
|
/**
|
|
3900
|
-
* Emitted when a user clicks the **Go** button
|
|
3901
|
-
*
|
|
3911
|
+
* Emitted when a user clicks the **Go** button to initiate
|
|
3912
|
+
* a Natural Language Search query
|
|
3913
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3902
3914
|
*/
|
|
3903
3915
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3904
3916
|
/**
|
|
3905
|
-
* Emitted when a user selects a data source on the
|
|
3906
|
-
*
|
|
3917
|
+
* Emitted when a user selects a data source on the embedded
|
|
3918
|
+
* Natural Language Search interface.
|
|
3919
|
+
*
|
|
3920
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3907
3921
|
*/
|
|
3908
3922
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3909
3923
|
/**
|
|
3910
3924
|
* Emitted when a user updates a connection on the **Data** page
|
|
3911
|
-
* @version SDK : 1.27.0 |
|
|
3925
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3912
3926
|
*/
|
|
3913
3927
|
UpdateConnection = "updateConnection",
|
|
3914
3928
|
/**
|
|
3915
3929
|
* Emitted when a user updates a connection on the **Data** page
|
|
3916
|
-
* @version SDK : 1.27.0 |
|
|
3930
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3917
3931
|
*/
|
|
3918
3932
|
CreateConnection = "createConnection",
|
|
3919
3933
|
/**
|
|
@@ -3923,7 +3937,7 @@ export enum EmbedEvent {
|
|
|
3923
3937
|
* @returns viewId: string
|
|
3924
3938
|
* @returns liveboardId: string
|
|
3925
3939
|
* @returns isPublic: boolean
|
|
3926
|
-
* @version SDK : 1.26.0 |
|
|
3940
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3927
3941
|
*/
|
|
3928
3942
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3929
3943
|
/**
|
|
@@ -3932,7 +3946,7 @@ export enum EmbedEvent {
|
|
|
3932
3946
|
* @returns viewId: string
|
|
3933
3947
|
* @returns liveboardId: string
|
|
3934
3948
|
* @returns isPublic: boolean
|
|
3935
|
-
* @version SDK : 1.26.0 |
|
|
3949
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3936
3950
|
*/
|
|
3937
3951
|
SavePersonalisedView = "savePersonalisedView",
|
|
3938
3952
|
/**
|
|
@@ -3941,28 +3955,28 @@ export enum EmbedEvent {
|
|
|
3941
3955
|
* @returns viewId: string
|
|
3942
3956
|
* @returns liveboardId: string
|
|
3943
3957
|
* @returns isPublic: boolean
|
|
3944
|
-
* @version SDK : 1.26.0 |
|
|
3958
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3945
3959
|
*/
|
|
3946
3960
|
ResetLiveboard = "resetLiveboard",
|
|
3947
3961
|
/**
|
|
3948
3962
|
* Emitted when a PersonalisedView is deleted.
|
|
3949
3963
|
* @returns views: string[]
|
|
3950
3964
|
* @returns liveboardId: string
|
|
3951
|
-
* @version SDK : 1.26.0 |
|
|
3965
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3952
3966
|
*/
|
|
3953
3967
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3954
3968
|
/**
|
|
3955
3969
|
* Emitted when a user creates a new worksheet
|
|
3956
|
-
* @version SDK : 1.27.0 |
|
|
3970
|
+
* @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
3957
3971
|
*/
|
|
3958
3972
|
CreateWorksheet = "createWorksheet",
|
|
3959
3973
|
/**
|
|
3960
|
-
* Emitted when Ask Sage is initialized.
|
|
3974
|
+
* Emitted when the *Ask Sage* is initialized.
|
|
3961
3975
|
* @returns viewName: string
|
|
3962
3976
|
* @returns viewId: string
|
|
3963
3977
|
* @returns liveboardId: string
|
|
3964
3978
|
* @returns isPublic: boolean
|
|
3965
|
-
* @version SDK : 1.29.0 |
|
|
3979
|
+
* @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3966
3980
|
*/
|
|
3967
3981
|
AskSageInit = "AskSageInit",
|
|
3968
3982
|
/**
|
|
@@ -3990,7 +4004,7 @@ export enum EmbedEvent {
|
|
|
3990
4004
|
*
|
|
3991
4005
|
* error: Developers can customize the error message text when `execute`
|
|
3992
4006
|
* returns `false` using the error parameter in responder.
|
|
3993
|
-
* @version SDK : 1.29.0 |
|
|
4007
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
3994
4008
|
* @example
|
|
3995
4009
|
*```js
|
|
3996
4010
|
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
@@ -4038,7 +4052,7 @@ export enum EmbedEvent {
|
|
|
4038
4052
|
* console.log('payload', payload);
|
|
4039
4053
|
* })
|
|
4040
4054
|
*```
|
|
4041
|
-
* @version SDK : 1.29.0 |
|
|
4055
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
4042
4056
|
*/
|
|
4043
4057
|
ParameterChanged = "parameterChanged"
|
|
4044
4058
|
}
|
|
@@ -4185,7 +4199,7 @@ export enum HostEvent {
|
|
|
4185
4199
|
* const url = embed.trigger(HostEvent.GetIframeUrl);
|
|
4186
4200
|
* console.log("iFrameURL",url);
|
|
4187
4201
|
* ```
|
|
4188
|
-
* @version SDK: 1.35.0 |
|
|
4202
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
4189
4203
|
*/
|
|
4190
4204
|
GetIframeUrl = "GetIframeUrl",
|
|
4191
4205
|
/**
|
|
@@ -4218,6 +4232,11 @@ export enum HostEvent {
|
|
|
4218
4232
|
* attributes passed with this event are appended to the existing runtime
|
|
4219
4233
|
* filters applied on a Liveboard.
|
|
4220
4234
|
*
|
|
4235
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
|
|
4236
|
+
* and `AppEmbed` only. In full application embedding, this event updates
|
|
4237
|
+
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
4238
|
+
*
|
|
4239
|
+
*
|
|
4221
4240
|
* Pass an array of runtime filters with the following attributes:
|
|
4222
4241
|
*
|
|
4223
4242
|
* `columnName` - _String_. The name of the column to filter on.
|
|
@@ -4228,9 +4247,12 @@ export enum HostEvent {
|
|
|
4228
4247
|
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
4229
4248
|
* single value, whereas BW and IN accept multiple values.
|
|
4230
4249
|
*
|
|
4231
|
-
* **Note**:
|
|
4232
|
-
*
|
|
4233
|
-
*
|
|
4250
|
+
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
4251
|
+
* object to its original state and applies new filter conditions.
|
|
4252
|
+
* Any user changes (like drilling into a visualization)
|
|
4253
|
+
* will be cleared, restoring the original visualization
|
|
4254
|
+
* with the updated filters.
|
|
4255
|
+
*
|
|
4234
4256
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
4235
4257
|
* @example
|
|
4236
4258
|
* ```js
|
|
@@ -4245,7 +4267,7 @@ export enum HostEvent {
|
|
|
4245
4267
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
4246
4268
|
/**
|
|
4247
4269
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4248
|
-
* This is the same as calling `appEmbed.navigateToPage(path, true)
|
|
4270
|
+
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
4249
4271
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
4250
4272
|
* be a number; for example, `1`, `-1`.
|
|
4251
4273
|
* @example
|
|
@@ -4540,7 +4562,9 @@ export enum HostEvent {
|
|
|
4540
4562
|
*/
|
|
4541
4563
|
GetTML = "getTML",
|
|
4542
4564
|
/**
|
|
4543
|
-
* Trigger the **Show underlying data** action on
|
|
4565
|
+
* Trigger the **Show underlying data** action on a
|
|
4566
|
+
* chart or table.
|
|
4567
|
+
*
|
|
4544
4568
|
* @param - an object with vizId as a key
|
|
4545
4569
|
* @example
|
|
4546
4570
|
* ```js
|
|
@@ -4574,8 +4598,8 @@ export enum HostEvent {
|
|
|
4574
4598
|
*/
|
|
4575
4599
|
Delete = "onDeleteAnswer",
|
|
4576
4600
|
/**
|
|
4577
|
-
* Trigger the **SpotIQ analyze** action on
|
|
4578
|
-
* or
|
|
4601
|
+
* Trigger the **SpotIQ analyze** action on a
|
|
4602
|
+
* chart or table.
|
|
4579
4603
|
* @param - Liveboard embed takes `vizId` as a
|
|
4580
4604
|
* key. Can be left undefined when embedding Search or
|
|
4581
4605
|
* visualization.
|
|
@@ -4848,7 +4872,7 @@ export enum HostEvent {
|
|
|
4848
4872
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
4849
4873
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
4850
4874
|
* ```
|
|
4851
|
-
* @version SDK: 1.26.0 |
|
|
4875
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4852
4876
|
*/
|
|
4853
4877
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
4854
4878
|
/**
|
|
@@ -4861,7 +4885,7 @@ export enum HostEvent {
|
|
|
4861
4885
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
4862
4886
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
4863
4887
|
* ```
|
|
4864
|
-
* @version SDK: 1.26.0 |
|
|
4888
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4865
4889
|
*/
|
|
4866
4890
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4867
4891
|
/**
|
|
@@ -4875,7 +4899,7 @@ export enum HostEvent {
|
|
|
4875
4899
|
* executeSearch: true,
|
|
4876
4900
|
* })
|
|
4877
4901
|
* ```
|
|
4878
|
-
* @version SDK: 1.26.0 |
|
|
4902
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
4879
4903
|
*/
|
|
4880
4904
|
UpdateSageQuery = "updateSageQuery",
|
|
4881
4905
|
/**
|
|
@@ -4892,21 +4916,22 @@ export enum HostEvent {
|
|
|
4892
4916
|
* ```js
|
|
4893
4917
|
* const {session} = await embed.trigger( HostEvent.GetAnswerSession )
|
|
4894
4918
|
* ```
|
|
4895
|
-
* @version SDK: 1.26.0 |
|
|
4919
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
4896
4920
|
*/
|
|
4897
4921
|
GetAnswerSession = "getAnswerSession",
|
|
4898
4922
|
/**
|
|
4899
|
-
* Trigger Ask Sage for
|
|
4923
|
+
* Trigger the *Ask Sage* action for visualizations
|
|
4900
4924
|
* @example
|
|
4901
4925
|
* ```js
|
|
4902
4926
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
4903
4927
|
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
4904
4928
|
* ```
|
|
4905
|
-
* @version SDK: 1.29.0 |
|
|
4929
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
4906
4930
|
*/
|
|
4907
4931
|
AskSage = "AskSage",
|
|
4908
4932
|
/**
|
|
4909
|
-
* Trigger cross filter update action on a Liveboard
|
|
4933
|
+
* Trigger cross filter update action on a Liveboard.
|
|
4934
|
+
*
|
|
4910
4935
|
* @example
|
|
4911
4936
|
* ```js
|
|
4912
4937
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -4917,7 +4942,7 @@ export enum HostEvent {
|
|
|
4917
4942
|
* ],
|
|
4918
4943
|
* });
|
|
4919
4944
|
* ```
|
|
4920
|
-
* @version SDK: 1.29.0 |
|
|
4945
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
|
|
4921
4946
|
*/
|
|
4922
4947
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
4923
4948
|
/**
|
|
@@ -4926,11 +4951,13 @@ export enum HostEvent {
|
|
|
4926
4951
|
* ```js
|
|
4927
4952
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
4928
4953
|
* ```
|
|
4929
|
-
* @version SDK: 1.29.0 |
|
|
4954
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
|
|
4930
4955
|
*/
|
|
4931
4956
|
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4932
4957
|
/**
|
|
4933
|
-
* Triggers an
|
|
4958
|
+
* Triggers an action to update Parameter values on embedded
|
|
4959
|
+
* Answers and Liveboard.
|
|
4960
|
+
*
|
|
4934
4961
|
* @example
|
|
4935
4962
|
* ```js
|
|
4936
4963
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -4938,30 +4965,30 @@ export enum HostEvent {
|
|
|
4938
4965
|
* value: "almond"
|
|
4939
4966
|
* }])
|
|
4940
4967
|
*
|
|
4941
|
-
* @version SDK: 1.29.0 |
|
|
4968
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
4942
4969
|
*/
|
|
4943
4970
|
UpdateParameters = "UpdateParameters",
|
|
4944
4971
|
/**
|
|
4945
|
-
* Triggers GetParameters to fetch the runtime
|
|
4972
|
+
* Triggers GetParameters to fetch the runtime Parameters.
|
|
4946
4973
|
* ```js
|
|
4947
4974
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
4948
4975
|
* console.log('parameters', parameter);
|
|
4949
4976
|
* });
|
|
4950
4977
|
*```
|
|
4951
|
-
* @version SDK: 1.29.0 |
|
|
4978
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
4952
4979
|
*/
|
|
4953
4980
|
GetParameters = "GetParameters",
|
|
4954
4981
|
/**
|
|
4955
|
-
* Triggers an event to update a
|
|
4982
|
+
* Triggers an event to update a personalized view of a Liveboard.
|
|
4956
4983
|
* ```js
|
|
4957
4984
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
4958
4985
|
* ```
|
|
4959
|
-
* @version SDK: 1.36.0 |
|
|
4986
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
4960
4987
|
*/
|
|
4961
4988
|
UpdatePersonalisedView = "UpdatePersonalisedView",
|
|
4962
4989
|
/**
|
|
4963
|
-
* Triggers the action to get the current view of the
|
|
4964
|
-
* @version SDK: 1.36.0 |
|
|
4990
|
+
* Triggers the action to get the current view of the Liveboard.
|
|
4991
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
4965
4992
|
*/
|
|
4966
4993
|
SaveAnswer = "saveAnswer",
|
|
4967
4994
|
/**
|
|
@@ -5181,7 +5208,8 @@ export enum Action {
|
|
|
5181
5208
|
ResetLayout = "resetLayout",
|
|
5182
5209
|
/**
|
|
5183
5210
|
* The **Schedule** menu action on a Liveboard.
|
|
5184
|
-
* Allows scheduling a Liveboard
|
|
5211
|
+
* Allows scheduling a Liveboard job, for example,
|
|
5212
|
+
* sending periodic notifications.
|
|
5185
5213
|
* @example
|
|
5186
5214
|
* ```js
|
|
5187
5215
|
* disabledActions: [Action.Schedule]
|
|
@@ -5223,7 +5251,7 @@ export enum Action {
|
|
|
5223
5251
|
* ```js
|
|
5224
5252
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
5225
5253
|
* ```
|
|
5226
|
-
* @version SDK: 1.32.0 |
|
|
5254
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5227
5255
|
*/
|
|
5228
5256
|
AddDataPanelObjects = "addDataPanelObjects",
|
|
5229
5257
|
/**
|
|
@@ -5236,7 +5264,28 @@ export enum Action {
|
|
|
5236
5264
|
* ```
|
|
5237
5265
|
*/
|
|
5238
5266
|
ConfigureFilter = "configureFilter",
|
|
5267
|
+
/**
|
|
5268
|
+
* The **Collapse data sources** icon on the Search page.
|
|
5269
|
+
* Collapses the panel showing data sources.
|
|
5270
|
+
*
|
|
5271
|
+
* @example
|
|
5272
|
+
* ```js
|
|
5273
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
5274
|
+
* ```
|
|
5275
|
+
* @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5276
|
+
*/
|
|
5239
5277
|
CollapseDataSources = "collapseDataSources",
|
|
5278
|
+
/**
|
|
5279
|
+
* The **Collapse data panel** icon on the Search page.
|
|
5280
|
+
* Collapses the data panel view.
|
|
5281
|
+
*
|
|
5282
|
+
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
|
|
5283
|
+
*
|
|
5284
|
+
* @example
|
|
5285
|
+
* ```js
|
|
5286
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
5287
|
+
* ```
|
|
5288
|
+
*/
|
|
5240
5289
|
CollapseDataPanel = "collapseDataPanel",
|
|
5241
5290
|
/**
|
|
5242
5291
|
* The **Choose sources** button on Search page.
|
|
@@ -5272,7 +5321,7 @@ export enum Action {
|
|
|
5272
5321
|
* ```js
|
|
5273
5322
|
* disabledActions: [Action.AddColumnSet]
|
|
5274
5323
|
* ```
|
|
5275
|
-
* @version SDK: 1.32.0 |
|
|
5324
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5276
5325
|
*/
|
|
5277
5326
|
AddColumnSet = "addSimpleCohort",
|
|
5278
5327
|
/**
|
|
@@ -5282,7 +5331,7 @@ export enum Action {
|
|
|
5282
5331
|
* ```js
|
|
5283
5332
|
* disabledActions: [Action.AddQuerySet]
|
|
5284
5333
|
* ```
|
|
5285
|
-
* @version SDK: 1.32.0 |
|
|
5334
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5286
5335
|
*/
|
|
5287
5336
|
AddQuerySet = "addAdvancedCohort",
|
|
5288
5337
|
/**
|
|
@@ -5314,6 +5363,8 @@ export enum Action {
|
|
|
5314
5363
|
/**
|
|
5315
5364
|
* The **Show underlying data** menu action on a visualization or
|
|
5316
5365
|
* Answer page.
|
|
5366
|
+
* Displays detailed information and raw data
|
|
5367
|
+
* for a given visualization.
|
|
5317
5368
|
* @example
|
|
5318
5369
|
* ```js
|
|
5319
5370
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -5515,6 +5566,7 @@ export enum Action {
|
|
|
5515
5566
|
AnalysisInfo = "analysisInfo",
|
|
5516
5567
|
/**
|
|
5517
5568
|
* The **Schedule** menu action on a Liveboard.
|
|
5569
|
+
* Allows scheduling a Liveboard job.
|
|
5518
5570
|
* @example
|
|
5519
5571
|
* ```js
|
|
5520
5572
|
* disabledActions: [Action.Subscription]
|
|
@@ -5584,8 +5636,13 @@ export enum Action {
|
|
|
5584
5636
|
*/
|
|
5585
5637
|
RequestAccess = "requestAccess",
|
|
5586
5638
|
/**
|
|
5587
|
-
* The **Query visualizer** and **Query SQL** buttons in
|
|
5588
|
-
* of the Answer page
|
|
5639
|
+
* The **Query visualizer** and **Query SQL** buttons in
|
|
5640
|
+
* Query details panel of the Answer page.
|
|
5641
|
+
*
|
|
5642
|
+
* **Query visualizer** - Displays the tables
|
|
5643
|
+
* and filters used in a search query.
|
|
5644
|
+
* **Query SQL** - Displays the SQL statements used
|
|
5645
|
+
* in a search query to fetch data.
|
|
5589
5646
|
* @example
|
|
5590
5647
|
* ```js
|
|
5591
5648
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5603,7 +5660,10 @@ export enum Action {
|
|
|
5603
5660
|
*/
|
|
5604
5661
|
AnswerDelete = "onDeleteAnswer",
|
|
5605
5662
|
/**
|
|
5606
|
-
* The
|
|
5663
|
+
* The chart switcher icon on Answer page and
|
|
5664
|
+
* visualizations in edit mode.
|
|
5665
|
+
* Allows switching to the table or chart mode
|
|
5666
|
+
* when editing a visualization.
|
|
5607
5667
|
* @example
|
|
5608
5668
|
* ```js
|
|
5609
5669
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -5612,7 +5672,10 @@ export enum Action {
|
|
|
5612
5672
|
*/
|
|
5613
5673
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5614
5674
|
/**
|
|
5615
|
-
* Favorites icon (*)
|
|
5675
|
+
* The Favorites icon (*) for Answers,
|
|
5676
|
+
* Liveboard, and data objects like Worksheet, Model,
|
|
5677
|
+
* Tables and Views.
|
|
5678
|
+
* Allows adding an object to the user’s favorites list.
|
|
5616
5679
|
* @example
|
|
5617
5680
|
* ```js
|
|
5618
5681
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -5630,7 +5693,9 @@ export enum Action {
|
|
|
5630
5693
|
*/
|
|
5631
5694
|
EditDetails = "editDetails",
|
|
5632
5695
|
/**
|
|
5633
|
-
* The Create alert action
|
|
5696
|
+
* The *Create alert* action for KPI charts.
|
|
5697
|
+
* Allows users to schedule threshold-based alerts
|
|
5698
|
+
* for KPI charts.
|
|
5634
5699
|
* @example
|
|
5635
5700
|
* ```js
|
|
5636
5701
|
* disabledActions: [Action.CreateMonitor]
|
|
@@ -5686,7 +5751,7 @@ export enum Action {
|
|
|
5686
5751
|
* ```js
|
|
5687
5752
|
* disabledActions: [Action.CrossFilter]
|
|
5688
5753
|
* ```
|
|
5689
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5754
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
|
|
5690
5755
|
*/
|
|
5691
5756
|
CrossFilter = "context-menu-item-cross-filter",
|
|
5692
5757
|
/**
|
|
@@ -5696,7 +5761,7 @@ export enum Action {
|
|
|
5696
5761
|
* ```js
|
|
5697
5762
|
* disabledActions: [Action.SyncToSlack]
|
|
5698
5763
|
* ```
|
|
5699
|
-
* @version @version SDK : 1.32.0 |
|
|
5764
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5700
5765
|
*/
|
|
5701
5766
|
SyncToSlack = "syncToSlack",
|
|
5702
5767
|
/**
|
|
@@ -5706,7 +5771,7 @@ export enum Action {
|
|
|
5706
5771
|
* ```js
|
|
5707
5772
|
* disabledActions: [Action.SyncToTeams]
|
|
5708
5773
|
* ```
|
|
5709
|
-
* @version @version SDK : 1.32.0 |
|
|
5774
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5710
5775
|
*/
|
|
5711
5776
|
SyncToTeams = "syncToTeams",
|
|
5712
5777
|
/**
|
|
@@ -5717,7 +5782,7 @@ export enum Action {
|
|
|
5717
5782
|
* ```js
|
|
5718
5783
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
5719
5784
|
* ```
|
|
5720
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5785
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5721
5786
|
*/
|
|
5722
5787
|
RemoveCrossFilter = "context-menu-item-remove-cross-filter",
|
|
5723
5788
|
/**
|
|
@@ -5728,7 +5793,7 @@ export enum Action {
|
|
|
5728
5793
|
* ```js
|
|
5729
5794
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
5730
5795
|
* ```
|
|
5731
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5796
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5732
5797
|
*/
|
|
5733
5798
|
AxisMenuAggregate = "axisMenuAggregate",
|
|
5734
5799
|
/**
|
|
@@ -5739,17 +5804,19 @@ export enum Action {
|
|
|
5739
5804
|
* ```js
|
|
5740
5805
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
5741
5806
|
* ```
|
|
5742
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5807
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5743
5808
|
*/
|
|
5744
5809
|
AxisMenuTimeBucket = "axisMenuTimeBucket",
|
|
5745
5810
|
/**
|
|
5746
5811
|
* The **Filter** action in the chart axis or table column
|
|
5747
5812
|
* customization menu.
|
|
5813
|
+
* Allows adding, editing, or removing filters.
|
|
5814
|
+
*
|
|
5748
5815
|
* @example
|
|
5749
5816
|
* ```js
|
|
5750
5817
|
* disabledActions: [Action.AxisMenuFilter]
|
|
5751
5818
|
* ```
|
|
5752
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5819
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5753
5820
|
*/
|
|
5754
5821
|
AxisMenuFilter = "axisMenuFilter",
|
|
5755
5822
|
/**
|
|
@@ -5760,7 +5827,7 @@ export enum Action {
|
|
|
5760
5827
|
* ```js
|
|
5761
5828
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
5762
5829
|
* ```
|
|
5763
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5830
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5764
5831
|
*/
|
|
5765
5832
|
AxisMenuConditionalFormat = "axisMenuConditionalFormat",
|
|
5766
5833
|
/**
|
|
@@ -5771,7 +5838,7 @@ export enum Action {
|
|
|
5771
5838
|
* ```js
|
|
5772
5839
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
5773
5840
|
* ```
|
|
5774
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5841
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5775
5842
|
*/
|
|
5776
5843
|
AxisMenuSort = "axisMenuSort",
|
|
5777
5844
|
/**
|
|
@@ -5783,7 +5850,7 @@ export enum Action {
|
|
|
5783
5850
|
* ```js
|
|
5784
5851
|
* disabledActions: [Action.AxisMenuGroup]
|
|
5785
5852
|
* ```
|
|
5786
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5853
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5787
5854
|
*/
|
|
5788
5855
|
AxisMenuGroup = "axisMenuGroup",
|
|
5789
5856
|
/**
|
|
@@ -5794,7 +5861,7 @@ export enum Action {
|
|
|
5794
5861
|
* ```js
|
|
5795
5862
|
* disabledActions: [Action.AxisMenuPosition]
|
|
5796
5863
|
* ```
|
|
5797
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5864
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5798
5865
|
*/
|
|
5799
5866
|
AxisMenuPosition = "axisMenuPosition",
|
|
5800
5867
|
/**
|
|
@@ -5804,7 +5871,7 @@ export enum Action {
|
|
|
5804
5871
|
* ```js
|
|
5805
5872
|
* disabledActions: [Action.AxisMenuRename]
|
|
5806
5873
|
* ```
|
|
5807
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5874
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5808
5875
|
*/
|
|
5809
5876
|
AxisMenuRename = "axisMenuRename",
|
|
5810
5877
|
/**
|
|
@@ -5815,7 +5882,7 @@ export enum Action {
|
|
|
5815
5882
|
* ```js
|
|
5816
5883
|
* disabledActions: [Action.AxisMenuEdit]
|
|
5817
5884
|
* ```
|
|
5818
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5885
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5819
5886
|
*/
|
|
5820
5887
|
AxisMenuEdit = "axisMenuEdit",
|
|
5821
5888
|
/**
|
|
@@ -5825,7 +5892,7 @@ export enum Action {
|
|
|
5825
5892
|
* ```js
|
|
5826
5893
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
5827
5894
|
* ```
|
|
5828
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5895
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5829
5896
|
*/
|
|
5830
5897
|
AxisMenuNumberFormat = "axisMenuNumberFormat",
|
|
5831
5898
|
/**
|
|
@@ -5835,7 +5902,7 @@ export enum Action {
|
|
|
5835
5902
|
* ```js
|
|
5836
5903
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
5837
5904
|
* ```
|
|
5838
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5905
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5839
5906
|
*/
|
|
5840
5907
|
AxisMenuTextWrapping = "axisMenuTextWrapping",
|
|
5841
5908
|
/**
|
|
@@ -5847,7 +5914,7 @@ export enum Action {
|
|
|
5847
5914
|
* ```js
|
|
5848
5915
|
* disabledActions: [Action.AxisMenuRemove]
|
|
5849
5916
|
* ```
|
|
5850
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5917
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
5851
5918
|
*/
|
|
5852
5919
|
AxisMenuRemove = "axisMenuRemove",
|
|
5853
5920
|
/**
|
|
@@ -5861,26 +5928,27 @@ export enum Action {
|
|
|
5861
5928
|
* ```js
|
|
5862
5929
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
5863
5930
|
* ```
|
|
5864
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
5931
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
|
|
5865
5932
|
*/
|
|
5866
5933
|
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
5867
5934
|
/**
|
|
5868
|
-
*
|
|
5935
|
+
* The *Request verification* action on a Liveboard.
|
|
5936
|
+
* Initiates a request for Liveboard verification.
|
|
5869
5937
|
* @example
|
|
5870
5938
|
* ```js
|
|
5871
5939
|
* disabledActions: [Action.RequestVerification]
|
|
5872
5940
|
* ```
|
|
5873
|
-
* @version SDK: 1.25.0 |
|
|
5941
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
5874
5942
|
*/
|
|
5875
5943
|
RequestVerification = "requestVerification",
|
|
5876
5944
|
/**
|
|
5877
5945
|
*
|
|
5878
|
-
*Allows users to mark a Liveboard as verified.
|
|
5946
|
+
* Allows users to mark a Liveboard as verified.
|
|
5879
5947
|
* @example
|
|
5880
5948
|
* ```js
|
|
5881
5949
|
* disabledActions: [Action.MarkAsVerified]
|
|
5882
5950
|
* ```
|
|
5883
|
-
* @version SDK: 1.25.0 |
|
|
5951
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
5884
5952
|
*/
|
|
5885
5953
|
MarkAsVerified = "markAsVerified",
|
|
5886
5954
|
/**
|
|
@@ -5890,7 +5958,7 @@ export enum Action {
|
|
|
5890
5958
|
* ```js
|
|
5891
5959
|
* disabledActions: [Action.AddTab]
|
|
5892
5960
|
* ```
|
|
5893
|
-
* @version SDK: 1.26.0 |
|
|
5961
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5894
5962
|
*/
|
|
5895
5963
|
AddTab = "addTab",
|
|
5896
5964
|
/**
|
|
@@ -5900,35 +5968,42 @@ export enum Action {
|
|
|
5900
5968
|
* ```js
|
|
5901
5969
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
5902
5970
|
* ```
|
|
5903
|
-
* @version SDK: 1.25.0 |
|
|
5971
|
+
* @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
|
|
5904
5972
|
*/
|
|
5905
5973
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
5906
5974
|
/**
|
|
5975
|
+
* Action ID to hide or disable Natural Language Search query.
|
|
5907
5976
|
*
|
|
5908
5977
|
* @example
|
|
5909
5978
|
* ```js
|
|
5910
5979
|
* disabledActions: [Action.ShowSageQuery]
|
|
5911
5980
|
* ```
|
|
5912
|
-
* @version SDK: 1.26.0 |
|
|
5981
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
5913
5982
|
*/
|
|
5914
5983
|
ShowSageQuery = "showSageQuery",
|
|
5915
5984
|
/**
|
|
5985
|
+
*
|
|
5986
|
+
* Action ID to hide or disable the edit option for the
|
|
5987
|
+
* results generated from the
|
|
5988
|
+
* Natural Language Search query.
|
|
5916
5989
|
*
|
|
5917
5990
|
* @example
|
|
5918
5991
|
* ```js
|
|
5919
5992
|
* disabledActions: [Action.EditSageAnswer]
|
|
5920
5993
|
* ```
|
|
5921
|
-
* @version SDK: 1.26.0 |
|
|
5994
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
5922
5995
|
*/
|
|
5923
5996
|
EditSageAnswer = "editSageAnswer",
|
|
5924
5997
|
/**
|
|
5998
|
+
* The feedback widget for AI-generated Answers.
|
|
5999
|
+
* Allows users to send feedback on the Answers generated
|
|
6000
|
+
* from a Natural Language Search query.
|
|
5925
6001
|
*
|
|
5926
|
-
*This action allows users to send feedback on AI-generated Answers.
|
|
5927
6002
|
* @example
|
|
5928
6003
|
* ```js
|
|
5929
6004
|
* disabledActions: [Action.SageAnswerFeedback]
|
|
5930
6005
|
* ```
|
|
5931
|
-
* @version SDK: 1.26.0 |
|
|
6006
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
5932
6007
|
*/
|
|
5933
6008
|
SageAnswerFeedback = "sageAnswerFeedback",
|
|
5934
6009
|
/**
|
|
@@ -5937,7 +6012,7 @@ export enum Action {
|
|
|
5937
6012
|
* ```js
|
|
5938
6013
|
* disabledActions: [Action.ModifySageAnswer]
|
|
5939
6014
|
* ```
|
|
5940
|
-
* @version SDK: 1.26.0 |
|
|
6015
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
5941
6016
|
*/
|
|
5942
6017
|
ModifySageAnswer = "modifySageAnswer",
|
|
5943
6018
|
/**
|
|
@@ -5950,7 +6025,10 @@ export enum Action {
|
|
|
5950
6025
|
*/
|
|
5951
6026
|
MoveToTab = "onContainerMove",
|
|
5952
6027
|
/**
|
|
5953
|
-
* The **Manage
|
|
6028
|
+
* The **Manage Alerts** menu action on KPI visualizations.
|
|
6029
|
+
* Allows creating, viewing, and editing monitor
|
|
6030
|
+
* alerts for a KPI chart.
|
|
6031
|
+
*
|
|
5954
6032
|
* @example
|
|
5955
6033
|
* ```js
|
|
5956
6034
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -5958,21 +6036,23 @@ export enum Action {
|
|
|
5958
6036
|
*/
|
|
5959
6037
|
ManageMonitor = "manageMonitor",
|
|
5960
6038
|
/**
|
|
5961
|
-
*
|
|
6039
|
+
* The Liveboard Personalised Views dropdown.
|
|
6040
|
+
* Allows navigating to a personalized Liveboard View.
|
|
5962
6041
|
* @example
|
|
5963
6042
|
* ```js
|
|
5964
6043
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
5965
6044
|
* ```
|
|
5966
|
-
* @version SDK : 1.26.0 |
|
|
6045
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
5967
6046
|
*/
|
|
5968
6047
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
5969
6048
|
/**
|
|
5970
|
-
* Action ID for
|
|
6049
|
+
* Action ID for show or hide the user details on a
|
|
6050
|
+
* Liveboard (Recently visited / social proof)
|
|
5971
6051
|
* @example
|
|
5972
6052
|
* ```js
|
|
5973
6053
|
* disabledActions: [Action.LiveboardUsers]
|
|
5974
6054
|
* ```
|
|
5975
|
-
* @version SDK : 1.26.0 |
|
|
6055
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
5976
6056
|
*/
|
|
5977
6057
|
LiveboardUsers = "liveboardUsers",
|
|
5978
6058
|
/**
|
|
@@ -5990,108 +6070,124 @@ export enum Action {
|
|
|
5990
6070
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
5991
6071
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
5992
6072
|
* ```
|
|
5993
|
-
* @version SDK : 1.28.3 |
|
|
6073
|
+
* @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
5994
6074
|
*/
|
|
5995
6075
|
TML = "tml",
|
|
5996
6076
|
/**
|
|
5997
|
-
*
|
|
5998
|
-
* and Pin modal
|
|
6077
|
+
* The **Create Liveboard* action on
|
|
6078
|
+
* the Liveboards page and the Pin modal.
|
|
6079
|
+
* Allows users to create a Liveboard.
|
|
6080
|
+
*
|
|
5999
6081
|
* @example
|
|
6000
6082
|
* ```js
|
|
6001
6083
|
* hiddenAction: [Action.CreateLiveboard]
|
|
6002
6084
|
* disabledActions: [Action.CreateLiveboard]
|
|
6003
6085
|
* ```
|
|
6004
|
-
* @version SDK: 1.32.0 |
|
|
6086
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
6005
6087
|
*/
|
|
6006
6088
|
CreateLiveboard = "createLiveboard",
|
|
6007
6089
|
/**
|
|
6008
|
-
* Action ID for to hide
|
|
6090
|
+
* Action ID for to hide or disable the
|
|
6091
|
+
* Verified Liveboard banner.
|
|
6009
6092
|
* @example
|
|
6010
6093
|
* ```js
|
|
6011
6094
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
6012
6095
|
* ```
|
|
6013
|
-
* @version SDK: 1.29.0 |
|
|
6096
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
6014
6097
|
*/
|
|
6015
6098
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
6016
6099
|
/**
|
|
6017
|
-
*
|
|
6100
|
+
* The *Ask Sage* action for Answers and visualizations.
|
|
6101
|
+
* Allows initiating a Natural Language Search query.
|
|
6102
|
+
*
|
|
6018
6103
|
* @example
|
|
6019
6104
|
* ```js
|
|
6020
6105
|
* hiddenAction: [Action.AskAi]
|
|
6021
6106
|
* ```
|
|
6022
|
-
* @version SDK: 1.29.0 |
|
|
6107
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
6023
6108
|
*/
|
|
6024
6109
|
AskAi = "AskAi",
|
|
6025
6110
|
/**
|
|
6026
6111
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
6112
|
+
* Adds a KPI chart to the watchlist on the Home page.
|
|
6027
6113
|
* @example
|
|
6028
6114
|
* ```js
|
|
6029
6115
|
* disabledActions: [Action.AddToWatchlist]
|
|
6030
6116
|
* ```
|
|
6031
|
-
* @version SDK : 1.27.9 |
|
|
6117
|
+
* @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6032
6118
|
*/
|
|
6033
6119
|
AddToWatchlist = "addToWatchlist",
|
|
6034
6120
|
/**
|
|
6035
6121
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
6122
|
+
* Removes a KPI chart from the watchlist on the Home page.
|
|
6036
6123
|
* @example
|
|
6037
6124
|
* ```js
|
|
6038
6125
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6039
6126
|
* ```
|
|
6040
|
-
* @version SDK : 1.27.9 |
|
|
6127
|
+
* @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6041
6128
|
*/
|
|
6042
6129
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6043
6130
|
/**
|
|
6044
|
-
* The **
|
|
6131
|
+
* The **Organize Favourites** action on Homepage
|
|
6132
|
+
* *Favorites* module.
|
|
6133
|
+
*
|
|
6045
6134
|
* @example
|
|
6046
6135
|
* ```js
|
|
6047
6136
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6048
6137
|
* ```
|
|
6049
|
-
* @version SDK : 1.32.0 |
|
|
6138
|
+
* @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6050
6139
|
*/
|
|
6051
6140
|
OrganiseFavourites = "organiseFavourites",
|
|
6052
6141
|
/**
|
|
6053
|
-
*
|
|
6142
|
+
* The **AI Highlights** action on a Liveboard.
|
|
6143
|
+
*
|
|
6054
6144
|
* @example
|
|
6055
6145
|
* ```js
|
|
6056
6146
|
* hiddenAction: [Action.AIHighlights]
|
|
6057
6147
|
* ```
|
|
6058
|
-
* @version SDK: 1.27.10 |
|
|
6148
|
+
* @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6059
6149
|
*/
|
|
6060
6150
|
AIHighlights = "AIHighlights",
|
|
6061
6151
|
/**
|
|
6062
|
-
*
|
|
6152
|
+
* The *Edit* action on the *Liveboard Schedules* page
|
|
6153
|
+
* (new Homepage experience).
|
|
6154
|
+
* Allows editing Liveboard schedules.
|
|
6155
|
+
*
|
|
6063
6156
|
* @example
|
|
6064
6157
|
* ```js
|
|
6065
6158
|
* disabledActions: [Action.EditScheduleHomepage]
|
|
6066
6159
|
* ```
|
|
6067
|
-
* @version SDK: 1.34.0 |
|
|
6160
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6068
6161
|
*/
|
|
6069
6162
|
EditScheduleHomepage = "editScheduleHomepage",
|
|
6070
6163
|
/**
|
|
6071
|
-
*
|
|
6164
|
+
* The *Pause* action on the *Liveboard Schedules* page
|
|
6165
|
+
* Pauses a scheduled Liveboard job.
|
|
6072
6166
|
* @example
|
|
6073
6167
|
* ```js
|
|
6074
6168
|
* disabledActions: [Action.PauseScheduleHomepage]
|
|
6075
6169
|
* ```
|
|
6076
|
-
* @version SDK: 1.34.0 |
|
|
6170
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6077
6171
|
*/
|
|
6078
6172
|
PauseScheduleHomepage = "pauseScheduleHomepage",
|
|
6079
6173
|
/**
|
|
6080
|
-
*
|
|
6174
|
+
* The **View run history** action **Liveboard Schedules** page.
|
|
6175
|
+
* Allows viewing schedule run history.
|
|
6081
6176
|
* @example
|
|
6082
6177
|
* ```js
|
|
6083
6178
|
* disabledActions: [Action.ViewScheduleRunHomepage]
|
|
6084
6179
|
* ```
|
|
6085
|
-
* @version SDK: 1.34.0 |
|
|
6180
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6086
6181
|
*/
|
|
6087
6182
|
ViewScheduleRunHomepage = "viewScheduleRunHomepage",
|
|
6088
6183
|
/**
|
|
6089
|
-
* Action ID
|
|
6184
|
+
* Action ID to hide or disable the
|
|
6185
|
+
* unsubscribe option for Liveboard schedules.
|
|
6090
6186
|
* @example
|
|
6091
6187
|
* ```js
|
|
6092
6188
|
* disabledActions: [Action.UnsubscribeScheduleHomepage]
|
|
6093
6189
|
* ```
|
|
6094
|
-
* @version SDK: 1.34.0 |
|
|
6190
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6095
6191
|
*/
|
|
6096
6192
|
UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
|
|
6097
6193
|
/**
|
|
@@ -6100,16 +6196,17 @@ export enum Action {
|
|
|
6100
6196
|
* ```js
|
|
6101
6197
|
* disabledActions: [Action.ManageTags]
|
|
6102
6198
|
* ```
|
|
6103
|
-
* @version SDK : 1.34.0 |
|
|
6199
|
+
* @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6104
6200
|
*/
|
|
6105
6201
|
ManageTags = "manageTags",
|
|
6106
6202
|
/**
|
|
6107
|
-
*
|
|
6203
|
+
* The **Delete** action on the **Liveboard Schedules* page.
|
|
6204
|
+
* Deletes a Liveboard schedule.
|
|
6108
6205
|
* @example
|
|
6109
6206
|
* ```js
|
|
6110
6207
|
* disabledActions: [Action.DeleteScheduleHomepage]
|
|
6111
6208
|
* ```
|
|
6112
|
-
* @version SDK: 1.34.0 |
|
|
6209
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6113
6210
|
*/
|
|
6114
6211
|
DeleteScheduleHomepage = "deleteScheduleHomepage",
|
|
6115
6212
|
/**
|
|
@@ -6118,7 +6215,7 @@ export enum Action {
|
|
|
6118
6215
|
* ```js
|
|
6119
6216
|
* disabledActions: [Action.KPIAnalysisCTA]
|
|
6120
6217
|
* ```
|
|
6121
|
-
* @version SDK: 1.34.0 |
|
|
6218
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6122
6219
|
*/
|
|
6123
6220
|
KPIAnalysisCTA = "kpiAnalysisCTA",
|
|
6124
6221
|
/**
|
|
@@ -6127,61 +6224,73 @@ export enum Action {
|
|
|
6127
6224
|
* ```js
|
|
6128
6225
|
* const disabledActions = [Action.DisableChipReorder]
|
|
6129
6226
|
* ```
|
|
6130
|
-
* @version SDK: 1.36.0 |
|
|
6227
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6131
6228
|
*/
|
|
6132
6229
|
DisableChipReorder = "disableChipReorder",
|
|
6133
6230
|
/**
|
|
6134
|
-
* Action ID
|
|
6231
|
+
* Action ID to show, hide, or disable filters
|
|
6232
|
+
* in a Liveboard tab.
|
|
6233
|
+
*
|
|
6135
6234
|
* @example
|
|
6136
6235
|
* ```js
|
|
6137
6236
|
* hiddenAction: [Action.ChangeFilterVisibilityInTab]
|
|
6138
6237
|
* ```
|
|
6139
|
-
* @version SDK: 1.36.0 |
|
|
6238
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6140
6239
|
*/
|
|
6141
6240
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
6142
6241
|
/**
|
|
6143
|
-
*
|
|
6242
|
+
* The **Preview data** button on the Spotter interface.
|
|
6243
|
+
* Allows previewing the data used for Spotter queries.
|
|
6244
|
+
*
|
|
6144
6245
|
* @example
|
|
6145
6246
|
* ```js
|
|
6146
6247
|
* hiddenAction: [Action.PreviewDataSpotter]
|
|
6147
6248
|
* ```
|
|
6148
|
-
* @version SDK: 1.36.0 |
|
|
6249
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6149
6250
|
*/
|
|
6150
6251
|
PreviewDataSpotter = "previewDataSpotter",
|
|
6151
6252
|
/**
|
|
6152
|
-
*
|
|
6253
|
+
* The **Reset** link on the Spotter interface.
|
|
6254
|
+
* Resets the conversation with Spotter.
|
|
6255
|
+
*
|
|
6153
6256
|
* @example
|
|
6154
6257
|
* ```js
|
|
6155
6258
|
* hiddenAction: [Action.ResetSpotterChat]
|
|
6156
6259
|
* ```
|
|
6157
|
-
* @version SDK: 1.36.0 |
|
|
6260
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6158
6261
|
*/
|
|
6159
6262
|
ResetSpotterChat = "resetSpotterChat",
|
|
6160
6263
|
/**
|
|
6161
|
-
* Action ID for hide
|
|
6264
|
+
* Action ID for hide or disable the
|
|
6265
|
+
* Spotter feedback widget.
|
|
6266
|
+
*
|
|
6162
6267
|
* @example
|
|
6163
6268
|
* ```js
|
|
6164
6269
|
* hiddenAction: [Action.SpotterFeedback]
|
|
6165
6270
|
* ```
|
|
6166
|
-
* @version SDK: 1.36.0 |
|
|
6271
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6167
6272
|
*/
|
|
6168
6273
|
SpotterFeedback = "spotterFeedback",
|
|
6169
6274
|
/**
|
|
6170
|
-
* Action ID for hide
|
|
6275
|
+
* Action ID for hide or disable
|
|
6276
|
+
* the previous prompt edit option in Spotter.
|
|
6277
|
+
*
|
|
6171
6278
|
* @example
|
|
6172
6279
|
* ```js
|
|
6173
6280
|
* hiddenAction: [Action.EditPreviousPrompt]
|
|
6174
6281
|
* ```
|
|
6175
|
-
* @version SDK: 1.36.0 |
|
|
6282
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6176
6283
|
*/
|
|
6177
6284
|
EditPreviousPrompt = "editPreviousPrompt",
|
|
6178
6285
|
/**
|
|
6179
|
-
* Action ID for hide
|
|
6286
|
+
* Action ID for hide or disable
|
|
6287
|
+
* the previous prompt deletion option in Spotter.
|
|
6288
|
+
*
|
|
6180
6289
|
* @example
|
|
6181
6290
|
* ```js
|
|
6182
6291
|
* hiddenAction: [Action.DeletePreviousPrompt]
|
|
6183
6292
|
* ```
|
|
6184
|
-
* @version SDK: 1.36.0 |
|
|
6293
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6185
6294
|
*/
|
|
6186
6295
|
DeletePreviousPrompt = "deletePreviousPrompt",
|
|
6187
6296
|
/**
|
|
@@ -6190,7 +6299,7 @@ export enum Action {
|
|
|
6190
6299
|
* ```js
|
|
6191
6300
|
* hiddenAction: [Action.EditTokens]
|
|
6192
6301
|
* ```
|
|
6193
|
-
* @version SDK: 1.36.0 |
|
|
6302
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6194
6303
|
*/
|
|
6195
6304
|
EditTokens = "editTokens"
|
|
6196
6305
|
}
|
|
@@ -6261,7 +6370,7 @@ export enum LogLevel {
|
|
|
6261
6370
|
* logLevel: LogLevel.SILENT,
|
|
6262
6371
|
* })
|
|
6263
6372
|
* ```
|
|
6264
|
-
* @version SDK: 1.26.7 |
|
|
6373
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6265
6374
|
*/
|
|
6266
6375
|
SILENT = "SILENT",
|
|
6267
6376
|
/**
|
|
@@ -6273,7 +6382,7 @@ export enum LogLevel {
|
|
|
6273
6382
|
* logLevel: LogLevel.ERROR,
|
|
6274
6383
|
* })
|
|
6275
6384
|
* ```
|
|
6276
|
-
* @version SDK: 1.26.7 |
|
|
6385
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6277
6386
|
*/
|
|
6278
6387
|
ERROR = "ERROR",
|
|
6279
6388
|
/**
|
|
@@ -6285,7 +6394,7 @@ export enum LogLevel {
|
|
|
6285
6394
|
* logLevel: LogLevel.WARN,
|
|
6286
6395
|
* })
|
|
6287
6396
|
* ```
|
|
6288
|
-
* @version SDK: 1.26.7 |
|
|
6397
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6289
6398
|
*/
|
|
6290
6399
|
WARN = "WARN",
|
|
6291
6400
|
/**
|
|
@@ -6297,7 +6406,7 @@ export enum LogLevel {
|
|
|
6297
6406
|
* logLevel: LogLevel.INFO,
|
|
6298
6407
|
* })
|
|
6299
6408
|
* ```
|
|
6300
|
-
* @version SDK: 1.26.7 |
|
|
6409
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6301
6410
|
*/
|
|
6302
6411
|
INFO = "INFO",
|
|
6303
6412
|
/**
|
|
@@ -6309,7 +6418,7 @@ export enum LogLevel {
|
|
|
6309
6418
|
* logLevel: LogLevel.DEBUG,
|
|
6310
6419
|
* })
|
|
6311
6420
|
* ```
|
|
6312
|
-
* @version SDK: 1.26.7 |
|
|
6421
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6313
6422
|
*/
|
|
6314
6423
|
DEBUG = "DEBUG",
|
|
6315
6424
|
/**
|
|
@@ -6321,7 +6430,7 @@ export enum LogLevel {
|
|
|
6321
6430
|
* logLevel: LogLevel.TRACE,
|
|
6322
6431
|
* })
|
|
6323
6432
|
* ```
|
|
6324
|
-
* @version SDK: 1.26.7 |
|
|
6433
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6325
6434
|
*/
|
|
6326
6435
|
TRACE = "TRACE"
|
|
6327
6436
|
}
|
|
@@ -7143,7 +7252,7 @@ export enum UIPassthroughEvent {
|
|
|
7143
7252
|
PinAnswerToLiveboard = "addVizToPinboard",
|
|
7144
7253
|
SaveAnswer = "saveAnswer",
|
|
7145
7254
|
GetDiscoverabilityStatus = "getDiscoverabilityStatus",
|
|
7146
|
-
GetAvailableUIPassthroughs = "
|
|
7255
|
+
GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
|
|
7147
7256
|
GetAnswerConfig = "getAnswerPageConfig",
|
|
7148
7257
|
GetLiveboardConfig = "getPinboardPageConfig"
|
|
7149
7258
|
}
|