@thoughtspot/visual-embed-sdk 1.22.0 → 1.23.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.
Files changed (69) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/css-variables.d.ts +1 -1
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/liveboard.d.ts +6 -0
  5. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  6. package/cjs/src/embed/liveboard.js +4 -1
  7. package/cjs/src/embed/liveboard.js.map +1 -1
  8. package/cjs/src/embed/liveboard.spec.js +12 -0
  9. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  10. package/cjs/src/embed/sage.d.ts +1 -0
  11. package/cjs/src/embed/sage.d.ts.map +1 -1
  12. package/cjs/src/embed/sage.js +1 -0
  13. package/cjs/src/embed/sage.js.map +1 -1
  14. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  15. package/cjs/src/embed/ts-embed.js +20 -1
  16. package/cjs/src/embed/ts-embed.js.map +1 -1
  17. package/cjs/src/embed/ts-embed.spec.js +69 -0
  18. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  19. package/cjs/src/types.d.ts +890 -210
  20. package/cjs/src/types.d.ts.map +1 -1
  21. package/cjs/src/types.js +830 -194
  22. package/cjs/src/types.js.map +1 -1
  23. package/dist/src/css-variables.d.ts +1 -1
  24. package/dist/src/css-variables.d.ts.map +1 -1
  25. package/dist/src/embed/liveboard.d.ts +6 -0
  26. package/dist/src/embed/liveboard.d.ts.map +1 -1
  27. package/dist/src/embed/sage.d.ts +1 -0
  28. package/dist/src/embed/sage.d.ts.map +1 -1
  29. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  30. package/dist/src/types.d.ts +890 -210
  31. package/dist/src/types.d.ts.map +1 -1
  32. package/dist/tsembed-react.es.js +856 -197
  33. package/dist/tsembed-react.js +837 -188
  34. package/dist/tsembed.es.js +856 -197
  35. package/dist/tsembed.js +837 -188
  36. package/dist/visual-embed-sdk-react-full.d.ts +898 -211
  37. package/dist/visual-embed-sdk-react.d.ts +898 -211
  38. package/dist/visual-embed-sdk.d.ts +898 -211
  39. package/lib/package.json +1 -1
  40. package/lib/src/css-variables.d.ts +1 -1
  41. package/lib/src/css-variables.d.ts.map +1 -1
  42. package/lib/src/embed/liveboard.d.ts +6 -0
  43. package/lib/src/embed/liveboard.d.ts.map +1 -1
  44. package/lib/src/embed/liveboard.js +4 -1
  45. package/lib/src/embed/liveboard.js.map +1 -1
  46. package/lib/src/embed/liveboard.spec.js +12 -0
  47. package/lib/src/embed/liveboard.spec.js.map +1 -1
  48. package/lib/src/embed/sage.d.ts +1 -0
  49. package/lib/src/embed/sage.d.ts.map +1 -1
  50. package/lib/src/embed/sage.js +1 -0
  51. package/lib/src/embed/sage.js.map +1 -1
  52. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  53. package/lib/src/embed/ts-embed.js +20 -1
  54. package/lib/src/embed/ts-embed.js.map +1 -1
  55. package/lib/src/embed/ts-embed.spec.js +69 -0
  56. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  57. package/lib/src/types.d.ts +890 -210
  58. package/lib/src/types.d.ts.map +1 -1
  59. package/lib/src/types.js +830 -194
  60. package/lib/src/types.js.map +1 -1
  61. package/lib/src/visual-embed-sdk.d.ts +898 -211
  62. package/package.json +1 -1
  63. package/src/css-variables.ts +1 -1
  64. package/src/embed/liveboard.spec.ts +16 -0
  65. package/src/embed/liveboard.ts +10 -0
  66. package/src/embed/sage.ts +1 -0
  67. package/src/embed/ts-embed.spec.ts +79 -0
  68. package/src/embed/ts-embed.ts +26 -1
  69. package/src/types.ts +903 -210
@@ -343,7 +343,7 @@ var AuthType;
343
343
  * .then((data) => data.token);
344
344
  * }
345
345
  * ```
346
- * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
346
+ * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
347
347
  */
348
348
  AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
349
349
  /**
@@ -493,7 +493,7 @@ var EmbedEvent;
493
493
  * One or more data columns have been selected.
494
494
  *
495
495
  * @returns columnIds - the list of columns
496
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
496
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
497
497
  */
498
498
  EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
499
499
  /**
@@ -526,7 +526,7 @@ var EmbedEvent;
526
526
  * });
527
527
  * ```
528
528
  * @return viz, clickedPoint - metadata about point that is clicked
529
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
529
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
530
530
  * @important
531
531
  */
532
532
  EmbedEvent["VizPointClick"] = "vizPointClick";
@@ -576,7 +576,7 @@ var EmbedEvent;
576
576
  * Emitted when the "Get Data" button in Search Bar embed
577
577
  * is clicked.
578
578
  *
579
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
579
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
580
580
  */
581
581
  EmbedEvent["GetDataClick"] = "getDataClick";
582
582
  /**
@@ -606,13 +606,13 @@ var EmbedEvent;
606
606
  /**
607
607
  * Emitted when any modal is opened in the app
608
608
  *
609
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
609
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
610
610
  */
611
611
  EmbedEvent["DialogOpen"] = "dialog-open";
612
612
  /**
613
613
  * Emitted when any modal is closed in the app
614
614
  *
615
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
615
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
616
616
  */
617
617
  EmbedEvent["DialogClose"] = "dialog-close";
618
618
  /**
@@ -620,136 +620,136 @@ var EmbedEvent;
620
620
  * You can use this event as a hook to trigger
621
621
  * other events on the rendered Liveboard.
622
622
  *
623
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
623
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
624
624
  */
625
625
  EmbedEvent["LiveboardRendered"] = "PinboardRendered";
626
626
  /**
627
627
  * This can be used to register an event listener which
628
628
  * is triggered on all events.
629
629
  *
630
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
630
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
631
631
  */
632
632
  EmbedEvent["ALL"] = "*";
633
633
  /**
634
- * Emitted when answer is saved in the app
634
+ * Emitted when an Answer is saved in the app
635
635
  *
636
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
636
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
637
637
  */
638
638
  EmbedEvent["Save"] = "save";
639
639
  /**
640
640
  * Emitted when the download action is triggered on an answer
641
641
  *
642
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
642
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
643
643
  */
644
644
  EmbedEvent["Download"] = "download";
645
645
  /**
646
646
  * Emitted when the download action is triggered on an answer
647
647
  *
648
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
648
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
649
649
  */
650
650
  EmbedEvent["DownloadAsPng"] = "downloadAsPng";
651
651
  /**
652
652
  * Emitted when the Download as PDF action is triggered on an answer
653
653
  *
654
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
654
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
655
655
  */
656
656
  EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
657
657
  /**
658
658
  * Emitted when the Download as CSV action is triggered on an answer
659
659
  *
660
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
660
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
661
661
  */
662
662
  EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
663
663
  /**
664
664
  * Emitted when the Download as XLSX action is triggered on an answer
665
665
  *
666
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
666
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
667
667
  */
668
668
  EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
669
669
  /**
670
670
  * Emitted when an answer is deleted in the app
671
671
  *
672
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
672
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
673
673
  */
674
674
  EmbedEvent["AnswerDelete"] = "answerDelete";
675
675
  /**
676
676
  * Emitted when an answer is pinned to a Liveboard
677
677
  *
678
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
678
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
679
679
  */
680
680
  EmbedEvent["Pin"] = "pin";
681
681
  /**
682
682
  * Emitted when SpotIQ analysis is triggered
683
683
  *
684
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
684
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
685
685
  */
686
686
  EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
687
687
  /**
688
688
  * Emitted when a user shares an object with another user or group
689
689
  *
690
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
690
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
691
691
  */
692
692
  EmbedEvent["Share"] = "share";
693
693
  /**
694
694
  * Emitted when a user clicks the Include action to include a specific value or data
695
695
  * on a chart or table
696
696
  *
697
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
697
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
698
698
  */
699
699
  EmbedEvent["DrillInclude"] = "context-menu-item-include";
700
700
  /**
701
701
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
702
702
  * on a chart or table
703
703
  *
704
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
704
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
705
705
  */
706
706
  EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
707
707
  /**
708
708
  * Emitted when copied column value on the app
709
709
  *
710
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
710
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
711
711
  */
712
712
  EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
713
713
  /**
714
714
  * Emitted when a user clicks the Update TML action
715
715
  *
716
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
716
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
717
717
  */
718
718
  EmbedEvent["UpdateTML"] = "updateTSL";
719
719
  /**
720
720
  * Emitted when a user clicks the Edit TML action
721
721
  *
722
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
722
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
723
723
  */
724
724
  EmbedEvent["EditTML"] = "editTSL";
725
725
  /**
726
726
  * Emitted when ExportTML trigger in answer on the app
727
727
  *
728
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
728
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
729
729
  */
730
730
  EmbedEvent["ExportTML"] = "exportTSL";
731
731
  /**
732
732
  * Emitted when an answer is saved as a view
733
733
  *
734
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
734
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
735
735
  */
736
736
  EmbedEvent["SaveAsView"] = "saveAsView";
737
737
  /**
738
738
  * Emitted when copy of existing answer on the app
739
739
  *
740
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
740
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
741
741
  */
742
742
  EmbedEvent["CopyAEdit"] = "copyAEdit";
743
743
  /**
744
744
  * Emitted when a user clicks Show underlying data on an answe
745
745
  *
746
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
746
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
747
747
  */
748
748
  EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
749
749
  /**
750
750
  * Emitted when an answer is switched to a chart or table view
751
751
  *
752
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
752
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
753
753
  */
754
754
  EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
755
755
  /**
@@ -761,67 +761,67 @@ var EmbedEvent;
761
761
  /**
762
762
  * Emitted when a user clicks Show Liveboard details on a Liveboard
763
763
  *
764
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
764
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
765
765
  */
766
766
  EmbedEvent["LiveboardInfo"] = "pinboardInfo";
767
767
  /**
768
768
  * Emitted when a user clicks on the Favorite icon on a Liveboard
769
769
  *
770
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
770
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
771
771
  */
772
772
  EmbedEvent["AddToFavorites"] = "addToFavorites";
773
773
  /**
774
774
  * Emitted when a user clicks Schedule on a Liveboard
775
775
  *
776
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
776
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
777
777
  */
778
778
  EmbedEvent["Schedule"] = "subscription";
779
779
  /**
780
780
  * Emitted when a user clicks Edit on a Liveboard or visualization
781
781
  *
782
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
782
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
783
783
  */
784
784
  EmbedEvent["Edit"] = "edit";
785
785
  /**
786
786
  * Emitted when a user clicks Make a copy on a Liveboard
787
787
  *
788
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
788
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
789
789
  */
790
790
  EmbedEvent["MakeACopy"] = "makeACopy";
791
791
  /**
792
792
  * Emitted when a user clicks Present on a Liveboard or visualization
793
793
  *
794
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
794
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
795
795
  */
796
796
  EmbedEvent["Present"] = "present";
797
797
  /**
798
798
  * Emitted when a user clicks Delete on a Liveboard
799
799
  *
800
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
800
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
801
801
  */
802
802
  EmbedEvent["Delete"] = "delete";
803
803
  /**
804
804
  * Emitted when a user clicks Manage schedules on a Liveboard
805
805
  *
806
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
806
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
807
807
  */
808
808
  EmbedEvent["SchedulesList"] = "schedule-list";
809
809
  /**
810
810
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
811
811
  *
812
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
812
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
813
813
  */
814
814
  EmbedEvent["Cancel"] = "cancel";
815
815
  /**
816
816
  * Emitted when a user clicks Explore on a visualization
817
817
  *
818
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
818
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
819
819
  */
820
820
  EmbedEvent["Explore"] = "explore";
821
821
  /**
822
822
  * Emitted when a user clicks Copy link action on a visualization
823
823
  *
824
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
824
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
825
825
  */
826
826
  EmbedEvent["CopyLink"] = "embedDocument";
827
827
  /**
@@ -842,6 +842,12 @@ var EmbedEvent;
842
842
  * @hidden
843
843
  */
844
844
  EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
845
+ /**
846
+ * Emitted when a user changes any filter on a Liveboard.
847
+ *
848
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
849
+ */
850
+ EmbedEvent["FilterChanged"] = "filterChanged";
845
851
  })(EmbedEvent || (EmbedEvent = {}));
846
852
  /**
847
853
  * Event types that can be triggered by the host application
@@ -869,13 +875,14 @@ var EmbedEvent;
869
875
  var HostEvent;
870
876
  (function (HostEvent) {
871
877
  /**
872
- * Trigger a search
873
- *
878
+ * Triggers a search query in AppEmbed and SearchEmbed
879
+ * deployments.
880
+ * Includes the following properties:
874
881
  * @param - dataSourceIds - The data source GUID to Search on
875
882
  * - Although an array, only a single source
876
- * is supported at this time.
877
- * @param - searchQuery - The search query
878
- * @param - execute - execute the existing / updated query
883
+ * is supported.
884
+ * @param - searchQuery - Query string with search tokens
885
+ * @param - execute - executes the existing / updated query
879
886
  * @example
880
887
  * ```js
881
888
  * searchEmbed.trigger(HostEvent.Search, {
@@ -887,13 +894,13 @@ var HostEvent;
887
894
  */
888
895
  HostEvent["Search"] = "search";
889
896
  /**
890
- * Trigger a drill on certain points by certain column
891
- *
897
+ * Triggers a drill on certain points of the specified column
898
+ * Includes the following properties:
892
899
  * @param - points - an object containing selectedPoints/clickedPoints
893
- * eg. { selectedPoints: []}
894
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
895
- * if not provided it will auto drill by the configured
896
- * column.
900
+ * to drill to. For example, { selectedPoints: []}
901
+ * @param - columnGuid - Optional. GUID of the column to drill
902
+ * by. If not provided it will auto drill by the configured
903
+ * column.
897
904
  * @example
898
905
  * ```js
899
906
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -926,17 +933,17 @@ var HostEvent;
926
933
  */
927
934
  HostEvent["Reload"] = "reload";
928
935
  /**
929
- * Set the visible visualizations on a Liveboard.
936
+ * Sets the visible visualizations on a Liveboard.
930
937
  *
931
- * @param - an array of ids of visualizations to show, the ids not passed
932
- * will be hidden.
938
+ * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
939
+ * in this parameter will be hidden.
933
940
  * @example
934
941
  * ```js
935
942
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
936
943
  * '730496d6-6903-4601-937e-2c691821af3c',
937
944
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
938
945
  * ```
939
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
946
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
940
947
  */
941
948
  HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
942
949
  /**
@@ -953,9 +960,18 @@ var HostEvent;
953
960
  */
954
961
  HostEvent["SetActiveTab"] = "SetActiveTab";
955
962
  /**
956
- * Update the runtime filters. The runtime filters passed here are extended
957
- * on to the existing runtime filters if they exist.
958
- *
963
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
964
+ * runtime filters passed here are appended to the existing runtime
965
+ * filters.
966
+ * Pass an array of runtime filters with the following attributes:
967
+ * `columnName`
968
+ * _String_. The name of the column to filter on.
969
+ * `operator`
970
+ * Runtime filter operator to apply. For information,
971
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
972
+ * `values`
973
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
974
+ * such as BW and IN accept multiple operands.
959
975
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
960
976
  * @example
961
977
  * ```js
@@ -964,25 +980,24 @@ var HostEvent;
964
980
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
965
981
  * ])
966
982
  * ```
967
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
983
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
968
984
  * @important
969
985
  */
970
986
  HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
971
987
  /**
972
- * Navigate to a specific page in App embed without any reload.
988
+ * Navigate to a specific page in the embedded application without reloading the page.
973
989
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
974
- *
975
990
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
976
991
  * @example
977
992
  * ```js
978
993
  * appEmbed.navigateToPage(-1)
979
994
  * ```
980
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
995
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
981
996
  */
982
997
  HostEvent["Navigate"] = "Navigate";
983
998
  /**
984
999
  * Opens the filter panel for a particular column.
985
- * Works with Search embed.
1000
+ * Works with Search and Liveboard embed.
986
1001
  *
987
1002
  * @param - { columnId: string,
988
1003
  * name: string,
@@ -991,233 +1006,257 @@ var HostEvent;
991
1006
  * @example
992
1007
  * ```js
993
1008
  * searchEmbed.trigger(HostEvent.OpenFilter,
994
- * { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
1009
+ * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
1010
+ * LiveboardEmbed.trigger(HostEvent.OpenFilter,
1011
+ * { columnId: '<column-GUID>'})
995
1012
  * ```
996
1013
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
997
1014
  */
998
1015
  HostEvent["OpenFilter"] = "openFilter";
999
1016
  /**
1000
- * Adds the columns to the current Search.
1017
+ * Adds columns to the current search query.
1001
1018
  *
1002
1019
  * @param - { columnIds: string[] }
1003
1020
  * @example
1004
1021
  * ```js
1005
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
1022
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
1006
1023
  * ```
1007
1024
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1008
1025
  */
1009
1026
  HostEvent["AddColumns"] = "addColumns";
1010
1027
  /**
1011
- * Removes a column from the current Search.
1028
+ * Removes a column from the current search query.
1012
1029
  *
1013
1030
  * @param - { columnId: string }
1014
1031
  * @example
1015
1032
  * ```js
1016
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
1033
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
1017
1034
  * ```
1018
1035
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1019
1036
  */
1020
1037
  HostEvent["RemoveColumn"] = "removeColumn";
1021
1038
  /**
1022
- * Gets the current pinboard content.
1039
+ * Gets the current Liveboard content.
1023
1040
  *
1024
1041
  * @example
1025
1042
  * ```js
1026
1043
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
1027
1044
  * ```
1028
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
1045
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
1029
1046
  */
1030
1047
  HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
1031
1048
  /**
1032
- * Triggers the Pin action on an embedded object
1049
+ * Triggers the **Pin** action on an embedded object
1033
1050
  *
1034
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1035
- * can be left empty for search and visualization embeds
1051
+ * @param - Liveboard embed takes the `vizId` as a
1052
+ * key. Can be left undefined when embedding Search, full app or
1053
+ * a visualization.
1036
1054
  * @example
1037
1055
  * ```js
1038
1056
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1057
+ * ```
1058
+ * ```js
1039
1059
  * vizEmbed.trigger(HostEvent.Pin)
1060
+ * ```
1061
+ * ```js
1040
1062
  * searchEmbed.trigger(HostEvent.Pin)
1041
1063
  * ```
1042
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1064
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1043
1065
  */
1044
1066
  HostEvent["Pin"] = "pin";
1045
1067
  /**
1046
- * Triggers the Show Liveboard details action on a Liveboard
1068
+ * Triggers the **Show Liveboard details** action on a Liveboard
1047
1069
  *
1048
1070
  * @example
1049
1071
  * ```js
1050
1072
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
1051
1073
  * ```
1052
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1074
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1053
1075
  */
1054
1076
  HostEvent["LiveboardInfo"] = "pinboardInfo";
1055
1077
  /**
1056
- * Triggers the Schedule action on a Liveboard
1078
+ * Triggers the **Schedule** action on a Liveboard
1057
1079
  *
1058
1080
  * @example
1059
1081
  * ```js
1060
1082
  * liveboardEmbed.trigger(HostEvent.Schedule)
1061
1083
  * ```
1062
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1084
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1063
1085
  */
1064
1086
  HostEvent["Schedule"] = "subscription";
1065
1087
  /**
1066
- * Triggers the Manage schedule action on a Liveboard
1088
+ * Triggers the **Manage schedule** action on a Liveboard
1067
1089
  *
1068
1090
  * @example
1069
1091
  * ```js
1070
1092
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
1071
1093
  * ```
1072
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1094
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1073
1095
  */
1074
1096
  HostEvent["SchedulesList"] = "schedule-list";
1075
1097
  /**
1076
- * Triggers the Export TML action on a Liveboard
1098
+ * Triggers the **Export TML** action on a Liveboard
1077
1099
  *
1078
1100
  * @example
1079
1101
  * ```js
1080
1102
  * liveboardEmbed.trigger(HostEvent.ExportTML)
1081
1103
  * ```
1082
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1104
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1083
1105
  */
1084
1106
  HostEvent["ExportTML"] = "exportTSL";
1085
1107
  /**
1086
- * Triggers the Edit TML action on a Liveboard
1108
+ * Triggers the **Edit TML** action on a Liveboard
1087
1109
  *
1088
1110
  * @example
1089
1111
  * ```js
1090
1112
  * liveboardEmbed.trigger(HostEvent.EditTML)
1091
1113
  * ```
1092
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1114
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1093
1115
  */
1094
1116
  HostEvent["EditTML"] = "editTSL";
1095
1117
  /**
1096
- * Triggers the Update TML action on a Liveboard
1118
+ * Triggers the **Update TML** action on a Liveboard
1097
1119
  *
1098
1120
  * @example
1099
1121
  * ```js
1100
1122
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
1101
1123
  * ```
1102
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1124
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1103
1125
  */
1104
1126
  HostEvent["UpdateTML"] = "updateTSL";
1105
1127
  /**
1106
- * Triggers the Download PDF action on a Liveboard
1128
+ * Triggers the **Download PDF** action on a Liveboard
1107
1129
  *
1108
1130
  * @example
1109
1131
  * ```js
1110
1132
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
1111
1133
  * ```
1112
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1134
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1113
1135
  */
1114
1136
  HostEvent["DownloadAsPdf"] = "downloadAsPdf";
1115
1137
  /**
1116
- * Triggers the Make a copy action on a Liveboard, search or visualization
1138
+ * Triggers the **Make a copy** action on a Liveboard, Search, or
1139
+ * visualization page
1117
1140
  *
1118
1141
  * @example
1119
1142
  * ```js
1120
1143
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1144
+ * ```
1145
+ * ```js
1121
1146
  * vizEmbed.trigger(HostEvent.MakeACopy)
1147
+ * ```
1148
+ * ```js
1122
1149
  * searchEmbed.trigger(HostEvent.MakeACopy)
1123
1150
  * ```
1124
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1151
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1125
1152
  */
1126
1153
  HostEvent["MakeACopy"] = "makeACopy";
1127
1154
  /**
1128
- * Triggers the Delete action on a Liveboard
1155
+ * Triggers the **Delete** action on a Liveboard
1129
1156
  *
1130
1157
  * @example
1131
1158
  * ```js
1132
1159
  * appEmbed.trigger(HostEvent.Remove)
1133
1160
  * ```
1134
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1161
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1135
1162
  */
1136
1163
  HostEvent["Remove"] = "delete";
1137
1164
  /**
1138
- * Triggers the Explore action on a visualization
1165
+ * Triggers the **Explore* action on a visualization
1139
1166
  *
1140
- * @param - an object with vizId as a key
1167
+ * @param - an object with `vizId` as a key
1141
1168
  * @example
1142
1169
  * ```js
1143
1170
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1144
1171
  * ```
1145
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1172
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1146
1173
  */
1147
1174
  HostEvent["Explore"] = "explore";
1148
1175
  /**
1149
- * Triggers the Create alert action on a visualization
1176
+ * Triggers the **Create alert** action on a visualization
1150
1177
  *
1151
- * @param - an object with vizId as a key
1178
+ * @param - an object with `vizId` as a key
1152
1179
  * @example
1153
1180
  * ```js
1154
1181
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
1155
1182
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1156
1183
  * })
1157
1184
  * ```
1158
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1185
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1159
1186
  */
1160
1187
  HostEvent["CreateMonitor"] = "createMonitor";
1161
1188
  /**
1162
- * Triggers the Manage alert action on a visualization
1189
+ * Triggers the **Manage alerts** action on a visualization
1163
1190
  *
1164
- * @param - an object with vizId as a key
1191
+ * @param - an object with `vizId` as a key
1165
1192
  * @example
1166
1193
  * ```js
1167
1194
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
1168
1195
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1169
1196
  * })
1170
1197
  * ```
1171
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1198
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1172
1199
  */
1173
1200
  HostEvent["ManageMonitor"] = "manageMonitor";
1174
1201
  /**
1175
- * Triggers the Edit action on a Liveboard or visualization
1202
+ * Triggers the **Edit** action on a Liveboard or visualization
1176
1203
  *
1177
- * @param - object - to trigger the action for a specfic visualization
1178
- * in Liveboard embed, pass in vizId as a key
1204
+ * @param - object - To trigger the action for a specific visualization
1205
+ * in Liveboard embed, pass in `vizId` as a key.
1206
+ * Can be left undefined when embedding Search, full app, or
1207
+ * a visualization.
1179
1208
  * @example
1180
1209
  * ```js
1181
1210
  * liveboardEmbed.trigger(HostEvent.Edit)
1182
- *
1211
+ * ```
1212
+ * ```js
1183
1213
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
1184
1214
  * '730496d6-6903-4601-937e-2c691821af3c'})
1185
- *
1215
+ * ```
1216
+ * ```js
1186
1217
  * vizEmbed.trigger((HostEvent.Edit)
1187
1218
  * ```
1188
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1219
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1189
1220
  */
1190
1221
  HostEvent["Edit"] = "edit";
1191
1222
  /**
1192
- * Triggers the Copy link action on a Liveboard or visualization
1223
+ * Triggers the **Copy link** action on a Liveboard or visualization
1193
1224
  *
1194
- * @param - object - to trigger the action for a s
1195
- * pecfic visualization in Liveboard embed, pass in vizId as a key
1225
+ * @param - object - to trigger the action for a
1226
+ * specific visualization in Liveboard embed, pass in `vizId` as a key
1196
1227
  * @example
1197
1228
  * ```js
1198
1229
  * liveboardEmbed.trigger(HostEvent.CopyLink)
1230
+ * ```
1231
+ * ```js
1199
1232
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1233
+ * ```
1234
+ * ```js
1200
1235
  * vizEmbed.trigger((HostEvent.CopyLink)
1201
1236
  * ```
1202
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1237
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1203
1238
  */
1204
1239
  HostEvent["CopyLink"] = "embedDocument";
1205
1240
  /**
1206
- * Triggers the Present action on a Liveboard or visualization
1241
+ * Triggers the **Present** action on a Liveboard or visualization
1207
1242
  *
1208
- * @param - object - to trigger the action for a specfic visualization
1209
- * in Liveboard embed, pass in vizId as a key
1243
+ * @param - object - to trigger the action for a specific visualization
1244
+ * in Liveboard embed, pass in `vizId` as a key
1210
1245
  * @example
1211
1246
  * ```js
1212
1247
  * liveboardEmbed.trigger(HostEvent.Present)
1248
+ * ```
1249
+ * ```js
1213
1250
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1251
+ * ```
1252
+ * ```js
1214
1253
  * vizEmbed.trigger((HostEvent.Present)
1215
1254
  * ```
1216
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1255
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1217
1256
  */
1218
1257
  HostEvent["Present"] = "present";
1219
1258
  /**
1220
- * Get TML for the current search.
1259
+ * Gets TML for the current search.
1221
1260
  *
1222
1261
  * @example
1223
1262
  * ```js
@@ -1227,79 +1266,89 @@ var HostEvent;
1227
1266
  * );
1228
1267
  * })
1229
1268
  * ```
1230
- * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
1269
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
1231
1270
  * @important
1232
1271
  */
1233
1272
  HostEvent["GetTML"] = "getTML";
1234
1273
  /**
1235
- * Triggers the ShowUnderlyingData action on visualization or search
1274
+ * Triggers the **Show underlying data** action on visualization or search
1236
1275
  *
1237
1276
  * @param - an object with vizId as a key
1238
1277
  * @example
1239
1278
  * ```js
1240
1279
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
1241
1280
  * '730496d6-6903-4601-937e-2c691821af3c'})
1242
- *
1281
+ * ```
1282
+ * ```js
1243
1283
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
1244
- *
1284
+ * ```
1285
+ * ```js
1245
1286
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
1246
1287
  * ```
1247
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1288
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1248
1289
  */
1249
1290
  HostEvent["ShowUnderlyingData"] = "showUnderlyingData";
1250
1291
  /**
1251
- * Triggers the Delete action on visualization or search
1292
+ * Triggers the **Delete** action on visualization or search
1252
1293
  *
1253
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1254
- * can be left empty for search and visualization embeds
1294
+ * @param - Liveboard embed takes an object with `vizId` as a key.
1295
+ * Can be left empty if embedding Search or visualization.
1255
1296
  * @example
1256
1297
  * ```js
1257
1298
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
1258
1299
  * '730496d6-6903-4601-937e-2c691821af3c'})
1259
- *
1300
+ * ```
1301
+ * ```js
1260
1302
  * vizEmbed.trigger(HostEvent.Delete)
1261
- *
1303
+ * ```
1304
+ * ```js
1262
1305
  * searchEmbed.trigger(HostEvent.Delete)
1263
1306
  * ```
1264
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1307
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1265
1308
  */
1266
1309
  HostEvent["Delete"] = "onDeleteAnswer";
1267
1310
  /**
1268
- * Triggers the SpotIQAnalyze action on visualization or search
1269
- *
1270
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1271
- * can be left empty for search and visualization embeds
1311
+ * Triggers the **SpotIQ analyze** action on visualization
1312
+ * or search.
1313
+ * @param - Liveboard embed takes `vizId` as a
1314
+ * key. Can be left undefined when embedding Search or
1315
+ * visualization.
1272
1316
  * @example
1273
1317
  * ```js
1274
1318
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
1275
1319
  * '730496d6-6903-4601-937e-2c691821af3c'})
1276
- *
1320
+ * ```
1321
+ * ```js
1277
1322
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
1278
- *
1323
+ * ```
1324
+ * ```js
1279
1325
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
1280
1326
  * ```
1281
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1327
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1282
1328
  */
1283
1329
  HostEvent["SpotIQAnalyze"] = "spotIQAnalyze";
1284
1330
  /**
1285
- * Triggers the Download action on visualization or search when Displaymode is Chart
1331
+ * Triggers the **Download** action on charts in
1332
+ * the embedded view.
1286
1333
  *
1287
1334
  * @example
1288
1335
  * ```js
1289
1336
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
1290
1337
  * '730496d6-6903-4601-937e-2c691821af3c'})
1291
- *
1338
+ * ```
1339
+ * ```js
1292
1340
  * vizEmbed.trigger(HostEvent.Download)
1293
- *
1341
+ * ```
1342
+ * ```js
1294
1343
  * searchEmbed.trigger(HostEvent.Download)
1295
1344
  * ```
1296
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
1297
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1345
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
1346
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1298
1347
  */
1299
1348
  HostEvent["Download"] = "downloadAsPng";
1300
1349
  /**
1301
- * Triggers the Download action on visualization or search when Displaymode is Chart
1302
- *
1350
+ * Triggers the **Download** > **PNG** action on
1351
+ * charts in the embedded view.
1303
1352
  * @example
1304
1353
  * ```js
1305
1354
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1309,115 +1358,192 @@ var HostEvent;
1309
1358
  *
1310
1359
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
1311
1360
  * ```
1312
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
1361
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
1313
1362
  */
1314
1363
  HostEvent["DownloadAsPng"] = "downloadAsPng";
1315
1364
  /**
1316
- * Triggers the downloadAsCSV action on visualization or search
1365
+ * Triggers the **Download** > **CSV** action on tables in
1366
+ * the embedded view.
1317
1367
  *
1318
1368
  * @example
1319
1369
  * ```js
1320
1370
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
1321
1371
  * '730496d6-6903-4601-937e-2c691821af3c'})
1322
- *
1372
+ * ```
1373
+ * ```js
1323
1374
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
1324
- *
1375
+ * ```
1376
+ * ```js
1325
1377
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
1326
1378
  * ```
1327
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1379
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1328
1380
  */
1329
1381
  HostEvent["DownloadAsCsv"] = "downloadAsCSV";
1330
1382
  /**
1331
- * Triggers the downloadAsXLSX action on visualization or search
1332
- *
1383
+ * Triggers the **Download** > **XLSX** action on tables
1384
+ * in the embedded view.
1333
1385
  * @example
1334
1386
  * ```js
1335
1387
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
1336
1388
  * '730496d6-6903-4601-937e-2c691821af3c'})
1337
- *
1389
+ * ```
1390
+ * ```js
1338
1391
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
1339
- *
1392
+ * ```
1393
+ * ```js
1340
1394
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
1341
1395
  * ```
1342
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1396
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1343
1397
  */
1344
1398
  HostEvent["DownloadAsXlsx"] = "downloadAsXLSX";
1345
1399
  /**
1346
- * Triggers the Share action on a liveboard or answer
1400
+ * Triggers the **Share** action on an embedded
1401
+ * Liveboard or Answer.
1347
1402
  *
1348
1403
  * @example
1349
1404
  * ```js
1350
1405
  * liveboardEmbed.trigger(HostEvent.Share)
1351
- *
1406
+ * ```
1407
+ * ```js
1352
1408
  * searchEmbed.trigger(HostEvent.Share)
1353
1409
  * ```
1354
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1410
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1355
1411
  */
1356
1412
  HostEvent["Share"] = "share";
1357
1413
  /**
1358
- * Trigger the Save action on a liveboard or answer
1359
- *
1414
+ * Triggers the **Save** action on a Liveboard or Answer.
1415
+ * Saves the changes.
1360
1416
  * @example
1361
1417
  * ```js
1362
1418
  * liveboardEmbed.trigger(HostEvent.Save)
1363
- *
1419
+ * ```
1420
+ * ```js
1364
1421
  * searchEmbed.trigger(HostEvent.Save)
1365
1422
  * ```
1366
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1423
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1367
1424
  */
1368
1425
  HostEvent["Save"] = "save";
1369
1426
  /**
1370
- * Triggers the SyncToSheets action on visualization
1371
- *
1372
- * @param - an object with vizId as a key
1427
+ * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
1428
+ * Sends data from an Answer or Liveboard visualization to a Google sheet.
1429
+ * @param - an object with `vizId` as a key
1373
1430
  * @example
1374
1431
  * ```js
1375
1432
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
1376
1433
  * '730496d6-6903-4601-937e-2c691821af3c'})
1377
- *
1434
+ * ```
1435
+ * ```js
1378
1436
  * vizEmbed.trigger(HostEvent.SyncToSheets)
1379
1437
  * ```
1380
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1438
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1381
1439
  */
1382
1440
  HostEvent["SyncToSheets"] = "sync-to-sheets";
1383
1441
  /**
1384
- * Triggers the SyncToOtherApps action on visualization
1385
- *
1442
+ * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
1443
+ * Sends data from an Answer or Liveboard visualization to third-party apps such
1444
+ * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
1386
1445
  * @param - an object with vizId as a key
1387
1446
  * @example
1388
1447
  * ```js
1389
1448
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
1390
1449
  * '730496d6-6903-4601-937e-2c691821af3c'})
1391
- *
1450
+ * ```
1451
+ * ```js
1392
1452
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
1393
1453
  * ```
1394
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1454
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1395
1455
  */
1396
1456
  HostEvent["SyncToOtherApps"] = "sync-to-other-apps";
1397
1457
  /**
1398
- * Triggers the ManagePipelines action on visualization
1399
- *
1400
- * @param - an object with vizId as a key
1458
+ * Triggers the **Manage pipelines** action on an embedded
1459
+ * visualization or Answer.
1460
+ * Allows users to manage ThoughtSpot Sync pipelines.
1461
+ * @param - an object with `vizId` as a key
1401
1462
  * @example
1402
1463
  * ```js
1403
1464
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
1404
1465
  * '730496d6-6903-4601-937e-2c691821af3c'})
1405
- *
1466
+ * ```
1467
+ * ```js
1406
1468
  * vizEmbed.trigger(HostEvent.ManagePipelines)
1407
1469
  * ```
1408
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1470
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1409
1471
  */
1410
1472
  HostEvent["ManagePipelines"] = "manage-pipeline";
1411
1473
  /**
1412
- * Triggers the Reset search in answer
1474
+ * Triggers the Reset search on the Search page
1413
1475
  *
1414
1476
  * @example
1415
1477
  * ```js
1416
1478
  * searchEmbed.trigger(HostEvent.ResetSearch)
1417
1479
  * ```
1418
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
1480
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
1419
1481
  */
1420
1482
  HostEvent["ResetSearch"] = "resetSearch";
1483
+ /**
1484
+ * Gets the currents visible and runtime filters applied on a Liveboard
1485
+ *
1486
+ * @example
1487
+ * liveboardEmbed.trigger(HostEvent.GetFilters)
1488
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1489
+ */
1490
+ HostEvent["GetFilters"] = "getFilters";
1491
+ /**
1492
+ * Updates the visible filters on the Liveboard.
1493
+ *
1494
+ * @param - filter: filter object containing column name and filter operation and values
1495
+ * @example
1496
+ *
1497
+ * ```js
1498
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
1499
+ * filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
1500
+ * })
1501
+ * ```
1502
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1503
+ */
1504
+ HostEvent["UpdateFilters"] = "updateFilters";
1505
+ /*
1506
+ * Get Tab for the current Liveboard.
1507
+ *
1508
+ * @example
1509
+ * ```js
1510
+ * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
1511
+ * console.log(
1512
+ * tabDetails // TabDetails of current LB
1513
+ * );
1514
+ * })
1515
+ * ```
1516
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1517
+ */
1518
+ HostEvent["GetTabs"] = "getTabs";
1519
+ /**
1520
+ * Set the visible Tabs on a Liveboard.
1521
+ *
1522
+ * @param - an array of ids of Tabs to show, the ids not passed
1523
+ * will be hidden.
1524
+ * @example
1525
+ * ```js
1526
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
1527
+ * '430496d6-6903-4601-937e-2c691821af3c',
1528
+ * 'f547ec54-2a37-4516-a222-2b06719af726'])
1529
+ * ```
1530
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1531
+ */
1532
+ HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
1533
+ /**
1534
+ * Set the hidden tabs on a Liveboard.
1535
+ *
1536
+ * @param - an array of ids of Tabs to hide, the ids not passed
1537
+ * will be shown.
1538
+ * @example
1539
+ * ```js
1540
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
1541
+ * '630496d6-6903-4601-937e-2c691821af3c',
1542
+ * 'i547ec54-2a37-4516-a222-2b06719af726'])
1543
+ * ```
1544
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1545
+ */
1546
+ HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
1421
1547
  })(HostEvent || (HostEvent = {}));
1422
1548
  /**
1423
1549
  * The different visual modes that the data sources panel within
@@ -1497,27 +1623,51 @@ var Param;
1497
1623
  Param["DisableWorksheetChange"] = "disableWorksheetChange";
1498
1624
  Param["HideEurekaResults"] = "hideEurekaResults";
1499
1625
  Param["HideEurekaSuggestions"] = "hideEurekaSuggestions";
1626
+ Param["HideLiveboardHeader"] = "hideLiveboardHeader";
1627
+ Param["ShowLiveboardDescription"] = "showLiveboardDescription";
1628
+ Param["ShowLiveboardTitle"] = "showLiveboardTitle";
1629
+ Param["HiddenTabs"] = "hideTabs";
1630
+ Param["VisibleTabs"] = "visibleTabs";
1631
+ Param["HideTabPanel"] = "hideTabPanel";
1500
1632
  })(Param || (Param = {}));
1501
1633
  /**
1502
- * The list of actions that can be performed on visual ThoughtSpot
1503
- * entities, such as answers and Liveboards.
1504
- *
1505
- * This enum is used to specify the actions that could be disabled,
1506
- * hidden or made visible.
1507
- *
1634
+ * ThoughtSpot application pages include actions and menu commands
1635
+ * for various user-initiated operations. These actions are represented
1636
+ * as enumeration members in the SDK. To show, hide, or disable
1637
+ * specific actions in the embedded view, define the Action
1638
+ * enumeration members in the `disabledActions`, `visibleActions`,
1639
+ * or `hiddenActions` array.
1640
+ * @example
1641
+ * ```js
1642
+ * const embed = new LiveboardEmbed('#embed-container', {
1643
+ * ... // other options
1644
+ * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
1645
+ * disabledActions: [Action.Download],
1646
+ * //hiddenActions: [], // Set either this or visibleActions
1647
+ * })
1648
+ * ```
1508
1649
  * @example
1509
1650
  * ```js
1510
1651
  * const embed = new LiveboardEmbed('#embed-container', {
1511
1652
  * ... // other options
1512
- * visibleActions: [Action.Save, Action.Explore],
1513
- * disableActions: [Action.Save],
1514
- * hiddenActions: [Action.Download], // Set either this or visibleActions
1653
+ * //visibleActions: [],
1654
+ * disabledActions: [Action.Download],
1655
+ * hiddenActions: [Action.Edit, ActionAction.Explore],
1515
1656
  * })
1516
1657
  * ```
1658
+
1517
1659
  */
1518
1660
  // eslint-disable-next-line no-shadow
1519
1661
  var Action;
1520
1662
  (function (Action) {
1663
+ /**
1664
+ * The **Save** action on an Answer or Liveboard.
1665
+ * Allows users to save the changes.
1666
+ * @example
1667
+ * ```js
1668
+ * disabledActions: [Action.SaveAsView]
1669
+ * ```
1670
+ */
1521
1671
  Action["Save"] = "save";
1522
1672
  /**
1523
1673
  * @hidden
@@ -1527,27 +1677,137 @@ var Action;
1527
1677
  * @hidden
1528
1678
  */
1529
1679
  Action["SaveUntitled"] = "saveUntitled";
1680
+ /**
1681
+ * The **Save as View** action on the Answer
1682
+ * page. Saves an Answer as a View object.
1683
+ *
1684
+ * @example
1685
+ * ```js
1686
+ * disabledActions: [Action.SaveAsView]
1687
+ * ```
1688
+ */
1530
1689
  Action["SaveAsView"] = "saveAsView";
1690
+ /**
1691
+ * The **Make a copy** action on a Liveboard or Answer
1692
+ * page.
1693
+ * Creates a copy of the Liveboard, visualization,
1694
+ * or Answer.
1695
+ *
1696
+ * @example
1697
+ * ```js
1698
+ * disabledActions: [Action.MakeACopy]
1699
+ * ```
1700
+ */
1531
1701
  Action["MakeACopy"] = "makeACopy";
1702
+ /**
1703
+ * The **Copy and Edit** action on a Liveboard.
1704
+ * This action is now replaced with `Action.MakeACopy`.
1705
+ *
1706
+ * @example
1707
+ * ```js
1708
+ * disabledActions: [Action.EditACopy]
1709
+ * ```
1710
+ */
1532
1711
  Action["EditACopy"] = "editACopy";
1712
+ /**
1713
+ * The **Copy link** menu action on a Liveboard visualization.
1714
+ * Copies the visualization URL
1715
+ * @example
1716
+ * ```js
1717
+ * disabledActions: [Action.CopyLink]
1718
+ * ```
1719
+ */
1533
1720
  Action["CopyLink"] = "embedDocument";
1534
1721
  /**
1535
1722
  * @hidden
1536
1723
  */
1537
1724
  Action["ResetLayout"] = "resetLayout";
1725
+ /**
1726
+ * The **Schedule** menu action on a Liveboard.
1727
+ * Allows scheduling a Liveboard notification.
1728
+ * @example
1729
+ * ```js
1730
+ * disabledActions: [Action.Schedule]
1731
+ * ```
1732
+ */
1538
1733
  Action["Schedule"] = "subscription";
1734
+ /**
1735
+ * The **Manage schedules** menu action on a Liveboard.
1736
+ * Allows users to manage scheduled Liveboard jobs.
1737
+ * @example
1738
+ * ```js
1739
+ * disabledActions: [Action.SchedulesList]
1740
+ * ```
1741
+ */
1539
1742
  Action["SchedulesList"] = "schedule-list";
1743
+ /**
1744
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
1745
+ * Allows users to share an object with other users and groups.
1746
+ * @example
1747
+ * ```js
1748
+ * disabledActions: [Action.Share]
1749
+ * ```
1750
+ */
1540
1751
  Action["Share"] = "share";
1752
+ /**
1753
+ * The **Add filter** action on a Liveboard and Search page.
1754
+ * Allows adding filters to Answers and visualizations on a Liveboard.
1755
+ * @example
1756
+ * ```js
1757
+ * disabledActions: [Action.AddFilter]
1758
+ * ```
1759
+ */
1541
1760
  Action["AddFilter"] = "addFilter";
1761
+ /**
1762
+ * Filter configuration options on a Liveboard and Search page.
1763
+ * Allows configuring filter options when adding filters to a
1764
+ * Liveboard or Answer.
1765
+ * @example
1766
+ * ```js
1767
+ * disabledActions: [Action.ConfigureFilter]
1768
+ * ```
1769
+ */
1542
1770
  Action["ConfigureFilter"] = "configureFilter";
1543
1771
  Action["CollapseDataSources"] = "collapseDataSources";
1772
+ /**
1773
+ * The **Choose sources** button on Search page.
1774
+ * Allows selecting data sources for search queries.
1775
+ * @example
1776
+ * ```js
1777
+ * disabledActions: [Action.ChooseDataSources]
1778
+ * ```
1779
+ */
1544
1780
  Action["ChooseDataSources"] = "chooseDataSources";
1781
+ /**
1782
+ * The **Create formula** action on a Search or Answer page.
1783
+ * Allows adding formulas to an Answer.
1784
+ * @example
1785
+ * ```js
1786
+ * disabledActions: [Action.AddFormula]
1787
+ * ```
1788
+ */
1545
1789
  Action["AddFormula"] = "addFormula";
1790
+ /**
1791
+ * The **Add parameter** action on a Liveboard or Answer.
1792
+ * Allows adding Parameters to a Liveboard or Answer.
1793
+ * @example
1794
+ * ```js
1795
+ * disabledActions: [Action.AddParameter]
1796
+ * ```
1797
+ */
1546
1798
  Action["AddParameter"] = "addParameter";
1547
1799
  /**
1548
1800
  * @hidden
1549
1801
  */
1550
1802
  Action["SearchOnTop"] = "searchOnTop";
1803
+ /**
1804
+ * The **SpotIQ analyze** menu action on a visualization or
1805
+ * Answer page.
1806
+ * @example
1807
+ * ```js
1808
+ * disabledActions: [Action.SpotIQAnalyze]
1809
+ * ```
1810
+ */
1551
1811
  Action["SpotIQAnalyze"] = "spotIQAnalyze";
1552
1812
  /**
1553
1813
  * @hidden
@@ -1562,24 +1822,150 @@ var Action;
1562
1822
  * @hidden
1563
1823
  */
1564
1824
  Action["ReplaySearch"] = "replaySearch";
1825
+ /**
1826
+ * The **Show underlying data** menu action on a visualization or
1827
+ * Answer page.
1828
+ * @example
1829
+ * ```js
1830
+ * disabledActions: [Action.ShowUnderlyingData]
1831
+ * ```
1832
+ */
1565
1833
  Action["ShowUnderlyingData"] = "showUnderlyingData";
1834
+ /**
1835
+ * The **Download** menu action on Liveboard visualizations
1836
+ * and Answers.
1837
+ * Allows downloading a visualization or Answer.
1838
+ * @example
1839
+ * ```js
1840
+ * disabledActions: [Action.DownloadAsPng]
1841
+ * ```
1842
+ */
1566
1843
  Action["Download"] = "download";
1844
+ /**
1845
+ * The **Download** > **PNG** menu action for charts on a Liveboard
1846
+ * or Answer page.
1847
+ * Downloads a visualization or Answer as a PNG file.
1848
+ * @example
1849
+ * ```js
1850
+ * disabledActions: [Action.DownloadAsPng]
1851
+ * ```
1852
+ */
1567
1853
  Action["DownloadAsPng"] = "downloadAsPng";
1854
+ /**
1855
+ * The **Download** > **PDF** menu action on a Liveboard.
1856
+ * Downloads a visualization or Answer as a PDF file.
1857
+ * @example
1858
+ * ```js
1859
+ * disabledActions: [Action.DownloadAsPdf]
1860
+ * ```
1861
+ */
1568
1862
  Action["DownloadAsPdf"] = "downloadAsPdf";
1863
+ /**
1864
+ * The **Download** > **CSV** menu action for tables on a Liveboard
1865
+ * or Answer page.
1866
+ * Downloads a visualization or Answer in the XLSX format.
1867
+ * @example
1868
+ * ```js
1869
+ * disabledActions: [Action.DownloadAsCsv]
1870
+ * ```
1871
+ */
1569
1872
  Action["DownloadAsCsv"] = "downloadAsCSV";
1873
+ /**
1874
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
1875
+ * or Answer page.
1876
+ * Downloads a visualization or Answer in the XLSX format.
1877
+ * @example
1878
+ * ```js
1879
+ * disabledActions: [Action.DownloadAsXlsx]
1880
+ * ```
1881
+ */
1570
1882
  Action["DownloadAsXlsx"] = "downloadAsXLSX";
1571
1883
  /**
1572
1884
  * @hidden
1573
1885
  */
1574
1886
  Action["DownloadTrace"] = "downloadTrace";
1887
+ /**
1888
+ * The **Export TML** menu action on Liveboard, Answers
1889
+ * Worksheets and Data Connections page.
1890
+ * Exports an object as a TML file.
1891
+ * @example
1892
+ * ```js
1893
+ * disabledActions: [Action.ExportTML]
1894
+ * ```
1895
+ */
1575
1896
  Action["ExportTML"] = "exportTSL";
1897
+ /**
1898
+ * The **Import TML** menu action for Liveboards and Answers.
1899
+ * Imports TML representation of ThoughtSpot objects.
1900
+ * @example
1901
+ * ```js
1902
+ * disabledActions: [Action.ImportTML]
1903
+ * ```
1904
+ */
1576
1905
  Action["ImportTML"] = "importTSL";
1906
+ /**
1907
+ * The **Update TML** menu action for Liveboards and Answers.
1908
+ * Update TML representation of ThoughtSpot objects.
1909
+ * @example
1910
+ * ```js
1911
+ * disabledActions: [Action.UpdateTML]
1912
+ * ```
1913
+ */
1577
1914
  Action["UpdateTML"] = "updateTSL";
1915
+ /**
1916
+ * The **Edit TML** menu action for Liveboards and Answers.
1917
+ * Opens the TML editor.
1918
+ * @example
1919
+ * ```js
1920
+ * disabledActions: [Action.EditTML]
1921
+ * ```
1922
+ */
1578
1923
  Action["EditTML"] = "editTSL";
1924
+ /**
1925
+ * The **Present** menu action for Liveboards and Answers.
1926
+ * Allows presenting a Liveboard or visualization in
1927
+ * slideshow mode.
1928
+ * @example
1929
+ * ```js
1930
+ * disabledActions: [Action.Present]
1931
+ * ```
1932
+ */
1579
1933
  Action["Present"] = "present";
1934
+ /**
1935
+ * The tile resize options in the visualization menu.
1936
+ * Allows switching between different preset layouts.
1937
+ * @example
1938
+ * ```js
1939
+ * disabledActions: [Action.ToggleSize]
1940
+ * ```
1941
+ */
1580
1942
  Action["ToggleSize"] = "toggleSize";
1943
+ /**
1944
+ * The *Edit* action on the Liveboard page and in the
1945
+ * visualization menu.
1946
+ * Opens a Liveboard or visualization in edit mode.
1947
+ * @example
1948
+ * ```js
1949
+ * disabledActions: [Action.Edit]
1950
+ * ```
1951
+ */
1581
1952
  Action["Edit"] = "edit";
1953
+ /**
1954
+ * The text edit option for Liveboard and visualization titles.
1955
+ * @example
1956
+ * ```js
1957
+ * disabledActions: [Action.EditTitle]
1958
+ * ```
1959
+ */
1582
1960
  Action["EditTitle"] = "editTitle";
1961
+ /**
1962
+ * The **Delete** menu action on Liveboards and visualizations.
1963
+ * Deletes a Liveboard or a visualization from a Liveboard.
1964
+ * @example
1965
+ * ```js
1966
+ * disabledActions: [Action.Remove]
1967
+ * ```
1968
+ */
1583
1969
  Action["Remove"] = "delete";
1584
1970
  /**
1585
1971
  * @hidden
@@ -1601,6 +1987,16 @@ var Action;
1601
1987
  * @hidden
1602
1988
  */
1603
1989
  Action["PinboardInfo"] = "pinboardInfo";
1990
+ /**
1991
+ * The **Show Liveboard details** menu action on a Liveboard.
1992
+ * Displays details such as the name, description, and
1993
+ * author of the Liveboard, and timestamp of Liveboard creation
1994
+ * and update.
1995
+ * @example
1996
+ * ```js
1997
+ * disabledActions: [Action.LiveboardInfo]
1998
+ * ```
1999
+ */
1604
2000
  Action["LiveboardInfo"] = "pinboardInfo";
1605
2001
  /**
1606
2002
  * @hidden
@@ -1611,20 +2007,61 @@ var Action;
1611
2007
  */
1612
2008
  Action["DownloadEmbraceQueries"] = "downloadEmbraceQueries";
1613
2009
  /**
1614
- * Pin action.
1615
- */
2010
+ * The **Pin** menu action on an Answer or
2011
+ * Search results page.
2012
+ * @example
2013
+ * ```js
2014
+ * disabledActions: [Action.Pin]
2015
+ * ```
2016
+ */
1616
2017
  Action["Pin"] = "pin";
1617
2018
  /**
1618
2019
  * @hidden
1619
2020
  */
1620
2021
  Action["AnalysisInfo"] = "analysisInfo";
1621
- Action["Subscription"] = "subscription";
1622
2022
  /**
1623
- * Explore action.
2023
+ * The **Schedule** menu action on a Liveboard.
2024
+ * @example
2025
+ * ```js
2026
+ * disabledActions: [Action.Subscription]
2027
+ * ```
1624
2028
  */
2029
+ Action["Subscription"] = "subscription";
2030
+ /**
2031
+ * The **Explore** action on Liveboard visualizations
2032
+ * @example
2033
+ * ```js
2034
+ * disabledActions: [Action.Explore]
2035
+ * ```
2036
+ */
1625
2037
  Action["Explore"] = "explore";
2038
+ /**
2039
+ * The action to include data points on a drilled-down Answer
2040
+ * or visualization
2041
+ * @example
2042
+ * ```js
2043
+ * disabledActions: [Action.DrillInclude]
2044
+ * ```
2045
+ */
1626
2046
  Action["DrillInclude"] = "context-menu-item-include";
2047
+ /**
2048
+ * The action to exclude data points on a drilled-down Answer
2049
+ * or visualization
2050
+ * @example
2051
+ * ```js
2052
+ * disabledActions: [Action.DrillInclude]
2053
+ * ```
2054
+ */
1627
2055
  Action["DrillExclude"] = "context-menu-item-exclude";
2056
+ /**
2057
+ * The **Copy to clipboard** menu action on tables in an Answer
2058
+ * or Liveboard.
2059
+ * Copies the selected data point.
2060
+ * @example
2061
+ * ```js
2062
+ * disabledActions: [Action.CopyToClipboard]
2063
+ * ```
2064
+ */
1628
2065
  Action["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
1629
2066
  Action["CopyAndEdit"] = "context-menu-item-copy-and-edit";
1630
2067
  /**
@@ -1633,89 +2070,266 @@ var Action;
1633
2070
  Action["DrillEdit"] = "context-menu-item-edit";
1634
2071
  Action["EditMeasure"] = "context-menu-item-edit-measure";
1635
2072
  Action["Separator"] = "context-menu-item-separator";
2073
+ /**
2074
+ * The **Drill down** menu action on Answers and Liveboard
2075
+ * visualizations.
2076
+ * Allows drilling down to a specific data point on a chart or table.
2077
+ * @example
2078
+ * ```js
2079
+ * disabledActions: [Action.DrillDown]
2080
+ * ```
2081
+ */
1636
2082
  Action["DrillDown"] = "DRILL";
2083
+ /**
2084
+ * The request access action on Liveboards.
2085
+ * Allows users with view permissions to request edit access to a Liveboard.
2086
+ * @example
2087
+ * ```js
2088
+ * disabledActions: [Action.RequestAccess]
2089
+ * ```
2090
+ */
1637
2091
  Action["RequestAccess"] = "requestAccess";
1638
- Action["QueryDetailsButtons"] = "queryDetailsButtons";
1639
2092
  /**
1640
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2093
+ * The **Query visualizer** and **Query SQL** buttons in Query details panel
2094
+ * of the Answer page
2095
+ * @example
2096
+ * ```js
2097
+ * disabledActions: [Action.QueryDetailsButtons]
2098
+ * ```
2099
+ */
2100
+ Action["QueryDetailsButtons"] = "QueryDetailsButtons";
2101
+ /**
2102
+ * The **Delete** action for Answers.
2103
+ * @example
2104
+ * ```js
2105
+ * disabledActions: [Action.AnswerDelete]
2106
+ * ```
2107
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1641
2108
  */
1642
2109
  Action["AnswerDelete"] = "onDeleteAnswer";
1643
2110
  /**
1644
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2111
+ * The Chart switcher icon on Answer and visualization pages.
2112
+ * @example
2113
+ * ```js
2114
+ * disabledActions: [Action.AnswerChartSwitcher]
2115
+ * ```
2116
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1645
2117
  */
1646
2118
  Action["AnswerChartSwitcher"] = "answerChartSwitcher";
1647
2119
  /**
1648
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2120
+ * Favorites icon (*) on Answers, Liveboard, and Data pages
2121
+ * @example
2122
+ * ```js
2123
+ * disabledActions: [Action.AddToFavorites]
2124
+ * ```
2125
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1649
2126
  */
1650
2127
  Action["AddToFavorites"] = "addToFavorites";
1651
2128
  /**
1652
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2129
+ * The edit icon on Liveboards (Classic experience).
2130
+ * @example
2131
+ * ```js
2132
+ * disabledActions: [Action.EditDetails]
2133
+ * ```
2134
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1653
2135
  */
1654
2136
  Action["EditDetails"] = "editDetails";
1655
2137
  /**
1656
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2138
+ * The Create alert action on KPI charts.
2139
+ * @example
2140
+ * ```js
2141
+ * disabledActions: [Action.CreateMonitor ]
2142
+ * ```
2143
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1657
2144
  */
1658
2145
  Action["CreateMonitor"] = "createMonitor";
1659
2146
  /**
1660
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2147
+ * @example
2148
+ * ```js
2149
+ * disabledActions: [Action.ReportError]
2150
+ * ```
2151
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1661
2152
  */
1662
2153
  Action["ReportError"] = "reportError";
2154
+ /**
2155
+ * The **Sync to sheets** action on Answers and Liveboard visualizations.
2156
+ * Allows sending data to a Google Sheet.
2157
+ * @example
2158
+ * ```js
2159
+ * disabledActions: [Action.SyncToSheets]
2160
+ * ```
2161
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2162
+ */
1663
2163
  Action["SyncToSheets"] = "sync-to-sheets";
2164
+ /**
2165
+ * The **Sync to other apps** action on Answers and Liveboard visualizations.
2166
+ * Allows sending data to third-party apps like Slack, Salesforce,
2167
+ * Microsoft Teams, and so on.
2168
+ * @example
2169
+ * ```js
2170
+ * disabledActions: [Action.SyncToOtherApps]
2171
+ * ```
2172
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2173
+ */
1664
2174
  Action["SyncToOtherApps"] = "sync-to-other-apps";
2175
+ /**
2176
+ * The **Manage pipelines** action on Answers and Liveboard visualizations.
2177
+ * Allows users to manage data sync pipelines to third-party apps.
2178
+ * @example
2179
+ * ```js
2180
+ * disabledActions: [Action.SyncToOtherApps]
2181
+ * ```
2182
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2183
+ */
1665
2184
  Action["ManagePipelines"] = "manage-pipeline";
1666
2185
  /**
2186
+ * The **Filter** action on Liveboard visualizations.
2187
+ * Allows users to apply cross-filters on a Liveboard.
2188
+ * @example
2189
+ * ```js
2190
+ * disabledActions: [Action.CrossFilter]
2191
+ * ```
1667
2192
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1668
2193
  */
1669
2194
  Action["CrossFilter"] = "context-menu-item-cross-filter";
1670
2195
  /**
2196
+ * The **Remove** action that appears when cross filters are applied
2197
+ * on a Liveboard.
2198
+ * Removes filters applied o a visualization.
2199
+ * @example
2200
+ * ```js
2201
+ * disabledActions: [Action.RemoveCrossFilter]
2202
+ * ```
1671
2203
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1672
2204
  */
1673
2205
  Action["RemoveCrossFilter"] = "context-menu-item-remove-cross-filter";
1674
2206
  /**
2207
+ * The **Aggregate** option in the chart axis or the
2208
+ * table column customization menu.
2209
+ * Provides aggregation options to analyze the data on a chart or table.
2210
+ * @example
2211
+ * ```js
2212
+ * disabledActions: [Action.AxisMenuAggregate]
2213
+ * ```
1675
2214
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1676
2215
  */
1677
2216
  Action["AxisMenuAggregate"] = "axisMenuAggregate";
1678
2217
  /**
2218
+ * The **Time bucket** option in the chart axis or table column
2219
+ * customization menu.
2220
+ * Allows defining time metric for date comparison.
2221
+ * @example
2222
+ * ```js
2223
+ * disabledActions: [Action.AxisMenuTimeBucket]
2224
+ * ```
1679
2225
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1680
2226
  */
1681
2227
  Action["AxisMenuTimeBucket"] = "axisMenuTimeBucket";
1682
2228
  /**
2229
+ * The **Filter** action in the chart axis or table column
2230
+ * customization menu.
2231
+ * @example
2232
+ * ```js
2233
+ * disabledActions: [Action.AxisMenuFilter]
2234
+ * ```
1683
2235
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1684
2236
  */
1685
2237
  Action["AxisMenuFilter"] = "axisMenuFilter";
1686
2238
  /**
2239
+ * The **Conditional formatting** action on chart or table.
2240
+ * Allows adding rules for conditional formatting of data
2241
+ * points on a chart or table.
2242
+ * @example
2243
+ * ```js
2244
+ * disabledActions: [Action.AxisMenuConditionalFormat]
2245
+ * ```
1687
2246
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1688
2247
  */
1689
2248
  Action["AxisMenuConditionalFormat"] = "axisMenuConditionalFormat";
1690
2249
  /**
2250
+ * The **Sort** menu action on a table or chart axis
2251
+ * Sorts data in ascending or descending order.
2252
+ * Allows adding, editing, or removing filters.
2253
+ * @example
2254
+ * ```js
2255
+ * disabledActions: [Action.AxisMenuConditionalFormat]
2256
+ * ```
1691
2257
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1692
2258
  */
1693
2259
  Action["AxisMenuSort"] = "axisMenuSort";
1694
2260
  /**
2261
+ * The **Group** option in the chart axis or table column
2262
+ * customization menu.
2263
+ * Allows grouping data points if the axes use the same
2264
+ * unit of measurement and a similar scale.
2265
+ * @example
2266
+ * ```js
2267
+ * disabledActions: [Action.AxisMenuGroup]
2268
+ * ```
1695
2269
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1696
2270
  */
1697
2271
  Action["AxisMenuGroup"] = "axisMenuGroup";
1698
2272
  /**
2273
+ * The **Position** option in the axis customization menu.
2274
+ * Allows changing the position of the axis to the
2275
+ * left or right side of the chart.
2276
+ * @example
2277
+ * ```js
2278
+ * disabledActions: [Action.AxisMenuPosition]
2279
+ * ```
1699
2280
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1700
2281
  */
1701
2282
  Action["AxisMenuPosition"] = "axisMenuPosition";
1702
2283
  /**
2284
+ * The **Rename** option in the chart axis or table column customization menu.
2285
+ * Renames the axis label on a chart or the column header on a table.
2286
+ * @example
2287
+ * ```js
2288
+ * disabledActions: [Action.AxisMenuRename]
2289
+ * ```
1703
2290
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1704
2291
  */
1705
2292
  Action["AxisMenuRename"] = "axisMenuRename";
1706
2293
  /**
2294
+ * The **Edit** action in the axis customization menu.
2295
+ * Allows editing the axis name, position, minimum and maximum values,
2296
+ * and format of a column.
2297
+ * @example
2298
+ * ```js
2299
+ * disabledActions: [Action.AxisMenuEdit]
2300
+ * ```
1707
2301
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1708
2302
  */
1709
2303
  Action["AxisMenuEdit"] = "axisMenuEdit";
1710
2304
  /**
2305
+ * The **Number format** action to customize the format of
2306
+ * the data labels on a chart or table.
2307
+ * @example
2308
+ * ```js
2309
+ * disabledActions: [Action.AxisMenuNumberFormat]
2310
+ * ```
1711
2311
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1712
2312
  */
1713
2313
  Action["AxisMenuNumberFormat"] = "axisMenuNumberFormat";
1714
2314
  /**
2315
+ * The **Text wrapping** action on a table.
2316
+ * Wraps or clips column text on a table.
2317
+ * @example
2318
+ * ```js
2319
+ * disabledActions: [Action.AxisMenuTextWrapping]
2320
+ * ```
1715
2321
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1716
2322
  */
1717
2323
  Action["AxisMenuTextWrapping"] = "axisMenuTextWrapping";
1718
2324
  /**
2325
+ * The **Remove** action in the chart axis or table column
2326
+ * customization menu.
2327
+ * Removes the data labels from a chart or the column of a
2328
+ * table visualization.
2329
+ * @example
2330
+ * ```js
2331
+ * disabledActions: [Action.AxisMenuRemove]
2332
+ * ```
1719
2333
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1720
2334
  */
1721
2335
  Action["AxisMenuRemove"] = "axisMenuRemove";
@@ -1724,9 +2338,31 @@ var Action;
1724
2338
  */
1725
2339
  Action["InsertInToSlide"] = "insertInToSlide";
1726
2340
  /**
2341
+ * The **Rename** menu action on Liveboards and visualizations.
2342
+ * Allows renaming a Liveboard or visualization.
2343
+ * @example
2344
+ * ```js
2345
+ * disabledActions: [Action.RenameModalTitleDescription]
2346
+ * ```
1727
2347
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1728
2348
  */
1729
2349
  Action["RenameModalTitleDescription"] = "renameModalTitleDescription";
2350
+ /**
2351
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2352
+ */
2353
+ Action["RequestVerification"] = "requestVerification";
2354
+ /**
2355
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2356
+ */
2357
+ Action["MarkAsVerified"] = "markAsVerified";
2358
+ /**
2359
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2360
+ */
2361
+ Action["AddTab"] = "addTab";
2362
+ /**
2363
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2364
+ */
2365
+ Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
1730
2366
  })(Action || (Action = {}));
1731
2367
  // eslint-disable-next-line no-shadow
1732
2368
  var OperationType;
@@ -27536,7 +28172,7 @@ function processTrigger(iFrame, messageType, thoughtSpotHost, data) {
27536
28172
  });
27537
28173
  }
27538
28174
 
27539
- var name="@thoughtspot/visual-embed-sdk";var version="1.22.0";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/index.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs",start:"gatsby develop","build:gatsby":"npm run clean:gatsby && gatsby build --prefix-paths","build:gatsby:noprefix":"npm run clean:gatsby && gatsby build","serve:gatsby":"gatsby serve","clean:gatsby":"gatsby clean","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts","bundle-dts":"dts-bundle --name ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true","bundle-dts-react":"dts-bundle --name ../../../dist/visual-embed-sdk-react --main lib/src/react/index.d.ts --outputAsModuleFolder=true","bundle-dts-react-full":"dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",build:"rollup -c",watch:"rollup -cw","docs-cmd":"node scripts/gatsby-commands.js",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme","test-sdk":"jest -c jest.config.sdk.js --runInBand","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs",posttest:"cat ./coverage/sdk/lcov.info | coveralls","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1",dompurify:"^2.3.4","eslint-plugin-comment-length":"^0.9.2","eslint-plugin-jsdoc":"^40.1.0",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",lodash:"^4.17.21","mixpanel-browser":"^2.45.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.13.1","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"6.7.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-puppeteer":"^4.4.0",jsdom:"^17.0.0","node-sass":"^8.0.0",prettier:"2.1.2",puppeteer:"^7.0.1",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports,typesVersions:typesVersions,scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
28175
+ var name="@thoughtspot/visual-embed-sdk";var version="1.23.0";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/index.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs",start:"gatsby develop","build:gatsby":"npm run clean:gatsby && gatsby build --prefix-paths","build:gatsby:noprefix":"npm run clean:gatsby && gatsby build","serve:gatsby":"gatsby serve","clean:gatsby":"gatsby clean","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts","bundle-dts":"dts-bundle --name ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true","bundle-dts-react":"dts-bundle --name ../../../dist/visual-embed-sdk-react --main lib/src/react/index.d.ts --outputAsModuleFolder=true","bundle-dts-react-full":"dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",build:"rollup -c",watch:"rollup -cw","docs-cmd":"node scripts/gatsby-commands.js",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme","test-sdk":"jest -c jest.config.sdk.js --runInBand","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs",posttest:"cat ./coverage/sdk/lcov.info | coveralls","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1",dompurify:"^2.3.4","eslint-plugin-comment-length":"^0.9.2","eslint-plugin-jsdoc":"^40.1.0",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",lodash:"^4.17.21","mixpanel-browser":"^2.45.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.13.1","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"6.7.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-puppeteer":"^4.4.0",jsdom:"^17.0.0","node-sass":"^8.0.0",prettier:"2.1.2",puppeteer:"^7.0.1",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports,typesVersions:typesVersions,scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
27540
28176
 
27541
28177
  /**
27542
28178
  * Copyright (c) 2022
@@ -27769,11 +28405,15 @@ class TsEmbed {
27769
28405
  if (this.embedConfig.authType === AuthType.TrustedAuthTokenCookieless) {
27770
28406
  queryParams[Param.cookieless] = true;
27771
28407
  }
27772
- const { disabledActions, disabledActionReason, hiddenActions, visibleActions, showAlerts, additionalFlags, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, } = this.viewConfig;
28408
+ const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, hideLiveboardHeader, showLiveboardDescription, showLiveboardTitle, } = this.viewConfig;
27773
28409
  if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
27774
28410
  this.handleError('You cannot have both hidden actions and visible actions');
27775
28411
  return queryParams;
27776
28412
  }
28413
+ if (Array.isArray(visibleTabs) && Array.isArray(hiddenTabs)) {
28414
+ this.handleError('You cannot have both hidden Tabs and visible Tabs');
28415
+ return queryParams;
28416
+ }
27777
28417
  // TODO remove embedConfig.customCssUrl
27778
28418
  const cssUrlParam = ((_c = customizations === null || customizations === void 0 ? void 0 : customizations.style) === null || _c === void 0 ? void 0 : _c.customCSSUrl) || this.embedConfig.customCssUrl;
27779
28419
  if (cssUrlParam) {
@@ -27789,6 +28429,12 @@ class TsEmbed {
27789
28429
  if (Array.isArray(visibleActions)) {
27790
28430
  queryParams[Param.VisibleActions] = visibleActions;
27791
28431
  }
28432
+ if (Array.isArray(hiddenTabs)) {
28433
+ queryParams[Param.HiddenTabs] = hiddenTabs;
28434
+ }
28435
+ if (Array.isArray(visibleTabs)) {
28436
+ queryParams[Param.VisibleTabs] = visibleTabs;
28437
+ }
27792
28438
  /**
27793
28439
  * Default behavior for context menu will be left-click
27794
28440
  * from version 9.2.0.cl the user have an option to override context
@@ -27820,6 +28466,15 @@ class TsEmbed {
27820
28466
  if (insertInToSlide) {
27821
28467
  queryParams[Param.ShowInsertToSlide] = insertInToSlide;
27822
28468
  }
28469
+ if (hideLiveboardHeader) {
28470
+ queryParams[Param.HideLiveboardHeader] = hideLiveboardHeader;
28471
+ }
28472
+ if (showLiveboardDescription) {
28473
+ queryParams[Param.ShowLiveboardDescription] = showLiveboardDescription;
28474
+ }
28475
+ if (showLiveboardTitle) {
28476
+ queryParams[Param.ShowLiveboardTitle] = showLiveboardTitle;
28477
+ }
27823
28478
  return queryParams;
27824
28479
  }
27825
28480
  /**
@@ -28529,7 +29184,7 @@ class LiveboardEmbed extends V1Embed {
28529
29184
  let params = {};
28530
29185
  params[Param.EmbedApp] = true;
28531
29186
  params = this.getBaseQueryParams(params);
28532
- const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, activeTabId, } = this.viewConfig;
29187
+ const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, hideTabPanel, activeTabId, } = this.viewConfig;
28533
29188
  const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
28534
29189
  || this.viewConfig.preventPinboardFilterRemoval;
28535
29190
  if (fullHeight === true) {
@@ -28554,6 +29209,9 @@ class LiveboardEmbed extends V1Embed {
28554
29209
  if (liveboardV2 !== undefined) {
28555
29210
  params[Param.LiveboardV2Enabled] = liveboardV2;
28556
29211
  }
29212
+ if (hideTabPanel) {
29213
+ params[Param.HideTabPanel] = hideTabPanel;
29214
+ }
28557
29215
  const queryParams = getQueryParamString(params, true);
28558
29216
  return queryParams;
28559
29217
  }
@@ -28825,6 +29483,7 @@ const HiddenActionItemByDefaultForSageEmbed = [
28825
29483
  /**
28826
29484
  * Embed ThoughtSpot LLM and GPT based natural language search component.
28827
29485
  *
29486
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
28828
29487
  * @group Embed components
28829
29488
  */
28830
29489
  class SageEmbed extends V1Embed {