@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
@@ -502,7 +502,7 @@ var AuthType;
502
502
  * .then((data) => data.token);
503
503
  * }
504
504
  * ```
505
- * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
505
+ * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
506
506
  */
507
507
  AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
508
508
  /**
@@ -652,7 +652,7 @@ var EmbedEvent;
652
652
  * One or more data columns have been selected.
653
653
  *
654
654
  * @returns columnIds - the list of columns
655
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
655
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
656
656
  */
657
657
  EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
658
658
  /**
@@ -685,7 +685,7 @@ var EmbedEvent;
685
685
  * });
686
686
  * ```
687
687
  * @return viz, clickedPoint - metadata about point that is clicked
688
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
688
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
689
689
  * @important
690
690
  */
691
691
  EmbedEvent["VizPointClick"] = "vizPointClick";
@@ -735,7 +735,7 @@ var EmbedEvent;
735
735
  * Emitted when the "Get Data" button in Search Bar embed
736
736
  * is clicked.
737
737
  *
738
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
738
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
739
739
  */
740
740
  EmbedEvent["GetDataClick"] = "getDataClick";
741
741
  /**
@@ -765,13 +765,13 @@ var EmbedEvent;
765
765
  /**
766
766
  * Emitted when any modal is opened in the app
767
767
  *
768
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
768
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
769
769
  */
770
770
  EmbedEvent["DialogOpen"] = "dialog-open";
771
771
  /**
772
772
  * Emitted when any modal is closed in the app
773
773
  *
774
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
774
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
775
775
  */
776
776
  EmbedEvent["DialogClose"] = "dialog-close";
777
777
  /**
@@ -779,136 +779,136 @@ var EmbedEvent;
779
779
  * You can use this event as a hook to trigger
780
780
  * other events on the rendered Liveboard.
781
781
  *
782
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
782
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
783
783
  */
784
784
  EmbedEvent["LiveboardRendered"] = "PinboardRendered";
785
785
  /**
786
786
  * This can be used to register an event listener which
787
787
  * is triggered on all events.
788
788
  *
789
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
789
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
790
790
  */
791
791
  EmbedEvent["ALL"] = "*";
792
792
  /**
793
- * Emitted when answer is saved in the app
793
+ * Emitted when an Answer is saved in the app
794
794
  *
795
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
795
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
796
796
  */
797
797
  EmbedEvent["Save"] = "save";
798
798
  /**
799
799
  * Emitted when the download action is triggered on an answer
800
800
  *
801
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
801
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
802
802
  */
803
803
  EmbedEvent["Download"] = "download";
804
804
  /**
805
805
  * Emitted when the download action is triggered on an answer
806
806
  *
807
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
807
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
808
808
  */
809
809
  EmbedEvent["DownloadAsPng"] = "downloadAsPng";
810
810
  /**
811
811
  * Emitted when the Download as PDF action is triggered on an answer
812
812
  *
813
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
813
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
814
814
  */
815
815
  EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
816
816
  /**
817
817
  * Emitted when the Download as CSV action is triggered on an answer
818
818
  *
819
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
819
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
820
820
  */
821
821
  EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
822
822
  /**
823
823
  * Emitted when the Download as XLSX action is triggered on an answer
824
824
  *
825
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
825
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
826
826
  */
827
827
  EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
828
828
  /**
829
829
  * Emitted when an answer is deleted in the app
830
830
  *
831
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
831
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
832
832
  */
833
833
  EmbedEvent["AnswerDelete"] = "answerDelete";
834
834
  /**
835
835
  * Emitted when an answer is pinned to a Liveboard
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["Pin"] = "pin";
840
840
  /**
841
841
  * Emitted when SpotIQ analysis is triggered
842
842
  *
843
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
843
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
844
844
  */
845
845
  EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
846
846
  /**
847
847
  * Emitted when a user shares an object with another user or group
848
848
  *
849
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
849
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
850
850
  */
851
851
  EmbedEvent["Share"] = "share";
852
852
  /**
853
853
  * Emitted when a user clicks the Include action to include a specific value or data
854
854
  * on a chart or table
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["DrillInclude"] = "context-menu-item-include";
859
859
  /**
860
860
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
861
861
  * on a chart or table
862
862
  *
863
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
863
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
864
864
  */
865
865
  EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
866
866
  /**
867
867
  * Emitted when copied column value on the app
868
868
  *
869
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
869
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
870
870
  */
871
871
  EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
872
872
  /**
873
873
  * Emitted when a user clicks the Update TML action
874
874
  *
875
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
875
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
876
876
  */
877
877
  EmbedEvent["UpdateTML"] = "updateTSL";
878
878
  /**
879
879
  * Emitted when a user clicks the Edit TML action
880
880
  *
881
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
881
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
882
882
  */
883
883
  EmbedEvent["EditTML"] = "editTSL";
884
884
  /**
885
885
  * Emitted when ExportTML trigger in answer on the app
886
886
  *
887
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
887
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
888
888
  */
889
889
  EmbedEvent["ExportTML"] = "exportTSL";
890
890
  /**
891
891
  * Emitted when an answer is saved as a view
892
892
  *
893
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
893
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
894
894
  */
895
895
  EmbedEvent["SaveAsView"] = "saveAsView";
896
896
  /**
897
897
  * Emitted when copy of existing answer on the app
898
898
  *
899
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
899
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
900
900
  */
901
901
  EmbedEvent["CopyAEdit"] = "copyAEdit";
902
902
  /**
903
903
  * Emitted when a user clicks Show underlying data on an answe
904
904
  *
905
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
905
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
906
906
  */
907
907
  EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
908
908
  /**
909
909
  * Emitted when an answer is switched to a chart or table view
910
910
  *
911
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
911
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
912
912
  */
913
913
  EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
914
914
  /**
@@ -920,67 +920,67 @@ var EmbedEvent;
920
920
  /**
921
921
  * Emitted when a user clicks Show Liveboard details on a Liveboard
922
922
  *
923
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
923
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
924
924
  */
925
925
  EmbedEvent["LiveboardInfo"] = "pinboardInfo";
926
926
  /**
927
927
  * Emitted when a user clicks on the Favorite icon on a Liveboard
928
928
  *
929
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
929
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
930
930
  */
931
931
  EmbedEvent["AddToFavorites"] = "addToFavorites";
932
932
  /**
933
933
  * Emitted when a user clicks Schedule on a Liveboard
934
934
  *
935
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
935
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
936
936
  */
937
937
  EmbedEvent["Schedule"] = "subscription";
938
938
  /**
939
939
  * Emitted when a user clicks Edit on a Liveboard or visualization
940
940
  *
941
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
941
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
942
942
  */
943
943
  EmbedEvent["Edit"] = "edit";
944
944
  /**
945
945
  * Emitted when a user clicks Make a copy on a Liveboard
946
946
  *
947
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
947
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
948
948
  */
949
949
  EmbedEvent["MakeACopy"] = "makeACopy";
950
950
  /**
951
951
  * Emitted when a user clicks Present on a Liveboard or visualization
952
952
  *
953
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
953
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
954
954
  */
955
955
  EmbedEvent["Present"] = "present";
956
956
  /**
957
957
  * Emitted when a user clicks Delete on a Liveboard
958
958
  *
959
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
959
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
960
960
  */
961
961
  EmbedEvent["Delete"] = "delete";
962
962
  /**
963
963
  * Emitted when a user clicks Manage schedules on a Liveboard
964
964
  *
965
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
965
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
966
966
  */
967
967
  EmbedEvent["SchedulesList"] = "schedule-list";
968
968
  /**
969
969
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
970
970
  *
971
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
971
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
972
972
  */
973
973
  EmbedEvent["Cancel"] = "cancel";
974
974
  /**
975
975
  * Emitted when a user clicks Explore on a visualization
976
976
  *
977
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
977
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
978
978
  */
979
979
  EmbedEvent["Explore"] = "explore";
980
980
  /**
981
981
  * Emitted when a user clicks Copy link action on a visualization
982
982
  *
983
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
983
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
984
984
  */
985
985
  EmbedEvent["CopyLink"] = "embedDocument";
986
986
  /**
@@ -1001,6 +1001,12 @@ var EmbedEvent;
1001
1001
  * @hidden
1002
1002
  */
1003
1003
  EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
1004
+ /**
1005
+ * Emitted when a user changes any filter on a Liveboard.
1006
+ *
1007
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1008
+ */
1009
+ EmbedEvent["FilterChanged"] = "filterChanged";
1004
1010
  })(EmbedEvent || (EmbedEvent = {}));
1005
1011
  /**
1006
1012
  * Event types that can be triggered by the host application
@@ -1028,13 +1034,14 @@ var EmbedEvent;
1028
1034
  var HostEvent;
1029
1035
  (function (HostEvent) {
1030
1036
  /**
1031
- * Trigger a search
1032
- *
1037
+ * Triggers a search query in AppEmbed and SearchEmbed
1038
+ * deployments.
1039
+ * Includes the following properties:
1033
1040
  * @param - dataSourceIds - The data source GUID to Search on
1034
1041
  * - Although an array, only a single source
1035
- * is supported at this time.
1036
- * @param - searchQuery - The search query
1037
- * @param - execute - execute the existing / updated query
1042
+ * is supported.
1043
+ * @param - searchQuery - Query string with search tokens
1044
+ * @param - execute - executes the existing / updated query
1038
1045
  * @example
1039
1046
  * ```js
1040
1047
  * searchEmbed.trigger(HostEvent.Search, {
@@ -1046,13 +1053,13 @@ var HostEvent;
1046
1053
  */
1047
1054
  HostEvent["Search"] = "search";
1048
1055
  /**
1049
- * Trigger a drill on certain points by certain column
1050
- *
1056
+ * Triggers a drill on certain points of the specified column
1057
+ * Includes the following properties:
1051
1058
  * @param - points - an object containing selectedPoints/clickedPoints
1052
- * eg. { selectedPoints: []}
1053
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
1054
- * if not provided it will auto drill by the configured
1055
- * column.
1059
+ * to drill to. For example, { selectedPoints: []}
1060
+ * @param - columnGuid - Optional. GUID of the column to drill
1061
+ * by. If not provided it will auto drill by the configured
1062
+ * column.
1056
1063
  * @example
1057
1064
  * ```js
1058
1065
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -1085,17 +1092,17 @@ var HostEvent;
1085
1092
  */
1086
1093
  HostEvent["Reload"] = "reload";
1087
1094
  /**
1088
- * Set the visible visualizations on a Liveboard.
1095
+ * Sets the visible visualizations on a Liveboard.
1089
1096
  *
1090
- * @param - an array of ids of visualizations to show, the ids not passed
1091
- * will be hidden.
1097
+ * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
1098
+ * in this parameter will be hidden.
1092
1099
  * @example
1093
1100
  * ```js
1094
1101
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
1095
1102
  * '730496d6-6903-4601-937e-2c691821af3c',
1096
1103
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
1097
1104
  * ```
1098
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
1105
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
1099
1106
  */
1100
1107
  HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
1101
1108
  /**
@@ -1112,9 +1119,18 @@ var HostEvent;
1112
1119
  */
1113
1120
  HostEvent["SetActiveTab"] = "SetActiveTab";
1114
1121
  /**
1115
- * Update the runtime filters. The runtime filters passed here are extended
1116
- * on to the existing runtime filters if they exist.
1117
- *
1122
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
1123
+ * runtime filters passed here are appended to the existing runtime
1124
+ * filters.
1125
+ * Pass an array of runtime filters with the following attributes:
1126
+ * `columnName`
1127
+ * _String_. The name of the column to filter on.
1128
+ * `operator`
1129
+ * Runtime filter operator to apply. For information,
1130
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
1131
+ * `values`
1132
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
1133
+ * such as BW and IN accept multiple operands.
1118
1134
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
1119
1135
  * @example
1120
1136
  * ```js
@@ -1123,25 +1139,24 @@ var HostEvent;
1123
1139
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
1124
1140
  * ])
1125
1141
  * ```
1126
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1142
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1127
1143
  * @important
1128
1144
  */
1129
1145
  HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
1130
1146
  /**
1131
- * Navigate to a specific page in App embed without any reload.
1147
+ * Navigate to a specific page in the embedded application without reloading the page.
1132
1148
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
1133
- *
1134
1149
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
1135
1150
  * @example
1136
1151
  * ```js
1137
1152
  * appEmbed.navigateToPage(-1)
1138
1153
  * ```
1139
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
1154
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
1140
1155
  */
1141
1156
  HostEvent["Navigate"] = "Navigate";
1142
1157
  /**
1143
1158
  * Opens the filter panel for a particular column.
1144
- * Works with Search embed.
1159
+ * Works with Search and Liveboard embed.
1145
1160
  *
1146
1161
  * @param - { columnId: string,
1147
1162
  * name: string,
@@ -1150,233 +1165,257 @@ var HostEvent;
1150
1165
  * @example
1151
1166
  * ```js
1152
1167
  * searchEmbed.trigger(HostEvent.OpenFilter,
1153
- * { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
1168
+ * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
1169
+ * LiveboardEmbed.trigger(HostEvent.OpenFilter,
1170
+ * { columnId: '<column-GUID>'})
1154
1171
  * ```
1155
1172
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1156
1173
  */
1157
1174
  HostEvent["OpenFilter"] = "openFilter";
1158
1175
  /**
1159
- * Adds the columns to the current Search.
1176
+ * Adds columns to the current search query.
1160
1177
  *
1161
1178
  * @param - { columnIds: string[] }
1162
1179
  * @example
1163
1180
  * ```js
1164
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
1181
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
1165
1182
  * ```
1166
1183
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1167
1184
  */
1168
1185
  HostEvent["AddColumns"] = "addColumns";
1169
1186
  /**
1170
- * Removes a column from the current Search.
1187
+ * Removes a column from the current search query.
1171
1188
  *
1172
1189
  * @param - { columnId: string }
1173
1190
  * @example
1174
1191
  * ```js
1175
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
1192
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
1176
1193
  * ```
1177
1194
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1178
1195
  */
1179
1196
  HostEvent["RemoveColumn"] = "removeColumn";
1180
1197
  /**
1181
- * Gets the current pinboard content.
1198
+ * Gets the current Liveboard content.
1182
1199
  *
1183
1200
  * @example
1184
1201
  * ```js
1185
1202
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
1186
1203
  * ```
1187
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
1204
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
1188
1205
  */
1189
1206
  HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
1190
1207
  /**
1191
- * Triggers the Pin action on an embedded object
1208
+ * Triggers the **Pin** action on an embedded object
1192
1209
  *
1193
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1194
- * can be left empty for search and visualization embeds
1210
+ * @param - Liveboard embed takes the `vizId` as a
1211
+ * key. Can be left undefined when embedding Search, full app or
1212
+ * a visualization.
1195
1213
  * @example
1196
1214
  * ```js
1197
1215
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1216
+ * ```
1217
+ * ```js
1198
1218
  * vizEmbed.trigger(HostEvent.Pin)
1219
+ * ```
1220
+ * ```js
1199
1221
  * searchEmbed.trigger(HostEvent.Pin)
1200
1222
  * ```
1201
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1223
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1202
1224
  */
1203
1225
  HostEvent["Pin"] = "pin";
1204
1226
  /**
1205
- * Triggers the Show Liveboard details action on a Liveboard
1227
+ * Triggers the **Show Liveboard details** action on a Liveboard
1206
1228
  *
1207
1229
  * @example
1208
1230
  * ```js
1209
1231
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
1210
1232
  * ```
1211
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1233
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1212
1234
  */
1213
1235
  HostEvent["LiveboardInfo"] = "pinboardInfo";
1214
1236
  /**
1215
- * Triggers the Schedule action on a Liveboard
1237
+ * Triggers the **Schedule** action on a Liveboard
1216
1238
  *
1217
1239
  * @example
1218
1240
  * ```js
1219
1241
  * liveboardEmbed.trigger(HostEvent.Schedule)
1220
1242
  * ```
1221
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1243
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1222
1244
  */
1223
1245
  HostEvent["Schedule"] = "subscription";
1224
1246
  /**
1225
- * Triggers the Manage schedule action on a Liveboard
1247
+ * Triggers the **Manage schedule** action on a Liveboard
1226
1248
  *
1227
1249
  * @example
1228
1250
  * ```js
1229
1251
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
1230
1252
  * ```
1231
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1253
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1232
1254
  */
1233
1255
  HostEvent["SchedulesList"] = "schedule-list";
1234
1256
  /**
1235
- * Triggers the Export TML action on a Liveboard
1257
+ * Triggers the **Export TML** action on a Liveboard
1236
1258
  *
1237
1259
  * @example
1238
1260
  * ```js
1239
1261
  * liveboardEmbed.trigger(HostEvent.ExportTML)
1240
1262
  * ```
1241
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1263
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1242
1264
  */
1243
1265
  HostEvent["ExportTML"] = "exportTSL";
1244
1266
  /**
1245
- * Triggers the Edit TML action on a Liveboard
1267
+ * Triggers the **Edit TML** action on a Liveboard
1246
1268
  *
1247
1269
  * @example
1248
1270
  * ```js
1249
1271
  * liveboardEmbed.trigger(HostEvent.EditTML)
1250
1272
  * ```
1251
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1273
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1252
1274
  */
1253
1275
  HostEvent["EditTML"] = "editTSL";
1254
1276
  /**
1255
- * Triggers the Update TML action on a Liveboard
1277
+ * Triggers the **Update TML** action on a Liveboard
1256
1278
  *
1257
1279
  * @example
1258
1280
  * ```js
1259
1281
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
1260
1282
  * ```
1261
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1283
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1262
1284
  */
1263
1285
  HostEvent["UpdateTML"] = "updateTSL";
1264
1286
  /**
1265
- * Triggers the Download PDF action on a Liveboard
1287
+ * Triggers the **Download PDF** action on a Liveboard
1266
1288
  *
1267
1289
  * @example
1268
1290
  * ```js
1269
1291
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
1270
1292
  * ```
1271
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1293
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1272
1294
  */
1273
1295
  HostEvent["DownloadAsPdf"] = "downloadAsPdf";
1274
1296
  /**
1275
- * Triggers the Make a copy action on a Liveboard, search or visualization
1297
+ * Triggers the **Make a copy** action on a Liveboard, Search, or
1298
+ * visualization page
1276
1299
  *
1277
1300
  * @example
1278
1301
  * ```js
1279
1302
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1303
+ * ```
1304
+ * ```js
1280
1305
  * vizEmbed.trigger(HostEvent.MakeACopy)
1306
+ * ```
1307
+ * ```js
1281
1308
  * searchEmbed.trigger(HostEvent.MakeACopy)
1282
1309
  * ```
1283
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1310
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1284
1311
  */
1285
1312
  HostEvent["MakeACopy"] = "makeACopy";
1286
1313
  /**
1287
- * Triggers the Delete action on a Liveboard
1314
+ * Triggers the **Delete** action on a Liveboard
1288
1315
  *
1289
1316
  * @example
1290
1317
  * ```js
1291
1318
  * appEmbed.trigger(HostEvent.Remove)
1292
1319
  * ```
1293
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1320
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1294
1321
  */
1295
1322
  HostEvent["Remove"] = "delete";
1296
1323
  /**
1297
- * Triggers the Explore action on a visualization
1324
+ * Triggers the **Explore* action on a visualization
1298
1325
  *
1299
- * @param - an object with vizId as a key
1326
+ * @param - an object with `vizId` as a key
1300
1327
  * @example
1301
1328
  * ```js
1302
1329
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1303
1330
  * ```
1304
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1331
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1305
1332
  */
1306
1333
  HostEvent["Explore"] = "explore";
1307
1334
  /**
1308
- * Triggers the Create alert action on a visualization
1335
+ * Triggers the **Create alert** action on a visualization
1309
1336
  *
1310
- * @param - an object with vizId as a key
1337
+ * @param - an object with `vizId` as a key
1311
1338
  * @example
1312
1339
  * ```js
1313
1340
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
1314
1341
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1315
1342
  * })
1316
1343
  * ```
1317
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1344
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1318
1345
  */
1319
1346
  HostEvent["CreateMonitor"] = "createMonitor";
1320
1347
  /**
1321
- * Triggers the Manage alert action on a visualization
1348
+ * Triggers the **Manage alerts** action on a visualization
1322
1349
  *
1323
- * @param - an object with vizId as a key
1350
+ * @param - an object with `vizId` as a key
1324
1351
  * @example
1325
1352
  * ```js
1326
1353
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
1327
1354
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
1328
1355
  * })
1329
1356
  * ```
1330
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1357
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1331
1358
  */
1332
1359
  HostEvent["ManageMonitor"] = "manageMonitor";
1333
1360
  /**
1334
- * Triggers the Edit action on a Liveboard or visualization
1361
+ * Triggers the **Edit** action on a Liveboard or visualization
1335
1362
  *
1336
- * @param - object - to trigger the action for a specfic visualization
1337
- * in Liveboard embed, pass in vizId as a key
1363
+ * @param - object - To trigger the action for a specific visualization
1364
+ * in Liveboard embed, pass in `vizId` as a key.
1365
+ * Can be left undefined when embedding Search, full app, or
1366
+ * a visualization.
1338
1367
  * @example
1339
1368
  * ```js
1340
1369
  * liveboardEmbed.trigger(HostEvent.Edit)
1341
- *
1370
+ * ```
1371
+ * ```js
1342
1372
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
1343
1373
  * '730496d6-6903-4601-937e-2c691821af3c'})
1344
- *
1374
+ * ```
1375
+ * ```js
1345
1376
  * vizEmbed.trigger((HostEvent.Edit)
1346
1377
  * ```
1347
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1378
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1348
1379
  */
1349
1380
  HostEvent["Edit"] = "edit";
1350
1381
  /**
1351
- * Triggers the Copy link action on a Liveboard or visualization
1382
+ * Triggers the **Copy link** action on a Liveboard or visualization
1352
1383
  *
1353
- * @param - object - to trigger the action for a s
1354
- * pecfic visualization in Liveboard embed, pass in vizId as a key
1384
+ * @param - object - to trigger the action for a
1385
+ * specific visualization in Liveboard embed, pass in `vizId` as a key
1355
1386
  * @example
1356
1387
  * ```js
1357
1388
  * liveboardEmbed.trigger(HostEvent.CopyLink)
1389
+ * ```
1390
+ * ```js
1358
1391
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1392
+ * ```
1393
+ * ```js
1359
1394
  * vizEmbed.trigger((HostEvent.CopyLink)
1360
1395
  * ```
1361
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1396
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1362
1397
  */
1363
1398
  HostEvent["CopyLink"] = "embedDocument";
1364
1399
  /**
1365
- * Triggers the Present action on a Liveboard or visualization
1400
+ * Triggers the **Present** action on a Liveboard or visualization
1366
1401
  *
1367
- * @param - object - to trigger the action for a specfic visualization
1368
- * in Liveboard embed, pass in vizId as a key
1402
+ * @param - object - to trigger the action for a specific visualization
1403
+ * in Liveboard embed, pass in `vizId` as a key
1369
1404
  * @example
1370
1405
  * ```js
1371
1406
  * liveboardEmbed.trigger(HostEvent.Present)
1407
+ * ```
1408
+ * ```js
1372
1409
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1410
+ * ```
1411
+ * ```js
1373
1412
  * vizEmbed.trigger((HostEvent.Present)
1374
1413
  * ```
1375
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1414
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1376
1415
  */
1377
1416
  HostEvent["Present"] = "present";
1378
1417
  /**
1379
- * Get TML for the current search.
1418
+ * Gets TML for the current search.
1380
1419
  *
1381
1420
  * @example
1382
1421
  * ```js
@@ -1386,79 +1425,89 @@ var HostEvent;
1386
1425
  * );
1387
1426
  * })
1388
1427
  * ```
1389
- * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
1428
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
1390
1429
  * @important
1391
1430
  */
1392
1431
  HostEvent["GetTML"] = "getTML";
1393
1432
  /**
1394
- * Triggers the ShowUnderlyingData action on visualization or search
1433
+ * Triggers the **Show underlying data** action on visualization or search
1395
1434
  *
1396
1435
  * @param - an object with vizId as a key
1397
1436
  * @example
1398
1437
  * ```js
1399
1438
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
1400
1439
  * '730496d6-6903-4601-937e-2c691821af3c'})
1401
- *
1440
+ * ```
1441
+ * ```js
1402
1442
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
1403
- *
1443
+ * ```
1444
+ * ```js
1404
1445
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
1405
1446
  * ```
1406
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1447
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1407
1448
  */
1408
1449
  HostEvent["ShowUnderlyingData"] = "showUnderlyingData";
1409
1450
  /**
1410
- * Triggers the Delete action on visualization or search
1451
+ * Triggers the **Delete** action on visualization or search
1411
1452
  *
1412
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1413
- * can be left empty for search and visualization embeds
1453
+ * @param - Liveboard embed takes an object with `vizId` as a key.
1454
+ * Can be left empty if embedding Search or visualization.
1414
1455
  * @example
1415
1456
  * ```js
1416
1457
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
1417
1458
  * '730496d6-6903-4601-937e-2c691821af3c'})
1418
- *
1459
+ * ```
1460
+ * ```js
1419
1461
  * vizEmbed.trigger(HostEvent.Delete)
1420
- *
1462
+ * ```
1463
+ * ```js
1421
1464
  * searchEmbed.trigger(HostEvent.Delete)
1422
1465
  * ```
1423
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1466
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1424
1467
  */
1425
1468
  HostEvent["Delete"] = "onDeleteAnswer";
1426
1469
  /**
1427
- * Triggers the SpotIQAnalyze action on visualization or search
1428
- *
1429
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1430
- * can be left empty for search and visualization embeds
1470
+ * Triggers the **SpotIQ analyze** action on visualization
1471
+ * or search.
1472
+ * @param - Liveboard embed takes `vizId` as a
1473
+ * key. Can be left undefined when embedding Search or
1474
+ * visualization.
1431
1475
  * @example
1432
1476
  * ```js
1433
1477
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
1434
1478
  * '730496d6-6903-4601-937e-2c691821af3c'})
1435
- *
1479
+ * ```
1480
+ * ```js
1436
1481
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
1437
- *
1482
+ * ```
1483
+ * ```js
1438
1484
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
1439
1485
  * ```
1440
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1486
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1441
1487
  */
1442
1488
  HostEvent["SpotIQAnalyze"] = "spotIQAnalyze";
1443
1489
  /**
1444
- * Triggers the Download action on visualization or search when Displaymode is Chart
1490
+ * Triggers the **Download** action on charts in
1491
+ * the embedded view.
1445
1492
  *
1446
1493
  * @example
1447
1494
  * ```js
1448
1495
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
1449
1496
  * '730496d6-6903-4601-937e-2c691821af3c'})
1450
- *
1497
+ * ```
1498
+ * ```js
1451
1499
  * vizEmbed.trigger(HostEvent.Download)
1452
- *
1500
+ * ```
1501
+ * ```js
1453
1502
  * searchEmbed.trigger(HostEvent.Download)
1454
1503
  * ```
1455
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
1456
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1504
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
1505
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1457
1506
  */
1458
1507
  HostEvent["Download"] = "downloadAsPng";
1459
1508
  /**
1460
- * Triggers the Download action on visualization or search when Displaymode is Chart
1461
- *
1509
+ * Triggers the **Download** > **PNG** action on
1510
+ * charts in the embedded view.
1462
1511
  * @example
1463
1512
  * ```js
1464
1513
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1468,115 +1517,192 @@ var HostEvent;
1468
1517
  *
1469
1518
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
1470
1519
  * ```
1471
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
1520
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
1472
1521
  */
1473
1522
  HostEvent["DownloadAsPng"] = "downloadAsPng";
1474
1523
  /**
1475
- * Triggers the downloadAsCSV action on visualization or search
1524
+ * Triggers the **Download** > **CSV** action on tables in
1525
+ * the embedded view.
1476
1526
  *
1477
1527
  * @example
1478
1528
  * ```js
1479
1529
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
1480
1530
  * '730496d6-6903-4601-937e-2c691821af3c'})
1481
- *
1531
+ * ```
1532
+ * ```js
1482
1533
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
1483
- *
1534
+ * ```
1535
+ * ```js
1484
1536
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
1485
1537
  * ```
1486
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1538
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1487
1539
  */
1488
1540
  HostEvent["DownloadAsCsv"] = "downloadAsCSV";
1489
1541
  /**
1490
- * Triggers the downloadAsXLSX action on visualization or search
1491
- *
1542
+ * Triggers the **Download** > **XLSX** action on tables
1543
+ * in the embedded view.
1492
1544
  * @example
1493
1545
  * ```js
1494
1546
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
1495
1547
  * '730496d6-6903-4601-937e-2c691821af3c'})
1496
- *
1548
+ * ```
1549
+ * ```js
1497
1550
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
1498
- *
1551
+ * ```
1552
+ * ```js
1499
1553
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
1500
1554
  * ```
1501
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1555
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1502
1556
  */
1503
1557
  HostEvent["DownloadAsXlsx"] = "downloadAsXLSX";
1504
1558
  /**
1505
- * Triggers the Share action on a liveboard or answer
1559
+ * Triggers the **Share** action on an embedded
1560
+ * Liveboard or Answer.
1506
1561
  *
1507
1562
  * @example
1508
1563
  * ```js
1509
1564
  * liveboardEmbed.trigger(HostEvent.Share)
1510
- *
1565
+ * ```
1566
+ * ```js
1511
1567
  * searchEmbed.trigger(HostEvent.Share)
1512
1568
  * ```
1513
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1569
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1514
1570
  */
1515
1571
  HostEvent["Share"] = "share";
1516
1572
  /**
1517
- * Trigger the Save action on a liveboard or answer
1518
- *
1573
+ * Triggers the **Save** action on a Liveboard or Answer.
1574
+ * Saves the changes.
1519
1575
  * @example
1520
1576
  * ```js
1521
1577
  * liveboardEmbed.trigger(HostEvent.Save)
1522
- *
1578
+ * ```
1579
+ * ```js
1523
1580
  * searchEmbed.trigger(HostEvent.Save)
1524
1581
  * ```
1525
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1582
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1526
1583
  */
1527
1584
  HostEvent["Save"] = "save";
1528
1585
  /**
1529
- * Triggers the SyncToSheets action on visualization
1530
- *
1531
- * @param - an object with vizId as a key
1586
+ * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
1587
+ * Sends data from an Answer or Liveboard visualization to a Google sheet.
1588
+ * @param - an object with `vizId` as a key
1532
1589
  * @example
1533
1590
  * ```js
1534
1591
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
1535
1592
  * '730496d6-6903-4601-937e-2c691821af3c'})
1536
- *
1593
+ * ```
1594
+ * ```js
1537
1595
  * vizEmbed.trigger(HostEvent.SyncToSheets)
1538
1596
  * ```
1539
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1597
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1540
1598
  */
1541
1599
  HostEvent["SyncToSheets"] = "sync-to-sheets";
1542
1600
  /**
1543
- * Triggers the SyncToOtherApps action on visualization
1544
- *
1601
+ * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
1602
+ * Sends data from an Answer or Liveboard visualization to third-party apps such
1603
+ * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
1545
1604
  * @param - an object with vizId as a key
1546
1605
  * @example
1547
1606
  * ```js
1548
1607
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
1549
1608
  * '730496d6-6903-4601-937e-2c691821af3c'})
1550
- *
1609
+ * ```
1610
+ * ```js
1551
1611
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
1552
1612
  * ```
1553
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1613
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1554
1614
  */
1555
1615
  HostEvent["SyncToOtherApps"] = "sync-to-other-apps";
1556
1616
  /**
1557
- * Triggers the ManagePipelines action on visualization
1558
- *
1559
- * @param - an object with vizId as a key
1617
+ * Triggers the **Manage pipelines** action on an embedded
1618
+ * visualization or Answer.
1619
+ * Allows users to manage ThoughtSpot Sync pipelines.
1620
+ * @param - an object with `vizId` as a key
1560
1621
  * @example
1561
1622
  * ```js
1562
1623
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
1563
1624
  * '730496d6-6903-4601-937e-2c691821af3c'})
1564
- *
1625
+ * ```
1626
+ * ```js
1565
1627
  * vizEmbed.trigger(HostEvent.ManagePipelines)
1566
1628
  * ```
1567
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1629
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1568
1630
  */
1569
1631
  HostEvent["ManagePipelines"] = "manage-pipeline";
1570
1632
  /**
1571
- * Triggers the Reset search in answer
1633
+ * Triggers the Reset search on the Search page
1572
1634
  *
1573
1635
  * @example
1574
1636
  * ```js
1575
1637
  * searchEmbed.trigger(HostEvent.ResetSearch)
1576
1638
  * ```
1577
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
1639
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
1578
1640
  */
1579
1641
  HostEvent["ResetSearch"] = "resetSearch";
1642
+ /**
1643
+ * Gets the currents visible and runtime filters applied on a Liveboard
1644
+ *
1645
+ * @example
1646
+ * liveboardEmbed.trigger(HostEvent.GetFilters)
1647
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1648
+ */
1649
+ HostEvent["GetFilters"] = "getFilters";
1650
+ /**
1651
+ * Updates the visible filters on the Liveboard.
1652
+ *
1653
+ * @param - filter: filter object containing column name and filter operation and values
1654
+ * @example
1655
+ *
1656
+ * ```js
1657
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
1658
+ * filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
1659
+ * })
1660
+ * ```
1661
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1662
+ */
1663
+ HostEvent["UpdateFilters"] = "updateFilters";
1664
+ /*
1665
+ * Get Tab for the current Liveboard.
1666
+ *
1667
+ * @example
1668
+ * ```js
1669
+ * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
1670
+ * console.log(
1671
+ * tabDetails // TabDetails of current LB
1672
+ * );
1673
+ * })
1674
+ * ```
1675
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1676
+ */
1677
+ HostEvent["GetTabs"] = "getTabs";
1678
+ /**
1679
+ * Set the visible Tabs on a Liveboard.
1680
+ *
1681
+ * @param - an array of ids of Tabs to show, the ids not passed
1682
+ * will be hidden.
1683
+ * @example
1684
+ * ```js
1685
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
1686
+ * '430496d6-6903-4601-937e-2c691821af3c',
1687
+ * 'f547ec54-2a37-4516-a222-2b06719af726'])
1688
+ * ```
1689
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1690
+ */
1691
+ HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
1692
+ /**
1693
+ * Set the hidden tabs on a Liveboard.
1694
+ *
1695
+ * @param - an array of ids of Tabs to hide, the ids not passed
1696
+ * will be shown.
1697
+ * @example
1698
+ * ```js
1699
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
1700
+ * '630496d6-6903-4601-937e-2c691821af3c',
1701
+ * 'i547ec54-2a37-4516-a222-2b06719af726'])
1702
+ * ```
1703
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1704
+ */
1705
+ HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
1580
1706
  })(HostEvent || (HostEvent = {}));
1581
1707
  /**
1582
1708
  * The different visual modes that the data sources panel within
@@ -1656,27 +1782,51 @@ var Param;
1656
1782
  Param["DisableWorksheetChange"] = "disableWorksheetChange";
1657
1783
  Param["HideEurekaResults"] = "hideEurekaResults";
1658
1784
  Param["HideEurekaSuggestions"] = "hideEurekaSuggestions";
1785
+ Param["HideLiveboardHeader"] = "hideLiveboardHeader";
1786
+ Param["ShowLiveboardDescription"] = "showLiveboardDescription";
1787
+ Param["ShowLiveboardTitle"] = "showLiveboardTitle";
1788
+ Param["HiddenTabs"] = "hideTabs";
1789
+ Param["VisibleTabs"] = "visibleTabs";
1790
+ Param["HideTabPanel"] = "hideTabPanel";
1659
1791
  })(Param || (Param = {}));
1660
1792
  /**
1661
- * The list of actions that can be performed on visual ThoughtSpot
1662
- * entities, such as answers and Liveboards.
1663
- *
1664
- * This enum is used to specify the actions that could be disabled,
1665
- * hidden or made visible.
1666
- *
1793
+ * ThoughtSpot application pages include actions and menu commands
1794
+ * for various user-initiated operations. These actions are represented
1795
+ * as enumeration members in the SDK. To show, hide, or disable
1796
+ * specific actions in the embedded view, define the Action
1797
+ * enumeration members in the `disabledActions`, `visibleActions`,
1798
+ * or `hiddenActions` array.
1799
+ * @example
1800
+ * ```js
1801
+ * const embed = new LiveboardEmbed('#embed-container', {
1802
+ * ... // other options
1803
+ * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
1804
+ * disabledActions: [Action.Download],
1805
+ * //hiddenActions: [], // Set either this or visibleActions
1806
+ * })
1807
+ * ```
1667
1808
  * @example
1668
1809
  * ```js
1669
1810
  * const embed = new LiveboardEmbed('#embed-container', {
1670
1811
  * ... // other options
1671
- * visibleActions: [Action.Save, Action.Explore],
1672
- * disableActions: [Action.Save],
1673
- * hiddenActions: [Action.Download], // Set either this or visibleActions
1812
+ * //visibleActions: [],
1813
+ * disabledActions: [Action.Download],
1814
+ * hiddenActions: [Action.Edit, ActionAction.Explore],
1674
1815
  * })
1675
1816
  * ```
1817
+
1676
1818
  */
1677
1819
  // eslint-disable-next-line no-shadow
1678
1820
  var Action;
1679
1821
  (function (Action) {
1822
+ /**
1823
+ * The **Save** action on an Answer or Liveboard.
1824
+ * Allows users to save the changes.
1825
+ * @example
1826
+ * ```js
1827
+ * disabledActions: [Action.SaveAsView]
1828
+ * ```
1829
+ */
1680
1830
  Action["Save"] = "save";
1681
1831
  /**
1682
1832
  * @hidden
@@ -1686,27 +1836,137 @@ var Action;
1686
1836
  * @hidden
1687
1837
  */
1688
1838
  Action["SaveUntitled"] = "saveUntitled";
1839
+ /**
1840
+ * The **Save as View** action on the Answer
1841
+ * page. Saves an Answer as a View object.
1842
+ *
1843
+ * @example
1844
+ * ```js
1845
+ * disabledActions: [Action.SaveAsView]
1846
+ * ```
1847
+ */
1689
1848
  Action["SaveAsView"] = "saveAsView";
1849
+ /**
1850
+ * The **Make a copy** action on a Liveboard or Answer
1851
+ * page.
1852
+ * Creates a copy of the Liveboard, visualization,
1853
+ * or Answer.
1854
+ *
1855
+ * @example
1856
+ * ```js
1857
+ * disabledActions: [Action.MakeACopy]
1858
+ * ```
1859
+ */
1690
1860
  Action["MakeACopy"] = "makeACopy";
1861
+ /**
1862
+ * The **Copy and Edit** action on a Liveboard.
1863
+ * This action is now replaced with `Action.MakeACopy`.
1864
+ *
1865
+ * @example
1866
+ * ```js
1867
+ * disabledActions: [Action.EditACopy]
1868
+ * ```
1869
+ */
1691
1870
  Action["EditACopy"] = "editACopy";
1871
+ /**
1872
+ * The **Copy link** menu action on a Liveboard visualization.
1873
+ * Copies the visualization URL
1874
+ * @example
1875
+ * ```js
1876
+ * disabledActions: [Action.CopyLink]
1877
+ * ```
1878
+ */
1692
1879
  Action["CopyLink"] = "embedDocument";
1693
1880
  /**
1694
1881
  * @hidden
1695
1882
  */
1696
1883
  Action["ResetLayout"] = "resetLayout";
1884
+ /**
1885
+ * The **Schedule** menu action on a Liveboard.
1886
+ * Allows scheduling a Liveboard notification.
1887
+ * @example
1888
+ * ```js
1889
+ * disabledActions: [Action.Schedule]
1890
+ * ```
1891
+ */
1697
1892
  Action["Schedule"] = "subscription";
1893
+ /**
1894
+ * The **Manage schedules** menu action on a Liveboard.
1895
+ * Allows users to manage scheduled Liveboard jobs.
1896
+ * @example
1897
+ * ```js
1898
+ * disabledActions: [Action.SchedulesList]
1899
+ * ```
1900
+ */
1698
1901
  Action["SchedulesList"] = "schedule-list";
1902
+ /**
1903
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
1904
+ * Allows users to share an object with other users and groups.
1905
+ * @example
1906
+ * ```js
1907
+ * disabledActions: [Action.Share]
1908
+ * ```
1909
+ */
1699
1910
  Action["Share"] = "share";
1911
+ /**
1912
+ * The **Add filter** action on a Liveboard and Search page.
1913
+ * Allows adding filters to Answers and visualizations on a Liveboard.
1914
+ * @example
1915
+ * ```js
1916
+ * disabledActions: [Action.AddFilter]
1917
+ * ```
1918
+ */
1700
1919
  Action["AddFilter"] = "addFilter";
1920
+ /**
1921
+ * Filter configuration options on a Liveboard and Search page.
1922
+ * Allows configuring filter options when adding filters to a
1923
+ * Liveboard or Answer.
1924
+ * @example
1925
+ * ```js
1926
+ * disabledActions: [Action.ConfigureFilter]
1927
+ * ```
1928
+ */
1701
1929
  Action["ConfigureFilter"] = "configureFilter";
1702
1930
  Action["CollapseDataSources"] = "collapseDataSources";
1931
+ /**
1932
+ * The **Choose sources** button on Search page.
1933
+ * Allows selecting data sources for search queries.
1934
+ * @example
1935
+ * ```js
1936
+ * disabledActions: [Action.ChooseDataSources]
1937
+ * ```
1938
+ */
1703
1939
  Action["ChooseDataSources"] = "chooseDataSources";
1940
+ /**
1941
+ * The **Create formula** action on a Search or Answer page.
1942
+ * Allows adding formulas to an Answer.
1943
+ * @example
1944
+ * ```js
1945
+ * disabledActions: [Action.AddFormula]
1946
+ * ```
1947
+ */
1704
1948
  Action["AddFormula"] = "addFormula";
1949
+ /**
1950
+ * The **Add parameter** action on a Liveboard or Answer.
1951
+ * Allows adding Parameters to a Liveboard or Answer.
1952
+ * @example
1953
+ * ```js
1954
+ * disabledActions: [Action.AddParameter]
1955
+ * ```
1956
+ */
1705
1957
  Action["AddParameter"] = "addParameter";
1706
1958
  /**
1707
1959
  * @hidden
1708
1960
  */
1709
1961
  Action["SearchOnTop"] = "searchOnTop";
1962
+ /**
1963
+ * The **SpotIQ analyze** menu action on a visualization or
1964
+ * Answer page.
1965
+ * @example
1966
+ * ```js
1967
+ * disabledActions: [Action.SpotIQAnalyze]
1968
+ * ```
1969
+ */
1710
1970
  Action["SpotIQAnalyze"] = "spotIQAnalyze";
1711
1971
  /**
1712
1972
  * @hidden
@@ -1721,24 +1981,150 @@ var Action;
1721
1981
  * @hidden
1722
1982
  */
1723
1983
  Action["ReplaySearch"] = "replaySearch";
1984
+ /**
1985
+ * The **Show underlying data** menu action on a visualization or
1986
+ * Answer page.
1987
+ * @example
1988
+ * ```js
1989
+ * disabledActions: [Action.ShowUnderlyingData]
1990
+ * ```
1991
+ */
1724
1992
  Action["ShowUnderlyingData"] = "showUnderlyingData";
1993
+ /**
1994
+ * The **Download** menu action on Liveboard visualizations
1995
+ * and Answers.
1996
+ * Allows downloading a visualization or Answer.
1997
+ * @example
1998
+ * ```js
1999
+ * disabledActions: [Action.DownloadAsPng]
2000
+ * ```
2001
+ */
1725
2002
  Action["Download"] = "download";
2003
+ /**
2004
+ * The **Download** > **PNG** menu action for charts on a Liveboard
2005
+ * or Answer page.
2006
+ * Downloads a visualization or Answer as a PNG file.
2007
+ * @example
2008
+ * ```js
2009
+ * disabledActions: [Action.DownloadAsPng]
2010
+ * ```
2011
+ */
1726
2012
  Action["DownloadAsPng"] = "downloadAsPng";
2013
+ /**
2014
+ * The **Download** > **PDF** menu action on a Liveboard.
2015
+ * Downloads a visualization or Answer as a PDF file.
2016
+ * @example
2017
+ * ```js
2018
+ * disabledActions: [Action.DownloadAsPdf]
2019
+ * ```
2020
+ */
1727
2021
  Action["DownloadAsPdf"] = "downloadAsPdf";
2022
+ /**
2023
+ * The **Download** > **CSV** menu action for tables on a Liveboard
2024
+ * or Answer page.
2025
+ * Downloads a visualization or Answer in the XLSX format.
2026
+ * @example
2027
+ * ```js
2028
+ * disabledActions: [Action.DownloadAsCsv]
2029
+ * ```
2030
+ */
1728
2031
  Action["DownloadAsCsv"] = "downloadAsCSV";
2032
+ /**
2033
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
2034
+ * or Answer page.
2035
+ * Downloads a visualization or Answer in the XLSX format.
2036
+ * @example
2037
+ * ```js
2038
+ * disabledActions: [Action.DownloadAsXlsx]
2039
+ * ```
2040
+ */
1729
2041
  Action["DownloadAsXlsx"] = "downloadAsXLSX";
1730
2042
  /**
1731
2043
  * @hidden
1732
2044
  */
1733
2045
  Action["DownloadTrace"] = "downloadTrace";
2046
+ /**
2047
+ * The **Export TML** menu action on Liveboard, Answers
2048
+ * Worksheets and Data Connections page.
2049
+ * Exports an object as a TML file.
2050
+ * @example
2051
+ * ```js
2052
+ * disabledActions: [Action.ExportTML]
2053
+ * ```
2054
+ */
1734
2055
  Action["ExportTML"] = "exportTSL";
2056
+ /**
2057
+ * The **Import TML** menu action for Liveboards and Answers.
2058
+ * Imports TML representation of ThoughtSpot objects.
2059
+ * @example
2060
+ * ```js
2061
+ * disabledActions: [Action.ImportTML]
2062
+ * ```
2063
+ */
1735
2064
  Action["ImportTML"] = "importTSL";
2065
+ /**
2066
+ * The **Update TML** menu action for Liveboards and Answers.
2067
+ * Update TML representation of ThoughtSpot objects.
2068
+ * @example
2069
+ * ```js
2070
+ * disabledActions: [Action.UpdateTML]
2071
+ * ```
2072
+ */
1736
2073
  Action["UpdateTML"] = "updateTSL";
2074
+ /**
2075
+ * The **Edit TML** menu action for Liveboards and Answers.
2076
+ * Opens the TML editor.
2077
+ * @example
2078
+ * ```js
2079
+ * disabledActions: [Action.EditTML]
2080
+ * ```
2081
+ */
1737
2082
  Action["EditTML"] = "editTSL";
2083
+ /**
2084
+ * The **Present** menu action for Liveboards and Answers.
2085
+ * Allows presenting a Liveboard or visualization in
2086
+ * slideshow mode.
2087
+ * @example
2088
+ * ```js
2089
+ * disabledActions: [Action.Present]
2090
+ * ```
2091
+ */
1738
2092
  Action["Present"] = "present";
2093
+ /**
2094
+ * The tile resize options in the visualization menu.
2095
+ * Allows switching between different preset layouts.
2096
+ * @example
2097
+ * ```js
2098
+ * disabledActions: [Action.ToggleSize]
2099
+ * ```
2100
+ */
1739
2101
  Action["ToggleSize"] = "toggleSize";
2102
+ /**
2103
+ * The *Edit* action on the Liveboard page and in the
2104
+ * visualization menu.
2105
+ * Opens a Liveboard or visualization in edit mode.
2106
+ * @example
2107
+ * ```js
2108
+ * disabledActions: [Action.Edit]
2109
+ * ```
2110
+ */
1740
2111
  Action["Edit"] = "edit";
2112
+ /**
2113
+ * The text edit option for Liveboard and visualization titles.
2114
+ * @example
2115
+ * ```js
2116
+ * disabledActions: [Action.EditTitle]
2117
+ * ```
2118
+ */
1741
2119
  Action["EditTitle"] = "editTitle";
2120
+ /**
2121
+ * The **Delete** menu action on Liveboards and visualizations.
2122
+ * Deletes a Liveboard or a visualization from a Liveboard.
2123
+ * @example
2124
+ * ```js
2125
+ * disabledActions: [Action.Remove]
2126
+ * ```
2127
+ */
1742
2128
  Action["Remove"] = "delete";
1743
2129
  /**
1744
2130
  * @hidden
@@ -1760,6 +2146,16 @@ var Action;
1760
2146
  * @hidden
1761
2147
  */
1762
2148
  Action["PinboardInfo"] = "pinboardInfo";
2149
+ /**
2150
+ * The **Show Liveboard details** menu action on a Liveboard.
2151
+ * Displays details such as the name, description, and
2152
+ * author of the Liveboard, and timestamp of Liveboard creation
2153
+ * and update.
2154
+ * @example
2155
+ * ```js
2156
+ * disabledActions: [Action.LiveboardInfo]
2157
+ * ```
2158
+ */
1763
2159
  Action["LiveboardInfo"] = "pinboardInfo";
1764
2160
  /**
1765
2161
  * @hidden
@@ -1770,20 +2166,61 @@ var Action;
1770
2166
  */
1771
2167
  Action["DownloadEmbraceQueries"] = "downloadEmbraceQueries";
1772
2168
  /**
1773
- * Pin action.
1774
- */
2169
+ * The **Pin** menu action on an Answer or
2170
+ * Search results page.
2171
+ * @example
2172
+ * ```js
2173
+ * disabledActions: [Action.Pin]
2174
+ * ```
2175
+ */
1775
2176
  Action["Pin"] = "pin";
1776
2177
  /**
1777
2178
  * @hidden
1778
2179
  */
1779
2180
  Action["AnalysisInfo"] = "analysisInfo";
1780
- Action["Subscription"] = "subscription";
1781
2181
  /**
1782
- * Explore action.
2182
+ * The **Schedule** menu action on a Liveboard.
2183
+ * @example
2184
+ * ```js
2185
+ * disabledActions: [Action.Subscription]
2186
+ * ```
1783
2187
  */
2188
+ Action["Subscription"] = "subscription";
2189
+ /**
2190
+ * The **Explore** action on Liveboard visualizations
2191
+ * @example
2192
+ * ```js
2193
+ * disabledActions: [Action.Explore]
2194
+ * ```
2195
+ */
1784
2196
  Action["Explore"] = "explore";
2197
+ /**
2198
+ * The action to include data points on a drilled-down Answer
2199
+ * or visualization
2200
+ * @example
2201
+ * ```js
2202
+ * disabledActions: [Action.DrillInclude]
2203
+ * ```
2204
+ */
1785
2205
  Action["DrillInclude"] = "context-menu-item-include";
2206
+ /**
2207
+ * The action to exclude data points on a drilled-down Answer
2208
+ * or visualization
2209
+ * @example
2210
+ * ```js
2211
+ * disabledActions: [Action.DrillInclude]
2212
+ * ```
2213
+ */
1786
2214
  Action["DrillExclude"] = "context-menu-item-exclude";
2215
+ /**
2216
+ * The **Copy to clipboard** menu action on tables in an Answer
2217
+ * or Liveboard.
2218
+ * Copies the selected data point.
2219
+ * @example
2220
+ * ```js
2221
+ * disabledActions: [Action.CopyToClipboard]
2222
+ * ```
2223
+ */
1787
2224
  Action["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
1788
2225
  Action["CopyAndEdit"] = "context-menu-item-copy-and-edit";
1789
2226
  /**
@@ -1792,89 +2229,266 @@ var Action;
1792
2229
  Action["DrillEdit"] = "context-menu-item-edit";
1793
2230
  Action["EditMeasure"] = "context-menu-item-edit-measure";
1794
2231
  Action["Separator"] = "context-menu-item-separator";
2232
+ /**
2233
+ * The **Drill down** menu action on Answers and Liveboard
2234
+ * visualizations.
2235
+ * Allows drilling down to a specific data point on a chart or table.
2236
+ * @example
2237
+ * ```js
2238
+ * disabledActions: [Action.DrillDown]
2239
+ * ```
2240
+ */
1795
2241
  Action["DrillDown"] = "DRILL";
2242
+ /**
2243
+ * The request access action on Liveboards.
2244
+ * Allows users with view permissions to request edit access to a Liveboard.
2245
+ * @example
2246
+ * ```js
2247
+ * disabledActions: [Action.RequestAccess]
2248
+ * ```
2249
+ */
1796
2250
  Action["RequestAccess"] = "requestAccess";
1797
- Action["QueryDetailsButtons"] = "queryDetailsButtons";
1798
2251
  /**
1799
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2252
+ * The **Query visualizer** and **Query SQL** buttons in Query details panel
2253
+ * of the Answer page
2254
+ * @example
2255
+ * ```js
2256
+ * disabledActions: [Action.QueryDetailsButtons]
2257
+ * ```
2258
+ */
2259
+ Action["QueryDetailsButtons"] = "QueryDetailsButtons";
2260
+ /**
2261
+ * The **Delete** action for Answers.
2262
+ * @example
2263
+ * ```js
2264
+ * disabledActions: [Action.AnswerDelete]
2265
+ * ```
2266
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1800
2267
  */
1801
2268
  Action["AnswerDelete"] = "onDeleteAnswer";
1802
2269
  /**
1803
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2270
+ * The Chart switcher icon on Answer and visualization pages.
2271
+ * @example
2272
+ * ```js
2273
+ * disabledActions: [Action.AnswerChartSwitcher]
2274
+ * ```
2275
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1804
2276
  */
1805
2277
  Action["AnswerChartSwitcher"] = "answerChartSwitcher";
1806
2278
  /**
1807
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2279
+ * Favorites icon (*) on Answers, Liveboard, and Data pages
2280
+ * @example
2281
+ * ```js
2282
+ * disabledActions: [Action.AddToFavorites]
2283
+ * ```
2284
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1808
2285
  */
1809
2286
  Action["AddToFavorites"] = "addToFavorites";
1810
2287
  /**
1811
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2288
+ * The edit icon on Liveboards (Classic experience).
2289
+ * @example
2290
+ * ```js
2291
+ * disabledActions: [Action.EditDetails]
2292
+ * ```
2293
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1812
2294
  */
1813
2295
  Action["EditDetails"] = "editDetails";
1814
2296
  /**
1815
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2297
+ * The Create alert action on KPI charts.
2298
+ * @example
2299
+ * ```js
2300
+ * disabledActions: [Action.CreateMonitor ]
2301
+ * ```
2302
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1816
2303
  */
1817
2304
  Action["CreateMonitor"] = "createMonitor";
1818
2305
  /**
1819
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2306
+ * @example
2307
+ * ```js
2308
+ * disabledActions: [Action.ReportError]
2309
+ * ```
2310
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1820
2311
  */
1821
2312
  Action["ReportError"] = "reportError";
2313
+ /**
2314
+ * The **Sync to sheets** action on Answers and Liveboard visualizations.
2315
+ * Allows sending data to a Google Sheet.
2316
+ * @example
2317
+ * ```js
2318
+ * disabledActions: [Action.SyncToSheets]
2319
+ * ```
2320
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2321
+ */
1822
2322
  Action["SyncToSheets"] = "sync-to-sheets";
2323
+ /**
2324
+ * The **Sync to other apps** action on Answers and Liveboard visualizations.
2325
+ * Allows sending data to third-party apps like Slack, Salesforce,
2326
+ * Microsoft Teams, and so on.
2327
+ * @example
2328
+ * ```js
2329
+ * disabledActions: [Action.SyncToOtherApps]
2330
+ * ```
2331
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2332
+ */
1823
2333
  Action["SyncToOtherApps"] = "sync-to-other-apps";
2334
+ /**
2335
+ * The **Manage pipelines** action on Answers and Liveboard visualizations.
2336
+ * Allows users to manage data sync pipelines to third-party apps.
2337
+ * @example
2338
+ * ```js
2339
+ * disabledActions: [Action.SyncToOtherApps]
2340
+ * ```
2341
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2342
+ */
1824
2343
  Action["ManagePipelines"] = "manage-pipeline";
1825
2344
  /**
2345
+ * The **Filter** action on Liveboard visualizations.
2346
+ * Allows users to apply cross-filters on a Liveboard.
2347
+ * @example
2348
+ * ```js
2349
+ * disabledActions: [Action.CrossFilter]
2350
+ * ```
1826
2351
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1827
2352
  */
1828
2353
  Action["CrossFilter"] = "context-menu-item-cross-filter";
1829
2354
  /**
2355
+ * The **Remove** action that appears when cross filters are applied
2356
+ * on a Liveboard.
2357
+ * Removes filters applied o a visualization.
2358
+ * @example
2359
+ * ```js
2360
+ * disabledActions: [Action.RemoveCrossFilter]
2361
+ * ```
1830
2362
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1831
2363
  */
1832
2364
  Action["RemoveCrossFilter"] = "context-menu-item-remove-cross-filter";
1833
2365
  /**
2366
+ * The **Aggregate** option in the chart axis or the
2367
+ * table column customization menu.
2368
+ * Provides aggregation options to analyze the data on a chart or table.
2369
+ * @example
2370
+ * ```js
2371
+ * disabledActions: [Action.AxisMenuAggregate]
2372
+ * ```
1834
2373
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1835
2374
  */
1836
2375
  Action["AxisMenuAggregate"] = "axisMenuAggregate";
1837
2376
  /**
2377
+ * The **Time bucket** option in the chart axis or table column
2378
+ * customization menu.
2379
+ * Allows defining time metric for date comparison.
2380
+ * @example
2381
+ * ```js
2382
+ * disabledActions: [Action.AxisMenuTimeBucket]
2383
+ * ```
1838
2384
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1839
2385
  */
1840
2386
  Action["AxisMenuTimeBucket"] = "axisMenuTimeBucket";
1841
2387
  /**
2388
+ * The **Filter** action in the chart axis or table column
2389
+ * customization menu.
2390
+ * @example
2391
+ * ```js
2392
+ * disabledActions: [Action.AxisMenuFilter]
2393
+ * ```
1842
2394
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1843
2395
  */
1844
2396
  Action["AxisMenuFilter"] = "axisMenuFilter";
1845
2397
  /**
2398
+ * The **Conditional formatting** action on chart or table.
2399
+ * Allows adding rules for conditional formatting of data
2400
+ * points on a chart or table.
2401
+ * @example
2402
+ * ```js
2403
+ * disabledActions: [Action.AxisMenuConditionalFormat]
2404
+ * ```
1846
2405
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1847
2406
  */
1848
2407
  Action["AxisMenuConditionalFormat"] = "axisMenuConditionalFormat";
1849
2408
  /**
2409
+ * The **Sort** menu action on a table or chart axis
2410
+ * Sorts data in ascending or descending order.
2411
+ * Allows adding, editing, or removing filters.
2412
+ * @example
2413
+ * ```js
2414
+ * disabledActions: [Action.AxisMenuConditionalFormat]
2415
+ * ```
1850
2416
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1851
2417
  */
1852
2418
  Action["AxisMenuSort"] = "axisMenuSort";
1853
2419
  /**
2420
+ * The **Group** option in the chart axis or table column
2421
+ * customization menu.
2422
+ * Allows grouping data points if the axes use the same
2423
+ * unit of measurement and a similar scale.
2424
+ * @example
2425
+ * ```js
2426
+ * disabledActions: [Action.AxisMenuGroup]
2427
+ * ```
1854
2428
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1855
2429
  */
1856
2430
  Action["AxisMenuGroup"] = "axisMenuGroup";
1857
2431
  /**
2432
+ * The **Position** option in the axis customization menu.
2433
+ * Allows changing the position of the axis to the
2434
+ * left or right side of the chart.
2435
+ * @example
2436
+ * ```js
2437
+ * disabledActions: [Action.AxisMenuPosition]
2438
+ * ```
1858
2439
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1859
2440
  */
1860
2441
  Action["AxisMenuPosition"] = "axisMenuPosition";
1861
2442
  /**
2443
+ * The **Rename** option in the chart axis or table column customization menu.
2444
+ * Renames the axis label on a chart or the column header on a table.
2445
+ * @example
2446
+ * ```js
2447
+ * disabledActions: [Action.AxisMenuRename]
2448
+ * ```
1862
2449
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1863
2450
  */
1864
2451
  Action["AxisMenuRename"] = "axisMenuRename";
1865
2452
  /**
2453
+ * The **Edit** action in the axis customization menu.
2454
+ * Allows editing the axis name, position, minimum and maximum values,
2455
+ * and format of a column.
2456
+ * @example
2457
+ * ```js
2458
+ * disabledActions: [Action.AxisMenuEdit]
2459
+ * ```
1866
2460
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1867
2461
  */
1868
2462
  Action["AxisMenuEdit"] = "axisMenuEdit";
1869
2463
  /**
2464
+ * The **Number format** action to customize the format of
2465
+ * the data labels on a chart or table.
2466
+ * @example
2467
+ * ```js
2468
+ * disabledActions: [Action.AxisMenuNumberFormat]
2469
+ * ```
1870
2470
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1871
2471
  */
1872
2472
  Action["AxisMenuNumberFormat"] = "axisMenuNumberFormat";
1873
2473
  /**
2474
+ * The **Text wrapping** action on a table.
2475
+ * Wraps or clips column text on a table.
2476
+ * @example
2477
+ * ```js
2478
+ * disabledActions: [Action.AxisMenuTextWrapping]
2479
+ * ```
1874
2480
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1875
2481
  */
1876
2482
  Action["AxisMenuTextWrapping"] = "axisMenuTextWrapping";
1877
2483
  /**
2484
+ * The **Remove** action in the chart axis or table column
2485
+ * customization menu.
2486
+ * Removes the data labels from a chart or the column of a
2487
+ * table visualization.
2488
+ * @example
2489
+ * ```js
2490
+ * disabledActions: [Action.AxisMenuRemove]
2491
+ * ```
1878
2492
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1879
2493
  */
1880
2494
  Action["AxisMenuRemove"] = "axisMenuRemove";
@@ -1883,9 +2497,31 @@ var Action;
1883
2497
  */
1884
2498
  Action["InsertInToSlide"] = "insertInToSlide";
1885
2499
  /**
2500
+ * The **Rename** menu action on Liveboards and visualizations.
2501
+ * Allows renaming a Liveboard or visualization.
2502
+ * @example
2503
+ * ```js
2504
+ * disabledActions: [Action.RenameModalTitleDescription]
2505
+ * ```
1886
2506
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1887
2507
  */
1888
2508
  Action["RenameModalTitleDescription"] = "renameModalTitleDescription";
2509
+ /**
2510
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2511
+ */
2512
+ Action["RequestVerification"] = "requestVerification";
2513
+ /**
2514
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2515
+ */
2516
+ Action["MarkAsVerified"] = "markAsVerified";
2517
+ /**
2518
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2519
+ */
2520
+ Action["AddTab"] = "addTab";
2521
+ /**
2522
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2523
+ */
2524
+ Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
1889
2525
  })(Action || (Action = {}));
1890
2526
  // eslint-disable-next-line no-shadow
1891
2527
  var OperationType;
@@ -26689,7 +27325,7 @@ function processTrigger(iFrame, messageType, thoughtSpotHost, data) {
26689
27325
  });
26690
27326
  }
26691
27327
 
26692
- var name="@thoughtspot/visual-embed-sdk";var version="1.22.0";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/index.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs",start:"gatsby develop","build:gatsby":"npm run clean:gatsby && gatsby build --prefix-paths","build:gatsby:noprefix":"npm run clean:gatsby && gatsby build","serve:gatsby":"gatsby serve","clean:gatsby":"gatsby clean","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts","bundle-dts":"dts-bundle --name ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true","bundle-dts-react":"dts-bundle --name ../../../dist/visual-embed-sdk-react --main lib/src/react/index.d.ts --outputAsModuleFolder=true","bundle-dts-react-full":"dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",build:"rollup -c",watch:"rollup -cw","docs-cmd":"node scripts/gatsby-commands.js",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme","test-sdk":"jest -c jest.config.sdk.js --runInBand","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs",posttest:"cat ./coverage/sdk/lcov.info | coveralls","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1",dompurify:"^2.3.4","eslint-plugin-comment-length":"^0.9.2","eslint-plugin-jsdoc":"^40.1.0",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",lodash:"^4.17.21","mixpanel-browser":"^2.45.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.13.1","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"6.7.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-puppeteer":"^4.4.0",jsdom:"^17.0.0","node-sass":"^8.0.0",prettier:"2.1.2",puppeteer:"^7.0.1",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports,typesVersions:typesVersions,scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
27328
+ var name="@thoughtspot/visual-embed-sdk";var version="1.23.0";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/index.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs",start:"gatsby develop","build:gatsby":"npm run clean:gatsby && gatsby build --prefix-paths","build:gatsby:noprefix":"npm run clean:gatsby && gatsby build","serve:gatsby":"gatsby serve","clean:gatsby":"gatsby clean","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts","bundle-dts":"dts-bundle --name ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true","bundle-dts-react":"dts-bundle --name ../../../dist/visual-embed-sdk-react --main lib/src/react/index.d.ts --outputAsModuleFolder=true","bundle-dts-react-full":"dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",build:"rollup -c",watch:"rollup -cw","docs-cmd":"node scripts/gatsby-commands.js",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme","test-sdk":"jest -c jest.config.sdk.js --runInBand","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs",posttest:"cat ./coverage/sdk/lcov.info | coveralls","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1",dompurify:"^2.3.4","eslint-plugin-comment-length":"^0.9.2","eslint-plugin-jsdoc":"^40.1.0",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",lodash:"^4.17.21","mixpanel-browser":"^2.45.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.13.1","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"6.7.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-puppeteer":"^4.4.0",jsdom:"^17.0.0","node-sass":"^8.0.0",prettier:"2.1.2",puppeteer:"^7.0.1",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports,typesVersions:typesVersions,scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
26693
27329
 
26694
27330
  /**
26695
27331
  * Copyright (c) 2022
@@ -26922,11 +27558,15 @@ class TsEmbed {
26922
27558
  if (this.embedConfig.authType === AuthType.TrustedAuthTokenCookieless) {
26923
27559
  queryParams[Param.cookieless] = true;
26924
27560
  }
26925
- const { disabledActions, disabledActionReason, hiddenActions, visibleActions, showAlerts, additionalFlags, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, } = this.viewConfig;
27561
+ const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, hideLiveboardHeader, showLiveboardDescription, showLiveboardTitle, } = this.viewConfig;
26926
27562
  if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
26927
27563
  this.handleError('You cannot have both hidden actions and visible actions');
26928
27564
  return queryParams;
26929
27565
  }
27566
+ if (Array.isArray(visibleTabs) && Array.isArray(hiddenTabs)) {
27567
+ this.handleError('You cannot have both hidden Tabs and visible Tabs');
27568
+ return queryParams;
27569
+ }
26930
27570
  // TODO remove embedConfig.customCssUrl
26931
27571
  const cssUrlParam = ((_c = customizations === null || customizations === void 0 ? void 0 : customizations.style) === null || _c === void 0 ? void 0 : _c.customCSSUrl) || this.embedConfig.customCssUrl;
26932
27572
  if (cssUrlParam) {
@@ -26942,6 +27582,12 @@ class TsEmbed {
26942
27582
  if (Array.isArray(visibleActions)) {
26943
27583
  queryParams[Param.VisibleActions] = visibleActions;
26944
27584
  }
27585
+ if (Array.isArray(hiddenTabs)) {
27586
+ queryParams[Param.HiddenTabs] = hiddenTabs;
27587
+ }
27588
+ if (Array.isArray(visibleTabs)) {
27589
+ queryParams[Param.VisibleTabs] = visibleTabs;
27590
+ }
26945
27591
  /**
26946
27592
  * Default behavior for context menu will be left-click
26947
27593
  * from version 9.2.0.cl the user have an option to override context
@@ -26973,6 +27619,15 @@ class TsEmbed {
26973
27619
  if (insertInToSlide) {
26974
27620
  queryParams[Param.ShowInsertToSlide] = insertInToSlide;
26975
27621
  }
27622
+ if (hideLiveboardHeader) {
27623
+ queryParams[Param.HideLiveboardHeader] = hideLiveboardHeader;
27624
+ }
27625
+ if (showLiveboardDescription) {
27626
+ queryParams[Param.ShowLiveboardDescription] = showLiveboardDescription;
27627
+ }
27628
+ if (showLiveboardTitle) {
27629
+ queryParams[Param.ShowLiveboardTitle] = showLiveboardTitle;
27630
+ }
26976
27631
  return queryParams;
26977
27632
  }
26978
27633
  /**
@@ -27487,6 +28142,7 @@ const HiddenActionItemByDefaultForSageEmbed = [
27487
28142
  /**
27488
28143
  * Embed ThoughtSpot LLM and GPT based natural language search component.
27489
28144
  *
28145
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
27490
28146
  * @group Embed components
27491
28147
  */
27492
28148
  class SageEmbed extends V1Embed {
@@ -27923,7 +28579,7 @@ class LiveboardEmbed extends V1Embed {
27923
28579
  let params = {};
27924
28580
  params[Param.EmbedApp] = true;
27925
28581
  params = this.getBaseQueryParams(params);
27926
- const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, activeTabId, } = this.viewConfig;
28582
+ const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, hideTabPanel, activeTabId, } = this.viewConfig;
27927
28583
  const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
27928
28584
  || this.viewConfig.preventPinboardFilterRemoval;
27929
28585
  if (fullHeight === true) {
@@ -27948,6 +28604,9 @@ class LiveboardEmbed extends V1Embed {
27948
28604
  if (liveboardV2 !== undefined) {
27949
28605
  params[Param.LiveboardV2Enabled] = liveboardV2;
27950
28606
  }
28607
+ if (hideTabPanel) {
28608
+ params[Param.HideTabPanel] = hideTabPanel;
28609
+ }
27951
28610
  const queryParams = getQueryParamString(params, true);
27952
28611
  return queryParams;
27953
28612
  }