@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
|
@@ -1186,7 +1186,7 @@ export interface EmbedConfig {
|
|
|
1186
1186
|
/**
|
|
1187
1187
|
* [AuthServer] The trusted authentication endpoint to use to get the
|
|
1188
1188
|
* authentication token. A `GET` request is made to the
|
|
1189
|
-
* authentication API endpoint, which
|
|
1189
|
+
* authentication API endpoint, which returns the token
|
|
1190
1190
|
* as a plaintext response. For trusted authentication,
|
|
1191
1191
|
* the `authEndpoint` or `getAuthToken` attribute is required.
|
|
1192
1192
|
*/
|
|
@@ -1296,12 +1296,12 @@ export interface EmbedConfig {
|
|
|
1296
1296
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
1297
1297
|
* to start after the previous embed's render is complete. This helps improve
|
|
1298
1298
|
* performance by decreasing the load on the browser.
|
|
1299
|
-
*
|
|
1299
|
+
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1300
1300
|
* @default false
|
|
1301
1301
|
*/
|
|
1302
1302
|
queueMultiRenders?: boolean;
|
|
1303
1303
|
/**
|
|
1304
|
-
* [AuthServer|Basic] Detect if third-party
|
|
1304
|
+
* [AuthServer|Basic] Detect if third-party cookies are enabled by doing an
|
|
1305
1305
|
* additional call. This is slower and should be avoided. Listen to the
|
|
1306
1306
|
* `NO_COOKIE_ACCESS` event to handle the situation.
|
|
1307
1307
|
*
|
|
@@ -2080,21 +2080,26 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2080
2080
|
/**
|
|
2081
2081
|
* Boolean to exclude runtimeFilters in the URL
|
|
2082
2082
|
* By default it is true, this flag removes runtime filters from the URL
|
|
2083
|
-
*
|
|
2083
|
+
* (default behavior from SDK 1.45.0).
|
|
2084
|
+
* when set to false, runtime filters will be included in the URL
|
|
2085
|
+
* (default behavior before SDK 1.45.0).
|
|
2084
2086
|
*
|
|
2085
2087
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2086
2088
|
* embedded view.
|
|
2087
|
-
* @default
|
|
2089
|
+
* @default true
|
|
2088
2090
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
2089
2091
|
*/
|
|
2090
2092
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
2091
2093
|
/**
|
|
2092
2094
|
* Boolean to exclude runtimeParameters from the URL
|
|
2093
|
-
* when set to true, this flag removes runtime parameters from the URL
|
|
2095
|
+
* when set to true, this flag removes runtime parameters from the URL
|
|
2096
|
+
* (default behavior from SDK 1.45.0).
|
|
2097
|
+
* when set to false, runtime parameters will be included in the URL
|
|
2098
|
+
* (default behavior before SDK 1.45.0).
|
|
2094
2099
|
*
|
|
2095
2100
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2096
2101
|
* embedded view.
|
|
2097
|
-
* @default
|
|
2102
|
+
* @default true
|
|
2098
2103
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2099
2104
|
*/
|
|
2100
2105
|
excludeRuntimeParametersfromURL?: boolean;
|
|
@@ -2145,6 +2150,22 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2145
2150
|
* ```
|
|
2146
2151
|
*/
|
|
2147
2152
|
enableCustomColumnGroups?: boolean;
|
|
2153
|
+
/**
|
|
2154
|
+
* To enable **Include current period** checkbox for date filters.
|
|
2155
|
+
* Controls the visibility of the option to include
|
|
2156
|
+
* the current time period in filter results.
|
|
2157
|
+
*
|
|
2158
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2159
|
+
* @example
|
|
2160
|
+
* ```js
|
|
2161
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2162
|
+
* ... // other embed view config
|
|
2163
|
+
* isThisPeriodInDateFiltersEnabled: true,
|
|
2164
|
+
* })
|
|
2165
|
+
* ```
|
|
2166
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2167
|
+
*/
|
|
2168
|
+
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
2148
2169
|
}
|
|
2149
2170
|
/**
|
|
2150
2171
|
* The configuration object for common Liveboard and App embeds configs.
|
|
@@ -2154,7 +2175,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2154
2175
|
* Show or hide Liveboard header
|
|
2155
2176
|
*
|
|
2156
2177
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2157
|
-
* @version SDK: 1.26.0 |
|
|
2178
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2158
2179
|
* @default false
|
|
2159
2180
|
* @example
|
|
2160
2181
|
* ```js
|
|
@@ -2170,7 +2191,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2170
2191
|
* Show or hide Liveboard title
|
|
2171
2192
|
*
|
|
2172
2193
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2173
|
-
* @version SDK: 1.26.0 |
|
|
2194
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2174
2195
|
* @default false
|
|
2175
2196
|
* @example
|
|
2176
2197
|
* ```js
|
|
@@ -2186,7 +2207,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2186
2207
|
* Show or hide Liveboard description
|
|
2187
2208
|
*
|
|
2188
2209
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2189
|
-
* @version SDK: 1.26.0 |
|
|
2210
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2190
2211
|
* @default false
|
|
2191
2212
|
* @example
|
|
2192
2213
|
* ```js
|
|
@@ -2210,7 +2231,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2210
2231
|
* isLiveboardHeaderSticky: true,
|
|
2211
2232
|
* });
|
|
2212
2233
|
* ```
|
|
2213
|
-
* @version SDK: 1.26.0 |
|
|
2234
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2214
2235
|
*/
|
|
2215
2236
|
isLiveboardHeaderSticky?: boolean;
|
|
2216
2237
|
/**
|
|
@@ -2304,7 +2325,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2304
2325
|
* enable or disable ask sage
|
|
2305
2326
|
*
|
|
2306
2327
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2307
|
-
* @version SDK: 1.29.0 |
|
|
2328
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.12.0.cl
|
|
2308
2329
|
* @default false
|
|
2309
2330
|
* @example
|
|
2310
2331
|
* ```js
|
|
@@ -2332,22 +2353,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2332
2353
|
* ```
|
|
2333
2354
|
*/
|
|
2334
2355
|
coverAndFilterOptionInPDF?: boolean;
|
|
2335
|
-
/**
|
|
2336
|
-
* This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
|
|
2337
|
-
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
2338
|
-
*
|
|
2339
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2340
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 26.3.0.cl
|
|
2341
|
-
* @example
|
|
2342
|
-
* ```js
|
|
2343
|
-
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
2344
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2345
|
-
* ... // other embed view config
|
|
2346
|
-
* liveboardXLSXCSVDownload: true,
|
|
2347
|
-
* })
|
|
2348
|
-
* ```
|
|
2349
|
-
*/
|
|
2350
|
-
liveboardXLSXCSVDownload?: boolean;
|
|
2351
2356
|
/**
|
|
2352
2357
|
* This flag is used to enable or disable the new centralized Liveboard filter UX (v2).
|
|
2353
2358
|
* When enabled, a unified modal is used to manage and update multiple filters at once,
|
|
@@ -2400,7 +2405,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2400
2405
|
* Show or hide masked filter chips
|
|
2401
2406
|
*
|
|
2402
2407
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2403
|
-
* @version SDK: 1.45.0 |
|
|
2408
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
2404
2409
|
* @default false
|
|
2405
2410
|
* @example
|
|
2406
2411
|
* ```js
|
|
@@ -2416,7 +2421,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2416
2421
|
* Enable or disable Liveboard styling and grouping
|
|
2417
2422
|
*
|
|
2418
2423
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2419
|
-
* @version SDK: 1.45.0 |
|
|
2424
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
2420
2425
|
* @default false
|
|
2421
2426
|
* @example
|
|
2422
2427
|
* ```js
|
|
@@ -2568,7 +2573,11 @@ export declare enum HomepageModule {
|
|
|
2568
2573
|
*/
|
|
2569
2574
|
export declare enum ListPageColumns {
|
|
2570
2575
|
/**
|
|
2571
|
-
*
|
|
2576
|
+
* Favorites
|
|
2577
|
+
*/
|
|
2578
|
+
Favorites = "FAVOURITE",
|
|
2579
|
+
/**
|
|
2580
|
+
* @deprecated Use {@link ListPageColumns.Favorites} instead.
|
|
2572
2581
|
*/
|
|
2573
2582
|
Favourite = "FAVOURITE",
|
|
2574
2583
|
/**
|
|
@@ -2586,7 +2595,11 @@ export declare enum ListPageColumns {
|
|
|
2586
2595
|
/**
|
|
2587
2596
|
* Share
|
|
2588
2597
|
*/
|
|
2589
|
-
Share = "SHARE"
|
|
2598
|
+
Share = "SHARE",
|
|
2599
|
+
/**
|
|
2600
|
+
* Verified badge/column
|
|
2601
|
+
*/
|
|
2602
|
+
Verified = "VERIFIED"
|
|
2590
2603
|
}
|
|
2591
2604
|
/**
|
|
2592
2605
|
* A filter that can be applied to ThoughtSpot answers, Liveboards, or
|
|
@@ -2836,7 +2849,7 @@ export declare enum EmbedEvent {
|
|
|
2836
2849
|
/**
|
|
2837
2850
|
* An error has occurred. This event is fired for the following error types:
|
|
2838
2851
|
*
|
|
2839
|
-
* `API` - API call failure
|
|
2852
|
+
* `API` - API call failure.
|
|
2840
2853
|
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
2841
2854
|
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
2842
2855
|
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
@@ -3567,20 +3580,20 @@ export declare enum EmbedEvent {
|
|
|
3567
3580
|
/**
|
|
3568
3581
|
*
|
|
3569
3582
|
* This event can be emitted to intercept search execution initiated by
|
|
3570
|
-
*
|
|
3571
|
-
* You can
|
|
3583
|
+
* users and implement logic to allow or restrict search execution.
|
|
3584
|
+
* You can also show custom error text if the search query must be
|
|
3572
3585
|
* restricted due to your application or business requirements.
|
|
3573
3586
|
|
|
3574
3587
|
* Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
|
|
3575
3588
|
* for this embed event to get emitted.
|
|
3576
|
-
* @param
|
|
3577
|
-
*
|
|
3578
|
-
* Contains elements that
|
|
3579
|
-
*
|
|
3580
|
-
*
|
|
3589
|
+
* @param - Includes the following event listener parameters:
|
|
3590
|
+
* - `payload`: The payload received from the embed related to the Data API call.
|
|
3591
|
+
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
3592
|
+
* should run the search, and if not, what error message
|
|
3593
|
+
* should be shown to the user.
|
|
3581
3594
|
*
|
|
3582
|
-
* `execute` - When execute returns `true`, the search will be run.
|
|
3583
|
-
* When execute returns `false`, the search will not be executed.
|
|
3595
|
+
* `execute` - When `execute` returns `true`, the search will be run.
|
|
3596
|
+
* When `execute` returns `false`, the search will not be executed.
|
|
3584
3597
|
*
|
|
3585
3598
|
* `error` - Developers can customize the error message text when `execute`
|
|
3586
3599
|
* is `false` using the `errorText` and `errorDescription` parameters in responder.
|
|
@@ -3752,7 +3765,7 @@ export declare enum EmbedEvent {
|
|
|
3752
3765
|
* console.log('payload', payload);
|
|
3753
3766
|
* })
|
|
3754
3767
|
* ```
|
|
3755
|
-
* @version SDK: 1.
|
|
3768
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3756
3769
|
*/
|
|
3757
3770
|
DataModelInstructions = "DataModelInstructions",
|
|
3758
3771
|
/**
|
|
@@ -3970,14 +3983,14 @@ export declare enum HostEvent {
|
|
|
3970
3983
|
* the search query string.
|
|
3971
3984
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
3972
3985
|
* Includes the following properties:
|
|
3973
|
-
* @param -
|
|
3974
|
-
*
|
|
3975
|
-
*
|
|
3976
|
-
*
|
|
3977
|
-
*
|
|
3986
|
+
* @param - Includes the following keys:
|
|
3987
|
+
* - `searchQuery`: Query string with search tokens.
|
|
3988
|
+
* - `dataSources`: Data source GUID to search on.
|
|
3989
|
+
* Although an array, only a single source is supported.
|
|
3990
|
+
* - `execute`: Executes search and updates the existing query.
|
|
3978
3991
|
* @example
|
|
3979
3992
|
* ```js
|
|
3980
|
-
*
|
|
3993
|
+
* searchEmbed.trigger(HostEvent.Search, {
|
|
3981
3994
|
searchQuery: "[sales] by [item type]",
|
|
3982
3995
|
dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
|
|
3983
3996
|
execute: true
|
|
@@ -3988,16 +4001,15 @@ export declare enum HostEvent {
|
|
|
3988
4001
|
/**
|
|
3989
4002
|
* Triggers a drill on certain points of the specified column
|
|
3990
4003
|
* Includes the following properties:
|
|
3991
|
-
* @param -
|
|
3992
|
-
*
|
|
3993
|
-
*
|
|
3994
|
-
*
|
|
3995
|
-
* column.
|
|
3996
|
-
*
|
|
3997
|
-
*
|
|
3998
|
-
*
|
|
3999
|
-
*
|
|
4000
|
-
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
4004
|
+
* @param - Includes the following keys:
|
|
4005
|
+
* - `points`: An object containing `selectedPoints` and/or `clickedPoint`
|
|
4006
|
+
* to drill to. For example, `{ selectedPoints: [] }`.
|
|
4007
|
+
* - `columnGuid`: Optional. GUID of the column to drill by. If not provided,
|
|
4008
|
+
* it will auto drill by the configured column.
|
|
4009
|
+
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
4010
|
+
* on the most popular column.
|
|
4011
|
+
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
4012
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
4001
4013
|
* @example
|
|
4002
4014
|
* ```js
|
|
4003
4015
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -4090,14 +4102,12 @@ export declare enum HostEvent {
|
|
|
4090
4102
|
* and `AppEmbed` only. In full application embedding, this event updates
|
|
4091
4103
|
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
4092
4104
|
*
|
|
4093
|
-
* @param -
|
|
4094
|
-
* `columnName
|
|
4095
|
-
*
|
|
4096
|
-
*
|
|
4097
|
-
*
|
|
4098
|
-
*
|
|
4099
|
-
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
4100
|
-
* single value, whereas BW and IN accept multiple values.
|
|
4105
|
+
* @param - Array of {@link RuntimeFilter} objects. Each item includes:
|
|
4106
|
+
* - `columnName`: Name of the column to filter on.
|
|
4107
|
+
* - `operator`: {@link RuntimeFilterOp} to apply. For more information, see
|
|
4108
|
+
* link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
4109
|
+
* - `values`: List of operands. Some operators such as EQ and LE allow a single
|
|
4110
|
+
* value, whereas BW and IN accept multiple values.
|
|
4101
4111
|
*
|
|
4102
4112
|
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
4103
4113
|
* object to its original state and applies new filter conditions.
|
|
@@ -4120,7 +4130,7 @@ export declare enum HostEvent {
|
|
|
4120
4130
|
/**
|
|
4121
4131
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4122
4132
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
4123
|
-
* @param - `path` - the path to navigate to
|
|
4133
|
+
* @param - `path` - the path to navigate to go forward or back. The path value can
|
|
4124
4134
|
* be a number; for example, `1`, `-1`.
|
|
4125
4135
|
* @example
|
|
4126
4136
|
* ```js
|
|
@@ -4191,30 +4201,25 @@ export declare enum HostEvent {
|
|
|
4191
4201
|
* for the Answer that the user is currently on
|
|
4192
4202
|
* and a modal opens for Liveboard selection.
|
|
4193
4203
|
* To add an Answer or visualization to a Liveboard programmatically without
|
|
4194
|
-
*
|
|
4204
|
+
* requiring additional user input via the *Pin to Liveboard* modal, define
|
|
4195
4205
|
* the following parameters:
|
|
4196
4206
|
*
|
|
4197
|
-
* @param
|
|
4198
|
-
* `vizId
|
|
4199
|
-
*
|
|
4200
|
-
*
|
|
4201
|
-
*
|
|
4202
|
-
* `
|
|
4203
|
-
*
|
|
4204
|
-
*
|
|
4205
|
-
*
|
|
4206
|
-
*
|
|
4207
|
-
*
|
|
4208
|
-
*
|
|
4209
|
-
*
|
|
4210
|
-
*
|
|
4211
|
-
*
|
|
4212
|
-
*
|
|
4213
|
-
* `newLiveboardName` - Name string for the Liveboard.
|
|
4214
|
-
* Creates a new Liveboard object with the specified name.
|
|
4215
|
-
* @param
|
|
4216
|
-
* `newTabName` - Name of the tab. Adds a new tab Liveboard specified
|
|
4217
|
-
* in the code.
|
|
4207
|
+
* @param - Includes the following keys:
|
|
4208
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
|
|
4209
|
+
* Optional when pinning a new chart or table generated from a Search query.
|
|
4210
|
+
* **Required** in Spotter Embed.
|
|
4211
|
+
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
4212
|
+
* specify the `newLiveboardName` parameter to create a new Liveboard.
|
|
4213
|
+
* - `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
|
|
4214
|
+
* specified in the code.
|
|
4215
|
+
* - `newVizName`: Name string for the Answer or visualization. If defined,
|
|
4216
|
+
* this parameter adds a new visualization object or creates a copy of the
|
|
4217
|
+
* Answer or visualization specified in `vizId`.
|
|
4218
|
+
* Required.
|
|
4219
|
+
* - `newLiveboardName`: Name string for the Liveboard.
|
|
4220
|
+
* Creates a new Liveboard object with the specified name.
|
|
4221
|
+
* - `newTabName`: Name of the tab. Adds a new tab Liveboard specified
|
|
4222
|
+
* in the code.
|
|
4218
4223
|
*
|
|
4219
4224
|
* @example
|
|
4220
4225
|
* ```js
|
|
@@ -4454,9 +4459,9 @@ export declare enum HostEvent {
|
|
|
4454
4459
|
* on a Liveboard.
|
|
4455
4460
|
*
|
|
4456
4461
|
* This event is not supported in visualization embed and search embed.
|
|
4457
|
-
* @param -
|
|
4458
|
-
*
|
|
4459
|
-
*
|
|
4462
|
+
* @param - Object parameter. Includes the following keys:
|
|
4463
|
+
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
4464
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
4460
4465
|
*
|
|
4461
4466
|
* @example
|
|
4462
4467
|
* ```js
|
|
@@ -4823,10 +4828,9 @@ export declare enum HostEvent {
|
|
|
4823
4828
|
GetFilters = "getFilters",
|
|
4824
4829
|
/**
|
|
4825
4830
|
* Update one or several filters applied on a Liveboard.
|
|
4826
|
-
* @param -
|
|
4827
|
-
* filter operator, and values.
|
|
4828
|
-
*
|
|
4829
|
-
* and values for each.
|
|
4831
|
+
* @param - Includes the following keys:
|
|
4832
|
+
* - `filter`: A single filter object containing column name, filter operator, and values.
|
|
4833
|
+
* - `filters`: Multiple filter objects with column name, filter operator, and values for each.
|
|
4830
4834
|
*
|
|
4831
4835
|
* Each filter object must include the following attributes:
|
|
4832
4836
|
*
|
|
@@ -4952,8 +4956,9 @@ export declare enum HostEvent {
|
|
|
4952
4956
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4953
4957
|
/**
|
|
4954
4958
|
* Updates the search query string for Natural Language Search operations.
|
|
4955
|
-
* @param -
|
|
4956
|
-
*
|
|
4959
|
+
* @param - Includes the following keys:
|
|
4960
|
+
* - `queryString`: Text string in Natural Language format.
|
|
4961
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
4957
4962
|
* @example
|
|
4958
4963
|
* ```js
|
|
4959
4964
|
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
@@ -5032,11 +5037,10 @@ export declare enum HostEvent {
|
|
|
5032
5037
|
/**
|
|
5033
5038
|
* Triggers an action to update Parameter values on embedded
|
|
5034
5039
|
* Answers, Liveboard, and Spotter answer in Edit mode.
|
|
5035
|
-
* @param -
|
|
5036
|
-
*
|
|
5037
|
-
*
|
|
5038
|
-
*
|
|
5039
|
-
* use the `isVisibleToUser` attribute when applying an override.
|
|
5040
|
+
* @param - Includes the following keys for each item:
|
|
5041
|
+
* - `name`: Name of the parameter.
|
|
5042
|
+
* - `value`: The value to set for the parameter.
|
|
5043
|
+
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
5040
5044
|
*
|
|
5041
5045
|
* @example
|
|
5042
5046
|
* ```js
|
|
@@ -5094,11 +5098,10 @@ export declare enum HostEvent {
|
|
|
5094
5098
|
* If no parameters are specified, the save action is
|
|
5095
5099
|
* triggered with a modal to prompt users to
|
|
5096
5100
|
* add a name and description for the Answer.
|
|
5097
|
-
* @param -
|
|
5098
|
-
* and is required in Spotter embed.
|
|
5099
|
-
* Optional
|
|
5100
|
-
*
|
|
5101
|
-
* @param - `description` - Description text for the Answer.
|
|
5101
|
+
* @param - Includes the following keys:
|
|
5102
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
|
|
5103
|
+
* - `name`: Optional. Name string for the Answer.
|
|
5104
|
+
* - `description`: Optional. Description text for the Answer.
|
|
5102
5105
|
* @example
|
|
5103
5106
|
* ```js
|
|
5104
5107
|
* const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
|
|
@@ -5147,8 +5150,9 @@ export declare enum HostEvent {
|
|
|
5147
5150
|
/**
|
|
5148
5151
|
* Triggers a search operation with the search tokens specified in
|
|
5149
5152
|
* the search query string in spotter embed.
|
|
5150
|
-
* @param -
|
|
5151
|
-
*
|
|
5153
|
+
* @param - Includes the following keys:
|
|
5154
|
+
* - `query`: Text string in Natural Language format.
|
|
5155
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
5152
5156
|
* @example
|
|
5153
5157
|
* ```js
|
|
5154
5158
|
* spotterEmbed.trigger(HostEvent.SpotterSearch, {
|
|
@@ -5195,7 +5199,7 @@ export declare enum HostEvent {
|
|
|
5195
5199
|
* ```js
|
|
5196
5200
|
* spotterEmbed.trigger(HostEvent.DataModelInstructions);
|
|
5197
5201
|
* ```
|
|
5198
|
-
* @version SDK: 1.
|
|
5202
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
5199
5203
|
*/
|
|
5200
5204
|
DataModelInstructions = "DataModelInstructions",
|
|
5201
5205
|
/**
|
|
@@ -5280,7 +5284,7 @@ export declare enum HostEvent {
|
|
|
5280
5284
|
*/
|
|
5281
5285
|
UpdateEmbedParams = "updateEmbedParams",
|
|
5282
5286
|
/**
|
|
5283
|
-
* Triggered when the embed
|
|
5287
|
+
* Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
|
|
5284
5288
|
* @example
|
|
5285
5289
|
* ```js
|
|
5286
5290
|
* liveboardEmbed.trigger(HostEvent.DestroyEmbed);
|
|
@@ -5288,11 +5292,12 @@ export declare enum HostEvent {
|
|
|
5288
5292
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
5289
5293
|
*/
|
|
5290
5294
|
DestroyEmbed = "EmbedDestroyed",
|
|
5291
|
-
/**
|
|
5292
|
-
*
|
|
5293
|
-
*
|
|
5295
|
+
/**
|
|
5296
|
+
* Triggers a new conversation in Spotter embed.
|
|
5297
|
+
*
|
|
5294
5298
|
* This feature is available only when chat history is enabled on your ThoughtSpot instance.
|
|
5295
5299
|
* Contact your admin or ThoughtSpot Support to enable chat history on your instance.
|
|
5300
|
+
*
|
|
5296
5301
|
* @example
|
|
5297
5302
|
* ```js
|
|
5298
5303
|
* spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
|
|
@@ -5312,7 +5317,7 @@ export declare enum HostEvent {
|
|
|
5312
5317
|
* ```js
|
|
5313
5318
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
5314
5319
|
* ... //other embed view config
|
|
5315
|
-
* visibleActions: [Action.Save, Action.Edit, Action.Present,
|
|
5320
|
+
* visibleActions: [Action.Save, Action.Edit, Action.Present, Action.Explore],
|
|
5316
5321
|
* disabledActions: [Action.Download],
|
|
5317
5322
|
* //hiddenActions: [], // Set either this or visibleActions
|
|
5318
5323
|
* })
|
|
@@ -5323,10 +5328,10 @@ export declare enum HostEvent {
|
|
|
5323
5328
|
* ... //other embed view config
|
|
5324
5329
|
* //visibleActions: [],
|
|
5325
5330
|
* disabledActions: [Action.Download],
|
|
5326
|
-
* hiddenActions: [Action.Edit,
|
|
5331
|
+
* hiddenActions: [Action.Edit, Action.Explore],
|
|
5327
5332
|
* })
|
|
5328
5333
|
* ```
|
|
5329
|
-
* See also link:https://developers.thoughtspot.com/docs/actions[
|
|
5334
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
|
|
5330
5335
|
*/
|
|
5331
5336
|
export declare enum Action {
|
|
5332
5337
|
/**
|
|
@@ -5613,6 +5618,16 @@ export declare enum Action {
|
|
|
5613
5618
|
* ```
|
|
5614
5619
|
*/
|
|
5615
5620
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
5621
|
+
/**
|
|
5622
|
+
* The **Download Liveboard** menu action on a Liveboard.
|
|
5623
|
+
* Allows downloading the entire Liveboard.
|
|
5624
|
+
* @example
|
|
5625
|
+
* ```js
|
|
5626
|
+
* disabledActions: [Action.DownloadLiveboard]
|
|
5627
|
+
* ```
|
|
5628
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
5629
|
+
*/
|
|
5630
|
+
DownloadLiveboard = "downloadLiveboard",
|
|
5616
5631
|
/**
|
|
5617
5632
|
* @hidden
|
|
5618
5633
|
*/
|
|
@@ -5832,13 +5847,15 @@ export declare enum Action {
|
|
|
5832
5847
|
*/
|
|
5833
5848
|
RequestAccess = "requestAccess",
|
|
5834
5849
|
/**
|
|
5835
|
-
*
|
|
5836
|
-
* Query details panel
|
|
5850
|
+
* Controls the display and availability of the **Query visualizer** and
|
|
5851
|
+
* **Query SQL** buttons in the Query details panel on the Answer page.
|
|
5852
|
+
*
|
|
5853
|
+
* **Query visualizer** - Displays the tables and filters used in the search query.
|
|
5854
|
+
* **Query SQL** - Displays the SQL statements used to retrieve data for the query.
|
|
5837
5855
|
*
|
|
5838
|
-
*
|
|
5839
|
-
*
|
|
5840
|
-
*
|
|
5841
|
-
* in a search query to fetch data.
|
|
5856
|
+
* Note: This action ID only affects the visibility of the buttons within the
|
|
5857
|
+
* Query details panel. It does not control the visibility
|
|
5858
|
+
* of the query details icon on the Answer page.
|
|
5842
5859
|
* @example
|
|
5843
5860
|
* ```js
|
|
5844
5861
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5952,28 +5969,28 @@ export declare enum Action {
|
|
|
5952
5969
|
CrossFilter = "context-menu-item-cross-filter",
|
|
5953
5970
|
/**
|
|
5954
5971
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5955
|
-
* Allows sending data to third-party apps Slack
|
|
5972
|
+
* Allows sending data to third-party apps like Slack.
|
|
5956
5973
|
* @example
|
|
5957
5974
|
* ```js
|
|
5958
5975
|
* disabledActions: [Action.SyncToSlack]
|
|
5959
5976
|
* ```
|
|
5960
|
-
* @version
|
|
5977
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5961
5978
|
*/
|
|
5962
5979
|
SyncToSlack = "syncToSlack",
|
|
5963
5980
|
/**
|
|
5964
5981
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5965
|
-
* Allows sending data to third-party apps
|
|
5982
|
+
* Allows sending data to third-party apps like Microsoft Teams.
|
|
5966
5983
|
* @example
|
|
5967
5984
|
* ```js
|
|
5968
5985
|
* disabledActions: [Action.SyncToTeams]
|
|
5969
5986
|
* ```
|
|
5970
|
-
* @version
|
|
5987
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5971
5988
|
*/
|
|
5972
5989
|
SyncToTeams = "syncToTeams",
|
|
5973
5990
|
/**
|
|
5974
5991
|
* The **Remove** action that appears when cross filters are applied
|
|
5975
5992
|
* on a Liveboard.
|
|
5976
|
-
* Removes filters applied
|
|
5993
|
+
* Removes filters applied to a visualization.
|
|
5977
5994
|
* @example
|
|
5978
5995
|
* ```js
|
|
5979
5996
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -6159,7 +6176,7 @@ export declare enum Action {
|
|
|
6159
6176
|
AddTab = "addTab",
|
|
6160
6177
|
/**
|
|
6161
6178
|
*
|
|
6162
|
-
*Initiates contextual change analysis on KPI charts.
|
|
6179
|
+
* Initiates contextual change analysis on KPI charts.
|
|
6163
6180
|
* @example
|
|
6164
6181
|
* ```js
|
|
6165
6182
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
@@ -6169,7 +6186,7 @@ export declare enum Action {
|
|
|
6169
6186
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
6170
6187
|
/**
|
|
6171
6188
|
* Action ID to hide or disable Iterative Change Analysis option
|
|
6172
|
-
*
|
|
6189
|
+
* in the contextual change analysis Insight charts context menu.
|
|
6173
6190
|
*
|
|
6174
6191
|
* @example
|
|
6175
6192
|
* ```js
|
|
@@ -6447,6 +6464,17 @@ export declare enum Action {
|
|
|
6447
6464
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6448
6465
|
*/
|
|
6449
6466
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
6467
|
+
/**
|
|
6468
|
+
* The **Data model instructions** button on the Spotter interface.
|
|
6469
|
+
* Allows opening the data model instructions modal.
|
|
6470
|
+
*
|
|
6471
|
+
* @example
|
|
6472
|
+
* ```js
|
|
6473
|
+
* hiddenAction: [Action.DataModelInstructions]
|
|
6474
|
+
* ```
|
|
6475
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6476
|
+
*/
|
|
6477
|
+
DataModelInstructions = "DataModelInstructions",
|
|
6450
6478
|
/**
|
|
6451
6479
|
* The **Preview data** button on the Spotter interface.
|
|
6452
6480
|
* Allows previewing the data used for Spotter queries.
|
|
@@ -6532,12 +6560,11 @@ export declare enum Action {
|
|
|
6532
6560
|
*/
|
|
6533
6561
|
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
6534
6562
|
/**
|
|
6535
|
-
|
|
6536
|
-
|
|
6537
|
-
|
|
6538
|
-
|
|
6539
|
-
|
|
6540
|
-
* contact ThoughtSpot Support.
|
|
6563
|
+
* Action ID to hide or disable the Coaching workflow in Spotter conversations.
|
|
6564
|
+
* When disabled, users cannot access **Add to Coaching** workflow in conversation.
|
|
6565
|
+
* The **Add to Coaching** feature allows adding reference questions and
|
|
6566
|
+
* business terms to improve Spotter’s responses. This feature is generally available
|
|
6567
|
+
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
6541
6568
|
* @example
|
|
6542
6569
|
* ```js
|
|
6543
6570
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -6613,6 +6640,55 @@ export declare enum Action {
|
|
|
6613
6640
|
* @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
|
|
6614
6641
|
*/
|
|
6615
6642
|
LiveboardStylePanel = "liveboardStylePanel",
|
|
6643
|
+
/**
|
|
6644
|
+
* The **Publish** action for Liveboards, Answers and Models.
|
|
6645
|
+
* Opens the publishing modal. It's a parent action for the
|
|
6646
|
+
* **Manage Publishing** and **Unpublish** actions if the object
|
|
6647
|
+
* is already published, otherwise appears standalone.
|
|
6648
|
+
* @example
|
|
6649
|
+
* ```js
|
|
6650
|
+
* hiddenActions: [Action.Publish]
|
|
6651
|
+
* disabledActions: [Action.Publish]
|
|
6652
|
+
* ```
|
|
6653
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6654
|
+
*/
|
|
6655
|
+
Publish = "publish",
|
|
6656
|
+
/**
|
|
6657
|
+
* The **Manage Publishing** action for Liveboards, Answers and Models.
|
|
6658
|
+
* Opens the same publishing modal as the **Publish** action.
|
|
6659
|
+
* Appears as a child action to the **Publish** action if the
|
|
6660
|
+
* object is already published.
|
|
6661
|
+
* @example
|
|
6662
|
+
* ```js
|
|
6663
|
+
* hiddenActions: [Action.ManagePublishing]
|
|
6664
|
+
* disabledActions: [Action.ManagePublishing]
|
|
6665
|
+
* ```
|
|
6666
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6667
|
+
*/
|
|
6668
|
+
ManagePublishing = "managePublishing",
|
|
6669
|
+
/**
|
|
6670
|
+
* The **Unpublish** action for Liveboards, Answers and Models.
|
|
6671
|
+
* Opens the unpublishing modal. Appears as a child action to
|
|
6672
|
+
* the **Publish** action if the object is already published.
|
|
6673
|
+
* @example
|
|
6674
|
+
* ```js
|
|
6675
|
+
* hiddenActions: [Action.Unpublish]
|
|
6676
|
+
* disabledActions: [Action.Unpublish]
|
|
6677
|
+
* ```
|
|
6678
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6679
|
+
*/
|
|
6680
|
+
Unpublish = "unpublish",
|
|
6681
|
+
/**
|
|
6682
|
+
* The **Parameterize** action for Tables and Connections.
|
|
6683
|
+
* Opens the parameterization modal.
|
|
6684
|
+
* @example
|
|
6685
|
+
* ```js
|
|
6686
|
+
* hiddenActions: [Action.Parameterize]
|
|
6687
|
+
* disabledActions: [Action.Parameterize]
|
|
6688
|
+
* ```
|
|
6689
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6690
|
+
*/
|
|
6691
|
+
Parameterize = "parameterise",
|
|
6616
6692
|
/**
|
|
6617
6693
|
* The **Move to Group** menu action on a Liveboard.
|
|
6618
6694
|
* Allows moving a visualization to a different group.
|
|
@@ -6652,7 +6728,19 @@ export declare enum Action {
|
|
|
6652
6728
|
* ```
|
|
6653
6729
|
* @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6654
6730
|
*/
|
|
6655
|
-
UngroupLiveboardGroup = "ungroupLiveboardGroup"
|
|
6731
|
+
UngroupLiveboardGroup = "ungroupLiveboardGroup",
|
|
6732
|
+
/**
|
|
6733
|
+
* The **Include current period** checkbox for date filters.
|
|
6734
|
+
* Controls the visibility and availability of the option to include
|
|
6735
|
+
* the current time period in filter results.
|
|
6736
|
+
* @example
|
|
6737
|
+
* ```js
|
|
6738
|
+
* hiddenActions: [Action.IncludeCurrentPeriod]
|
|
6739
|
+
* disabledActions: [Action.IncludeCurrentPeriod]
|
|
6740
|
+
* ```
|
|
6741
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
6742
|
+
*/
|
|
6743
|
+
IncludeCurrentPeriod = "includeCurrentPeriod"
|
|
6656
6744
|
}
|
|
6657
6745
|
declare enum ContextMenuTriggerOptions {
|
|
6658
6746
|
LEFT_CLICK = "left-click",
|
|
@@ -7739,6 +7827,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
7739
7827
|
* ... // other embed view config
|
|
7740
7828
|
* forceTable:true,
|
|
7741
7829
|
* })
|
|
7830
|
+
* ```
|
|
7742
7831
|
*/
|
|
7743
7832
|
forceTable?: boolean;
|
|
7744
7833
|
/**
|
|
@@ -8504,7 +8593,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8504
8593
|
* ```js
|
|
8505
8594
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
8506
8595
|
* ... // other embed view config
|
|
8507
|
-
* pageId
|
|
8596
|
+
* pageId: Page.Answers, // or Page.Data
|
|
8508
8597
|
* })
|
|
8509
8598
|
* ```
|
|
8510
8599
|
*/
|
|
@@ -8727,6 +8816,38 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8727
8816
|
* ```
|
|
8728
8817
|
*/
|
|
8729
8818
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
8819
|
+
/**
|
|
8820
|
+
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
8821
|
+
*
|
|
8822
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
8823
|
+
* @type {boolean}
|
|
8824
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8825
|
+
* @example
|
|
8826
|
+
* ```js
|
|
8827
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
8828
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
8829
|
+
* ... // other embed view config
|
|
8830
|
+
* isLiveboardXLSXCSVDownloadEnabled: true,
|
|
8831
|
+
* })
|
|
8832
|
+
* ```
|
|
8833
|
+
*/
|
|
8834
|
+
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
8835
|
+
/**
|
|
8836
|
+
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
8837
|
+
*
|
|
8838
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
8839
|
+
* @type {boolean}
|
|
8840
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8841
|
+
* @example
|
|
8842
|
+
* ```js
|
|
8843
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
8844
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
8845
|
+
* ... // other embed view config
|
|
8846
|
+
* isGranularXLSXCSVSchedulesEnabled: true,
|
|
8847
|
+
* })
|
|
8848
|
+
* ```
|
|
8849
|
+
*/
|
|
8850
|
+
isGranularXLSXCSVSchedulesEnabled?: boolean;
|
|
8730
8851
|
/**
|
|
8731
8852
|
* This flag is used to enable the full height lazy load data.
|
|
8732
8853
|
*
|
|
@@ -9196,6 +9317,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9196
9317
|
* ```
|
|
9197
9318
|
*/
|
|
9198
9319
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
9320
|
+
/**
|
|
9321
|
+
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
9322
|
+
*
|
|
9323
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9324
|
+
* @type {boolean}
|
|
9325
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9326
|
+
* @example
|
|
9327
|
+
* ```js
|
|
9328
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
9329
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
9330
|
+
* ... // other embed view config
|
|
9331
|
+
* isLiveboardXLSXCSVDownloadEnabled: true,
|
|
9332
|
+
* })
|
|
9333
|
+
* ```
|
|
9334
|
+
*/
|
|
9335
|
+
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
9336
|
+
/**
|
|
9337
|
+
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
9338
|
+
*
|
|
9339
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9340
|
+
* @type {boolean}
|
|
9341
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9342
|
+
* @example
|
|
9343
|
+
* ```js
|
|
9344
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
9345
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
9346
|
+
* ... // other embed view config
|
|
9347
|
+
* isGranularXLSXCSVSchedulesEnabled: true,
|
|
9348
|
+
* })
|
|
9349
|
+
* ```
|
|
9350
|
+
*/
|
|
9351
|
+
isGranularXLSXCSVSchedulesEnabled?: boolean;
|
|
9199
9352
|
/**
|
|
9200
9353
|
* This flag is used to enable the full height lazy load data.
|
|
9201
9354
|
*
|
|
@@ -9496,11 +9649,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9496
9649
|
runtimeFilters?: RuntimeFilter[];
|
|
9497
9650
|
/**
|
|
9498
9651
|
* Flag to control whether runtime filters should be included in the URL.
|
|
9499
|
-
* If true, filters will be passed via app initialization payload
|
|
9500
|
-
*
|
|
9652
|
+
* If true, filters will be passed via app initialization payload
|
|
9653
|
+
* (default behavior from SDK 1.45.0).
|
|
9654
|
+
* If false/undefined, filters are appended to the iframe URL instead.
|
|
9655
|
+
* (default behavior before SDK 1.45.0).
|
|
9501
9656
|
*
|
|
9502
9657
|
* Supported embed types: `SpotterEmbed`
|
|
9503
|
-
* @default
|
|
9658
|
+
* @default true
|
|
9504
9659
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9505
9660
|
*/
|
|
9506
9661
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
@@ -9525,11 +9680,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9525
9680
|
runtimeParameters?: RuntimeParameter[];
|
|
9526
9681
|
/**
|
|
9527
9682
|
* Flag to control whether runtime parameters should be included in the URL.
|
|
9528
|
-
* If true, parameters will be passed via app
|
|
9529
|
-
*
|
|
9683
|
+
* If true, parameters will be passed via app
|
|
9684
|
+
* initialization payload (default behavior from SDK 1.45.0).
|
|
9685
|
+
* If false/undefined, parameters are appended to
|
|
9686
|
+
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
9530
9687
|
*
|
|
9531
9688
|
* Supported embed types: `SpotterEmbed`
|
|
9532
|
-
* @default
|
|
9689
|
+
* @default true
|
|
9533
9690
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9534
9691
|
*/
|
|
9535
9692
|
excludeRuntimeParametersfromURL?: boolean;
|