@thoughtspot/visual-embed-sdk 1.20.0 → 1.20.2
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/dist/src/auth.d.ts +38 -4
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +2 -2
- package/dist/src/embed/base.d.ts +25 -14
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +13 -3
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +4 -1
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +2 -2
- package/dist/src/embed/ts-embed.d.ts +35 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +3 -3
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +201 -27
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed.es.js +247 -38
- package/dist/tsembed.js +228 -38
- package/lib/package.json +2 -3
- package/lib/src/auth.d.ts +38 -4
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +17 -2
- package/lib/src/auth.js.map +1 -1
- package/lib/src/embed/app.d.ts +2 -2
- package/lib/src/embed/app.js +1 -1
- package/lib/src/embed/base.d.ts +25 -14
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +24 -4
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +2 -2
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +13 -3
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +12 -2
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +4 -1
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +1 -1
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +2 -2
- package/lib/src/embed/search.js +1 -1
- package/lib/src/embed/ts-embed.d.ts +35 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +35 -2
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/index.d.ts +3 -3
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +1 -1
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +4 -2
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +14 -2
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +201 -27
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +155 -24
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +323 -57
- package/package.json +2 -3
- package/src/auth.ts +51 -5
- package/src/embed/app.ts +2 -2
- package/src/embed/base.spec.ts +3 -3
- package/src/embed/base.ts +30 -9
- package/src/embed/liveboard.ts +13 -3
- package/src/embed/search-bar.tsx +4 -1
- package/src/embed/search.ts +2 -2
- package/src/embed/ts-embed.ts +35 -2
- package/src/index.ts +24 -2
- package/src/react/index.spec.tsx +35 -2
- package/src/react/index.tsx +10 -2
- package/src/types.ts +202 -26
package/lib/src/types.js
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
/**
|
|
10
10
|
* The authentication mechanism for allowing access to the
|
|
11
11
|
* the embedded app
|
|
12
|
+
* @group Authentication / Init
|
|
12
13
|
*/
|
|
13
14
|
// eslint-disable-next-line no-shadow
|
|
14
15
|
export var AuthType;
|
|
@@ -37,7 +38,47 @@ export var AuthType;
|
|
|
37
38
|
AuthType["SAML"] = "SSO_SAML";
|
|
38
39
|
/**
|
|
39
40
|
* SSO using SAML
|
|
40
|
-
* Will make the host application redirect to the SAML Idp.
|
|
41
|
+
* Will make the host application redirect to the SAML Idp. Use this
|
|
42
|
+
* when the idp does not allow itself to be embedded.
|
|
43
|
+
*
|
|
44
|
+
* This redirects the host application to the SAML Idp. The host application
|
|
45
|
+
* will be redirected back to the ThoughtSpot app after authentication.
|
|
46
|
+
* @example
|
|
47
|
+
* ```js
|
|
48
|
+
* init({
|
|
49
|
+
* // ...
|
|
50
|
+
* authType: AuthType.SAMLRedirect,
|
|
51
|
+
* });
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* This opens the SAML Idp in a popup window. The popup is triggered
|
|
55
|
+
* when the user clicks the trigger button. The popup window will be
|
|
56
|
+
* closed automatically after authentication.
|
|
57
|
+
* @example
|
|
58
|
+
* ```js
|
|
59
|
+
* init({
|
|
60
|
+
* // ...
|
|
61
|
+
* authType: AuthType.SAMLRedirect,
|
|
62
|
+
* authTriggerText: 'Login with SAML',
|
|
63
|
+
* authTriggerContainer: '#embed-container',
|
|
64
|
+
* inPopup: true,
|
|
65
|
+
* });
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* Can also use event to trigger the popup flow. Works the same
|
|
69
|
+
* as above example.
|
|
70
|
+
* @example
|
|
71
|
+
* ```js
|
|
72
|
+
* const authEE = init({
|
|
73
|
+
* // ...
|
|
74
|
+
* authType: AuthType.SAMLRedirect,
|
|
75
|
+
* inPopup: true,
|
|
76
|
+
* });
|
|
77
|
+
*
|
|
78
|
+
* someButtonOnYourPage.addEventListener('click', () => {
|
|
79
|
+
* authEE.emit(AuthEvent.TRIGGER_SSO_POPUP);
|
|
80
|
+
* });
|
|
81
|
+
* ```
|
|
41
82
|
*/
|
|
42
83
|
AuthType["SAMLRedirect"] = "SSO_SAML";
|
|
43
84
|
/**
|
|
@@ -49,6 +90,7 @@ export var AuthType;
|
|
|
49
90
|
/**
|
|
50
91
|
* SSO using OIDC
|
|
51
92
|
* Will make the host application redirect to the OIDC Idp.
|
|
93
|
+
* See code samples in {@link SAMLRedirect}.
|
|
52
94
|
*/
|
|
53
95
|
AuthType["OIDCRedirect"] = "SSO_OIDC";
|
|
54
96
|
/**
|
|
@@ -61,6 +103,18 @@ export var AuthType;
|
|
|
61
103
|
* Trusted authentication server, Use your own authentication server
|
|
62
104
|
* which returns a bearer token, generated using the secret_key obtained from
|
|
63
105
|
* ThoughtSpot.
|
|
106
|
+
*
|
|
107
|
+
* @example
|
|
108
|
+
* ```js
|
|
109
|
+
* init({
|
|
110
|
+
* // ...
|
|
111
|
+
* authType: AuthType.TrustedAuthToken,
|
|
112
|
+
* getAuthToken: () => {
|
|
113
|
+
* return fetch('https://my-backend.app/ts-token')
|
|
114
|
+
* .then((response) => response.json())
|
|
115
|
+
* .then((data) => data.token);
|
|
116
|
+
* }
|
|
117
|
+
* ```
|
|
64
118
|
*/
|
|
65
119
|
AuthType["TrustedAuthToken"] = "AuthServer";
|
|
66
120
|
/**
|
|
@@ -143,6 +197,10 @@ export var RuntimeFilterOp;
|
|
|
143
197
|
})(RuntimeFilterOp || (RuntimeFilterOp = {}));
|
|
144
198
|
/**
|
|
145
199
|
* Event types emitted by the embedded ThoughtSpot application.
|
|
200
|
+
*
|
|
201
|
+
* To add an event listener use the corresponding
|
|
202
|
+
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
203
|
+
* @group Events
|
|
146
204
|
*/
|
|
147
205
|
// eslint-disable-next-line no-shadow
|
|
148
206
|
export var EmbedEvent;
|
|
@@ -309,6 +367,12 @@ export var EmbedEvent;
|
|
|
309
367
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
310
368
|
*/
|
|
311
369
|
EmbedEvent["Download"] = "download";
|
|
370
|
+
/**
|
|
371
|
+
* Emitted when the download action is triggered on an answer
|
|
372
|
+
*
|
|
373
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
|
|
374
|
+
*/
|
|
375
|
+
EmbedEvent["DownloadAsPng"] = "downloadAsPng";
|
|
312
376
|
/**
|
|
313
377
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
314
378
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
@@ -471,6 +535,7 @@ export var EmbedEvent;
|
|
|
471
535
|
*
|
|
472
536
|
* To trigger an event use the corresponding
|
|
473
537
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link SearchEmbed.trigger} method.
|
|
538
|
+
* @group Events
|
|
474
539
|
*/
|
|
475
540
|
// eslint-disable-next-line no-shadow
|
|
476
541
|
export var HostEvent;
|
|
@@ -483,11 +548,13 @@ export var HostEvent;
|
|
|
483
548
|
* @param - searchQuery - The search query
|
|
484
549
|
* @param - execute - execute the existing / updated query
|
|
485
550
|
* @example
|
|
551
|
+
* ```js
|
|
486
552
|
* searchEmbed.trigger(HostEvent.Search, {
|
|
487
|
-
*
|
|
488
|
-
*
|
|
489
|
-
*
|
|
553
|
+
* searchQuery: "[sales] by [item type],
|
|
554
|
+
* dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
|
|
555
|
+
* execute: true
|
|
490
556
|
* })
|
|
557
|
+
* ```
|
|
491
558
|
*/
|
|
492
559
|
HostEvent["Search"] = "search";
|
|
493
560
|
/**
|
|
@@ -496,10 +563,14 @@ export var HostEvent;
|
|
|
496
563
|
* eg. { selectedPoints: []}
|
|
497
564
|
* @param - columnGuid - a string guid of the column to drill by. This is optional,
|
|
498
565
|
* if not provided it will auto drill by the configured column.
|
|
499
|
-
* @example
|
|
500
|
-
*
|
|
501
|
-
*
|
|
566
|
+
* @example
|
|
567
|
+
* ```js
|
|
568
|
+
* searchEmbed.trigger(HostEvent.DrillDown, {
|
|
569
|
+
* points: clickedPointData,
|
|
570
|
+
* autoDrillDown: true,
|
|
502
571
|
* })
|
|
572
|
+
* ```
|
|
573
|
+
*
|
|
503
574
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
504
575
|
*/
|
|
505
576
|
HostEvent["DrillDown"] = "triggerDrillDown";
|
|
@@ -538,7 +609,10 @@ export var HostEvent;
|
|
|
538
609
|
* Navigate to a specific page in App embed without any reload.
|
|
539
610
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
540
611
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
541
|
-
* @example
|
|
612
|
+
* @example
|
|
613
|
+
* ```js
|
|
614
|
+
* appEmbed.navigateToPage(-1)
|
|
615
|
+
* ```
|
|
542
616
|
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
|
|
543
617
|
*/
|
|
544
618
|
HostEvent["Navigate"] = "Navigate";
|
|
@@ -546,27 +620,39 @@ export var HostEvent;
|
|
|
546
620
|
* Opens the filter panel for a particular column.
|
|
547
621
|
* Works with Search embed.
|
|
548
622
|
* @param - { columnId: string, name: string, type: INT64/CHAR/DATE, dataType: ATTRIBUTE/MEASURE }
|
|
549
|
-
* @example
|
|
623
|
+
* @example
|
|
624
|
+
* ```js
|
|
625
|
+
* searchEmbed.trigger(HostEvent.OpenFilter, { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
|
|
626
|
+
* ```
|
|
550
627
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
551
628
|
*/
|
|
552
629
|
HostEvent["OpenFilter"] = "openFilter";
|
|
553
630
|
/**
|
|
554
631
|
* Adds the columns to the current Search.
|
|
555
632
|
* @param - { columnIds: string[] }
|
|
556
|
-
* @example
|
|
633
|
+
* @example
|
|
634
|
+
* ```js
|
|
635
|
+
* searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
|
|
636
|
+
* ```
|
|
557
637
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
558
638
|
*/
|
|
559
639
|
HostEvent["AddColumns"] = "addColumns";
|
|
560
640
|
/**
|
|
561
641
|
* Removes a column from the current Search.
|
|
562
642
|
* @param - { columnId: string }
|
|
563
|
-
* @example
|
|
643
|
+
* @example
|
|
644
|
+
* ```js
|
|
645
|
+
* searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
|
|
646
|
+
* ```
|
|
564
647
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
565
648
|
*/
|
|
566
649
|
HostEvent["RemoveColumn"] = "removeColumn";
|
|
567
650
|
/**
|
|
568
651
|
* Gets the current pinboard content.
|
|
569
|
-
* @example
|
|
652
|
+
* @example
|
|
653
|
+
* ```js
|
|
654
|
+
* liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
|
|
655
|
+
* ```
|
|
570
656
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
571
657
|
*/
|
|
572
658
|
HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
|
|
@@ -575,87 +661,124 @@ export var HostEvent;
|
|
|
575
661
|
* @param - incase of Liveboard embed, takes in an object with vizId as a key
|
|
576
662
|
* can be left empty for search and visualization embeds
|
|
577
663
|
* @example
|
|
664
|
+
* ```js
|
|
578
665
|
* liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
579
666
|
* vizEmbed.trigger(HostEvent.Pin)
|
|
580
667
|
* searchEmbed.trigger(HostEvent.Pin)
|
|
668
|
+
* ```
|
|
581
669
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
582
670
|
*/
|
|
583
671
|
HostEvent["Pin"] = "pin";
|
|
584
672
|
/**
|
|
585
673
|
* Triggers the Show Liveboard details action on a Liveboard
|
|
586
|
-
* @example
|
|
674
|
+
* @example
|
|
675
|
+
* ```js
|
|
676
|
+
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
677
|
+
* ```
|
|
587
678
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
588
679
|
*/
|
|
589
680
|
HostEvent["LiveboardInfo"] = "pinboardInfo";
|
|
590
681
|
/**
|
|
591
682
|
* Triggers the Schedule action on a Liveboard
|
|
592
|
-
* @example
|
|
683
|
+
* @example
|
|
684
|
+
* ```js
|
|
685
|
+
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
686
|
+
* ```
|
|
593
687
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
594
688
|
*/
|
|
595
689
|
HostEvent["Schedule"] = "subscription";
|
|
596
690
|
/**
|
|
597
691
|
* Triggers the Manage schedule action on a Liveboard
|
|
598
|
-
* @example
|
|
692
|
+
* @example
|
|
693
|
+
* ```js
|
|
694
|
+
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
695
|
+
* ```
|
|
599
696
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
600
697
|
*/
|
|
601
698
|
HostEvent["SchedulesList"] = "schedule-list";
|
|
602
699
|
/**
|
|
603
700
|
* Triggers the Export TML action on a Liveboard
|
|
604
|
-
* @example
|
|
701
|
+
* @example
|
|
702
|
+
* ```js
|
|
703
|
+
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
704
|
+
* ```
|
|
605
705
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
606
706
|
*/
|
|
607
707
|
HostEvent["ExportTML"] = "exportTSL";
|
|
608
708
|
/**
|
|
609
709
|
* Triggers the Edit TML action on a Liveboard
|
|
610
|
-
* @example
|
|
710
|
+
* @example
|
|
711
|
+
* ```js
|
|
712
|
+
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
713
|
+
* ```
|
|
611
714
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
612
715
|
*/
|
|
613
716
|
HostEvent["EditTML"] = "editTSL";
|
|
614
717
|
/**
|
|
615
718
|
* Triggers the Update TML action on a Liveboard
|
|
616
|
-
* @example
|
|
719
|
+
* @example
|
|
720
|
+
* ```js
|
|
721
|
+
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
722
|
+
* ```
|
|
617
723
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
618
724
|
*/
|
|
619
725
|
HostEvent["UpdateTML"] = "updateTSL";
|
|
620
726
|
/**
|
|
621
727
|
* Triggers the Download PDF action on a Liveboard
|
|
622
|
-
* @example
|
|
728
|
+
* @example
|
|
729
|
+
* ```js
|
|
730
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
|
|
731
|
+
* ```
|
|
623
732
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
624
733
|
*/
|
|
625
734
|
HostEvent["DownloadAsPdf"] = "downloadAsPdf";
|
|
626
735
|
/**
|
|
627
736
|
* Triggers the Make a copy action on a Liveboard, search or visualization
|
|
628
737
|
* @example
|
|
738
|
+
* ```js
|
|
629
739
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
630
740
|
* vizEmbed.trigger(HostEvent.MakeACopy)
|
|
631
741
|
* searchEmbed.trigger(HostEvent.MakeACopy)
|
|
742
|
+
* ```
|
|
632
743
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
633
744
|
*/
|
|
634
745
|
HostEvent["MakeACopy"] = "makeACopy";
|
|
635
746
|
/**
|
|
636
747
|
* Triggers the Delete action on a Liveboard
|
|
637
|
-
* @example
|
|
748
|
+
* @example
|
|
749
|
+
* ```js
|
|
750
|
+
* appEmbed.trigger(HostEvent.Remove)
|
|
751
|
+
* ```
|
|
638
752
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
639
753
|
*/
|
|
640
754
|
HostEvent["Remove"] = "delete";
|
|
641
755
|
/**
|
|
642
756
|
* Triggers the Explore action on a visualization
|
|
643
757
|
* @param - an object with vizId as a key
|
|
644
|
-
* @example
|
|
758
|
+
* @example
|
|
759
|
+
* ```js
|
|
760
|
+
* liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
761
|
+
* ```
|
|
645
762
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
646
763
|
*/
|
|
647
764
|
HostEvent["Explore"] = "explore";
|
|
648
765
|
/**
|
|
649
766
|
* Triggers the Create alert action on a visualization
|
|
650
767
|
* @param - an object with vizId as a key
|
|
651
|
-
* @example
|
|
768
|
+
* @example
|
|
769
|
+
* ```js
|
|
770
|
+
* liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
771
|
+
* ```
|
|
652
772
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
653
773
|
*/
|
|
654
774
|
HostEvent["CreateMonitor"] = "createMonitor";
|
|
655
775
|
/**
|
|
656
776
|
* Triggers the Manage alert action on a visualization
|
|
657
777
|
* @param - an object with vizId as a key
|
|
658
|
-
* @example
|
|
778
|
+
* @example
|
|
779
|
+
* ```js
|
|
780
|
+
* liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
781
|
+
* ```
|
|
659
782
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
660
783
|
*/
|
|
661
784
|
HostEvent["ManageMonitor"] = "manageMonitor";
|
|
@@ -673,9 +796,11 @@ export var HostEvent;
|
|
|
673
796
|
* Triggers the Copy link action on a Liveboard or visualization
|
|
674
797
|
* @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
|
|
675
798
|
* @example
|
|
799
|
+
* ```js
|
|
676
800
|
* liveboardEmbed.trigger(HostEvent.CopyLink)
|
|
677
801
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
678
802
|
* vizEmbed.trigger((HostEvent.CopyLink)
|
|
803
|
+
* ```
|
|
679
804
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
680
805
|
*/
|
|
681
806
|
HostEvent["CopyLink"] = "embedDocument";
|
|
@@ -683,15 +808,20 @@ export var HostEvent;
|
|
|
683
808
|
* Triggers the Present action on a Liveboard or visualization
|
|
684
809
|
* @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
|
|
685
810
|
* @example
|
|
811
|
+
* ```js
|
|
686
812
|
* liveboardEmbed.trigger(HostEvent.Present)
|
|
687
813
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
688
814
|
* vizEmbed.trigger((HostEvent.Present)
|
|
815
|
+
* ```
|
|
689
816
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
690
817
|
*/
|
|
691
818
|
HostEvent["Present"] = "present";
|
|
692
819
|
/**
|
|
693
820
|
* Get TML for the current search.
|
|
694
|
-
* @example
|
|
821
|
+
* @example
|
|
822
|
+
* ```js
|
|
823
|
+
* searchEmbed.trigger(HostEvent.GetTML)
|
|
824
|
+
* ```
|
|
695
825
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
696
826
|
*/
|
|
697
827
|
HostEvent["GetTML"] = "getTML";
|
|
@@ -926,6 +1056,7 @@ export var Action;
|
|
|
926
1056
|
Action["ReplaySearch"] = "replaySearch";
|
|
927
1057
|
Action["ShowUnderlyingData"] = "showUnderlyingData";
|
|
928
1058
|
Action["Download"] = "download";
|
|
1059
|
+
Action["DownloadAsPng"] = "downloadAsPng";
|
|
929
1060
|
Action["DownloadAsPdf"] = "downloadAsPdf";
|
|
930
1061
|
Action["DownloadAsCsv"] = "downloadAsCSV";
|
|
931
1062
|
Action["DownloadAsXlsx"] = "downloadAsXLSX";
|
package/lib/src/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;GAIG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,QAsHX;AAtHD,WAAY,QAAQ;IAChB;;OAEG;IACH,yBAAa,CAAA;IACb;;;;OAIG;IACH,uCAA2B,CAAA;IAC3B;;;;OAIG;IACH,4BAAgB,CAAA;IAChB;;;;OAIG;IACH,6BAAiB,CAAA;IACjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,qCAAyB,CAAA;IACzB;;;;OAIG;IACH,6BAAiB,CAAA;IACjB;;;;OAIG;IACH,qCAAyB,CAAA;IACzB;;;;OAIG;IACH,qCAAyB,CAAA;IACzB;;;;;;;;;;;;;;;;OAgBG;IACH,2CAA+B,CAAA;IAC/B;;;;;OAKG;IACH,+DAAmD,CAAA;IACnD;;;;;OAKG;IACH,2BAAe,CAAA;AACnB,CAAC,EAtHW,QAAQ,KAAR,QAAQ,QAsHnB;AAyZD;;GAEG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,eAyDX;AAzDD,WAAY,eAAe;IACvB;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,wCAAqB,CAAA;IACrB;;OAEG;IACH,8CAA2B,CAAA;IAC3B;;OAEG;IACH,0CAAuB,CAAA;IACvB;;OAEG;IACH,4CAAyB,CAAA;IACzB;;OAEG;IACH,4CAAyB,CAAA;IACzB;;OAEG;IACH,oCAAiB,CAAA;IACjB;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;AACb,CAAC,EAzDW,eAAe,KAAf,eAAe,QAyD1B;AAsBD;;;;;;GAMG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,UAoUX;AApUD,WAAY,UAAU;IAClB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,mCAAqB,CAAA;IACrB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,+CAAiC,CAAA;IACjC;;OAEG;IACH,2CAA6B,CAAA;IAC7B;;;;;OAKG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,uDAAyC,CAAA;IACzC;;;;OAIG;IACH,mDAAqC,CAAA;IACrC;;;;OAIG;IACH,2CAA6B,CAAA;IAC7B;;;;OAIG;IACH,yDAA2C,CAAA;IAC3C;;;;OAIG;IACH,6CAA+B,CAAA;IAC/B;;;OAGG;IACH,6BAAe,CAAA;IACf;;;OAGG;IACH,6BAAe,CAAA;IACf;;OAEG;IACH,mDAAqC,CAAA;IACrC;;;OAGG;IACH,oDAAsC,CAAA;IACtC;;;OAGG;IACH,kDAAoC,CAAA;IACpC;;;;OAIG;IACH,0CAA4B,CAAA;IAC5B;;;;OAIG;IACH,qDAAuC,CAAA;IACvC;;;;OAIG;IACH,2CAA6B,CAAA;IAC7B;;OAEG;IACH,0CAA4B,CAAA;IAC5B;;;OAGG;IACH,8CAAgC,CAAA;IAChC;;;;;OAKG;IACH,+CAAiC,CAAA;IACjC;;;;OAIG;IACH,2CAA6B,CAAA;IAC7B;;;OAGG;IACH,wCAA0B,CAAA;IAC1B;;;OAGG;IACH,0CAA4B,CAAA;IAC5B;;;;;OAKG;IACH,oDAAsC,CAAA;IACtC;;;;OAIG;IACH,uBAAS,CAAA;IACT;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,mCAAqB,CAAA;IACrB;;;;OAIG;IACH,6CAA6B,CAAA;IAC7B;;;OAGG;IACH,6CAA+B,CAAA;IAC/B;;;OAGG;IACH,6CAA+B,CAAA;IAC/B;;;OAGG;IACH,+CAAiC,CAAA;IACjC;;;OAGG;IACH,2CAA6B,CAAA;IAC7B;;;OAGG;IACH,yBAAW,CAAA;IACX;;;OAGG;IACH,6CAA+B,CAAA;IAC/B;;;OAGG;IACH,6BAAe,CAAA;IACf;;;OAGG;IACH,wDAA0C,CAAA;IAC1C;;;OAGG;IACH,wDAA0C,CAAA;IAC1C;;;OAGG;IACH,qEAAuD,CAAA;IACvD;;;OAGG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,iCAAmB,CAAA;IACnB;;;OAGG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,uCAAyB,CAAA;IACzB;;;OAGG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,uDAAyC,CAAA;IACzC;;;OAGG;IACH,yDAA2C,CAAA;IAC3C;;;OAGG;IACH,kCAAoB,CAAA;IACpB;;;OAGG;IACH,4CAA8B,CAAA;IAC9B;;;OAGG;IACH,+CAAiC,CAAA;IACjC;;;OAGG;IACH,uCAAyB,CAAA;IACzB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,iCAAmB,CAAA;IACnB;;;OAGG;IACH,+BAAiB,CAAA;IACjB;;;OAGG;IACH,6CAA+B,CAAA;IAC/B;;;OAGG;IACH,+BAAiB,CAAA;IACjB;;;OAGG;IACH,iCAAmB,CAAA;IACnB;;;OAGG;IACH,wCAA0B,CAAA;IAC1B;;;OAGG;IACH,yDAA2C,CAAA;IAC3C;;;OAGG;IACH,uDAAyC,CAAA;AAC7C,CAAC,EApUW,UAAU,KAAV,UAAU,QAoUrB;AAED;;;;;;;GAOG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,SA2YX;AA3YD,WAAY,SAAS;IACjB;;;;;;;;;;;;;;;OAeG;IACH,8BAAiB,CAAA;IACjB;;;;;;;;;;;;;;;OAeG;IACH,2CAA8B,CAAA;IAC9B;;;OAGG;IACH,8BAAiB,CAAA;IACjB;;;OAGG;IACH,8BAAiB,CAAA;IACjB;;;;;;;OAOG;IACH,sDAAyC,CAAA;IACzC;;;;;;;;;;OAUG;IACH,0DAA6C,CAAA;IAC7C;;;;;;;;;OASG;IACH,kCAAqB,CAAA;IACrB;;;;;;;;;OASG;IACH,sCAAyB,CAAA;IACzB;;;;;;;;OAQG;IACH,sCAAyB,CAAA;IACzB;;;;;;;;OAQG;IACH,0CAA6B,CAAA;IAC7B;;;;;;;OAOG;IACH,sFAAyE,CAAA;IACzE;;;;;;;;;;;OAWG;IACH,wBAAW,CAAA;IACX;;;;;;;OAOG;IACH,2CAA8B,CAAA;IAC9B;;;;;;;OAOG;IACH,sCAAyB,CAAA;IACzB;;;;;;;OAOG;IACH,4CAA+B,CAAA;IAC/B;;;;;;;OAOG;IACH,oCAAuB,CAAA;IACvB;;;;;;;OAOG;IACH,gCAAmB,CAAA;IACnB;;;;;;;OAOG;IACH,oCAAuB,CAAA;IACvB;;;;;;;OAOG;IACH,4CAA+B,CAAA;IAC/B;;;;;;;;;OASG;IACH,oCAAuB,CAAA;IACvB;;;;;;;OAOG;IACH,8BAAiB,CAAA;IACjB;;;;;;;;OAQG;IACH,gCAAmB,CAAA;IACnB;;;;;;;;OAQG;IACH,4CAA+B,CAAA;IAC/B;;;;;;;;OAQG;IACH,4CAA+B,CAAA;IAC/B;;;;;;;;OAQG;IACH,0BAAa,CAAA;IACb;;;;;;;;;;OAUG;IACH,uCAA0B,CAAA;IAC1B;;;;;;;;;;OAUG;IACH,gCAAmB,CAAA;IACnB;;;;;;;OAOG;IACH,8BAAiB,CAAA;IACjB;;;;;;;;OAQG;IACH,sDAAyC,CAAA;IACzC;;;;;;;;;OASG;IACH,8BAAiB,CAAA;IACjB;;;;;;;;;OASG;IACH,4CAA+B,CAAA;IAC/B;;;;;;;OAOG;IACH,kCAAqB,CAAA;IACrB;;;;;;;OAOG;IACH,4CAA+B,CAAA;IAC/B;;;;;;;OAOG;IACH,8CAAiC,CAAA;IACjC;;;;;;OAMG;IACH,4BAAe,CAAA;IACf;;;;;;OAMG;IACH,0BAAa,CAAA;IACb;;;;;;;OAOG;IACH,4CAA+B,CAAA;IAC/B;;;;;;;OAOG;IACH,mDAAsC,CAAA;IACtC;;;;;;;OAOG;IACH,gDAAmC,CAAA;IACnC;;;;;OAKG;IACH,wCAA2B,CAAA;AAC/B,CAAC,EA3YW,SAAS,KAAT,SAAS,QA2YpB;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,oBAaX;AAbD,WAAY,oBAAoB;IAC5B;;OAEG;IACH,uCAAe,CAAA;IACf;;OAEG;IACH,8CAAsB,CAAA;IACtB;;OAEG;IACH,2CAAmB,CAAA;AACvB,CAAC,EAbW,oBAAoB,KAApB,oBAAoB,QAa/B;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,KAyCX;AAzCD,WAAY,KAAK;IACb,oCAA2B,CAAA;IAC3B,0CAAiC,CAAA;IACjC,yCAAgC,CAAA;IAChC,4CAAmC,CAAA;IACnC,kCAAyB,CAAA;IACzB,uEAA8D,CAAA;IAC9D,oCAA2B,CAAA;IAC3B,mCAA0B,CAAA;IAC1B,oCAA2B,CAAA;IAC3B,kCAAyB,CAAA;IACzB,wDAA+C,CAAA;IAC/C,kDAAyC,CAAA;IACzC,kCAAyB,CAAA;IACzB,6DAAoD,CAAA;IACpD,oBAAW,CAAA;IACX,gDAAuC,CAAA;IACvC,wCAA+B,CAAA;IAC/B,4CAAmC,CAAA;IACnC,6CAAoC,CAAA;IACpC,sCAA6B,CAAA;IAC7B,gCAAuB,CAAA;IACvB,+BAAsB,CAAA;IACtB,0CAAiC,CAAA;IACjC,wCAA+B,CAAA;IAC/B,yCAAgC,CAAA;IAChC,sCAA6B,CAAA;IAC7B,sDAA6C,CAAA;IAC7C,4CAAmC,CAAA;IACnC,mDAA0C,CAAA;IAC1C,kCAAyB,CAAA;IACzB,0BAAiB,CAAA;IACjB,oCAA2B,CAAA;IAC3B,wDAA+C,CAAA;IAC/C,wDAAwD;IACxD,8BAAqB,CAAA;IACrB,qCAA4B,CAAA;IAC5B,kCAAyB,CAAA;IACzB,+DAAsD,CAAA;IACtD,sCAA6B,CAAA;IAC7B,8CAAqC,CAAA;AACzC,CAAC,EAzCW,KAAK,KAAL,KAAK,QAyChB;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,MA2MX;AA3MD,WAAY,MAAM;IACd,uBAAa,CAAA;IACb;;OAEG;IACH,2BAAiB,CAAA;IACjB;;OAEG;IACH,uCAA6B,CAAA;IAC7B,mCAAyB,CAAA;IACzB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,oCAA0B,CAAA;IAC1B;;OAEG;IACH,qCAA2B,CAAA;IAC3B,mCAAyB,CAAA;IACzB,yCAA+B,CAAA;IAC/B,yBAAe,CAAA;IACf,iCAAuB,CAAA;IACvB,6CAAmC,CAAA;IACnC,qDAA2C,CAAA;IAC3C,iDAAuC,CAAA;IACvC,mCAAyB,CAAA;IACzB,uCAA6B,CAAA;IAC7B;;OAEG;IACH,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B;;OAEG;IACH,2CAAiC,CAAA;IACjC;;OAEG;IACH,uCAA6B,CAAA;IAC7B,+BAAqB,CAAA;IACrB;;OAEG;IACH,uCAA6B,CAAA;IAC7B,mDAAyC,CAAA;IACzC,+BAAqB,CAAA;IACrB,yCAA6B,CAAA;IAC7B,yCAA+B,CAAA;IAC/B,yCAA+B,CAAA;IAC/B,2CAAiC,CAAA;IACjC;;OAEG;IACH,yCAA+B,CAAA;IAC/B,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,6BAAmB,CAAA;IACnB,6BAAmB,CAAA;IACnB,mCAAyB,CAAA;IACzB,uBAAa,CAAA;IACb,iCAAuB,CAAA;IACvB,2BAAiB,CAAA;IACjB;;OAEG;IACH,6BAAmB,CAAA;IACnB;;OAEG;IACH,+BAAqB,CAAA;IACrB;;OAEG;IACH,2BAAiB,CAAA;IACjB;;OAEG;IACH,mDAAyC,CAAA;IACzC;;OAEG;IACH,uCAA6B,CAAA;IAC7B,wCAA8B,CAAA;IAC9B;;OAEG;IACH,6CAAmC,CAAA;IACnC;;OAEG;IACH,2DAAiD,CAAA;IACjD,qBAAW,CAAA;IACX;;OAEG;IACH,uCAA6B,CAAA;IAC7B,uCAA6B,CAAA;IAC7B,6BAAmB,CAAA;IACnB,oDAA0C,CAAA;IAC1C,oDAA0C,CAAA;IAC1C,iEAAuD,CAAA;IACvD,yDAA+C,CAAA;IAC/C;;OAEG;IACH,8CAAoC,CAAA;IACpC,wDAA8C,CAAA;IAC9C,mDAAyC,CAAA;IACzC;;OAEG;IACH,6BAAmB,CAAA;IACnB,yCAA+B,CAAA;IAC/B,qDAA2C,CAAA;IAC3C;;OAEG;IACH,yCAA+B,CAAA;IAC/B;;OAEG;IACH,qDAA2C,CAAA;IAC3C;;OAEG;IACH,2CAAiC,CAAA;IACjC;;OAEG;IACH,qCAA2B,CAAA;IAC3B;;OAEG;IACH,yCAA+B,CAAA;IAC/B;;OAEG;IACH,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,gDAAsC,CAAA;IACtC,6CAAmC,CAAA;IACnC;;OAEG;IACH,wDAA8C,CAAA;IAC9C;;OAEG;IACH,qEAA2D,CAAA;IAC3D;;OAEG;IACH,iDAAuC,CAAA;IACvC;;OAEG;IACH,mDAAyC,CAAA;IACzC;;OAEG;IACH,2CAAiC,CAAA;IACjC;;OAEG;IACH,iEAAuD,CAAA;IACvD;;OAEG;IACH,uCAA6B,CAAA;IAC7B;;OAEG;IACH,yCAA+B,CAAA;IAC/B;;OAEG;IACH,+CAAqC,CAAA;IACrC;;OAEG;IACH,2CAAiC,CAAA;IACjC;;OAEG;IACH,uCAA6B,CAAA;IAC7B;;OAEG;IACH,uDAA6C,CAAA;IAC7C;;OAEG;IACH,uDAA6C,CAAA;IAC7C;;OAEG;IACH,2CAAiC,CAAA;IACjC;;OAEG;IACH,6CAAmC,CAAA;AACvC,CAAC,EA3MW,MAAM,KAAN,MAAM,QA2MjB;AAQD,qCAAqC;AACrC,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,sDAAqC,CAAA;IACrC,sEAAqD,CAAA;AACzD,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAMD,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IACxB,uCAAmB,CAAA;IACnB,+CAA2B,CAAA;IAC3B,qDAAiC,CAAA;IACjC,yCAAqB,CAAA;AACzB,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B;AAED,MAAM,CAAN,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACjC,sDAAyB,CAAA;IACzB,wDAA2B,CAAA;AAC/B,CAAC,EAHW,yBAAyB,KAAzB,yBAAyB,QAGpC"}
|