@thoughtspot/visual-embed-sdk 1.17.0-alpha.5 → 1.17.0

package/src/types.ts

@@ -239,6 +239,7 @@ export interface EmbedConfig {
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw*
      */
     suppressSearchEmbedBetaWarning?: boolean;
+
     /**
      * Custom style params for embed Config.
      *
@@ -777,10 +778,7 @@ export enum HostEvent {
      * Triggers the Pin action on an embedded object
      * @param - incase of Liveboard embed, takes in an object with vizId as a key
      * can be left empty for search and visualization embeds
-     * @example
-     * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.Pin)
-     * searchEmbed.trigger(HostEvent.Pin)
+     * @example liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Pin = 'pin',
@@ -827,11 +825,8 @@ export enum HostEvent {
      */
     DownloadAsPdf = 'downloadAsPdf',
     /**
-     * Triggers the Make a copy action on a Liveboard, search or visualization
-     * @example
-     * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.MakeACopy)
-     * searchEmbed.trigger(HostEvent.MakeACopy)
+     * Triggers the Make a copy action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.MakeACopy)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     MakeACopy = 'makeACopy',
@@ -898,65 +893,6 @@ export enum HostEvent {
      * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
      */
     GetTML = 'getTML',
-    /**
-     * Triggers the ShowUnderlyingData action on visualization or search
-     * @param - an object with vizId as a key
-     * @example
-     * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
-     * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
-     * @version SDK: 1.18.0 | ThoughtSpot: 9.0.0.cl
-     */
-    ShowUnderlyingData = 'showUnderlyingData',
-    /**
-     * Triggers the Delete action on visualization or search
-     * @param - incase of Liveboard embed, takes in an object with vizId as a key
-     * can be left empty for search and visualization embeds
-     * @example
-     * liveboardEmbed.trigger(HostEvent.Delete, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.Delete)
-     * searchEmbed.trigger(HostEvent.Delete)
-     * @version SDK: 1.18.0 | ThoughtSpot: 9.0.0.cl
-     */
-    Delete = 'delete',
-    /**
-     * Triggers the SpotIQAnalyze action on visualization or search
-     * @param - incase of Liveboard embed, takes in an object with vizId as a key
-     * can be left empty for search and visualization embeds
-     * @example
-     * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
-     * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
-     * @version SDK: 1.18.0 | ThoughtSpot: 9.0.0.cl
-     */
-    SpotIQAnalyze = 'spotIQAnalyze',
-    /**
-     * Triggers the Download action on visualization or search when Displaymode is Chart
-     * @example
-     * liveboardEmbed.trigger(HostEvent.Download, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.Download)
-     * searchEmbed.trigger(HostEvent.Download)
-     * @version SDK: 1.18.0 | ThoughtSpot: 9.0.0.cl
-     */
-    Download = 'download',
-    /**
-     * Triggers the downloadAsCSV action on visualization or search when Displaymode is Table
-     * @example
-     * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.DownloadAsCsv)
-     * searchEmbed.trigger(HostEvent.DownloadAsCsv)
-     * @version SDK: 1.18.0 | ThoughtSpot: 9.0.0.cl
-     */
-    DownloadAsCsv = 'downloadAsCSV',
-    /**
-     * Triggers the downloadAsXLSX action on visualization or search when Displaymode is Table
-     * @example
-     * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
-     * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
-     * @version SDK: 1.18.0 | ThoughtSpot: 9.0.0.cl
-     */
-    DownloadAsXlsx = 'downloadAsXLSX',
     /**
      * Triggers the Share action on a liveboard or answer
      * @example
@@ -973,33 +909,6 @@ export enum HostEvent {
      * @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
      */
     Save = 'save',
-    /**
-     * Triggers the SyncToSheets action on visualization
-     * @param - an object with vizId as a key
-     * @example
-     * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.SyncToSheets)
-     * @version SDK: 1.18.0 | ThoughtSpot: 9.0.0.cl
-     */
-    SyncToSheets = 'sync-to-sheets',
-    /**
-     * Triggers the SyncToOtherApps action on visualization
-     * @param - an object with vizId as a key
-     * @example
-     * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.SyncToOtherApps)
-     * @version SDK: 1.18.0 | ThoughtSpot: 9.0.0.cl
-     */
-    SyncToOtherApps = 'sync-to-other-apps',
-    /**
-     * Triggers the ManagePipelines action on visualization
-     * @param - an object with vizId as a key
-     * @example
-     * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     * vizEmbed.trigger(HostEvent.ManagePipelines)
-     * @version SDK: 1.18.0 | ThoughtSpot: 9.0.0.cl
-     */
-    ManagePipelines = 'manage-pipeline',
 }
 
 /**