@thoughtspot/visual-embed-sdk 1.35.10 → 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/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-DWOIXXJ1.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/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/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/types.ts +253 -161
|
@@ -1057,8 +1057,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1057
1057
|
*/
|
|
1058
1058
|
enableSearchAssist?: boolean;
|
|
1059
1059
|
/**
|
|
1060
|
-
* If set to true, the
|
|
1061
|
-
* according to the height of the
|
|
1060
|
+
* If set to true, the Liveboard container dynamically resizes
|
|
1061
|
+
* according to the height of the Liveboard.
|
|
1062
|
+
*
|
|
1063
|
+
* **Note**: Using fullHeight loads all visualizations
|
|
1064
|
+
* on the Liveboard simultaneously, which results in
|
|
1065
|
+
* multiple warehouse queries and potentially a
|
|
1066
|
+
* longer wait for the topmost visualizations to
|
|
1067
|
+
* display on the screen. Setting fullHeight to
|
|
1068
|
+
* `false` fetches visualizations incrementally as
|
|
1069
|
+
* users scroll the page to view the charts and tables.
|
|
1070
|
+
*
|
|
1062
1071
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
1063
1072
|
* @example
|
|
1064
1073
|
* ```js
|
|
@@ -1320,12 +1329,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1320
1329
|
/**
|
|
1321
1330
|
* If set to true, the embedded object container dynamically resizes
|
|
1322
1331
|
* according to the height of the Liveboard.
|
|
1332
|
+
*
|
|
1323
1333
|
* **Note**: Using fullHeight loads all visualizations on the
|
|
1324
1334
|
* Liveboard simultaneously, which results in multiple warehouse
|
|
1325
1335
|
* queries and potentially a longer wait for the topmost
|
|
1326
1336
|
* visualizations to display on the screen.
|
|
1327
1337
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
1328
1338
|
* incrementally as users scroll the page to view the charts and tables.
|
|
1339
|
+
*
|
|
1329
1340
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
1330
1341
|
* @example
|
|
1331
1342
|
* ```js
|
|
@@ -2217,7 +2228,7 @@ export declare function resetCachedSessionInfo(): void;
|
|
|
2217
2228
|
*/
|
|
2218
2229
|
export declare enum AuthType {
|
|
2219
2230
|
/**
|
|
2220
|
-
* No authentication on the SDK.
|
|
2231
|
+
* No authentication on the SDK. Pass-through to the embedded App. Alias for
|
|
2221
2232
|
* `Passthrough`.
|
|
2222
2233
|
* @example
|
|
2223
2234
|
* ```js
|
|
@@ -2414,8 +2425,8 @@ export interface customCssInterface {
|
|
|
2414
2425
|
/**
|
|
2415
2426
|
* The custom css variables, which can be set.
|
|
2416
2427
|
* The allowed list is in the CustomCssVariables
|
|
2417
|
-
* interface.
|
|
2418
|
-
*
|
|
2428
|
+
* interface. For more information, see
|
|
2429
|
+
* link:https://developers.thoughtspot.com/docs/css-variables-reference
|
|
2419
2430
|
*/
|
|
2420
2431
|
variables?: CustomCssVariables;
|
|
2421
2432
|
/**
|
|
@@ -2457,7 +2468,7 @@ export interface CustomStyles {
|
|
|
2457
2468
|
}
|
|
2458
2469
|
/**
|
|
2459
2470
|
* Configuration to define the customization on the Embedded
|
|
2460
|
-
*
|
|
2471
|
+
* ThoughtSpot components.
|
|
2461
2472
|
* You can customize styles, text strings, and icons.
|
|
2462
2473
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
2463
2474
|
* @example
|
|
@@ -2577,7 +2588,7 @@ export interface EmbedConfig {
|
|
|
2577
2588
|
/**
|
|
2578
2589
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
2579
2590
|
* should be encoded in base64. This provides additional security to
|
|
2580
|
-
*
|
|
2591
|
+
* ThoughtSpot clusters against cross-site scripting attacks.
|
|
2581
2592
|
* @default false
|
|
2582
2593
|
*/
|
|
2583
2594
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -2730,18 +2741,18 @@ export interface EmbedConfig {
|
|
|
2730
2741
|
*/
|
|
2731
2742
|
disableSDKTracking?: boolean;
|
|
2732
2743
|
/**
|
|
2733
|
-
* Overrides default/user
|
|
2734
|
-
* @version SDK: 1.28.4 |
|
|
2744
|
+
* Overrides default/user preferred locale for date formatting
|
|
2745
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2735
2746
|
*/
|
|
2736
2747
|
dateFormatLocale?: string;
|
|
2737
2748
|
/**
|
|
2738
|
-
* Overrides default/user
|
|
2739
|
-
* @version SDK: 1.28.4 |
|
|
2749
|
+
* Overrides default/user preferred locale for number formatting
|
|
2750
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2740
2751
|
*/
|
|
2741
2752
|
numberFormatLocale?: string;
|
|
2742
2753
|
/**
|
|
2743
2754
|
* Format to be used for currency when currency format is set to infer from browser
|
|
2744
|
-
* @version SDK: 1.28.4 |
|
|
2755
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
2745
2756
|
*/
|
|
2746
2757
|
currencyFormat?: string;
|
|
2747
2758
|
/**
|
|
@@ -2755,12 +2766,12 @@ export interface EmbedConfig {
|
|
|
2755
2766
|
* disableTokenVerification : true
|
|
2756
2767
|
* })
|
|
2757
2768
|
* ```
|
|
2758
|
-
* @version SDK: 1.28.5 |
|
|
2769
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
2759
2770
|
*/
|
|
2760
2771
|
disableTokenVerification?: boolean;
|
|
2761
2772
|
/**
|
|
2762
2773
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
2763
|
-
* @version SDK 1.32.3 |
|
|
2774
|
+
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
2764
2775
|
*/
|
|
2765
2776
|
disableLoginFailurePage?: boolean;
|
|
2766
2777
|
/**
|
|
@@ -2798,7 +2809,7 @@ export interface EmbedConfig {
|
|
|
2798
2809
|
* }
|
|
2799
2810
|
* });
|
|
2800
2811
|
* ```
|
|
2801
|
-
* @version SDK 1.37.0 |
|
|
2812
|
+
* @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
|
|
2802
2813
|
*/
|
|
2803
2814
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
2804
2815
|
}
|
|
@@ -2957,7 +2968,7 @@ export interface ViewConfig {
|
|
|
2957
2968
|
/**
|
|
2958
2969
|
* The list of parameter override to apply to a search answer,
|
|
2959
2970
|
* visualization, or Liveboard.
|
|
2960
|
-
* @version SDK : 1.25.0 |
|
|
2971
|
+
* @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2961
2972
|
* @example
|
|
2962
2973
|
* ```js
|
|
2963
2974
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -3017,7 +3028,7 @@ export interface ViewConfig {
|
|
|
3017
3028
|
/**
|
|
3018
3029
|
* Insert as a sibling of the target container, instead of appending to a
|
|
3019
3030
|
* child inside it.
|
|
3020
|
-
* @version SDK: 1.2.0 |
|
|
3031
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
3021
3032
|
* @example
|
|
3022
3033
|
* ```js
|
|
3023
3034
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -3090,7 +3101,7 @@ export interface ViewConfig {
|
|
|
3090
3101
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
3091
3102
|
* });
|
|
3092
3103
|
* ```
|
|
3093
|
-
* @version SDK: 1.26.0 |
|
|
3104
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
3094
3105
|
*/
|
|
3095
3106
|
hiddenTabs?: string[];
|
|
3096
3107
|
/**
|
|
@@ -3100,7 +3111,7 @@ export interface ViewConfig {
|
|
|
3100
3111
|
* **Note**: This option does not apply to the classic homepage.
|
|
3101
3112
|
* To access the updated modular homepage, set
|
|
3102
3113
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3103
|
-
* @version SDK: 1.28.0 |
|
|
3114
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3104
3115
|
* @example
|
|
3105
3116
|
* ```js
|
|
3106
3117
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -3117,7 +3128,7 @@ export interface ViewConfig {
|
|
|
3117
3128
|
* **Note**: This option does not apply to the classic homepage.
|
|
3118
3129
|
* To access the updated modular homepage, set
|
|
3119
3130
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3120
|
-
* @version SDK: 1.28.0|
|
|
3131
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3121
3132
|
* @example
|
|
3122
3133
|
* ```js
|
|
3123
3134
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -3132,7 +3143,7 @@ export interface ViewConfig {
|
|
|
3132
3143
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
3133
3144
|
*
|
|
3134
3145
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
3135
|
-
* @version SDK: 1.26.0 |
|
|
3146
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
3136
3147
|
* @example
|
|
3137
3148
|
* ```js
|
|
3138
3149
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -3160,7 +3171,7 @@ export interface ViewConfig {
|
|
|
3160
3171
|
* **Note**: This option does not apply to the classic homepage.
|
|
3161
3172
|
* To access the updated modular homepage, set
|
|
3162
3173
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3163
|
-
* @version SDK: 1.28.0 |
|
|
3174
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3164
3175
|
*/
|
|
3165
3176
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
3166
3177
|
/**
|
|
@@ -3175,7 +3186,7 @@ export interface ViewConfig {
|
|
|
3175
3186
|
* });
|
|
3176
3187
|
* embed.showPreRender();
|
|
3177
3188
|
* ```
|
|
3178
|
-
* @version SDK: 1.25.0 |
|
|
3189
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
3179
3190
|
*/
|
|
3180
3191
|
preRenderId?: string;
|
|
3181
3192
|
/**
|
|
@@ -3229,7 +3240,7 @@ export interface ViewConfig {
|
|
|
3229
3240
|
/**
|
|
3230
3241
|
* To set the initial state of the search bar in case of saved Answers.
|
|
3231
3242
|
* @default true
|
|
3232
|
-
* @version SDK: 1.34.0 |
|
|
3243
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
3233
3244
|
* @example
|
|
3234
3245
|
* ```js
|
|
3235
3246
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -3253,7 +3264,7 @@ export interface ViewConfig {
|
|
|
3253
3264
|
/**
|
|
3254
3265
|
* Flag to control Data panel experience
|
|
3255
3266
|
* @default false
|
|
3256
|
-
* @version SDK: 1.34.0 |
|
|
3267
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
3257
3268
|
* @example
|
|
3258
3269
|
* ```js
|
|
3259
3270
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -3265,7 +3276,7 @@ export interface ViewConfig {
|
|
|
3265
3276
|
dataPanelV2?: boolean;
|
|
3266
3277
|
/**
|
|
3267
3278
|
* To enable custom column groups in data panel v2
|
|
3268
|
-
* @version SDK: 1.32.0 |
|
|
3279
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
3269
3280
|
* @default false
|
|
3270
3281
|
* @example
|
|
3271
3282
|
* ```js
|
|
@@ -3295,7 +3306,7 @@ export interface ViewConfig {
|
|
|
3295
3306
|
/**
|
|
3296
3307
|
* Flag to control new flip tooltip context menu experience
|
|
3297
3308
|
* @default false
|
|
3298
|
-
* @version SDK: 1.36.0 |
|
|
3309
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
3299
3310
|
*/
|
|
3300
3311
|
enableFlipTooltipToContextMenu?: boolean;
|
|
3301
3312
|
}
|
|
@@ -3415,7 +3426,7 @@ export declare enum RuntimeFilterOp {
|
|
|
3415
3426
|
* **Note**: This option does not apply to the classic homepage.
|
|
3416
3427
|
* To access the updated modular homepage, set
|
|
3417
3428
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3418
|
-
* @version SDK: 1.28.0 |
|
|
3429
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3419
3430
|
*/
|
|
3420
3431
|
export declare enum HomepageModule {
|
|
3421
3432
|
/**
|
|
@@ -4258,7 +4269,7 @@ export declare enum EmbedEvent {
|
|
|
4258
4269
|
*/
|
|
4259
4270
|
Explore = "explore",
|
|
4260
4271
|
/**
|
|
4261
|
-
* Emitted when a user clicks **Copy link** action on a visualization
|
|
4272
|
+
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
4262
4273
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4263
4274
|
* @example
|
|
4264
4275
|
*```js
|
|
@@ -4308,23 +4319,26 @@ export declare enum EmbedEvent {
|
|
|
4308
4319
|
*/
|
|
4309
4320
|
FilterChanged = "filterChanged",
|
|
4310
4321
|
/**
|
|
4311
|
-
* Emitted when a user clicks the **Go** button
|
|
4312
|
-
*
|
|
4322
|
+
* Emitted when a user clicks the **Go** button to initiate
|
|
4323
|
+
* a Natural Language Search query
|
|
4324
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4313
4325
|
*/
|
|
4314
4326
|
SageEmbedQuery = "sageEmbedQuery",
|
|
4315
4327
|
/**
|
|
4316
|
-
* Emitted when a user selects a data source on the
|
|
4317
|
-
*
|
|
4328
|
+
* Emitted when a user selects a data source on the embedded
|
|
4329
|
+
* Natural Language Search interface.
|
|
4330
|
+
*
|
|
4331
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4318
4332
|
*/
|
|
4319
4333
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
4320
4334
|
/**
|
|
4321
4335
|
* Emitted when a user updates a connection on the **Data** page
|
|
4322
|
-
* @version SDK : 1.27.0 |
|
|
4336
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
4323
4337
|
*/
|
|
4324
4338
|
UpdateConnection = "updateConnection",
|
|
4325
4339
|
/**
|
|
4326
4340
|
* Emitted when a user updates a connection on the **Data** page
|
|
4327
|
-
* @version SDK : 1.27.0 |
|
|
4341
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
4328
4342
|
*/
|
|
4329
4343
|
CreateConnection = "createConnection",
|
|
4330
4344
|
/**
|
|
@@ -4334,7 +4348,7 @@ export declare enum EmbedEvent {
|
|
|
4334
4348
|
* @returns viewId: string
|
|
4335
4349
|
* @returns liveboardId: string
|
|
4336
4350
|
* @returns isPublic: boolean
|
|
4337
|
-
* @version SDK : 1.26.0 |
|
|
4351
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4338
4352
|
*/
|
|
4339
4353
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
4340
4354
|
/**
|
|
@@ -4343,7 +4357,7 @@ export declare enum EmbedEvent {
|
|
|
4343
4357
|
* @returns viewId: string
|
|
4344
4358
|
* @returns liveboardId: string
|
|
4345
4359
|
* @returns isPublic: boolean
|
|
4346
|
-
* @version SDK : 1.26.0 |
|
|
4360
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4347
4361
|
*/
|
|
4348
4362
|
SavePersonalisedView = "savePersonalisedView",
|
|
4349
4363
|
/**
|
|
@@ -4352,28 +4366,28 @@ export declare enum EmbedEvent {
|
|
|
4352
4366
|
* @returns viewId: string
|
|
4353
4367
|
* @returns liveboardId: string
|
|
4354
4368
|
* @returns isPublic: boolean
|
|
4355
|
-
* @version SDK : 1.26.0 |
|
|
4369
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4356
4370
|
*/
|
|
4357
4371
|
ResetLiveboard = "resetLiveboard",
|
|
4358
4372
|
/**
|
|
4359
4373
|
* Emitted when a PersonalisedView is deleted.
|
|
4360
4374
|
* @returns views: string[]
|
|
4361
4375
|
* @returns liveboardId: string
|
|
4362
|
-
* @version SDK : 1.26.0 |
|
|
4376
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4363
4377
|
*/
|
|
4364
4378
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
4365
4379
|
/**
|
|
4366
4380
|
* Emitted when a user creates a new worksheet
|
|
4367
|
-
* @version SDK : 1.27.0 |
|
|
4381
|
+
* @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
4368
4382
|
*/
|
|
4369
4383
|
CreateWorksheet = "createWorksheet",
|
|
4370
4384
|
/**
|
|
4371
|
-
* Emitted when Ask Sage is initialized.
|
|
4385
|
+
* Emitted when the *Ask Sage* is initialized.
|
|
4372
4386
|
* @returns viewName: string
|
|
4373
4387
|
* @returns viewId: string
|
|
4374
4388
|
* @returns liveboardId: string
|
|
4375
4389
|
* @returns isPublic: boolean
|
|
4376
|
-
* @version SDK : 1.29.0 |
|
|
4390
|
+
* @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
4377
4391
|
*/
|
|
4378
4392
|
AskSageInit = "AskSageInit",
|
|
4379
4393
|
/**
|
|
@@ -4401,7 +4415,7 @@ export declare enum EmbedEvent {
|
|
|
4401
4415
|
*
|
|
4402
4416
|
* error: Developers can customize the error message text when `execute`
|
|
4403
4417
|
* returns `false` using the error parameter in responder.
|
|
4404
|
-
* @version SDK : 1.29.0 |
|
|
4418
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
4405
4419
|
* @example
|
|
4406
4420
|
*```js
|
|
4407
4421
|
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
@@ -4449,7 +4463,7 @@ export declare enum EmbedEvent {
|
|
|
4449
4463
|
* console.log('payload', payload);
|
|
4450
4464
|
* })
|
|
4451
4465
|
*```
|
|
4452
|
-
* @version SDK : 1.29.0 |
|
|
4466
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
4453
4467
|
*/
|
|
4454
4468
|
ParameterChanged = "parameterChanged"
|
|
4455
4469
|
}
|
|
@@ -4596,7 +4610,7 @@ export declare enum HostEvent {
|
|
|
4596
4610
|
* const url = embed.trigger(HostEvent.GetIframeUrl);
|
|
4597
4611
|
* console.log("iFrameURL",url);
|
|
4598
4612
|
* ```
|
|
4599
|
-
* @version SDK: 1.35.0 |
|
|
4613
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
4600
4614
|
*/
|
|
4601
4615
|
GetIframeUrl = "GetIframeUrl",
|
|
4602
4616
|
/**
|
|
@@ -4629,6 +4643,11 @@ export declare enum HostEvent {
|
|
|
4629
4643
|
* attributes passed with this event are appended to the existing runtime
|
|
4630
4644
|
* filters applied on a Liveboard.
|
|
4631
4645
|
*
|
|
4646
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
|
|
4647
|
+
* and `AppEmbed` only. In full application embedding, this event updates
|
|
4648
|
+
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
4649
|
+
*
|
|
4650
|
+
*
|
|
4632
4651
|
* Pass an array of runtime filters with the following attributes:
|
|
4633
4652
|
*
|
|
4634
4653
|
* `columnName` - _String_. The name of the column to filter on.
|
|
@@ -4639,9 +4658,12 @@ export declare enum HostEvent {
|
|
|
4639
4658
|
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
4640
4659
|
* single value, whereas BW and IN accept multiple values.
|
|
4641
4660
|
*
|
|
4642
|
-
* **Note**:
|
|
4643
|
-
*
|
|
4644
|
-
*
|
|
4661
|
+
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
4662
|
+
* object to its original state and applies new filter conditions.
|
|
4663
|
+
* Any user changes (like drilling into a visualization)
|
|
4664
|
+
* will be cleared, restoring the original visualization
|
|
4665
|
+
* with the updated filters.
|
|
4666
|
+
*
|
|
4645
4667
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
4646
4668
|
* @example
|
|
4647
4669
|
* ```js
|
|
@@ -4656,7 +4678,7 @@ export declare enum HostEvent {
|
|
|
4656
4678
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
4657
4679
|
/**
|
|
4658
4680
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4659
|
-
* This is the same as calling `appEmbed.navigateToPage(path, true)
|
|
4681
|
+
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
4660
4682
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
4661
4683
|
* be a number; for example, `1`, `-1`.
|
|
4662
4684
|
* @example
|
|
@@ -4951,7 +4973,9 @@ export declare enum HostEvent {
|
|
|
4951
4973
|
*/
|
|
4952
4974
|
GetTML = "getTML",
|
|
4953
4975
|
/**
|
|
4954
|
-
* Trigger the **Show underlying data** action on
|
|
4976
|
+
* Trigger the **Show underlying data** action on a
|
|
4977
|
+
* chart or table.
|
|
4978
|
+
*
|
|
4955
4979
|
* @param - an object with vizId as a key
|
|
4956
4980
|
* @example
|
|
4957
4981
|
* ```js
|
|
@@ -4985,8 +5009,8 @@ export declare enum HostEvent {
|
|
|
4985
5009
|
*/
|
|
4986
5010
|
Delete = "onDeleteAnswer",
|
|
4987
5011
|
/**
|
|
4988
|
-
* Trigger the **SpotIQ analyze** action on
|
|
4989
|
-
* or
|
|
5012
|
+
* Trigger the **SpotIQ analyze** action on a
|
|
5013
|
+
* chart or table.
|
|
4990
5014
|
* @param - Liveboard embed takes `vizId` as a
|
|
4991
5015
|
* key. Can be left undefined when embedding Search or
|
|
4992
5016
|
* visualization.
|
|
@@ -5259,7 +5283,7 @@ export declare enum HostEvent {
|
|
|
5259
5283
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
5260
5284
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
5261
5285
|
* ```
|
|
5262
|
-
* @version SDK: 1.26.0 |
|
|
5286
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5263
5287
|
*/
|
|
5264
5288
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
5265
5289
|
/**
|
|
@@ -5272,7 +5296,7 @@ export declare enum HostEvent {
|
|
|
5272
5296
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
5273
5297
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
5274
5298
|
* ```
|
|
5275
|
-
* @version SDK: 1.26.0 |
|
|
5299
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5276
5300
|
*/
|
|
5277
5301
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
5278
5302
|
/**
|
|
@@ -5286,7 +5310,7 @@ export declare enum HostEvent {
|
|
|
5286
5310
|
* executeSearch: true,
|
|
5287
5311
|
* })
|
|
5288
5312
|
* ```
|
|
5289
|
-
* @version SDK: 1.26.0 |
|
|
5313
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
5290
5314
|
*/
|
|
5291
5315
|
UpdateSageQuery = "updateSageQuery",
|
|
5292
5316
|
/**
|
|
@@ -5303,21 +5327,22 @@ export declare enum HostEvent {
|
|
|
5303
5327
|
* ```js
|
|
5304
5328
|
* const {session} = await embed.trigger( HostEvent.GetAnswerSession )
|
|
5305
5329
|
* ```
|
|
5306
|
-
* @version SDK: 1.26.0 |
|
|
5330
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
5307
5331
|
*/
|
|
5308
5332
|
GetAnswerSession = "getAnswerSession",
|
|
5309
5333
|
/**
|
|
5310
|
-
* Trigger Ask Sage for
|
|
5334
|
+
* Trigger the *Ask Sage* action for visualizations
|
|
5311
5335
|
* @example
|
|
5312
5336
|
* ```js
|
|
5313
5337
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
5314
5338
|
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
5315
5339
|
* ```
|
|
5316
|
-
* @version SDK: 1.29.0 |
|
|
5340
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
5317
5341
|
*/
|
|
5318
5342
|
AskSage = "AskSage",
|
|
5319
5343
|
/**
|
|
5320
|
-
* Trigger cross filter update action on a Liveboard
|
|
5344
|
+
* Trigger cross filter update action on a Liveboard.
|
|
5345
|
+
*
|
|
5321
5346
|
* @example
|
|
5322
5347
|
* ```js
|
|
5323
5348
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -5328,7 +5353,7 @@ export declare enum HostEvent {
|
|
|
5328
5353
|
* ],
|
|
5329
5354
|
* });
|
|
5330
5355
|
* ```
|
|
5331
|
-
* @version SDK: 1.29.0 |
|
|
5356
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
|
|
5332
5357
|
*/
|
|
5333
5358
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
5334
5359
|
/**
|
|
@@ -5337,11 +5362,13 @@ export declare enum HostEvent {
|
|
|
5337
5362
|
* ```js
|
|
5338
5363
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
5339
5364
|
* ```
|
|
5340
|
-
* @version SDK: 1.29.0 |
|
|
5365
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
|
|
5341
5366
|
*/
|
|
5342
5367
|
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
5343
5368
|
/**
|
|
5344
|
-
* Triggers an
|
|
5369
|
+
* Triggers an action to update Parameter values on embedded
|
|
5370
|
+
* Answers and Liveboard.
|
|
5371
|
+
*
|
|
5345
5372
|
* @example
|
|
5346
5373
|
* ```js
|
|
5347
5374
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -5349,30 +5376,30 @@ export declare enum HostEvent {
|
|
|
5349
5376
|
* value: "almond"
|
|
5350
5377
|
* }])
|
|
5351
5378
|
*
|
|
5352
|
-
* @version SDK: 1.29.0 |
|
|
5379
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
5353
5380
|
*/
|
|
5354
5381
|
UpdateParameters = "UpdateParameters",
|
|
5355
5382
|
/**
|
|
5356
|
-
* Triggers GetParameters to fetch the runtime
|
|
5383
|
+
* Triggers GetParameters to fetch the runtime Parameters.
|
|
5357
5384
|
* ```js
|
|
5358
5385
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
5359
5386
|
* console.log('parameters', parameter);
|
|
5360
5387
|
* });
|
|
5361
5388
|
*```
|
|
5362
|
-
* @version SDK: 1.29.0 |
|
|
5389
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
5363
5390
|
*/
|
|
5364
5391
|
GetParameters = "GetParameters",
|
|
5365
5392
|
/**
|
|
5366
|
-
* Triggers an event to update a
|
|
5393
|
+
* Triggers an event to update a personalized view of a Liveboard.
|
|
5367
5394
|
* ```js
|
|
5368
5395
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
5369
5396
|
* ```
|
|
5370
|
-
* @version SDK: 1.36.0 |
|
|
5397
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5371
5398
|
*/
|
|
5372
5399
|
UpdatePersonalisedView = "UpdatePersonalisedView",
|
|
5373
5400
|
/**
|
|
5374
|
-
* Triggers the action to get the current view of the
|
|
5375
|
-
* @version SDK: 1.36.0 |
|
|
5401
|
+
* Triggers the action to get the current view of the Liveboard.
|
|
5402
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5376
5403
|
*/
|
|
5377
5404
|
SaveAnswer = "saveAnswer",
|
|
5378
5405
|
/**
|
|
@@ -5592,7 +5619,8 @@ export declare enum Action {
|
|
|
5592
5619
|
ResetLayout = "resetLayout",
|
|
5593
5620
|
/**
|
|
5594
5621
|
* The **Schedule** menu action on a Liveboard.
|
|
5595
|
-
* Allows scheduling a Liveboard
|
|
5622
|
+
* Allows scheduling a Liveboard job, for example,
|
|
5623
|
+
* sending periodic notifications.
|
|
5596
5624
|
* @example
|
|
5597
5625
|
* ```js
|
|
5598
5626
|
* disabledActions: [Action.Schedule]
|
|
@@ -5634,7 +5662,7 @@ export declare enum Action {
|
|
|
5634
5662
|
* ```js
|
|
5635
5663
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
5636
5664
|
* ```
|
|
5637
|
-
* @version SDK: 1.32.0 |
|
|
5665
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5638
5666
|
*/
|
|
5639
5667
|
AddDataPanelObjects = "addDataPanelObjects",
|
|
5640
5668
|
/**
|
|
@@ -5647,7 +5675,28 @@ export declare enum Action {
|
|
|
5647
5675
|
* ```
|
|
5648
5676
|
*/
|
|
5649
5677
|
ConfigureFilter = "configureFilter",
|
|
5678
|
+
/**
|
|
5679
|
+
* The **Collapse data sources** icon on the Search page.
|
|
5680
|
+
* Collapses the panel showing data sources.
|
|
5681
|
+
*
|
|
5682
|
+
* @example
|
|
5683
|
+
* ```js
|
|
5684
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
5685
|
+
* ```
|
|
5686
|
+
* @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5687
|
+
*/
|
|
5650
5688
|
CollapseDataSources = "collapseDataSources",
|
|
5689
|
+
/**
|
|
5690
|
+
* The **Collapse data panel** icon on the Search page.
|
|
5691
|
+
* Collapses the data panel view.
|
|
5692
|
+
*
|
|
5693
|
+
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
|
|
5694
|
+
*
|
|
5695
|
+
* @example
|
|
5696
|
+
* ```js
|
|
5697
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
5698
|
+
* ```
|
|
5699
|
+
*/
|
|
5651
5700
|
CollapseDataPanel = "collapseDataPanel",
|
|
5652
5701
|
/**
|
|
5653
5702
|
* The **Choose sources** button on Search page.
|
|
@@ -5683,7 +5732,7 @@ export declare enum Action {
|
|
|
5683
5732
|
* ```js
|
|
5684
5733
|
* disabledActions: [Action.AddColumnSet]
|
|
5685
5734
|
* ```
|
|
5686
|
-
* @version SDK: 1.32.0 |
|
|
5735
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5687
5736
|
*/
|
|
5688
5737
|
AddColumnSet = "addSimpleCohort",
|
|
5689
5738
|
/**
|
|
@@ -5693,7 +5742,7 @@ export declare enum Action {
|
|
|
5693
5742
|
* ```js
|
|
5694
5743
|
* disabledActions: [Action.AddQuerySet]
|
|
5695
5744
|
* ```
|
|
5696
|
-
* @version SDK: 1.32.0 |
|
|
5745
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
5697
5746
|
*/
|
|
5698
5747
|
AddQuerySet = "addAdvancedCohort",
|
|
5699
5748
|
/**
|
|
@@ -5725,6 +5774,8 @@ export declare enum Action {
|
|
|
5725
5774
|
/**
|
|
5726
5775
|
* The **Show underlying data** menu action on a visualization or
|
|
5727
5776
|
* Answer page.
|
|
5777
|
+
* Displays detailed information and raw data
|
|
5778
|
+
* for a given visualization.
|
|
5728
5779
|
* @example
|
|
5729
5780
|
* ```js
|
|
5730
5781
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -5926,6 +5977,7 @@ export declare enum Action {
|
|
|
5926
5977
|
AnalysisInfo = "analysisInfo",
|
|
5927
5978
|
/**
|
|
5928
5979
|
* The **Schedule** menu action on a Liveboard.
|
|
5980
|
+
* Allows scheduling a Liveboard job.
|
|
5929
5981
|
* @example
|
|
5930
5982
|
* ```js
|
|
5931
5983
|
* disabledActions: [Action.Subscription]
|
|
@@ -5995,8 +6047,13 @@ export declare enum Action {
|
|
|
5995
6047
|
*/
|
|
5996
6048
|
RequestAccess = "requestAccess",
|
|
5997
6049
|
/**
|
|
5998
|
-
* The **Query visualizer** and **Query SQL** buttons in
|
|
5999
|
-
* of the Answer page
|
|
6050
|
+
* The **Query visualizer** and **Query SQL** buttons in
|
|
6051
|
+
* Query details panel of the Answer page.
|
|
6052
|
+
*
|
|
6053
|
+
* **Query visualizer** - Displays the tables
|
|
6054
|
+
* and filters used in a search query.
|
|
6055
|
+
* **Query SQL** - Displays the SQL statements used
|
|
6056
|
+
* in a search query to fetch data.
|
|
6000
6057
|
* @example
|
|
6001
6058
|
* ```js
|
|
6002
6059
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -6014,7 +6071,10 @@ export declare enum Action {
|
|
|
6014
6071
|
*/
|
|
6015
6072
|
AnswerDelete = "onDeleteAnswer",
|
|
6016
6073
|
/**
|
|
6017
|
-
* The
|
|
6074
|
+
* The chart switcher icon on Answer page and
|
|
6075
|
+
* visualizations in edit mode.
|
|
6076
|
+
* Allows switching to the table or chart mode
|
|
6077
|
+
* when editing a visualization.
|
|
6018
6078
|
* @example
|
|
6019
6079
|
* ```js
|
|
6020
6080
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -6023,7 +6083,10 @@ export declare enum Action {
|
|
|
6023
6083
|
*/
|
|
6024
6084
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
6025
6085
|
/**
|
|
6026
|
-
* Favorites icon (*)
|
|
6086
|
+
* The Favorites icon (*) for Answers,
|
|
6087
|
+
* Liveboard, and data objects like Worksheet, Model,
|
|
6088
|
+
* Tables and Views.
|
|
6089
|
+
* Allows adding an object to the user’s favorites list.
|
|
6027
6090
|
* @example
|
|
6028
6091
|
* ```js
|
|
6029
6092
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -6041,7 +6104,9 @@ export declare enum Action {
|
|
|
6041
6104
|
*/
|
|
6042
6105
|
EditDetails = "editDetails",
|
|
6043
6106
|
/**
|
|
6044
|
-
* The Create alert action
|
|
6107
|
+
* The *Create alert* action for KPI charts.
|
|
6108
|
+
* Allows users to schedule threshold-based alerts
|
|
6109
|
+
* for KPI charts.
|
|
6045
6110
|
* @example
|
|
6046
6111
|
* ```js
|
|
6047
6112
|
* disabledActions: [Action.CreateMonitor]
|
|
@@ -6097,7 +6162,7 @@ export declare enum Action {
|
|
|
6097
6162
|
* ```js
|
|
6098
6163
|
* disabledActions: [Action.CrossFilter]
|
|
6099
6164
|
* ```
|
|
6100
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6165
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
|
|
6101
6166
|
*/
|
|
6102
6167
|
CrossFilter = "context-menu-item-cross-filter",
|
|
6103
6168
|
/**
|
|
@@ -6107,7 +6172,7 @@ export declare enum Action {
|
|
|
6107
6172
|
* ```js
|
|
6108
6173
|
* disabledActions: [Action.SyncToSlack]
|
|
6109
6174
|
* ```
|
|
6110
|
-
* @version @version SDK : 1.32.0 |
|
|
6175
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
6111
6176
|
*/
|
|
6112
6177
|
SyncToSlack = "syncToSlack",
|
|
6113
6178
|
/**
|
|
@@ -6117,7 +6182,7 @@ export declare enum Action {
|
|
|
6117
6182
|
* ```js
|
|
6118
6183
|
* disabledActions: [Action.SyncToTeams]
|
|
6119
6184
|
* ```
|
|
6120
|
-
* @version @version SDK : 1.32.0 |
|
|
6185
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
6121
6186
|
*/
|
|
6122
6187
|
SyncToTeams = "syncToTeams",
|
|
6123
6188
|
/**
|
|
@@ -6128,7 +6193,7 @@ export declare enum Action {
|
|
|
6128
6193
|
* ```js
|
|
6129
6194
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
6130
6195
|
* ```
|
|
6131
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6196
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6132
6197
|
*/
|
|
6133
6198
|
RemoveCrossFilter = "context-menu-item-remove-cross-filter",
|
|
6134
6199
|
/**
|
|
@@ -6139,7 +6204,7 @@ export declare enum Action {
|
|
|
6139
6204
|
* ```js
|
|
6140
6205
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
6141
6206
|
* ```
|
|
6142
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6207
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6143
6208
|
*/
|
|
6144
6209
|
AxisMenuAggregate = "axisMenuAggregate",
|
|
6145
6210
|
/**
|
|
@@ -6150,17 +6215,19 @@ export declare enum Action {
|
|
|
6150
6215
|
* ```js
|
|
6151
6216
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
6152
6217
|
* ```
|
|
6153
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6218
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6154
6219
|
*/
|
|
6155
6220
|
AxisMenuTimeBucket = "axisMenuTimeBucket",
|
|
6156
6221
|
/**
|
|
6157
6222
|
* The **Filter** action in the chart axis or table column
|
|
6158
6223
|
* customization menu.
|
|
6224
|
+
* Allows adding, editing, or removing filters.
|
|
6225
|
+
*
|
|
6159
6226
|
* @example
|
|
6160
6227
|
* ```js
|
|
6161
6228
|
* disabledActions: [Action.AxisMenuFilter]
|
|
6162
6229
|
* ```
|
|
6163
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6230
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6164
6231
|
*/
|
|
6165
6232
|
AxisMenuFilter = "axisMenuFilter",
|
|
6166
6233
|
/**
|
|
@@ -6171,7 +6238,7 @@ export declare enum Action {
|
|
|
6171
6238
|
* ```js
|
|
6172
6239
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
6173
6240
|
* ```
|
|
6174
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6241
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6175
6242
|
*/
|
|
6176
6243
|
AxisMenuConditionalFormat = "axisMenuConditionalFormat",
|
|
6177
6244
|
/**
|
|
@@ -6182,7 +6249,7 @@ export declare enum Action {
|
|
|
6182
6249
|
* ```js
|
|
6183
6250
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
6184
6251
|
* ```
|
|
6185
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6252
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6186
6253
|
*/
|
|
6187
6254
|
AxisMenuSort = "axisMenuSort",
|
|
6188
6255
|
/**
|
|
@@ -6194,7 +6261,7 @@ export declare enum Action {
|
|
|
6194
6261
|
* ```js
|
|
6195
6262
|
* disabledActions: [Action.AxisMenuGroup]
|
|
6196
6263
|
* ```
|
|
6197
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6264
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6198
6265
|
*/
|
|
6199
6266
|
AxisMenuGroup = "axisMenuGroup",
|
|
6200
6267
|
/**
|
|
@@ -6205,7 +6272,7 @@ export declare enum Action {
|
|
|
6205
6272
|
* ```js
|
|
6206
6273
|
* disabledActions: [Action.AxisMenuPosition]
|
|
6207
6274
|
* ```
|
|
6208
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6275
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6209
6276
|
*/
|
|
6210
6277
|
AxisMenuPosition = "axisMenuPosition",
|
|
6211
6278
|
/**
|
|
@@ -6215,7 +6282,7 @@ export declare enum Action {
|
|
|
6215
6282
|
* ```js
|
|
6216
6283
|
* disabledActions: [Action.AxisMenuRename]
|
|
6217
6284
|
* ```
|
|
6218
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6285
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6219
6286
|
*/
|
|
6220
6287
|
AxisMenuRename = "axisMenuRename",
|
|
6221
6288
|
/**
|
|
@@ -6226,7 +6293,7 @@ export declare enum Action {
|
|
|
6226
6293
|
* ```js
|
|
6227
6294
|
* disabledActions: [Action.AxisMenuEdit]
|
|
6228
6295
|
* ```
|
|
6229
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6296
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6230
6297
|
*/
|
|
6231
6298
|
AxisMenuEdit = "axisMenuEdit",
|
|
6232
6299
|
/**
|
|
@@ -6236,7 +6303,7 @@ export declare enum Action {
|
|
|
6236
6303
|
* ```js
|
|
6237
6304
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
6238
6305
|
* ```
|
|
6239
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6306
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6240
6307
|
*/
|
|
6241
6308
|
AxisMenuNumberFormat = "axisMenuNumberFormat",
|
|
6242
6309
|
/**
|
|
@@ -6246,7 +6313,7 @@ export declare enum Action {
|
|
|
6246
6313
|
* ```js
|
|
6247
6314
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
6248
6315
|
* ```
|
|
6249
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6316
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6250
6317
|
*/
|
|
6251
6318
|
AxisMenuTextWrapping = "axisMenuTextWrapping",
|
|
6252
6319
|
/**
|
|
@@ -6258,7 +6325,7 @@ export declare enum Action {
|
|
|
6258
6325
|
* ```js
|
|
6259
6326
|
* disabledActions: [Action.AxisMenuRemove]
|
|
6260
6327
|
* ```
|
|
6261
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
6328
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
6262
6329
|
*/
|
|
6263
6330
|
AxisMenuRemove = "axisMenuRemove",
|
|
6264
6331
|
/**
|
|
@@ -6272,26 +6339,27 @@ export declare enum Action {
|
|
|
6272
6339
|
* ```js
|
|
6273
6340
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
6274
6341
|
* ```
|
|
6275
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
6342
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
|
|
6276
6343
|
*/
|
|
6277
6344
|
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
6278
6345
|
/**
|
|
6279
|
-
*
|
|
6346
|
+
* The *Request verification* action on a Liveboard.
|
|
6347
|
+
* Initiates a request for Liveboard verification.
|
|
6280
6348
|
* @example
|
|
6281
6349
|
* ```js
|
|
6282
6350
|
* disabledActions: [Action.RequestVerification]
|
|
6283
6351
|
* ```
|
|
6284
|
-
* @version SDK: 1.25.0 |
|
|
6352
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
6285
6353
|
*/
|
|
6286
6354
|
RequestVerification = "requestVerification",
|
|
6287
6355
|
/**
|
|
6288
6356
|
*
|
|
6289
|
-
*Allows users to mark a Liveboard as verified.
|
|
6357
|
+
* Allows users to mark a Liveboard as verified.
|
|
6290
6358
|
* @example
|
|
6291
6359
|
* ```js
|
|
6292
6360
|
* disabledActions: [Action.MarkAsVerified]
|
|
6293
6361
|
* ```
|
|
6294
|
-
* @version SDK: 1.25.0 |
|
|
6362
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
6295
6363
|
*/
|
|
6296
6364
|
MarkAsVerified = "markAsVerified",
|
|
6297
6365
|
/**
|
|
@@ -6301,7 +6369,7 @@ export declare enum Action {
|
|
|
6301
6369
|
* ```js
|
|
6302
6370
|
* disabledActions: [Action.AddTab]
|
|
6303
6371
|
* ```
|
|
6304
|
-
* @version SDK: 1.26.0 |
|
|
6372
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
6305
6373
|
*/
|
|
6306
6374
|
AddTab = "addTab",
|
|
6307
6375
|
/**
|
|
@@ -6311,35 +6379,42 @@ export declare enum Action {
|
|
|
6311
6379
|
* ```js
|
|
6312
6380
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
6313
6381
|
* ```
|
|
6314
|
-
* @version SDK: 1.25.0 |
|
|
6382
|
+
* @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
|
|
6315
6383
|
*/
|
|
6316
6384
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
6317
6385
|
/**
|
|
6386
|
+
* Action ID to hide or disable Natural Language Search query.
|
|
6318
6387
|
*
|
|
6319
6388
|
* @example
|
|
6320
6389
|
* ```js
|
|
6321
6390
|
* disabledActions: [Action.ShowSageQuery]
|
|
6322
6391
|
* ```
|
|
6323
|
-
* @version SDK: 1.26.0 |
|
|
6392
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
6324
6393
|
*/
|
|
6325
6394
|
ShowSageQuery = "showSageQuery",
|
|
6326
6395
|
/**
|
|
6396
|
+
*
|
|
6397
|
+
* Action ID to hide or disable the edit option for the
|
|
6398
|
+
* results generated from the
|
|
6399
|
+
* Natural Language Search query.
|
|
6327
6400
|
*
|
|
6328
6401
|
* @example
|
|
6329
6402
|
* ```js
|
|
6330
6403
|
* disabledActions: [Action.EditSageAnswer]
|
|
6331
6404
|
* ```
|
|
6332
|
-
* @version SDK: 1.26.0 |
|
|
6405
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
6333
6406
|
*/
|
|
6334
6407
|
EditSageAnswer = "editSageAnswer",
|
|
6335
6408
|
/**
|
|
6409
|
+
* The feedback widget for AI-generated Answers.
|
|
6410
|
+
* Allows users to send feedback on the Answers generated
|
|
6411
|
+
* from a Natural Language Search query.
|
|
6336
6412
|
*
|
|
6337
|
-
*This action allows users to send feedback on AI-generated Answers.
|
|
6338
6413
|
* @example
|
|
6339
6414
|
* ```js
|
|
6340
6415
|
* disabledActions: [Action.SageAnswerFeedback]
|
|
6341
6416
|
* ```
|
|
6342
|
-
* @version SDK: 1.26.0 |
|
|
6417
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
6343
6418
|
*/
|
|
6344
6419
|
SageAnswerFeedback = "sageAnswerFeedback",
|
|
6345
6420
|
/**
|
|
@@ -6348,7 +6423,7 @@ export declare enum Action {
|
|
|
6348
6423
|
* ```js
|
|
6349
6424
|
* disabledActions: [Action.ModifySageAnswer]
|
|
6350
6425
|
* ```
|
|
6351
|
-
* @version SDK: 1.26.0 |
|
|
6426
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
6352
6427
|
*/
|
|
6353
6428
|
ModifySageAnswer = "modifySageAnswer",
|
|
6354
6429
|
/**
|
|
@@ -6361,7 +6436,10 @@ export declare enum Action {
|
|
|
6361
6436
|
*/
|
|
6362
6437
|
MoveToTab = "onContainerMove",
|
|
6363
6438
|
/**
|
|
6364
|
-
* The **Manage
|
|
6439
|
+
* The **Manage Alerts** menu action on KPI visualizations.
|
|
6440
|
+
* Allows creating, viewing, and editing monitor
|
|
6441
|
+
* alerts for a KPI chart.
|
|
6442
|
+
*
|
|
6365
6443
|
* @example
|
|
6366
6444
|
* ```js
|
|
6367
6445
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -6369,21 +6447,23 @@ export declare enum Action {
|
|
|
6369
6447
|
*/
|
|
6370
6448
|
ManageMonitor = "manageMonitor",
|
|
6371
6449
|
/**
|
|
6372
|
-
*
|
|
6450
|
+
* The Liveboard Personalised Views dropdown.
|
|
6451
|
+
* Allows navigating to a personalized Liveboard View.
|
|
6373
6452
|
* @example
|
|
6374
6453
|
* ```js
|
|
6375
6454
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
6376
6455
|
* ```
|
|
6377
|
-
* @version SDK : 1.26.0 |
|
|
6456
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6378
6457
|
*/
|
|
6379
6458
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
6380
6459
|
/**
|
|
6381
|
-
* Action ID for
|
|
6460
|
+
* Action ID for show or hide the user details on a
|
|
6461
|
+
* Liveboard (Recently visited / social proof)
|
|
6382
6462
|
* @example
|
|
6383
6463
|
* ```js
|
|
6384
6464
|
* disabledActions: [Action.LiveboardUsers]
|
|
6385
6465
|
* ```
|
|
6386
|
-
* @version SDK : 1.26.0 |
|
|
6466
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6387
6467
|
*/
|
|
6388
6468
|
LiveboardUsers = "liveboardUsers",
|
|
6389
6469
|
/**
|
|
@@ -6401,108 +6481,124 @@ export declare enum Action {
|
|
|
6401
6481
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
6402
6482
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
6403
6483
|
* ```
|
|
6404
|
-
* @version SDK : 1.28.3 |
|
|
6484
|
+
* @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
6405
6485
|
*/
|
|
6406
6486
|
TML = "tml",
|
|
6407
6487
|
/**
|
|
6408
|
-
*
|
|
6409
|
-
* and Pin modal
|
|
6488
|
+
* The **Create Liveboard* action on
|
|
6489
|
+
* the Liveboards page and the Pin modal.
|
|
6490
|
+
* Allows users to create a Liveboard.
|
|
6491
|
+
*
|
|
6410
6492
|
* @example
|
|
6411
6493
|
* ```js
|
|
6412
6494
|
* hiddenAction: [Action.CreateLiveboard]
|
|
6413
6495
|
* disabledActions: [Action.CreateLiveboard]
|
|
6414
6496
|
* ```
|
|
6415
|
-
* @version SDK: 1.32.0 |
|
|
6497
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
6416
6498
|
*/
|
|
6417
6499
|
CreateLiveboard = "createLiveboard",
|
|
6418
6500
|
/**
|
|
6419
|
-
* Action ID for to hide
|
|
6501
|
+
* Action ID for to hide or disable the
|
|
6502
|
+
* Verified Liveboard banner.
|
|
6420
6503
|
* @example
|
|
6421
6504
|
* ```js
|
|
6422
6505
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
6423
6506
|
* ```
|
|
6424
|
-
* @version SDK: 1.29.0 |
|
|
6507
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
6425
6508
|
*/
|
|
6426
6509
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
6427
6510
|
/**
|
|
6428
|
-
*
|
|
6511
|
+
* The *Ask Sage* action for Answers and visualizations.
|
|
6512
|
+
* Allows initiating a Natural Language Search query.
|
|
6513
|
+
*
|
|
6429
6514
|
* @example
|
|
6430
6515
|
* ```js
|
|
6431
6516
|
* hiddenAction: [Action.AskAi]
|
|
6432
6517
|
* ```
|
|
6433
|
-
* @version SDK: 1.29.0 |
|
|
6518
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
6434
6519
|
*/
|
|
6435
6520
|
AskAi = "AskAi",
|
|
6436
6521
|
/**
|
|
6437
6522
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
6523
|
+
* Adds a KPI chart to the watchlist on the Home page.
|
|
6438
6524
|
* @example
|
|
6439
6525
|
* ```js
|
|
6440
6526
|
* disabledActions: [Action.AddToWatchlist]
|
|
6441
6527
|
* ```
|
|
6442
|
-
* @version SDK : 1.27.9 |
|
|
6528
|
+
* @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6443
6529
|
*/
|
|
6444
6530
|
AddToWatchlist = "addToWatchlist",
|
|
6445
6531
|
/**
|
|
6446
6532
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
6533
|
+
* Removes a KPI chart from the watchlist on the Home page.
|
|
6447
6534
|
* @example
|
|
6448
6535
|
* ```js
|
|
6449
6536
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6450
6537
|
* ```
|
|
6451
|
-
* @version SDK : 1.27.9 |
|
|
6538
|
+
* @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6452
6539
|
*/
|
|
6453
6540
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6454
6541
|
/**
|
|
6455
|
-
* The **
|
|
6542
|
+
* The **Organize Favourites** action on Homepage
|
|
6543
|
+
* *Favorites* module.
|
|
6544
|
+
*
|
|
6456
6545
|
* @example
|
|
6457
6546
|
* ```js
|
|
6458
6547
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6459
6548
|
* ```
|
|
6460
|
-
* @version SDK : 1.32.0 |
|
|
6549
|
+
* @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6461
6550
|
*/
|
|
6462
6551
|
OrganiseFavourites = "organiseFavourites",
|
|
6463
6552
|
/**
|
|
6464
|
-
*
|
|
6553
|
+
* The **AI Highlights** action on a Liveboard.
|
|
6554
|
+
*
|
|
6465
6555
|
* @example
|
|
6466
6556
|
* ```js
|
|
6467
6557
|
* hiddenAction: [Action.AIHighlights]
|
|
6468
6558
|
* ```
|
|
6469
|
-
* @version SDK: 1.27.10 |
|
|
6559
|
+
* @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6470
6560
|
*/
|
|
6471
6561
|
AIHighlights = "AIHighlights",
|
|
6472
6562
|
/**
|
|
6473
|
-
*
|
|
6563
|
+
* The *Edit* action on the *Liveboard Schedules* page
|
|
6564
|
+
* (new Homepage experience).
|
|
6565
|
+
* Allows editing Liveboard schedules.
|
|
6566
|
+
*
|
|
6474
6567
|
* @example
|
|
6475
6568
|
* ```js
|
|
6476
6569
|
* disabledActions: [Action.EditScheduleHomepage]
|
|
6477
6570
|
* ```
|
|
6478
|
-
* @version SDK: 1.34.0 |
|
|
6571
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6479
6572
|
*/
|
|
6480
6573
|
EditScheduleHomepage = "editScheduleHomepage",
|
|
6481
6574
|
/**
|
|
6482
|
-
*
|
|
6575
|
+
* The *Pause* action on the *Liveboard Schedules* page
|
|
6576
|
+
* Pauses a scheduled Liveboard job.
|
|
6483
6577
|
* @example
|
|
6484
6578
|
* ```js
|
|
6485
6579
|
* disabledActions: [Action.PauseScheduleHomepage]
|
|
6486
6580
|
* ```
|
|
6487
|
-
* @version SDK: 1.34.0 |
|
|
6581
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6488
6582
|
*/
|
|
6489
6583
|
PauseScheduleHomepage = "pauseScheduleHomepage",
|
|
6490
6584
|
/**
|
|
6491
|
-
*
|
|
6585
|
+
* The **View run history** action **Liveboard Schedules** page.
|
|
6586
|
+
* Allows viewing schedule run history.
|
|
6492
6587
|
* @example
|
|
6493
6588
|
* ```js
|
|
6494
6589
|
* disabledActions: [Action.ViewScheduleRunHomepage]
|
|
6495
6590
|
* ```
|
|
6496
|
-
* @version SDK: 1.34.0 |
|
|
6591
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6497
6592
|
*/
|
|
6498
6593
|
ViewScheduleRunHomepage = "viewScheduleRunHomepage",
|
|
6499
6594
|
/**
|
|
6500
|
-
* Action ID
|
|
6595
|
+
* Action ID to hide or disable the
|
|
6596
|
+
* unsubscribe option for Liveboard schedules.
|
|
6501
6597
|
* @example
|
|
6502
6598
|
* ```js
|
|
6503
6599
|
* disabledActions: [Action.UnsubscribeScheduleHomepage]
|
|
6504
6600
|
* ```
|
|
6505
|
-
* @version SDK: 1.34.0 |
|
|
6601
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6506
6602
|
*/
|
|
6507
6603
|
UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
|
|
6508
6604
|
/**
|
|
@@ -6511,16 +6607,17 @@ export declare enum Action {
|
|
|
6511
6607
|
* ```js
|
|
6512
6608
|
* disabledActions: [Action.ManageTags]
|
|
6513
6609
|
* ```
|
|
6514
|
-
* @version SDK : 1.34.0 |
|
|
6610
|
+
* @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6515
6611
|
*/
|
|
6516
6612
|
ManageTags = "manageTags",
|
|
6517
6613
|
/**
|
|
6518
|
-
*
|
|
6614
|
+
* The **Delete** action on the **Liveboard Schedules* page.
|
|
6615
|
+
* Deletes a Liveboard schedule.
|
|
6519
6616
|
* @example
|
|
6520
6617
|
* ```js
|
|
6521
6618
|
* disabledActions: [Action.DeleteScheduleHomepage]
|
|
6522
6619
|
* ```
|
|
6523
|
-
* @version SDK: 1.34.0 |
|
|
6620
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
6524
6621
|
*/
|
|
6525
6622
|
DeleteScheduleHomepage = "deleteScheduleHomepage",
|
|
6526
6623
|
/**
|
|
@@ -6529,7 +6626,7 @@ export declare enum Action {
|
|
|
6529
6626
|
* ```js
|
|
6530
6627
|
* disabledActions: [Action.KPIAnalysisCTA]
|
|
6531
6628
|
* ```
|
|
6532
|
-
* @version SDK: 1.34.0 |
|
|
6629
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6533
6630
|
*/
|
|
6534
6631
|
KPIAnalysisCTA = "kpiAnalysisCTA",
|
|
6535
6632
|
/**
|
|
@@ -6538,61 +6635,73 @@ export declare enum Action {
|
|
|
6538
6635
|
* ```js
|
|
6539
6636
|
* const disabledActions = [Action.DisableChipReorder]
|
|
6540
6637
|
* ```
|
|
6541
|
-
* @version SDK: 1.36.0 |
|
|
6638
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6542
6639
|
*/
|
|
6543
6640
|
DisableChipReorder = "disableChipReorder",
|
|
6544
6641
|
/**
|
|
6545
|
-
* Action ID
|
|
6642
|
+
* Action ID to show, hide, or disable filters
|
|
6643
|
+
* in a Liveboard tab.
|
|
6644
|
+
*
|
|
6546
6645
|
* @example
|
|
6547
6646
|
* ```js
|
|
6548
6647
|
* hiddenAction: [Action.ChangeFilterVisibilityInTab]
|
|
6549
6648
|
* ```
|
|
6550
|
-
* @version SDK: 1.36.0 |
|
|
6649
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6551
6650
|
*/
|
|
6552
6651
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
6553
6652
|
/**
|
|
6554
|
-
*
|
|
6653
|
+
* The **Preview data** button on the Spotter interface.
|
|
6654
|
+
* Allows previewing the data used for Spotter queries.
|
|
6655
|
+
*
|
|
6555
6656
|
* @example
|
|
6556
6657
|
* ```js
|
|
6557
6658
|
* hiddenAction: [Action.PreviewDataSpotter]
|
|
6558
6659
|
* ```
|
|
6559
|
-
* @version SDK: 1.36.0 |
|
|
6660
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6560
6661
|
*/
|
|
6561
6662
|
PreviewDataSpotter = "previewDataSpotter",
|
|
6562
6663
|
/**
|
|
6563
|
-
*
|
|
6664
|
+
* The **Reset** link on the Spotter interface.
|
|
6665
|
+
* Resets the conversation with Spotter.
|
|
6666
|
+
*
|
|
6564
6667
|
* @example
|
|
6565
6668
|
* ```js
|
|
6566
6669
|
* hiddenAction: [Action.ResetSpotterChat]
|
|
6567
6670
|
* ```
|
|
6568
|
-
* @version SDK: 1.36.0 |
|
|
6671
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6569
6672
|
*/
|
|
6570
6673
|
ResetSpotterChat = "resetSpotterChat",
|
|
6571
6674
|
/**
|
|
6572
|
-
* Action ID for hide
|
|
6675
|
+
* Action ID for hide or disable the
|
|
6676
|
+
* Spotter feedback widget.
|
|
6677
|
+
*
|
|
6573
6678
|
* @example
|
|
6574
6679
|
* ```js
|
|
6575
6680
|
* hiddenAction: [Action.SpotterFeedback]
|
|
6576
6681
|
* ```
|
|
6577
|
-
* @version SDK: 1.36.0 |
|
|
6682
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6578
6683
|
*/
|
|
6579
6684
|
SpotterFeedback = "spotterFeedback",
|
|
6580
6685
|
/**
|
|
6581
|
-
* Action ID for hide
|
|
6686
|
+
* Action ID for hide or disable
|
|
6687
|
+
* the previous prompt edit option in Spotter.
|
|
6688
|
+
*
|
|
6582
6689
|
* @example
|
|
6583
6690
|
* ```js
|
|
6584
6691
|
* hiddenAction: [Action.EditPreviousPrompt]
|
|
6585
6692
|
* ```
|
|
6586
|
-
* @version SDK: 1.36.0 |
|
|
6693
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6587
6694
|
*/
|
|
6588
6695
|
EditPreviousPrompt = "editPreviousPrompt",
|
|
6589
6696
|
/**
|
|
6590
|
-
* Action ID for hide
|
|
6697
|
+
* Action ID for hide or disable
|
|
6698
|
+
* the previous prompt deletion option in Spotter.
|
|
6699
|
+
*
|
|
6591
6700
|
* @example
|
|
6592
6701
|
* ```js
|
|
6593
6702
|
* hiddenAction: [Action.DeletePreviousPrompt]
|
|
6594
6703
|
* ```
|
|
6595
|
-
* @version SDK: 1.36.0 |
|
|
6704
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6596
6705
|
*/
|
|
6597
6706
|
DeletePreviousPrompt = "deletePreviousPrompt",
|
|
6598
6707
|
/**
|
|
@@ -6601,7 +6710,7 @@ export declare enum Action {
|
|
|
6601
6710
|
* ```js
|
|
6602
6711
|
* hiddenAction: [Action.EditTokens]
|
|
6603
6712
|
* ```
|
|
6604
|
-
* @version SDK: 1.36.0 |
|
|
6713
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6605
6714
|
*/
|
|
6606
6715
|
EditTokens = "editTokens"
|
|
6607
6716
|
}
|
|
@@ -6672,7 +6781,7 @@ export declare enum LogLevel {
|
|
|
6672
6781
|
* logLevel: LogLevel.SILENT,
|
|
6673
6782
|
* })
|
|
6674
6783
|
* ```
|
|
6675
|
-
* @version SDK: 1.26.7 |
|
|
6784
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6676
6785
|
*/
|
|
6677
6786
|
SILENT = "SILENT",
|
|
6678
6787
|
/**
|
|
@@ -6684,7 +6793,7 @@ export declare enum LogLevel {
|
|
|
6684
6793
|
* logLevel: LogLevel.ERROR,
|
|
6685
6794
|
* })
|
|
6686
6795
|
* ```
|
|
6687
|
-
* @version SDK: 1.26.7 |
|
|
6796
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6688
6797
|
*/
|
|
6689
6798
|
ERROR = "ERROR",
|
|
6690
6799
|
/**
|
|
@@ -6696,7 +6805,7 @@ export declare enum LogLevel {
|
|
|
6696
6805
|
* logLevel: LogLevel.WARN,
|
|
6697
6806
|
* })
|
|
6698
6807
|
* ```
|
|
6699
|
-
* @version SDK: 1.26.7 |
|
|
6808
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6700
6809
|
*/
|
|
6701
6810
|
WARN = "WARN",
|
|
6702
6811
|
/**
|
|
@@ -6708,7 +6817,7 @@ export declare enum LogLevel {
|
|
|
6708
6817
|
* logLevel: LogLevel.INFO,
|
|
6709
6818
|
* })
|
|
6710
6819
|
* ```
|
|
6711
|
-
* @version SDK: 1.26.7 |
|
|
6820
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6712
6821
|
*/
|
|
6713
6822
|
INFO = "INFO",
|
|
6714
6823
|
/**
|
|
@@ -6720,7 +6829,7 @@ export declare enum LogLevel {
|
|
|
6720
6829
|
* logLevel: LogLevel.DEBUG,
|
|
6721
6830
|
* })
|
|
6722
6831
|
* ```
|
|
6723
|
-
* @version SDK: 1.26.7 |
|
|
6832
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6724
6833
|
*/
|
|
6725
6834
|
DEBUG = "DEBUG",
|
|
6726
6835
|
/**
|
|
@@ -6732,7 +6841,7 @@ export declare enum LogLevel {
|
|
|
6732
6841
|
* logLevel: LogLevel.TRACE,
|
|
6733
6842
|
* })
|
|
6734
6843
|
* ```
|
|
6735
|
-
* @version SDK: 1.26.7 |
|
|
6844
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
6736
6845
|
*/
|
|
6737
6846
|
TRACE = "TRACE"
|
|
6738
6847
|
}
|
|
@@ -7408,7 +7517,7 @@ export declare enum UIPassthroughEvent {
|
|
|
7408
7517
|
PinAnswerToLiveboard = "addVizToPinboard",
|
|
7409
7518
|
SaveAnswer = "saveAnswer",
|
|
7410
7519
|
GetDiscoverabilityStatus = "getDiscoverabilityStatus",
|
|
7411
|
-
GetAvailableUIPassthroughs = "
|
|
7520
|
+
GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
|
|
7412
7521
|
GetAnswerConfig = "getAnswerPageConfig",
|
|
7413
7522
|
GetLiveboardConfig = "getPinboardPageConfig"
|
|
7414
7523
|
}
|