@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
|
|
@@ -2555,7 +2560,11 @@ declare enum HomepageModule {
|
|
|
2555
2560
|
}
|
|
2556
2561
|
declare enum ListPageColumns {
|
|
2557
2562
|
/**
|
|
2558
|
-
*
|
|
2563
|
+
* Favorites
|
|
2564
|
+
*/
|
|
2565
|
+
Favorites = "FAVOURITE",
|
|
2566
|
+
/**
|
|
2567
|
+
* @deprecated Use {@link ListPageColumns.Favorites} instead.
|
|
2559
2568
|
*/
|
|
2560
2569
|
Favourite = "FAVOURITE",
|
|
2561
2570
|
/**
|
|
@@ -2573,7 +2582,11 @@ declare enum ListPageColumns {
|
|
|
2573
2582
|
/**
|
|
2574
2583
|
* Share
|
|
2575
2584
|
*/
|
|
2576
|
-
Share = "SHARE"
|
|
2585
|
+
Share = "SHARE",
|
|
2586
|
+
/**
|
|
2587
|
+
* Verified badge/column
|
|
2588
|
+
*/
|
|
2589
|
+
Verified = "VERIFIED"
|
|
2577
2590
|
}
|
|
2578
2591
|
/**
|
|
2579
2592
|
* A filter that can be applied to ThoughtSpot answers, Liveboards, or
|
|
@@ -2823,7 +2836,7 @@ export declare enum EmbedEvent {
|
|
|
2823
2836
|
/**
|
|
2824
2837
|
* An error has occurred. This event is fired for the following error types:
|
|
2825
2838
|
*
|
|
2826
|
-
* `API` - API call failure
|
|
2839
|
+
* `API` - API call failure.
|
|
2827
2840
|
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
2828
2841
|
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
2829
2842
|
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
@@ -3554,20 +3567,20 @@ export declare enum EmbedEvent {
|
|
|
3554
3567
|
/**
|
|
3555
3568
|
*
|
|
3556
3569
|
* This event can be emitted to intercept search execution initiated by
|
|
3557
|
-
*
|
|
3558
|
-
* You can
|
|
3570
|
+
* users and implement logic to allow or restrict search execution.
|
|
3571
|
+
* You can also show custom error text if the search query must be
|
|
3559
3572
|
* restricted due to your application or business requirements.
|
|
3560
3573
|
|
|
3561
3574
|
* Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
|
|
3562
3575
|
* for this embed event to get emitted.
|
|
3563
|
-
* @param
|
|
3564
|
-
*
|
|
3565
|
-
* Contains elements that
|
|
3566
|
-
*
|
|
3567
|
-
*
|
|
3576
|
+
* @param - Includes the following event listener parameters:
|
|
3577
|
+
* - `payload`: The payload received from the embed related to the Data API call.
|
|
3578
|
+
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
3579
|
+
* should run the search, and if not, what error message
|
|
3580
|
+
* should be shown to the user.
|
|
3568
3581
|
*
|
|
3569
|
-
* `execute` - When execute returns `true`, the search will be run.
|
|
3570
|
-
* When execute returns `false`, the search will not be executed.
|
|
3582
|
+
* `execute` - When `execute` returns `true`, the search will be run.
|
|
3583
|
+
* When `execute` returns `false`, the search will not be executed.
|
|
3571
3584
|
*
|
|
3572
3585
|
* `error` - Developers can customize the error message text when `execute`
|
|
3573
3586
|
* is `false` using the `errorText` and `errorDescription` parameters in responder.
|
|
@@ -3739,7 +3752,7 @@ export declare enum EmbedEvent {
|
|
|
3739
3752
|
* console.log('payload', payload);
|
|
3740
3753
|
* })
|
|
3741
3754
|
* ```
|
|
3742
|
-
* @version SDK: 1.
|
|
3755
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3743
3756
|
*/
|
|
3744
3757
|
DataModelInstructions = "DataModelInstructions",
|
|
3745
3758
|
/**
|
|
@@ -3957,14 +3970,14 @@ export declare enum HostEvent {
|
|
|
3957
3970
|
* the search query string.
|
|
3958
3971
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
3959
3972
|
* Includes the following properties:
|
|
3960
|
-
* @param -
|
|
3961
|
-
*
|
|
3962
|
-
*
|
|
3963
|
-
*
|
|
3964
|
-
*
|
|
3973
|
+
* @param - Includes the following keys:
|
|
3974
|
+
* - `searchQuery`: Query string with search tokens.
|
|
3975
|
+
* - `dataSources`: Data source GUID to search on.
|
|
3976
|
+
* Although an array, only a single source is supported.
|
|
3977
|
+
* - `execute`: Executes search and updates the existing query.
|
|
3965
3978
|
* @example
|
|
3966
3979
|
* ```js
|
|
3967
|
-
*
|
|
3980
|
+
* searchEmbed.trigger(HostEvent.Search, {
|
|
3968
3981
|
searchQuery: "[sales] by [item type]",
|
|
3969
3982
|
dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
|
|
3970
3983
|
execute: true
|
|
@@ -3975,16 +3988,15 @@ export declare enum HostEvent {
|
|
|
3975
3988
|
/**
|
|
3976
3989
|
* Triggers a drill on certain points of the specified column
|
|
3977
3990
|
* Includes the following properties:
|
|
3978
|
-
* @param -
|
|
3979
|
-
*
|
|
3980
|
-
*
|
|
3981
|
-
*
|
|
3982
|
-
* column.
|
|
3983
|
-
*
|
|
3984
|
-
*
|
|
3985
|
-
*
|
|
3986
|
-
*
|
|
3987
|
-
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
3991
|
+
* @param - Includes the following keys:
|
|
3992
|
+
* - `points`: An object containing `selectedPoints` and/or `clickedPoint`
|
|
3993
|
+
* to drill to. For example, `{ selectedPoints: [] }`.
|
|
3994
|
+
* - `columnGuid`: Optional. GUID of the column to drill by. If not provided,
|
|
3995
|
+
* it will auto drill by the configured column.
|
|
3996
|
+
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
3997
|
+
* on the most popular column.
|
|
3998
|
+
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
3999
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
3988
4000
|
* @example
|
|
3989
4001
|
* ```js
|
|
3990
4002
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -4077,14 +4089,12 @@ export declare enum HostEvent {
|
|
|
4077
4089
|
* and `AppEmbed` only. In full application embedding, this event updates
|
|
4078
4090
|
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
4079
4091
|
*
|
|
4080
|
-
* @param -
|
|
4081
|
-
* `columnName
|
|
4082
|
-
*
|
|
4083
|
-
*
|
|
4084
|
-
*
|
|
4085
|
-
*
|
|
4086
|
-
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
4087
|
-
* single value, whereas BW and IN accept multiple values.
|
|
4092
|
+
* @param - Array of {@link RuntimeFilter} objects. Each item includes:
|
|
4093
|
+
* - `columnName`: Name of the column to filter on.
|
|
4094
|
+
* - `operator`: {@link RuntimeFilterOp} to apply. For more information, see
|
|
4095
|
+
* link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
4096
|
+
* - `values`: List of operands. Some operators such as EQ and LE allow a single
|
|
4097
|
+
* value, whereas BW and IN accept multiple values.
|
|
4088
4098
|
*
|
|
4089
4099
|
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
4090
4100
|
* object to its original state and applies new filter conditions.
|
|
@@ -4107,7 +4117,7 @@ export declare enum HostEvent {
|
|
|
4107
4117
|
/**
|
|
4108
4118
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4109
4119
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
4110
|
-
* @param - `path` - the path to navigate to
|
|
4120
|
+
* @param - `path` - the path to navigate to go forward or back. The path value can
|
|
4111
4121
|
* be a number; for example, `1`, `-1`.
|
|
4112
4122
|
* @example
|
|
4113
4123
|
* ```js
|
|
@@ -4178,30 +4188,25 @@ export declare enum HostEvent {
|
|
|
4178
4188
|
* for the Answer that the user is currently on
|
|
4179
4189
|
* and a modal opens for Liveboard selection.
|
|
4180
4190
|
* To add an Answer or visualization to a Liveboard programmatically without
|
|
4181
|
-
*
|
|
4191
|
+
* requiring additional user input via the *Pin to Liveboard* modal, define
|
|
4182
4192
|
* the following parameters:
|
|
4183
4193
|
*
|
|
4184
|
-
* @param
|
|
4185
|
-
* `vizId
|
|
4186
|
-
*
|
|
4187
|
-
*
|
|
4188
|
-
*
|
|
4189
|
-
* `
|
|
4190
|
-
*
|
|
4191
|
-
*
|
|
4192
|
-
*
|
|
4193
|
-
*
|
|
4194
|
-
*
|
|
4195
|
-
*
|
|
4196
|
-
*
|
|
4197
|
-
*
|
|
4198
|
-
*
|
|
4199
|
-
*
|
|
4200
|
-
* `newLiveboardName` - Name string for the Liveboard.
|
|
4201
|
-
* Creates a new Liveboard object with the specified name.
|
|
4202
|
-
* @param
|
|
4203
|
-
* `newTabName` - Name of the tab. Adds a new tab Liveboard specified
|
|
4204
|
-
* in the code.
|
|
4194
|
+
* @param - Includes the following keys:
|
|
4195
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
|
|
4196
|
+
* Optional when pinning a new chart or table generated from a Search query.
|
|
4197
|
+
* **Required** in Spotter Embed.
|
|
4198
|
+
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
4199
|
+
* specify the `newLiveboardName` parameter to create a new Liveboard.
|
|
4200
|
+
* - `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
|
|
4201
|
+
* specified in the code.
|
|
4202
|
+
* - `newVizName`: Name string for the Answer or visualization. If defined,
|
|
4203
|
+
* this parameter adds a new visualization object or creates a copy of the
|
|
4204
|
+
* Answer or visualization specified in `vizId`.
|
|
4205
|
+
* Required.
|
|
4206
|
+
* - `newLiveboardName`: Name string for the Liveboard.
|
|
4207
|
+
* Creates a new Liveboard object with the specified name.
|
|
4208
|
+
* - `newTabName`: Name of the tab. Adds a new tab Liveboard specified
|
|
4209
|
+
* in the code.
|
|
4205
4210
|
*
|
|
4206
4211
|
* @example
|
|
4207
4212
|
* ```js
|
|
@@ -4441,9 +4446,9 @@ export declare enum HostEvent {
|
|
|
4441
4446
|
* on a Liveboard.
|
|
4442
4447
|
*
|
|
4443
4448
|
* This event is not supported in visualization embed and search embed.
|
|
4444
|
-
* @param -
|
|
4445
|
-
*
|
|
4446
|
-
*
|
|
4449
|
+
* @param - Object parameter. Includes the following keys:
|
|
4450
|
+
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
4451
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
4447
4452
|
*
|
|
4448
4453
|
* @example
|
|
4449
4454
|
* ```js
|
|
@@ -4810,10 +4815,9 @@ export declare enum HostEvent {
|
|
|
4810
4815
|
GetFilters = "getFilters",
|
|
4811
4816
|
/**
|
|
4812
4817
|
* Update one or several filters applied on a Liveboard.
|
|
4813
|
-
* @param -
|
|
4814
|
-
* filter operator, and values.
|
|
4815
|
-
*
|
|
4816
|
-
* and values for each.
|
|
4818
|
+
* @param - Includes the following keys:
|
|
4819
|
+
* - `filter`: A single filter object containing column name, filter operator, and values.
|
|
4820
|
+
* - `filters`: Multiple filter objects with column name, filter operator, and values for each.
|
|
4817
4821
|
*
|
|
4818
4822
|
* Each filter object must include the following attributes:
|
|
4819
4823
|
*
|
|
@@ -4939,8 +4943,9 @@ export declare enum HostEvent {
|
|
|
4939
4943
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4940
4944
|
/**
|
|
4941
4945
|
* Updates the search query string for Natural Language Search operations.
|
|
4942
|
-
* @param -
|
|
4943
|
-
*
|
|
4946
|
+
* @param - Includes the following keys:
|
|
4947
|
+
* - `queryString`: Text string in Natural Language format.
|
|
4948
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
4944
4949
|
* @example
|
|
4945
4950
|
* ```js
|
|
4946
4951
|
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
@@ -5019,11 +5024,10 @@ export declare enum HostEvent {
|
|
|
5019
5024
|
/**
|
|
5020
5025
|
* Triggers an action to update Parameter values on embedded
|
|
5021
5026
|
* Answers, Liveboard, and Spotter answer in Edit mode.
|
|
5022
|
-
* @param -
|
|
5023
|
-
*
|
|
5024
|
-
*
|
|
5025
|
-
*
|
|
5026
|
-
* use the `isVisibleToUser` attribute when applying an override.
|
|
5027
|
+
* @param - Includes the following keys for each item:
|
|
5028
|
+
* - `name`: Name of the parameter.
|
|
5029
|
+
* - `value`: The value to set for the parameter.
|
|
5030
|
+
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
5027
5031
|
*
|
|
5028
5032
|
* @example
|
|
5029
5033
|
* ```js
|
|
@@ -5081,11 +5085,10 @@ export declare enum HostEvent {
|
|
|
5081
5085
|
* If no parameters are specified, the save action is
|
|
5082
5086
|
* triggered with a modal to prompt users to
|
|
5083
5087
|
* add a name and description for the Answer.
|
|
5084
|
-
* @param -
|
|
5085
|
-
* and is required in Spotter embed.
|
|
5086
|
-
* Optional
|
|
5087
|
-
*
|
|
5088
|
-
* @param - `description` - Description text for the Answer.
|
|
5088
|
+
* @param - Includes the following keys:
|
|
5089
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
|
|
5090
|
+
* - `name`: Optional. Name string for the Answer.
|
|
5091
|
+
* - `description`: Optional. Description text for the Answer.
|
|
5089
5092
|
* @example
|
|
5090
5093
|
* ```js
|
|
5091
5094
|
* const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
|
|
@@ -5134,8 +5137,9 @@ export declare enum HostEvent {
|
|
|
5134
5137
|
/**
|
|
5135
5138
|
* Triggers a search operation with the search tokens specified in
|
|
5136
5139
|
* the search query string in spotter embed.
|
|
5137
|
-
* @param -
|
|
5138
|
-
*
|
|
5140
|
+
* @param - Includes the following keys:
|
|
5141
|
+
* - `query`: Text string in Natural Language format.
|
|
5142
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
5139
5143
|
* @example
|
|
5140
5144
|
* ```js
|
|
5141
5145
|
* spotterEmbed.trigger(HostEvent.SpotterSearch, {
|
|
@@ -5182,7 +5186,7 @@ export declare enum HostEvent {
|
|
|
5182
5186
|
* ```js
|
|
5183
5187
|
* spotterEmbed.trigger(HostEvent.DataModelInstructions);
|
|
5184
5188
|
* ```
|
|
5185
|
-
* @version SDK: 1.
|
|
5189
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
5186
5190
|
*/
|
|
5187
5191
|
DataModelInstructions = "DataModelInstructions",
|
|
5188
5192
|
/**
|
|
@@ -5267,7 +5271,7 @@ export declare enum HostEvent {
|
|
|
5267
5271
|
*/
|
|
5268
5272
|
UpdateEmbedParams = "updateEmbedParams",
|
|
5269
5273
|
/**
|
|
5270
|
-
* Triggered when the embed
|
|
5274
|
+
* Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
|
|
5271
5275
|
* @example
|
|
5272
5276
|
* ```js
|
|
5273
5277
|
* liveboardEmbed.trigger(HostEvent.DestroyEmbed);
|
|
@@ -5275,11 +5279,12 @@ export declare enum HostEvent {
|
|
|
5275
5279
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
5276
5280
|
*/
|
|
5277
5281
|
DestroyEmbed = "EmbedDestroyed",
|
|
5278
|
-
/**
|
|
5279
|
-
*
|
|
5280
|
-
*
|
|
5282
|
+
/**
|
|
5283
|
+
* Triggers a new conversation in Spotter embed.
|
|
5284
|
+
*
|
|
5281
5285
|
* This feature is available only when chat history is enabled on your ThoughtSpot instance.
|
|
5282
5286
|
* Contact your admin or ThoughtSpot Support to enable chat history on your instance.
|
|
5287
|
+
*
|
|
5283
5288
|
* @example
|
|
5284
5289
|
* ```js
|
|
5285
5290
|
* spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
|
|
@@ -5317,7 +5322,7 @@ export declare enum DataSourceVisualMode {
|
|
|
5317
5322
|
* ```js
|
|
5318
5323
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
5319
5324
|
* ... //other embed view config
|
|
5320
|
-
* visibleActions: [Action.Save, Action.Edit, Action.Present,
|
|
5325
|
+
* visibleActions: [Action.Save, Action.Edit, Action.Present, Action.Explore],
|
|
5321
5326
|
* disabledActions: [Action.Download],
|
|
5322
5327
|
* //hiddenActions: [], // Set either this or visibleActions
|
|
5323
5328
|
* })
|
|
@@ -5328,10 +5333,10 @@ export declare enum DataSourceVisualMode {
|
|
|
5328
5333
|
* ... //other embed view config
|
|
5329
5334
|
* //visibleActions: [],
|
|
5330
5335
|
* disabledActions: [Action.Download],
|
|
5331
|
-
* hiddenActions: [Action.Edit,
|
|
5336
|
+
* hiddenActions: [Action.Edit, Action.Explore],
|
|
5332
5337
|
* })
|
|
5333
5338
|
* ```
|
|
5334
|
-
* See also link:https://developers.thoughtspot.com/docs/actions[
|
|
5339
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
|
|
5335
5340
|
*/
|
|
5336
5341
|
export declare enum Action {
|
|
5337
5342
|
/**
|
|
@@ -5618,6 +5623,16 @@ export declare enum Action {
|
|
|
5618
5623
|
* ```
|
|
5619
5624
|
*/
|
|
5620
5625
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
5626
|
+
/**
|
|
5627
|
+
* The **Download Liveboard** menu action on a Liveboard.
|
|
5628
|
+
* Allows downloading the entire Liveboard.
|
|
5629
|
+
* @example
|
|
5630
|
+
* ```js
|
|
5631
|
+
* disabledActions: [Action.DownloadLiveboard]
|
|
5632
|
+
* ```
|
|
5633
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
5634
|
+
*/
|
|
5635
|
+
DownloadLiveboard = "downloadLiveboard",
|
|
5621
5636
|
/**
|
|
5622
5637
|
* @hidden
|
|
5623
5638
|
*/
|
|
@@ -5837,13 +5852,15 @@ export declare enum Action {
|
|
|
5837
5852
|
*/
|
|
5838
5853
|
RequestAccess = "requestAccess",
|
|
5839
5854
|
/**
|
|
5840
|
-
*
|
|
5841
|
-
* Query details panel
|
|
5855
|
+
* Controls the display and availability of the **Query visualizer** and
|
|
5856
|
+
* **Query SQL** buttons in the Query details panel on the Answer page.
|
|
5857
|
+
*
|
|
5858
|
+
* **Query visualizer** - Displays the tables and filters used in the search query.
|
|
5859
|
+
* **Query SQL** - Displays the SQL statements used to retrieve data for the query.
|
|
5842
5860
|
*
|
|
5843
|
-
*
|
|
5844
|
-
*
|
|
5845
|
-
*
|
|
5846
|
-
* in a search query to fetch data.
|
|
5861
|
+
* Note: This action ID only affects the visibility of the buttons within the
|
|
5862
|
+
* Query details panel. It does not control the visibility
|
|
5863
|
+
* of the query details icon on the Answer page.
|
|
5847
5864
|
* @example
|
|
5848
5865
|
* ```js
|
|
5849
5866
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5957,28 +5974,28 @@ export declare enum Action {
|
|
|
5957
5974
|
CrossFilter = "context-menu-item-cross-filter",
|
|
5958
5975
|
/**
|
|
5959
5976
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5960
|
-
* Allows sending data to third-party apps Slack
|
|
5977
|
+
* Allows sending data to third-party apps like Slack.
|
|
5961
5978
|
* @example
|
|
5962
5979
|
* ```js
|
|
5963
5980
|
* disabledActions: [Action.SyncToSlack]
|
|
5964
5981
|
* ```
|
|
5965
|
-
* @version
|
|
5982
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5966
5983
|
*/
|
|
5967
5984
|
SyncToSlack = "syncToSlack",
|
|
5968
5985
|
/**
|
|
5969
5986
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5970
|
-
* Allows sending data to third-party apps
|
|
5987
|
+
* Allows sending data to third-party apps like Microsoft Teams.
|
|
5971
5988
|
* @example
|
|
5972
5989
|
* ```js
|
|
5973
5990
|
* disabledActions: [Action.SyncToTeams]
|
|
5974
5991
|
* ```
|
|
5975
|
-
* @version
|
|
5992
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5976
5993
|
*/
|
|
5977
5994
|
SyncToTeams = "syncToTeams",
|
|
5978
5995
|
/**
|
|
5979
5996
|
* The **Remove** action that appears when cross filters are applied
|
|
5980
5997
|
* on a Liveboard.
|
|
5981
|
-
* Removes filters applied
|
|
5998
|
+
* Removes filters applied to a visualization.
|
|
5982
5999
|
* @example
|
|
5983
6000
|
* ```js
|
|
5984
6001
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -6164,7 +6181,7 @@ export declare enum Action {
|
|
|
6164
6181
|
AddTab = "addTab",
|
|
6165
6182
|
/**
|
|
6166
6183
|
*
|
|
6167
|
-
*Initiates contextual change analysis on KPI charts.
|
|
6184
|
+
* Initiates contextual change analysis on KPI charts.
|
|
6168
6185
|
* @example
|
|
6169
6186
|
* ```js
|
|
6170
6187
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
@@ -6174,7 +6191,7 @@ export declare enum Action {
|
|
|
6174
6191
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
6175
6192
|
/**
|
|
6176
6193
|
* Action ID to hide or disable Iterative Change Analysis option
|
|
6177
|
-
*
|
|
6194
|
+
* in the contextual change analysis Insight charts context menu.
|
|
6178
6195
|
*
|
|
6179
6196
|
* @example
|
|
6180
6197
|
* ```js
|
|
@@ -6452,6 +6469,17 @@ export declare enum Action {
|
|
|
6452
6469
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6453
6470
|
*/
|
|
6454
6471
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
6472
|
+
/**
|
|
6473
|
+
* The **Data model instructions** button on the Spotter interface.
|
|
6474
|
+
* Allows opening the data model instructions modal.
|
|
6475
|
+
*
|
|
6476
|
+
* @example
|
|
6477
|
+
* ```js
|
|
6478
|
+
* hiddenAction: [Action.DataModelInstructions]
|
|
6479
|
+
* ```
|
|
6480
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6481
|
+
*/
|
|
6482
|
+
DataModelInstructions = "DataModelInstructions",
|
|
6455
6483
|
/**
|
|
6456
6484
|
* The **Preview data** button on the Spotter interface.
|
|
6457
6485
|
* Allows previewing the data used for Spotter queries.
|
|
@@ -6537,12 +6565,11 @@ export declare enum Action {
|
|
|
6537
6565
|
*/
|
|
6538
6566
|
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
6539
6567
|
/**
|
|
6540
|
-
|
|
6541
|
-
|
|
6542
|
-
|
|
6543
|
-
|
|
6544
|
-
|
|
6545
|
-
* contact ThoughtSpot Support.
|
|
6568
|
+
* Action ID to hide or disable the Coaching workflow in Spotter conversations.
|
|
6569
|
+
* When disabled, users cannot access **Add to Coaching** workflow in conversation.
|
|
6570
|
+
* The **Add to Coaching** feature allows adding reference questions and
|
|
6571
|
+
* business terms to improve Spotter’s responses. This feature is generally available
|
|
6572
|
+
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
6546
6573
|
* @example
|
|
6547
6574
|
* ```js
|
|
6548
6575
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -6618,6 +6645,55 @@ export declare enum Action {
|
|
|
6618
6645
|
* @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
|
|
6619
6646
|
*/
|
|
6620
6647
|
LiveboardStylePanel = "liveboardStylePanel",
|
|
6648
|
+
/**
|
|
6649
|
+
* The **Publish** action for Liveboards, Answers and Models.
|
|
6650
|
+
* Opens the publishing modal. It's a parent action for the
|
|
6651
|
+
* **Manage Publishing** and **Unpublish** actions if the object
|
|
6652
|
+
* is already published, otherwise appears standalone.
|
|
6653
|
+
* @example
|
|
6654
|
+
* ```js
|
|
6655
|
+
* hiddenActions: [Action.Publish]
|
|
6656
|
+
* disabledActions: [Action.Publish]
|
|
6657
|
+
* ```
|
|
6658
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6659
|
+
*/
|
|
6660
|
+
Publish = "publish",
|
|
6661
|
+
/**
|
|
6662
|
+
* The **Manage Publishing** action for Liveboards, Answers and Models.
|
|
6663
|
+
* Opens the same publishing modal as the **Publish** action.
|
|
6664
|
+
* Appears as a child action to the **Publish** action if the
|
|
6665
|
+
* object is already published.
|
|
6666
|
+
* @example
|
|
6667
|
+
* ```js
|
|
6668
|
+
* hiddenActions: [Action.ManagePublishing]
|
|
6669
|
+
* disabledActions: [Action.ManagePublishing]
|
|
6670
|
+
* ```
|
|
6671
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6672
|
+
*/
|
|
6673
|
+
ManagePublishing = "managePublishing",
|
|
6674
|
+
/**
|
|
6675
|
+
* The **Unpublish** action for Liveboards, Answers and Models.
|
|
6676
|
+
* Opens the unpublishing modal. Appears as a child action to
|
|
6677
|
+
* the **Publish** action if the object is already published.
|
|
6678
|
+
* @example
|
|
6679
|
+
* ```js
|
|
6680
|
+
* hiddenActions: [Action.Unpublish]
|
|
6681
|
+
* disabledActions: [Action.Unpublish]
|
|
6682
|
+
* ```
|
|
6683
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6684
|
+
*/
|
|
6685
|
+
Unpublish = "unpublish",
|
|
6686
|
+
/**
|
|
6687
|
+
* The **Parameterize** action for Tables and Connections.
|
|
6688
|
+
* Opens the parameterization modal.
|
|
6689
|
+
* @example
|
|
6690
|
+
* ```js
|
|
6691
|
+
* hiddenActions: [Action.Parameterize]
|
|
6692
|
+
* disabledActions: [Action.Parameterize]
|
|
6693
|
+
* ```
|
|
6694
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6695
|
+
*/
|
|
6696
|
+
Parameterize = "parameterise",
|
|
6621
6697
|
/**
|
|
6622
6698
|
* The **Move to Group** menu action on a Liveboard.
|
|
6623
6699
|
* Allows moving a visualization to a different group.
|
|
@@ -6657,7 +6733,19 @@ export declare enum Action {
|
|
|
6657
6733
|
* ```
|
|
6658
6734
|
* @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6659
6735
|
*/
|
|
6660
|
-
UngroupLiveboardGroup = "ungroupLiveboardGroup"
|
|
6736
|
+
UngroupLiveboardGroup = "ungroupLiveboardGroup",
|
|
6737
|
+
/**
|
|
6738
|
+
* The **Include current period** checkbox for date filters.
|
|
6739
|
+
* Controls the visibility and availability of the option to include
|
|
6740
|
+
* the current time period in filter results.
|
|
6741
|
+
* @example
|
|
6742
|
+
* ```js
|
|
6743
|
+
* hiddenActions: [Action.IncludeCurrentPeriod]
|
|
6744
|
+
* disabledActions: [Action.IncludeCurrentPeriod]
|
|
6745
|
+
* ```
|
|
6746
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
6747
|
+
*/
|
|
6748
|
+
IncludeCurrentPeriod = "includeCurrentPeriod"
|
|
6661
6749
|
}
|
|
6662
6750
|
export declare enum PrefetchFeatures {
|
|
6663
6751
|
FullApp = "FullApp",
|
|
@@ -7763,6 +7851,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
7763
7851
|
* ... // other embed view config
|
|
7764
7852
|
* forceTable:true,
|
|
7765
7853
|
* })
|
|
7854
|
+
* ```
|
|
7766
7855
|
*/
|
|
7767
7856
|
forceTable?: boolean;
|
|
7768
7857
|
/**
|
|
@@ -8532,7 +8621,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8532
8621
|
* ```js
|
|
8533
8622
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
8534
8623
|
* ... // other embed view config
|
|
8535
|
-
* pageId
|
|
8624
|
+
* pageId: Page.Answers, // or Page.Data
|
|
8536
8625
|
* })
|
|
8537
8626
|
* ```
|
|
8538
8627
|
*/
|
|
@@ -8755,6 +8844,38 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8755
8844
|
* ```
|
|
8756
8845
|
*/
|
|
8757
8846
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
8847
|
+
/**
|
|
8848
|
+
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
8849
|
+
*
|
|
8850
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
8851
|
+
* @type {boolean}
|
|
8852
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8853
|
+
* @example
|
|
8854
|
+
* ```js
|
|
8855
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
8856
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
8857
|
+
* ... // other embed view config
|
|
8858
|
+
* isLiveboardXLSXCSVDownloadEnabled: true,
|
|
8859
|
+
* })
|
|
8860
|
+
* ```
|
|
8861
|
+
*/
|
|
8862
|
+
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
8863
|
+
/**
|
|
8864
|
+
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
8865
|
+
*
|
|
8866
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
8867
|
+
* @type {boolean}
|
|
8868
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8869
|
+
* @example
|
|
8870
|
+
* ```js
|
|
8871
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
8872
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
8873
|
+
* ... // other embed view config
|
|
8874
|
+
* isGranularXLSXCSVSchedulesEnabled: true,
|
|
8875
|
+
* })
|
|
8876
|
+
* ```
|
|
8877
|
+
*/
|
|
8878
|
+
isGranularXLSXCSVSchedulesEnabled?: boolean;
|
|
8758
8879
|
/**
|
|
8759
8880
|
* This flag is used to enable the full height lazy load data.
|
|
8760
8881
|
*
|
|
@@ -9224,6 +9345,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9224
9345
|
* ```
|
|
9225
9346
|
*/
|
|
9226
9347
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
9348
|
+
/**
|
|
9349
|
+
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
9350
|
+
*
|
|
9351
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9352
|
+
* @type {boolean}
|
|
9353
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9354
|
+
* @example
|
|
9355
|
+
* ```js
|
|
9356
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
9357
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
9358
|
+
* ... // other embed view config
|
|
9359
|
+
* isLiveboardXLSXCSVDownloadEnabled: true,
|
|
9360
|
+
* })
|
|
9361
|
+
* ```
|
|
9362
|
+
*/
|
|
9363
|
+
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
9364
|
+
/**
|
|
9365
|
+
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
9366
|
+
*
|
|
9367
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9368
|
+
* @type {boolean}
|
|
9369
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9370
|
+
* @example
|
|
9371
|
+
* ```js
|
|
9372
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
9373
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
9374
|
+
* ... // other embed view config
|
|
9375
|
+
* isGranularXLSXCSVSchedulesEnabled: true,
|
|
9376
|
+
* })
|
|
9377
|
+
* ```
|
|
9378
|
+
*/
|
|
9379
|
+
isGranularXLSXCSVSchedulesEnabled?: boolean;
|
|
9227
9380
|
/**
|
|
9228
9381
|
* This flag is used to enable the full height lazy load data.
|
|
9229
9382
|
*
|
|
@@ -9529,11 +9682,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9529
9682
|
runtimeFilters?: RuntimeFilter[];
|
|
9530
9683
|
/**
|
|
9531
9684
|
* Flag to control whether runtime filters should be included in the URL.
|
|
9532
|
-
* If true, filters will be passed via app initialization payload
|
|
9533
|
-
*
|
|
9685
|
+
* If true, filters will be passed via app initialization payload
|
|
9686
|
+
* (default behavior from SDK 1.45.0).
|
|
9687
|
+
* If false/undefined, filters are appended to the iframe URL instead.
|
|
9688
|
+
* (default behavior before SDK 1.45.0).
|
|
9534
9689
|
*
|
|
9535
9690
|
* Supported embed types: `SpotterEmbed`
|
|
9536
|
-
* @default
|
|
9691
|
+
* @default true
|
|
9537
9692
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9538
9693
|
*/
|
|
9539
9694
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
@@ -9558,11 +9713,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9558
9713
|
runtimeParameters?: RuntimeParameter[];
|
|
9559
9714
|
/**
|
|
9560
9715
|
* Flag to control whether runtime parameters should be included in the URL.
|
|
9561
|
-
* If true, parameters will be passed via app
|
|
9562
|
-
*
|
|
9716
|
+
* If true, parameters will be passed via app
|
|
9717
|
+
* initialization payload (default behavior from SDK 1.45.0).
|
|
9718
|
+
* If false/undefined, parameters are appended to
|
|
9719
|
+
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
9563
9720
|
*
|
|
9564
9721
|
* Supported embed types: `SpotterEmbed`
|
|
9565
|
-
* @default
|
|
9722
|
+
* @default true
|
|
9566
9723
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9567
9724
|
*/
|
|
9568
9725
|
excludeRuntimeParametersfromURL?: boolean;
|