@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
package/src/types.ts
CHANGED
|
@@ -355,7 +355,7 @@ export interface EmbedConfig {
|
|
|
355
355
|
/**
|
|
356
356
|
* [AuthServer] The trusted authentication endpoint to use to get the
|
|
357
357
|
* authentication token. A `GET` request is made to the
|
|
358
|
-
* authentication API endpoint, which
|
|
358
|
+
* authentication API endpoint, which returns the token
|
|
359
359
|
* as a plaintext response. For trusted authentication,
|
|
360
360
|
* the `authEndpoint` or `getAuthToken` attribute is required.
|
|
361
361
|
*/
|
|
@@ -478,13 +478,13 @@ export interface EmbedConfig {
|
|
|
478
478
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
479
479
|
* to start after the previous embed's render is complete. This helps improve
|
|
480
480
|
* performance by decreasing the load on the browser.
|
|
481
|
-
*
|
|
481
|
+
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
482
482
|
* @default false
|
|
483
483
|
*/
|
|
484
484
|
queueMultiRenders?: boolean;
|
|
485
485
|
|
|
486
486
|
/**
|
|
487
|
-
* [AuthServer|Basic] Detect if third-party
|
|
487
|
+
* [AuthServer|Basic] Detect if third-party cookies are enabled by doing an
|
|
488
488
|
* additional call. This is slower and should be avoided. Listen to the
|
|
489
489
|
* `NO_COOKIE_ACCESS` event to handle the situation.
|
|
490
490
|
*
|
|
@@ -1112,7 +1112,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1112
1112
|
* }
|
|
1113
1113
|
* ]
|
|
1114
1114
|
* })
|
|
1115
|
-
*
|
|
1115
|
+
*
|
|
1116
1116
|
* // to trigger a custom flow on custom action click listen to Custom action embed event
|
|
1117
1117
|
* embed.on(EmbedEvent.CustomAction, (payload: CustomActionPayload) => {
|
|
1118
1118
|
* console.log('Custom Action event:', payload);
|
|
@@ -1277,21 +1277,26 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1277
1277
|
/**
|
|
1278
1278
|
* Boolean to exclude runtimeFilters in the URL
|
|
1279
1279
|
* By default it is true, this flag removes runtime filters from the URL
|
|
1280
|
-
*
|
|
1280
|
+
* (default behavior from SDK 1.45.0).
|
|
1281
|
+
* when set to false, runtime filters will be included in the URL
|
|
1282
|
+
* (default behavior before SDK 1.45.0).
|
|
1281
1283
|
*
|
|
1282
1284
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
1283
1285
|
* embedded view.
|
|
1284
|
-
* @default
|
|
1286
|
+
* @default true
|
|
1285
1287
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
1286
1288
|
*/
|
|
1287
1289
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
1288
1290
|
/**
|
|
1289
1291
|
* Boolean to exclude runtimeParameters from the URL
|
|
1290
|
-
* when set to true, this flag removes runtime parameters from the URL
|
|
1292
|
+
* when set to true, this flag removes runtime parameters from the URL
|
|
1293
|
+
* (default behavior from SDK 1.45.0).
|
|
1294
|
+
* when set to false, runtime parameters will be included in the URL
|
|
1295
|
+
* (default behavior before SDK 1.45.0).
|
|
1291
1296
|
*
|
|
1292
1297
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
1293
1298
|
* embedded view.
|
|
1294
|
-
* @default
|
|
1299
|
+
* @default true
|
|
1295
1300
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
1296
1301
|
*/
|
|
1297
1302
|
excludeRuntimeParametersfromURL?: boolean;
|
|
@@ -1342,6 +1347,22 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1342
1347
|
* ```
|
|
1343
1348
|
*/
|
|
1344
1349
|
enableCustomColumnGroups?: boolean;
|
|
1350
|
+
/**
|
|
1351
|
+
* To enable **Include current period** checkbox for date filters.
|
|
1352
|
+
* Controls the visibility of the option to include
|
|
1353
|
+
* the current time period in filter results.
|
|
1354
|
+
*
|
|
1355
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1356
|
+
* @example
|
|
1357
|
+
* ```js
|
|
1358
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1359
|
+
* ... // other embed view config
|
|
1360
|
+
* isThisPeriodInDateFiltersEnabled: true,
|
|
1361
|
+
* })
|
|
1362
|
+
* ```
|
|
1363
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
1364
|
+
*/
|
|
1365
|
+
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
1345
1366
|
}
|
|
1346
1367
|
|
|
1347
1368
|
/**
|
|
@@ -1352,7 +1373,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1352
1373
|
* Show or hide Liveboard header
|
|
1353
1374
|
*
|
|
1354
1375
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1355
|
-
* @version SDK: 1.26.0 |
|
|
1376
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1356
1377
|
* @default false
|
|
1357
1378
|
* @example
|
|
1358
1379
|
* ```js
|
|
@@ -1368,7 +1389,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1368
1389
|
* Show or hide Liveboard title
|
|
1369
1390
|
*
|
|
1370
1391
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1371
|
-
* @version SDK: 1.26.0 |
|
|
1392
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1372
1393
|
* @default false
|
|
1373
1394
|
* @example
|
|
1374
1395
|
* ```js
|
|
@@ -1384,7 +1405,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1384
1405
|
* Show or hide Liveboard description
|
|
1385
1406
|
*
|
|
1386
1407
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1387
|
-
* @version SDK: 1.26.0 |
|
|
1408
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1388
1409
|
* @default false
|
|
1389
1410
|
* @example
|
|
1390
1411
|
* ```js
|
|
@@ -1408,7 +1429,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1408
1429
|
* isLiveboardHeaderSticky: true,
|
|
1409
1430
|
* });
|
|
1410
1431
|
* ```
|
|
1411
|
-
* @version SDK: 1.26.0 |
|
|
1432
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1412
1433
|
*/
|
|
1413
1434
|
isLiveboardHeaderSticky?: boolean;
|
|
1414
1435
|
/**
|
|
@@ -1502,7 +1523,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1502
1523
|
* enable or disable ask sage
|
|
1503
1524
|
*
|
|
1504
1525
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1505
|
-
* @version SDK: 1.29.0 |
|
|
1526
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.12.0.cl
|
|
1506
1527
|
* @default false
|
|
1507
1528
|
* @example
|
|
1508
1529
|
* ```js
|
|
@@ -1530,22 +1551,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1530
1551
|
* ```
|
|
1531
1552
|
*/
|
|
1532
1553
|
coverAndFilterOptionInPDF?: boolean;
|
|
1533
|
-
/**
|
|
1534
|
-
* This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
|
|
1535
|
-
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
1536
|
-
*
|
|
1537
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1538
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 26.3.0.cl
|
|
1539
|
-
* @example
|
|
1540
|
-
* ```js
|
|
1541
|
-
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
1542
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1543
|
-
* ... // other embed view config
|
|
1544
|
-
* liveboardXLSXCSVDownload: true,
|
|
1545
|
-
* })
|
|
1546
|
-
* ```
|
|
1547
|
-
*/
|
|
1548
|
-
liveboardXLSXCSVDownload?: boolean;
|
|
1549
1554
|
/**
|
|
1550
1555
|
* This flag is used to enable or disable the new centralized Liveboard filter UX (v2).
|
|
1551
1556
|
* When enabled, a unified modal is used to manage and update multiple filters at once,
|
|
@@ -1599,7 +1604,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1599
1604
|
* Show or hide masked filter chips
|
|
1600
1605
|
*
|
|
1601
1606
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1602
|
-
* @version SDK: 1.45.0 |
|
|
1607
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
1603
1608
|
* @default false
|
|
1604
1609
|
* @example
|
|
1605
1610
|
* ```js
|
|
@@ -1615,7 +1620,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1615
1620
|
* Enable or disable Liveboard styling and grouping
|
|
1616
1621
|
*
|
|
1617
1622
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1618
|
-
* @version SDK: 1.45.0 |
|
|
1623
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
1619
1624
|
* @default false
|
|
1620
1625
|
* @example
|
|
1621
1626
|
* ```js
|
|
@@ -1802,9 +1807,13 @@ export enum HomepageModule {
|
|
|
1802
1807
|
|
|
1803
1808
|
export enum ListPageColumns {
|
|
1804
1809
|
/**
|
|
1805
|
-
*
|
|
1810
|
+
* Favorites
|
|
1806
1811
|
*/
|
|
1807
|
-
|
|
1812
|
+
Favorites = 'FAVOURITE',
|
|
1813
|
+
/**
|
|
1814
|
+
* @deprecated Use {@link ListPageColumns.Favorites} instead.
|
|
1815
|
+
*/
|
|
1816
|
+
Favourite = Favorites,
|
|
1808
1817
|
/**
|
|
1809
1818
|
* Tags
|
|
1810
1819
|
*/
|
|
@@ -1821,6 +1830,10 @@ export enum ListPageColumns {
|
|
|
1821
1830
|
* Share
|
|
1822
1831
|
*/
|
|
1823
1832
|
Share = 'SHARE',
|
|
1833
|
+
/**
|
|
1834
|
+
* Verified badge/column
|
|
1835
|
+
*/
|
|
1836
|
+
Verified = 'VERIFIED',
|
|
1824
1837
|
}
|
|
1825
1838
|
|
|
1826
1839
|
/**
|
|
@@ -2073,7 +2086,7 @@ export enum EmbedEvent {
|
|
|
2073
2086
|
/**
|
|
2074
2087
|
* An error has occurred. This event is fired for the following error types:
|
|
2075
2088
|
*
|
|
2076
|
-
* `API` - API call failure
|
|
2089
|
+
* `API` - API call failure.
|
|
2077
2090
|
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
2078
2091
|
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
2079
2092
|
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
@@ -2806,24 +2819,24 @@ export enum EmbedEvent {
|
|
|
2806
2819
|
/**
|
|
2807
2820
|
*
|
|
2808
2821
|
* This event can be emitted to intercept search execution initiated by
|
|
2809
|
-
*
|
|
2810
|
-
* You can
|
|
2822
|
+
* users and implement logic to allow or restrict search execution.
|
|
2823
|
+
* You can also show custom error text if the search query must be
|
|
2811
2824
|
* restricted due to your application or business requirements.
|
|
2812
2825
|
|
|
2813
2826
|
* Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
|
|
2814
2827
|
* for this embed event to get emitted.
|
|
2815
|
-
* @param
|
|
2816
|
-
*
|
|
2817
|
-
* Contains elements that
|
|
2818
|
-
*
|
|
2819
|
-
*
|
|
2828
|
+
* @param - Includes the following event listener parameters:
|
|
2829
|
+
* - `payload`: The payload received from the embed related to the Data API call.
|
|
2830
|
+
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
2831
|
+
* should run the search, and if not, what error message
|
|
2832
|
+
* should be shown to the user.
|
|
2820
2833
|
*
|
|
2821
|
-
* `execute` - When execute returns `true`, the search will be run.
|
|
2822
|
-
* When execute returns `false`, the search will not be executed.
|
|
2834
|
+
* `execute` - When `execute` returns `true`, the search will be run.
|
|
2835
|
+
* When `execute` returns `false`, the search will not be executed.
|
|
2823
2836
|
*
|
|
2824
2837
|
* `error` - Developers can customize the error message text when `execute`
|
|
2825
2838
|
* is `false` using the `errorText` and `errorDescription` parameters in responder.
|
|
2826
|
-
*
|
|
2839
|
+
*
|
|
2827
2840
|
* `errorText` - The error message text to be shown to the user.
|
|
2828
2841
|
* `errorDescription (ThoughtSpot: 10.15.0.cl and above)` - The error description to be shown to the user.
|
|
2829
2842
|
* @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
@@ -2991,7 +3004,7 @@ export enum EmbedEvent {
|
|
|
2991
3004
|
* console.log('payload', payload);
|
|
2992
3005
|
* })
|
|
2993
3006
|
* ```
|
|
2994
|
-
* @version SDK: 1.
|
|
3007
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
2995
3008
|
*/
|
|
2996
3009
|
DataModelInstructions = 'DataModelInstructions',
|
|
2997
3010
|
/**
|
|
@@ -3211,14 +3224,14 @@ export enum HostEvent {
|
|
|
3211
3224
|
* the search query string.
|
|
3212
3225
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
3213
3226
|
* Includes the following properties:
|
|
3214
|
-
* @param -
|
|
3215
|
-
*
|
|
3216
|
-
*
|
|
3217
|
-
*
|
|
3218
|
-
*
|
|
3227
|
+
* @param - Includes the following keys:
|
|
3228
|
+
* - `searchQuery`: Query string with search tokens.
|
|
3229
|
+
* - `dataSources`: Data source GUID to search on.
|
|
3230
|
+
* Although an array, only a single source is supported.
|
|
3231
|
+
* - `execute`: Executes search and updates the existing query.
|
|
3219
3232
|
* @example
|
|
3220
3233
|
* ```js
|
|
3221
|
-
*
|
|
3234
|
+
* searchEmbed.trigger(HostEvent.Search, {
|
|
3222
3235
|
searchQuery: "[sales] by [item type]",
|
|
3223
3236
|
dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
|
|
3224
3237
|
execute: true
|
|
@@ -3229,16 +3242,15 @@ export enum HostEvent {
|
|
|
3229
3242
|
/**
|
|
3230
3243
|
* Triggers a drill on certain points of the specified column
|
|
3231
3244
|
* Includes the following properties:
|
|
3232
|
-
* @param -
|
|
3233
|
-
*
|
|
3234
|
-
*
|
|
3235
|
-
*
|
|
3236
|
-
* column.
|
|
3237
|
-
*
|
|
3238
|
-
*
|
|
3239
|
-
*
|
|
3240
|
-
*
|
|
3241
|
-
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
3245
|
+
* @param - Includes the following keys:
|
|
3246
|
+
* - `points`: An object containing `selectedPoints` and/or `clickedPoint`
|
|
3247
|
+
* to drill to. For example, `{ selectedPoints: [] }`.
|
|
3248
|
+
* - `columnGuid`: Optional. GUID of the column to drill by. If not provided,
|
|
3249
|
+
* it will auto drill by the configured column.
|
|
3250
|
+
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
3251
|
+
* on the most popular column.
|
|
3252
|
+
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
3253
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
3242
3254
|
* @example
|
|
3243
3255
|
* ```js
|
|
3244
3256
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -3331,14 +3343,12 @@ export enum HostEvent {
|
|
|
3331
3343
|
* and `AppEmbed` only. In full application embedding, this event updates
|
|
3332
3344
|
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
3333
3345
|
*
|
|
3334
|
-
* @param -
|
|
3335
|
-
* `columnName
|
|
3336
|
-
*
|
|
3337
|
-
*
|
|
3338
|
-
*
|
|
3339
|
-
*
|
|
3340
|
-
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
3341
|
-
* single value, whereas BW and IN accept multiple values.
|
|
3346
|
+
* @param - Array of {@link RuntimeFilter} objects. Each item includes:
|
|
3347
|
+
* - `columnName`: Name of the column to filter on.
|
|
3348
|
+
* - `operator`: {@link RuntimeFilterOp} to apply. For more information, see
|
|
3349
|
+
* link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
3350
|
+
* - `values`: List of operands. Some operators such as EQ and LE allow a single
|
|
3351
|
+
* value, whereas BW and IN accept multiple values.
|
|
3342
3352
|
*
|
|
3343
3353
|
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
3344
3354
|
* object to its original state and applies new filter conditions.
|
|
@@ -3361,7 +3371,7 @@ export enum HostEvent {
|
|
|
3361
3371
|
/**
|
|
3362
3372
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
3363
3373
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
3364
|
-
* @param - `path` - the path to navigate to
|
|
3374
|
+
* @param - `path` - the path to navigate to go forward or back. The path value can
|
|
3365
3375
|
* be a number; for example, `1`, `-1`.
|
|
3366
3376
|
* @example
|
|
3367
3377
|
* ```js
|
|
@@ -3432,30 +3442,25 @@ export enum HostEvent {
|
|
|
3432
3442
|
* for the Answer that the user is currently on
|
|
3433
3443
|
* and a modal opens for Liveboard selection.
|
|
3434
3444
|
* To add an Answer or visualization to a Liveboard programmatically without
|
|
3435
|
-
*
|
|
3445
|
+
* requiring additional user input via the *Pin to Liveboard* modal, define
|
|
3436
3446
|
* the following parameters:
|
|
3437
3447
|
*
|
|
3438
|
-
* @param
|
|
3439
|
-
* `vizId
|
|
3440
|
-
*
|
|
3441
|
-
*
|
|
3442
|
-
*
|
|
3443
|
-
* `
|
|
3444
|
-
*
|
|
3445
|
-
*
|
|
3446
|
-
*
|
|
3447
|
-
*
|
|
3448
|
-
*
|
|
3449
|
-
*
|
|
3450
|
-
*
|
|
3451
|
-
*
|
|
3452
|
-
*
|
|
3453
|
-
*
|
|
3454
|
-
* `newLiveboardName` - Name string for the Liveboard.
|
|
3455
|
-
* Creates a new Liveboard object with the specified name.
|
|
3456
|
-
* @param
|
|
3457
|
-
* `newTabName` - Name of the tab. Adds a new tab Liveboard specified
|
|
3458
|
-
* in the code.
|
|
3448
|
+
* @param - Includes the following keys:
|
|
3449
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
|
|
3450
|
+
* Optional when pinning a new chart or table generated from a Search query.
|
|
3451
|
+
* **Required** in Spotter Embed.
|
|
3452
|
+
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
3453
|
+
* specify the `newLiveboardName` parameter to create a new Liveboard.
|
|
3454
|
+
* - `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
|
|
3455
|
+
* specified in the code.
|
|
3456
|
+
* - `newVizName`: Name string for the Answer or visualization. If defined,
|
|
3457
|
+
* this parameter adds a new visualization object or creates a copy of the
|
|
3458
|
+
* Answer or visualization specified in `vizId`.
|
|
3459
|
+
* Required.
|
|
3460
|
+
* - `newLiveboardName`: Name string for the Liveboard.
|
|
3461
|
+
* Creates a new Liveboard object with the specified name.
|
|
3462
|
+
* - `newTabName`: Name of the tab. Adds a new tab Liveboard specified
|
|
3463
|
+
* in the code.
|
|
3459
3464
|
*
|
|
3460
3465
|
* @example
|
|
3461
3466
|
* ```js
|
|
@@ -3497,7 +3502,7 @@ export enum HostEvent {
|
|
|
3497
3502
|
*
|
|
3498
3503
|
* spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
|
|
3499
3504
|
* ```
|
|
3500
|
-
*
|
|
3505
|
+
*
|
|
3501
3506
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3502
3507
|
*/
|
|
3503
3508
|
Pin = 'pin',
|
|
@@ -3563,7 +3568,7 @@ export enum HostEvent {
|
|
|
3563
3568
|
* visualization or Answer.
|
|
3564
3569
|
*
|
|
3565
3570
|
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
3566
|
-
*
|
|
3571
|
+
*
|
|
3567
3572
|
* **NOTE**: The **Download** > **PDF** action is available on
|
|
3568
3573
|
* visualizations and Answers if the data is in tabular format.
|
|
3569
3574
|
* @example
|
|
@@ -3581,7 +3586,7 @@ export enum HostEvent {
|
|
|
3581
3586
|
*
|
|
3582
3587
|
* spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
|
|
3583
3588
|
* ```
|
|
3584
|
-
*
|
|
3589
|
+
*
|
|
3585
3590
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3586
3591
|
*/
|
|
3587
3592
|
DownloadAsPdf = 'downloadAsPdf',
|
|
@@ -3695,9 +3700,9 @@ export enum HostEvent {
|
|
|
3695
3700
|
* on a Liveboard.
|
|
3696
3701
|
*
|
|
3697
3702
|
* This event is not supported in visualization embed and search embed.
|
|
3698
|
-
* @param -
|
|
3699
|
-
*
|
|
3700
|
-
*
|
|
3703
|
+
* @param - Object parameter. Includes the following keys:
|
|
3704
|
+
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
3705
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
3701
3706
|
*
|
|
3702
3707
|
* @example
|
|
3703
3708
|
* ```js
|
|
@@ -4064,10 +4069,9 @@ export enum HostEvent {
|
|
|
4064
4069
|
GetFilters = 'getFilters',
|
|
4065
4070
|
/**
|
|
4066
4071
|
* Update one or several filters applied on a Liveboard.
|
|
4067
|
-
* @param -
|
|
4068
|
-
* filter operator, and values.
|
|
4069
|
-
*
|
|
4070
|
-
* and values for each.
|
|
4072
|
+
* @param - Includes the following keys:
|
|
4073
|
+
* - `filter`: A single filter object containing column name, filter operator, and values.
|
|
4074
|
+
* - `filters`: Multiple filter objects with column name, filter operator, and values for each.
|
|
4071
4075
|
*
|
|
4072
4076
|
* Each filter object must include the following attributes:
|
|
4073
4077
|
*
|
|
@@ -4193,8 +4197,9 @@ export enum HostEvent {
|
|
|
4193
4197
|
SetHiddenTabs = 'SetPinboardHiddenTabs',
|
|
4194
4198
|
/**
|
|
4195
4199
|
* Updates the search query string for Natural Language Search operations.
|
|
4196
|
-
* @param -
|
|
4197
|
-
*
|
|
4200
|
+
* @param - Includes the following keys:
|
|
4201
|
+
* - `queryString`: Text string in Natural Language format.
|
|
4202
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
4198
4203
|
* @example
|
|
4199
4204
|
* ```js
|
|
4200
4205
|
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
@@ -4273,11 +4278,10 @@ export enum HostEvent {
|
|
|
4273
4278
|
/**
|
|
4274
4279
|
* Triggers an action to update Parameter values on embedded
|
|
4275
4280
|
* Answers, Liveboard, and Spotter answer in Edit mode.
|
|
4276
|
-
* @param -
|
|
4277
|
-
*
|
|
4278
|
-
*
|
|
4279
|
-
*
|
|
4280
|
-
* use the `isVisibleToUser` attribute when applying an override.
|
|
4281
|
+
* @param - Includes the following keys for each item:
|
|
4282
|
+
* - `name`: Name of the parameter.
|
|
4283
|
+
* - `value`: The value to set for the parameter.
|
|
4284
|
+
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
4281
4285
|
*
|
|
4282
4286
|
* @example
|
|
4283
4287
|
* ```js
|
|
@@ -4335,11 +4339,10 @@ export enum HostEvent {
|
|
|
4335
4339
|
* If no parameters are specified, the save action is
|
|
4336
4340
|
* triggered with a modal to prompt users to
|
|
4337
4341
|
* add a name and description for the Answer.
|
|
4338
|
-
* @param -
|
|
4339
|
-
* and is required in Spotter embed.
|
|
4340
|
-
* Optional
|
|
4341
|
-
*
|
|
4342
|
-
* @param - `description` - Description text for the Answer.
|
|
4342
|
+
* @param - Includes the following keys:
|
|
4343
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
|
|
4344
|
+
* - `name`: Optional. Name string for the Answer.
|
|
4345
|
+
* - `description`: Optional. Description text for the Answer.
|
|
4343
4346
|
* @example
|
|
4344
4347
|
* ```js
|
|
4345
4348
|
* const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
|
|
@@ -4388,8 +4391,9 @@ export enum HostEvent {
|
|
|
4388
4391
|
/**
|
|
4389
4392
|
* Triggers a search operation with the search tokens specified in
|
|
4390
4393
|
* the search query string in spotter embed.
|
|
4391
|
-
* @param -
|
|
4392
|
-
*
|
|
4394
|
+
* @param - Includes the following keys:
|
|
4395
|
+
* - `query`: Text string in Natural Language format.
|
|
4396
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
4393
4397
|
* @example
|
|
4394
4398
|
* ```js
|
|
4395
4399
|
* spotterEmbed.trigger(HostEvent.SpotterSearch, {
|
|
@@ -4425,7 +4429,7 @@ export enum HostEvent {
|
|
|
4425
4429
|
* @example
|
|
4426
4430
|
* ```js
|
|
4427
4431
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
4428
|
-
*
|
|
4432
|
+
*
|
|
4429
4433
|
*```
|
|
4430
4434
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
4431
4435
|
*/
|
|
@@ -4436,7 +4440,7 @@ export enum HostEvent {
|
|
|
4436
4440
|
* ```js
|
|
4437
4441
|
* spotterEmbed.trigger(HostEvent.DataModelInstructions);
|
|
4438
4442
|
* ```
|
|
4439
|
-
* @version SDK: 1.
|
|
4443
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4440
4444
|
*/
|
|
4441
4445
|
DataModelInstructions = 'DataModelInstructions',
|
|
4442
4446
|
/**
|
|
@@ -4522,7 +4526,7 @@ export enum HostEvent {
|
|
|
4522
4526
|
*/
|
|
4523
4527
|
UpdateEmbedParams = 'updateEmbedParams',
|
|
4524
4528
|
/**
|
|
4525
|
-
* Triggered when the embed
|
|
4529
|
+
* Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
|
|
4526
4530
|
* @example
|
|
4527
4531
|
* ```js
|
|
4528
4532
|
* liveboardEmbed.trigger(HostEvent.DestroyEmbed);
|
|
@@ -4530,11 +4534,12 @@ export enum HostEvent {
|
|
|
4530
4534
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
4531
4535
|
*/
|
|
4532
4536
|
DestroyEmbed = 'EmbedDestroyed',
|
|
4533
|
-
/**
|
|
4534
|
-
*
|
|
4535
|
-
*
|
|
4537
|
+
/**
|
|
4538
|
+
* Triggers a new conversation in Spotter embed.
|
|
4539
|
+
*
|
|
4536
4540
|
* This feature is available only when chat history is enabled on your ThoughtSpot instance.
|
|
4537
4541
|
* Contact your admin or ThoughtSpot Support to enable chat history on your instance.
|
|
4542
|
+
*
|
|
4538
4543
|
* @example
|
|
4539
4544
|
* ```js
|
|
4540
4545
|
* spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
|
|
@@ -4693,12 +4698,14 @@ export enum Param {
|
|
|
4693
4698
|
IsLiveboardStylingAndGroupingEnabled = 'isLiveboardStylingAndGroupingEnabled',
|
|
4694
4699
|
IsLazyLoadingForEmbedEnabled = 'isLazyLoadingForEmbedEnabled',
|
|
4695
4700
|
RootMarginForLazyLoad = 'rootMarginForLazyLoad',
|
|
4696
|
-
LiveboardXLSXCSVDownload = 'isLiveboardXLSXCSVDownloadEnabled',
|
|
4697
4701
|
isPNGInScheduledEmailsEnabled = 'isPNGInScheduledEmailsEnabled',
|
|
4702
|
+
isLiveboardXLSXCSVDownloadEnabled = 'isLiveboardXLSXCSVDownloadEnabled',
|
|
4703
|
+
isGranularXLSXCSVSchedulesEnabled = 'isGranularXLSXCSVSchedulesEnabled',
|
|
4698
4704
|
isCentralizedLiveboardFilterUXEnabled = 'isCentralizedLiveboardFilterUXEnabled',
|
|
4699
4705
|
isLinkParametersEnabled = 'isLinkParametersEnabled',
|
|
4700
4706
|
EnablePastConversationsSidebar = 'enablePastConversationsSidebar',
|
|
4701
4707
|
UpdatedSpotterChatPrompt = 'updatedSpotterChatPrompt',
|
|
4708
|
+
IsThisPeriodInDateFiltersEnabled = 'isThisPeriodInDateFiltersEnabled',
|
|
4702
4709
|
}
|
|
4703
4710
|
|
|
4704
4711
|
/**
|
|
@@ -4712,7 +4719,7 @@ export enum Param {
|
|
|
4712
4719
|
* ```js
|
|
4713
4720
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
4714
4721
|
* ... //other embed view config
|
|
4715
|
-
* visibleActions: [Action.Save, Action.Edit, Action.Present,
|
|
4722
|
+
* visibleActions: [Action.Save, Action.Edit, Action.Present, Action.Explore],
|
|
4716
4723
|
* disabledActions: [Action.Download],
|
|
4717
4724
|
* //hiddenActions: [], // Set either this or visibleActions
|
|
4718
4725
|
* })
|
|
@@ -4723,10 +4730,10 @@ export enum Param {
|
|
|
4723
4730
|
* ... //other embed view config
|
|
4724
4731
|
* //visibleActions: [],
|
|
4725
4732
|
* disabledActions: [Action.Download],
|
|
4726
|
-
* hiddenActions: [Action.Edit,
|
|
4733
|
+
* hiddenActions: [Action.Edit, Action.Explore],
|
|
4727
4734
|
* })
|
|
4728
4735
|
* ```
|
|
4729
|
-
* See also link:https://developers.thoughtspot.com/docs/actions[
|
|
4736
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
|
|
4730
4737
|
*/
|
|
4731
4738
|
|
|
4732
4739
|
export enum Action {
|
|
@@ -5014,6 +5021,16 @@ export enum Action {
|
|
|
5014
5021
|
* ```
|
|
5015
5022
|
*/
|
|
5016
5023
|
DownloadAsXlsx = 'downloadAsXLSX',
|
|
5024
|
+
/**
|
|
5025
|
+
* The **Download Liveboard** menu action on a Liveboard.
|
|
5026
|
+
* Allows downloading the entire Liveboard.
|
|
5027
|
+
* @example
|
|
5028
|
+
* ```js
|
|
5029
|
+
* disabledActions: [Action.DownloadLiveboard]
|
|
5030
|
+
* ```
|
|
5031
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
5032
|
+
*/
|
|
5033
|
+
DownloadLiveboard = 'downloadLiveboard',
|
|
5017
5034
|
/**
|
|
5018
5035
|
* @hidden
|
|
5019
5036
|
*/
|
|
@@ -5234,13 +5251,15 @@ export enum Action {
|
|
|
5234
5251
|
*/
|
|
5235
5252
|
RequestAccess = 'requestAccess',
|
|
5236
5253
|
/**
|
|
5237
|
-
*
|
|
5238
|
-
* Query details panel
|
|
5254
|
+
* Controls the display and availability of the **Query visualizer** and
|
|
5255
|
+
* **Query SQL** buttons in the Query details panel on the Answer page.
|
|
5239
5256
|
*
|
|
5240
|
-
* **Query visualizer** - Displays the tables
|
|
5241
|
-
*
|
|
5242
|
-
*
|
|
5243
|
-
*
|
|
5257
|
+
* **Query visualizer** - Displays the tables and filters used in the search query.
|
|
5258
|
+
* **Query SQL** - Displays the SQL statements used to retrieve data for the query.
|
|
5259
|
+
*
|
|
5260
|
+
* Note: This action ID only affects the visibility of the buttons within the
|
|
5261
|
+
* Query details panel. It does not control the visibility
|
|
5262
|
+
* of the query details icon on the Answer page.
|
|
5244
5263
|
* @example
|
|
5245
5264
|
* ```js
|
|
5246
5265
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5354,28 +5373,28 @@ export enum Action {
|
|
|
5354
5373
|
CrossFilter = 'context-menu-item-cross-filter',
|
|
5355
5374
|
/**
|
|
5356
5375
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5357
|
-
* Allows sending data to third-party apps Slack
|
|
5376
|
+
* Allows sending data to third-party apps like Slack.
|
|
5358
5377
|
* @example
|
|
5359
5378
|
* ```js
|
|
5360
5379
|
* disabledActions: [Action.SyncToSlack]
|
|
5361
5380
|
* ```
|
|
5362
|
-
* @version
|
|
5381
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5363
5382
|
*/
|
|
5364
5383
|
SyncToSlack = 'syncToSlack',
|
|
5365
5384
|
/**
|
|
5366
5385
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5367
|
-
* Allows sending data to third-party apps
|
|
5386
|
+
* Allows sending data to third-party apps like Microsoft Teams.
|
|
5368
5387
|
* @example
|
|
5369
5388
|
* ```js
|
|
5370
5389
|
* disabledActions: [Action.SyncToTeams]
|
|
5371
5390
|
* ```
|
|
5372
|
-
* @version
|
|
5391
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5373
5392
|
*/
|
|
5374
5393
|
SyncToTeams = 'syncToTeams',
|
|
5375
5394
|
/**
|
|
5376
5395
|
* The **Remove** action that appears when cross filters are applied
|
|
5377
5396
|
* on a Liveboard.
|
|
5378
|
-
* Removes filters applied
|
|
5397
|
+
* Removes filters applied to a visualization.
|
|
5379
5398
|
* @example
|
|
5380
5399
|
* ```js
|
|
5381
5400
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -5561,7 +5580,7 @@ export enum Action {
|
|
|
5561
5580
|
AddTab = 'addTab',
|
|
5562
5581
|
/**
|
|
5563
5582
|
*
|
|
5564
|
-
*Initiates contextual change analysis on KPI charts.
|
|
5583
|
+
* Initiates contextual change analysis on KPI charts.
|
|
5565
5584
|
* @example
|
|
5566
5585
|
* ```js
|
|
5567
5586
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
@@ -5571,7 +5590,7 @@ export enum Action {
|
|
|
5571
5590
|
EnableContextualChangeAnalysis = 'enableContextualChangeAnalysis',
|
|
5572
5591
|
/**
|
|
5573
5592
|
* Action ID to hide or disable Iterative Change Analysis option
|
|
5574
|
-
*
|
|
5593
|
+
* in the contextual change analysis Insight charts context menu.
|
|
5575
5594
|
*
|
|
5576
5595
|
* @example
|
|
5577
5596
|
* ```js
|
|
@@ -5864,6 +5883,18 @@ export enum Action {
|
|
|
5864
5883
|
*/
|
|
5865
5884
|
ChangeFilterVisibilityInTab = 'changeFilterVisibilityInTab',
|
|
5866
5885
|
|
|
5886
|
+
/**
|
|
5887
|
+
* The **Data model instructions** button on the Spotter interface.
|
|
5888
|
+
* Allows opening the data model instructions modal.
|
|
5889
|
+
*
|
|
5890
|
+
* @example
|
|
5891
|
+
* ```js
|
|
5892
|
+
* hiddenAction: [Action.DataModelInstructions]
|
|
5893
|
+
* ```
|
|
5894
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
5895
|
+
*/
|
|
5896
|
+
DataModelInstructions = 'DataModelInstructions',
|
|
5897
|
+
|
|
5867
5898
|
/**
|
|
5868
5899
|
* The **Preview data** button on the Spotter interface.
|
|
5869
5900
|
* Allows previewing the data used for Spotter queries.
|
|
@@ -5950,12 +5981,11 @@ export enum Action {
|
|
|
5950
5981
|
*/
|
|
5951
5982
|
CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
|
|
5952
5983
|
/**
|
|
5953
|
-
|
|
5954
|
-
|
|
5955
|
-
|
|
5956
|
-
|
|
5957
|
-
|
|
5958
|
-
* contact ThoughtSpot Support.
|
|
5984
|
+
* Action ID to hide or disable the Coaching workflow in Spotter conversations.
|
|
5985
|
+
* When disabled, users cannot access **Add to Coaching** workflow in conversation.
|
|
5986
|
+
* The **Add to Coaching** feature allows adding reference questions and
|
|
5987
|
+
* business terms to improve Spotter’s responses. This feature is generally available
|
|
5988
|
+
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
5959
5989
|
* @example
|
|
5960
5990
|
* ```js
|
|
5961
5991
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -6031,6 +6061,55 @@ export enum Action {
|
|
|
6031
6061
|
* @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
|
|
6032
6062
|
*/
|
|
6033
6063
|
LiveboardStylePanel = 'liveboardStylePanel',
|
|
6064
|
+
/**
|
|
6065
|
+
* The **Publish** action for Liveboards, Answers and Models.
|
|
6066
|
+
* Opens the publishing modal. It's a parent action for the
|
|
6067
|
+
* **Manage Publishing** and **Unpublish** actions if the object
|
|
6068
|
+
* is already published, otherwise appears standalone.
|
|
6069
|
+
* @example
|
|
6070
|
+
* ```js
|
|
6071
|
+
* hiddenActions: [Action.Publish]
|
|
6072
|
+
* disabledActions: [Action.Publish]
|
|
6073
|
+
* ```
|
|
6074
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6075
|
+
*/
|
|
6076
|
+
Publish = 'publish',
|
|
6077
|
+
/**
|
|
6078
|
+
* The **Manage Publishing** action for Liveboards, Answers and Models.
|
|
6079
|
+
* Opens the same publishing modal as the **Publish** action.
|
|
6080
|
+
* Appears as a child action to the **Publish** action if the
|
|
6081
|
+
* object is already published.
|
|
6082
|
+
* @example
|
|
6083
|
+
* ```js
|
|
6084
|
+
* hiddenActions: [Action.ManagePublishing]
|
|
6085
|
+
* disabledActions: [Action.ManagePublishing]
|
|
6086
|
+
* ```
|
|
6087
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6088
|
+
*/
|
|
6089
|
+
ManagePublishing = 'managePublishing',
|
|
6090
|
+
/**
|
|
6091
|
+
* The **Unpublish** action for Liveboards, Answers and Models.
|
|
6092
|
+
* Opens the unpublishing modal. Appears as a child action to
|
|
6093
|
+
* the **Publish** action if the object is already published.
|
|
6094
|
+
* @example
|
|
6095
|
+
* ```js
|
|
6096
|
+
* hiddenActions: [Action.Unpublish]
|
|
6097
|
+
* disabledActions: [Action.Unpublish]
|
|
6098
|
+
* ```
|
|
6099
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6100
|
+
*/
|
|
6101
|
+
Unpublish = 'unpublish',
|
|
6102
|
+
/**
|
|
6103
|
+
* The **Parameterize** action for Tables and Connections.
|
|
6104
|
+
* Opens the parameterization modal.
|
|
6105
|
+
* @example
|
|
6106
|
+
* ```js
|
|
6107
|
+
* hiddenActions: [Action.Parameterize]
|
|
6108
|
+
* disabledActions: [Action.Parameterize]
|
|
6109
|
+
* ```
|
|
6110
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6111
|
+
*/
|
|
6112
|
+
Parameterize = 'parameterise',
|
|
6034
6113
|
/**
|
|
6035
6114
|
* The **Move to Group** menu action on a Liveboard.
|
|
6036
6115
|
* Allows moving a visualization to a different group.
|
|
@@ -6071,6 +6150,18 @@ export enum Action {
|
|
|
6071
6150
|
* @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6072
6151
|
*/
|
|
6073
6152
|
UngroupLiveboardGroup = 'ungroupLiveboardGroup',
|
|
6153
|
+
/**
|
|
6154
|
+
* The **Include current period** checkbox for date filters.
|
|
6155
|
+
* Controls the visibility and availability of the option to include
|
|
6156
|
+
* the current time period in filter results.
|
|
6157
|
+
* @example
|
|
6158
|
+
* ```js
|
|
6159
|
+
* hiddenActions: [Action.IncludeCurrentPeriod]
|
|
6160
|
+
* disabledActions: [Action.IncludeCurrentPeriod]
|
|
6161
|
+
* ```
|
|
6162
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
6163
|
+
*/
|
|
6164
|
+
IncludeCurrentPeriod = 'includeCurrentPeriod',
|
|
6074
6165
|
}
|
|
6075
6166
|
export interface AnswerServiceType {
|
|
6076
6167
|
getAnswer?: (offset: number, batchSize: number) => any;
|
|
@@ -6267,11 +6358,11 @@ export enum LogLevel {
|
|
|
6267
6358
|
|
|
6268
6359
|
/**
|
|
6269
6360
|
* Error types emitted by embedded components.
|
|
6270
|
-
*
|
|
6361
|
+
*
|
|
6271
6362
|
* These enum values categorize different types of errors that can occur during
|
|
6272
6363
|
* the lifecycle of an embedded ThoughtSpot component. Use these values to implement
|
|
6273
6364
|
* specific error handling logic based on the error category.
|
|
6274
|
-
*
|
|
6365
|
+
*
|
|
6275
6366
|
* @see {@link EmbedErrorDetailsEvent} - The error event object structure
|
|
6276
6367
|
* @see {@link EmbedEvent.Error} - The event that emits these errors
|
|
6277
6368
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
@@ -6287,31 +6378,19 @@ export enum ErrorDetailsTypes {
|
|
|
6287
6378
|
}
|
|
6288
6379
|
|
|
6289
6380
|
/**
|
|
6290
|
-
*
|
|
6291
|
-
*
|
|
6292
|
-
*
|
|
6293
|
-
*
|
|
6294
|
-
*
|
|
6295
|
-
*
|
|
6296
|
-
* The codes are organized into categories:
|
|
6297
|
-
* - **Worksheet ID not found or does not exist**: Errors related to applying or updating filters
|
|
6298
|
-
* - **Liveboard ID missing**: Errors related to missing liveboard ID
|
|
6299
|
-
* - **Conflicting actions configuration**: Errors related to conflicting actions configuration
|
|
6300
|
-
* - **Conflicting tabs configuration**: Errors related to conflicting tabs configuration
|
|
6301
|
-
* - **Initialization error**: Errors related to initialization error
|
|
6302
|
-
* - **Network error**: Errors related to network error
|
|
6303
|
-
* - **Custom action validation**: Errors related to custom action validation
|
|
6304
|
-
* - **Login failed**: Errors related to login failed
|
|
6305
|
-
* - **Render not called**: Errors related to render not called
|
|
6306
|
-
* - **Host event type undefined or invalid**: Errors related to host event type undefined or invalid
|
|
6307
|
-
*
|
|
6381
|
+
* Error codes for identifying specific issues in embedded ThoughtSpot components.
|
|
6382
|
+
*
|
|
6383
|
+
* Use these codes for precise error handling and debugging. Each code maps to a
|
|
6384
|
+
* distinct failure scenario, enabling targeted recovery strategies.
|
|
6385
|
+
*
|
|
6308
6386
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
6309
6387
|
* @group Error Handling
|
|
6388
|
+
*
|
|
6310
6389
|
* @see {@link EmbedErrorDetailsEvent} - The error event object that includes these codes
|
|
6311
6390
|
* @see {@link ErrorDetailsTypes} - General error type categories
|
|
6312
|
-
*
|
|
6391
|
+
*
|
|
6313
6392
|
* @example
|
|
6314
|
-
* Handle specific error codes
|
|
6393
|
+
* Handle specific error codes in the error event handler
|
|
6315
6394
|
*
|
|
6316
6395
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
6317
6396
|
* if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {
|
|
@@ -6322,31 +6401,31 @@ export enum ErrorDetailsTypes {
|
|
|
6322
6401
|
export enum EmbedErrorCodes {
|
|
6323
6402
|
/** Worksheet ID not found or does not exist */
|
|
6324
6403
|
WORKSHEET_ID_NOT_FOUND = 'WORKSHEET_ID_NOT_FOUND',
|
|
6325
|
-
|
|
6404
|
+
|
|
6326
6405
|
/** Required Liveboard ID is missing from configuration */
|
|
6327
6406
|
LIVEBOARD_ID_MISSING = 'LIVEBOARD_ID_MISSING',
|
|
6328
|
-
|
|
6407
|
+
|
|
6329
6408
|
/** Conflicting action configuration detected (e.g., both hiddenActions and visibleActions specified) */
|
|
6330
6409
|
CONFLICTING_ACTIONS_CONFIG = 'CONFLICTING_ACTIONS_CONFIG',
|
|
6331
|
-
|
|
6410
|
+
|
|
6332
6411
|
/** Conflicting tab configuration detected (e.g., both hiddenTabs and visibleTabs specified) */
|
|
6333
6412
|
CONFLICTING_TABS_CONFIG = 'CONFLICTING_TABS_CONFIG',
|
|
6334
|
-
|
|
6413
|
+
|
|
6335
6414
|
/** Error during component initialization */
|
|
6336
6415
|
INIT_ERROR = 'INIT_ERROR',
|
|
6337
|
-
|
|
6416
|
+
|
|
6338
6417
|
/** Network connectivity or request error */
|
|
6339
6418
|
NETWORK_ERROR = 'NETWORK_ERROR',
|
|
6340
|
-
|
|
6419
|
+
|
|
6341
6420
|
/** Custom action validation failed */
|
|
6342
6421
|
CUSTOM_ACTION_VALIDATION = 'CUSTOM_ACTION_VALIDATION',
|
|
6343
|
-
|
|
6422
|
+
|
|
6344
6423
|
/** Authentication/login failed */
|
|
6345
6424
|
LOGIN_FAILED = 'LOGIN_FAILED',
|
|
6346
|
-
|
|
6425
|
+
|
|
6347
6426
|
/** Render method was not called before attempting to use the component */
|
|
6348
6427
|
RENDER_NOT_CALLED = 'RENDER_NOT_CALLED',
|
|
6349
|
-
|
|
6428
|
+
|
|
6350
6429
|
/** Host event type is undefined or invalid */
|
|
6351
6430
|
HOST_EVENT_TYPE_UNDEFINED = 'HOST_EVENT_TYPE_UNDEFINED',
|
|
6352
6431
|
|
|
@@ -6365,14 +6444,14 @@ export enum EmbedErrorCodes {
|
|
|
6365
6444
|
* a human-readable message, and a machine-readable error code.
|
|
6366
6445
|
*
|
|
6367
6446
|
* ## Properties
|
|
6368
|
-
*
|
|
6447
|
+
*
|
|
6369
6448
|
* - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
|
|
6370
6449
|
* - **message**: Human-readable error description (string or array of strings for multiple errors)
|
|
6371
6450
|
* - **code**: Machine-readable error identifier for programmatic handling
|
|
6372
6451
|
* - **[key: string]**: Additional context-specific for backward compatibility
|
|
6373
6452
|
*
|
|
6374
6453
|
* ## Usage
|
|
6375
|
-
*
|
|
6454
|
+
*
|
|
6376
6455
|
* Listen to the {@link EmbedEvent.Error} event to receive instances of this object
|
|
6377
6456
|
* and implement appropriate error handling logic based on the `errorType`.
|
|
6378
6457
|
*
|
|
@@ -6380,7 +6459,7 @@ export enum EmbedErrorCodes {
|
|
|
6380
6459
|
* @group Error Handling
|
|
6381
6460
|
* @see {@link ErrorDetailsTypes} - Available error type values
|
|
6382
6461
|
* @see {@link EmbedEvent.Error} - The event that emits this object
|
|
6383
|
-
*
|
|
6462
|
+
*
|
|
6384
6463
|
* @example
|
|
6385
6464
|
* Handle specific error types
|
|
6386
6465
|
*
|
|
@@ -6393,18 +6472,18 @@ export enum EmbedErrorCodes {
|
|
|
6393
6472
|
* console.error('Unknown error:', error);
|
|
6394
6473
|
* }
|
|
6395
6474
|
* });
|
|
6396
|
-
* *
|
|
6475
|
+
* *
|
|
6397
6476
|
* @example
|
|
6398
6477
|
* Handle multiple error messages
|
|
6399
6478
|
*
|
|
6400
6479
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
6401
|
-
* const messages = Array.isArray(error.message)
|
|
6402
|
-
* ? error.message
|
|
6480
|
+
* const messages = Array.isArray(error.message)
|
|
6481
|
+
* ? error.message
|
|
6403
6482
|
* : [error.message];
|
|
6404
|
-
*
|
|
6483
|
+
*
|
|
6405
6484
|
* messages.forEach(msg => console.error(msg));
|
|
6406
6485
|
* });
|
|
6407
|
-
* *
|
|
6486
|
+
* *
|
|
6408
6487
|
* @example
|
|
6409
6488
|
* Access additional error context
|
|
6410
6489
|
*
|