@thoughtspot/visual-embed-sdk 1.44.4 → 1.45.0
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 +33 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +10 -4
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +28 -7
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +10 -6
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +12 -2
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +3 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/embed.spec.js +1 -0
- package/cjs/src/embed/embed.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +32 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +10 -4
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +57 -33
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/pinboard.spec.js +1 -0
- package/cjs/src/embed/pinboard.spec.js.map +1 -1
- package/cjs/src/embed/search.d.ts +1 -0
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +10 -2
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +12 -0
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +7 -3
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +1 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/types.d.ts +236 -158
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +198 -125
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +0 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +0 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/processTrigger.js +1 -1
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils/processTrigger.spec.js +12 -0
- package/cjs/src/utils/processTrigger.spec.js.map +1 -1
- package/dist/{index-C5FAW929.js → index-Dk-SLdNk.js} +1 -1
- package/dist/src/embed/app.d.ts +33 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +10 -6
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +32 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +1 -0
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +236 -158
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -1
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +251 -145
- package/dist/tsembed-react.js +250 -144
- package/dist/tsembed.es.js +251 -145
- package/dist/tsembed.js +250 -144
- package/dist/visual-embed-sdk-react-full.d.ts +303 -146
- package/dist/visual-embed-sdk-react.d.ts +303 -146
- package/dist/visual-embed-sdk.d.ts +308 -163
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +33 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +10 -4
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +28 -7
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +10 -6
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +12 -2
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +3 -0
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/embed.spec.js +1 -0
- package/lib/src/embed/embed.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +32 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +10 -4
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +57 -33
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/pinboard.spec.js +1 -0
- package/lib/src/embed/pinboard.spec.js.map +1 -1
- package/lib/src/embed/search.d.ts +1 -0
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +10 -2
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +12 -0
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +7 -3
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +1 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/types.d.ts +236 -158
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +198 -125
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +0 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +0 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/processTrigger.js +1 -1
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils/processTrigger.spec.js +12 -0
- package/lib/src/utils/processTrigger.spec.js.map +1 -1
- package/package.json +1 -1
- package/src/embed/app.spec.ts +39 -7
- package/src/embed/app.ts +50 -6
- package/src/embed/conversation.spec.ts +3 -0
- package/src/embed/conversation.ts +22 -8
- package/src/embed/embed.spec.ts +1 -0
- package/src/embed/liveboard.spec.ts +77 -42
- package/src/embed/liveboard.ts +47 -5
- package/src/embed/pinboard.spec.ts +1 -0
- package/src/embed/search.spec.ts +16 -0
- package/src/embed/search.ts +12 -1
- package/src/embed/ts-embed.spec.ts +1 -0
- package/src/embed/ts-embed.ts +7 -3
- package/src/types.ts +263 -184
- package/src/utils/graphql/answerService/answer-queries.ts +0 -1
- package/src/utils/graphql/answerService/answerService.spec.ts +0 -1
- package/src/utils/processTrigger.spec.ts +18 -0
- package/src/utils/processTrigger.ts +1 -1
|
@@ -1237,7 +1237,7 @@ export interface EmbedConfig {
|
|
|
1237
1237
|
/**
|
|
1238
1238
|
* [AuthServer] The trusted authentication endpoint to use to get the
|
|
1239
1239
|
* authentication token. A `GET` request is made to the
|
|
1240
|
-
* authentication API endpoint, which
|
|
1240
|
+
* authentication API endpoint, which returns the token
|
|
1241
1241
|
* as a plaintext response. For trusted authentication,
|
|
1242
1242
|
* the `authEndpoint` or `getAuthToken` attribute is required.
|
|
1243
1243
|
*/
|
|
@@ -1347,12 +1347,12 @@ export interface EmbedConfig {
|
|
|
1347
1347
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
1348
1348
|
* to start after the previous embed's render is complete. This helps improve
|
|
1349
1349
|
* performance by decreasing the load on the browser.
|
|
1350
|
-
*
|
|
1350
|
+
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1351
1351
|
* @default false
|
|
1352
1352
|
*/
|
|
1353
1353
|
queueMultiRenders?: boolean;
|
|
1354
1354
|
/**
|
|
1355
|
-
* [AuthServer|Basic] Detect if third-party
|
|
1355
|
+
* [AuthServer|Basic] Detect if third-party cookies are enabled by doing an
|
|
1356
1356
|
* additional call. This is slower and should be avoided. Listen to the
|
|
1357
1357
|
* `NO_COOKIE_ACCESS` event to handle the situation.
|
|
1358
1358
|
*
|
|
@@ -2131,21 +2131,26 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2131
2131
|
/**
|
|
2132
2132
|
* Boolean to exclude runtimeFilters in the URL
|
|
2133
2133
|
* By default it is true, this flag removes runtime filters from the URL
|
|
2134
|
-
*
|
|
2134
|
+
* (default behavior from SDK 1.45.0).
|
|
2135
|
+
* when set to false, runtime filters will be included in the URL
|
|
2136
|
+
* (default behavior before SDK 1.45.0).
|
|
2135
2137
|
*
|
|
2136
2138
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2137
2139
|
* embedded view.
|
|
2138
|
-
* @default
|
|
2140
|
+
* @default true
|
|
2139
2141
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
2140
2142
|
*/
|
|
2141
2143
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
2142
2144
|
/**
|
|
2143
2145
|
* Boolean to exclude runtimeParameters from the URL
|
|
2144
|
-
* when set to true, this flag removes runtime parameters from the URL
|
|
2146
|
+
* when set to true, this flag removes runtime parameters from the URL
|
|
2147
|
+
* (default behavior from SDK 1.45.0).
|
|
2148
|
+
* when set to false, runtime parameters will be included in the URL
|
|
2149
|
+
* (default behavior before SDK 1.45.0).
|
|
2145
2150
|
*
|
|
2146
2151
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2147
2152
|
* embedded view.
|
|
2148
|
-
* @default
|
|
2153
|
+
* @default true
|
|
2149
2154
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2150
2155
|
*/
|
|
2151
2156
|
excludeRuntimeParametersfromURL?: boolean;
|
|
@@ -2196,6 +2201,22 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2196
2201
|
* ```
|
|
2197
2202
|
*/
|
|
2198
2203
|
enableCustomColumnGroups?: boolean;
|
|
2204
|
+
/**
|
|
2205
|
+
* To enable **Include current period** checkbox for date filters.
|
|
2206
|
+
* Controls the visibility of the option to include
|
|
2207
|
+
* the current time period in filter results.
|
|
2208
|
+
*
|
|
2209
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2210
|
+
* @example
|
|
2211
|
+
* ```js
|
|
2212
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2213
|
+
* ... // other embed view config
|
|
2214
|
+
* isThisPeriodInDateFiltersEnabled: true,
|
|
2215
|
+
* })
|
|
2216
|
+
* ```
|
|
2217
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2218
|
+
*/
|
|
2219
|
+
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
2199
2220
|
}
|
|
2200
2221
|
/**
|
|
2201
2222
|
* The configuration object for common Liveboard and App embeds configs.
|
|
@@ -2205,7 +2226,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2205
2226
|
* Show or hide Liveboard header
|
|
2206
2227
|
*
|
|
2207
2228
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2208
|
-
* @version SDK: 1.26.0 |
|
|
2229
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2209
2230
|
* @default false
|
|
2210
2231
|
* @example
|
|
2211
2232
|
* ```js
|
|
@@ -2221,7 +2242,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2221
2242
|
* Show or hide Liveboard title
|
|
2222
2243
|
*
|
|
2223
2244
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2224
|
-
* @version SDK: 1.26.0 |
|
|
2245
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2225
2246
|
* @default false
|
|
2226
2247
|
* @example
|
|
2227
2248
|
* ```js
|
|
@@ -2237,7 +2258,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2237
2258
|
* Show or hide Liveboard description
|
|
2238
2259
|
*
|
|
2239
2260
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2240
|
-
* @version SDK: 1.26.0 |
|
|
2261
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2241
2262
|
* @default false
|
|
2242
2263
|
* @example
|
|
2243
2264
|
* ```js
|
|
@@ -2261,7 +2282,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2261
2282
|
* isLiveboardHeaderSticky: true,
|
|
2262
2283
|
* });
|
|
2263
2284
|
* ```
|
|
2264
|
-
* @version SDK: 1.26.0 |
|
|
2285
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2265
2286
|
*/
|
|
2266
2287
|
isLiveboardHeaderSticky?: boolean;
|
|
2267
2288
|
/**
|
|
@@ -2355,7 +2376,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2355
2376
|
* enable or disable ask sage
|
|
2356
2377
|
*
|
|
2357
2378
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2358
|
-
* @version SDK: 1.29.0 |
|
|
2379
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.12.0.cl
|
|
2359
2380
|
* @default false
|
|
2360
2381
|
* @example
|
|
2361
2382
|
* ```js
|
|
@@ -2383,22 +2404,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2383
2404
|
* ```
|
|
2384
2405
|
*/
|
|
2385
2406
|
coverAndFilterOptionInPDF?: boolean;
|
|
2386
|
-
/**
|
|
2387
|
-
* This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
|
|
2388
|
-
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
2389
|
-
*
|
|
2390
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2391
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 26.3.0.cl
|
|
2392
|
-
* @example
|
|
2393
|
-
* ```js
|
|
2394
|
-
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
2395
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2396
|
-
* ... // other embed view config
|
|
2397
|
-
* liveboardXLSXCSVDownload: true,
|
|
2398
|
-
* })
|
|
2399
|
-
* ```
|
|
2400
|
-
*/
|
|
2401
|
-
liveboardXLSXCSVDownload?: boolean;
|
|
2402
2407
|
/**
|
|
2403
2408
|
* This flag is used to enable or disable the new centralized Liveboard filter UX (v2).
|
|
2404
2409
|
* When enabled, a unified modal is used to manage and update multiple filters at once,
|
|
@@ -2451,7 +2456,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2451
2456
|
* Show or hide masked filter chips
|
|
2452
2457
|
*
|
|
2453
2458
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2454
|
-
* @version SDK: 1.45.0 |
|
|
2459
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
2455
2460
|
* @default false
|
|
2456
2461
|
* @example
|
|
2457
2462
|
* ```js
|
|
@@ -2467,7 +2472,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2467
2472
|
* Enable or disable Liveboard styling and grouping
|
|
2468
2473
|
*
|
|
2469
2474
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2470
|
-
* @version SDK: 1.45.0 |
|
|
2475
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
2471
2476
|
* @default false
|
|
2472
2477
|
* @example
|
|
2473
2478
|
* ```js
|
|
@@ -2619,7 +2624,11 @@ export declare enum HomepageModule {
|
|
|
2619
2624
|
*/
|
|
2620
2625
|
export declare enum ListPageColumns {
|
|
2621
2626
|
/**
|
|
2622
|
-
*
|
|
2627
|
+
* Favorites
|
|
2628
|
+
*/
|
|
2629
|
+
Favorites = "FAVOURITE",
|
|
2630
|
+
/**
|
|
2631
|
+
* @deprecated Use {@link ListPageColumns.Favorites} instead.
|
|
2623
2632
|
*/
|
|
2624
2633
|
Favourite = "FAVOURITE",
|
|
2625
2634
|
/**
|
|
@@ -2637,7 +2646,11 @@ export declare enum ListPageColumns {
|
|
|
2637
2646
|
/**
|
|
2638
2647
|
* Share
|
|
2639
2648
|
*/
|
|
2640
|
-
Share = "SHARE"
|
|
2649
|
+
Share = "SHARE",
|
|
2650
|
+
/**
|
|
2651
|
+
* Verified badge/column
|
|
2652
|
+
*/
|
|
2653
|
+
Verified = "VERIFIED"
|
|
2641
2654
|
}
|
|
2642
2655
|
/**
|
|
2643
2656
|
* A filter that can be applied to ThoughtSpot answers, Liveboards, or
|
|
@@ -2887,7 +2900,7 @@ export declare enum EmbedEvent {
|
|
|
2887
2900
|
/**
|
|
2888
2901
|
* An error has occurred. This event is fired for the following error types:
|
|
2889
2902
|
*
|
|
2890
|
-
* `API` - API call failure
|
|
2903
|
+
* `API` - API call failure.
|
|
2891
2904
|
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
2892
2905
|
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
2893
2906
|
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
@@ -3618,20 +3631,20 @@ export declare enum EmbedEvent {
|
|
|
3618
3631
|
/**
|
|
3619
3632
|
*
|
|
3620
3633
|
* This event can be emitted to intercept search execution initiated by
|
|
3621
|
-
*
|
|
3622
|
-
* You can
|
|
3634
|
+
* users and implement logic to allow or restrict search execution.
|
|
3635
|
+
* You can also show custom error text if the search query must be
|
|
3623
3636
|
* restricted due to your application or business requirements.
|
|
3624
3637
|
|
|
3625
3638
|
* Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
|
|
3626
3639
|
* for this embed event to get emitted.
|
|
3627
|
-
* @param
|
|
3628
|
-
*
|
|
3629
|
-
* Contains elements that
|
|
3630
|
-
*
|
|
3631
|
-
*
|
|
3640
|
+
* @param - Includes the following event listener parameters:
|
|
3641
|
+
* - `payload`: The payload received from the embed related to the Data API call.
|
|
3642
|
+
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
3643
|
+
* should run the search, and if not, what error message
|
|
3644
|
+
* should be shown to the user.
|
|
3632
3645
|
*
|
|
3633
|
-
* `execute` - When execute returns `true`, the search will be run.
|
|
3634
|
-
* When execute returns `false`, the search will not be executed.
|
|
3646
|
+
* `execute` - When `execute` returns `true`, the search will be run.
|
|
3647
|
+
* When `execute` returns `false`, the search will not be executed.
|
|
3635
3648
|
*
|
|
3636
3649
|
* `error` - Developers can customize the error message text when `execute`
|
|
3637
3650
|
* is `false` using the `errorText` and `errorDescription` parameters in responder.
|
|
@@ -3803,7 +3816,7 @@ export declare enum EmbedEvent {
|
|
|
3803
3816
|
* console.log('payload', payload);
|
|
3804
3817
|
* })
|
|
3805
3818
|
* ```
|
|
3806
|
-
* @version SDK: 1.
|
|
3819
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3807
3820
|
*/
|
|
3808
3821
|
DataModelInstructions = "DataModelInstructions",
|
|
3809
3822
|
/**
|
|
@@ -4021,14 +4034,14 @@ export declare enum HostEvent {
|
|
|
4021
4034
|
* the search query string.
|
|
4022
4035
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
4023
4036
|
* Includes the following properties:
|
|
4024
|
-
* @param -
|
|
4025
|
-
*
|
|
4026
|
-
*
|
|
4027
|
-
*
|
|
4028
|
-
*
|
|
4037
|
+
* @param - Includes the following keys:
|
|
4038
|
+
* - `searchQuery`: Query string with search tokens.
|
|
4039
|
+
* - `dataSources`: Data source GUID to search on.
|
|
4040
|
+
* Although an array, only a single source is supported.
|
|
4041
|
+
* - `execute`: Executes search and updates the existing query.
|
|
4029
4042
|
* @example
|
|
4030
4043
|
* ```js
|
|
4031
|
-
*
|
|
4044
|
+
* searchEmbed.trigger(HostEvent.Search, {
|
|
4032
4045
|
searchQuery: "[sales] by [item type]",
|
|
4033
4046
|
dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
|
|
4034
4047
|
execute: true
|
|
@@ -4039,16 +4052,15 @@ export declare enum HostEvent {
|
|
|
4039
4052
|
/**
|
|
4040
4053
|
* Triggers a drill on certain points of the specified column
|
|
4041
4054
|
* Includes the following properties:
|
|
4042
|
-
* @param -
|
|
4043
|
-
*
|
|
4044
|
-
*
|
|
4045
|
-
*
|
|
4046
|
-
* column.
|
|
4047
|
-
*
|
|
4048
|
-
*
|
|
4049
|
-
*
|
|
4050
|
-
*
|
|
4051
|
-
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
4055
|
+
* @param - Includes the following keys:
|
|
4056
|
+
* - `points`: An object containing `selectedPoints` and/or `clickedPoint`
|
|
4057
|
+
* to drill to. For example, `{ selectedPoints: [] }`.
|
|
4058
|
+
* - `columnGuid`: Optional. GUID of the column to drill by. If not provided,
|
|
4059
|
+
* it will auto drill by the configured column.
|
|
4060
|
+
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
4061
|
+
* on the most popular column.
|
|
4062
|
+
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
4063
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
4052
4064
|
* @example
|
|
4053
4065
|
* ```js
|
|
4054
4066
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -4141,14 +4153,12 @@ export declare enum HostEvent {
|
|
|
4141
4153
|
* and `AppEmbed` only. In full application embedding, this event updates
|
|
4142
4154
|
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
4143
4155
|
*
|
|
4144
|
-
* @param -
|
|
4145
|
-
* `columnName
|
|
4146
|
-
*
|
|
4147
|
-
*
|
|
4148
|
-
*
|
|
4149
|
-
*
|
|
4150
|
-
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
4151
|
-
* single value, whereas BW and IN accept multiple values.
|
|
4156
|
+
* @param - Array of {@link RuntimeFilter} objects. Each item includes:
|
|
4157
|
+
* - `columnName`: Name of the column to filter on.
|
|
4158
|
+
* - `operator`: {@link RuntimeFilterOp} to apply. For more information, see
|
|
4159
|
+
* link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
4160
|
+
* - `values`: List of operands. Some operators such as EQ and LE allow a single
|
|
4161
|
+
* value, whereas BW and IN accept multiple values.
|
|
4152
4162
|
*
|
|
4153
4163
|
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
4154
4164
|
* object to its original state and applies new filter conditions.
|
|
@@ -4171,7 +4181,7 @@ export declare enum HostEvent {
|
|
|
4171
4181
|
/**
|
|
4172
4182
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4173
4183
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
4174
|
-
* @param - `path` - the path to navigate to
|
|
4184
|
+
* @param - `path` - the path to navigate to go forward or back. The path value can
|
|
4175
4185
|
* be a number; for example, `1`, `-1`.
|
|
4176
4186
|
* @example
|
|
4177
4187
|
* ```js
|
|
@@ -4242,30 +4252,25 @@ export declare enum HostEvent {
|
|
|
4242
4252
|
* for the Answer that the user is currently on
|
|
4243
4253
|
* and a modal opens for Liveboard selection.
|
|
4244
4254
|
* To add an Answer or visualization to a Liveboard programmatically without
|
|
4245
|
-
*
|
|
4255
|
+
* requiring additional user input via the *Pin to Liveboard* modal, define
|
|
4246
4256
|
* the following parameters:
|
|
4247
4257
|
*
|
|
4248
|
-
* @param
|
|
4249
|
-
* `vizId
|
|
4250
|
-
*
|
|
4251
|
-
*
|
|
4252
|
-
*
|
|
4253
|
-
* `
|
|
4254
|
-
*
|
|
4255
|
-
*
|
|
4256
|
-
*
|
|
4257
|
-
*
|
|
4258
|
-
*
|
|
4259
|
-
*
|
|
4260
|
-
*
|
|
4261
|
-
*
|
|
4262
|
-
*
|
|
4263
|
-
*
|
|
4264
|
-
* `newLiveboardName` - Name string for the Liveboard.
|
|
4265
|
-
* Creates a new Liveboard object with the specified name.
|
|
4266
|
-
* @param
|
|
4267
|
-
* `newTabName` - Name of the tab. Adds a new tab Liveboard specified
|
|
4268
|
-
* in the code.
|
|
4258
|
+
* @param - Includes the following keys:
|
|
4259
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
|
|
4260
|
+
* Optional when pinning a new chart or table generated from a Search query.
|
|
4261
|
+
* **Required** in Spotter Embed.
|
|
4262
|
+
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
4263
|
+
* specify the `newLiveboardName` parameter to create a new Liveboard.
|
|
4264
|
+
* - `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
|
|
4265
|
+
* specified in the code.
|
|
4266
|
+
* - `newVizName`: Name string for the Answer or visualization. If defined,
|
|
4267
|
+
* this parameter adds a new visualization object or creates a copy of the
|
|
4268
|
+
* Answer or visualization specified in `vizId`.
|
|
4269
|
+
* Required.
|
|
4270
|
+
* - `newLiveboardName`: Name string for the Liveboard.
|
|
4271
|
+
* Creates a new Liveboard object with the specified name.
|
|
4272
|
+
* - `newTabName`: Name of the tab. Adds a new tab Liveboard specified
|
|
4273
|
+
* in the code.
|
|
4269
4274
|
*
|
|
4270
4275
|
* @example
|
|
4271
4276
|
* ```js
|
|
@@ -4505,9 +4510,9 @@ export declare enum HostEvent {
|
|
|
4505
4510
|
* on a Liveboard.
|
|
4506
4511
|
*
|
|
4507
4512
|
* This event is not supported in visualization embed and search embed.
|
|
4508
|
-
* @param -
|
|
4509
|
-
*
|
|
4510
|
-
*
|
|
4513
|
+
* @param - Object parameter. Includes the following keys:
|
|
4514
|
+
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
4515
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
4511
4516
|
*
|
|
4512
4517
|
* @example
|
|
4513
4518
|
* ```js
|
|
@@ -4874,10 +4879,9 @@ export declare enum HostEvent {
|
|
|
4874
4879
|
GetFilters = "getFilters",
|
|
4875
4880
|
/**
|
|
4876
4881
|
* Update one or several filters applied on a Liveboard.
|
|
4877
|
-
* @param -
|
|
4878
|
-
* filter operator, and values.
|
|
4879
|
-
*
|
|
4880
|
-
* and values for each.
|
|
4882
|
+
* @param - Includes the following keys:
|
|
4883
|
+
* - `filter`: A single filter object containing column name, filter operator, and values.
|
|
4884
|
+
* - `filters`: Multiple filter objects with column name, filter operator, and values for each.
|
|
4881
4885
|
*
|
|
4882
4886
|
* Each filter object must include the following attributes:
|
|
4883
4887
|
*
|
|
@@ -5003,8 +5007,9 @@ export declare enum HostEvent {
|
|
|
5003
5007
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
5004
5008
|
/**
|
|
5005
5009
|
* Updates the search query string for Natural Language Search operations.
|
|
5006
|
-
* @param -
|
|
5007
|
-
*
|
|
5010
|
+
* @param - Includes the following keys:
|
|
5011
|
+
* - `queryString`: Text string in Natural Language format.
|
|
5012
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
5008
5013
|
* @example
|
|
5009
5014
|
* ```js
|
|
5010
5015
|
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
@@ -5083,11 +5088,10 @@ export declare enum HostEvent {
|
|
|
5083
5088
|
/**
|
|
5084
5089
|
* Triggers an action to update Parameter values on embedded
|
|
5085
5090
|
* Answers, Liveboard, and Spotter answer in Edit mode.
|
|
5086
|
-
* @param -
|
|
5087
|
-
*
|
|
5088
|
-
*
|
|
5089
|
-
*
|
|
5090
|
-
* use the `isVisibleToUser` attribute when applying an override.
|
|
5091
|
+
* @param - Includes the following keys for each item:
|
|
5092
|
+
* - `name`: Name of the parameter.
|
|
5093
|
+
* - `value`: The value to set for the parameter.
|
|
5094
|
+
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
5091
5095
|
*
|
|
5092
5096
|
* @example
|
|
5093
5097
|
* ```js
|
|
@@ -5145,11 +5149,10 @@ export declare enum HostEvent {
|
|
|
5145
5149
|
* If no parameters are specified, the save action is
|
|
5146
5150
|
* triggered with a modal to prompt users to
|
|
5147
5151
|
* add a name and description for the Answer.
|
|
5148
|
-
* @param -
|
|
5149
|
-
* and is required in Spotter embed.
|
|
5150
|
-
* Optional
|
|
5151
|
-
*
|
|
5152
|
-
* @param - `description` - Description text for the Answer.
|
|
5152
|
+
* @param - Includes the following keys:
|
|
5153
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
|
|
5154
|
+
* - `name`: Optional. Name string for the Answer.
|
|
5155
|
+
* - `description`: Optional. Description text for the Answer.
|
|
5153
5156
|
* @example
|
|
5154
5157
|
* ```js
|
|
5155
5158
|
* const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
|
|
@@ -5198,8 +5201,9 @@ export declare enum HostEvent {
|
|
|
5198
5201
|
/**
|
|
5199
5202
|
* Triggers a search operation with the search tokens specified in
|
|
5200
5203
|
* the search query string in spotter embed.
|
|
5201
|
-
* @param -
|
|
5202
|
-
*
|
|
5204
|
+
* @param - Includes the following keys:
|
|
5205
|
+
* - `query`: Text string in Natural Language format.
|
|
5206
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
5203
5207
|
* @example
|
|
5204
5208
|
* ```js
|
|
5205
5209
|
* spotterEmbed.trigger(HostEvent.SpotterSearch, {
|
|
@@ -5246,7 +5250,7 @@ export declare enum HostEvent {
|
|
|
5246
5250
|
* ```js
|
|
5247
5251
|
* spotterEmbed.trigger(HostEvent.DataModelInstructions);
|
|
5248
5252
|
* ```
|
|
5249
|
-
* @version SDK: 1.
|
|
5253
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
5250
5254
|
*/
|
|
5251
5255
|
DataModelInstructions = "DataModelInstructions",
|
|
5252
5256
|
/**
|
|
@@ -5331,7 +5335,7 @@ export declare enum HostEvent {
|
|
|
5331
5335
|
*/
|
|
5332
5336
|
UpdateEmbedParams = "updateEmbedParams",
|
|
5333
5337
|
/**
|
|
5334
|
-
* Triggered when the embed
|
|
5338
|
+
* Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
|
|
5335
5339
|
* @example
|
|
5336
5340
|
* ```js
|
|
5337
5341
|
* liveboardEmbed.trigger(HostEvent.DestroyEmbed);
|
|
@@ -5339,11 +5343,12 @@ export declare enum HostEvent {
|
|
|
5339
5343
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
5340
5344
|
*/
|
|
5341
5345
|
DestroyEmbed = "EmbedDestroyed",
|
|
5342
|
-
/**
|
|
5343
|
-
*
|
|
5344
|
-
*
|
|
5346
|
+
/**
|
|
5347
|
+
* Triggers a new conversation in Spotter embed.
|
|
5348
|
+
*
|
|
5345
5349
|
* This feature is available only when chat history is enabled on your ThoughtSpot instance.
|
|
5346
5350
|
* Contact your admin or ThoughtSpot Support to enable chat history on your instance.
|
|
5351
|
+
*
|
|
5347
5352
|
* @example
|
|
5348
5353
|
* ```js
|
|
5349
5354
|
* spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
|
|
@@ -5381,7 +5386,7 @@ export declare enum DataSourceVisualMode {
|
|
|
5381
5386
|
* ```js
|
|
5382
5387
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
5383
5388
|
* ... //other embed view config
|
|
5384
|
-
* visibleActions: [Action.Save, Action.Edit, Action.Present,
|
|
5389
|
+
* visibleActions: [Action.Save, Action.Edit, Action.Present, Action.Explore],
|
|
5385
5390
|
* disabledActions: [Action.Download],
|
|
5386
5391
|
* //hiddenActions: [], // Set either this or visibleActions
|
|
5387
5392
|
* })
|
|
@@ -5392,10 +5397,10 @@ export declare enum DataSourceVisualMode {
|
|
|
5392
5397
|
* ... //other embed view config
|
|
5393
5398
|
* //visibleActions: [],
|
|
5394
5399
|
* disabledActions: [Action.Download],
|
|
5395
|
-
* hiddenActions: [Action.Edit,
|
|
5400
|
+
* hiddenActions: [Action.Edit, Action.Explore],
|
|
5396
5401
|
* })
|
|
5397
5402
|
* ```
|
|
5398
|
-
* See also link:https://developers.thoughtspot.com/docs/actions[
|
|
5403
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
|
|
5399
5404
|
*/
|
|
5400
5405
|
export declare enum Action {
|
|
5401
5406
|
/**
|
|
@@ -5682,6 +5687,16 @@ export declare enum Action {
|
|
|
5682
5687
|
* ```
|
|
5683
5688
|
*/
|
|
5684
5689
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
5690
|
+
/**
|
|
5691
|
+
* The **Download Liveboard** menu action on a Liveboard.
|
|
5692
|
+
* Allows downloading the entire Liveboard.
|
|
5693
|
+
* @example
|
|
5694
|
+
* ```js
|
|
5695
|
+
* disabledActions: [Action.DownloadLiveboard]
|
|
5696
|
+
* ```
|
|
5697
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
5698
|
+
*/
|
|
5699
|
+
DownloadLiveboard = "downloadLiveboard",
|
|
5685
5700
|
/**
|
|
5686
5701
|
* @hidden
|
|
5687
5702
|
*/
|
|
@@ -5901,13 +5916,15 @@ export declare enum Action {
|
|
|
5901
5916
|
*/
|
|
5902
5917
|
RequestAccess = "requestAccess",
|
|
5903
5918
|
/**
|
|
5904
|
-
*
|
|
5905
|
-
* Query details panel
|
|
5919
|
+
* Controls the display and availability of the **Query visualizer** and
|
|
5920
|
+
* **Query SQL** buttons in the Query details panel on the Answer page.
|
|
5906
5921
|
*
|
|
5907
|
-
* **Query visualizer** - Displays the tables
|
|
5908
|
-
*
|
|
5909
|
-
*
|
|
5910
|
-
*
|
|
5922
|
+
* **Query visualizer** - Displays the tables and filters used in the search query.
|
|
5923
|
+
* **Query SQL** - Displays the SQL statements used to retrieve data for the query.
|
|
5924
|
+
*
|
|
5925
|
+
* Note: This action ID only affects the visibility of the buttons within the
|
|
5926
|
+
* Query details panel. It does not control the visibility
|
|
5927
|
+
* of the query details icon on the Answer page.
|
|
5911
5928
|
* @example
|
|
5912
5929
|
* ```js
|
|
5913
5930
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -6021,28 +6038,28 @@ export declare enum Action {
|
|
|
6021
6038
|
CrossFilter = "context-menu-item-cross-filter",
|
|
6022
6039
|
/**
|
|
6023
6040
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
6024
|
-
* Allows sending data to third-party apps Slack
|
|
6041
|
+
* Allows sending data to third-party apps like Slack.
|
|
6025
6042
|
* @example
|
|
6026
6043
|
* ```js
|
|
6027
6044
|
* disabledActions: [Action.SyncToSlack]
|
|
6028
6045
|
* ```
|
|
6029
|
-
* @version
|
|
6046
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
6030
6047
|
*/
|
|
6031
6048
|
SyncToSlack = "syncToSlack",
|
|
6032
6049
|
/**
|
|
6033
6050
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
6034
|
-
* Allows sending data to third-party apps
|
|
6051
|
+
* Allows sending data to third-party apps like Microsoft Teams.
|
|
6035
6052
|
* @example
|
|
6036
6053
|
* ```js
|
|
6037
6054
|
* disabledActions: [Action.SyncToTeams]
|
|
6038
6055
|
* ```
|
|
6039
|
-
* @version
|
|
6056
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
6040
6057
|
*/
|
|
6041
6058
|
SyncToTeams = "syncToTeams",
|
|
6042
6059
|
/**
|
|
6043
6060
|
* The **Remove** action that appears when cross filters are applied
|
|
6044
6061
|
* on a Liveboard.
|
|
6045
|
-
* Removes filters applied
|
|
6062
|
+
* Removes filters applied to a visualization.
|
|
6046
6063
|
* @example
|
|
6047
6064
|
* ```js
|
|
6048
6065
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -6228,7 +6245,7 @@ export declare enum Action {
|
|
|
6228
6245
|
AddTab = "addTab",
|
|
6229
6246
|
/**
|
|
6230
6247
|
*
|
|
6231
|
-
*Initiates contextual change analysis on KPI charts.
|
|
6248
|
+
* Initiates contextual change analysis on KPI charts.
|
|
6232
6249
|
* @example
|
|
6233
6250
|
* ```js
|
|
6234
6251
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
@@ -6238,7 +6255,7 @@ export declare enum Action {
|
|
|
6238
6255
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
6239
6256
|
/**
|
|
6240
6257
|
* Action ID to hide or disable Iterative Change Analysis option
|
|
6241
|
-
*
|
|
6258
|
+
* in the contextual change analysis Insight charts context menu.
|
|
6242
6259
|
*
|
|
6243
6260
|
* @example
|
|
6244
6261
|
* ```js
|
|
@@ -6516,6 +6533,17 @@ export declare enum Action {
|
|
|
6516
6533
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6517
6534
|
*/
|
|
6518
6535
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
6536
|
+
/**
|
|
6537
|
+
* The **Data model instructions** button on the Spotter interface.
|
|
6538
|
+
* Allows opening the data model instructions modal.
|
|
6539
|
+
*
|
|
6540
|
+
* @example
|
|
6541
|
+
* ```js
|
|
6542
|
+
* hiddenAction: [Action.DataModelInstructions]
|
|
6543
|
+
* ```
|
|
6544
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6545
|
+
*/
|
|
6546
|
+
DataModelInstructions = "DataModelInstructions",
|
|
6519
6547
|
/**
|
|
6520
6548
|
* The **Preview data** button on the Spotter interface.
|
|
6521
6549
|
* Allows previewing the data used for Spotter queries.
|
|
@@ -6601,12 +6629,11 @@ export declare enum Action {
|
|
|
6601
6629
|
*/
|
|
6602
6630
|
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
6603
6631
|
/**
|
|
6604
|
-
|
|
6605
|
-
|
|
6606
|
-
|
|
6607
|
-
|
|
6608
|
-
|
|
6609
|
-
* contact ThoughtSpot Support.
|
|
6632
|
+
* Action ID to hide or disable the Coaching workflow in Spotter conversations.
|
|
6633
|
+
* When disabled, users cannot access **Add to Coaching** workflow in conversation.
|
|
6634
|
+
* The **Add to Coaching** feature allows adding reference questions and
|
|
6635
|
+
* business terms to improve Spotter’s responses. This feature is generally available
|
|
6636
|
+
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
6610
6637
|
* @example
|
|
6611
6638
|
* ```js
|
|
6612
6639
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -6682,6 +6709,55 @@ export declare enum Action {
|
|
|
6682
6709
|
* @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
|
|
6683
6710
|
*/
|
|
6684
6711
|
LiveboardStylePanel = "liveboardStylePanel",
|
|
6712
|
+
/**
|
|
6713
|
+
* The **Publish** action for Liveboards, Answers and Models.
|
|
6714
|
+
* Opens the publishing modal. It's a parent action for the
|
|
6715
|
+
* **Manage Publishing** and **Unpublish** actions if the object
|
|
6716
|
+
* is already published, otherwise appears standalone.
|
|
6717
|
+
* @example
|
|
6718
|
+
* ```js
|
|
6719
|
+
* hiddenActions: [Action.Publish]
|
|
6720
|
+
* disabledActions: [Action.Publish]
|
|
6721
|
+
* ```
|
|
6722
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6723
|
+
*/
|
|
6724
|
+
Publish = "publish",
|
|
6725
|
+
/**
|
|
6726
|
+
* The **Manage Publishing** action for Liveboards, Answers and Models.
|
|
6727
|
+
* Opens the same publishing modal as the **Publish** action.
|
|
6728
|
+
* Appears as a child action to the **Publish** action if the
|
|
6729
|
+
* object is already published.
|
|
6730
|
+
* @example
|
|
6731
|
+
* ```js
|
|
6732
|
+
* hiddenActions: [Action.ManagePublishing]
|
|
6733
|
+
* disabledActions: [Action.ManagePublishing]
|
|
6734
|
+
* ```
|
|
6735
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6736
|
+
*/
|
|
6737
|
+
ManagePublishing = "managePublishing",
|
|
6738
|
+
/**
|
|
6739
|
+
* The **Unpublish** action for Liveboards, Answers and Models.
|
|
6740
|
+
* Opens the unpublishing modal. Appears as a child action to
|
|
6741
|
+
* the **Publish** action if the object is already published.
|
|
6742
|
+
* @example
|
|
6743
|
+
* ```js
|
|
6744
|
+
* hiddenActions: [Action.Unpublish]
|
|
6745
|
+
* disabledActions: [Action.Unpublish]
|
|
6746
|
+
* ```
|
|
6747
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6748
|
+
*/
|
|
6749
|
+
Unpublish = "unpublish",
|
|
6750
|
+
/**
|
|
6751
|
+
* The **Parameterize** action for Tables and Connections.
|
|
6752
|
+
* Opens the parameterization modal.
|
|
6753
|
+
* @example
|
|
6754
|
+
* ```js
|
|
6755
|
+
* hiddenActions: [Action.Parameterize]
|
|
6756
|
+
* disabledActions: [Action.Parameterize]
|
|
6757
|
+
* ```
|
|
6758
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6759
|
+
*/
|
|
6760
|
+
Parameterize = "parameterise",
|
|
6685
6761
|
/**
|
|
6686
6762
|
* The **Move to Group** menu action on a Liveboard.
|
|
6687
6763
|
* Allows moving a visualization to a different group.
|
|
@@ -6721,7 +6797,19 @@ export declare enum Action {
|
|
|
6721
6797
|
* ```
|
|
6722
6798
|
* @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6723
6799
|
*/
|
|
6724
|
-
UngroupLiveboardGroup = "ungroupLiveboardGroup"
|
|
6800
|
+
UngroupLiveboardGroup = "ungroupLiveboardGroup",
|
|
6801
|
+
/**
|
|
6802
|
+
* The **Include current period** checkbox for date filters.
|
|
6803
|
+
* Controls the visibility and availability of the option to include
|
|
6804
|
+
* the current time period in filter results.
|
|
6805
|
+
* @example
|
|
6806
|
+
* ```js
|
|
6807
|
+
* hiddenActions: [Action.IncludeCurrentPeriod]
|
|
6808
|
+
* disabledActions: [Action.IncludeCurrentPeriod]
|
|
6809
|
+
* ```
|
|
6810
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
6811
|
+
*/
|
|
6812
|
+
IncludeCurrentPeriod = "includeCurrentPeriod"
|
|
6725
6813
|
}
|
|
6726
6814
|
export declare enum PrefetchFeatures {
|
|
6727
6815
|
FullApp = "FullApp",
|
|
@@ -6918,31 +7006,19 @@ export declare enum ErrorDetailsTypes {
|
|
|
6918
7006
|
NETWORK = "NETWORK"
|
|
6919
7007
|
}
|
|
6920
7008
|
/**
|
|
6921
|
-
*
|
|
6922
|
-
*
|
|
6923
|
-
* These codes provide granular identification of errors that occur in embedded components.
|
|
6924
|
-
* They are returned in the {@link EmbedErrorDetailsEvent.code} property and allow for
|
|
6925
|
-
* precise error handling and debugging.
|
|
7009
|
+
* Error codes for identifying specific issues in embedded ThoughtSpot components.
|
|
6926
7010
|
*
|
|
6927
|
-
*
|
|
6928
|
-
*
|
|
6929
|
-
* - **Liveboard ID missing**: Errors related to missing liveboard ID
|
|
6930
|
-
* - **Conflicting actions configuration**: Errors related to conflicting actions configuration
|
|
6931
|
-
* - **Conflicting tabs configuration**: Errors related to conflicting tabs configuration
|
|
6932
|
-
* - **Initialization error**: Errors related to initialization error
|
|
6933
|
-
* - **Network error**: Errors related to network error
|
|
6934
|
-
* - **Custom action validation**: Errors related to custom action validation
|
|
6935
|
-
* - **Login failed**: Errors related to login failed
|
|
6936
|
-
* - **Render not called**: Errors related to render not called
|
|
6937
|
-
* - **Host event type undefined or invalid**: Errors related to host event type undefined or invalid
|
|
7011
|
+
* Use these codes for precise error handling and debugging. Each code maps to a
|
|
7012
|
+
* distinct failure scenario, enabling targeted recovery strategies.
|
|
6938
7013
|
*
|
|
6939
7014
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
6940
7015
|
* @group Error Handling
|
|
7016
|
+
*
|
|
6941
7017
|
* @see {@link EmbedErrorDetailsEvent} - The error event object that includes these codes
|
|
6942
7018
|
* @see {@link ErrorDetailsTypes} - General error type categories
|
|
6943
7019
|
*
|
|
6944
7020
|
* @example
|
|
6945
|
-
* Handle specific error codes
|
|
7021
|
+
* Handle specific error codes in the error event handler
|
|
6946
7022
|
*
|
|
6947
7023
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
6948
7024
|
* if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {
|
|
@@ -8008,7 +8084,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8008
8084
|
* ```js
|
|
8009
8085
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
8010
8086
|
* ... // other embed view config
|
|
8011
|
-
* pageId
|
|
8087
|
+
* pageId: Page.Answers, // or Page.Data
|
|
8012
8088
|
* })
|
|
8013
8089
|
* ```
|
|
8014
8090
|
*/
|
|
@@ -8231,6 +8307,38 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8231
8307
|
* ```
|
|
8232
8308
|
*/
|
|
8233
8309
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
8310
|
+
/**
|
|
8311
|
+
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
8312
|
+
*
|
|
8313
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
8314
|
+
* @type {boolean}
|
|
8315
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8316
|
+
* @example
|
|
8317
|
+
* ```js
|
|
8318
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
8319
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
8320
|
+
* ... // other embed view config
|
|
8321
|
+
* isLiveboardXLSXCSVDownloadEnabled: true,
|
|
8322
|
+
* })
|
|
8323
|
+
* ```
|
|
8324
|
+
*/
|
|
8325
|
+
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
8326
|
+
/**
|
|
8327
|
+
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
8328
|
+
*
|
|
8329
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
8330
|
+
* @type {boolean}
|
|
8331
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8332
|
+
* @example
|
|
8333
|
+
* ```js
|
|
8334
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
8335
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
8336
|
+
* ... // other embed view config
|
|
8337
|
+
* isGranularXLSXCSVSchedulesEnabled: true,
|
|
8338
|
+
* })
|
|
8339
|
+
* ```
|
|
8340
|
+
*/
|
|
8341
|
+
isGranularXLSXCSVSchedulesEnabled?: boolean;
|
|
8234
8342
|
/**
|
|
8235
8343
|
* This flag is used to enable the full height lazy load data.
|
|
8236
8344
|
*
|
|
@@ -8928,6 +9036,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8928
9036
|
* ```
|
|
8929
9037
|
*/
|
|
8930
9038
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
9039
|
+
/**
|
|
9040
|
+
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
9041
|
+
*
|
|
9042
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9043
|
+
* @type {boolean}
|
|
9044
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9045
|
+
* @example
|
|
9046
|
+
* ```js
|
|
9047
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
9048
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
9049
|
+
* ... // other embed view config
|
|
9050
|
+
* isLiveboardXLSXCSVDownloadEnabled: true,
|
|
9051
|
+
* })
|
|
9052
|
+
* ```
|
|
9053
|
+
*/
|
|
9054
|
+
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
9055
|
+
/**
|
|
9056
|
+
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
9057
|
+
*
|
|
9058
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9059
|
+
* @type {boolean}
|
|
9060
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9061
|
+
* @example
|
|
9062
|
+
* ```js
|
|
9063
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
9064
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
9065
|
+
* ... // other embed view config
|
|
9066
|
+
* isGranularXLSXCSVSchedulesEnabled: true,
|
|
9067
|
+
* })
|
|
9068
|
+
* ```
|
|
9069
|
+
*/
|
|
9070
|
+
isGranularXLSXCSVSchedulesEnabled?: boolean;
|
|
8931
9071
|
/**
|
|
8932
9072
|
* This flag is used to enable the full height lazy load data.
|
|
8933
9073
|
*
|
|
@@ -9217,6 +9357,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
9217
9357
|
* ... // other embed view config
|
|
9218
9358
|
* forceTable:true,
|
|
9219
9359
|
* })
|
|
9360
|
+
* ```
|
|
9220
9361
|
*/
|
|
9221
9362
|
forceTable?: boolean;
|
|
9222
9363
|
/**
|
|
@@ -9763,11 +9904,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9763
9904
|
runtimeFilters?: RuntimeFilter[];
|
|
9764
9905
|
/**
|
|
9765
9906
|
* Flag to control whether runtime filters should be included in the URL.
|
|
9766
|
-
* If true, filters will be passed via app initialization payload
|
|
9767
|
-
*
|
|
9907
|
+
* If true, filters will be passed via app initialization payload
|
|
9908
|
+
* (default behavior from SDK 1.45.0).
|
|
9909
|
+
* If false/undefined, filters are appended to the iframe URL instead.
|
|
9910
|
+
* (default behavior before SDK 1.45.0).
|
|
9768
9911
|
*
|
|
9769
9912
|
* Supported embed types: `SpotterEmbed`
|
|
9770
|
-
* @default
|
|
9913
|
+
* @default true
|
|
9771
9914
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9772
9915
|
*/
|
|
9773
9916
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
@@ -9792,11 +9935,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9792
9935
|
runtimeParameters?: RuntimeParameter[];
|
|
9793
9936
|
/**
|
|
9794
9937
|
* Flag to control whether runtime parameters should be included in the URL.
|
|
9795
|
-
* If true, parameters will be passed via app
|
|
9796
|
-
*
|
|
9938
|
+
* If true, parameters will be passed via app
|
|
9939
|
+
* initialization payload (default behavior from SDK 1.45.0).
|
|
9940
|
+
* If false/undefined, parameters are appended to
|
|
9941
|
+
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
9797
9942
|
*
|
|
9798
9943
|
* Supported embed types: `SpotterEmbed`
|
|
9799
|
-
* @default
|
|
9944
|
+
* @default true
|
|
9800
9945
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9801
9946
|
*/
|
|
9802
9947
|
excludeRuntimeParametersfromURL?: boolean;
|