@thoughtspot/visual-embed-sdk 1.24.0-preRender.5 → 1.24.0-preRender.7

package/lib/src/visual-embed-sdk.d.ts

@@ -18,11 +18,11 @@ declare module '@thoughtspot/visual-embed-sdk' {
     import { SearchEmbed, SearchViewConfig } from '@thoughtspot/visual-embed-sdk/embed/search';
     import { SearchBarEmbed, SearchBarViewConfig } from '@thoughtspot/visual-embed-sdk/embed/search-bar';
     import { AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, getSessionInfo } from '@thoughtspot/visual-embed-sdk/auth';
-    import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, PrefetchFeatures, FrameParams, DOMSelector, HomeLeftNavItem, HomepageModule, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, ContextMenuTriggerOptions } from '@thoughtspot/visual-embed-sdk/types';
+    import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, PrefetchFeatures, FrameParams, DOMSelector, HomeLeftNavItem, HomepageModule, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, ContextMenuTriggerOptions, RuntimeParameter } from '@thoughtspot/visual-embed-sdk/types';
     import { CustomCssVariables } from '@thoughtspot/visual-embed-sdk/css-variables';
     import { SageEmbed, SageViewConfig } from '@thoughtspot/visual-embed-sdk/embed/sage';
     import { AnswerService } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
-    export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, 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, };
+    export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, 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, };
 }
 
 declare module '@thoughtspot/visual-embed-sdk/embed/app' {
@@ -76,7 +76,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
         *
         * @group Embed components
         */
-    export interface AppViewConfig extends ViewConfig {
+    export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             /**
                 * If true, the main navigation bar within the ThoughtSpot app
                 * is displayed. By default, the navigation bar is hidden.
@@ -170,6 +170,27 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * @hidden
                 */
             dataPanelV2?: boolean;
+            /**
+                * Show or hide Liveboard header
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+                * @default false
+                */
+            hideLiveboardHeader?: boolean;
+            /**
+                * Show or hide Liveboard title
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+                * @default false
+                */
+            showLiveboardTitle?: boolean;
+            /**
+                * Show or hide Liveboard description
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+                * @default false
+                */
+            showLiveboardDescription?: boolean;
             /**
                 * Flag to control new Modular Home experience
                 *
@@ -177,6 +198,19 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
                 */
             modularHomeExperience?: boolean;
+            /**
+                * Boolean to control if Liveboard header is sticky or not.
+                *
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#embed', {
+                *   ... // other app view config
+                *   isLiveboardHeaderSticky: true,
+                * });
+                * ```
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+                */
+            isLiveboardHeaderSticky?: boolean;
     }
     /**
         * Embeds full ThoughtSpot experience in a host application.
@@ -345,14 +379,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
         * @summary Liveboard & visualization embed
         * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
         */
-    import { RuntimeParameter, DOMSelector, HostEvent, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
+    import { DOMSelector, HostEvent, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     /**
         * The configuration for the embedded Liveboard or visualization page view.
         *
         * @group Embed components
         */
-    export interface LiveboardViewConfig extends ViewConfig {
+    export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
             /**
                 * If set to true, the embedded object container dynamically resizes
                 * according to the height of the Liveboard.
@@ -418,7 +452,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 */
             liveboardV2?: boolean;
             /**
-                * Tab Id of the Liveboard that is supposed to be active
+                * Tab ID of the Liveboard that is supposed to be active
                 *
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
@@ -430,9 +464,39 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 */
             hideTabPanel?: boolean;
             /**
-                * The list of parameter override to apply to a Liveboard.
+                * Show or hide Liveboard header
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+                * @default false
                 */
-            runtimeParameters?: RuntimeParameter[];
+            hideLiveboardHeader?: boolean;
+            /**
+                * Show or hide Liveboard title
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+                * @default false
+                */
+            showLiveboardTitle?: boolean;
+            /**
+                * Show or hide Liveboard description
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+                * @default false
+                */
+            showLiveboardDescription?: boolean;
+            /**
+                * Boolean for sticky Liveboard header.
+                *
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed', {
+                *   ... // other liveboard view config
+                *   isLiveboardHeaderSticky: true,
+                * });
+                * ```
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+                */
+            isLiveboardHeaderSticky?: boolean;
     }
     /**
         * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -492,7 +556,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
         * @summary Search embed
         * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
         */
-    import { DOMSelector, Action, ViewConfig, RuntimeParameter } from '@thoughtspot/visual-embed-sdk/types';
+    import { DOMSelector, Action, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     /**
         * Configuration for search options
@@ -515,7 +579,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
         *
         * @group Embed components
         */
-    export interface SearchViewConfig extends ViewConfig {
+    export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
             /**
                 * If set to true, the data sources panel is collapsed on load,
                 * but can be expanded manually.
@@ -589,10 +653,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 * @version: SDK: 1.24.0
                 */
             useLastSelectedSources?: boolean;
-            /**
-                * The list of parameter override to apply to a search answer.
-                */
-            runtimeParameters?: RuntimeParameter[];
     }
     export const HiddenActionItemByDefaultForSearchEmbed: Action[];
     /**
@@ -622,7 +682,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
     /**
         * @group Embed components
         */
-    export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
+    export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
             /**
                 * The array of data source GUIDs to set on load.
                 * Only a single dataSource supported currently.
@@ -1473,9 +1533,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * The list of parameter override to apply to a search answer,
                 * visualization, or Liveboard.
+                *
+                * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
                 */
             runtimeParameters?: RuntimeParameter[];
             /**
+             /**
                 * The locale/language to use for the embedded view.
                 *
                 * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
@@ -1543,27 +1606,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @hidden
                 */
             excludeRuntimeFiltersfromURL?: boolean;
-            /**
-                * Boolean to hide liveboard header
-                *
-                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-                * @default false
-                */
-            hideLiveboardHeader?: boolean;
-            /**
-                * Boolean to show liveboard title
-                *
-                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-                * @default false
-                */
-            showLiveboardTitle?: boolean;
-            /**
-                * Boolean to show liveboard description
-                *
-                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-                * @default false
-                */
-            showLiveboardDescription?: boolean;
             /**
                 * The list of tab IDs to hide from the embedded.
                 * This Tabs will be hidden from their respective LBs.
@@ -1640,23 +1682,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             preRenderId?: string;
             /**
-                * Determines whether the PreRender component should dynamically track the size
+                * Determines whether the PreRender component should not dynamically track the size
                 * of its embedding element and adjust its own size accordingly.
                 * Enabling this option allows the PreRender component to automatically adapt
                 * its dimensions based on changes to the size of the embedding element.
                 *
                 * @type {boolean}
-                * @default true
+                * @default false
                 * @example
-                * // Enable tracking PreRender size in the configuration
+                * // Disable tracking PreRender size in the configuration
                 * const config = {
-                *   trackPreRenderSize: true,
+                *   doNotTrackPreRenderSize: true,
                 * };
                 *
                 * // Instantiate an object with the configuration
                 * const myComponent = new MyComponent(config);
                 */
-            trackPreRenderSize?: boolean;
+            doNotTrackPreRenderSize?: boolean;
     }
     /**
         * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2359,11 +2401,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @param - execute - executes the existing / updated query
                 * @example
                 * ```js
-                * searchEmbed.trigger(HostEvent.Search, {
-                *   searchQuery: "[sales] by [item type],
-                *   dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
-                *   execute: true
-                * })
+                * searchembed.trigger(HostEvent.Search, {
+                     searchQuery: "[sales] by [item type]",
+                     dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
+                     execute: true
+                 });
                 * ```
                 */
             Search = "search",
@@ -3117,6 +3159,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             DisableWorksheetChange = "disableWorksheetChange",
             HideEurekaResults = "hideEurekaResults",
             HideEurekaSuggestions = "hideEurekaSuggestions",
+            HideAutocompleteSuggestions = "hideAutocompleteSuggestions",
             HideLiveboardHeader = "hideLiveboardHeader",
             ShowLiveboardDescription = "showLiveboardDescription",
             ShowLiveboardTitle = "showLiveboardTitle",
@@ -3128,7 +3171,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             Query = "query",
             HideHomepageLeftNav = "hideHomepageLeftNav",
             ModularHomeExperienceEnabled = "modularHomeExperience",
-            PendoTrackingKey = "additionalPendoKey"
+            PendoTrackingKey = "additionalPendoKey",
+            LiveboardHeaderSticky = "isLiveboardHeaderSticky",
+            IsProductTour = "isProductTour",
+            HideSearchBarTitle = "hideSearchBarTitle",
+            HideSageAnswerHeader = "hideSageAnswerHeader"
     }
     /**
         * ThoughtSpot application pages include actions and menu commands
@@ -3964,7 +4011,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
                 */
-            PersonalisedViewsDropdown = "personalisedViewsDropdown"
+            PersonalisedViewsDropdown = "personalisedViewsDropdown",
+            /**
+                * Action ID for Liveboard Users ( Recently Visited / social proof )
+                *
+                *  @example
+                * ```js
+                * disabledActions: [Action.LiveboardUsers]
+                * ```
+                *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+                */
+            LiveboardUsers = "liveboardUsers"
     }
     export interface AnswerServiceType {
             getAnswer?: (offset: number, batchSize: number) => any;
@@ -4376,7 +4433,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
         */
     export interface SearchOptions {
             /**
-                * The tml string to load the answer
+                * The query string to pre-fill in natual language search bar
                 */
             searchQuery: string;
             /**
@@ -4394,15 +4451,45 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
         * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
         * @group Embed components
         */
-    export interface SageViewConfig extends ViewConfig {
+    export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
             /**
                 * If set to true, a list of liveboard and answers related
                 * to the natural language search will be shown below the
                 * AI generated answer.
+                *
+                * @deprecated Currently liveboard and answers related
+                * to the natural language search will not be shown for sage
+                * embed
                 */
             showObjectResults?: boolean;
+            /**
+                * flag used by the TS product tour page to show the blue search bar
+                * even after the search is completed. This is different from TSE Sage Embed
+                * experience where it mimics closer to the non-embed case.
+                * The Sample questions container is collapsed when this value is set after
+                * does a search.
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
+                * @hidden
+                */
+            isProductTour?: boolean;
+            /**
+                * flag to hide search bar title. default false.
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
+                */
+            hideSearchBarTitle?: boolean;
+            /**
+                * flag to disable Sage Answer header(`AI Answer` title section on top of the Sage
+                * answer). default false.
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
+                */
+            hideSageAnswerHeader?: boolean;
             /**
                 * flag to disable changing worksheet. default false.
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
                 */
             disableWorksheetChange?: boolean;
             /**
@@ -4410,18 +4497,24 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
                 */
             hideWorksheetSelector?: boolean;
             /**
-                * If set to true, the search suggestions will contain existing
-                * liveboards and answers in addition with the autocomplete
+                * If set to true, the search bar auto complete search suggestions will not be shown.
+                * default false
                 *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
                 */
-            showObjectSuggestions?: boolean;
+            hideAutocompleteSuggestions?: boolean;
             /**
-                * The query string to pre-fill in natual language search bar
+                * If set to false, the auto complete search suggestions not be shown
+                *
+                * @deprecated currently, object suggestions will not be shown for sage embed
+                * earlier this flag was used to show Auto complete suggestions
                 */
-            searchQuery?: string;
+            showObjectSuggestions?: boolean;
             /**
                 * If set to true, sample questions would be hidden to user.
                 * These sample questions are autogenerated based on selected datasource.
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
                 */
             hideSampleQuestions?: boolean;
             /**
@@ -4430,6 +4523,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
             dataSource?: string;
             /**
                 * Configuration for search options
+                *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
                 */
             searchOptions?: SearchOptions;
     }
@@ -4513,9 +4608,10 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answer
                 *
                 * @param userLocale
                 * @param omitInfo Omit the download Info on top of the CSV
+                * @param includeInfo
                 * @returns Response
                 */
-            fetchCSVBlob(userLocale?: string, omitInfo?: boolean): Promise<Response>;
+            fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
             getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
             executeQuery(query: string, variables: any): Promise<any>;
             getSession(): SessionInterface;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.24.0-preRender.5",
+    "version": "1.24.0-preRender.7",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -64,7 +64,7 @@
         "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 tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
+        "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",
         "check-size": "npm run build && size-limit",
         "publish-dev": "npm publish --tag dev",
         "publish-prod": "npm publish --tag latest"

package/src/embed/app.spec.ts

@@ -310,6 +310,35 @@ describe('App embed tests', () => {
         });
     });
 
+    test('Should add isLiveboardHeaderSticky flag to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            isLiveboardHeaderSticky: false,
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&isLiveboardHeaderSticky=false${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
+    test('Should add default values of flags to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&isLiveboardHeaderSticky=true&hideLiveboardHeader=false&showLiveboardDescription=true&showLiveboardTitle=true${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('Should add modularHomeExperience flag to the iframe src', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,

package/src/embed/app.ts

@@ -55,7 +55,7 @@ export enum Page {
  *
  * @group Embed components
  */
-export interface AppViewConfig extends ViewConfig {
+export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
     /**
      * If true, the main navigation bar within the ThoughtSpot app
      * is displayed. By default, the navigation bar is hidden.
@@ -149,6 +149,27 @@ export interface AppViewConfig extends ViewConfig {
      * @hidden
      */
     dataPanelV2?: boolean;
+    /**
+     * Show or hide Liveboard header
+     *
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @default false
+     */
+    hideLiveboardHeader?: boolean;
+    /**
+     * Show or hide Liveboard title
+     *
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @default false
+     */
+    showLiveboardTitle?: boolean;
+    /**
+     * Show or hide Liveboard description
+     *
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @default false
+     */
+    showLiveboardDescription?: boolean;
     /**
      * Flag to control new Modular Home experience
      *
@@ -156,6 +177,19 @@ export interface AppViewConfig extends ViewConfig {
      * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
      */
     modularHomeExperience?: boolean;
+    /**
+     * Boolean to control if Liveboard header is sticky or not.
+     *
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#embed', {
+     *   ... // other app view config
+     *   isLiveboardHeaderSticky: true,
+     * });
+     * ```
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     */
+    isLiveboardHeaderSticky?: boolean;
 }
 
 /**
@@ -196,8 +230,12 @@ export class AppEmbed extends V1Embed {
             enableSearchAssist,
             fullHeight,
             dataPanelV2 = false,
+            hideLiveboardHeader = false,
+            showLiveboardTitle = true,
+            showLiveboardDescription = true,
             hideHomepageLeftNav = false,
             modularHomeExperience = false,
+            isLiveboardHeaderSticky = true,
         } = this.viewConfig;
 
         let params = {};
@@ -206,6 +244,10 @@ export class AppEmbed extends V1Embed {
         params[Param.HideProfleAndHelp] = !!disableProfileAndHelp;
         params[Param.HideApplicationSwitcher] = !!hideApplicationSwitcher;
         params[Param.HideOrgSwitcher] = !!hideOrgSwitcher;
+        params[Param.HideLiveboardHeader] = hideLiveboardHeader;
+        params[Param.ShowLiveboardTitle] = showLiveboardTitle;
+        params[Param.ShowLiveboardDescription] = !!showLiveboardDescription;
+        params[Param.LiveboardHeaderSticky] = isLiveboardHeaderSticky;
 
         params = this.getBaseQueryParams(params);
 

package/src/embed/liveboard.spec.ts

@@ -192,6 +192,22 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('Should add isLiveboardHeaderSticky flag to the iframe src', async () => {
+        const appEmbed = new LiveboardEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            liveboardId,
+            isLiveboardHeaderSticky: false,
+        } as LiveboardViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardHeaderSticky=false${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('should not apply runtime filters if excludeRuntimeFiltersfromURL is true', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -409,7 +425,7 @@ describe('Liveboard/viz embed tests', () => {
 
                 // should render the generic link
                 expect(prerenderGenericSpy).toHaveBeenCalledTimes(1);
-                expect(iFrame.src).toMatch(/http:\/\/tshost\/.*&isLiveboardEmbed=true#$/);
+                expect(iFrame.src).toMatch(/http:\/\/tshost\/.*&isLiveboardEmbed=true.*#$/);
 
                 expect(consoleSpy).toHaveBeenCalledTimes(0);
 
@@ -417,7 +433,7 @@ describe('Liveboard/viz embed tests', () => {
             });
         });
 
-        test('it should preRender generic with liveboard id is not passed', async (done) => {
+        test('it should navigateToLiveboard with liveboard id is not passed', async (done) => {
             mockMessageChannel();
             const consoleSpy = jest.spyOn(console, 'error');
             const testPreRenderId = 'testPreRender';
@@ -459,7 +475,7 @@ describe('Liveboard/viz embed tests', () => {
 
                 // should render the generic link
                 expect(navigateToLiveboardSpy).toHaveBeenCalledWith(testLiveboardId);
-                expect(iFrame.src).toMatch(/http:\/\/tshost\/.*&isLiveboardEmbed=true#$/);
+                expect(iFrame.src).toMatch(/http:\/\/tshost\/.*&isLiveboardEmbed=true.*#$/);
 
                 expect(consoleSpy).toHaveBeenCalledTimes(0);