@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
package/dist/tsembed.js CHANGED
@@ -341,7 +341,7 @@
341
341
  * .then((data) => data.token);
342
342
  * }
343
343
  * ```
344
- * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
344
+ * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
345
345
  */
346
346
  AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
347
347
  /**
@@ -464,7 +464,7 @@
464
464
  * One or more data columns have been selected.
465
465
  *
466
466
  * @returns columnIds - the list of columns
467
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
467
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
468
468
  */
469
469
  EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
470
470
  /**
@@ -497,7 +497,7 @@
497
497
  * });
498
498
  * ```
499
499
  * @return viz, clickedPoint - metadata about point that is clicked
500
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
500
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
501
501
  * @important
502
502
  */
503
503
  EmbedEvent["VizPointClick"] = "vizPointClick";
@@ -547,7 +547,7 @@
547
547
  * Emitted when the "Get Data" button in Search Bar embed
548
548
  * is clicked.
549
549
  *
550
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
550
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
551
551
  */
552
552
  EmbedEvent["GetDataClick"] = "getDataClick";
553
553
  /**
@@ -577,13 +577,13 @@
577
577
  /**
578
578
  * Emitted when any modal is opened in the app
579
579
  *
580
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
580
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
581
581
  */
582
582
  EmbedEvent["DialogOpen"] = "dialog-open";
583
583
  /**
584
584
  * Emitted when any modal is closed in the app
585
585
  *
586
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
586
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
587
587
  */
588
588
  EmbedEvent["DialogClose"] = "dialog-close";
589
589
  /**
@@ -591,136 +591,136 @@
591
591
  * You can use this event as a hook to trigger
592
592
  * other events on the rendered Liveboard.
593
593
  *
594
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
594
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
595
595
  */
596
596
  EmbedEvent["LiveboardRendered"] = "PinboardRendered";
597
597
  /**
598
598
  * This can be used to register an event listener which
599
599
  * is triggered on all events.
600
600
  *
601
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
601
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
602
602
  */
603
603
  EmbedEvent["ALL"] = "*";
604
604
  /**
605
- * Emitted when answer is saved in the app
605
+ * Emitted when an Answer is saved in the app
606
606
  *
607
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
607
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
608
608
  */
609
609
  EmbedEvent["Save"] = "save";
610
610
  /**
611
611
  * Emitted when the download action is triggered on an answer
612
612
  *
613
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
613
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
614
614
  */
615
615
  EmbedEvent["Download"] = "download";
616
616
  /**
617
617
  * Emitted when the download action is triggered on an answer
618
618
  *
619
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
619
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
620
620
  */
621
621
  EmbedEvent["DownloadAsPng"] = "downloadAsPng";
622
622
  /**
623
623
  * Emitted when the Download as PDF action is triggered on an answer
624
624
  *
625
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
625
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
626
626
  */
627
627
  EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
628
628
  /**
629
629
  * Emitted when the Download as CSV action is triggered on an answer
630
630
  *
631
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
631
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
632
632
  */
633
633
  EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
634
634
  /**
635
635
  * Emitted when the Download as XLSX action is triggered on an answer
636
636
  *
637
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
637
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
638
638
  */
639
639
  EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
640
640
  /**
641
641
  * Emitted when an answer is deleted in the app
642
642
  *
643
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
643
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
644
644
  */
645
645
  EmbedEvent["AnswerDelete"] = "answerDelete";
646
646
  /**
647
647
  * Emitted when an answer is pinned to a Liveboard
648
648
  *
649
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
649
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
650
650
  */
651
651
  EmbedEvent["Pin"] = "pin";
652
652
  /**
653
653
  * Emitted when SpotIQ analysis is triggered
654
654
  *
655
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
655
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
656
656
  */
657
657
  EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
658
658
  /**
659
659
  * Emitted when a user shares an object with another user or group
660
660
  *
661
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
661
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
662
662
  */
663
663
  EmbedEvent["Share"] = "share";
664
664
  /**
665
665
  * Emitted when a user clicks the Include action to include a specific value or data
666
666
  * on a chart or table
667
667
  *
668
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
668
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
669
669
  */
670
670
  EmbedEvent["DrillInclude"] = "context-menu-item-include";
671
671
  /**
672
672
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
673
673
  * on a chart or table
674
674
  *
675
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
675
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
676
676
  */
677
677
  EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
678
678
  /**
679
679
  * Emitted when copied column value on the app
680
680
  *
681
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
681
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
682
682
  */
683
683
  EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
684
684
  /**
685
685
  * Emitted when a user clicks the Update TML action
686
686
  *
687
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
687
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
688
688
  */
689
689
  EmbedEvent["UpdateTML"] = "updateTSL";
690
690
  /**
691
691
  * Emitted when a user clicks the Edit TML action
692
692
  *
693
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
693
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
694
694
  */
695
695
  EmbedEvent["EditTML"] = "editTSL";
696
696
  /**
697
697
  * Emitted when ExportTML trigger in answer on the app
698
698
  *
699
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
699
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
700
700
  */
701
701
  EmbedEvent["ExportTML"] = "exportTSL";
702
702
  /**
703
703
  * Emitted when an answer is saved as a view
704
704
  *
705
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
705
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
706
706
  */
707
707
  EmbedEvent["SaveAsView"] = "saveAsView";
708
708
  /**
709
709
  * Emitted when copy of existing answer on the app
710
710
  *
711
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
711
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
712
712
  */
713
713
  EmbedEvent["CopyAEdit"] = "copyAEdit";
714
714
  /**
715
715
  * Emitted when a user clicks Show underlying data on an answe
716
716
  *
717
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
717
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
718
718
  */
719
719
  EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
720
720
  /**
721
721
  * Emitted when an answer is switched to a chart or table view
722
722
  *
723
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
723
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
724
724
  */
725
725
  EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
726
726
  /**
@@ -732,67 +732,67 @@
732
732
  /**
733
733
  * Emitted when a user clicks Show Liveboard details on a Liveboard
734
734
  *
735
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
735
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
736
736
  */
737
737
  EmbedEvent["LiveboardInfo"] = "pinboardInfo";
738
738
  /**
739
739
  * Emitted when a user clicks on the Favorite icon on a Liveboard
740
740
  *
741
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
741
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
742
742
  */
743
743
  EmbedEvent["AddToFavorites"] = "addToFavorites";
744
744
  /**
745
745
  * Emitted when a user clicks Schedule on a Liveboard
746
746
  *
747
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
747
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
748
748
  */
749
749
  EmbedEvent["Schedule"] = "subscription";
750
750
  /**
751
751
  * Emitted when a user clicks Edit on a Liveboard or visualization
752
752
  *
753
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
753
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
754
754
  */
755
755
  EmbedEvent["Edit"] = "edit";
756
756
  /**
757
757
  * Emitted when a user clicks Make a copy on a Liveboard
758
758
  *
759
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
759
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
760
760
  */
761
761
  EmbedEvent["MakeACopy"] = "makeACopy";
762
762
  /**
763
763
  * Emitted when a user clicks Present on a Liveboard or visualization
764
764
  *
765
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
765
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
766
766
  */
767
767
  EmbedEvent["Present"] = "present";
768
768
  /**
769
769
  * Emitted when a user clicks Delete on a Liveboard
770
770
  *
771
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
771
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
772
772
  */
773
773
  EmbedEvent["Delete"] = "delete";
774
774
  /**
775
775
  * Emitted when a user clicks Manage schedules on a Liveboard
776
776
  *
777
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
777
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
778
778
  */
779
779
  EmbedEvent["SchedulesList"] = "schedule-list";
780
780
  /**
781
781
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
782
782
  *
783
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
783
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
784
784
  */
785
785
  EmbedEvent["Cancel"] = "cancel";
786
786
  /**
787
787
  * Emitted when a user clicks Explore on a visualization
788
788
  *
789
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
789
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
790
790
  */
791
791
  EmbedEvent["Explore"] = "explore";
792
792
  /**
793
793
  * Emitted when a user clicks Copy link action on a visualization
794
794
  *
795
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
795
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
796
796
  */
797
797
  EmbedEvent["CopyLink"] = "embedDocument";
798
798
  /**
@@ -813,16 +813,23 @@
813
813
  * @hidden
814
814
  */
815
815
  EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
816
+ /**
817
+ * Emitted when a user changes any filter on a Liveboard.
818
+ *
819
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
820
+ */
821
+ EmbedEvent["FilterChanged"] = "filterChanged";
816
822
  })(exports.EmbedEvent || (exports.EmbedEvent = {}));
817
823
  (function (HostEvent) {
818
824
  /**
819
- * Trigger a search
820
- *
825
+ * Triggers a search query in AppEmbed and SearchEmbed
826
+ * deployments.
827
+ * Includes the following properties:
821
828
  * @param - dataSourceIds - The data source GUID to Search on
822
829
  * - Although an array, only a single source
823
- * is supported at this time.
824
- * @param - searchQuery - The search query
825
- * @param - execute - execute the existing / updated query
830
+ * is supported.
831
+ * @param - searchQuery - Query string with search tokens
832
+ * @param - execute - executes the existing / updated query
826
833
  * @example
827
834
  * ```js
828
835
  * searchEmbed.trigger(HostEvent.Search, {
@@ -834,13 +841,13 @@
834
841
  */
835
842
  HostEvent["Search"] = "search";
836
843
  /**
837
- * Trigger a drill on certain points by certain column
838
- *
844
+ * Triggers a drill on certain points of the specified column
845
+ * Includes the following properties:
839
846
  * @param - points - an object containing selectedPoints/clickedPoints
840
- * eg. { selectedPoints: []}
841
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
842
- * if not provided it will auto drill by the configured
843
- * column.
847
+ * to drill to. For example, { selectedPoints: []}
848
+ * @param - columnGuid - Optional. GUID of the column to drill
849
+ * by. If not provided it will auto drill by the configured
850
+ * column.
844
851
  * @example
845
852
  * ```js
846
853
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -873,17 +880,17 @@
873
880
  */
874
881
  HostEvent["Reload"] = "reload";
875
882
  /**
876
- * Set the visible visualizations on a Liveboard.
883
+ * Sets the visible visualizations on a Liveboard.
877
884
  *
878
- * @param - an array of ids of visualizations to show, the ids not passed
879
- * will be hidden.
885
+ * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
886
+ * in this parameter will be hidden.
880
887
  * @example
881
888
  * ```js
882
889
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
883
890
  * '730496d6-6903-4601-937e-2c691821af3c',
884
891
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
885
892
  * ```
886
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
893
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
887
894
  */
888
895
  HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
889
896
  /**
@@ -900,9 +907,18 @@
900
907
  */
901
908
  HostEvent["SetActiveTab"] = "SetActiveTab";
902
909
  /**
903
- * Update the runtime filters. The runtime filters passed here are extended
904
- * on to the existing runtime filters if they exist.
905
- *
910
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
911
+ * runtime filters passed here are appended to the existing runtime
912
+ * filters.
913
+ * Pass an array of runtime filters with the following attributes:
914
+ * `columnName`
915
+ * _String_. The name of the column to filter on.
916
+ * `operator`
917
+ * Runtime filter operator to apply. For information,
918
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
919
+ * `values`
920
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
921
+ * such as BW and IN accept multiple operands.
906
922
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
907
923
  * @example
908
924
  * ```js
@@ -911,25 +927,24 @@
911
927
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
912
928
  * ])
913
929
  * ```
914
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
930
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
915
931
  * @important
916
932
  */
917
933
  HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
918
934
  /**
919
- * Navigate to a specific page in App embed without any reload.
935
+ * Navigate to a specific page in the embedded application without reloading the page.
920
936
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
921
- *
922
937
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
923
938
  * @example
924
939
  * ```js
925
940
  * appEmbed.navigateToPage(-1)
926
941
  * ```
927
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
942
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
928
943
  */
929
944
  HostEvent["Navigate"] = "Navigate";
930
945
  /**
931
946
  * Opens the filter panel for a particular column.
932
- * Works with Search embed.
947
+ * Works with Search and Liveboard embed.
933
948
  *
934
949
  * @param - { columnId: string,
935
950
  * name: string,
@@ -938,233 +953,257 @@
938
953
  * @example
939
954
  * ```js
940
955
  * searchEmbed.trigger(HostEvent.OpenFilter,
941
- * { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
956
+ * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
957
+ * LiveboardEmbed.trigger(HostEvent.OpenFilter,
958
+ * { columnId: '<column-GUID>'})
942
959
  * ```
943
960
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
944
961
  */
945
962
  HostEvent["OpenFilter"] = "openFilter";
946
963
  /**
947
- * Adds the columns to the current Search.
964
+ * Adds columns to the current search query.
948
965
  *
949
966
  * @param - { columnIds: string[] }
950
967
  * @example
951
968
  * ```js
952
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
969
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
953
970
  * ```
954
971
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
955
972
  */
956
973
  HostEvent["AddColumns"] = "addColumns";
957
974
  /**
958
- * Removes a column from the current Search.
975
+ * Removes a column from the current search query.
959
976
  *
960
977
  * @param - { columnId: string }
961
978
  * @example
962
979
  * ```js
963
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
980
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
964
981
  * ```
965
982
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
966
983
  */
967
984
  HostEvent["RemoveColumn"] = "removeColumn";
968
985
  /**
969
- * Gets the current pinboard content.
986
+ * Gets the current Liveboard content.
970
987
  *
971
988
  * @example
972
989
  * ```js
973
990
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
974
991
  * ```
975
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
992
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
976
993
  */
977
994
  HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
978
995
  /**
979
- * Triggers the Pin action on an embedded object
996
+ * Triggers the **Pin** action on an embedded object
980
997
  *
981
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
982
- * can be left empty for search and visualization embeds
998
+ * @param - Liveboard embed takes the `vizId` as a
999
+ * key. Can be left undefined when embedding Search, full app or
1000
+ * a visualization.
983
1001
  * @example
984
1002
  * ```js
985
1003
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1004
+ * ```
1005
+ * ```js
986
1006
  * vizEmbed.trigger(HostEvent.Pin)
1007
+ * ```
1008
+ * ```js
987
1009
  * searchEmbed.trigger(HostEvent.Pin)
988
1010
  * ```
989
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1011
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
990
1012
  */
991
1013
  HostEvent["Pin"] = "pin";
992
1014
  /**
993
- * Triggers the Show Liveboard details action on a Liveboard
1015
+ * Triggers the **Show Liveboard details** action on a Liveboard
994
1016
  *
995
1017
  * @example
996
1018
  * ```js
997
1019
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
998
1020
  * ```
999
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1021
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1000
1022
  */
1001
1023
  HostEvent["LiveboardInfo"] = "pinboardInfo";
1002
1024
  /**
1003
- * Triggers the Schedule action on a Liveboard
1025
+ * Triggers the **Schedule** action on a Liveboard
1004
1026
  *
1005
1027
  * @example
1006
1028
  * ```js
1007
1029
  * liveboardEmbed.trigger(HostEvent.Schedule)
1008
1030
  * ```
1009
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1031
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1010
1032
  */
1011
1033
  HostEvent["Schedule"] = "subscription";
1012
1034
  /**
1013
- * Triggers the Manage schedule action on a Liveboard
1035
+ * Triggers the **Manage schedule** action on a Liveboard
1014
1036
  *
1015
1037
  * @example
1016
1038
  * ```js
1017
1039
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
1018
1040
  * ```
1019
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1041
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1020
1042
  */
1021
1043
  HostEvent["SchedulesList"] = "schedule-list";
1022
1044
  /**
1023
- * Triggers the Export TML action on a Liveboard
1045
+ * Triggers the **Export TML** action on a Liveboard
1024
1046
  *
1025
1047
  * @example
1026
1048
  * ```js
1027
1049
  * liveboardEmbed.trigger(HostEvent.ExportTML)
1028
1050
  * ```
1029
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1051
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1030
1052
  */
1031
1053
  HostEvent["ExportTML"] = "exportTSL";
1032
1054
  /**
1033
- * Triggers the Edit TML action on a Liveboard
1055
+ * Triggers the **Edit TML** action on a Liveboard
1034
1056
  *
1035
1057
  * @example
1036
1058
  * ```js
1037
1059
  * liveboardEmbed.trigger(HostEvent.EditTML)
1038
1060
  * ```
1039
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1061
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1040
1062
  */
1041
1063
  HostEvent["EditTML"] = "editTSL";
1042
1064
  /**
1043
- * Triggers the Update TML action on a Liveboard
1065
+ * Triggers the **Update TML** action on a Liveboard
1044
1066
  *
1045
1067
  * @example
1046
1068
  * ```js
1047
1069
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
1048
1070
  * ```
1049
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1071
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1050
1072
  */
1051
1073
  HostEvent["UpdateTML"] = "updateTSL";
1052
1074
  /**
1053
- * Triggers the Download PDF action on a Liveboard
1075
+ * Triggers the **Download PDF** action on a Liveboard
1054
1076
  *
1055
1077
  * @example
1056
1078
  * ```js
1057
1079
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
1058
1080
  * ```
1059
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1081
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1060
1082
  */
1061
1083
  HostEvent["DownloadAsPdf"] = "downloadAsPdf";
1062
1084
  /**
1063
- * Triggers the Make a copy action on a Liveboard, search or visualization
1085
+ * Triggers the **Make a copy** action on a Liveboard, Search, or
1086
+ * visualization page
1064
1087
  *
1065
1088
  * @example
1066
1089
  * ```js
1067
1090
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1091
+ * ```
1092
+ * ```js
1068
1093
  * vizEmbed.trigger(HostEvent.MakeACopy)
1094
+ * ```
1095
+ * ```js
1069
1096
  * searchEmbed.trigger(HostEvent.MakeACopy)
1070
1097
  * ```
1071
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1098
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1072
1099
  */
1073
1100
  HostEvent["MakeACopy"] = "makeACopy";
1074
1101
  /**
1075
- * Triggers the Delete action on a Liveboard
1102
+ * Triggers the **Delete** action on a Liveboard
1076
1103
  *
1077
1104
  * @example
1078
1105
  * ```js
1079
1106
  * appEmbed.trigger(HostEvent.Remove)
1080
1107
  * ```
1081
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1108
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1082
1109
  */
1083
1110
  HostEvent["Remove"] = "delete";
1084
1111
  /**
1085
- * Triggers the Explore action on a visualization
1112
+ * Triggers the **Explore* action on a visualization
1086
1113
  *
1087
- * @param - an object with vizId as a key
1114
+ * @param - an object with `vizId` as a key
1088
1115
  * @example
1089
1116
  * ```js
1090
1117
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1091
1118
  * ```
1092
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1119
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1093
1120
  */
1094
1121
  HostEvent["Explore"] = "explore";
1095
1122
  /**
1096
- * Triggers the Create alert action on a visualization
1123
+ * Triggers the **Create alert** action on a visualization
1097
1124
  *
1098
- * @param - an object with vizId as a key
1125
+ * @param - an object with `vizId` as a key
1099
1126
  * @example
1100
1127
  * ```js
1101
1128
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
1102
1129
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1103
1130
  * })
1104
1131
  * ```
1105
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1132
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1106
1133
  */
1107
1134
  HostEvent["CreateMonitor"] = "createMonitor";
1108
1135
  /**
1109
- * Triggers the Manage alert action on a visualization
1136
+ * Triggers the **Manage alerts** action on a visualization
1110
1137
  *
1111
- * @param - an object with vizId as a key
1138
+ * @param - an object with `vizId` as a key
1112
1139
  * @example
1113
1140
  * ```js
1114
1141
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
1115
1142
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1116
1143
  * })
1117
1144
  * ```
1118
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1145
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1119
1146
  */
1120
1147
  HostEvent["ManageMonitor"] = "manageMonitor";
1121
1148
  /**
1122
- * Triggers the Edit action on a Liveboard or visualization
1149
+ * Triggers the **Edit** action on a Liveboard or visualization
1123
1150
  *
1124
- * @param - object - to trigger the action for a specfic visualization
1125
- * in Liveboard embed, pass in vizId as a key
1151
+ * @param - object - To trigger the action for a specific visualization
1152
+ * in Liveboard embed, pass in `vizId` as a key.
1153
+ * Can be left undefined when embedding Search, full app, or
1154
+ * a visualization.
1126
1155
  * @example
1127
1156
  * ```js
1128
1157
  * liveboardEmbed.trigger(HostEvent.Edit)
1129
- *
1158
+ * ```
1159
+ * ```js
1130
1160
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
1131
1161
  * '730496d6-6903-4601-937e-2c691821af3c'})
1132
- *
1162
+ * ```
1163
+ * ```js
1133
1164
  * vizEmbed.trigger((HostEvent.Edit)
1134
1165
  * ```
1135
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1166
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1136
1167
  */
1137
1168
  HostEvent["Edit"] = "edit";
1138
1169
  /**
1139
- * Triggers the Copy link action on a Liveboard or visualization
1170
+ * Triggers the **Copy link** action on a Liveboard or visualization
1140
1171
  *
1141
- * @param - object - to trigger the action for a s
1142
- * pecfic visualization in Liveboard embed, pass in vizId as a key
1172
+ * @param - object - to trigger the action for a
1173
+ * specific visualization in Liveboard embed, pass in `vizId` as a key
1143
1174
  * @example
1144
1175
  * ```js
1145
1176
  * liveboardEmbed.trigger(HostEvent.CopyLink)
1177
+ * ```
1178
+ * ```js
1146
1179
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1180
+ * ```
1181
+ * ```js
1147
1182
  * vizEmbed.trigger((HostEvent.CopyLink)
1148
1183
  * ```
1149
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1184
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1150
1185
  */
1151
1186
  HostEvent["CopyLink"] = "embedDocument";
1152
1187
  /**
1153
- * Triggers the Present action on a Liveboard or visualization
1188
+ * Triggers the **Present** action on a Liveboard or visualization
1154
1189
  *
1155
- * @param - object - to trigger the action for a specfic visualization
1156
- * in Liveboard embed, pass in vizId as a key
1190
+ * @param - object - to trigger the action for a specific visualization
1191
+ * in Liveboard embed, pass in `vizId` as a key
1157
1192
  * @example
1158
1193
  * ```js
1159
1194
  * liveboardEmbed.trigger(HostEvent.Present)
1195
+ * ```
1196
+ * ```js
1160
1197
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1198
+ * ```
1199
+ * ```js
1161
1200
  * vizEmbed.trigger((HostEvent.Present)
1162
1201
  * ```
1163
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1202
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1164
1203
  */
1165
1204
  HostEvent["Present"] = "present";
1166
1205
  /**
1167
- * Get TML for the current search.
1206
+ * Gets TML for the current search.
1168
1207
  *
1169
1208
  * @example
1170
1209
  * ```js
@@ -1174,79 +1213,89 @@
1174
1213
  * );
1175
1214
  * })
1176
1215
  * ```
1177
- * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
1216
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
1178
1217
  * @important
1179
1218
  */
1180
1219
  HostEvent["GetTML"] = "getTML";
1181
1220
  /**
1182
- * Triggers the ShowUnderlyingData action on visualization or search
1221
+ * Triggers the **Show underlying data** action on visualization or search
1183
1222
  *
1184
1223
  * @param - an object with vizId as a key
1185
1224
  * @example
1186
1225
  * ```js
1187
1226
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
1188
1227
  * '730496d6-6903-4601-937e-2c691821af3c'})
1189
- *
1228
+ * ```
1229
+ * ```js
1190
1230
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
1191
- *
1231
+ * ```
1232
+ * ```js
1192
1233
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
1193
1234
  * ```
1194
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1235
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1195
1236
  */
1196
1237
  HostEvent["ShowUnderlyingData"] = "showUnderlyingData";
1197
1238
  /**
1198
- * Triggers the Delete action on visualization or search
1239
+ * Triggers the **Delete** action on visualization or search
1199
1240
  *
1200
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1201
- * can be left empty for search and visualization embeds
1241
+ * @param - Liveboard embed takes an object with `vizId` as a key.
1242
+ * Can be left empty if embedding Search or visualization.
1202
1243
  * @example
1203
1244
  * ```js
1204
1245
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
1205
1246
  * '730496d6-6903-4601-937e-2c691821af3c'})
1206
- *
1247
+ * ```
1248
+ * ```js
1207
1249
  * vizEmbed.trigger(HostEvent.Delete)
1208
- *
1250
+ * ```
1251
+ * ```js
1209
1252
  * searchEmbed.trigger(HostEvent.Delete)
1210
1253
  * ```
1211
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1254
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1212
1255
  */
1213
1256
  HostEvent["Delete"] = "onDeleteAnswer";
1214
1257
  /**
1215
- * Triggers the SpotIQAnalyze action on visualization or search
1216
- *
1217
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1218
- * can be left empty for search and visualization embeds
1258
+ * Triggers the **SpotIQ analyze** action on visualization
1259
+ * or search.
1260
+ * @param - Liveboard embed takes `vizId` as a
1261
+ * key. Can be left undefined when embedding Search or
1262
+ * visualization.
1219
1263
  * @example
1220
1264
  * ```js
1221
1265
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
1222
1266
  * '730496d6-6903-4601-937e-2c691821af3c'})
1223
- *
1267
+ * ```
1268
+ * ```js
1224
1269
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
1225
- *
1270
+ * ```
1271
+ * ```js
1226
1272
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
1227
1273
  * ```
1228
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1274
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1229
1275
  */
1230
1276
  HostEvent["SpotIQAnalyze"] = "spotIQAnalyze";
1231
1277
  /**
1232
- * Triggers the Download action on visualization or search when Displaymode is Chart
1278
+ * Triggers the **Download** action on charts in
1279
+ * the embedded view.
1233
1280
  *
1234
1281
  * @example
1235
1282
  * ```js
1236
1283
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
1237
1284
  * '730496d6-6903-4601-937e-2c691821af3c'})
1238
- *
1285
+ * ```
1286
+ * ```js
1239
1287
  * vizEmbed.trigger(HostEvent.Download)
1240
- *
1288
+ * ```
1289
+ * ```js
1241
1290
  * searchEmbed.trigger(HostEvent.Download)
1242
1291
  * ```
1243
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
1244
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1292
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
1293
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1245
1294
  */
1246
1295
  HostEvent["Download"] = "downloadAsPng";
1247
1296
  /**
1248
- * Triggers the Download action on visualization or search when Displaymode is Chart
1249
- *
1297
+ * Triggers the **Download** > **PNG** action on
1298
+ * charts in the embedded view.
1250
1299
  * @example
1251
1300
  * ```js
1252
1301
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1256,115 +1305,192 @@
1256
1305
  *
1257
1306
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
1258
1307
  * ```
1259
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
1308
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
1260
1309
  */
1261
1310
  HostEvent["DownloadAsPng"] = "downloadAsPng";
1262
1311
  /**
1263
- * Triggers the downloadAsCSV action on visualization or search
1312
+ * Triggers the **Download** > **CSV** action on tables in
1313
+ * the embedded view.
1264
1314
  *
1265
1315
  * @example
1266
1316
  * ```js
1267
1317
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
1268
1318
  * '730496d6-6903-4601-937e-2c691821af3c'})
1269
- *
1319
+ * ```
1320
+ * ```js
1270
1321
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
1271
- *
1322
+ * ```
1323
+ * ```js
1272
1324
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
1273
1325
  * ```
1274
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1326
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1275
1327
  */
1276
1328
  HostEvent["DownloadAsCsv"] = "downloadAsCSV";
1277
1329
  /**
1278
- * Triggers the downloadAsXLSX action on visualization or search
1279
- *
1330
+ * Triggers the **Download** > **XLSX** action on tables
1331
+ * in the embedded view.
1280
1332
  * @example
1281
1333
  * ```js
1282
1334
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
1283
1335
  * '730496d6-6903-4601-937e-2c691821af3c'})
1284
- *
1336
+ * ```
1337
+ * ```js
1285
1338
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
1286
- *
1339
+ * ```
1340
+ * ```js
1287
1341
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
1288
1342
  * ```
1289
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1343
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1290
1344
  */
1291
1345
  HostEvent["DownloadAsXlsx"] = "downloadAsXLSX";
1292
1346
  /**
1293
- * Triggers the Share action on a liveboard or answer
1347
+ * Triggers the **Share** action on an embedded
1348
+ * Liveboard or Answer.
1294
1349
  *
1295
1350
  * @example
1296
1351
  * ```js
1297
1352
  * liveboardEmbed.trigger(HostEvent.Share)
1298
- *
1353
+ * ```
1354
+ * ```js
1299
1355
  * searchEmbed.trigger(HostEvent.Share)
1300
1356
  * ```
1301
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1357
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1302
1358
  */
1303
1359
  HostEvent["Share"] = "share";
1304
1360
  /**
1305
- * Trigger the Save action on a liveboard or answer
1306
- *
1361
+ * Triggers the **Save** action on a Liveboard or Answer.
1362
+ * Saves the changes.
1307
1363
  * @example
1308
1364
  * ```js
1309
1365
  * liveboardEmbed.trigger(HostEvent.Save)
1310
- *
1366
+ * ```
1367
+ * ```js
1311
1368
  * searchEmbed.trigger(HostEvent.Save)
1312
1369
  * ```
1313
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1370
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1314
1371
  */
1315
1372
  HostEvent["Save"] = "save";
1316
1373
  /**
1317
- * Triggers the SyncToSheets action on visualization
1318
- *
1319
- * @param - an object with vizId as a key
1374
+ * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
1375
+ * Sends data from an Answer or Liveboard visualization to a Google sheet.
1376
+ * @param - an object with `vizId` as a key
1320
1377
  * @example
1321
1378
  * ```js
1322
1379
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
1323
1380
  * '730496d6-6903-4601-937e-2c691821af3c'})
1324
- *
1381
+ * ```
1382
+ * ```js
1325
1383
  * vizEmbed.trigger(HostEvent.SyncToSheets)
1326
1384
  * ```
1327
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1385
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1328
1386
  */
1329
1387
  HostEvent["SyncToSheets"] = "sync-to-sheets";
1330
1388
  /**
1331
- * Triggers the SyncToOtherApps action on visualization
1332
- *
1389
+ * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
1390
+ * Sends data from an Answer or Liveboard visualization to third-party apps such
1391
+ * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
1333
1392
  * @param - an object with vizId as a key
1334
1393
  * @example
1335
1394
  * ```js
1336
1395
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
1337
1396
  * '730496d6-6903-4601-937e-2c691821af3c'})
1338
- *
1397
+ * ```
1398
+ * ```js
1339
1399
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
1340
1400
  * ```
1341
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1401
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1342
1402
  */
1343
1403
  HostEvent["SyncToOtherApps"] = "sync-to-other-apps";
1344
1404
  /**
1345
- * Triggers the ManagePipelines action on visualization
1346
- *
1347
- * @param - an object with vizId as a key
1405
+ * Triggers the **Manage pipelines** action on an embedded
1406
+ * visualization or Answer.
1407
+ * Allows users to manage ThoughtSpot Sync pipelines.
1408
+ * @param - an object with `vizId` as a key
1348
1409
  * @example
1349
1410
  * ```js
1350
1411
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
1351
1412
  * '730496d6-6903-4601-937e-2c691821af3c'})
1352
- *
1413
+ * ```
1414
+ * ```js
1353
1415
  * vizEmbed.trigger(HostEvent.ManagePipelines)
1354
1416
  * ```
1355
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1417
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1356
1418
  */
1357
1419
  HostEvent["ManagePipelines"] = "manage-pipeline";
1358
1420
  /**
1359
- * Triggers the Reset search in answer
1421
+ * Triggers the Reset search on the Search page
1360
1422
  *
1361
1423
  * @example
1362
1424
  * ```js
1363
1425
  * searchEmbed.trigger(HostEvent.ResetSearch)
1364
1426
  * ```
1365
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
1427
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
1366
1428
  */
1367
1429
  HostEvent["ResetSearch"] = "resetSearch";
1430
+ /**
1431
+ * Gets the currents visible and runtime filters applied on a Liveboard
1432
+ *
1433
+ * @example
1434
+ * liveboardEmbed.trigger(HostEvent.GetFilters)
1435
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1436
+ */
1437
+ HostEvent["GetFilters"] = "getFilters";
1438
+ /**
1439
+ * Updates the visible filters on the Liveboard.
1440
+ *
1441
+ * @param - filter: filter object containing column name and filter operation and values
1442
+ * @example
1443
+ *
1444
+ * ```js
1445
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
1446
+ * filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
1447
+ * })
1448
+ * ```
1449
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1450
+ */
1451
+ HostEvent["UpdateFilters"] = "updateFilters";
1452
+ /*
1453
+ * Get Tab for the current Liveboard.
1454
+ *
1455
+ * @example
1456
+ * ```js
1457
+ * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
1458
+ * console.log(
1459
+ * tabDetails // TabDetails of current LB
1460
+ * );
1461
+ * })
1462
+ * ```
1463
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1464
+ */
1465
+ HostEvent["GetTabs"] = "getTabs";
1466
+ /**
1467
+ * Set the visible Tabs on a Liveboard.
1468
+ *
1469
+ * @param - an array of ids of Tabs to show, the ids not passed
1470
+ * will be hidden.
1471
+ * @example
1472
+ * ```js
1473
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
1474
+ * '430496d6-6903-4601-937e-2c691821af3c',
1475
+ * 'f547ec54-2a37-4516-a222-2b06719af726'])
1476
+ * ```
1477
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1478
+ */
1479
+ HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
1480
+ /**
1481
+ * Set the hidden tabs on a Liveboard.
1482
+ *
1483
+ * @param - an array of ids of Tabs to hide, the ids not passed
1484
+ * will be shown.
1485
+ * @example
1486
+ * ```js
1487
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
1488
+ * '630496d6-6903-4601-937e-2c691821af3c',
1489
+ * 'i547ec54-2a37-4516-a222-2b06719af726'])
1490
+ * ```
1491
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1492
+ */
1493
+ HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
1368
1494
  })(exports.HostEvent || (exports.HostEvent = {}));
1369
1495
  (function (DataSourceVisualMode) {
1370
1496
  /**
@@ -1438,8 +1564,22 @@
1438
1564
  Param["DisableWorksheetChange"] = "disableWorksheetChange";
1439
1565
  Param["HideEurekaResults"] = "hideEurekaResults";
1440
1566
  Param["HideEurekaSuggestions"] = "hideEurekaSuggestions";
1567
+ Param["HideLiveboardHeader"] = "hideLiveboardHeader";
1568
+ Param["ShowLiveboardDescription"] = "showLiveboardDescription";
1569
+ Param["ShowLiveboardTitle"] = "showLiveboardTitle";
1570
+ Param["HiddenTabs"] = "hideTabs";
1571
+ Param["VisibleTabs"] = "visibleTabs";
1572
+ Param["HideTabPanel"] = "hideTabPanel";
1441
1573
  })(Param || (Param = {}));
1442
1574
  (function (Action) {
1575
+ /**
1576
+ * The **Save** action on an Answer or Liveboard.
1577
+ * Allows users to save the changes.
1578
+ * @example
1579
+ * ```js
1580
+ * disabledActions: [Action.SaveAsView]
1581
+ * ```
1582
+ */
1443
1583
  Action["Save"] = "save";
1444
1584
  /**
1445
1585
  * @hidden
@@ -1449,27 +1589,137 @@
1449
1589
  * @hidden
1450
1590
  */
1451
1591
  Action["SaveUntitled"] = "saveUntitled";
1592
+ /**
1593
+ * The **Save as View** action on the Answer
1594
+ * page. Saves an Answer as a View object.
1595
+ *
1596
+ * @example
1597
+ * ```js
1598
+ * disabledActions: [Action.SaveAsView]
1599
+ * ```
1600
+ */
1452
1601
  Action["SaveAsView"] = "saveAsView";
1602
+ /**
1603
+ * The **Make a copy** action on a Liveboard or Answer
1604
+ * page.
1605
+ * Creates a copy of the Liveboard, visualization,
1606
+ * or Answer.
1607
+ *
1608
+ * @example
1609
+ * ```js
1610
+ * disabledActions: [Action.MakeACopy]
1611
+ * ```
1612
+ */
1453
1613
  Action["MakeACopy"] = "makeACopy";
1614
+ /**
1615
+ * The **Copy and Edit** action on a Liveboard.
1616
+ * This action is now replaced with `Action.MakeACopy`.
1617
+ *
1618
+ * @example
1619
+ * ```js
1620
+ * disabledActions: [Action.EditACopy]
1621
+ * ```
1622
+ */
1454
1623
  Action["EditACopy"] = "editACopy";
1624
+ /**
1625
+ * The **Copy link** menu action on a Liveboard visualization.
1626
+ * Copies the visualization URL
1627
+ * @example
1628
+ * ```js
1629
+ * disabledActions: [Action.CopyLink]
1630
+ * ```
1631
+ */
1455
1632
  Action["CopyLink"] = "embedDocument";
1456
1633
  /**
1457
1634
  * @hidden
1458
1635
  */
1459
1636
  Action["ResetLayout"] = "resetLayout";
1637
+ /**
1638
+ * The **Schedule** menu action on a Liveboard.
1639
+ * Allows scheduling a Liveboard notification.
1640
+ * @example
1641
+ * ```js
1642
+ * disabledActions: [Action.Schedule]
1643
+ * ```
1644
+ */
1460
1645
  Action["Schedule"] = "subscription";
1646
+ /**
1647
+ * The **Manage schedules** menu action on a Liveboard.
1648
+ * Allows users to manage scheduled Liveboard jobs.
1649
+ * @example
1650
+ * ```js
1651
+ * disabledActions: [Action.SchedulesList]
1652
+ * ```
1653
+ */
1461
1654
  Action["SchedulesList"] = "schedule-list";
1655
+ /**
1656
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
1657
+ * Allows users to share an object with other users and groups.
1658
+ * @example
1659
+ * ```js
1660
+ * disabledActions: [Action.Share]
1661
+ * ```
1662
+ */
1462
1663
  Action["Share"] = "share";
1664
+ /**
1665
+ * The **Add filter** action on a Liveboard and Search page.
1666
+ * Allows adding filters to Answers and visualizations on a Liveboard.
1667
+ * @example
1668
+ * ```js
1669
+ * disabledActions: [Action.AddFilter]
1670
+ * ```
1671
+ */
1463
1672
  Action["AddFilter"] = "addFilter";
1673
+ /**
1674
+ * Filter configuration options on a Liveboard and Search page.
1675
+ * Allows configuring filter options when adding filters to a
1676
+ * Liveboard or Answer.
1677
+ * @example
1678
+ * ```js
1679
+ * disabledActions: [Action.ConfigureFilter]
1680
+ * ```
1681
+ */
1464
1682
  Action["ConfigureFilter"] = "configureFilter";
1465
1683
  Action["CollapseDataSources"] = "collapseDataSources";
1684
+ /**
1685
+ * The **Choose sources** button on Search page.
1686
+ * Allows selecting data sources for search queries.
1687
+ * @example
1688
+ * ```js
1689
+ * disabledActions: [Action.ChooseDataSources]
1690
+ * ```
1691
+ */
1466
1692
  Action["ChooseDataSources"] = "chooseDataSources";
1693
+ /**
1694
+ * The **Create formula** action on a Search or Answer page.
1695
+ * Allows adding formulas to an Answer.
1696
+ * @example
1697
+ * ```js
1698
+ * disabledActions: [Action.AddFormula]
1699
+ * ```
1700
+ */
1467
1701
  Action["AddFormula"] = "addFormula";
1702
+ /**
1703
+ * The **Add parameter** action on a Liveboard or Answer.
1704
+ * Allows adding Parameters to a Liveboard or Answer.
1705
+ * @example
1706
+ * ```js
1707
+ * disabledActions: [Action.AddParameter]
1708
+ * ```
1709
+ */
1468
1710
  Action["AddParameter"] = "addParameter";
1469
1711
  /**
1470
1712
  * @hidden
1471
1713
  */
1472
1714
  Action["SearchOnTop"] = "searchOnTop";
1715
+ /**
1716
+ * The **SpotIQ analyze** menu action on a visualization or
1717
+ * Answer page.
1718
+ * @example
1719
+ * ```js
1720
+ * disabledActions: [Action.SpotIQAnalyze]
1721
+ * ```
1722
+ */
1473
1723
  Action["SpotIQAnalyze"] = "spotIQAnalyze";
1474
1724
  /**
1475
1725
  * @hidden
@@ -1484,24 +1734,150 @@
1484
1734
  * @hidden
1485
1735
  */
1486
1736
  Action["ReplaySearch"] = "replaySearch";
1737
+ /**
1738
+ * The **Show underlying data** menu action on a visualization or
1739
+ * Answer page.
1740
+ * @example
1741
+ * ```js
1742
+ * disabledActions: [Action.ShowUnderlyingData]
1743
+ * ```
1744
+ */
1487
1745
  Action["ShowUnderlyingData"] = "showUnderlyingData";
1746
+ /**
1747
+ * The **Download** menu action on Liveboard visualizations
1748
+ * and Answers.
1749
+ * Allows downloading a visualization or Answer.
1750
+ * @example
1751
+ * ```js
1752
+ * disabledActions: [Action.DownloadAsPng]
1753
+ * ```
1754
+ */
1488
1755
  Action["Download"] = "download";
1756
+ /**
1757
+ * The **Download** > **PNG** menu action for charts on a Liveboard
1758
+ * or Answer page.
1759
+ * Downloads a visualization or Answer as a PNG file.
1760
+ * @example
1761
+ * ```js
1762
+ * disabledActions: [Action.DownloadAsPng]
1763
+ * ```
1764
+ */
1489
1765
  Action["DownloadAsPng"] = "downloadAsPng";
1766
+ /**
1767
+ * The **Download** > **PDF** menu action on a Liveboard.
1768
+ * Downloads a visualization or Answer as a PDF file.
1769
+ * @example
1770
+ * ```js
1771
+ * disabledActions: [Action.DownloadAsPdf]
1772
+ * ```
1773
+ */
1490
1774
  Action["DownloadAsPdf"] = "downloadAsPdf";
1775
+ /**
1776
+ * The **Download** > **CSV** menu action for tables on a Liveboard
1777
+ * or Answer page.
1778
+ * Downloads a visualization or Answer in the XLSX format.
1779
+ * @example
1780
+ * ```js
1781
+ * disabledActions: [Action.DownloadAsCsv]
1782
+ * ```
1783
+ */
1491
1784
  Action["DownloadAsCsv"] = "downloadAsCSV";
1785
+ /**
1786
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
1787
+ * or Answer page.
1788
+ * Downloads a visualization or Answer in the XLSX format.
1789
+ * @example
1790
+ * ```js
1791
+ * disabledActions: [Action.DownloadAsXlsx]
1792
+ * ```
1793
+ */
1492
1794
  Action["DownloadAsXlsx"] = "downloadAsXLSX";
1493
1795
  /**
1494
1796
  * @hidden
1495
1797
  */
1496
1798
  Action["DownloadTrace"] = "downloadTrace";
1799
+ /**
1800
+ * The **Export TML** menu action on Liveboard, Answers
1801
+ * Worksheets and Data Connections page.
1802
+ * Exports an object as a TML file.
1803
+ * @example
1804
+ * ```js
1805
+ * disabledActions: [Action.ExportTML]
1806
+ * ```
1807
+ */
1497
1808
  Action["ExportTML"] = "exportTSL";
1809
+ /**
1810
+ * The **Import TML** menu action for Liveboards and Answers.
1811
+ * Imports TML representation of ThoughtSpot objects.
1812
+ * @example
1813
+ * ```js
1814
+ * disabledActions: [Action.ImportTML]
1815
+ * ```
1816
+ */
1498
1817
  Action["ImportTML"] = "importTSL";
1818
+ /**
1819
+ * The **Update TML** menu action for Liveboards and Answers.
1820
+ * Update TML representation of ThoughtSpot objects.
1821
+ * @example
1822
+ * ```js
1823
+ * disabledActions: [Action.UpdateTML]
1824
+ * ```
1825
+ */
1499
1826
  Action["UpdateTML"] = "updateTSL";
1827
+ /**
1828
+ * The **Edit TML** menu action for Liveboards and Answers.
1829
+ * Opens the TML editor.
1830
+ * @example
1831
+ * ```js
1832
+ * disabledActions: [Action.EditTML]
1833
+ * ```
1834
+ */
1500
1835
  Action["EditTML"] = "editTSL";
1836
+ /**
1837
+ * The **Present** menu action for Liveboards and Answers.
1838
+ * Allows presenting a Liveboard or visualization in
1839
+ * slideshow mode.
1840
+ * @example
1841
+ * ```js
1842
+ * disabledActions: [Action.Present]
1843
+ * ```
1844
+ */
1501
1845
  Action["Present"] = "present";
1846
+ /**
1847
+ * The tile resize options in the visualization menu.
1848
+ * Allows switching between different preset layouts.
1849
+ * @example
1850
+ * ```js
1851
+ * disabledActions: [Action.ToggleSize]
1852
+ * ```
1853
+ */
1502
1854
  Action["ToggleSize"] = "toggleSize";
1855
+ /**
1856
+ * The *Edit* action on the Liveboard page and in the
1857
+ * visualization menu.
1858
+ * Opens a Liveboard or visualization in edit mode.
1859
+ * @example
1860
+ * ```js
1861
+ * disabledActions: [Action.Edit]
1862
+ * ```
1863
+ */
1503
1864
  Action["Edit"] = "edit";
1865
+ /**
1866
+ * The text edit option for Liveboard and visualization titles.
1867
+ * @example
1868
+ * ```js
1869
+ * disabledActions: [Action.EditTitle]
1870
+ * ```
1871
+ */
1504
1872
  Action["EditTitle"] = "editTitle";
1873
+ /**
1874
+ * The **Delete** menu action on Liveboards and visualizations.
1875
+ * Deletes a Liveboard or a visualization from a Liveboard.
1876
+ * @example
1877
+ * ```js
1878
+ * disabledActions: [Action.Remove]
1879
+ * ```
1880
+ */
1505
1881
  Action["Remove"] = "delete";
1506
1882
  /**
1507
1883
  * @hidden
@@ -1523,6 +1899,16 @@
1523
1899
  * @hidden
1524
1900
  */
1525
1901
  Action["PinboardInfo"] = "pinboardInfo";
1902
+ /**
1903
+ * The **Show Liveboard details** menu action on a Liveboard.
1904
+ * Displays details such as the name, description, and
1905
+ * author of the Liveboard, and timestamp of Liveboard creation
1906
+ * and update.
1907
+ * @example
1908
+ * ```js
1909
+ * disabledActions: [Action.LiveboardInfo]
1910
+ * ```
1911
+ */
1526
1912
  Action["LiveboardInfo"] = "pinboardInfo";
1527
1913
  /**
1528
1914
  * @hidden
@@ -1533,20 +1919,61 @@
1533
1919
  */
1534
1920
  Action["DownloadEmbraceQueries"] = "downloadEmbraceQueries";
1535
1921
  /**
1536
- * Pin action.
1537
- */
1922
+ * The **Pin** menu action on an Answer or
1923
+ * Search results page.
1924
+ * @example
1925
+ * ```js
1926
+ * disabledActions: [Action.Pin]
1927
+ * ```
1928
+ */
1538
1929
  Action["Pin"] = "pin";
1539
1930
  /**
1540
1931
  * @hidden
1541
1932
  */
1542
1933
  Action["AnalysisInfo"] = "analysisInfo";
1543
- Action["Subscription"] = "subscription";
1544
1934
  /**
1545
- * Explore action.
1935
+ * The **Schedule** menu action on a Liveboard.
1936
+ * @example
1937
+ * ```js
1938
+ * disabledActions: [Action.Subscription]
1939
+ * ```
1546
1940
  */
1941
+ Action["Subscription"] = "subscription";
1942
+ /**
1943
+ * The **Explore** action on Liveboard visualizations
1944
+ * @example
1945
+ * ```js
1946
+ * disabledActions: [Action.Explore]
1947
+ * ```
1948
+ */
1547
1949
  Action["Explore"] = "explore";
1950
+ /**
1951
+ * The action to include data points on a drilled-down Answer
1952
+ * or visualization
1953
+ * @example
1954
+ * ```js
1955
+ * disabledActions: [Action.DrillInclude]
1956
+ * ```
1957
+ */
1548
1958
  Action["DrillInclude"] = "context-menu-item-include";
1959
+ /**
1960
+ * The action to exclude data points on a drilled-down Answer
1961
+ * or visualization
1962
+ * @example
1963
+ * ```js
1964
+ * disabledActions: [Action.DrillInclude]
1965
+ * ```
1966
+ */
1549
1967
  Action["DrillExclude"] = "context-menu-item-exclude";
1968
+ /**
1969
+ * The **Copy to clipboard** menu action on tables in an Answer
1970
+ * or Liveboard.
1971
+ * Copies the selected data point.
1972
+ * @example
1973
+ * ```js
1974
+ * disabledActions: [Action.CopyToClipboard]
1975
+ * ```
1976
+ */
1550
1977
  Action["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
1551
1978
  Action["CopyAndEdit"] = "context-menu-item-copy-and-edit";
1552
1979
  /**
@@ -1555,89 +1982,266 @@
1555
1982
  Action["DrillEdit"] = "context-menu-item-edit";
1556
1983
  Action["EditMeasure"] = "context-menu-item-edit-measure";
1557
1984
  Action["Separator"] = "context-menu-item-separator";
1985
+ /**
1986
+ * The **Drill down** menu action on Answers and Liveboard
1987
+ * visualizations.
1988
+ * Allows drilling down to a specific data point on a chart or table.
1989
+ * @example
1990
+ * ```js
1991
+ * disabledActions: [Action.DrillDown]
1992
+ * ```
1993
+ */
1558
1994
  Action["DrillDown"] = "DRILL";
1995
+ /**
1996
+ * The request access action on Liveboards.
1997
+ * Allows users with view permissions to request edit access to a Liveboard.
1998
+ * @example
1999
+ * ```js
2000
+ * disabledActions: [Action.RequestAccess]
2001
+ * ```
2002
+ */
1559
2003
  Action["RequestAccess"] = "requestAccess";
1560
- Action["QueryDetailsButtons"] = "queryDetailsButtons";
1561
2004
  /**
1562
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2005
+ * The **Query visualizer** and **Query SQL** buttons in Query details panel
2006
+ * of the Answer page
2007
+ * @example
2008
+ * ```js
2009
+ * disabledActions: [Action.QueryDetailsButtons]
2010
+ * ```
2011
+ */
2012
+ Action["QueryDetailsButtons"] = "QueryDetailsButtons";
2013
+ /**
2014
+ * The **Delete** action for Answers.
2015
+ * @example
2016
+ * ```js
2017
+ * disabledActions: [Action.AnswerDelete]
2018
+ * ```
2019
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1563
2020
  */
1564
2021
  Action["AnswerDelete"] = "onDeleteAnswer";
1565
2022
  /**
1566
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2023
+ * The Chart switcher icon on Answer and visualization pages.
2024
+ * @example
2025
+ * ```js
2026
+ * disabledActions: [Action.AnswerChartSwitcher]
2027
+ * ```
2028
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1567
2029
  */
1568
2030
  Action["AnswerChartSwitcher"] = "answerChartSwitcher";
1569
2031
  /**
1570
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2032
+ * Favorites icon (*) on Answers, Liveboard, and Data pages
2033
+ * @example
2034
+ * ```js
2035
+ * disabledActions: [Action.AddToFavorites]
2036
+ * ```
2037
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1571
2038
  */
1572
2039
  Action["AddToFavorites"] = "addToFavorites";
1573
2040
  /**
1574
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2041
+ * The edit icon on Liveboards (Classic experience).
2042
+ * @example
2043
+ * ```js
2044
+ * disabledActions: [Action.EditDetails]
2045
+ * ```
2046
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1575
2047
  */
1576
2048
  Action["EditDetails"] = "editDetails";
1577
2049
  /**
1578
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2050
+ * The Create alert action on KPI charts.
2051
+ * @example
2052
+ * ```js
2053
+ * disabledActions: [Action.CreateMonitor ]
2054
+ * ```
2055
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1579
2056
  */
1580
2057
  Action["CreateMonitor"] = "createMonitor";
1581
2058
  /**
1582
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2059
+ * @example
2060
+ * ```js
2061
+ * disabledActions: [Action.ReportError]
2062
+ * ```
2063
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1583
2064
  */
1584
2065
  Action["ReportError"] = "reportError";
2066
+ /**
2067
+ * The **Sync to sheets** action on Answers and Liveboard visualizations.
2068
+ * Allows sending data to a Google Sheet.
2069
+ * @example
2070
+ * ```js
2071
+ * disabledActions: [Action.SyncToSheets]
2072
+ * ```
2073
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2074
+ */
1585
2075
  Action["SyncToSheets"] = "sync-to-sheets";
2076
+ /**
2077
+ * The **Sync to other apps** action on Answers and Liveboard visualizations.
2078
+ * Allows sending data to third-party apps like Slack, Salesforce,
2079
+ * Microsoft Teams, and so on.
2080
+ * @example
2081
+ * ```js
2082
+ * disabledActions: [Action.SyncToOtherApps]
2083
+ * ```
2084
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2085
+ */
1586
2086
  Action["SyncToOtherApps"] = "sync-to-other-apps";
2087
+ /**
2088
+ * The **Manage pipelines** action on Answers and Liveboard visualizations.
2089
+ * Allows users to manage data sync pipelines to third-party apps.
2090
+ * @example
2091
+ * ```js
2092
+ * disabledActions: [Action.SyncToOtherApps]
2093
+ * ```
2094
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2095
+ */
1587
2096
  Action["ManagePipelines"] = "manage-pipeline";
1588
2097
  /**
2098
+ * The **Filter** action on Liveboard visualizations.
2099
+ * Allows users to apply cross-filters on a Liveboard.
2100
+ * @example
2101
+ * ```js
2102
+ * disabledActions: [Action.CrossFilter]
2103
+ * ```
1589
2104
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1590
2105
  */
1591
2106
  Action["CrossFilter"] = "context-menu-item-cross-filter";
1592
2107
  /**
2108
+ * The **Remove** action that appears when cross filters are applied
2109
+ * on a Liveboard.
2110
+ * Removes filters applied o a visualization.
2111
+ * @example
2112
+ * ```js
2113
+ * disabledActions: [Action.RemoveCrossFilter]
2114
+ * ```
1593
2115
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1594
2116
  */
1595
2117
  Action["RemoveCrossFilter"] = "context-menu-item-remove-cross-filter";
1596
2118
  /**
2119
+ * The **Aggregate** option in the chart axis or the
2120
+ * table column customization menu.
2121
+ * Provides aggregation options to analyze the data on a chart or table.
2122
+ * @example
2123
+ * ```js
2124
+ * disabledActions: [Action.AxisMenuAggregate]
2125
+ * ```
1597
2126
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1598
2127
  */
1599
2128
  Action["AxisMenuAggregate"] = "axisMenuAggregate";
1600
2129
  /**
2130
+ * The **Time bucket** option in the chart axis or table column
2131
+ * customization menu.
2132
+ * Allows defining time metric for date comparison.
2133
+ * @example
2134
+ * ```js
2135
+ * disabledActions: [Action.AxisMenuTimeBucket]
2136
+ * ```
1601
2137
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1602
2138
  */
1603
2139
  Action["AxisMenuTimeBucket"] = "axisMenuTimeBucket";
1604
2140
  /**
2141
+ * The **Filter** action in the chart axis or table column
2142
+ * customization menu.
2143
+ * @example
2144
+ * ```js
2145
+ * disabledActions: [Action.AxisMenuFilter]
2146
+ * ```
1605
2147
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1606
2148
  */
1607
2149
  Action["AxisMenuFilter"] = "axisMenuFilter";
1608
2150
  /**
2151
+ * The **Conditional formatting** action on chart or table.
2152
+ * Allows adding rules for conditional formatting of data
2153
+ * points on a chart or table.
2154
+ * @example
2155
+ * ```js
2156
+ * disabledActions: [Action.AxisMenuConditionalFormat]
2157
+ * ```
1609
2158
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1610
2159
  */
1611
2160
  Action["AxisMenuConditionalFormat"] = "axisMenuConditionalFormat";
1612
2161
  /**
2162
+ * The **Sort** menu action on a table or chart axis
2163
+ * Sorts data in ascending or descending order.
2164
+ * Allows adding, editing, or removing filters.
2165
+ * @example
2166
+ * ```js
2167
+ * disabledActions: [Action.AxisMenuConditionalFormat]
2168
+ * ```
1613
2169
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1614
2170
  */
1615
2171
  Action["AxisMenuSort"] = "axisMenuSort";
1616
2172
  /**
2173
+ * The **Group** option in the chart axis or table column
2174
+ * customization menu.
2175
+ * Allows grouping data points if the axes use the same
2176
+ * unit of measurement and a similar scale.
2177
+ * @example
2178
+ * ```js
2179
+ * disabledActions: [Action.AxisMenuGroup]
2180
+ * ```
1617
2181
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1618
2182
  */
1619
2183
  Action["AxisMenuGroup"] = "axisMenuGroup";
1620
2184
  /**
2185
+ * The **Position** option in the axis customization menu.
2186
+ * Allows changing the position of the axis to the
2187
+ * left or right side of the chart.
2188
+ * @example
2189
+ * ```js
2190
+ * disabledActions: [Action.AxisMenuPosition]
2191
+ * ```
1621
2192
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1622
2193
  */
1623
2194
  Action["AxisMenuPosition"] = "axisMenuPosition";
1624
2195
  /**
2196
+ * The **Rename** option in the chart axis or table column customization menu.
2197
+ * Renames the axis label on a chart or the column header on a table.
2198
+ * @example
2199
+ * ```js
2200
+ * disabledActions: [Action.AxisMenuRename]
2201
+ * ```
1625
2202
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1626
2203
  */
1627
2204
  Action["AxisMenuRename"] = "axisMenuRename";
1628
2205
  /**
2206
+ * The **Edit** action in the axis customization menu.
2207
+ * Allows editing the axis name, position, minimum and maximum values,
2208
+ * and format of a column.
2209
+ * @example
2210
+ * ```js
2211
+ * disabledActions: [Action.AxisMenuEdit]
2212
+ * ```
1629
2213
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1630
2214
  */
1631
2215
  Action["AxisMenuEdit"] = "axisMenuEdit";
1632
2216
  /**
2217
+ * The **Number format** action to customize the format of
2218
+ * the data labels on a chart or table.
2219
+ * @example
2220
+ * ```js
2221
+ * disabledActions: [Action.AxisMenuNumberFormat]
2222
+ * ```
1633
2223
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1634
2224
  */
1635
2225
  Action["AxisMenuNumberFormat"] = "axisMenuNumberFormat";
1636
2226
  /**
2227
+ * The **Text wrapping** action on a table.
2228
+ * Wraps or clips column text on a table.
2229
+ * @example
2230
+ * ```js
2231
+ * disabledActions: [Action.AxisMenuTextWrapping]
2232
+ * ```
1637
2233
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1638
2234
  */
1639
2235
  Action["AxisMenuTextWrapping"] = "axisMenuTextWrapping";
1640
2236
  /**
2237
+ * The **Remove** action in the chart axis or table column
2238
+ * customization menu.
2239
+ * Removes the data labels from a chart or the column of a
2240
+ * table visualization.
2241
+ * @example
2242
+ * ```js
2243
+ * disabledActions: [Action.AxisMenuRemove]
2244
+ * ```
1641
2245
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1642
2246
  */
1643
2247
  Action["AxisMenuRemove"] = "axisMenuRemove";
@@ -1646,9 +2250,31 @@
1646
2250
  */
1647
2251
  Action["InsertInToSlide"] = "insertInToSlide";
1648
2252
  /**
2253
+ * The **Rename** menu action on Liveboards and visualizations.
2254
+ * Allows renaming a Liveboard or visualization.
2255
+ * @example
2256
+ * ```js
2257
+ * disabledActions: [Action.RenameModalTitleDescription]
2258
+ * ```
1649
2259
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1650
2260
  */
1651
2261
  Action["RenameModalTitleDescription"] = "renameModalTitleDescription";
2262
+ /**
2263
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2264
+ */
2265
+ Action["RequestVerification"] = "requestVerification";
2266
+ /**
2267
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2268
+ */
2269
+ Action["MarkAsVerified"] = "markAsVerified";
2270
+ /**
2271
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2272
+ */
2273
+ Action["AddTab"] = "addTab";
2274
+ /**
2275
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2276
+ */
2277
+ Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
1652
2278
  })(exports.Action || (exports.Action = {}));
1653
2279
  // eslint-disable-next-line no-shadow
1654
2280
  var OperationType;
@@ -27434,7 +28060,7 @@
27434
28060
  });
27435
28061
  }
27436
28062
 
27437
- 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$1={".":{"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$1,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};
28063
+ 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$1={".":{"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$1,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};
27438
28064
 
27439
28065
  /**
27440
28066
  * Copyright (c) 2022
@@ -27667,11 +28293,15 @@
27667
28293
  if (this.embedConfig.authType === exports.AuthType.TrustedAuthTokenCookieless) {
27668
28294
  queryParams[Param.cookieless] = true;
27669
28295
  }
27670
- const { disabledActions, disabledActionReason, hiddenActions, visibleActions, showAlerts, additionalFlags, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, } = this.viewConfig;
28296
+ const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, hideLiveboardHeader, showLiveboardDescription, showLiveboardTitle, } = this.viewConfig;
27671
28297
  if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
27672
28298
  this.handleError('You cannot have both hidden actions and visible actions');
27673
28299
  return queryParams;
27674
28300
  }
28301
+ if (Array.isArray(visibleTabs) && Array.isArray(hiddenTabs)) {
28302
+ this.handleError('You cannot have both hidden Tabs and visible Tabs');
28303
+ return queryParams;
28304
+ }
27675
28305
  // TODO remove embedConfig.customCssUrl
27676
28306
  const cssUrlParam = ((_c = customizations === null || customizations === void 0 ? void 0 : customizations.style) === null || _c === void 0 ? void 0 : _c.customCSSUrl) || this.embedConfig.customCssUrl;
27677
28307
  if (cssUrlParam) {
@@ -27687,6 +28317,12 @@
27687
28317
  if (Array.isArray(visibleActions)) {
27688
28318
  queryParams[Param.VisibleActions] = visibleActions;
27689
28319
  }
28320
+ if (Array.isArray(hiddenTabs)) {
28321
+ queryParams[Param.HiddenTabs] = hiddenTabs;
28322
+ }
28323
+ if (Array.isArray(visibleTabs)) {
28324
+ queryParams[Param.VisibleTabs] = visibleTabs;
28325
+ }
27690
28326
  /**
27691
28327
  * Default behavior for context menu will be left-click
27692
28328
  * from version 9.2.0.cl the user have an option to override context
@@ -27718,6 +28354,15 @@
27718
28354
  if (insertInToSlide) {
27719
28355
  queryParams[Param.ShowInsertToSlide] = insertInToSlide;
27720
28356
  }
28357
+ if (hideLiveboardHeader) {
28358
+ queryParams[Param.HideLiveboardHeader] = hideLiveboardHeader;
28359
+ }
28360
+ if (showLiveboardDescription) {
28361
+ queryParams[Param.ShowLiveboardDescription] = showLiveboardDescription;
28362
+ }
28363
+ if (showLiveboardTitle) {
28364
+ queryParams[Param.ShowLiveboardTitle] = showLiveboardTitle;
28365
+ }
27721
28366
  return queryParams;
27722
28367
  }
27723
28368
  /**
@@ -28422,7 +29067,7 @@
28422
29067
  let params = {};
28423
29068
  params[Param.EmbedApp] = true;
28424
29069
  params = this.getBaseQueryParams(params);
28425
- const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, activeTabId, } = this.viewConfig;
29070
+ const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, hideTabPanel, activeTabId, } = this.viewConfig;
28426
29071
  const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
28427
29072
  || this.viewConfig.preventPinboardFilterRemoval;
28428
29073
  if (fullHeight === true) {
@@ -28447,6 +29092,9 @@
28447
29092
  if (liveboardV2 !== undefined) {
28448
29093
  params[Param.LiveboardV2Enabled] = liveboardV2;
28449
29094
  }
29095
+ if (hideTabPanel) {
29096
+ params[Param.HideTabPanel] = hideTabPanel;
29097
+ }
28450
29098
  const queryParams = getQueryParamString(params, true);
28451
29099
  return queryParams;
28452
29100
  }
@@ -28718,6 +29366,7 @@
28718
29366
  /**
28719
29367
  * Embed ThoughtSpot LLM and GPT based natural language search component.
28720
29368
  *
29369
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
28721
29370
  * @group Embed components
28722
29371
  */
28723
29372
  class SageEmbed extends V1Embed {