@thoughtspot/visual-embed-sdk 1.39.3 → 1.40.1-alpha.1

package/dist/visual-embed-sdk-react.d.ts

@@ -354,8 +354,6 @@ export function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
                 query: string;
                 message: {
                         worksheetId: string;
-                        convId: any;
-                        messageId: any;
                         sessionId: any;
                         genNo: any;
                         acSessionId: any;
@@ -1666,6 +1664,46 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * ```
             */
         isLiveboardStylingAndGroupingEnabled?: boolean;
+        /**
+            * This flag is used to enable the full height lazy load data.
+            *
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    // ...other options
+            *    fullHeight: true,
+            *    lazyLoadingForFullHeight: true,
+            * })
+            * ```
+            *
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
+            */
+        lazyLoadingForFullHeight?: boolean;
+        /**
+            * The margin to be used for lazy loading.
+            *
+            * For example, if the margin is set to '10px',
+            * the visualization will be loaded 10px before the its top edge is visible in the
+            * viewport.
+            *
+            * The format is similar to CSS margin.
+            *
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    // ...other options
+            *    fullHeight: true,
+            *    lazyLoadingForFullHeight: true,
+            *   // Using 0px, the visualization will be only loaded when its visible in the viewport.
+            *    lazyLoadingMargin: '0px',
+            * })
+            * ```
+            * @type {string}
+            * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
+            */
+        lazyLoadingMargin?: string;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -1702,6 +1740,11 @@ export declare class AppEmbed extends V1Embed {
             * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
             */
         navigateToPage(path: string | number, noReload?: boolean): void;
+        /**
+            * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        destroy(): void;
         /**
             * Renders the embedded application pages in the ThoughtSpot app.
             * @param renderOptions An object containing the page ID
@@ -2012,6 +2055,46 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
             * ```
             */
         isLiveboardStylingAndGroupingEnabled?: boolean;
+        /**
+            * This flag is used to enable the full height lazy load data.
+            *
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    // ...other options
+            *    fullHeight: true,
+            *    lazyLoadingForFullHeight: true,
+            * })
+            * ```
+            *
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
+            */
+        lazyLoadingForFullHeight?: boolean;
+        /**
+            * The margin to be used for lazy loading.
+            *
+            * For example, if the margin is set to '10px',
+            * the visualization will be loaded 10px before the its top edge is visible in the
+            * viewport.
+            *
+            * The format is similar to CSS margin.
+            *
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    // ...other options
+            *    fullHeight: true,
+            *    lazyLoadingForFullHeight: true,
+            *   // Using 0px, the visualization will be only loaded when its visible in the viewport.
+            *    lazyLoadingMargin: '0px',
+            * })
+            * ```
+            * @type {string}
+            * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
+            */
+        lazyLoadingMargin?: string;
 }
 /**
     * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -2045,6 +2128,11 @@ export declare class LiveboardEmbed extends V1Embed {
             * @returns A promise that resolves with the response from the embedded app
             */
         trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+        /**
+            * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            */
+        destroy(): void;
         /**
             * Render an embedded ThoughtSpot Liveboard or visualization
             * @param renderOptions An object specifying the Liveboard ID,
@@ -2088,8 +2176,6 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
         genNo: number;
         acSessionId: string;
         acGenNo: number;
-        convId: string;
-        messageId: string;
 }
 export declare class ConversationMessage extends TsEmbed {
         protected viewConfig: SpotterAgentMessageViewConfig;
@@ -2137,8 +2223,6 @@ export declare class SpotterAgentEmbed {
                 data?: undefined;
         } | {
                 data: {
-                        convId: any;
-                        messageId: any;
                         sessionId: any;
                         genNo: any;
                         acSessionId: any;
@@ -4823,82 +4907,11 @@ export declare enum EmbedEvent {
             */
         ExitPresentMode = "exitPresentMode",
         /**
-            * Emitted when spotter response is text data
-            * @example
-            * ```js
-            * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
-            *     console.log('payload', payload);
-            * })
-            *```
-            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
-            */
-        SpotterData = "SpotterData",
-        /**
-            * Emitted when user opens up the worksheet preview modal in spotter embed.
-            * @example
-            * ```js
-            * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
-            *     console.log('payload', payload);
-            * })
-            *```
-            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
-            */
-        PreviewSpotterData = "PreviewSpotterData",
-        /**
-            * Emitted when the spotter query is triggered in spotter embed.
-            * @example
-            * ```js
-            * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
-            *     console.log('payload', payload);
-            * })
-            *```
-            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
-            */
-        SpotterQueryTriggered = "SpotterQueryTriggered",
-        /**
-            * Emitted when the last spotter query is edited in spotter embed.
-            * @example
-            * ```js
-            * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
-            *     console.log('payload', payload);
-            * })
-            *```
-            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
-            */
-        LastPromptEdited = "LastPromptEdited",
-        /**
-            * Emitted when the last spotter query is deleted in spotter embed.
-            * @example
-            * ```js
-            * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
-            *     console.log('payload', payload);
-            * })
-            *```
-            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
-            */
-        LastPromptDeleted = "LastPromptDeleted",
-        /**
-            * Emitted when the coversation is reset in spotter embed.
-            * @example
-            * ```js
-            * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
-            *     console.log('payload', payload);
-            * })
-            *```
-            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
-            */
-        ResetSpotterConversation = "ResetSpotterConversation",
-        /**
-            * Emitted when the *Spotter* is initialized.
-            * @example
-            * ```js
-            * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
-            *     console.log('payload', payload);
-            * })
-            *```
-            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            * Emitted when a user requests the full height lazy load data.
+            * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
+            * @hidden
             */
-        SpotterInit = "SpotterInit"
+        RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates"
 }
 /**
     * Event types that can be triggered by the host application
@@ -5187,7 +5200,6 @@ export declare enum HostEvent {
             * @param
             * `vizId`-  GUID of the saved Answer or visualization to pin to a Liveboard.
             *  Optional when pinning a new chart or table generated from a Search query.
-            *  **Required** in Spotter Embed.
             * @param
             * `liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard,
             *  specify the `newLiveboardName` parameter to create a new Liveboard.
@@ -5235,12 +5247,6 @@ export declare enum HostEvent {
             * ```js
             * appEmbed.trigger(HostEvent.Pin)
             * ```
-            * @example
-            * ```js
-            * const pinResponse = await spotterEmbed.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",
@@ -5334,12 +5340,6 @@ export declare enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.MakeACopy)
             * ```
-            * @example
-            * ```js
-            * const pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, {
-            *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-            *  });
-            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         MakeACopy = "makeACopy",
@@ -5412,7 +5412,6 @@ export declare enum HostEvent {
             * This event is not supported in visualization embed and search embed.
             * @param - object - To trigger the action for a specific visualization
             * in Liveboard embed, pass in `vizId` as a key.
-            * **Required** in Spotter embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Edit)
@@ -5421,12 +5420,6 @@ export declare enum HostEvent {
             * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
             * '730496d6-6903-4601-937e-2c691821af3c'})
             * ```
-            * @example
-            * ```js
-            * const pinResponse = await spotterEmbed.trigger(HostEvent.Edit, {
-            *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-            *  });
-            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         Edit = "edit",
@@ -5474,16 +5467,6 @@ export declare enum HostEvent {
             *   );
             * })
             * ```
-            * @example
-            * ```js
-            * spotterEmbed.trigger(HostEvent.GetTML, {
-            *   vizId: '730496d6-6903-4601-937e-2c691821af3c'
-            * }).then((tml) => {
-            *   console.log(
-            *      tml.answer.search_query // TML representation of the search query
-            *   );
-            * })
-            * ```
             * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
             * @important
             */
@@ -5571,12 +5554,7 @@ export declare enum HostEvent {
             * vizEmbed.trigger(HostEvent.DownloadAsPng)
             *
             * searchEmbed.trigger(HostEvent.DownloadAsPng)
-            *
-            * spotterEmbed.trigger(HostEvent.DownloadAsPng, {
-            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-            * })
             * ```
-            *
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
             */
         DownloadAsPng = "downloadAsPng",
@@ -5594,11 +5572,6 @@ export declare enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.DownloadAsCsv)
             * ```
-            * ```js
-            * spotterEmbed.trigger(HostEvent.DownloadAsCsv, {
-            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-            * })
-            * ```
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         DownloadAsCsv = "downloadAsCSV",
@@ -5616,11 +5589,6 @@ export declare enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
             * ```
-            * ```js
-            * spotterEmbed.trigger(HostEvent.downloadAsXLSX, {
-            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-            * })
-            * ```
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         DownloadAsXlsx = "downloadAsXLSX",
@@ -5640,7 +5608,6 @@ export declare enum HostEvent {
         /**
             * Trigger the **Save**  action on a Liveboard or Answer.
             * Saves the changes.
-            * @param - `vizId` is required in Spotter Embed.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.Save)
@@ -5648,11 +5615,6 @@ export declare enum HostEvent {
             * ```js
             * searchEmbed.trigger(HostEvent.Save)
             * ```
-            * ```js
-            * spotterEmbed.trigger(HostEvent.Save, {
-            *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-            * })
-            * ```
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         Save = "save",
@@ -5936,7 +5898,7 @@ export declare enum HostEvent {
         ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
         /**
             * Triggers an action to update Parameter values on embedded
-            * Answers, Liveboard and Spotter answer in Edit mode.
+            * Answers and Liveboard.
             *
             * @example
             * ```js
@@ -5955,13 +5917,6 @@ export declare enum HostEvent {
             *  console.log('parameters', parameter);
             * });
             *```
-            *```js
-            * spotterEmbed.trigger(HostEvent.GetParameters, {
-            *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
-            * }).then((parameter) => {
-            *  console.log('parameters', parameter);
-            * });
-            *```
             * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
             */
         GetParameters = "GetParameters",
@@ -6029,64 +5984,6 @@ export declare enum HostEvent {
             * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
             */
         TransformTableVizData = "TransformTableVizData",
-        /**
-            * Triggers a search operation with the search tokens specified in
-            * the search query string in spotter embed.
-            * @param - `queryString`: Text string in Natural Language format
-            * @param - `executeSearch`: Boolean to execute search and update search query
-            * @example
-            * ```js
-            * spotterEmbed.trigger(HostEvent.SpotterSearch, {
-            *  query: 'revenue per year',
-            *  executeSearch: true,
-            * })
-            * ```
-            */
-        SpotterSearch = "SpotterSearch",
-        /**
-            * Edits the last prompt in spotter embed.
-            * @param - `query`: Text string
-            * @example
-            * ```js
-            * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
-            * ```
-            */
-        EditLastPrompt = "EditLastPrompt",
-        /**
-            * Opens the Worksheet preview modal in Spotter Embed.
-            * @example
-            * ```js
-            * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
-            * ```
-            */
-        PreviewSpotterData = "PreviewSpotterData",
-        /**
-            * Resets the Spotter Embed Conversation.
-            * @example
-            * ```js
-            * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
-            * ```
-            */
-        ResetSpotterConversation = "ResetSpotterConversation",
-        /**
-            * Deletes the last prompt in spotter embed.
-            * @example
-            * ```js
-            * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
-            * ```
-            */
-        DeleteLastPrompt = "DeleteLastPrompt",
-        /**
-            * Toggle the visualization to chart or table view.
-            * @param - `vizId ` In Spotter Embed, vizId is required.
-            * @example
-            * ```js
-            * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
-            *          vizId:"'b535c760-8bbe-4e6f-bb26-af56b4129a1e'"
-            * });
-            *```
-            */
-        AnswerChartSwitcher = "answerChartSwitcher",
         /**
             * @hidden
             * Trigger exit from presentation mode when user exits fullscreen.
@@ -6098,15 +5995,18 @@ export declare enum HostEvent {
             */
         ExitPresentMode = "exitPresentMode",
         /**
-            * Trigger the *Ask Sage* action for visualizations
+            * Triggers the full height lazy load data.
             * @example
             * ```js
-            * liveboardEmbed.trigger(HostEvent.AskSpotter,
-            * {containerId:'730496d6-6903-4601-937e-2c691821af3c'})
+            * liveboardEmbed.on(EmbedEvent.RequestVisibleEmbedCoordinates, (payload) => {
+            *      console.log(payload);
+            * });
             * ```
-            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+            *
+            * @hidden
             */
-        AskSpotter = "askSpotter"
+        VisibleEmbedCoordinates = "visibleEmbedCoordinates"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -6240,7 +6140,9 @@ export declare enum Param {
         CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
         PrimaryAction = "primaryAction",
         isSpotterAgentEmbed = "isSpotterAgentEmbed",
-        IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
+        IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
+        IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
+        RootMarginForLazyLoad = "rootMarginForLazyLoad"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands