@thoughtspot/visual-embed-sdk 1.41.0-pre-render-1 → 1.41.1

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

@@ -373,7 +373,7 @@ export function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, CustomActionsPosition, CustomActionTarget, };
 
 export declare let loggedInStatus: boolean;
 export declare let samlAuthWindow: Window;
@@ -662,7 +662,6 @@ export declare class SearchBarEmbed extends TsEmbed {
         protected viewConfig: SearchBarViewConfig;
         protected embedComponentType: string;
         constructor(domSelector: string, viewConfig: SearchBarViewConfig);
-        protected getEmbedParamsObject(): Record<any, any>;
         /**
             * Render the embedded ThoughtSpot search
             */
@@ -815,7 +814,6 @@ export declare class SageEmbed extends V1Embed {
             */
         protected viewConfig: SageViewConfig;
         constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
-        protected getEmbedParamsObject(): Record<any, any>;
         /**
             * Constructs a map of parameters to be passed on to the
             * embedded Eureka or Sage search page.
@@ -1153,7 +1151,6 @@ export declare class SearchEmbed extends TsEmbed {
                 };
         };
         protected getAppInitData(): Promise<SearchAppInitData>;
-        protected getEmbedParamsObject(): Record<any, any>;
         protected getEmbedParams(): string;
         /**
             * Construct the URL of the embedded ThoughtSpot search to be
@@ -1258,7 +1255,12 @@ export declare enum HomePage {
             * Modular (v2) introduces the updated Modular Home Experience.
             * It serves as the foundational version of the home page.
             */
-        Modular = "v2"
+        Modular = "v2",
+        /**
+            * ModularWithStylingChanges (v3) introduces Modular Home Experience
+            * with styling changes.
+            */
+        ModularWithStylingChanges = "v3"
 }
 /**
     * Define the version of the list page
@@ -1679,6 +1681,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
             * ```
             */
         isLiveboardStylingAndGroupingEnabled?: boolean;
+        /**
+            * This flag is used to enable/disable the png embedding of liveboard in scheduled mails
+            *
+            * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+            * @type {boolean}
+            * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl
+            * @example
+            * ```js
+            * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+            * const embed = new <EmbedComponent>('#tsEmbed', {
+            *    ... // other embed view config
+            *    isPNGInScheduledEmailsEnabled: true,
+            * })
+            * ```
+            */
+        isPNGInScheduledEmailsEnabled?: boolean;
         /**
             * This flag is used to enable the full height lazy load data.
             *
@@ -2070,6 +2088,22 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
             * ```
             */
         isLiveboardStylingAndGroupingEnabled?: boolean;
+        /**
+            * This flag is used to enable/disable the png embedding of liveboard in scheduled mails
+            *
+            * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+            * @type {boolean}
+            * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl
+            * @example
+            * ```js
+            * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+            * const embed = new <EmbedComponent>('#tsEmbed', {
+            *    ... // other embed view config
+            *    isPNGInScheduledEmailsEnabled: true,
+            * })
+            * ```
+            */
+        isPNGInScheduledEmailsEnabled?: boolean;
         /**
             * This flag is used to enable the full height lazy load data.
             *
@@ -2110,6 +2144,22 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
             * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
             */
         lazyLoadingMargin?: string;
+        /**
+            * showSpotterLimitations : show limitation text
+            * of the spotter underneath the chat input.
+            * default is false.
+            *
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    // ...other options
+            *    showSpotterLimitations: true,
+            * })
+            * ```
+            * @type {boolean}
+            * @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
+            */
+        showSpotterLimitations?: boolean;
 }
 /**
     * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -2134,7 +2184,6 @@ export declare class LiveboardEmbed extends V1Embed {
             * embedded Liveboard or visualization.
             */
         protected getEmbedParams(): string;
-        protected getEmbedParamsObject(): any;
         /**
             * @hidden
             * Internal state to track the current liveboard id.
@@ -2208,7 +2257,6 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
 export declare class ConversationMessage extends TsEmbed {
         protected viewConfig: SpotterAgentMessageViewConfig;
         constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
-        protected getEmbedParamsObject(): Record<any, any>;
         getIframeSrc(): string;
         render(): Promise<ConversationMessage>;
 }
@@ -2924,6 +2972,31 @@ export interface EmbedConfig {
             * ```
             */
         disableFullscreenPresentation?: boolean;
+        /**
+            * Custom Actions allows users to define interactive UI actions (like buttons or menu
+            * items) that appear in ThoughtSpot's visualizations, answers, and Liveboards. These
+            * actions enable users to trigger custom workflows — such as navigating to an
+            * external app, calling an API, or opening a modal — based on the data context of
+            * what they clicked can be used to trigger custom logic when the action is clicked.
+            * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
+            * @example
+            * ```js
+            * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
+            * init({
+            *   ... // other embed config options
+            *   customActions: [
+            *     {
+            *       name: 'customAction',
+            *       id: 'customAction',
+            *       target: CustomActionTarget.VISUALIZATION,
+            *       position: CustomActionPosition.PRIMARY,
+            *       }
+            *     }
+            *   ]
+            * })
+            * ```
+            */
+        customActions?: CustomAction[];
 }
 export interface LayoutConfig {
 }
@@ -3284,6 +3357,34 @@ export interface BaseViewConfig {
             * ```
             */
         showAlerts?: boolean;
+        /**
+            * Custom Actions allows users to define interactive UI actions (like buttons or menu
+            * items) that appear in ThoughtSpot's visualizations, answers, and Liveboards. These
+            * actions enable users to trigger custom workflows — such as navigating to an
+            * external app, calling an API, or opening a modal — based on the data context of
+            * what they clicked can be used to trigger custom logic when the action is clicked.
+            *
+            * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterEmbed`
+            * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
+            * @example
+            * ```js
+            * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
+            * // Use supported embed types such as AppEmbed or LiveboardEmbed
+            * const embed = new LiveboardEmbed('#tsEmbed', {
+            *   ... // other embed config options
+            *   customActions: [
+            *     {
+            *       name: 'customAction',
+            *       id: 'customAction',
+            *       target: CustomActionTarget.VISUALIZATION,
+            *       position: CustomActionPosition.PRIMARY,
+            *       }
+            *     }
+            *   ]
+            * })
+            * ```
+            */
+        customActions?: CustomAction[];
 }
 /**
     * The configuration object for Home page embeds configs.
@@ -3293,7 +3394,8 @@ export interface HomePageConfig {
             * Hide list page columns
             * For example: hiddenListColumns = [ListPageColumns.Author]
             *
-            * **Note**: This option is available only in full app embedding. To use it, you need to import `ListPageColumns` enum.
+            * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum.
+            * At present, it can be used with Liveboard and Answer list pages, and starting with version 10.14.0.cl, it will also be supported for the Home page.
             *
             * Supported embed types: `AppEmbed`
             * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
@@ -3478,8 +3580,8 @@ export interface SearchLiveboardCommonViewConfig {
             * Flag to control Data panel experience
             *
             * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
-            * @default false
-            * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
+            * @default true
+            * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl
             * @example
             * ```js
             * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -3609,7 +3711,8 @@ export interface LiveboardAppEmbedViewConfig {
             */
         isLiveboardCompactHeaderEnabled?: boolean;
         /**
-            * This flag can be used to show or hide the Liveboard verified icon in the compact header.
+            * This flag can be used to show or hide the Liveboard verified icon in the compact
+            * header.
             *
             * Supported embed types: `AppEmbed`, `LiveboardEmbed`
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -3627,6 +3730,8 @@ export interface LiveboardAppEmbedViewConfig {
         /**
             * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
             *
+            * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
+            *
             * Supported embed types: `AppEmbed`, `LiveboardEmbed`
             * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
             * @default false
@@ -3636,12 +3741,14 @@ export interface LiveboardAppEmbedViewConfig {
             * const embed = new <EmbedComponent>('#tsEmbed', {
             *    ... // other embed view config
             *    hideIrrelevantChipsInLiveboardTabs: true,
+            *    isLiveboardCompactHeaderEnabled: true,
             * })
             * ```
             */
         hideIrrelevantChipsInLiveboardTabs?: boolean;
         /**
-            * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
+            * This flag can be used to show or hide the re-verify banner on the Liveboard
+            * compact header
             *
             * Supported embed types: `AppEmbed`, `LiveboardEmbed`
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -3688,6 +3795,21 @@ export interface LiveboardAppEmbedViewConfig {
          * ```
          */
         coverAndFilterOptionInPDF?: boolean;
+        /**
+            * This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
+            *
+            * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.14.0.cl
+            * @example
+            * ```js
+            * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+            * const embed = new <EmbedComponent>('#tsEmbed', {
+            *    ... // other embed view config
+            *    liveboardXLSXCSVDownload: true,
+            * })
+            * ```
+            */
+        liveboardXLSXCSVDownload?: boolean;
 }
 export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
 }
@@ -4575,6 +4697,11 @@ export declare enum EmbedEvent {
             * @hidden
             */
         APP_INIT = "appInit",
+        /**
+            * Internal event to clear the cached info
+            * @hidden
+            */
+        CLEAR_INFO_CACHE = "clearInfoCache",
         /**
             * Emitted when a user clicks **Show Liveboard details** on a Liveboard
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
@@ -5042,7 +5169,18 @@ export declare enum EmbedEvent {
             * })
             * ```
             */
-        EmbedListenerReady = "EmbedListenerReady"
+        EmbedListenerReady = "EmbedListenerReady",
+        /**
+            * Emitted when the organization is switched.
+            * @example
+            * ```js
+            * appEmbed.on(EmbedEvent.OrgSwitched, (payload) => {
+            *     console.log('payload', payload);
+            * })
+            * ```
+            * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+            */
+        OrgSwitched = "orgSwitched"
 }
 /**
     * Event types that can be triggered by the host application
@@ -5959,7 +6097,7 @@ export declare enum HostEvent {
             *      column: "Date",
             *      oper: 'EQ',
             *      values: ["2023-07-31"],
-            *      types: "EXACT_DATE"
+            *      type: "EXACT_DATE"
             *    }]
             * });
             * ```
@@ -6304,17 +6442,7 @@ export declare enum HostEvent {
             * ```
             * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
             */
-        AskSpotter = "AskSpotter",
-        /**
-            * @hidden
-            * Triggers the update of the embed params.
-            *
-            * @example
-            * ```js
-            * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
-            * ```
-            */
-        UpdateEmbedParams = "updateEmbedParams"
+        AskSpotter = "AskSpotter"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -6410,6 +6538,7 @@ export declare enum Param {
         Query = "query",
         HideHomepageLeftNav = "hideHomepageLeftNav",
         ModularHomeExperienceEnabled = "modularHomeExperience",
+        HomepageVersion = "homepageVersion",
         ListPageVersion = "listpageVersion",
         PendoTrackingKey = "additionalPendoKey",
         LiveboardHeaderSticky = "isLiveboardHeaderSticky",
@@ -6450,7 +6579,9 @@ export declare enum Param {
         isSpotterAgentEmbed = "isSpotterAgentEmbed",
         IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled",
         IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
-        RootMarginForLazyLoad = "rootMarginForLazyLoad"
+        RootMarginForLazyLoad = "rootMarginForLazyLoad",
+        LiveboardXLSXCSVDownload = "isLiveboardXLSXCSVDownloadEnabled",
+        isPNGInScheduledEmailsEnabled = "isPNGInScheduledEmailsEnabled"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -7022,7 +7153,7 @@ export declare enum Action {
             * The Favorites icon (*) for Answers,
             * Liveboard, and data objects like Worksheet, Model,
             * Tables and Views.
-            * Allows adding an object to the user’s favorites list.
+            * Allows adding an object to the user's favorites list.
             * @example
             * ```js
             * disabledActions: [Action.AddToFavorites]
@@ -7730,7 +7861,30 @@ export declare enum Action {
             * ```
             *  @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
             */
-        SpotterTokenQuickEdit = "SpotterTokenQuickEdit"
+        SpotterTokenQuickEdit = "SpotterTokenQuickEdit",
+        /**
+            * The **PNG screenshot in email** option in the schedule email dialog.
+            * Includes a PNG screenshot in the notification email body.
+            * @example
+            * ```js
+            * disabledActions: [Action.PngScreenshotInEmail]
+            * ```
+            * ```
+            *  @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl
+            */
+        PngScreenshotInEmail = "pngScreenshotInEmail",
+        /**
+            * The **Remove attachment** action in the schedule email dialog.
+            * Removes an attachment from the email configuration.
+            * @example
+            * ```js
+            * disabledActions: [Action.RemoveAttachment]
+            * ```
+            * ```
+            * ```
+            *  @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl
+            */
+        RemoveAttachment = "removeAttachment"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
@@ -7791,6 +7945,41 @@ export interface CustomActionPayload {
         session: SessionInterface;
         vizId?: string;
 }
+export interface CustomAction {
+        name: string;
+        id: string;
+        position: CustomActionsPosition;
+        target: CustomActionTarget;
+        metadataIds?: {
+                answerIds?: string[];
+                liveboardIds?: string[];
+                vizIds?: string[];
+        };
+        dataModelIds?: {
+                modelIds?: string[];
+                modelColumnNames?: string[];
+        };
+        orgIds?: string[];
+        groupIds?: string[];
+}
+/**
+    * Enum options to show custom actions at different
+    * positions in the application.
+    */
+export declare enum CustomActionsPosition {
+        PRIMARY = "PRIMARY",
+        MENU = "MENU",
+        CONTEXTMENU = "CONTEXTMENU"
+}
+/**
+    * Enum options to mention the target of the custom action.
+    */
+export declare enum CustomActionTarget {
+        LIVEBOARD = "LIVEBOARD",
+        VIZ = "VIZ",
+        ANSWER = "ANSWER",
+        SPOTTER = "SPOTTER"
+}
 /**
     * Enum options to show or suppress Visual Embed SDK and
     * ThoughtSpot application logs in the console output.
@@ -7885,6 +8074,7 @@ export interface DefaultAppInitData {
         hiddenHomeLeftNavItems: string[];
         customVariablesForThirdPartyTools: Record<string, any>;
         hiddenListColumns: ListPageColumns[];
+        customActions: CustomAction[];
 }
 
 interface EmbedViewConfig extends AllEmbedViewConfig, EmbedEventHandlers {
@@ -7965,8 +8155,8 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
             * Flag to control Data panel experience
             *
             * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
-            * @default false
-            * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
+            * @default true
+            * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl
             * @example
             * ```js
             * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -8095,7 +8285,6 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
 export declare class SpotterEmbed extends TsEmbed {
         protected viewConfig: SpotterEmbedViewConfig;
         constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
-        protected getEmbedParamsObject(): Record<any, any>;
         getIframeSrc(): string;
         render(): Promise<SpotterEmbed>;
 }
@@ -8391,7 +8580,8 @@ export interface CustomCssVariables {
             * Font color of the text on toggle buttons such as
             * **All**, **Answers**, and **Liveboards** on the Home page (Classic experience),
             * the text color of the chart and table tiles on Home page (New modular Homepage
-            * experience), and title text on the AI-generated charts and tables.
+            * experience), title text on the AI-generated charts and tables, and object titles on
+            * list pages such as *Liveboards* and *Answers*.
             * The default color code is #2770EF.
             *
             */
@@ -9510,6 +9700,7 @@ export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT e
     * @param embedConfig
     */
 export declare function getAuthenticationToken(embedConfig: EmbedConfig): Promise<string>;
+export declare const validateAuthToken: (embedConfig: EmbedConfig, authToken: string, suppressAlert?: boolean) => Promise<boolean>;
 /**
     * Resets the auth token and a new token will be fetched on the next request.
     * @example
@@ -9595,7 +9786,6 @@ export declare class TsEmbed {
             * @param query
             */
         protected getEmbedBasePath(query: string): string;
-        protected getUpdateEmbedParamsObject(): Record<any, any>;
         /**
             * Common query params set for all the embed modes.
             * @param queryParams
@@ -9611,7 +9801,6 @@ export declare class TsEmbed {
             */
         protected getV1EmbedBasePath(queryString: string): string;
         protected getEmbedParams(): string;
-        protected getEmbedParamsObject(): Record<any, any>;
         protected getRootIframeSrc(): string;
         protected createIframeEl(frameSrc: string): HTMLIFrameElement;
         protected handleInsertionIntoDOM(child: string | Node): void;
@@ -9704,10 +9893,10 @@ export declare class TsEmbed {
             */
         off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
         /**
-         * @hidden
-         * Internal state to track if the embed container is loaded.
-         * This is used to trigger events after the embed container is loaded.
-         */
+            * @hidden
+            * Internal state to track if the embed container is loaded.
+            * This is used to trigger events after the embed container is loaded.
+            */
         isEmbedContainerLoaded: boolean;
         protected getPreRenderObj<T extends TsEmbed>(): T;
         /**
@@ -9744,7 +9933,7 @@ export declare class TsEmbed {
             * Creates the preRender shell
             * @param showPreRenderByDefault - Show the preRender after render, hidden by default
             */
-        preRender(showPreRenderByDefault?: boolean): Promise<TsEmbed>;
+        preRender(showPreRenderByDefault?: boolean, replaceExistingPreRender?: boolean): Promise<TsEmbed>;
         /**
             * Get the Post Url Params for THOUGHTSPOT from the current
             * host app URL.