@thoughtspot/visual-embed-sdk 1.44.4 → 1.44.5
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 +32 -0
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +7 -4
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +18 -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 +7 -4
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +46 -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.map +1 -1
- package/cjs/src/embed/search.js +6 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +2 -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 +140 -141
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +127 -117
- 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/dist/{index-C5FAW929.js → index-_2rRJf4J.js} +1 -1
- package/dist/src/embed/app.d.ts +32 -0
- 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.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +140 -141
- 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 +169 -135
- package/dist/tsembed-react.js +168 -134
- package/dist/tsembed.es.js +169 -135
- package/dist/tsembed.js +168 -134
- package/dist/visual-embed-sdk-react-full.d.ts +207 -129
- package/dist/visual-embed-sdk-react.d.ts +207 -129
- package/dist/visual-embed-sdk.d.ts +212 -146
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +32 -0
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +7 -4
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +18 -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 +7 -4
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +46 -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.map +1 -1
- package/lib/src/embed/search.js +6 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +2 -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 +140 -141
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +127 -117
- 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/package.json +1 -1
- package/src/embed/app.spec.ts +25 -7
- package/src/embed/app.ts +44 -5
- 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 +62 -42
- package/src/embed/liveboard.ts +42 -5
- package/src/embed/pinboard.spec.ts +1 -0
- package/src/embed/search.spec.ts +2 -0
- package/src/embed/search.ts +6 -1
- package/src/embed/ts-embed.spec.ts +1 -0
- package/src/embed/ts-embed.ts +7 -3
- package/src/types.ts +144 -144
- package/src/utils/graphql/answerService/answer-queries.ts +0 -1
- package/src/utils/graphql/answerService/answerService.spec.ts +0 -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;
|
|
@@ -2332,22 +2337,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2332
2337
|
* ```
|
|
2333
2338
|
*/
|
|
2334
2339
|
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
2340
|
/**
|
|
2352
2341
|
* This flag is used to enable or disable the new centralized Liveboard filter UX (v2).
|
|
2353
2342
|
* When enabled, a unified modal is used to manage and update multiple filters at once,
|
|
@@ -2568,7 +2557,11 @@ export declare enum HomepageModule {
|
|
|
2568
2557
|
*/
|
|
2569
2558
|
export declare enum ListPageColumns {
|
|
2570
2559
|
/**
|
|
2571
|
-
*
|
|
2560
|
+
* Favorites
|
|
2561
|
+
*/
|
|
2562
|
+
Favorites = "FAVOURITE",
|
|
2563
|
+
/**
|
|
2564
|
+
* @deprecated Use {@link ListPageColumns.Favorites} instead.
|
|
2572
2565
|
*/
|
|
2573
2566
|
Favourite = "FAVOURITE",
|
|
2574
2567
|
/**
|
|
@@ -2586,7 +2579,11 @@ export declare enum ListPageColumns {
|
|
|
2586
2579
|
/**
|
|
2587
2580
|
* Share
|
|
2588
2581
|
*/
|
|
2589
|
-
Share = "SHARE"
|
|
2582
|
+
Share = "SHARE",
|
|
2583
|
+
/**
|
|
2584
|
+
* Verified badge/column
|
|
2585
|
+
*/
|
|
2586
|
+
Verified = "VERIFIED"
|
|
2590
2587
|
}
|
|
2591
2588
|
/**
|
|
2592
2589
|
* A filter that can be applied to ThoughtSpot answers, Liveboards, or
|
|
@@ -2836,7 +2833,7 @@ export declare enum EmbedEvent {
|
|
|
2836
2833
|
/**
|
|
2837
2834
|
* An error has occurred. This event is fired for the following error types:
|
|
2838
2835
|
*
|
|
2839
|
-
* `API` - API call failure
|
|
2836
|
+
* `API` - API call failure.
|
|
2840
2837
|
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
2841
2838
|
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
2842
2839
|
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
@@ -3567,20 +3564,20 @@ export declare enum EmbedEvent {
|
|
|
3567
3564
|
/**
|
|
3568
3565
|
*
|
|
3569
3566
|
* This event can be emitted to intercept search execution initiated by
|
|
3570
|
-
*
|
|
3571
|
-
* You can
|
|
3567
|
+
* users and implement logic to allow or restrict search execution.
|
|
3568
|
+
* You can also show custom error text if the search query must be
|
|
3572
3569
|
* restricted due to your application or business requirements.
|
|
3573
3570
|
|
|
3574
3571
|
* Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
|
|
3575
3572
|
* for this embed event to get emitted.
|
|
3576
|
-
* @param
|
|
3577
|
-
*
|
|
3578
|
-
* Contains elements that
|
|
3579
|
-
*
|
|
3580
|
-
*
|
|
3573
|
+
* @param - Includes the following event listener parameters:
|
|
3574
|
+
* - `payload`: The payload received from the embed related to the Data API call.
|
|
3575
|
+
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
3576
|
+
* should run the search, and if not, what error message
|
|
3577
|
+
* should be shown to the user.
|
|
3581
3578
|
*
|
|
3582
|
-
* `execute` - When execute returns `true`, the search will be run.
|
|
3583
|
-
* When execute returns `false`, the search will not be executed.
|
|
3579
|
+
* `execute` - When `execute` returns `true`, the search will be run.
|
|
3580
|
+
* When `execute` returns `false`, the search will not be executed.
|
|
3584
3581
|
*
|
|
3585
3582
|
* `error` - Developers can customize the error message text when `execute`
|
|
3586
3583
|
* is `false` using the `errorText` and `errorDescription` parameters in responder.
|
|
@@ -3752,7 +3749,7 @@ export declare enum EmbedEvent {
|
|
|
3752
3749
|
* console.log('payload', payload);
|
|
3753
3750
|
* })
|
|
3754
3751
|
* ```
|
|
3755
|
-
* @version SDK: 1.
|
|
3752
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3756
3753
|
*/
|
|
3757
3754
|
DataModelInstructions = "DataModelInstructions",
|
|
3758
3755
|
/**
|
|
@@ -3970,14 +3967,14 @@ export declare enum HostEvent {
|
|
|
3970
3967
|
* the search query string.
|
|
3971
3968
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
3972
3969
|
* Includes the following properties:
|
|
3973
|
-
* @param -
|
|
3974
|
-
*
|
|
3975
|
-
*
|
|
3976
|
-
*
|
|
3977
|
-
*
|
|
3970
|
+
* @param - Includes the following keys:
|
|
3971
|
+
* - `searchQuery`: Query string with search tokens.
|
|
3972
|
+
* - `dataSources`: Data source GUID to search on.
|
|
3973
|
+
* Although an array, only a single source is supported.
|
|
3974
|
+
* - `execute`: Executes search and updates the existing query.
|
|
3978
3975
|
* @example
|
|
3979
3976
|
* ```js
|
|
3980
|
-
*
|
|
3977
|
+
* searchEmbed.trigger(HostEvent.Search, {
|
|
3981
3978
|
searchQuery: "[sales] by [item type]",
|
|
3982
3979
|
dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
|
|
3983
3980
|
execute: true
|
|
@@ -3988,16 +3985,15 @@ export declare enum HostEvent {
|
|
|
3988
3985
|
/**
|
|
3989
3986
|
* Triggers a drill on certain points of the specified column
|
|
3990
3987
|
* 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.
|
|
3988
|
+
* @param - Includes the following keys:
|
|
3989
|
+
* - `points`: An object containing `selectedPoints` and/or `clickedPoint`
|
|
3990
|
+
* to drill to. For example, `{ selectedPoints: [] }`.
|
|
3991
|
+
* - `columnGuid`: Optional. GUID of the column to drill by. If not provided,
|
|
3992
|
+
* it will auto drill by the configured column.
|
|
3993
|
+
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
3994
|
+
* on the most popular column.
|
|
3995
|
+
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
3996
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
4001
3997
|
* @example
|
|
4002
3998
|
* ```js
|
|
4003
3999
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -4090,14 +4086,12 @@ export declare enum HostEvent {
|
|
|
4090
4086
|
* and `AppEmbed` only. In full application embedding, this event updates
|
|
4091
4087
|
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
4092
4088
|
*
|
|
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.
|
|
4089
|
+
* @param - Array of {@link RuntimeFilter} objects. Each item includes:
|
|
4090
|
+
* - `columnName`: Name of the column to filter on.
|
|
4091
|
+
* - `operator`: {@link RuntimeFilterOp} to apply. For more information, see
|
|
4092
|
+
* link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
4093
|
+
* - `values`: List of operands. Some operators such as EQ and LE allow a single
|
|
4094
|
+
* value, whereas BW and IN accept multiple values.
|
|
4101
4095
|
*
|
|
4102
4096
|
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
4103
4097
|
* object to its original state and applies new filter conditions.
|
|
@@ -4120,7 +4114,7 @@ export declare enum HostEvent {
|
|
|
4120
4114
|
/**
|
|
4121
4115
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4122
4116
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
4123
|
-
* @param - `path` - the path to navigate to
|
|
4117
|
+
* @param - `path` - the path to navigate to go forward or back. The path value can
|
|
4124
4118
|
* be a number; for example, `1`, `-1`.
|
|
4125
4119
|
* @example
|
|
4126
4120
|
* ```js
|
|
@@ -4191,30 +4185,25 @@ export declare enum HostEvent {
|
|
|
4191
4185
|
* for the Answer that the user is currently on
|
|
4192
4186
|
* and a modal opens for Liveboard selection.
|
|
4193
4187
|
* To add an Answer or visualization to a Liveboard programmatically without
|
|
4194
|
-
*
|
|
4188
|
+
* requiring additional user input via the *Pin to Liveboard* modal, define
|
|
4195
4189
|
* the following parameters:
|
|
4196
4190
|
*
|
|
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.
|
|
4191
|
+
* @param - Includes the following keys:
|
|
4192
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
|
|
4193
|
+
* Optional when pinning a new chart or table generated from a Search query.
|
|
4194
|
+
* **Required** in Spotter Embed.
|
|
4195
|
+
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
4196
|
+
* specify the `newLiveboardName` parameter to create a new Liveboard.
|
|
4197
|
+
* - `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
|
|
4198
|
+
* specified in the code.
|
|
4199
|
+
* - `newVizName`: Name string for the Answer or visualization. If defined,
|
|
4200
|
+
* this parameter adds a new visualization object or creates a copy of the
|
|
4201
|
+
* Answer or visualization specified in `vizId`.
|
|
4202
|
+
* Required.
|
|
4203
|
+
* - `newLiveboardName`: Name string for the Liveboard.
|
|
4204
|
+
* Creates a new Liveboard object with the specified name.
|
|
4205
|
+
* - `newTabName`: Name of the tab. Adds a new tab Liveboard specified
|
|
4206
|
+
* in the code.
|
|
4218
4207
|
*
|
|
4219
4208
|
* @example
|
|
4220
4209
|
* ```js
|
|
@@ -4454,9 +4443,9 @@ export declare enum HostEvent {
|
|
|
4454
4443
|
* on a Liveboard.
|
|
4455
4444
|
*
|
|
4456
4445
|
* This event is not supported in visualization embed and search embed.
|
|
4457
|
-
* @param -
|
|
4458
|
-
*
|
|
4459
|
-
*
|
|
4446
|
+
* @param - Object parameter. Includes the following keys:
|
|
4447
|
+
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
4448
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
4460
4449
|
*
|
|
4461
4450
|
* @example
|
|
4462
4451
|
* ```js
|
|
@@ -4823,10 +4812,9 @@ export declare enum HostEvent {
|
|
|
4823
4812
|
GetFilters = "getFilters",
|
|
4824
4813
|
/**
|
|
4825
4814
|
* Update one or several filters applied on a Liveboard.
|
|
4826
|
-
* @param -
|
|
4827
|
-
* filter operator, and values.
|
|
4828
|
-
*
|
|
4829
|
-
* and values for each.
|
|
4815
|
+
* @param - Includes the following keys:
|
|
4816
|
+
* - `filter`: A single filter object containing column name, filter operator, and values.
|
|
4817
|
+
* - `filters`: Multiple filter objects with column name, filter operator, and values for each.
|
|
4830
4818
|
*
|
|
4831
4819
|
* Each filter object must include the following attributes:
|
|
4832
4820
|
*
|
|
@@ -4952,8 +4940,9 @@ export declare enum HostEvent {
|
|
|
4952
4940
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4953
4941
|
/**
|
|
4954
4942
|
* Updates the search query string for Natural Language Search operations.
|
|
4955
|
-
* @param -
|
|
4956
|
-
*
|
|
4943
|
+
* @param - Includes the following keys:
|
|
4944
|
+
* - `queryString`: Text string in Natural Language format.
|
|
4945
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
4957
4946
|
* @example
|
|
4958
4947
|
* ```js
|
|
4959
4948
|
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
@@ -5032,11 +5021,10 @@ export declare enum HostEvent {
|
|
|
5032
5021
|
/**
|
|
5033
5022
|
* Triggers an action to update Parameter values on embedded
|
|
5034
5023
|
* Answers, Liveboard, and Spotter answer in Edit mode.
|
|
5035
|
-
* @param -
|
|
5036
|
-
*
|
|
5037
|
-
*
|
|
5038
|
-
*
|
|
5039
|
-
* use the `isVisibleToUser` attribute when applying an override.
|
|
5024
|
+
* @param - Includes the following keys for each item:
|
|
5025
|
+
* - `name`: Name of the parameter.
|
|
5026
|
+
* - `value`: The value to set for the parameter.
|
|
5027
|
+
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
5040
5028
|
*
|
|
5041
5029
|
* @example
|
|
5042
5030
|
* ```js
|
|
@@ -5094,11 +5082,10 @@ export declare enum HostEvent {
|
|
|
5094
5082
|
* If no parameters are specified, the save action is
|
|
5095
5083
|
* triggered with a modal to prompt users to
|
|
5096
5084
|
* 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.
|
|
5085
|
+
* @param - Includes the following keys:
|
|
5086
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
|
|
5087
|
+
* - `name`: Optional. Name string for the Answer.
|
|
5088
|
+
* - `description`: Optional. Description text for the Answer.
|
|
5102
5089
|
* @example
|
|
5103
5090
|
* ```js
|
|
5104
5091
|
* const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
|
|
@@ -5147,8 +5134,9 @@ export declare enum HostEvent {
|
|
|
5147
5134
|
/**
|
|
5148
5135
|
* Triggers a search operation with the search tokens specified in
|
|
5149
5136
|
* the search query string in spotter embed.
|
|
5150
|
-
* @param -
|
|
5151
|
-
*
|
|
5137
|
+
* @param - Includes the following keys:
|
|
5138
|
+
* - `query`: Text string in Natural Language format.
|
|
5139
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
5152
5140
|
* @example
|
|
5153
5141
|
* ```js
|
|
5154
5142
|
* spotterEmbed.trigger(HostEvent.SpotterSearch, {
|
|
@@ -5195,7 +5183,7 @@ export declare enum HostEvent {
|
|
|
5195
5183
|
* ```js
|
|
5196
5184
|
* spotterEmbed.trigger(HostEvent.DataModelInstructions);
|
|
5197
5185
|
* ```
|
|
5198
|
-
* @version SDK: 1.
|
|
5186
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
5199
5187
|
*/
|
|
5200
5188
|
DataModelInstructions = "DataModelInstructions",
|
|
5201
5189
|
/**
|
|
@@ -5280,7 +5268,7 @@ export declare enum HostEvent {
|
|
|
5280
5268
|
*/
|
|
5281
5269
|
UpdateEmbedParams = "updateEmbedParams",
|
|
5282
5270
|
/**
|
|
5283
|
-
* Triggered when the embed
|
|
5271
|
+
* Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
|
|
5284
5272
|
* @example
|
|
5285
5273
|
* ```js
|
|
5286
5274
|
* liveboardEmbed.trigger(HostEvent.DestroyEmbed);
|
|
@@ -5288,11 +5276,12 @@ export declare enum HostEvent {
|
|
|
5288
5276
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
5289
5277
|
*/
|
|
5290
5278
|
DestroyEmbed = "EmbedDestroyed",
|
|
5291
|
-
/**
|
|
5292
|
-
*
|
|
5293
|
-
*
|
|
5279
|
+
/**
|
|
5280
|
+
* Triggers a new conversation in Spotter embed.
|
|
5281
|
+
*
|
|
5294
5282
|
* This feature is available only when chat history is enabled on your ThoughtSpot instance.
|
|
5295
5283
|
* Contact your admin or ThoughtSpot Support to enable chat history on your instance.
|
|
5284
|
+
*
|
|
5296
5285
|
* @example
|
|
5297
5286
|
* ```js
|
|
5298
5287
|
* spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
|
|
@@ -5326,7 +5315,7 @@ export declare enum HostEvent {
|
|
|
5326
5315
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
5327
5316
|
* })
|
|
5328
5317
|
* ```
|
|
5329
|
-
* See also link:https://developers.thoughtspot.com/docs/actions[
|
|
5318
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
|
|
5330
5319
|
*/
|
|
5331
5320
|
export declare enum Action {
|
|
5332
5321
|
/**
|
|
@@ -5613,6 +5602,16 @@ export declare enum Action {
|
|
|
5613
5602
|
* ```
|
|
5614
5603
|
*/
|
|
5615
5604
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
5605
|
+
/**
|
|
5606
|
+
* The **Download Liveboard** menu action on a Liveboard.
|
|
5607
|
+
* Allows downloading the entire Liveboard.
|
|
5608
|
+
* @example
|
|
5609
|
+
* ```js
|
|
5610
|
+
* disabledActions: [Action.DownloadLiveboard]
|
|
5611
|
+
* ```
|
|
5612
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
5613
|
+
*/
|
|
5614
|
+
DownloadLiveboard = "downloadLiveboard",
|
|
5616
5615
|
/**
|
|
5617
5616
|
* @hidden
|
|
5618
5617
|
*/
|
|
@@ -5952,28 +5951,28 @@ export declare enum Action {
|
|
|
5952
5951
|
CrossFilter = "context-menu-item-cross-filter",
|
|
5953
5952
|
/**
|
|
5954
5953
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5955
|
-
* Allows sending data to third-party apps Slack
|
|
5954
|
+
* Allows sending data to third-party apps like Slack.
|
|
5956
5955
|
* @example
|
|
5957
5956
|
* ```js
|
|
5958
5957
|
* disabledActions: [Action.SyncToSlack]
|
|
5959
5958
|
* ```
|
|
5960
|
-
* @version
|
|
5959
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5961
5960
|
*/
|
|
5962
5961
|
SyncToSlack = "syncToSlack",
|
|
5963
5962
|
/**
|
|
5964
5963
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5965
|
-
* Allows sending data to third-party apps
|
|
5964
|
+
* Allows sending data to third-party apps like Microsoft Teams.
|
|
5966
5965
|
* @example
|
|
5967
5966
|
* ```js
|
|
5968
5967
|
* disabledActions: [Action.SyncToTeams]
|
|
5969
5968
|
* ```
|
|
5970
|
-
* @version
|
|
5969
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5971
5970
|
*/
|
|
5972
5971
|
SyncToTeams = "syncToTeams",
|
|
5973
5972
|
/**
|
|
5974
5973
|
* The **Remove** action that appears when cross filters are applied
|
|
5975
5974
|
* on a Liveboard.
|
|
5976
|
-
* Removes filters applied
|
|
5975
|
+
* Removes filters applied to a visualization.
|
|
5977
5976
|
* @example
|
|
5978
5977
|
* ```js
|
|
5979
5978
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -6159,7 +6158,7 @@ export declare enum Action {
|
|
|
6159
6158
|
AddTab = "addTab",
|
|
6160
6159
|
/**
|
|
6161
6160
|
*
|
|
6162
|
-
*Initiates contextual change analysis on KPI charts.
|
|
6161
|
+
* Initiates contextual change analysis on KPI charts.
|
|
6163
6162
|
* @example
|
|
6164
6163
|
* ```js
|
|
6165
6164
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
@@ -6169,7 +6168,7 @@ export declare enum Action {
|
|
|
6169
6168
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
6170
6169
|
/**
|
|
6171
6170
|
* Action ID to hide or disable Iterative Change Analysis option
|
|
6172
|
-
*
|
|
6171
|
+
* in the contextual change analysis Insight charts context menu.
|
|
6173
6172
|
*
|
|
6174
6173
|
* @example
|
|
6175
6174
|
* ```js
|
|
@@ -6447,6 +6446,17 @@ export declare enum Action {
|
|
|
6447
6446
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
6448
6447
|
*/
|
|
6449
6448
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
6449
|
+
/**
|
|
6450
|
+
* The **Data model instructions** button on the Spotter interface.
|
|
6451
|
+
* Allows opening the data model instructions modal.
|
|
6452
|
+
*
|
|
6453
|
+
* @example
|
|
6454
|
+
* ```js
|
|
6455
|
+
* hiddenAction: [Action.DataModelInstructions]
|
|
6456
|
+
* ```
|
|
6457
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6458
|
+
*/
|
|
6459
|
+
DataModelInstructions = "DataModelInstructions",
|
|
6450
6460
|
/**
|
|
6451
6461
|
* The **Preview data** button on the Spotter interface.
|
|
6452
6462
|
* Allows previewing the data used for Spotter queries.
|
|
@@ -6532,12 +6542,12 @@ export declare enum Action {
|
|
|
6532
6542
|
*/
|
|
6533
6543
|
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
6534
6544
|
/**
|
|
6535
|
-
* Action ID
|
|
6536
|
-
*
|
|
6537
|
-
*
|
|
6538
|
-
*
|
|
6539
|
-
*
|
|
6540
|
-
|
|
6545
|
+
* Action ID to hide or disable the Spotter in the conversation training widget.
|
|
6546
|
+
* When disabled, users cannot access **Add to Coaching**, which allows adding reference
|
|
6547
|
+
* questions and business terms to improve Spotter’s responses.
|
|
6548
|
+
* The **Add to Coaching** feature is generally available from version 26.2.0.cl and
|
|
6549
|
+
* enabled by default on embed deployments.
|
|
6550
|
+
|
|
6541
6551
|
* @example
|
|
6542
6552
|
* ```js
|
|
6543
6553
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -8727,6 +8737,38 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8727
8737
|
* ```
|
|
8728
8738
|
*/
|
|
8729
8739
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
8740
|
+
/**
|
|
8741
|
+
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
8742
|
+
*
|
|
8743
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
8744
|
+
* @type {boolean}
|
|
8745
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8746
|
+
* @example
|
|
8747
|
+
* ```js
|
|
8748
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
8749
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
8750
|
+
* ... // other embed view config
|
|
8751
|
+
* isLiveboardXLSXCSVDownloadEnabled: true,
|
|
8752
|
+
* })
|
|
8753
|
+
* ```
|
|
8754
|
+
*/
|
|
8755
|
+
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
8756
|
+
/**
|
|
8757
|
+
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
8758
|
+
*
|
|
8759
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
8760
|
+
* @type {boolean}
|
|
8761
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8762
|
+
* @example
|
|
8763
|
+
* ```js
|
|
8764
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
8765
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
8766
|
+
* ... // other embed view config
|
|
8767
|
+
* isGranularXLSXCSVSchedulesEnabled: true,
|
|
8768
|
+
* })
|
|
8769
|
+
* ```
|
|
8770
|
+
*/
|
|
8771
|
+
isGranularXLSXCSVSchedulesEnabled?: boolean;
|
|
8730
8772
|
/**
|
|
8731
8773
|
* This flag is used to enable the full height lazy load data.
|
|
8732
8774
|
*
|
|
@@ -9196,6 +9238,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9196
9238
|
* ```
|
|
9197
9239
|
*/
|
|
9198
9240
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
9241
|
+
/**
|
|
9242
|
+
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
9243
|
+
*
|
|
9244
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9245
|
+
* @type {boolean}
|
|
9246
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9247
|
+
* @example
|
|
9248
|
+
* ```js
|
|
9249
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
9250
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
9251
|
+
* ... // other embed view config
|
|
9252
|
+
* isLiveboardXLSXCSVDownloadEnabled: true,
|
|
9253
|
+
* })
|
|
9254
|
+
* ```
|
|
9255
|
+
*/
|
|
9256
|
+
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
9257
|
+
/**
|
|
9258
|
+
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
9259
|
+
*
|
|
9260
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9261
|
+
* @type {boolean}
|
|
9262
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9263
|
+
* @example
|
|
9264
|
+
* ```js
|
|
9265
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
9266
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
9267
|
+
* ... // other embed view config
|
|
9268
|
+
* isGranularXLSXCSVSchedulesEnabled: true,
|
|
9269
|
+
* })
|
|
9270
|
+
* ```
|
|
9271
|
+
*/
|
|
9272
|
+
isGranularXLSXCSVSchedulesEnabled?: boolean;
|
|
9199
9273
|
/**
|
|
9200
9274
|
* This flag is used to enable the full height lazy load data.
|
|
9201
9275
|
*
|
|
@@ -9496,11 +9570,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9496
9570
|
runtimeFilters?: RuntimeFilter[];
|
|
9497
9571
|
/**
|
|
9498
9572
|
* Flag to control whether runtime filters should be included in the URL.
|
|
9499
|
-
* If true, filters will be passed via app initialization payload
|
|
9500
|
-
*
|
|
9573
|
+
* If true, filters will be passed via app initialization payload
|
|
9574
|
+
* (default behavior from SDK 1.45.0).
|
|
9575
|
+
* If false/undefined, filters are appended to the iframe URL instead.
|
|
9576
|
+
* (default behavior before SDK 1.45.0).
|
|
9501
9577
|
*
|
|
9502
9578
|
* Supported embed types: `SpotterEmbed`
|
|
9503
|
-
* @default
|
|
9579
|
+
* @default true
|
|
9504
9580
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9505
9581
|
*/
|
|
9506
9582
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
@@ -9525,11 +9601,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9525
9601
|
runtimeParameters?: RuntimeParameter[];
|
|
9526
9602
|
/**
|
|
9527
9603
|
* Flag to control whether runtime parameters should be included in the URL.
|
|
9528
|
-
* If true, parameters will be passed via app
|
|
9529
|
-
*
|
|
9604
|
+
* If true, parameters will be passed via app
|
|
9605
|
+
* initialization payload (default behavior from SDK 1.45.0).
|
|
9606
|
+
* If false/undefined, parameters are appended to
|
|
9607
|
+
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
9530
9608
|
*
|
|
9531
9609
|
* Supported embed types: `SpotterEmbed`
|
|
9532
|
-
* @default
|
|
9610
|
+
* @default true
|
|
9533
9611
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9534
9612
|
*/
|
|
9535
9613
|
excludeRuntimeParametersfromURL?: boolean;
|