@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
@@ -510,7 +510,7 @@
510
510
  * .then((data) => data.token);
511
511
  * }
512
512
  * ```
513
- * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
513
+ * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
514
514
  */
515
515
  AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
516
516
  /**
@@ -633,7 +633,7 @@
633
633
  * One or more data columns have been selected.
634
634
  *
635
635
  * @returns columnIds - the list of columns
636
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
636
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
637
637
  */
638
638
  EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
639
639
  /**
@@ -666,7 +666,7 @@
666
666
  * });
667
667
  * ```
668
668
  * @return viz, clickedPoint - metadata about point that is clicked
669
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
669
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
670
670
  * @important
671
671
  */
672
672
  EmbedEvent["VizPointClick"] = "vizPointClick";
@@ -716,7 +716,7 @@
716
716
  * Emitted when the "Get Data" button in Search Bar embed
717
717
  * is clicked.
718
718
  *
719
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
719
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
720
720
  */
721
721
  EmbedEvent["GetDataClick"] = "getDataClick";
722
722
  /**
@@ -746,13 +746,13 @@
746
746
  /**
747
747
  * Emitted when any modal is opened in the app
748
748
  *
749
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
749
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
750
750
  */
751
751
  EmbedEvent["DialogOpen"] = "dialog-open";
752
752
  /**
753
753
  * Emitted when any modal is closed in the app
754
754
  *
755
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
755
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
756
756
  */
757
757
  EmbedEvent["DialogClose"] = "dialog-close";
758
758
  /**
@@ -760,136 +760,136 @@
760
760
  * You can use this event as a hook to trigger
761
761
  * other events on the rendered Liveboard.
762
762
  *
763
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
763
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
764
764
  */
765
765
  EmbedEvent["LiveboardRendered"] = "PinboardRendered";
766
766
  /**
767
767
  * This can be used to register an event listener which
768
768
  * is triggered on all events.
769
769
  *
770
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
770
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
771
771
  */
772
772
  EmbedEvent["ALL"] = "*";
773
773
  /**
774
- * Emitted when answer is saved in the app
774
+ * Emitted when an Answer is saved in the app
775
775
  *
776
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
776
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
777
777
  */
778
778
  EmbedEvent["Save"] = "save";
779
779
  /**
780
780
  * Emitted when the download action is triggered on an answer
781
781
  *
782
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
782
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
783
783
  */
784
784
  EmbedEvent["Download"] = "download";
785
785
  /**
786
786
  * Emitted when the download action is triggered on an answer
787
787
  *
788
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
788
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
789
789
  */
790
790
  EmbedEvent["DownloadAsPng"] = "downloadAsPng";
791
791
  /**
792
792
  * Emitted when the Download as PDF action is triggered on an answer
793
793
  *
794
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
794
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
795
795
  */
796
796
  EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
797
797
  /**
798
798
  * Emitted when the Download as CSV action is triggered on an answer
799
799
  *
800
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
800
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
801
801
  */
802
802
  EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
803
803
  /**
804
804
  * Emitted when the Download as XLSX action is triggered on an answer
805
805
  *
806
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
806
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
807
807
  */
808
808
  EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
809
809
  /**
810
810
  * Emitted when an answer is deleted in the app
811
811
  *
812
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
812
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
813
813
  */
814
814
  EmbedEvent["AnswerDelete"] = "answerDelete";
815
815
  /**
816
816
  * Emitted when an answer is pinned to a Liveboard
817
817
  *
818
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
818
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
819
819
  */
820
820
  EmbedEvent["Pin"] = "pin";
821
821
  /**
822
822
  * Emitted when SpotIQ analysis is triggered
823
823
  *
824
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
824
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
825
825
  */
826
826
  EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
827
827
  /**
828
828
  * Emitted when a user shares an object with another user or group
829
829
  *
830
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
830
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
831
831
  */
832
832
  EmbedEvent["Share"] = "share";
833
833
  /**
834
834
  * Emitted when a user clicks the Include action to include a specific value or data
835
835
  * on a chart or table
836
836
  *
837
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
837
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
838
838
  */
839
839
  EmbedEvent["DrillInclude"] = "context-menu-item-include";
840
840
  /**
841
841
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
842
842
  * on a chart or table
843
843
  *
844
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
844
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
845
845
  */
846
846
  EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
847
847
  /**
848
848
  * Emitted when copied column value on the app
849
849
  *
850
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
850
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
851
851
  */
852
852
  EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
853
853
  /**
854
854
  * Emitted when a user clicks the Update TML action
855
855
  *
856
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
856
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
857
857
  */
858
858
  EmbedEvent["UpdateTML"] = "updateTSL";
859
859
  /**
860
860
  * Emitted when a user clicks the Edit TML action
861
861
  *
862
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
862
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
863
863
  */
864
864
  EmbedEvent["EditTML"] = "editTSL";
865
865
  /**
866
866
  * Emitted when ExportTML trigger in answer on the app
867
867
  *
868
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
868
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
869
869
  */
870
870
  EmbedEvent["ExportTML"] = "exportTSL";
871
871
  /**
872
872
  * Emitted when an answer is saved as a view
873
873
  *
874
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
874
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
875
875
  */
876
876
  EmbedEvent["SaveAsView"] = "saveAsView";
877
877
  /**
878
878
  * Emitted when copy of existing answer on the app
879
879
  *
880
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
880
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
881
881
  */
882
882
  EmbedEvent["CopyAEdit"] = "copyAEdit";
883
883
  /**
884
884
  * Emitted when a user clicks Show underlying data on an answe
885
885
  *
886
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
886
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
887
887
  */
888
888
  EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
889
889
  /**
890
890
  * Emitted when an answer is switched to a chart or table view
891
891
  *
892
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
892
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
893
893
  */
894
894
  EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
895
895
  /**
@@ -901,67 +901,67 @@
901
901
  /**
902
902
  * Emitted when a user clicks Show Liveboard details on a Liveboard
903
903
  *
904
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
904
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
905
905
  */
906
906
  EmbedEvent["LiveboardInfo"] = "pinboardInfo";
907
907
  /**
908
908
  * Emitted when a user clicks on the Favorite icon on a Liveboard
909
909
  *
910
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
910
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
911
911
  */
912
912
  EmbedEvent["AddToFavorites"] = "addToFavorites";
913
913
  /**
914
914
  * Emitted when a user clicks Schedule on a Liveboard
915
915
  *
916
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
916
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
917
917
  */
918
918
  EmbedEvent["Schedule"] = "subscription";
919
919
  /**
920
920
  * Emitted when a user clicks Edit on a Liveboard or visualization
921
921
  *
922
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
922
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
923
923
  */
924
924
  EmbedEvent["Edit"] = "edit";
925
925
  /**
926
926
  * Emitted when a user clicks Make a copy on a Liveboard
927
927
  *
928
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
928
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
929
929
  */
930
930
  EmbedEvent["MakeACopy"] = "makeACopy";
931
931
  /**
932
932
  * Emitted when a user clicks Present on a Liveboard or visualization
933
933
  *
934
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
934
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
935
935
  */
936
936
  EmbedEvent["Present"] = "present";
937
937
  /**
938
938
  * Emitted when a user clicks Delete on a Liveboard
939
939
  *
940
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
940
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
941
941
  */
942
942
  EmbedEvent["Delete"] = "delete";
943
943
  /**
944
944
  * Emitted when a user clicks Manage schedules on a Liveboard
945
945
  *
946
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
946
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
947
947
  */
948
948
  EmbedEvent["SchedulesList"] = "schedule-list";
949
949
  /**
950
950
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
951
951
  *
952
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
952
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
953
953
  */
954
954
  EmbedEvent["Cancel"] = "cancel";
955
955
  /**
956
956
  * Emitted when a user clicks Explore on a visualization
957
957
  *
958
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
958
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
959
959
  */
960
960
  EmbedEvent["Explore"] = "explore";
961
961
  /**
962
962
  * Emitted when a user clicks Copy link action on a visualization
963
963
  *
964
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
964
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
965
965
  */
966
966
  EmbedEvent["CopyLink"] = "embedDocument";
967
967
  /**
@@ -982,16 +982,23 @@
982
982
  * @hidden
983
983
  */
984
984
  EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
985
+ /**
986
+ * Emitted when a user changes any filter on a Liveboard.
987
+ *
988
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
989
+ */
990
+ EmbedEvent["FilterChanged"] = "filterChanged";
985
991
  })(exports.EmbedEvent || (exports.EmbedEvent = {}));
986
992
  (function (HostEvent) {
987
993
  /**
988
- * Trigger a search
989
- *
994
+ * Triggers a search query in AppEmbed and SearchEmbed
995
+ * deployments.
996
+ * Includes the following properties:
990
997
  * @param - dataSourceIds - The data source GUID to Search on
991
998
  * - Although an array, only a single source
992
- * is supported at this time.
993
- * @param - searchQuery - The search query
994
- * @param - execute - execute the existing / updated query
999
+ * is supported.
1000
+ * @param - searchQuery - Query string with search tokens
1001
+ * @param - execute - executes the existing / updated query
995
1002
  * @example
996
1003
  * ```js
997
1004
  * searchEmbed.trigger(HostEvent.Search, {
@@ -1003,13 +1010,13 @@
1003
1010
  */
1004
1011
  HostEvent["Search"] = "search";
1005
1012
  /**
1006
- * Trigger a drill on certain points by certain column
1007
- *
1013
+ * Triggers a drill on certain points of the specified column
1014
+ * Includes the following properties:
1008
1015
  * @param - points - an object containing selectedPoints/clickedPoints
1009
- * eg. { selectedPoints: []}
1010
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
1011
- * if not provided it will auto drill by the configured
1012
- * column.
1016
+ * to drill to. For example, { selectedPoints: []}
1017
+ * @param - columnGuid - Optional. GUID of the column to drill
1018
+ * by. If not provided it will auto drill by the configured
1019
+ * column.
1013
1020
  * @example
1014
1021
  * ```js
1015
1022
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -1042,17 +1049,17 @@
1042
1049
  */
1043
1050
  HostEvent["Reload"] = "reload";
1044
1051
  /**
1045
- * Set the visible visualizations on a Liveboard.
1052
+ * Sets the visible visualizations on a Liveboard.
1046
1053
  *
1047
- * @param - an array of ids of visualizations to show, the ids not passed
1048
- * will be hidden.
1054
+ * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
1055
+ * in this parameter will be hidden.
1049
1056
  * @example
1050
1057
  * ```js
1051
1058
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
1052
1059
  * '730496d6-6903-4601-937e-2c691821af3c',
1053
1060
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
1054
1061
  * ```
1055
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1062
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1056
1063
  */
1057
1064
  HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
1058
1065
  /**
@@ -1069,9 +1076,18 @@
1069
1076
  */
1070
1077
  HostEvent["SetActiveTab"] = "SetActiveTab";
1071
1078
  /**
1072
- * Update the runtime filters. The runtime filters passed here are extended
1073
- * on to the existing runtime filters if they exist.
1074
- *
1079
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
1080
+ * runtime filters passed here are appended to the existing runtime
1081
+ * filters.
1082
+ * Pass an array of runtime filters with the following attributes:
1083
+ * `columnName`
1084
+ * _String_. The name of the column to filter on.
1085
+ * `operator`
1086
+ * Runtime filter operator to apply. For information,
1087
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
1088
+ * `values`
1089
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
1090
+ * such as BW and IN accept multiple operands.
1075
1091
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
1076
1092
  * @example
1077
1093
  * ```js
@@ -1080,25 +1096,24 @@
1080
1096
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
1081
1097
  * ])
1082
1098
  * ```
1083
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1099
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1084
1100
  * @important
1085
1101
  */
1086
1102
  HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
1087
1103
  /**
1088
- * Navigate to a specific page in App embed without any reload.
1104
+ * Navigate to a specific page in the embedded application without reloading the page.
1089
1105
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
1090
- *
1091
1106
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
1092
1107
  * @example
1093
1108
  * ```js
1094
1109
  * appEmbed.navigateToPage(-1)
1095
1110
  * ```
1096
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
1111
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
1097
1112
  */
1098
1113
  HostEvent["Navigate"] = "Navigate";
1099
1114
  /**
1100
1115
  * Opens the filter panel for a particular column.
1101
- * Works with Search embed.
1116
+ * Works with Search and Liveboard embed.
1102
1117
  *
1103
1118
  * @param - { columnId: string,
1104
1119
  * name: string,
@@ -1107,233 +1122,257 @@
1107
1122
  * @example
1108
1123
  * ```js
1109
1124
  * searchEmbed.trigger(HostEvent.OpenFilter,
1110
- * { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
1125
+ * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
1126
+ * LiveboardEmbed.trigger(HostEvent.OpenFilter,
1127
+ * { columnId: '<column-GUID>'})
1111
1128
  * ```
1112
1129
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1113
1130
  */
1114
1131
  HostEvent["OpenFilter"] = "openFilter";
1115
1132
  /**
1116
- * Adds the columns to the current Search.
1133
+ * Adds columns to the current search query.
1117
1134
  *
1118
1135
  * @param - { columnIds: string[] }
1119
1136
  * @example
1120
1137
  * ```js
1121
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
1138
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
1122
1139
  * ```
1123
1140
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1124
1141
  */
1125
1142
  HostEvent["AddColumns"] = "addColumns";
1126
1143
  /**
1127
- * Removes a column from the current Search.
1144
+ * Removes a column from the current search query.
1128
1145
  *
1129
1146
  * @param - { columnId: string }
1130
1147
  * @example
1131
1148
  * ```js
1132
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
1149
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
1133
1150
  * ```
1134
1151
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1135
1152
  */
1136
1153
  HostEvent["RemoveColumn"] = "removeColumn";
1137
1154
  /**
1138
- * Gets the current pinboard content.
1155
+ * Gets the current Liveboard content.
1139
1156
  *
1140
1157
  * @example
1141
1158
  * ```js
1142
1159
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
1143
1160
  * ```
1144
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
1161
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
1145
1162
  */
1146
1163
  HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
1147
1164
  /**
1148
- * Triggers the Pin action on an embedded object
1165
+ * Triggers the **Pin** action on an embedded object
1149
1166
  *
1150
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1151
- * can be left empty for search and visualization embeds
1167
+ * @param - Liveboard embed takes the `vizId` as a
1168
+ * key. Can be left undefined when embedding Search, full app or
1169
+ * a visualization.
1152
1170
  * @example
1153
1171
  * ```js
1154
1172
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1173
+ * ```
1174
+ * ```js
1155
1175
  * vizEmbed.trigger(HostEvent.Pin)
1176
+ * ```
1177
+ * ```js
1156
1178
  * searchEmbed.trigger(HostEvent.Pin)
1157
1179
  * ```
1158
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1180
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1159
1181
  */
1160
1182
  HostEvent["Pin"] = "pin";
1161
1183
  /**
1162
- * Triggers the Show Liveboard details action on a Liveboard
1184
+ * Triggers the **Show Liveboard details** action on a Liveboard
1163
1185
  *
1164
1186
  * @example
1165
1187
  * ```js
1166
1188
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
1167
1189
  * ```
1168
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1190
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1169
1191
  */
1170
1192
  HostEvent["LiveboardInfo"] = "pinboardInfo";
1171
1193
  /**
1172
- * Triggers the Schedule action on a Liveboard
1194
+ * Triggers the **Schedule** action on a Liveboard
1173
1195
  *
1174
1196
  * @example
1175
1197
  * ```js
1176
1198
  * liveboardEmbed.trigger(HostEvent.Schedule)
1177
1199
  * ```
1178
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1200
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1179
1201
  */
1180
1202
  HostEvent["Schedule"] = "subscription";
1181
1203
  /**
1182
- * Triggers the Manage schedule action on a Liveboard
1204
+ * Triggers the **Manage schedule** action on a Liveboard
1183
1205
  *
1184
1206
  * @example
1185
1207
  * ```js
1186
1208
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
1187
1209
  * ```
1188
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1210
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1189
1211
  */
1190
1212
  HostEvent["SchedulesList"] = "schedule-list";
1191
1213
  /**
1192
- * Triggers the Export TML action on a Liveboard
1214
+ * Triggers the **Export TML** action on a Liveboard
1193
1215
  *
1194
1216
  * @example
1195
1217
  * ```js
1196
1218
  * liveboardEmbed.trigger(HostEvent.ExportTML)
1197
1219
  * ```
1198
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1220
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1199
1221
  */
1200
1222
  HostEvent["ExportTML"] = "exportTSL";
1201
1223
  /**
1202
- * Triggers the Edit TML action on a Liveboard
1224
+ * Triggers the **Edit TML** action on a Liveboard
1203
1225
  *
1204
1226
  * @example
1205
1227
  * ```js
1206
1228
  * liveboardEmbed.trigger(HostEvent.EditTML)
1207
1229
  * ```
1208
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1230
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1209
1231
  */
1210
1232
  HostEvent["EditTML"] = "editTSL";
1211
1233
  /**
1212
- * Triggers the Update TML action on a Liveboard
1234
+ * Triggers the **Update TML** action on a Liveboard
1213
1235
  *
1214
1236
  * @example
1215
1237
  * ```js
1216
1238
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
1217
1239
  * ```
1218
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1240
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1219
1241
  */
1220
1242
  HostEvent["UpdateTML"] = "updateTSL";
1221
1243
  /**
1222
- * Triggers the Download PDF action on a Liveboard
1244
+ * Triggers the **Download PDF** action on a Liveboard
1223
1245
  *
1224
1246
  * @example
1225
1247
  * ```js
1226
1248
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
1227
1249
  * ```
1228
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1250
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1229
1251
  */
1230
1252
  HostEvent["DownloadAsPdf"] = "downloadAsPdf";
1231
1253
  /**
1232
- * Triggers the Make a copy action on a Liveboard, search or visualization
1254
+ * Triggers the **Make a copy** action on a Liveboard, Search, or
1255
+ * visualization page
1233
1256
  *
1234
1257
  * @example
1235
1258
  * ```js
1236
1259
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1260
+ * ```
1261
+ * ```js
1237
1262
  * vizEmbed.trigger(HostEvent.MakeACopy)
1263
+ * ```
1264
+ * ```js
1238
1265
  * searchEmbed.trigger(HostEvent.MakeACopy)
1239
1266
  * ```
1240
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1267
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1241
1268
  */
1242
1269
  HostEvent["MakeACopy"] = "makeACopy";
1243
1270
  /**
1244
- * Triggers the Delete action on a Liveboard
1271
+ * Triggers the **Delete** action on a Liveboard
1245
1272
  *
1246
1273
  * @example
1247
1274
  * ```js
1248
1275
  * appEmbed.trigger(HostEvent.Remove)
1249
1276
  * ```
1250
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1277
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1251
1278
  */
1252
1279
  HostEvent["Remove"] = "delete";
1253
1280
  /**
1254
- * Triggers the Explore action on a visualization
1281
+ * Triggers the **Explore* action on a visualization
1255
1282
  *
1256
- * @param - an object with vizId as a key
1283
+ * @param - an object with `vizId` as a key
1257
1284
  * @example
1258
1285
  * ```js
1259
1286
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1260
1287
  * ```
1261
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1288
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1262
1289
  */
1263
1290
  HostEvent["Explore"] = "explore";
1264
1291
  /**
1265
- * Triggers the Create alert action on a visualization
1292
+ * Triggers the **Create alert** action on a visualization
1266
1293
  *
1267
- * @param - an object with vizId as a key
1294
+ * @param - an object with `vizId` as a key
1268
1295
  * @example
1269
1296
  * ```js
1270
1297
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
1271
1298
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1272
1299
  * })
1273
1300
  * ```
1274
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1301
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1275
1302
  */
1276
1303
  HostEvent["CreateMonitor"] = "createMonitor";
1277
1304
  /**
1278
- * Triggers the Manage alert action on a visualization
1305
+ * Triggers the **Manage alerts** action on a visualization
1279
1306
  *
1280
- * @param - an object with vizId as a key
1307
+ * @param - an object with `vizId` as a key
1281
1308
  * @example
1282
1309
  * ```js
1283
1310
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
1284
1311
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1285
1312
  * })
1286
1313
  * ```
1287
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1314
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1288
1315
  */
1289
1316
  HostEvent["ManageMonitor"] = "manageMonitor";
1290
1317
  /**
1291
- * Triggers the Edit action on a Liveboard or visualization
1318
+ * Triggers the **Edit** action on a Liveboard or visualization
1292
1319
  *
1293
- * @param - object - to trigger the action for a specfic visualization
1294
- * in Liveboard embed, pass in vizId as a key
1320
+ * @param - object - To trigger the action for a specific visualization
1321
+ * in Liveboard embed, pass in `vizId` as a key.
1322
+ * Can be left undefined when embedding Search, full app, or
1323
+ * a visualization.
1295
1324
  * @example
1296
1325
  * ```js
1297
1326
  * liveboardEmbed.trigger(HostEvent.Edit)
1298
- *
1327
+ * ```
1328
+ * ```js
1299
1329
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
1300
1330
  * '730496d6-6903-4601-937e-2c691821af3c'})
1301
- *
1331
+ * ```
1332
+ * ```js
1302
1333
  * vizEmbed.trigger((HostEvent.Edit)
1303
1334
  * ```
1304
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1335
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1305
1336
  */
1306
1337
  HostEvent["Edit"] = "edit";
1307
1338
  /**
1308
- * Triggers the Copy link action on a Liveboard or visualization
1339
+ * Triggers the **Copy link** action on a Liveboard or visualization
1309
1340
  *
1310
- * @param - object - to trigger the action for a s
1311
- * pecfic visualization in Liveboard embed, pass in vizId as a key
1341
+ * @param - object - to trigger the action for a
1342
+ * specific visualization in Liveboard embed, pass in `vizId` as a key
1312
1343
  * @example
1313
1344
  * ```js
1314
1345
  * liveboardEmbed.trigger(HostEvent.CopyLink)
1346
+ * ```
1347
+ * ```js
1315
1348
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1349
+ * ```
1350
+ * ```js
1316
1351
  * vizEmbed.trigger((HostEvent.CopyLink)
1317
1352
  * ```
1318
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1353
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1319
1354
  */
1320
1355
  HostEvent["CopyLink"] = "embedDocument";
1321
1356
  /**
1322
- * Triggers the Present action on a Liveboard or visualization
1357
+ * Triggers the **Present** action on a Liveboard or visualization
1323
1358
  *
1324
- * @param - object - to trigger the action for a specfic visualization
1325
- * in Liveboard embed, pass in vizId as a key
1359
+ * @param - object - to trigger the action for a specific visualization
1360
+ * in Liveboard embed, pass in `vizId` as a key
1326
1361
  * @example
1327
1362
  * ```js
1328
1363
  * liveboardEmbed.trigger(HostEvent.Present)
1364
+ * ```
1365
+ * ```js
1329
1366
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1367
+ * ```
1368
+ * ```js
1330
1369
  * vizEmbed.trigger((HostEvent.Present)
1331
1370
  * ```
1332
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1371
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1333
1372
  */
1334
1373
  HostEvent["Present"] = "present";
1335
1374
  /**
1336
- * Get TML for the current search.
1375
+ * Gets TML for the current search.
1337
1376
  *
1338
1377
  * @example
1339
1378
  * ```js
@@ -1343,79 +1382,89 @@
1343
1382
  * );
1344
1383
  * })
1345
1384
  * ```
1346
- * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
1385
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
1347
1386
  * @important
1348
1387
  */
1349
1388
  HostEvent["GetTML"] = "getTML";
1350
1389
  /**
1351
- * Triggers the ShowUnderlyingData action on visualization or search
1390
+ * Triggers the **Show underlying data** action on visualization or search
1352
1391
  *
1353
1392
  * @param - an object with vizId as a key
1354
1393
  * @example
1355
1394
  * ```js
1356
1395
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
1357
1396
  * '730496d6-6903-4601-937e-2c691821af3c'})
1358
- *
1397
+ * ```
1398
+ * ```js
1359
1399
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
1360
- *
1400
+ * ```
1401
+ * ```js
1361
1402
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
1362
1403
  * ```
1363
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1404
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1364
1405
  */
1365
1406
  HostEvent["ShowUnderlyingData"] = "showUnderlyingData";
1366
1407
  /**
1367
- * Triggers the Delete action on visualization or search
1408
+ * Triggers the **Delete** action on visualization or search
1368
1409
  *
1369
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1370
- * can be left empty for search and visualization embeds
1410
+ * @param - Liveboard embed takes an object with `vizId` as a key.
1411
+ * Can be left empty if embedding Search or visualization.
1371
1412
  * @example
1372
1413
  * ```js
1373
1414
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
1374
1415
  * '730496d6-6903-4601-937e-2c691821af3c'})
1375
- *
1416
+ * ```
1417
+ * ```js
1376
1418
  * vizEmbed.trigger(HostEvent.Delete)
1377
- *
1419
+ * ```
1420
+ * ```js
1378
1421
  * searchEmbed.trigger(HostEvent.Delete)
1379
1422
  * ```
1380
- * @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
1381
1424
  */
1382
1425
  HostEvent["Delete"] = "onDeleteAnswer";
1383
1426
  /**
1384
- * Triggers the SpotIQAnalyze action on visualization or search
1385
- *
1386
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1387
- * can be left empty for search and visualization embeds
1427
+ * Triggers the **SpotIQ analyze** action on visualization
1428
+ * or search.
1429
+ * @param - Liveboard embed takes `vizId` as a
1430
+ * key. Can be left undefined when embedding Search or
1431
+ * visualization.
1388
1432
  * @example
1389
1433
  * ```js
1390
1434
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
1391
1435
  * '730496d6-6903-4601-937e-2c691821af3c'})
1392
- *
1436
+ * ```
1437
+ * ```js
1393
1438
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
1394
- *
1439
+ * ```
1440
+ * ```js
1395
1441
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
1396
1442
  * ```
1397
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1443
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1398
1444
  */
1399
1445
  HostEvent["SpotIQAnalyze"] = "spotIQAnalyze";
1400
1446
  /**
1401
- * Triggers the Download action on visualization or search when Displaymode is Chart
1447
+ * Triggers the **Download** action on charts in
1448
+ * the embedded view.
1402
1449
  *
1403
1450
  * @example
1404
1451
  * ```js
1405
1452
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
1406
1453
  * '730496d6-6903-4601-937e-2c691821af3c'})
1407
- *
1454
+ * ```
1455
+ * ```js
1408
1456
  * vizEmbed.trigger(HostEvent.Download)
1409
- *
1457
+ * ```
1458
+ * ```js
1410
1459
  * searchEmbed.trigger(HostEvent.Download)
1411
1460
  * ```
1412
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
1413
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1461
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
1462
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1414
1463
  */
1415
1464
  HostEvent["Download"] = "downloadAsPng";
1416
1465
  /**
1417
- * Triggers the Download action on visualization or search when Displaymode is Chart
1418
- *
1466
+ * Triggers the **Download** > **PNG** action on
1467
+ * charts in the embedded view.
1419
1468
  * @example
1420
1469
  * ```js
1421
1470
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1425,115 +1474,192 @@
1425
1474
  *
1426
1475
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
1427
1476
  * ```
1428
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
1477
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
1429
1478
  */
1430
1479
  HostEvent["DownloadAsPng"] = "downloadAsPng";
1431
1480
  /**
1432
- * Triggers the downloadAsCSV action on visualization or search
1481
+ * Triggers the **Download** > **CSV** action on tables in
1482
+ * the embedded view.
1433
1483
  *
1434
1484
  * @example
1435
1485
  * ```js
1436
1486
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
1437
1487
  * '730496d6-6903-4601-937e-2c691821af3c'})
1438
- *
1488
+ * ```
1489
+ * ```js
1439
1490
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
1440
- *
1491
+ * ```
1492
+ * ```js
1441
1493
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
1442
1494
  * ```
1443
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1495
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1444
1496
  */
1445
1497
  HostEvent["DownloadAsCsv"] = "downloadAsCSV";
1446
1498
  /**
1447
- * Triggers the downloadAsXLSX action on visualization or search
1448
- *
1499
+ * Triggers the **Download** > **XLSX** action on tables
1500
+ * in the embedded view.
1449
1501
  * @example
1450
1502
  * ```js
1451
1503
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
1452
1504
  * '730496d6-6903-4601-937e-2c691821af3c'})
1453
- *
1505
+ * ```
1506
+ * ```js
1454
1507
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
1455
- *
1508
+ * ```
1509
+ * ```js
1456
1510
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
1457
1511
  * ```
1458
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1512
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1459
1513
  */
1460
1514
  HostEvent["DownloadAsXlsx"] = "downloadAsXLSX";
1461
1515
  /**
1462
- * Triggers the Share action on a liveboard or answer
1516
+ * Triggers the **Share** action on an embedded
1517
+ * Liveboard or Answer.
1463
1518
  *
1464
1519
  * @example
1465
1520
  * ```js
1466
1521
  * liveboardEmbed.trigger(HostEvent.Share)
1467
- *
1522
+ * ```
1523
+ * ```js
1468
1524
  * searchEmbed.trigger(HostEvent.Share)
1469
1525
  * ```
1470
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1526
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1471
1527
  */
1472
1528
  HostEvent["Share"] = "share";
1473
1529
  /**
1474
- * Trigger the Save action on a liveboard or answer
1475
- *
1530
+ * Triggers the **Save** action on a Liveboard or Answer.
1531
+ * Saves the changes.
1476
1532
  * @example
1477
1533
  * ```js
1478
1534
  * liveboardEmbed.trigger(HostEvent.Save)
1479
- *
1535
+ * ```
1536
+ * ```js
1480
1537
  * searchEmbed.trigger(HostEvent.Save)
1481
1538
  * ```
1482
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1539
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1483
1540
  */
1484
1541
  HostEvent["Save"] = "save";
1485
1542
  /**
1486
- * Triggers the SyncToSheets action on visualization
1487
- *
1488
- * @param - an object with vizId as a key
1543
+ * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
1544
+ * Sends data from an Answer or Liveboard visualization to a Google sheet.
1545
+ * @param - an object with `vizId` as a key
1489
1546
  * @example
1490
1547
  * ```js
1491
1548
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
1492
1549
  * '730496d6-6903-4601-937e-2c691821af3c'})
1493
- *
1550
+ * ```
1551
+ * ```js
1494
1552
  * vizEmbed.trigger(HostEvent.SyncToSheets)
1495
1553
  * ```
1496
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1554
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1497
1555
  */
1498
1556
  HostEvent["SyncToSheets"] = "sync-to-sheets";
1499
1557
  /**
1500
- * Triggers the SyncToOtherApps action on visualization
1501
- *
1558
+ * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
1559
+ * Sends data from an Answer or Liveboard visualization to third-party apps such
1560
+ * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
1502
1561
  * @param - an object with vizId as a key
1503
1562
  * @example
1504
1563
  * ```js
1505
1564
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
1506
1565
  * '730496d6-6903-4601-937e-2c691821af3c'})
1507
- *
1566
+ * ```
1567
+ * ```js
1508
1568
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
1509
1569
  * ```
1510
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1570
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1511
1571
  */
1512
1572
  HostEvent["SyncToOtherApps"] = "sync-to-other-apps";
1513
1573
  /**
1514
- * Triggers the ManagePipelines action on visualization
1515
- *
1516
- * @param - an object with vizId as a key
1574
+ * Triggers the **Manage pipelines** action on an embedded
1575
+ * visualization or Answer.
1576
+ * Allows users to manage ThoughtSpot Sync pipelines.
1577
+ * @param - an object with `vizId` as a key
1517
1578
  * @example
1518
1579
  * ```js
1519
1580
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
1520
1581
  * '730496d6-6903-4601-937e-2c691821af3c'})
1521
- *
1582
+ * ```
1583
+ * ```js
1522
1584
  * vizEmbed.trigger(HostEvent.ManagePipelines)
1523
1585
  * ```
1524
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1586
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1525
1587
  */
1526
1588
  HostEvent["ManagePipelines"] = "manage-pipeline";
1527
1589
  /**
1528
- * Triggers the Reset search in answer
1590
+ * Triggers the Reset search on the Search page
1529
1591
  *
1530
1592
  * @example
1531
1593
  * ```js
1532
1594
  * searchEmbed.trigger(HostEvent.ResetSearch)
1533
1595
  * ```
1534
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
1596
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
1535
1597
  */
1536
1598
  HostEvent["ResetSearch"] = "resetSearch";
1599
+ /**
1600
+ * Gets the currents visible and runtime filters applied on a Liveboard
1601
+ *
1602
+ * @example
1603
+ * liveboardEmbed.trigger(HostEvent.GetFilters)
1604
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1605
+ */
1606
+ HostEvent["GetFilters"] = "getFilters";
1607
+ /**
1608
+ * Updates the visible filters on the Liveboard.
1609
+ *
1610
+ * @param - filter: filter object containing column name and filter operation and values
1611
+ * @example
1612
+ *
1613
+ * ```js
1614
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
1615
+ * filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
1616
+ * })
1617
+ * ```
1618
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1619
+ */
1620
+ HostEvent["UpdateFilters"] = "updateFilters";
1621
+ /*
1622
+ * Get Tab for the current Liveboard.
1623
+ *
1624
+ * @example
1625
+ * ```js
1626
+ * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
1627
+ * console.log(
1628
+ * tabDetails // TabDetails of current LB
1629
+ * );
1630
+ * })
1631
+ * ```
1632
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1633
+ */
1634
+ HostEvent["GetTabs"] = "getTabs";
1635
+ /**
1636
+ * Set the visible Tabs on a Liveboard.
1637
+ *
1638
+ * @param - an array of ids of Tabs to show, the ids not passed
1639
+ * will be hidden.
1640
+ * @example
1641
+ * ```js
1642
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
1643
+ * '430496d6-6903-4601-937e-2c691821af3c',
1644
+ * 'f547ec54-2a37-4516-a222-2b06719af726'])
1645
+ * ```
1646
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1647
+ */
1648
+ HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
1649
+ /**
1650
+ * Set the hidden tabs on a Liveboard.
1651
+ *
1652
+ * @param - an array of ids of Tabs to hide, the ids not passed
1653
+ * will be shown.
1654
+ * @example
1655
+ * ```js
1656
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
1657
+ * '630496d6-6903-4601-937e-2c691821af3c',
1658
+ * 'i547ec54-2a37-4516-a222-2b06719af726'])
1659
+ * ```
1660
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1661
+ */
1662
+ HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
1537
1663
  })(exports.HostEvent || (exports.HostEvent = {}));
1538
1664
  /**
1539
1665
  * The different visual modes that the data sources panel within
@@ -1613,8 +1739,22 @@
1613
1739
  Param["DisableWorksheetChange"] = "disableWorksheetChange";
1614
1740
  Param["HideEurekaResults"] = "hideEurekaResults";
1615
1741
  Param["HideEurekaSuggestions"] = "hideEurekaSuggestions";
1742
+ Param["HideLiveboardHeader"] = "hideLiveboardHeader";
1743
+ Param["ShowLiveboardDescription"] = "showLiveboardDescription";
1744
+ Param["ShowLiveboardTitle"] = "showLiveboardTitle";
1745
+ Param["HiddenTabs"] = "hideTabs";
1746
+ Param["VisibleTabs"] = "visibleTabs";
1747
+ Param["HideTabPanel"] = "hideTabPanel";
1616
1748
  })(Param || (Param = {}));
1617
1749
  (function (Action) {
1750
+ /**
1751
+ * The **Save** action on an Answer or Liveboard.
1752
+ * Allows users to save the changes.
1753
+ * @example
1754
+ * ```js
1755
+ * disabledActions: [Action.SaveAsView]
1756
+ * ```
1757
+ */
1618
1758
  Action["Save"] = "save";
1619
1759
  /**
1620
1760
  * @hidden
@@ -1624,27 +1764,137 @@
1624
1764
  * @hidden
1625
1765
  */
1626
1766
  Action["SaveUntitled"] = "saveUntitled";
1767
+ /**
1768
+ * The **Save as View** action on the Answer
1769
+ * page. Saves an Answer as a View object.
1770
+ *
1771
+ * @example
1772
+ * ```js
1773
+ * disabledActions: [Action.SaveAsView]
1774
+ * ```
1775
+ */
1627
1776
  Action["SaveAsView"] = "saveAsView";
1777
+ /**
1778
+ * The **Make a copy** action on a Liveboard or Answer
1779
+ * page.
1780
+ * Creates a copy of the Liveboard, visualization,
1781
+ * or Answer.
1782
+ *
1783
+ * @example
1784
+ * ```js
1785
+ * disabledActions: [Action.MakeACopy]
1786
+ * ```
1787
+ */
1628
1788
  Action["MakeACopy"] = "makeACopy";
1789
+ /**
1790
+ * The **Copy and Edit** action on a Liveboard.
1791
+ * This action is now replaced with `Action.MakeACopy`.
1792
+ *
1793
+ * @example
1794
+ * ```js
1795
+ * disabledActions: [Action.EditACopy]
1796
+ * ```
1797
+ */
1629
1798
  Action["EditACopy"] = "editACopy";
1799
+ /**
1800
+ * The **Copy link** menu action on a Liveboard visualization.
1801
+ * Copies the visualization URL
1802
+ * @example
1803
+ * ```js
1804
+ * disabledActions: [Action.CopyLink]
1805
+ * ```
1806
+ */
1630
1807
  Action["CopyLink"] = "embedDocument";
1631
1808
  /**
1632
1809
  * @hidden
1633
1810
  */
1634
1811
  Action["ResetLayout"] = "resetLayout";
1812
+ /**
1813
+ * The **Schedule** menu action on a Liveboard.
1814
+ * Allows scheduling a Liveboard notification.
1815
+ * @example
1816
+ * ```js
1817
+ * disabledActions: [Action.Schedule]
1818
+ * ```
1819
+ */
1635
1820
  Action["Schedule"] = "subscription";
1821
+ /**
1822
+ * The **Manage schedules** menu action on a Liveboard.
1823
+ * Allows users to manage scheduled Liveboard jobs.
1824
+ * @example
1825
+ * ```js
1826
+ * disabledActions: [Action.SchedulesList]
1827
+ * ```
1828
+ */
1636
1829
  Action["SchedulesList"] = "schedule-list";
1830
+ /**
1831
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
1832
+ * Allows users to share an object with other users and groups.
1833
+ * @example
1834
+ * ```js
1835
+ * disabledActions: [Action.Share]
1836
+ * ```
1837
+ */
1637
1838
  Action["Share"] = "share";
1839
+ /**
1840
+ * The **Add filter** action on a Liveboard and Search page.
1841
+ * Allows adding filters to Answers and visualizations on a Liveboard.
1842
+ * @example
1843
+ * ```js
1844
+ * disabledActions: [Action.AddFilter]
1845
+ * ```
1846
+ */
1638
1847
  Action["AddFilter"] = "addFilter";
1848
+ /**
1849
+ * Filter configuration options on a Liveboard and Search page.
1850
+ * Allows configuring filter options when adding filters to a
1851
+ * Liveboard or Answer.
1852
+ * @example
1853
+ * ```js
1854
+ * disabledActions: [Action.ConfigureFilter]
1855
+ * ```
1856
+ */
1639
1857
  Action["ConfigureFilter"] = "configureFilter";
1640
1858
  Action["CollapseDataSources"] = "collapseDataSources";
1859
+ /**
1860
+ * The **Choose sources** button on Search page.
1861
+ * Allows selecting data sources for search queries.
1862
+ * @example
1863
+ * ```js
1864
+ * disabledActions: [Action.ChooseDataSources]
1865
+ * ```
1866
+ */
1641
1867
  Action["ChooseDataSources"] = "chooseDataSources";
1868
+ /**
1869
+ * The **Create formula** action on a Search or Answer page.
1870
+ * Allows adding formulas to an Answer.
1871
+ * @example
1872
+ * ```js
1873
+ * disabledActions: [Action.AddFormula]
1874
+ * ```
1875
+ */
1642
1876
  Action["AddFormula"] = "addFormula";
1877
+ /**
1878
+ * The **Add parameter** action on a Liveboard or Answer.
1879
+ * Allows adding Parameters to a Liveboard or Answer.
1880
+ * @example
1881
+ * ```js
1882
+ * disabledActions: [Action.AddParameter]
1883
+ * ```
1884
+ */
1643
1885
  Action["AddParameter"] = "addParameter";
1644
1886
  /**
1645
1887
  * @hidden
1646
1888
  */
1647
1889
  Action["SearchOnTop"] = "searchOnTop";
1890
+ /**
1891
+ * The **SpotIQ analyze** menu action on a visualization or
1892
+ * Answer page.
1893
+ * @example
1894
+ * ```js
1895
+ * disabledActions: [Action.SpotIQAnalyze]
1896
+ * ```
1897
+ */
1648
1898
  Action["SpotIQAnalyze"] = "spotIQAnalyze";
1649
1899
  /**
1650
1900
  * @hidden
@@ -1659,24 +1909,150 @@
1659
1909
  * @hidden
1660
1910
  */
1661
1911
  Action["ReplaySearch"] = "replaySearch";
1912
+ /**
1913
+ * The **Show underlying data** menu action on a visualization or
1914
+ * Answer page.
1915
+ * @example
1916
+ * ```js
1917
+ * disabledActions: [Action.ShowUnderlyingData]
1918
+ * ```
1919
+ */
1662
1920
  Action["ShowUnderlyingData"] = "showUnderlyingData";
1921
+ /**
1922
+ * The **Download** menu action on Liveboard visualizations
1923
+ * and Answers.
1924
+ * Allows downloading a visualization or Answer.
1925
+ * @example
1926
+ * ```js
1927
+ * disabledActions: [Action.DownloadAsPng]
1928
+ * ```
1929
+ */
1663
1930
  Action["Download"] = "download";
1931
+ /**
1932
+ * The **Download** > **PNG** menu action for charts on a Liveboard
1933
+ * or Answer page.
1934
+ * Downloads a visualization or Answer as a PNG file.
1935
+ * @example
1936
+ * ```js
1937
+ * disabledActions: [Action.DownloadAsPng]
1938
+ * ```
1939
+ */
1664
1940
  Action["DownloadAsPng"] = "downloadAsPng";
1941
+ /**
1942
+ * The **Download** > **PDF** menu action on a Liveboard.
1943
+ * Downloads a visualization or Answer as a PDF file.
1944
+ * @example
1945
+ * ```js
1946
+ * disabledActions: [Action.DownloadAsPdf]
1947
+ * ```
1948
+ */
1665
1949
  Action["DownloadAsPdf"] = "downloadAsPdf";
1950
+ /**
1951
+ * The **Download** > **CSV** menu action for tables on a Liveboard
1952
+ * or Answer page.
1953
+ * Downloads a visualization or Answer in the XLSX format.
1954
+ * @example
1955
+ * ```js
1956
+ * disabledActions: [Action.DownloadAsCsv]
1957
+ * ```
1958
+ */
1666
1959
  Action["DownloadAsCsv"] = "downloadAsCSV";
1960
+ /**
1961
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
1962
+ * or Answer page.
1963
+ * Downloads a visualization or Answer in the XLSX format.
1964
+ * @example
1965
+ * ```js
1966
+ * disabledActions: [Action.DownloadAsXlsx]
1967
+ * ```
1968
+ */
1667
1969
  Action["DownloadAsXlsx"] = "downloadAsXLSX";
1668
1970
  /**
1669
1971
  * @hidden
1670
1972
  */
1671
1973
  Action["DownloadTrace"] = "downloadTrace";
1974
+ /**
1975
+ * The **Export TML** menu action on Liveboard, Answers
1976
+ * Worksheets and Data Connections page.
1977
+ * Exports an object as a TML file.
1978
+ * @example
1979
+ * ```js
1980
+ * disabledActions: [Action.ExportTML]
1981
+ * ```
1982
+ */
1672
1983
  Action["ExportTML"] = "exportTSL";
1984
+ /**
1985
+ * The **Import TML** menu action for Liveboards and Answers.
1986
+ * Imports TML representation of ThoughtSpot objects.
1987
+ * @example
1988
+ * ```js
1989
+ * disabledActions: [Action.ImportTML]
1990
+ * ```
1991
+ */
1673
1992
  Action["ImportTML"] = "importTSL";
1993
+ /**
1994
+ * The **Update TML** menu action for Liveboards and Answers.
1995
+ * Update TML representation of ThoughtSpot objects.
1996
+ * @example
1997
+ * ```js
1998
+ * disabledActions: [Action.UpdateTML]
1999
+ * ```
2000
+ */
1674
2001
  Action["UpdateTML"] = "updateTSL";
2002
+ /**
2003
+ * The **Edit TML** menu action for Liveboards and Answers.
2004
+ * Opens the TML editor.
2005
+ * @example
2006
+ * ```js
2007
+ * disabledActions: [Action.EditTML]
2008
+ * ```
2009
+ */
1675
2010
  Action["EditTML"] = "editTSL";
2011
+ /**
2012
+ * The **Present** menu action for Liveboards and Answers.
2013
+ * Allows presenting a Liveboard or visualization in
2014
+ * slideshow mode.
2015
+ * @example
2016
+ * ```js
2017
+ * disabledActions: [Action.Present]
2018
+ * ```
2019
+ */
1676
2020
  Action["Present"] = "present";
2021
+ /**
2022
+ * The tile resize options in the visualization menu.
2023
+ * Allows switching between different preset layouts.
2024
+ * @example
2025
+ * ```js
2026
+ * disabledActions: [Action.ToggleSize]
2027
+ * ```
2028
+ */
1677
2029
  Action["ToggleSize"] = "toggleSize";
2030
+ /**
2031
+ * The *Edit* action on the Liveboard page and in the
2032
+ * visualization menu.
2033
+ * Opens a Liveboard or visualization in edit mode.
2034
+ * @example
2035
+ * ```js
2036
+ * disabledActions: [Action.Edit]
2037
+ * ```
2038
+ */
1678
2039
  Action["Edit"] = "edit";
2040
+ /**
2041
+ * The text edit option for Liveboard and visualization titles.
2042
+ * @example
2043
+ * ```js
2044
+ * disabledActions: [Action.EditTitle]
2045
+ * ```
2046
+ */
1679
2047
  Action["EditTitle"] = "editTitle";
2048
+ /**
2049
+ * The **Delete** menu action on Liveboards and visualizations.
2050
+ * Deletes a Liveboard or a visualization from a Liveboard.
2051
+ * @example
2052
+ * ```js
2053
+ * disabledActions: [Action.Remove]
2054
+ * ```
2055
+ */
1680
2056
  Action["Remove"] = "delete";
1681
2057
  /**
1682
2058
  * @hidden
@@ -1698,6 +2074,16 @@
1698
2074
  * @hidden
1699
2075
  */
1700
2076
  Action["PinboardInfo"] = "pinboardInfo";
2077
+ /**
2078
+ * The **Show Liveboard details** menu action on a Liveboard.
2079
+ * Displays details such as the name, description, and
2080
+ * author of the Liveboard, and timestamp of Liveboard creation
2081
+ * and update.
2082
+ * @example
2083
+ * ```js
2084
+ * disabledActions: [Action.LiveboardInfo]
2085
+ * ```
2086
+ */
1701
2087
  Action["LiveboardInfo"] = "pinboardInfo";
1702
2088
  /**
1703
2089
  * @hidden
@@ -1708,20 +2094,61 @@
1708
2094
  */
1709
2095
  Action["DownloadEmbraceQueries"] = "downloadEmbraceQueries";
1710
2096
  /**
1711
- * Pin action.
1712
- */
2097
+ * The **Pin** menu action on an Answer or
2098
+ * Search results page.
2099
+ * @example
2100
+ * ```js
2101
+ * disabledActions: [Action.Pin]
2102
+ * ```
2103
+ */
1713
2104
  Action["Pin"] = "pin";
1714
2105
  /**
1715
2106
  * @hidden
1716
2107
  */
1717
2108
  Action["AnalysisInfo"] = "analysisInfo";
1718
- Action["Subscription"] = "subscription";
1719
2109
  /**
1720
- * Explore action.
2110
+ * The **Schedule** menu action on a Liveboard.
2111
+ * @example
2112
+ * ```js
2113
+ * disabledActions: [Action.Subscription]
2114
+ * ```
1721
2115
  */
2116
+ Action["Subscription"] = "subscription";
2117
+ /**
2118
+ * The **Explore** action on Liveboard visualizations
2119
+ * @example
2120
+ * ```js
2121
+ * disabledActions: [Action.Explore]
2122
+ * ```
2123
+ */
1722
2124
  Action["Explore"] = "explore";
2125
+ /**
2126
+ * The action to include data points on a drilled-down Answer
2127
+ * or visualization
2128
+ * @example
2129
+ * ```js
2130
+ * disabledActions: [Action.DrillInclude]
2131
+ * ```
2132
+ */
1723
2133
  Action["DrillInclude"] = "context-menu-item-include";
2134
+ /**
2135
+ * The action to exclude data points on a drilled-down Answer
2136
+ * or visualization
2137
+ * @example
2138
+ * ```js
2139
+ * disabledActions: [Action.DrillInclude]
2140
+ * ```
2141
+ */
1724
2142
  Action["DrillExclude"] = "context-menu-item-exclude";
2143
+ /**
2144
+ * The **Copy to clipboard** menu action on tables in an Answer
2145
+ * or Liveboard.
2146
+ * Copies the selected data point.
2147
+ * @example
2148
+ * ```js
2149
+ * disabledActions: [Action.CopyToClipboard]
2150
+ * ```
2151
+ */
1725
2152
  Action["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
1726
2153
  Action["CopyAndEdit"] = "context-menu-item-copy-and-edit";
1727
2154
  /**
@@ -1730,89 +2157,266 @@
1730
2157
  Action["DrillEdit"] = "context-menu-item-edit";
1731
2158
  Action["EditMeasure"] = "context-menu-item-edit-measure";
1732
2159
  Action["Separator"] = "context-menu-item-separator";
2160
+ /**
2161
+ * The **Drill down** menu action on Answers and Liveboard
2162
+ * visualizations.
2163
+ * Allows drilling down to a specific data point on a chart or table.
2164
+ * @example
2165
+ * ```js
2166
+ * disabledActions: [Action.DrillDown]
2167
+ * ```
2168
+ */
1733
2169
  Action["DrillDown"] = "DRILL";
2170
+ /**
2171
+ * The request access action on Liveboards.
2172
+ * Allows users with view permissions to request edit access to a Liveboard.
2173
+ * @example
2174
+ * ```js
2175
+ * disabledActions: [Action.RequestAccess]
2176
+ * ```
2177
+ */
1734
2178
  Action["RequestAccess"] = "requestAccess";
1735
- Action["QueryDetailsButtons"] = "queryDetailsButtons";
1736
2179
  /**
1737
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2180
+ * The **Query visualizer** and **Query SQL** buttons in Query details panel
2181
+ * of the Answer page
2182
+ * @example
2183
+ * ```js
2184
+ * disabledActions: [Action.QueryDetailsButtons]
2185
+ * ```
2186
+ */
2187
+ Action["QueryDetailsButtons"] = "QueryDetailsButtons";
2188
+ /**
2189
+ * The **Delete** action for Answers.
2190
+ * @example
2191
+ * ```js
2192
+ * disabledActions: [Action.AnswerDelete]
2193
+ * ```
2194
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1738
2195
  */
1739
2196
  Action["AnswerDelete"] = "onDeleteAnswer";
1740
2197
  /**
1741
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2198
+ * The Chart switcher icon on Answer and visualization pages.
2199
+ * @example
2200
+ * ```js
2201
+ * disabledActions: [Action.AnswerChartSwitcher]
2202
+ * ```
2203
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1742
2204
  */
1743
2205
  Action["AnswerChartSwitcher"] = "answerChartSwitcher";
1744
2206
  /**
1745
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2207
+ * Favorites icon (*) on Answers, Liveboard, and Data pages
2208
+ * @example
2209
+ * ```js
2210
+ * disabledActions: [Action.AddToFavorites]
2211
+ * ```
2212
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1746
2213
  */
1747
2214
  Action["AddToFavorites"] = "addToFavorites";
1748
2215
  /**
1749
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2216
+ * The edit icon on Liveboards (Classic experience).
2217
+ * @example
2218
+ * ```js
2219
+ * disabledActions: [Action.EditDetails]
2220
+ * ```
2221
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1750
2222
  */
1751
2223
  Action["EditDetails"] = "editDetails";
1752
2224
  /**
1753
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2225
+ * The Create alert action on KPI charts.
2226
+ * @example
2227
+ * ```js
2228
+ * disabledActions: [Action.CreateMonitor ]
2229
+ * ```
2230
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1754
2231
  */
1755
2232
  Action["CreateMonitor"] = "createMonitor";
1756
2233
  /**
1757
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2234
+ * @example
2235
+ * ```js
2236
+ * disabledActions: [Action.ReportError]
2237
+ * ```
2238
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1758
2239
  */
1759
2240
  Action["ReportError"] = "reportError";
2241
+ /**
2242
+ * The **Sync to sheets** action on Answers and Liveboard visualizations.
2243
+ * Allows sending data to a Google Sheet.
2244
+ * @example
2245
+ * ```js
2246
+ * disabledActions: [Action.SyncToSheets]
2247
+ * ```
2248
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2249
+ */
1760
2250
  Action["SyncToSheets"] = "sync-to-sheets";
2251
+ /**
2252
+ * The **Sync to other apps** action on Answers and Liveboard visualizations.
2253
+ * Allows sending data to third-party apps like Slack, Salesforce,
2254
+ * Microsoft Teams, and so on.
2255
+ * @example
2256
+ * ```js
2257
+ * disabledActions: [Action.SyncToOtherApps]
2258
+ * ```
2259
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2260
+ */
1761
2261
  Action["SyncToOtherApps"] = "sync-to-other-apps";
2262
+ /**
2263
+ * The **Manage pipelines** action on Answers and Liveboard visualizations.
2264
+ * Allows users to manage data sync pipelines to third-party apps.
2265
+ * @example
2266
+ * ```js
2267
+ * disabledActions: [Action.SyncToOtherApps]
2268
+ * ```
2269
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2270
+ */
1762
2271
  Action["ManagePipelines"] = "manage-pipeline";
1763
2272
  /**
2273
+ * The **Filter** action on Liveboard visualizations.
2274
+ * Allows users to apply cross-filters on a Liveboard.
2275
+ * @example
2276
+ * ```js
2277
+ * disabledActions: [Action.CrossFilter]
2278
+ * ```
1764
2279
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1765
2280
  */
1766
2281
  Action["CrossFilter"] = "context-menu-item-cross-filter";
1767
2282
  /**
2283
+ * The **Remove** action that appears when cross filters are applied
2284
+ * on a Liveboard.
2285
+ * Removes filters applied o a visualization.
2286
+ * @example
2287
+ * ```js
2288
+ * disabledActions: [Action.RemoveCrossFilter]
2289
+ * ```
1768
2290
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1769
2291
  */
1770
2292
  Action["RemoveCrossFilter"] = "context-menu-item-remove-cross-filter";
1771
2293
  /**
2294
+ * The **Aggregate** option in the chart axis or the
2295
+ * table column customization menu.
2296
+ * Provides aggregation options to analyze the data on a chart or table.
2297
+ * @example
2298
+ * ```js
2299
+ * disabledActions: [Action.AxisMenuAggregate]
2300
+ * ```
1772
2301
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1773
2302
  */
1774
2303
  Action["AxisMenuAggregate"] = "axisMenuAggregate";
1775
2304
  /**
2305
+ * The **Time bucket** option in the chart axis or table column
2306
+ * customization menu.
2307
+ * Allows defining time metric for date comparison.
2308
+ * @example
2309
+ * ```js
2310
+ * disabledActions: [Action.AxisMenuTimeBucket]
2311
+ * ```
1776
2312
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1777
2313
  */
1778
2314
  Action["AxisMenuTimeBucket"] = "axisMenuTimeBucket";
1779
2315
  /**
2316
+ * The **Filter** action in the chart axis or table column
2317
+ * customization menu.
2318
+ * @example
2319
+ * ```js
2320
+ * disabledActions: [Action.AxisMenuFilter]
2321
+ * ```
1780
2322
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1781
2323
  */
1782
2324
  Action["AxisMenuFilter"] = "axisMenuFilter";
1783
2325
  /**
2326
+ * The **Conditional formatting** action on chart or table.
2327
+ * Allows adding rules for conditional formatting of data
2328
+ * points on a chart or table.
2329
+ * @example
2330
+ * ```js
2331
+ * disabledActions: [Action.AxisMenuConditionalFormat]
2332
+ * ```
1784
2333
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1785
2334
  */
1786
2335
  Action["AxisMenuConditionalFormat"] = "axisMenuConditionalFormat";
1787
2336
  /**
2337
+ * The **Sort** menu action on a table or chart axis
2338
+ * Sorts data in ascending or descending order.
2339
+ * Allows adding, editing, or removing filters.
2340
+ * @example
2341
+ * ```js
2342
+ * disabledActions: [Action.AxisMenuConditionalFormat]
2343
+ * ```
1788
2344
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1789
2345
  */
1790
2346
  Action["AxisMenuSort"] = "axisMenuSort";
1791
2347
  /**
2348
+ * The **Group** option in the chart axis or table column
2349
+ * customization menu.
2350
+ * Allows grouping data points if the axes use the same
2351
+ * unit of measurement and a similar scale.
2352
+ * @example
2353
+ * ```js
2354
+ * disabledActions: [Action.AxisMenuGroup]
2355
+ * ```
1792
2356
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1793
2357
  */
1794
2358
  Action["AxisMenuGroup"] = "axisMenuGroup";
1795
2359
  /**
2360
+ * The **Position** option in the axis customization menu.
2361
+ * Allows changing the position of the axis to the
2362
+ * left or right side of the chart.
2363
+ * @example
2364
+ * ```js
2365
+ * disabledActions: [Action.AxisMenuPosition]
2366
+ * ```
1796
2367
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1797
2368
  */
1798
2369
  Action["AxisMenuPosition"] = "axisMenuPosition";
1799
2370
  /**
2371
+ * The **Rename** option in the chart axis or table column customization menu.
2372
+ * Renames the axis label on a chart or the column header on a table.
2373
+ * @example
2374
+ * ```js
2375
+ * disabledActions: [Action.AxisMenuRename]
2376
+ * ```
1800
2377
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1801
2378
  */
1802
2379
  Action["AxisMenuRename"] = "axisMenuRename";
1803
2380
  /**
2381
+ * The **Edit** action in the axis customization menu.
2382
+ * Allows editing the axis name, position, minimum and maximum values,
2383
+ * and format of a column.
2384
+ * @example
2385
+ * ```js
2386
+ * disabledActions: [Action.AxisMenuEdit]
2387
+ * ```
1804
2388
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1805
2389
  */
1806
2390
  Action["AxisMenuEdit"] = "axisMenuEdit";
1807
2391
  /**
2392
+ * The **Number format** action to customize the format of
2393
+ * the data labels on a chart or table.
2394
+ * @example
2395
+ * ```js
2396
+ * disabledActions: [Action.AxisMenuNumberFormat]
2397
+ * ```
1808
2398
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1809
2399
  */
1810
2400
  Action["AxisMenuNumberFormat"] = "axisMenuNumberFormat";
1811
2401
  /**
2402
+ * The **Text wrapping** action on a table.
2403
+ * Wraps or clips column text on a table.
2404
+ * @example
2405
+ * ```js
2406
+ * disabledActions: [Action.AxisMenuTextWrapping]
2407
+ * ```
1812
2408
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1813
2409
  */
1814
2410
  Action["AxisMenuTextWrapping"] = "axisMenuTextWrapping";
1815
2411
  /**
2412
+ * The **Remove** action in the chart axis or table column
2413
+ * customization menu.
2414
+ * Removes the data labels from a chart or the column of a
2415
+ * table visualization.
2416
+ * @example
2417
+ * ```js
2418
+ * disabledActions: [Action.AxisMenuRemove]
2419
+ * ```
1816
2420
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1817
2421
  */
1818
2422
  Action["AxisMenuRemove"] = "axisMenuRemove";
@@ -1821,9 +2425,31 @@
1821
2425
  */
1822
2426
  Action["InsertInToSlide"] = "insertInToSlide";
1823
2427
  /**
2428
+ * The **Rename** menu action on Liveboards and visualizations.
2429
+ * Allows renaming a Liveboard or visualization.
2430
+ * @example
2431
+ * ```js
2432
+ * disabledActions: [Action.RenameModalTitleDescription]
2433
+ * ```
1824
2434
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1825
2435
  */
1826
2436
  Action["RenameModalTitleDescription"] = "renameModalTitleDescription";
2437
+ /**
2438
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2439
+ */
2440
+ Action["RequestVerification"] = "requestVerification";
2441
+ /**
2442
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2443
+ */
2444
+ Action["MarkAsVerified"] = "markAsVerified";
2445
+ /**
2446
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2447
+ */
2448
+ Action["AddTab"] = "addTab";
2449
+ /**
2450
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2451
+ */
2452
+ Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
1827
2453
  })(exports.Action || (exports.Action = {}));
1828
2454
  // eslint-disable-next-line no-shadow
1829
2455
  var OperationType;
@@ -26627,7 +27253,7 @@
26627
27253
  });
26628
27254
  }
26629
27255
 
26630
- 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};
27256
+ 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};
26631
27257
 
26632
27258
  /**
26633
27259
  * Copyright (c) 2022
@@ -26860,11 +27486,15 @@
26860
27486
  if (this.embedConfig.authType === AuthType.TrustedAuthTokenCookieless) {
26861
27487
  queryParams[Param.cookieless] = true;
26862
27488
  }
26863
- const { disabledActions, disabledActionReason, hiddenActions, visibleActions, showAlerts, additionalFlags, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, } = this.viewConfig;
27489
+ const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, hideLiveboardHeader, showLiveboardDescription, showLiveboardTitle, } = this.viewConfig;
26864
27490
  if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
26865
27491
  this.handleError('You cannot have both hidden actions and visible actions');
26866
27492
  return queryParams;
26867
27493
  }
27494
+ if (Array.isArray(visibleTabs) && Array.isArray(hiddenTabs)) {
27495
+ this.handleError('You cannot have both hidden Tabs and visible Tabs');
27496
+ return queryParams;
27497
+ }
26868
27498
  // TODO remove embedConfig.customCssUrl
26869
27499
  const cssUrlParam = ((_c = customizations === null || customizations === void 0 ? void 0 : customizations.style) === null || _c === void 0 ? void 0 : _c.customCSSUrl) || this.embedConfig.customCssUrl;
26870
27500
  if (cssUrlParam) {
@@ -26880,6 +27510,12 @@
26880
27510
  if (Array.isArray(visibleActions)) {
26881
27511
  queryParams[Param.VisibleActions] = visibleActions;
26882
27512
  }
27513
+ if (Array.isArray(hiddenTabs)) {
27514
+ queryParams[Param.HiddenTabs] = hiddenTabs;
27515
+ }
27516
+ if (Array.isArray(visibleTabs)) {
27517
+ queryParams[Param.VisibleTabs] = visibleTabs;
27518
+ }
26883
27519
  /**
26884
27520
  * Default behavior for context menu will be left-click
26885
27521
  * from version 9.2.0.cl the user have an option to override context
@@ -26911,6 +27547,15 @@
26911
27547
  if (insertInToSlide) {
26912
27548
  queryParams[Param.ShowInsertToSlide] = insertInToSlide;
26913
27549
  }
27550
+ if (hideLiveboardHeader) {
27551
+ queryParams[Param.HideLiveboardHeader] = hideLiveboardHeader;
27552
+ }
27553
+ if (showLiveboardDescription) {
27554
+ queryParams[Param.ShowLiveboardDescription] = showLiveboardDescription;
27555
+ }
27556
+ if (showLiveboardTitle) {
27557
+ queryParams[Param.ShowLiveboardTitle] = showLiveboardTitle;
27558
+ }
26914
27559
  return queryParams;
26915
27560
  }
26916
27561
  /**
@@ -27425,6 +28070,7 @@
27425
28070
  /**
27426
28071
  * Embed ThoughtSpot LLM and GPT based natural language search component.
27427
28072
  *
28073
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
27428
28074
  * @group Embed components
27429
28075
  */
27430
28076
  class SageEmbed extends V1Embed {
@@ -27856,7 +28502,7 @@
27856
28502
  let params = {};
27857
28503
  params[Param.EmbedApp] = true;
27858
28504
  params = this.getBaseQueryParams(params);
27859
- const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, activeTabId, } = this.viewConfig;
28505
+ const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, hideTabPanel, activeTabId, } = this.viewConfig;
27860
28506
  const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
27861
28507
  || this.viewConfig.preventPinboardFilterRemoval;
27862
28508
  if (fullHeight === true) {
@@ -27881,6 +28527,9 @@
27881
28527
  if (liveboardV2 !== undefined) {
27882
28528
  params[Param.LiveboardV2Enabled] = liveboardV2;
27883
28529
  }
28530
+ if (hideTabPanel) {
28531
+ params[Param.HideTabPanel] = hideTabPanel;
28532
+ }
27884
28533
  const queryParams = getQueryParamString(params, true);
27885
28534
  return queryParams;
27886
28535
  }