@thoughtspot/visual-embed-sdk 1.46.2 → 1.46.3
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/auth.js +0 -3
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/auth.spec.js +1 -3
- package/cjs/src/auth.spec.js.map +1 -1
- package/cjs/src/authToken.js +0 -1
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/authToken.spec.js +2 -1
- package/cjs/src/authToken.spec.js.map +1 -1
- package/cjs/src/embed/app.d.ts +2 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/auto-frame-renderer.d.ts +41 -0
- package/cjs/src/embed/auto-frame-renderer.d.ts.map +1 -0
- package/cjs/src/embed/auto-frame-renderer.js +145 -0
- package/cjs/src/embed/auto-frame-renderer.js.map +1 -0
- package/cjs/src/embed/auto-frame-renderer.spec.d.ts +2 -0
- package/cjs/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
- package/cjs/src/embed/auto-frame-renderer.spec.js +195 -0
- package/cjs/src/embed/auto-frame-renderer.spec.js.map +1 -0
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +4 -7
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +0 -2
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +2 -1
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +5 -3
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +4 -2
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.js +0 -1
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search.spec.js +0 -2
- 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 +3 -3
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +2 -1
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +3 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +3 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/index.js +0 -1
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +6 -3
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/types.d.ts +56 -32
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +34 -18
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +5 -4
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +7 -11
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/preview-service.js +0 -1
- package/cjs/src/utils/graphql/preview-service.js.map +1 -1
- package/cjs/src/utils/processData.js +0 -5
- package/cjs/src/utils/processData.js.map +1 -1
- package/dist/{index-DkizS4xM.js → index-DyX-x6uN.js} +1 -1
- package/dist/src/embed/app.d.ts +2 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/auto-frame-renderer.d.ts +41 -0
- package/dist/src/embed/auto-frame-renderer.d.ts.map +1 -0
- package/dist/src/embed/auto-frame-renderer.spec.d.ts +2 -0
- package/dist/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +2 -1
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +3 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +56 -32
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +5 -4
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +55 -57
- package/dist/tsembed-react.js +54 -56
- package/dist/tsembed.es.js +194 -57
- package/dist/tsembed.js +193 -55
- package/dist/visual-embed-sdk-react-full.d.ts +54 -33
- package/dist/visual-embed-sdk-react.d.ts +54 -33
- package/dist/visual-embed-sdk.d.ts +103 -38
- package/lib/package.json +1 -1
- package/lib/src/auth.js +0 -3
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.js +1 -3
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/authToken.js +0 -1
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/authToken.spec.js +2 -1
- package/lib/src/authToken.spec.js.map +1 -1
- package/lib/src/embed/app.d.ts +2 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/auto-frame-renderer.d.ts +41 -0
- package/lib/src/embed/auto-frame-renderer.d.ts.map +1 -0
- package/lib/src/embed/auto-frame-renderer.js +141 -0
- package/lib/src/embed/auto-frame-renderer.js.map +1 -0
- package/lib/src/embed/auto-frame-renderer.spec.d.ts +2 -0
- package/lib/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
- package/lib/src/embed/auto-frame-renderer.spec.js +192 -0
- package/lib/src/embed/auto-frame-renderer.spec.js.map +1 -0
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +4 -7
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +0 -2
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +2 -1
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +5 -3
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +4 -2
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.js +0 -1
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search.spec.js +0 -2
- 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 +3 -3
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +2 -1
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +3 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +1 -0
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/index.js +0 -1
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +6 -3
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +56 -32
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +34 -18
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +5 -4
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +7 -11
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/preview-service.js +0 -1
- package/lib/src/utils/graphql/preview-service.js.map +1 -1
- package/lib/src/utils/processData.js +0 -5
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +11466 -0
- package/package.json +1 -1
- package/src/auth.spec.ts +1 -1
- package/src/auth.ts +3 -3
- package/src/authToken.spec.ts +2 -1
- package/src/authToken.ts +1 -1
- package/src/embed/app.ts +2 -1
- package/src/embed/auto-frame-renderer.spec.ts +266 -0
- package/src/embed/auto-frame-renderer.ts +152 -0
- package/src/embed/base.spec.ts +1 -1
- package/src/embed/base.ts +7 -8
- package/src/embed/hostEventClient/host-event-client.ts +2 -2
- package/src/embed/liveboard.spec.ts +4 -2
- package/src/embed/liveboard.ts +7 -4
- package/src/embed/sage.ts +1 -1
- package/src/embed/search.spec.ts +2 -2
- package/src/embed/ts-embed.spec.ts +2 -1
- package/src/embed/ts-embed.ts +3 -3
- package/src/index.ts +3 -0
- package/src/react/index.spec.tsx +6 -3
- package/src/react/index.tsx +1 -1
- package/src/types.ts +57 -32
- package/src/utils/graphql/answerService/answerService.ts +8 -7
- package/src/utils/graphql/preview-service.ts +1 -1
- package/src/utils/processData.ts +5 -5
|
@@ -2336,8 +2336,9 @@ export interface HomePageConfig {
|
|
|
2336
2336
|
* *Liveboards* and *Answers*.
|
|
2337
2337
|
* For example: `hiddenListColumns = [ListPageColumns.Author]`
|
|
2338
2338
|
*
|
|
2339
|
-
* **Note**: This option is available only in full app embedding and requires
|
|
2340
|
-
* Starting with version 10.14.0.cl, you can
|
|
2339
|
+
* **Note**: This option is available only in full app embedding and requires
|
|
2340
|
+
* importing the `ListPageColumns` enum. Starting with version 10.14.0.cl, you can
|
|
2341
|
+
* use this attribute to
|
|
2341
2342
|
* hide the columns on all list pages in the *Insights* section.
|
|
2342
2343
|
*
|
|
2343
2344
|
* Supported embed types: `AppEmbed`
|
|
@@ -2377,8 +2378,9 @@ export interface HomePageConfig {
|
|
|
2377
2378
|
/**
|
|
2378
2379
|
* Reorder home page modules.
|
|
2379
2380
|
* To specify the modules, import the `HomepageModule` enum.
|
|
2380
|
-
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2381
|
-
* **Note**: This attribute is not supported in the
|
|
2381
|
+
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2382
|
+
* HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
|
|
2383
|
+
* classic (v1) homepage.
|
|
2382
2384
|
*
|
|
2383
2385
|
* Supported embed types: `AppEmbed`
|
|
2384
2386
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -2690,7 +2692,9 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2690
2692
|
/**
|
|
2691
2693
|
* This flag is used to enable/disable hide irrelevant filters in Liveboard tab
|
|
2692
2694
|
*
|
|
2693
|
-
* **Note**: This feature is supported only if compact header is enabled on your
|
|
2695
|
+
* **Note**: This feature is supported only if compact header is enabled on your
|
|
2696
|
+
* Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled`
|
|
2697
|
+
* attribute.
|
|
2694
2698
|
*
|
|
2695
2699
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2696
2700
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
@@ -2756,9 +2760,9 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2756
2760
|
*/
|
|
2757
2761
|
coverAndFilterOptionInPDF?: boolean;
|
|
2758
2762
|
/**
|
|
2759
|
-
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
2760
|
-
* When enabled, a unified modal is used to manage and update multiple filters
|
|
2761
|
-
* replacing the older individual filter interactions.
|
|
2763
|
+
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
2764
|
+
* (v2). When enabled, a unified modal is used to manage and update multiple filters
|
|
2765
|
+
* at once, replacing the older individual filter interactions.
|
|
2762
2766
|
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
2763
2767
|
*
|
|
2764
2768
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
@@ -2789,7 +2793,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2789
2793
|
*/
|
|
2790
2794
|
isLinkParametersEnabled?: boolean;
|
|
2791
2795
|
/**
|
|
2792
|
-
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
2796
|
+
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
2797
|
+
* liveboard.
|
|
2793
2798
|
*
|
|
2794
2799
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2795
2800
|
* @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
|
|
@@ -3459,7 +3464,8 @@ export declare enum EmbedEvent {
|
|
|
3459
3464
|
Download = "download",
|
|
3460
3465
|
/**
|
|
3461
3466
|
* Emitted when the download action is triggered on an Answer.
|
|
3462
|
-
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
3467
|
+
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
3468
|
+
* subscribe to when download is completed. Default is end:true.
|
|
3463
3469
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3464
3470
|
* @example
|
|
3465
3471
|
* ```js
|
|
@@ -3474,7 +3480,8 @@ export declare enum EmbedEvent {
|
|
|
3474
3480
|
DownloadAsPng = "downloadAsPng",
|
|
3475
3481
|
/**
|
|
3476
3482
|
* Emitted when the Download as PDF action is triggered on an Answer
|
|
3477
|
-
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
3483
|
+
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
3484
|
+
* subscribe to when download as PDF is completed. Default is end:true.
|
|
3478
3485
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3479
3486
|
* @example
|
|
3480
3487
|
* ```js
|
|
@@ -3489,7 +3496,8 @@ export declare enum EmbedEvent {
|
|
|
3489
3496
|
DownloadAsPdf = "downloadAsPdf",
|
|
3490
3497
|
/**
|
|
3491
3498
|
* Emitted when the Download as CSV action is triggered on an Answer.
|
|
3492
|
-
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
3499
|
+
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
3500
|
+
* subscribe to when download as CSV is completed. Default is end:true.
|
|
3493
3501
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3494
3502
|
* @example
|
|
3495
3503
|
* ```js
|
|
@@ -3504,7 +3512,8 @@ export declare enum EmbedEvent {
|
|
|
3504
3512
|
DownloadAsCsv = "downloadAsCsv",
|
|
3505
3513
|
/**
|
|
3506
3514
|
* Emitted when the Download as XLSX action is triggered on an Answer.
|
|
3507
|
-
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
3515
|
+
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
3516
|
+
* subscribe to when download as XLSX is completed. Default is end:true.
|
|
3508
3517
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3509
3518
|
* @example
|
|
3510
3519
|
* ```js
|
|
@@ -3519,7 +3528,8 @@ export declare enum EmbedEvent {
|
|
|
3519
3528
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3520
3529
|
/**
|
|
3521
3530
|
* Emitted when an Answer is deleted in the app
|
|
3522
|
-
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
3531
|
+
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
3532
|
+
* to when delete is completed. Default is end:true.
|
|
3523
3533
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3524
3534
|
* @example
|
|
3525
3535
|
* ```js
|
|
@@ -3546,7 +3556,8 @@ export declare enum EmbedEvent {
|
|
|
3546
3556
|
/**
|
|
3547
3557
|
* Emitted when a user initiates the Pin action to
|
|
3548
3558
|
* add an Answer to a Liveboard.
|
|
3549
|
-
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
3559
|
+
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
3560
|
+
* when pin is completed. Default is end:true.
|
|
3550
3561
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3551
3562
|
* @example
|
|
3552
3563
|
* ```js
|
|
@@ -3660,7 +3671,8 @@ export declare enum EmbedEvent {
|
|
|
3660
3671
|
/**
|
|
3661
3672
|
* Emitted when the **Export TML** action is triggered on an
|
|
3662
3673
|
* an embedded object in the app
|
|
3663
|
-
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
3674
|
+
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
3675
|
+
* to when export is completed. Default is end:true.
|
|
3664
3676
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3665
3677
|
* @example
|
|
3666
3678
|
* ```js
|
|
@@ -3686,7 +3698,8 @@ export declare enum EmbedEvent {
|
|
|
3686
3698
|
SaveAsView = "saveAsView",
|
|
3687
3699
|
/**
|
|
3688
3700
|
* Emitted when the user creates a copy of an Answer.
|
|
3689
|
-
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
3701
|
+
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
3702
|
+
* subscribe to when copy and edit is completed. Default is end:true.
|
|
3690
3703
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3691
3704
|
* @example
|
|
3692
3705
|
* ```js
|
|
@@ -4449,7 +4462,8 @@ export declare enum HostEvent {
|
|
|
4449
4462
|
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
4450
4463
|
* on the most popular column.
|
|
4451
4464
|
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
4452
|
-
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
4465
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
4466
|
+
* **required**.
|
|
4453
4467
|
* @example
|
|
4454
4468
|
* ```js
|
|
4455
4469
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -4645,7 +4659,8 @@ export declare enum HostEvent {
|
|
|
4645
4659
|
* the following parameters:
|
|
4646
4660
|
*
|
|
4647
4661
|
* @param - Includes the following keys:
|
|
4648
|
-
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
4662
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
4663
|
+
* Liveboard.
|
|
4649
4664
|
* Optional when pinning a new chart or table generated from a Search query.
|
|
4650
4665
|
* **Required** in Spotter Embed.
|
|
4651
4666
|
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
@@ -4901,7 +4916,8 @@ export declare enum HostEvent {
|
|
|
4901
4916
|
* This event is not supported in visualization embed and search embed.
|
|
4902
4917
|
* @param - Object parameter. Includes the following keys:
|
|
4903
4918
|
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
4904
|
-
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4919
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4920
|
+
* is **required**.
|
|
4905
4921
|
*
|
|
4906
4922
|
* @example
|
|
4907
4923
|
* ```js
|
|
@@ -5270,8 +5286,9 @@ export declare enum HostEvent {
|
|
|
5270
5286
|
/**
|
|
5271
5287
|
* Update one or several filters applied on a Liveboard.
|
|
5272
5288
|
* @param - Includes the following keys:
|
|
5273
|
-
* - `filter`: A single filter object containing column name, filter operator, and
|
|
5274
|
-
* - `filters`: Multiple filter objects with column name, filter operator,
|
|
5289
|
+
* - `filter`: A single filter object containing column name, filter operator, and
|
|
5290
|
+
* values. - `filters`: Multiple filter objects with column name, filter operator,
|
|
5291
|
+
* and values for each.
|
|
5275
5292
|
*
|
|
5276
5293
|
* Each filter object must include the following attributes:
|
|
5277
5294
|
*
|
|
@@ -5540,8 +5557,8 @@ export declare enum HostEvent {
|
|
|
5540
5557
|
* triggered with a modal to prompt users to
|
|
5541
5558
|
* add a name and description for the Answer.
|
|
5542
5559
|
* @param - Includes the following keys:
|
|
5543
|
-
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
5544
|
-
* - `name`: Optional. Name string for the Answer.
|
|
5560
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
5561
|
+
* embed. - `name`: Optional. Name string for the Answer.
|
|
5545
5562
|
* - `description`: Optional. Description text for the Answer.
|
|
5546
5563
|
* @example
|
|
5547
5564
|
* ```js
|
|
@@ -5736,8 +5753,9 @@ export declare enum HostEvent {
|
|
|
5736
5753
|
/**
|
|
5737
5754
|
* Triggers a new conversation in Spotter embed.
|
|
5738
5755
|
*
|
|
5739
|
-
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
5740
|
-
* Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
5756
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
5757
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
5758
|
+
* instance.
|
|
5741
5759
|
*
|
|
5742
5760
|
* @example
|
|
5743
5761
|
* ```js
|
|
@@ -7543,15 +7561,16 @@ declare enum EmbedErrorCodes {
|
|
|
7543
7561
|
/**
|
|
7544
7562
|
* Error event object emitted when an error occurs in an embedded component.
|
|
7545
7563
|
*
|
|
7546
|
-
* This interface defines the structure of error objects returned by the {@link
|
|
7547
|
-
* event. It provides detailed information about what went wrong,
|
|
7548
|
-
* a human-readable message, and a machine-readable error code.
|
|
7564
|
+
* This interface defines the structure of error objects returned by the {@link
|
|
7565
|
+
* EmbedEvent.Error} event. It provides detailed information about what went wrong,
|
|
7566
|
+
* including the error type, a human-readable message, and a machine-readable error code.
|
|
7549
7567
|
*
|
|
7550
7568
|
* ## Properties
|
|
7551
7569
|
*
|
|
7552
7570
|
* - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
|
|
7553
|
-
* - **message**: Human-readable error description (string or array of strings for
|
|
7554
|
-
* - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
7571
|
+
* - **message**: Human-readable error description (string or array of strings for
|
|
7572
|
+
* multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
7573
|
+
* values
|
|
7555
7574
|
* - **[key: string]**: Additional context-specific for backward compatibility
|
|
7556
7575
|
*
|
|
7557
7576
|
* ## Usage
|
|
@@ -9958,7 +9977,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9958
9977
|
*/
|
|
9959
9978
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
9960
9979
|
/**
|
|
9961
|
-
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
9980
|
+
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
9981
|
+
* mails
|
|
9962
9982
|
*
|
|
9963
9983
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9964
9984
|
* @type {boolean}
|
|
@@ -10546,7 +10566,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10546
10566
|
*/
|
|
10547
10567
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
10548
10568
|
/**
|
|
10549
|
-
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
10569
|
+
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
10570
|
+
* mails
|
|
10550
10571
|
*
|
|
10551
10572
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
10552
10573
|
* @type {boolean}
|
|
@@ -2336,8 +2336,9 @@ export interface HomePageConfig {
|
|
|
2336
2336
|
* *Liveboards* and *Answers*.
|
|
2337
2337
|
* For example: `hiddenListColumns = [ListPageColumns.Author]`
|
|
2338
2338
|
*
|
|
2339
|
-
* **Note**: This option is available only in full app embedding and requires
|
|
2340
|
-
* Starting with version 10.14.0.cl, you can
|
|
2339
|
+
* **Note**: This option is available only in full app embedding and requires
|
|
2340
|
+
* importing the `ListPageColumns` enum. Starting with version 10.14.0.cl, you can
|
|
2341
|
+
* use this attribute to
|
|
2341
2342
|
* hide the columns on all list pages in the *Insights* section.
|
|
2342
2343
|
*
|
|
2343
2344
|
* Supported embed types: `AppEmbed`
|
|
@@ -2377,8 +2378,9 @@ export interface HomePageConfig {
|
|
|
2377
2378
|
/**
|
|
2378
2379
|
* Reorder home page modules.
|
|
2379
2380
|
* To specify the modules, import the `HomepageModule` enum.
|
|
2380
|
-
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2381
|
-
* **Note**: This attribute is not supported in the
|
|
2381
|
+
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2382
|
+
* HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
|
|
2383
|
+
* classic (v1) homepage.
|
|
2382
2384
|
*
|
|
2383
2385
|
* Supported embed types: `AppEmbed`
|
|
2384
2386
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -2690,7 +2692,9 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2690
2692
|
/**
|
|
2691
2693
|
* This flag is used to enable/disable hide irrelevant filters in Liveboard tab
|
|
2692
2694
|
*
|
|
2693
|
-
* **Note**: This feature is supported only if compact header is enabled on your
|
|
2695
|
+
* **Note**: This feature is supported only if compact header is enabled on your
|
|
2696
|
+
* Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled`
|
|
2697
|
+
* attribute.
|
|
2694
2698
|
*
|
|
2695
2699
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2696
2700
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
@@ -2756,9 +2760,9 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2756
2760
|
*/
|
|
2757
2761
|
coverAndFilterOptionInPDF?: boolean;
|
|
2758
2762
|
/**
|
|
2759
|
-
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
2760
|
-
* When enabled, a unified modal is used to manage and update multiple filters
|
|
2761
|
-
* replacing the older individual filter interactions.
|
|
2763
|
+
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
2764
|
+
* (v2). When enabled, a unified modal is used to manage and update multiple filters
|
|
2765
|
+
* at once, replacing the older individual filter interactions.
|
|
2762
2766
|
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
2763
2767
|
*
|
|
2764
2768
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
@@ -2789,7 +2793,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2789
2793
|
*/
|
|
2790
2794
|
isLinkParametersEnabled?: boolean;
|
|
2791
2795
|
/**
|
|
2792
|
-
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
2796
|
+
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
2797
|
+
* liveboard.
|
|
2793
2798
|
*
|
|
2794
2799
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2795
2800
|
* @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
|
|
@@ -3472,7 +3477,8 @@ export declare enum EmbedEvent {
|
|
|
3472
3477
|
Download = "download",
|
|
3473
3478
|
/**
|
|
3474
3479
|
* Emitted when the download action is triggered on an Answer.
|
|
3475
|
-
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
3480
|
+
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
3481
|
+
* subscribe to when download is completed. Default is end:true.
|
|
3476
3482
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3477
3483
|
* @example
|
|
3478
3484
|
* ```js
|
|
@@ -3487,7 +3493,8 @@ export declare enum EmbedEvent {
|
|
|
3487
3493
|
DownloadAsPng = "downloadAsPng",
|
|
3488
3494
|
/**
|
|
3489
3495
|
* Emitted when the Download as PDF action is triggered on an Answer
|
|
3490
|
-
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
3496
|
+
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
3497
|
+
* subscribe to when download as PDF is completed. Default is end:true.
|
|
3491
3498
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3492
3499
|
* @example
|
|
3493
3500
|
* ```js
|
|
@@ -3502,7 +3509,8 @@ export declare enum EmbedEvent {
|
|
|
3502
3509
|
DownloadAsPdf = "downloadAsPdf",
|
|
3503
3510
|
/**
|
|
3504
3511
|
* Emitted when the Download as CSV action is triggered on an Answer.
|
|
3505
|
-
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
3512
|
+
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
3513
|
+
* subscribe to when download as CSV is completed. Default is end:true.
|
|
3506
3514
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3507
3515
|
* @example
|
|
3508
3516
|
* ```js
|
|
@@ -3517,7 +3525,8 @@ export declare enum EmbedEvent {
|
|
|
3517
3525
|
DownloadAsCsv = "downloadAsCsv",
|
|
3518
3526
|
/**
|
|
3519
3527
|
* Emitted when the Download as XLSX action is triggered on an Answer.
|
|
3520
|
-
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
3528
|
+
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
3529
|
+
* subscribe to when download as XLSX is completed. Default is end:true.
|
|
3521
3530
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3522
3531
|
* @example
|
|
3523
3532
|
* ```js
|
|
@@ -3532,7 +3541,8 @@ export declare enum EmbedEvent {
|
|
|
3532
3541
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3533
3542
|
/**
|
|
3534
3543
|
* Emitted when an Answer is deleted in the app
|
|
3535
|
-
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
3544
|
+
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
3545
|
+
* to when delete is completed. Default is end:true.
|
|
3536
3546
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3537
3547
|
* @example
|
|
3538
3548
|
* ```js
|
|
@@ -3559,7 +3569,8 @@ export declare enum EmbedEvent {
|
|
|
3559
3569
|
/**
|
|
3560
3570
|
* Emitted when a user initiates the Pin action to
|
|
3561
3571
|
* add an Answer to a Liveboard.
|
|
3562
|
-
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
3572
|
+
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
3573
|
+
* when pin is completed. Default is end:true.
|
|
3563
3574
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3564
3575
|
* @example
|
|
3565
3576
|
* ```js
|
|
@@ -3673,7 +3684,8 @@ export declare enum EmbedEvent {
|
|
|
3673
3684
|
/**
|
|
3674
3685
|
* Emitted when the **Export TML** action is triggered on an
|
|
3675
3686
|
* an embedded object in the app
|
|
3676
|
-
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
3687
|
+
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
3688
|
+
* to when export is completed. Default is end:true.
|
|
3677
3689
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3678
3690
|
* @example
|
|
3679
3691
|
* ```js
|
|
@@ -3699,7 +3711,8 @@ export declare enum EmbedEvent {
|
|
|
3699
3711
|
SaveAsView = "saveAsView",
|
|
3700
3712
|
/**
|
|
3701
3713
|
* Emitted when the user creates a copy of an Answer.
|
|
3702
|
-
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
3714
|
+
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
3715
|
+
* subscribe to when copy and edit is completed. Default is end:true.
|
|
3703
3716
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3704
3717
|
* @example
|
|
3705
3718
|
* ```js
|
|
@@ -4462,7 +4475,8 @@ export declare enum HostEvent {
|
|
|
4462
4475
|
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
4463
4476
|
* on the most popular column.
|
|
4464
4477
|
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
4465
|
-
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
4478
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
4479
|
+
* **required**.
|
|
4466
4480
|
* @example
|
|
4467
4481
|
* ```js
|
|
4468
4482
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -4658,7 +4672,8 @@ export declare enum HostEvent {
|
|
|
4658
4672
|
* the following parameters:
|
|
4659
4673
|
*
|
|
4660
4674
|
* @param - Includes the following keys:
|
|
4661
|
-
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
4675
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
4676
|
+
* Liveboard.
|
|
4662
4677
|
* Optional when pinning a new chart or table generated from a Search query.
|
|
4663
4678
|
* **Required** in Spotter Embed.
|
|
4664
4679
|
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
@@ -4914,7 +4929,8 @@ export declare enum HostEvent {
|
|
|
4914
4929
|
* This event is not supported in visualization embed and search embed.
|
|
4915
4930
|
* @param - Object parameter. Includes the following keys:
|
|
4916
4931
|
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
4917
|
-
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4932
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4933
|
+
* is **required**.
|
|
4918
4934
|
*
|
|
4919
4935
|
* @example
|
|
4920
4936
|
* ```js
|
|
@@ -5283,8 +5299,9 @@ export declare enum HostEvent {
|
|
|
5283
5299
|
/**
|
|
5284
5300
|
* Update one or several filters applied on a Liveboard.
|
|
5285
5301
|
* @param - Includes the following keys:
|
|
5286
|
-
* - `filter`: A single filter object containing column name, filter operator, and
|
|
5287
|
-
* - `filters`: Multiple filter objects with column name, filter operator,
|
|
5302
|
+
* - `filter`: A single filter object containing column name, filter operator, and
|
|
5303
|
+
* values. - `filters`: Multiple filter objects with column name, filter operator,
|
|
5304
|
+
* and values for each.
|
|
5288
5305
|
*
|
|
5289
5306
|
* Each filter object must include the following attributes:
|
|
5290
5307
|
*
|
|
@@ -5553,8 +5570,8 @@ export declare enum HostEvent {
|
|
|
5553
5570
|
* triggered with a modal to prompt users to
|
|
5554
5571
|
* add a name and description for the Answer.
|
|
5555
5572
|
* @param - Includes the following keys:
|
|
5556
|
-
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
5557
|
-
* - `name`: Optional. Name string for the Answer.
|
|
5573
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
5574
|
+
* embed. - `name`: Optional. Name string for the Answer.
|
|
5558
5575
|
* - `description`: Optional. Description text for the Answer.
|
|
5559
5576
|
* @example
|
|
5560
5577
|
* ```js
|
|
@@ -5749,8 +5766,9 @@ export declare enum HostEvent {
|
|
|
5749
5766
|
/**
|
|
5750
5767
|
* Triggers a new conversation in Spotter embed.
|
|
5751
5768
|
*
|
|
5752
|
-
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
5753
|
-
* Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
5769
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
5770
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
5771
|
+
* instance.
|
|
5754
5772
|
*
|
|
5755
5773
|
* @example
|
|
5756
5774
|
* ```js
|
|
@@ -7532,15 +7550,16 @@ declare enum EmbedErrorCodes {
|
|
|
7532
7550
|
/**
|
|
7533
7551
|
* Error event object emitted when an error occurs in an embedded component.
|
|
7534
7552
|
*
|
|
7535
|
-
* This interface defines the structure of error objects returned by the {@link
|
|
7536
|
-
* event. It provides detailed information about what went wrong,
|
|
7537
|
-
* a human-readable message, and a machine-readable error code.
|
|
7553
|
+
* This interface defines the structure of error objects returned by the {@link
|
|
7554
|
+
* EmbedEvent.Error} event. It provides detailed information about what went wrong,
|
|
7555
|
+
* including the error type, a human-readable message, and a machine-readable error code.
|
|
7538
7556
|
*
|
|
7539
7557
|
* ## Properties
|
|
7540
7558
|
*
|
|
7541
7559
|
* - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
|
|
7542
|
-
* - **message**: Human-readable error description (string or array of strings for
|
|
7543
|
-
* - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
7560
|
+
* - **message**: Human-readable error description (string or array of strings for
|
|
7561
|
+
* multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
7562
|
+
* values
|
|
7544
7563
|
* - **[key: string]**: Additional context-specific for backward compatibility
|
|
7545
7564
|
*
|
|
7546
7565
|
* ## Usage
|
|
@@ -9927,7 +9946,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9927
9946
|
*/
|
|
9928
9947
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
9929
9948
|
/**
|
|
9930
|
-
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
9949
|
+
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
9950
|
+
* mails
|
|
9931
9951
|
*
|
|
9932
9952
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9933
9953
|
* @type {boolean}
|
|
@@ -10515,7 +10535,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10515
10535
|
*/
|
|
10516
10536
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
10517
10537
|
/**
|
|
10518
|
-
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
10538
|
+
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
10539
|
+
* mails
|
|
10519
10540
|
*
|
|
10520
10541
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
10521
10542
|
* @type {boolean}
|