@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/lib/src/types.d.ts
CHANGED
|
@@ -347,7 +347,7 @@ export interface EmbedConfig {
|
|
|
347
347
|
/**
|
|
348
348
|
* [AuthServer] The trusted authentication endpoint to use to get the
|
|
349
349
|
* authentication token. A `GET` request is made to the
|
|
350
|
-
* authentication API endpoint, which
|
|
350
|
+
* authentication API endpoint, which returns the token
|
|
351
351
|
* as a plaintext response. For trusted authentication,
|
|
352
352
|
* the `authEndpoint` or `getAuthToken` attribute is required.
|
|
353
353
|
*/
|
|
@@ -457,12 +457,12 @@ export interface EmbedConfig {
|
|
|
457
457
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
458
458
|
* to start after the previous embed's render is complete. This helps improve
|
|
459
459
|
* performance by decreasing the load on the browser.
|
|
460
|
-
*
|
|
460
|
+
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
461
461
|
* @default false
|
|
462
462
|
*/
|
|
463
463
|
queueMultiRenders?: boolean;
|
|
464
464
|
/**
|
|
465
|
-
* [AuthServer|Basic] Detect if third-party
|
|
465
|
+
* [AuthServer|Basic] Detect if third-party cookies are enabled by doing an
|
|
466
466
|
* additional call. This is slower and should be avoided. Listen to the
|
|
467
467
|
* `NO_COOKIE_ACCESS` event to handle the situation.
|
|
468
468
|
*
|
|
@@ -1241,21 +1241,26 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1241
1241
|
/**
|
|
1242
1242
|
* Boolean to exclude runtimeFilters in the URL
|
|
1243
1243
|
* By default it is true, this flag removes runtime filters from the URL
|
|
1244
|
-
*
|
|
1244
|
+
* (default behavior from SDK 1.45.0).
|
|
1245
|
+
* when set to false, runtime filters will be included in the URL
|
|
1246
|
+
* (default behavior before SDK 1.45.0).
|
|
1245
1247
|
*
|
|
1246
1248
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
1247
1249
|
* embedded view.
|
|
1248
|
-
* @default
|
|
1250
|
+
* @default true
|
|
1249
1251
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
1250
1252
|
*/
|
|
1251
1253
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
1252
1254
|
/**
|
|
1253
1255
|
* Boolean to exclude runtimeParameters from the URL
|
|
1254
|
-
* when set to true, this flag removes runtime parameters from the URL
|
|
1256
|
+
* when set to true, this flag removes runtime parameters from the URL
|
|
1257
|
+
* (default behavior from SDK 1.45.0).
|
|
1258
|
+
* when set to false, runtime parameters will be included in the URL
|
|
1259
|
+
* (default behavior before SDK 1.45.0).
|
|
1255
1260
|
*
|
|
1256
1261
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
1257
1262
|
* embedded view.
|
|
1258
|
-
* @default
|
|
1263
|
+
* @default true
|
|
1259
1264
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
1260
1265
|
*/
|
|
1261
1266
|
excludeRuntimeParametersfromURL?: boolean;
|
|
@@ -1306,6 +1311,22 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1306
1311
|
* ```
|
|
1307
1312
|
*/
|
|
1308
1313
|
enableCustomColumnGroups?: boolean;
|
|
1314
|
+
/**
|
|
1315
|
+
* To enable **Include current period** checkbox for date filters.
|
|
1316
|
+
* Controls the visibility of the option to include
|
|
1317
|
+
* the current time period in filter results.
|
|
1318
|
+
*
|
|
1319
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1320
|
+
* @example
|
|
1321
|
+
* ```js
|
|
1322
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1323
|
+
* ... // other embed view config
|
|
1324
|
+
* isThisPeriodInDateFiltersEnabled: true,
|
|
1325
|
+
* })
|
|
1326
|
+
* ```
|
|
1327
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
1328
|
+
*/
|
|
1329
|
+
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
1309
1330
|
}
|
|
1310
1331
|
/**
|
|
1311
1332
|
* The configuration object for common Liveboard and App embeds configs.
|
|
@@ -1315,7 +1336,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1315
1336
|
* Show or hide Liveboard header
|
|
1316
1337
|
*
|
|
1317
1338
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1318
|
-
* @version SDK: 1.26.0 |
|
|
1339
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1319
1340
|
* @default false
|
|
1320
1341
|
* @example
|
|
1321
1342
|
* ```js
|
|
@@ -1331,7 +1352,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1331
1352
|
* Show or hide Liveboard title
|
|
1332
1353
|
*
|
|
1333
1354
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1334
|
-
* @version SDK: 1.26.0 |
|
|
1355
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1335
1356
|
* @default false
|
|
1336
1357
|
* @example
|
|
1337
1358
|
* ```js
|
|
@@ -1347,7 +1368,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1347
1368
|
* Show or hide Liveboard description
|
|
1348
1369
|
*
|
|
1349
1370
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1350
|
-
* @version SDK: 1.26.0 |
|
|
1371
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1351
1372
|
* @default false
|
|
1352
1373
|
* @example
|
|
1353
1374
|
* ```js
|
|
@@ -1371,7 +1392,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1371
1392
|
* isLiveboardHeaderSticky: true,
|
|
1372
1393
|
* });
|
|
1373
1394
|
* ```
|
|
1374
|
-
* @version SDK: 1.26.0 |
|
|
1395
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1375
1396
|
*/
|
|
1376
1397
|
isLiveboardHeaderSticky?: boolean;
|
|
1377
1398
|
/**
|
|
@@ -1465,7 +1486,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1465
1486
|
* enable or disable ask sage
|
|
1466
1487
|
*
|
|
1467
1488
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1468
|
-
* @version SDK: 1.29.0 |
|
|
1489
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.12.0.cl
|
|
1469
1490
|
* @default false
|
|
1470
1491
|
* @example
|
|
1471
1492
|
* ```js
|
|
@@ -1493,22 +1514,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1493
1514
|
* ```
|
|
1494
1515
|
*/
|
|
1495
1516
|
coverAndFilterOptionInPDF?: boolean;
|
|
1496
|
-
/**
|
|
1497
|
-
* This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
|
|
1498
|
-
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
1499
|
-
*
|
|
1500
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1501
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 26.3.0.cl
|
|
1502
|
-
* @example
|
|
1503
|
-
* ```js
|
|
1504
|
-
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
1505
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1506
|
-
* ... // other embed view config
|
|
1507
|
-
* liveboardXLSXCSVDownload: true,
|
|
1508
|
-
* })
|
|
1509
|
-
* ```
|
|
1510
|
-
*/
|
|
1511
|
-
liveboardXLSXCSVDownload?: boolean;
|
|
1512
1517
|
/**
|
|
1513
1518
|
* This flag is used to enable or disable the new centralized Liveboard filter UX (v2).
|
|
1514
1519
|
* When enabled, a unified modal is used to manage and update multiple filters at once,
|
|
@@ -1561,7 +1566,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1561
1566
|
* Show or hide masked filter chips
|
|
1562
1567
|
*
|
|
1563
1568
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1564
|
-
* @version SDK: 1.45.0 |
|
|
1569
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
1565
1570
|
* @default false
|
|
1566
1571
|
* @example
|
|
1567
1572
|
* ```js
|
|
@@ -1577,7 +1582,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1577
1582
|
* Enable or disable Liveboard styling and grouping
|
|
1578
1583
|
*
|
|
1579
1584
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1580
|
-
* @version SDK: 1.45.0 |
|
|
1585
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
1581
1586
|
* @default false
|
|
1582
1587
|
* @example
|
|
1583
1588
|
* ```js
|
|
@@ -1744,7 +1749,11 @@ export declare enum HomepageModule {
|
|
|
1744
1749
|
*/
|
|
1745
1750
|
export declare enum ListPageColumns {
|
|
1746
1751
|
/**
|
|
1747
|
-
*
|
|
1752
|
+
* Favorites
|
|
1753
|
+
*/
|
|
1754
|
+
Favorites = "FAVOURITE",
|
|
1755
|
+
/**
|
|
1756
|
+
* @deprecated Use {@link ListPageColumns.Favorites} instead.
|
|
1748
1757
|
*/
|
|
1749
1758
|
Favourite = "FAVOURITE",
|
|
1750
1759
|
/**
|
|
@@ -1762,7 +1771,11 @@ export declare enum ListPageColumns {
|
|
|
1762
1771
|
/**
|
|
1763
1772
|
* Share
|
|
1764
1773
|
*/
|
|
1765
|
-
Share = "SHARE"
|
|
1774
|
+
Share = "SHARE",
|
|
1775
|
+
/**
|
|
1776
|
+
* Verified badge/column
|
|
1777
|
+
*/
|
|
1778
|
+
Verified = "VERIFIED"
|
|
1766
1779
|
}
|
|
1767
1780
|
/**
|
|
1768
1781
|
* A filter that can be applied to ThoughtSpot answers, Liveboards, or
|
|
@@ -2012,7 +2025,7 @@ export declare enum EmbedEvent {
|
|
|
2012
2025
|
/**
|
|
2013
2026
|
* An error has occurred. This event is fired for the following error types:
|
|
2014
2027
|
*
|
|
2015
|
-
* `API` - API call failure
|
|
2028
|
+
* `API` - API call failure.
|
|
2016
2029
|
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
2017
2030
|
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
2018
2031
|
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
@@ -2743,20 +2756,20 @@ export declare enum EmbedEvent {
|
|
|
2743
2756
|
/**
|
|
2744
2757
|
*
|
|
2745
2758
|
* This event can be emitted to intercept search execution initiated by
|
|
2746
|
-
*
|
|
2747
|
-
* You can
|
|
2759
|
+
* users and implement logic to allow or restrict search execution.
|
|
2760
|
+
* You can also show custom error text if the search query must be
|
|
2748
2761
|
* restricted due to your application or business requirements.
|
|
2749
2762
|
|
|
2750
2763
|
* Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
|
|
2751
2764
|
* for this embed event to get emitted.
|
|
2752
|
-
* @param
|
|
2753
|
-
*
|
|
2754
|
-
* Contains elements that
|
|
2755
|
-
*
|
|
2756
|
-
*
|
|
2765
|
+
* @param - Includes the following event listener parameters:
|
|
2766
|
+
* - `payload`: The payload received from the embed related to the Data API call.
|
|
2767
|
+
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
2768
|
+
* should run the search, and if not, what error message
|
|
2769
|
+
* should be shown to the user.
|
|
2757
2770
|
*
|
|
2758
|
-
* `execute` - When execute returns `true`, the search will be run.
|
|
2759
|
-
* When execute returns `false`, the search will not be executed.
|
|
2771
|
+
* `execute` - When `execute` returns `true`, the search will be run.
|
|
2772
|
+
* When `execute` returns `false`, the search will not be executed.
|
|
2760
2773
|
*
|
|
2761
2774
|
* `error` - Developers can customize the error message text when `execute`
|
|
2762
2775
|
* is `false` using the `errorText` and `errorDescription` parameters in responder.
|
|
@@ -2928,7 +2941,7 @@ export declare enum EmbedEvent {
|
|
|
2928
2941
|
* console.log('payload', payload);
|
|
2929
2942
|
* })
|
|
2930
2943
|
* ```
|
|
2931
|
-
* @version SDK: 1.
|
|
2944
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
2932
2945
|
*/
|
|
2933
2946
|
DataModelInstructions = "DataModelInstructions",
|
|
2934
2947
|
/**
|
|
@@ -3146,14 +3159,14 @@ export declare enum HostEvent {
|
|
|
3146
3159
|
* the search query string.
|
|
3147
3160
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
3148
3161
|
* Includes the following properties:
|
|
3149
|
-
* @param -
|
|
3150
|
-
*
|
|
3151
|
-
*
|
|
3152
|
-
*
|
|
3153
|
-
*
|
|
3162
|
+
* @param - Includes the following keys:
|
|
3163
|
+
* - `searchQuery`: Query string with search tokens.
|
|
3164
|
+
* - `dataSources`: Data source GUID to search on.
|
|
3165
|
+
* Although an array, only a single source is supported.
|
|
3166
|
+
* - `execute`: Executes search and updates the existing query.
|
|
3154
3167
|
* @example
|
|
3155
3168
|
* ```js
|
|
3156
|
-
*
|
|
3169
|
+
* searchEmbed.trigger(HostEvent.Search, {
|
|
3157
3170
|
searchQuery: "[sales] by [item type]",
|
|
3158
3171
|
dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
|
|
3159
3172
|
execute: true
|
|
@@ -3164,16 +3177,15 @@ export declare enum HostEvent {
|
|
|
3164
3177
|
/**
|
|
3165
3178
|
* Triggers a drill on certain points of the specified column
|
|
3166
3179
|
* Includes the following properties:
|
|
3167
|
-
* @param -
|
|
3168
|
-
*
|
|
3169
|
-
*
|
|
3170
|
-
*
|
|
3171
|
-
* column.
|
|
3172
|
-
*
|
|
3173
|
-
*
|
|
3174
|
-
*
|
|
3175
|
-
*
|
|
3176
|
-
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
3180
|
+
* @param - Includes the following keys:
|
|
3181
|
+
* - `points`: An object containing `selectedPoints` and/or `clickedPoint`
|
|
3182
|
+
* to drill to. For example, `{ selectedPoints: [] }`.
|
|
3183
|
+
* - `columnGuid`: Optional. GUID of the column to drill by. If not provided,
|
|
3184
|
+
* it will auto drill by the configured column.
|
|
3185
|
+
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
3186
|
+
* on the most popular column.
|
|
3187
|
+
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
3188
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
3177
3189
|
* @example
|
|
3178
3190
|
* ```js
|
|
3179
3191
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -3266,14 +3278,12 @@ export declare enum HostEvent {
|
|
|
3266
3278
|
* and `AppEmbed` only. In full application embedding, this event updates
|
|
3267
3279
|
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
3268
3280
|
*
|
|
3269
|
-
* @param -
|
|
3270
|
-
* `columnName
|
|
3271
|
-
*
|
|
3272
|
-
*
|
|
3273
|
-
*
|
|
3274
|
-
*
|
|
3275
|
-
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
3276
|
-
* single value, whereas BW and IN accept multiple values.
|
|
3281
|
+
* @param - Array of {@link RuntimeFilter} objects. Each item includes:
|
|
3282
|
+
* - `columnName`: Name of the column to filter on.
|
|
3283
|
+
* - `operator`: {@link RuntimeFilterOp} to apply. For more information, see
|
|
3284
|
+
* link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
3285
|
+
* - `values`: List of operands. Some operators such as EQ and LE allow a single
|
|
3286
|
+
* value, whereas BW and IN accept multiple values.
|
|
3277
3287
|
*
|
|
3278
3288
|
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
3279
3289
|
* object to its original state and applies new filter conditions.
|
|
@@ -3296,7 +3306,7 @@ export declare enum HostEvent {
|
|
|
3296
3306
|
/**
|
|
3297
3307
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
3298
3308
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
3299
|
-
* @param - `path` - the path to navigate to
|
|
3309
|
+
* @param - `path` - the path to navigate to go forward or back. The path value can
|
|
3300
3310
|
* be a number; for example, `1`, `-1`.
|
|
3301
3311
|
* @example
|
|
3302
3312
|
* ```js
|
|
@@ -3367,30 +3377,25 @@ export declare enum HostEvent {
|
|
|
3367
3377
|
* for the Answer that the user is currently on
|
|
3368
3378
|
* and a modal opens for Liveboard selection.
|
|
3369
3379
|
* To add an Answer or visualization to a Liveboard programmatically without
|
|
3370
|
-
*
|
|
3380
|
+
* requiring additional user input via the *Pin to Liveboard* modal, define
|
|
3371
3381
|
* the following parameters:
|
|
3372
3382
|
*
|
|
3373
|
-
* @param
|
|
3374
|
-
* `vizId
|
|
3375
|
-
*
|
|
3376
|
-
*
|
|
3377
|
-
*
|
|
3378
|
-
* `
|
|
3379
|
-
*
|
|
3380
|
-
*
|
|
3381
|
-
*
|
|
3382
|
-
*
|
|
3383
|
-
*
|
|
3384
|
-
*
|
|
3385
|
-
*
|
|
3386
|
-
*
|
|
3387
|
-
*
|
|
3388
|
-
*
|
|
3389
|
-
* `newLiveboardName` - Name string for the Liveboard.
|
|
3390
|
-
* Creates a new Liveboard object with the specified name.
|
|
3391
|
-
* @param
|
|
3392
|
-
* `newTabName` - Name of the tab. Adds a new tab Liveboard specified
|
|
3393
|
-
* in the code.
|
|
3383
|
+
* @param - Includes the following keys:
|
|
3384
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
|
|
3385
|
+
* Optional when pinning a new chart or table generated from a Search query.
|
|
3386
|
+
* **Required** in Spotter Embed.
|
|
3387
|
+
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
3388
|
+
* specify the `newLiveboardName` parameter to create a new Liveboard.
|
|
3389
|
+
* - `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
|
|
3390
|
+
* specified in the code.
|
|
3391
|
+
* - `newVizName`: Name string for the Answer or visualization. If defined,
|
|
3392
|
+
* this parameter adds a new visualization object or creates a copy of the
|
|
3393
|
+
* Answer or visualization specified in `vizId`.
|
|
3394
|
+
* Required.
|
|
3395
|
+
* - `newLiveboardName`: Name string for the Liveboard.
|
|
3396
|
+
* Creates a new Liveboard object with the specified name.
|
|
3397
|
+
* - `newTabName`: Name of the tab. Adds a new tab Liveboard specified
|
|
3398
|
+
* in the code.
|
|
3394
3399
|
*
|
|
3395
3400
|
* @example
|
|
3396
3401
|
* ```js
|
|
@@ -3630,9 +3635,9 @@ export declare enum HostEvent {
|
|
|
3630
3635
|
* on a Liveboard.
|
|
3631
3636
|
*
|
|
3632
3637
|
* This event is not supported in visualization embed and search embed.
|
|
3633
|
-
* @param -
|
|
3634
|
-
*
|
|
3635
|
-
*
|
|
3638
|
+
* @param - Object parameter. Includes the following keys:
|
|
3639
|
+
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
3640
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
3636
3641
|
*
|
|
3637
3642
|
* @example
|
|
3638
3643
|
* ```js
|
|
@@ -3999,10 +4004,9 @@ export declare enum HostEvent {
|
|
|
3999
4004
|
GetFilters = "getFilters",
|
|
4000
4005
|
/**
|
|
4001
4006
|
* Update one or several filters applied on a Liveboard.
|
|
4002
|
-
* @param -
|
|
4003
|
-
* filter operator, and values.
|
|
4004
|
-
*
|
|
4005
|
-
* and values for each.
|
|
4007
|
+
* @param - Includes the following keys:
|
|
4008
|
+
* - `filter`: A single filter object containing column name, filter operator, and values.
|
|
4009
|
+
* - `filters`: Multiple filter objects with column name, filter operator, and values for each.
|
|
4006
4010
|
*
|
|
4007
4011
|
* Each filter object must include the following attributes:
|
|
4008
4012
|
*
|
|
@@ -4128,8 +4132,9 @@ export declare enum HostEvent {
|
|
|
4128
4132
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4129
4133
|
/**
|
|
4130
4134
|
* Updates the search query string for Natural Language Search operations.
|
|
4131
|
-
* @param -
|
|
4132
|
-
*
|
|
4135
|
+
* @param - Includes the following keys:
|
|
4136
|
+
* - `queryString`: Text string in Natural Language format.
|
|
4137
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
4133
4138
|
* @example
|
|
4134
4139
|
* ```js
|
|
4135
4140
|
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
@@ -4208,11 +4213,10 @@ export declare enum HostEvent {
|
|
|
4208
4213
|
/**
|
|
4209
4214
|
* Triggers an action to update Parameter values on embedded
|
|
4210
4215
|
* Answers, Liveboard, and Spotter answer in Edit mode.
|
|
4211
|
-
* @param -
|
|
4212
|
-
*
|
|
4213
|
-
*
|
|
4214
|
-
*
|
|
4215
|
-
* use the `isVisibleToUser` attribute when applying an override.
|
|
4216
|
+
* @param - Includes the following keys for each item:
|
|
4217
|
+
* - `name`: Name of the parameter.
|
|
4218
|
+
* - `value`: The value to set for the parameter.
|
|
4219
|
+
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
4216
4220
|
*
|
|
4217
4221
|
* @example
|
|
4218
4222
|
* ```js
|
|
@@ -4270,11 +4274,10 @@ export declare enum HostEvent {
|
|
|
4270
4274
|
* If no parameters are specified, the save action is
|
|
4271
4275
|
* triggered with a modal to prompt users to
|
|
4272
4276
|
* add a name and description for the Answer.
|
|
4273
|
-
* @param -
|
|
4274
|
-
* and is required in Spotter embed.
|
|
4275
|
-
* Optional
|
|
4276
|
-
*
|
|
4277
|
-
* @param - `description` - Description text for the Answer.
|
|
4277
|
+
* @param - Includes the following keys:
|
|
4278
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
|
|
4279
|
+
* - `name`: Optional. Name string for the Answer.
|
|
4280
|
+
* - `description`: Optional. Description text for the Answer.
|
|
4278
4281
|
* @example
|
|
4279
4282
|
* ```js
|
|
4280
4283
|
* const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
|
|
@@ -4323,8 +4326,9 @@ export declare enum HostEvent {
|
|
|
4323
4326
|
/**
|
|
4324
4327
|
* Triggers a search operation with the search tokens specified in
|
|
4325
4328
|
* the search query string in spotter embed.
|
|
4326
|
-
* @param -
|
|
4327
|
-
*
|
|
4329
|
+
* @param - Includes the following keys:
|
|
4330
|
+
* - `query`: Text string in Natural Language format.
|
|
4331
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
4328
4332
|
* @example
|
|
4329
4333
|
* ```js
|
|
4330
4334
|
* spotterEmbed.trigger(HostEvent.SpotterSearch, {
|
|
@@ -4371,7 +4375,7 @@ export declare enum HostEvent {
|
|
|
4371
4375
|
* ```js
|
|
4372
4376
|
* spotterEmbed.trigger(HostEvent.DataModelInstructions);
|
|
4373
4377
|
* ```
|
|
4374
|
-
* @version SDK: 1.
|
|
4378
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4375
4379
|
*/
|
|
4376
4380
|
DataModelInstructions = "DataModelInstructions",
|
|
4377
4381
|
/**
|
|
@@ -4456,7 +4460,7 @@ export declare enum HostEvent {
|
|
|
4456
4460
|
*/
|
|
4457
4461
|
UpdateEmbedParams = "updateEmbedParams",
|
|
4458
4462
|
/**
|
|
4459
|
-
* Triggered when the embed
|
|
4463
|
+
* Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
|
|
4460
4464
|
* @example
|
|
4461
4465
|
* ```js
|
|
4462
4466
|
* liveboardEmbed.trigger(HostEvent.DestroyEmbed);
|
|
@@ -4464,11 +4468,12 @@ export declare enum HostEvent {
|
|
|
4464
4468
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
4465
4469
|
*/
|
|
4466
4470
|
DestroyEmbed = "EmbedDestroyed",
|
|
4467
|
-
/**
|
|
4468
|
-
*
|
|
4469
|
-
*
|
|
4471
|
+
/**
|
|
4472
|
+
* Triggers a new conversation in Spotter embed.
|
|
4473
|
+
*
|
|
4470
4474
|
* This feature is available only when chat history is enabled on your ThoughtSpot instance.
|
|
4471
4475
|
* Contact your admin or ThoughtSpot Support to enable chat history on your instance.
|
|
4476
|
+
*
|
|
4472
4477
|
* @example
|
|
4473
4478
|
* ```js
|
|
4474
4479
|
* spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
|
|
@@ -4617,12 +4622,14 @@ export declare enum Param {
|
|
|
4617
4622
|
IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
|
|
4618
4623
|
IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
|
|
4619
4624
|
RootMarginForLazyLoad = "rootMarginForLazyLoad",
|
|
4620
|
-
LiveboardXLSXCSVDownload = "isLiveboardXLSXCSVDownloadEnabled",
|
|
4621
4625
|
isPNGInScheduledEmailsEnabled = "isPNGInScheduledEmailsEnabled",
|
|
4626
|
+
isLiveboardXLSXCSVDownloadEnabled = "isLiveboardXLSXCSVDownloadEnabled",
|
|
4627
|
+
isGranularXLSXCSVSchedulesEnabled = "isGranularXLSXCSVSchedulesEnabled",
|
|
4622
4628
|
isCentralizedLiveboardFilterUXEnabled = "isCentralizedLiveboardFilterUXEnabled",
|
|
4623
4629
|
isLinkParametersEnabled = "isLinkParametersEnabled",
|
|
4624
4630
|
EnablePastConversationsSidebar = "enablePastConversationsSidebar",
|
|
4625
|
-
UpdatedSpotterChatPrompt = "updatedSpotterChatPrompt"
|
|
4631
|
+
UpdatedSpotterChatPrompt = "updatedSpotterChatPrompt",
|
|
4632
|
+
IsThisPeriodInDateFiltersEnabled = "isThisPeriodInDateFiltersEnabled"
|
|
4626
4633
|
}
|
|
4627
4634
|
/**
|
|
4628
4635
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -4635,7 +4642,7 @@ export declare enum Param {
|
|
|
4635
4642
|
* ```js
|
|
4636
4643
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
4637
4644
|
* ... //other embed view config
|
|
4638
|
-
* visibleActions: [Action.Save, Action.Edit, Action.Present,
|
|
4645
|
+
* visibleActions: [Action.Save, Action.Edit, Action.Present, Action.Explore],
|
|
4639
4646
|
* disabledActions: [Action.Download],
|
|
4640
4647
|
* //hiddenActions: [], // Set either this or visibleActions
|
|
4641
4648
|
* })
|
|
@@ -4646,10 +4653,10 @@ export declare enum Param {
|
|
|
4646
4653
|
* ... //other embed view config
|
|
4647
4654
|
* //visibleActions: [],
|
|
4648
4655
|
* disabledActions: [Action.Download],
|
|
4649
|
-
* hiddenActions: [Action.Edit,
|
|
4656
|
+
* hiddenActions: [Action.Edit, Action.Explore],
|
|
4650
4657
|
* })
|
|
4651
4658
|
* ```
|
|
4652
|
-
* See also link:https://developers.thoughtspot.com/docs/actions[
|
|
4659
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
|
|
4653
4660
|
*/
|
|
4654
4661
|
export declare enum Action {
|
|
4655
4662
|
/**
|
|
@@ -4936,6 +4943,16 @@ export declare enum Action {
|
|
|
4936
4943
|
* ```
|
|
4937
4944
|
*/
|
|
4938
4945
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
4946
|
+
/**
|
|
4947
|
+
* The **Download Liveboard** menu action on a Liveboard.
|
|
4948
|
+
* Allows downloading the entire Liveboard.
|
|
4949
|
+
* @example
|
|
4950
|
+
* ```js
|
|
4951
|
+
* disabledActions: [Action.DownloadLiveboard]
|
|
4952
|
+
* ```
|
|
4953
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4954
|
+
*/
|
|
4955
|
+
DownloadLiveboard = "downloadLiveboard",
|
|
4939
4956
|
/**
|
|
4940
4957
|
* @hidden
|
|
4941
4958
|
*/
|
|
@@ -5155,13 +5172,15 @@ export declare enum Action {
|
|
|
5155
5172
|
*/
|
|
5156
5173
|
RequestAccess = "requestAccess",
|
|
5157
5174
|
/**
|
|
5158
|
-
*
|
|
5159
|
-
* Query details panel
|
|
5175
|
+
* Controls the display and availability of the **Query visualizer** and
|
|
5176
|
+
* **Query SQL** buttons in the Query details panel on the Answer page.
|
|
5177
|
+
*
|
|
5178
|
+
* **Query visualizer** - Displays the tables and filters used in the search query.
|
|
5179
|
+
* **Query SQL** - Displays the SQL statements used to retrieve data for the query.
|
|
5160
5180
|
*
|
|
5161
|
-
*
|
|
5162
|
-
*
|
|
5163
|
-
*
|
|
5164
|
-
* in a search query to fetch data.
|
|
5181
|
+
* Note: This action ID only affects the visibility of the buttons within the
|
|
5182
|
+
* Query details panel. It does not control the visibility
|
|
5183
|
+
* of the query details icon on the Answer page.
|
|
5165
5184
|
* @example
|
|
5166
5185
|
* ```js
|
|
5167
5186
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5275,28 +5294,28 @@ export declare enum Action {
|
|
|
5275
5294
|
CrossFilter = "context-menu-item-cross-filter",
|
|
5276
5295
|
/**
|
|
5277
5296
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5278
|
-
* Allows sending data to third-party apps Slack
|
|
5297
|
+
* Allows sending data to third-party apps like Slack.
|
|
5279
5298
|
* @example
|
|
5280
5299
|
* ```js
|
|
5281
5300
|
* disabledActions: [Action.SyncToSlack]
|
|
5282
5301
|
* ```
|
|
5283
|
-
* @version
|
|
5302
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5284
5303
|
*/
|
|
5285
5304
|
SyncToSlack = "syncToSlack",
|
|
5286
5305
|
/**
|
|
5287
5306
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5288
|
-
* Allows sending data to third-party apps
|
|
5307
|
+
* Allows sending data to third-party apps like Microsoft Teams.
|
|
5289
5308
|
* @example
|
|
5290
5309
|
* ```js
|
|
5291
5310
|
* disabledActions: [Action.SyncToTeams]
|
|
5292
5311
|
* ```
|
|
5293
|
-
* @version
|
|
5312
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
5294
5313
|
*/
|
|
5295
5314
|
SyncToTeams = "syncToTeams",
|
|
5296
5315
|
/**
|
|
5297
5316
|
* The **Remove** action that appears when cross filters are applied
|
|
5298
5317
|
* on a Liveboard.
|
|
5299
|
-
* Removes filters applied
|
|
5318
|
+
* Removes filters applied to a visualization.
|
|
5300
5319
|
* @example
|
|
5301
5320
|
* ```js
|
|
5302
5321
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -5482,7 +5501,7 @@ export declare enum Action {
|
|
|
5482
5501
|
AddTab = "addTab",
|
|
5483
5502
|
/**
|
|
5484
5503
|
*
|
|
5485
|
-
*Initiates contextual change analysis on KPI charts.
|
|
5504
|
+
* Initiates contextual change analysis on KPI charts.
|
|
5486
5505
|
* @example
|
|
5487
5506
|
* ```js
|
|
5488
5507
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
@@ -5492,7 +5511,7 @@ export declare enum Action {
|
|
|
5492
5511
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
5493
5512
|
/**
|
|
5494
5513
|
* Action ID to hide or disable Iterative Change Analysis option
|
|
5495
|
-
*
|
|
5514
|
+
* in the contextual change analysis Insight charts context menu.
|
|
5496
5515
|
*
|
|
5497
5516
|
* @example
|
|
5498
5517
|
* ```js
|
|
@@ -5770,6 +5789,17 @@ export declare enum Action {
|
|
|
5770
5789
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
5771
5790
|
*/
|
|
5772
5791
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
5792
|
+
/**
|
|
5793
|
+
* The **Data model instructions** button on the Spotter interface.
|
|
5794
|
+
* Allows opening the data model instructions modal.
|
|
5795
|
+
*
|
|
5796
|
+
* @example
|
|
5797
|
+
* ```js
|
|
5798
|
+
* hiddenAction: [Action.DataModelInstructions]
|
|
5799
|
+
* ```
|
|
5800
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
5801
|
+
*/
|
|
5802
|
+
DataModelInstructions = "DataModelInstructions",
|
|
5773
5803
|
/**
|
|
5774
5804
|
* The **Preview data** button on the Spotter interface.
|
|
5775
5805
|
* Allows previewing the data used for Spotter queries.
|
|
@@ -5855,12 +5885,11 @@ export declare enum Action {
|
|
|
5855
5885
|
*/
|
|
5856
5886
|
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
5857
5887
|
/**
|
|
5858
|
-
|
|
5859
|
-
|
|
5860
|
-
|
|
5861
|
-
|
|
5862
|
-
|
|
5863
|
-
* contact ThoughtSpot Support.
|
|
5888
|
+
* Action ID to hide or disable the Coaching workflow in Spotter conversations.
|
|
5889
|
+
* When disabled, users cannot access **Add to Coaching** workflow in conversation.
|
|
5890
|
+
* The **Add to Coaching** feature allows adding reference questions and
|
|
5891
|
+
* business terms to improve Spotter’s responses. This feature is generally available
|
|
5892
|
+
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
5864
5893
|
* @example
|
|
5865
5894
|
* ```js
|
|
5866
5895
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -5936,6 +5965,55 @@ export declare enum Action {
|
|
|
5936
5965
|
* @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
|
|
5937
5966
|
*/
|
|
5938
5967
|
LiveboardStylePanel = "liveboardStylePanel",
|
|
5968
|
+
/**
|
|
5969
|
+
* The **Publish** action for Liveboards, Answers and Models.
|
|
5970
|
+
* Opens the publishing modal. It's a parent action for the
|
|
5971
|
+
* **Manage Publishing** and **Unpublish** actions if the object
|
|
5972
|
+
* is already published, otherwise appears standalone.
|
|
5973
|
+
* @example
|
|
5974
|
+
* ```js
|
|
5975
|
+
* hiddenActions: [Action.Publish]
|
|
5976
|
+
* disabledActions: [Action.Publish]
|
|
5977
|
+
* ```
|
|
5978
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
5979
|
+
*/
|
|
5980
|
+
Publish = "publish",
|
|
5981
|
+
/**
|
|
5982
|
+
* The **Manage Publishing** action for Liveboards, Answers and Models.
|
|
5983
|
+
* Opens the same publishing modal as the **Publish** action.
|
|
5984
|
+
* Appears as a child action to the **Publish** action if the
|
|
5985
|
+
* object is already published.
|
|
5986
|
+
* @example
|
|
5987
|
+
* ```js
|
|
5988
|
+
* hiddenActions: [Action.ManagePublishing]
|
|
5989
|
+
* disabledActions: [Action.ManagePublishing]
|
|
5990
|
+
* ```
|
|
5991
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
5992
|
+
*/
|
|
5993
|
+
ManagePublishing = "managePublishing",
|
|
5994
|
+
/**
|
|
5995
|
+
* The **Unpublish** action for Liveboards, Answers and Models.
|
|
5996
|
+
* Opens the unpublishing modal. Appears as a child action to
|
|
5997
|
+
* the **Publish** action if the object is already published.
|
|
5998
|
+
* @example
|
|
5999
|
+
* ```js
|
|
6000
|
+
* hiddenActions: [Action.Unpublish]
|
|
6001
|
+
* disabledActions: [Action.Unpublish]
|
|
6002
|
+
* ```
|
|
6003
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6004
|
+
*/
|
|
6005
|
+
Unpublish = "unpublish",
|
|
6006
|
+
/**
|
|
6007
|
+
* The **Parameterize** action for Tables and Connections.
|
|
6008
|
+
* Opens the parameterization modal.
|
|
6009
|
+
* @example
|
|
6010
|
+
* ```js
|
|
6011
|
+
* hiddenActions: [Action.Parameterize]
|
|
6012
|
+
* disabledActions: [Action.Parameterize]
|
|
6013
|
+
* ```
|
|
6014
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6015
|
+
*/
|
|
6016
|
+
Parameterize = "parameterise",
|
|
5939
6017
|
/**
|
|
5940
6018
|
* The **Move to Group** menu action on a Liveboard.
|
|
5941
6019
|
* Allows moving a visualization to a different group.
|
|
@@ -5975,7 +6053,19 @@ export declare enum Action {
|
|
|
5975
6053
|
* ```
|
|
5976
6054
|
* @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
5977
6055
|
*/
|
|
5978
|
-
UngroupLiveboardGroup = "ungroupLiveboardGroup"
|
|
6056
|
+
UngroupLiveboardGroup = "ungroupLiveboardGroup",
|
|
6057
|
+
/**
|
|
6058
|
+
* The **Include current period** checkbox for date filters.
|
|
6059
|
+
* Controls the visibility and availability of the option to include
|
|
6060
|
+
* the current time period in filter results.
|
|
6061
|
+
* @example
|
|
6062
|
+
* ```js
|
|
6063
|
+
* hiddenActions: [Action.IncludeCurrentPeriod]
|
|
6064
|
+
* disabledActions: [Action.IncludeCurrentPeriod]
|
|
6065
|
+
* ```
|
|
6066
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
6067
|
+
*/
|
|
6068
|
+
IncludeCurrentPeriod = "includeCurrentPeriod"
|
|
5979
6069
|
}
|
|
5980
6070
|
export interface AnswerServiceType {
|
|
5981
6071
|
getAnswer?: (offset: number, batchSize: number) => any;
|
|
@@ -6175,31 +6265,19 @@ export declare enum ErrorDetailsTypes {
|
|
|
6175
6265
|
NETWORK = "NETWORK"
|
|
6176
6266
|
}
|
|
6177
6267
|
/**
|
|
6178
|
-
*
|
|
6268
|
+
* Error codes for identifying specific issues in embedded ThoughtSpot components.
|
|
6179
6269
|
*
|
|
6180
|
-
*
|
|
6181
|
-
*
|
|
6182
|
-
* precise error handling and debugging.
|
|
6183
|
-
*
|
|
6184
|
-
* The codes are organized into categories:
|
|
6185
|
-
* - **Worksheet ID not found or does not exist**: Errors related to applying or updating filters
|
|
6186
|
-
* - **Liveboard ID missing**: Errors related to missing liveboard ID
|
|
6187
|
-
* - **Conflicting actions configuration**: Errors related to conflicting actions configuration
|
|
6188
|
-
* - **Conflicting tabs configuration**: Errors related to conflicting tabs configuration
|
|
6189
|
-
* - **Initialization error**: Errors related to initialization error
|
|
6190
|
-
* - **Network error**: Errors related to network error
|
|
6191
|
-
* - **Custom action validation**: Errors related to custom action validation
|
|
6192
|
-
* - **Login failed**: Errors related to login failed
|
|
6193
|
-
* - **Render not called**: Errors related to render not called
|
|
6194
|
-
* - **Host event type undefined or invalid**: Errors related to host event type undefined or invalid
|
|
6270
|
+
* Use these codes for precise error handling and debugging. Each code maps to a
|
|
6271
|
+
* distinct failure scenario, enabling targeted recovery strategies.
|
|
6195
6272
|
*
|
|
6196
6273
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
6197
6274
|
* @group Error Handling
|
|
6275
|
+
*
|
|
6198
6276
|
* @see {@link EmbedErrorDetailsEvent} - The error event object that includes these codes
|
|
6199
6277
|
* @see {@link ErrorDetailsTypes} - General error type categories
|
|
6200
6278
|
*
|
|
6201
6279
|
* @example
|
|
6202
|
-
* Handle specific error codes
|
|
6280
|
+
* Handle specific error codes in the error event handler
|
|
6203
6281
|
*
|
|
6204
6282
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
6205
6283
|
* if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {
|