AppViewConfig

This is an object (key/val) of override flags which will be applied to the internal embedded object. This can be used to add any URL flag. If the same flags are passed in init, they will be overriden by the values here. Warning: This option is for advanced use only and is used internally to control embed behavior in non-regular ways. We do not publish the list of supported keys and values associated with each.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Index Signature Parameters

Version : SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
  additionalFlags: {
       flag1: 'value1',
       flag2: 'value2'
    },
});

collapseSearchBar🔗

collapseSearchBar: boolean

Optional

To set the initial state of the search bar in case of saved Answers.

Supported embed types: SageEmbed, AppEmbed, SearchBarEmbed

Version : SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl

default : true

// Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
  collapseSearchBar: true,
});

collapseSearchBarInitially🔗

collapseSearchBarInitially: boolean

Optional

To set the initial state of the search bar in case of saved-answers.

Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl

Deprecated : Use {@link collapseSearchBar} instead

default : false

contextMenuTrigger🔗

contextMenuTrigger: ContextMenuTriggerOptions

Optional

flag to set ContextMenu Trigger to either left or right click.

Supported embed types: AppEmbed, SageEmbed, SearchEmbed

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
})

coverAndFilterOptionInPDF🔗

coverAndFilterOptionInPDF: boolean

Optional

This flag is used to show or hide checkboxes for including or excluding the cover and filters pages in the Liveboard PDF.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.40.0 | ThoughtSpot:10.8.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   coverAndFilterOptionInPDF: false,
})

customActions🔗

customActions: CustomAction[]

Optional

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

import {
  CustomActionPayload,
  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.VIZ,
      position: CustomActionPosition.PRIMARY,
      }
    }
  ]
})

// to trigger a custom flow on custom action click listen to Custom action embed event
embed.on(EmbedEvent.CustomAction, (payload: CustomActionPayload) => {
  console.log('Custom Action event:', payload);
})

customizations🔗

customizations: CustomisationsInterface

Optional

Dynamic CSSUrl and customCSS to be injected in the loaded application. You would also need to set style-src in the CSP settings.

Version : SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl

default : ''

dataPanelCustomGroupsAccordionInitialState🔗

dataPanelCustomGroupsAccordionInitialState: DataPanelCustomColumnGroupsAccordionState

Optional

This controls the initial behaviour of custom column groups accordion. It takes DataPanelCustomColumnGroupsAccordionState enum values as input. List of different enum values:- - EXPAND_ALL: Expand all the accordion initially in data panel v2. - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2. - EXPAND_FIRST: Expand the first accordion and collapse the rest.

Supported embed types: AppEmbed

Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl

default : DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL

const embed = new AppEmbed('#embed', {
  ... // other app view config
  dataPanelCustomGroupsAccordionInitialState:
     DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
});

dataPanelV2🔗

dataPanelV2: boolean

Optional

Flag to control Data panel experience

Supported embed types: SageEmbed, AppEmbed, SearchBarEmbed, LiveboardEmbed, SearchEmbed

Version : SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl

default : true

// Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   dataPanelV2: true,
})

disableProfileAndHelp🔗

disableProfileAndHelp: boolean

Optional

Control the visibility of the help (?) and profile buttons on the top navigation bar. These buttons are visible if the navigation bar is not hidden via showPrimaryNavbar.

Supported embed types: AppEmbed

Version : SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl

default : false

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   disableProfileAndHelp: true,
})

disableRedirectionLinksInNewTab🔗

disableRedirectionLinksInNewTab: boolean

Optional

This flag can be used to disable links inside the embedded app, and disable redirection of links in a new tab.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
  ... // other embed view config
  disableRedirectionLinksInNewTab: true,
});

disabledActionReason🔗

disabledActionReason: string

Optional

The tooltip to display for disabled actions.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   disabledActions: [Action.Download, Action.Save],
   disabledActionReason: "Reason for disabling",
});

disabledActions🔗

disabledActions: Action[]

Optional

The list of actions to disable from the primary menu, more menu (…), and the contextual menu. These actions will be disabled for the user. Use this to disable actions.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   disabledActions: [Action.Download, Action.Save],
});

discoveryExperience🔗

discoveryExperience: DiscoveryExperience

Optional

Configures the V3 navigation and home page experience. For more information, see full app embed documentation. Supported embed types: AppEmbed

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl

default : false

const embed = new AppEmbed('#tsEmbed', {
   // Enable V3 navigation and home page experience
   discoveryExperience : {
     primaryNavbarVersion: PrimaryNavbarVersion.Sliding, // Enable V3 navigation
     homePage: HomePage.ModularWithStylingChanges, // Enable V3 modular home page
     ... // other embed view config
   },
})

doNotTrackPreRenderSize🔗

doNotTrackPreRenderSize: boolean

Optional

Determines if the PreRender component should 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.

Version : SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw

default : false

// Disable tracking PreRender size in the configuration
const config = {
  doNotTrackPreRenderSize: true,
};

// Instantiate an object with the configuration
const myComponent = new MyComponent(config);

enable2ColumnLayout🔗

enable2ColumnLayout: boolean

Optional

This attribute can be used to enable the two-column layout on an embedded Liveboard

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.32.0 | ThoughtSpot:10.1.0.cl

default : false

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   enable2ColumnLayout: true,
})

enableAskSage🔗

enableAskSage: boolean

Optional

enable or disable ask sage

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.29.0 | Thoughtspot: 9.12.0.cl

default : false

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SpotterEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   enableAskSage:true,
})

enableCustomColumnGroups🔗

enableCustomColumnGroups: boolean

Optional

To enable custom column groups in data panel v2

Supported embed types: SageEmbed, SearchBarEmbed, LiveboardEmbed, SearchEmbed

Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw

default : false

// Replace <EmbedComponent> with embed component name. For example, SageEmbed, SearchBarEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
  ... // other embed view config
  enableCustomColumnGroups: true,
});

enablePendoHelp🔗

enablePendoHelp: boolean

Optional

Version : SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl

default : true Whether the help menu in the top navigation bar should be served from Pendo or ThoughtSpot’s internal help items.

Supported embed types: AppEmbed

const embed = new AppEmbed('#tsEmbed', {
  ... // other embed view config
 enablePendoHelp: false,
});

enableSearchAssist🔗

enableSearchAssist: boolean

Optional

If set to true, the Search Assist feature is enabled.

Supported embed types: AppEmbed

Version : SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw

default : true

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   enableSearchAssist: true,
})

enableV2Shell_experimental🔗

enableV2Shell_experimental: boolean

Optional

Enable the V2 shell. This can provide performance benefits due to a lighterweight shell.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
  enableV2Shell_experimental: true,
});

excludeRuntimeFiltersfromURL🔗

excludeRuntimeFiltersfromURL: boolean

Optional

Boolean to exclude runtimeFilters in the URL By default it is true, this flag removes runtime filters from the URL when set to false, runtime filters will be included in the URL.

Irrespective of this flag, runtime filters ( if passed ) will be applied to the embedded view.

Version : SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl

default : false

excludeRuntimeParametersfromURL🔗

excludeRuntimeParametersfromURL: boolean

Optional

Boolean to exclude runtimeParameters from the URL when set to true, this flag removes runtime parameters from the URL.

Irrespective of this flag, runtime filters ( if passed ) will be applied to the embedded view.

Version : SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl

default : false

exposeTranslationIDs🔗

exposeTranslationIDs: boolean

Optional

This flag can be used to expose translation IDs on the embedded app.

Version : SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl

default : false

frameParams🔗

frameParams: FrameParams

Optional

The width and height dimensions to render an embedded object inside your app. Specify the values in pixels or percentage.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   frameParams: {
       width: '500px' | '50%',
       height: '400px' | '60%',
   },
})

fullHeight🔗

fullHeight: boolean

Optional

If set to true, the Liveboard container dynamically resizes according to the height of the Liveboard.

Note: Using fullHeight loads all visualizations on the Liveboard simultaneously, which results in multiple warehouse queries and potentially a longer wait for the topmost visualizations to display on the screen. Setting fullHeight to false fetches visualizations incrementally as users scroll the page to view the charts and tables.

Supported embed types: AppEmbed

Version : SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   fullHeight: true,
})

hiddenActions🔗

hiddenActions: Action[]

Optional

The list of actions to hide from the embedded. This actions will be hidden from the user. Use this to hide an action.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   hiddenActions: [Action.Download, Action.Export],
});

hiddenHomeLeftNavItems🔗

hiddenHomeLeftNavItems: HomeLeftNavItem[]

Optional

Controls the visibility of the menu items on the home page left navigation panel. To specify the menu items, import the HomeLeftNavItem enum.

Note: This attribute is not supported in the classic (v1) homepage.

Supported embed types: AppEmbed

Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw

import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';

const embed = new AppEmbed('#tsEmbed', {
   //... V2/V3 experience attributes
   hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
   ... //other embed view configuration attributes
})

hiddenHomepageModules🔗

hiddenHomepageModules: HomepageModule[]

Optional

Control the visibility of home page modules. To specify the modules, import the HomepageModule enum. For example: hiddenHomepageModules = [HomepageModule.MyLibrary]

Note: This attribute is not supported in the classic (v1) experience.

Supported embed types: AppEmbed

Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw

import { HomepageModule } from '@thoughtspot/visual-embed-sdk';

const embed = new AppEmbed('#tsEmbed', {
   ... // V2/V3 navigation and home page experience attributes
   hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
   //...other embed view configuration attributes
})

hiddenListColumns🔗

hiddenListColumns: ListPageColumns[]

Optional

Hide columns on list pages such as Liveboards and Answers. For example: hiddenListColumns = [ListPageColumns.Author]

Note: This option is available only in full app embedding and requires importing the ListPageColumns enum. Starting with version 10.14.0.cl, you can use this attribute to hide the columns on all list pages in the Insights section.

Supported embed types: AppEmbed

Version : SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl

import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';

const embed = new AppEmbed('#tsEmbed', {
   ... //other embed view config
   hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
})

hideApplicationSwitcher🔗

hideApplicationSwitcher: boolean

Optional

Control the visibility of the application selection menu in the top navigation bar in the V2 experience. In the V3 experience, it shows or hides application selection icons on the left navigation panel. By default, the application selection menu and icons are shown in the UI

Note: This attribute is not supported in the classic (V1) experience.

Supported embed types: AppEmbed

Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl

default : false

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   hideApplicationSwitcher : true,
})

hideHamburger🔗

hideHamburger: boolean

Optional

Control the visibility of the hamburger icon on the top navigation bar in the V3 navigation experience.

Supported embed types: AppEmbed

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl

default : false

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   hideHamburger : true,
})

hideHomepageLeftNav🔗

hideHomepageLeftNav: boolean

Optional

Control the visibility of the left navigation panel on the home page in the V2 and V3 navigation and home page experience. If showPrimaryNavbar is true, that is, if the Global and Homepage navigation bars are visible, this flag will only hide the left navigation bar on the home page. The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.

Note: This attribute is not supported in the classic (V1) experience.

Supported embed types: AppEmbed

Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl

default : false

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   hideHomepageLeftNav : true,
})

hideIrrelevantChipsInLiveboardTabs🔗

hideIrrelevantChipsInLiveboardTabs: boolean

Optional

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

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   hideIrrelevantChipsInLiveboardTabs: true,
   isLiveboardCompactHeaderEnabled: true,
})

hideLiveboardHeader🔗

hideLiveboardHeader: boolean

Optional

Show or hide Liveboard header

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

default : false

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   hideLiveboardHeader : true,
})

hideNotification🔗

hideNotification: boolean

Optional

Control the visibility of the notification icon on the top navigation bar in V3 navigation experience.

Note: This attribute is not supported in the classic (V1) and V2 experience modes.

Supported embed types: AppEmbed

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl

default : true

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   hideNotification: false,
})

hideObjectSearch🔗

hideObjectSearch: boolean

Optional

Control the visibility of the object search on the top navigation bar in the V2 and V3 navigation experience.

Note: This attribute is not supported in the classic (V1) experience.

Supported embed types: AppEmbed

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl

default : true

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   hideObjectSearch: false,
})

hideObjects🔗

hideObjects: string[]

Optional

The array of GUIDs to be hidden

Supported embed types: AppEmbed

Version : SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   hideObjects: [
      '430496d6-6903-4601-937e-2c691821af3c',
      'f547ec54-2a37-4516-a222-2b06719af726'
    ]
})

hideOrgSwitcher🔗

hideOrgSwitcher: boolean

Optional

Control the visibility of the Org switcher button on the nav-bar. By default, the Org switcher button is shown.

Note: This attribute is not supported in the classic (V1) experience.

Supported embed types: AppEmbed

Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl

default : true

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   hideOrgSwitcher : true,
})

hideTagFilterChips🔗

hideTagFilterChips: boolean

Optional

Hide tag filter chips that appear when content is filtered by tags. When enabled, this automatically: - Hides tag filter indicators/chips from the UI

This provides a clean interface without tag-related UI elements.

Supported embed types: AppEmbed

Version : SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl

// Simple usage - automatically hides all tag-related UI
const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   tag: 'Some Tag',
   hideTagFilterChips: true, // This is all you need!
});

homePageSearchBarMode🔗

homePageSearchBarMode: HomePageSearchBarMode

Optional

Flag to use home page search bar mode

Supported embed types: AppEmbed

Version : SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl

insertAsSibling🔗

insertAsSibling: boolean

Optional

Insert as a sibling of the target container, instead of appending to a child inside it.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   insertAsSibling:true,
})

interceptTimeout🔗

interceptTimeout: number

Optional

The timeout for the intercept, default is 30000ms the api will error out if the timeout is reached

Version : SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl

const embed = new LiveboardEmbed('#embed', {
  ...viewConfig,
  enableApiIntercept: true,
  interceptUrls: [InterceptedApiType.ALL],
  interceptTimeout: 1000,
})

interceptUrls🔗

interceptUrls: string[]

Optional

This allows to intercept the urls passed, once intercepted the api will only run based on the reponse from the responder of ApiIntercept event.

Version : SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl

const embed = new LiveboardEmbed('#embed', {
  ...viewConfig,
  enableApiIntercept: true,
  interceptUrls: [InterceptedApiType.DATA],
})

isCentralizedLiveboardFilterUXEnabled🔗

isCentralizedLiveboardFilterUXEnabled: boolean

Optional

This flag is used to enable or disable the new centralized Liveboard filter UX (v2). When enabled, a unified modal is used to manage and update multiple filters at once, replacing the older individual filter interactions. To enable this feature on your instance, contact ThoughtSpot Support.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isCentralizedLiveboardFilterUXEnabled: true,
})

isEnhancedFilterInteractivityEnabled🔗

isEnhancedFilterInteractivityEnabled: boolean

Optional

This flag is used to enable or disable the enhanced filter interactivity in liveboard.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isEnhancedFilterInteractivityEnabled: true,
})

isLinkParametersEnabled🔗

isLinkParametersEnabled: boolean

Optional

This flag is used to enable or disable the link parameters in liveboard.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isLinkParametersEnabled: true,
})

isLiveboardCompactHeaderEnabled🔗

isLiveboardCompactHeaderEnabled: boolean

Optional

This flag can be used to enable the compact header in Liveboard

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.35.0 | ThoughtSpot:10.3.0.cl

default : false

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isLiveboardCompactHeaderEnabled: true,
})

isLiveboardHeaderSticky🔗

isLiveboardHeaderSticky: boolean

Optional

Boolean to control if Liveboard header is sticky or not.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#embed', {
  ... // other app view config
  isLiveboardHeaderSticky: true,
});

isLiveboardMasterpiecesEnabled🔗

isLiveboardMasterpiecesEnabled: boolean

Optional

Enable or disable Liveboard styling and grouping

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.45.0 | Thoughtspot: 26.2.0.cl

default : false

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isLiveboardMasterpiecesEnabled: true,
})

isLiveboardStylingAndGroupingEnabled🔗

isLiveboardStylingAndGroupingEnabled: boolean

Optional

This flag is used to enable/disable the styling and grouping in a Liveboard

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isLiveboardStylingAndGroupingEnabled: true,
})

isOnBeforeGetVizDataInterceptEnabled🔗

isOnBeforeGetVizDataInterceptEnabled: boolean

Optional

Flag that allows using EmbedEvent.OnBeforeGetVizDataIntercept.

Can be used for Serach and App Embed from SDK 1.29.0

Version : SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl

isPNGInScheduledEmailsEnabled🔗

isPNGInScheduledEmailsEnabled: boolean

Optional

This flag is used to enable/disable the png embedding of liveboard in scheduled mails

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isPNGInScheduledEmailsEnabled: true,
})

isUnifiedSearchExperienceEnabled🔗

isUnifiedSearchExperienceEnabled: boolean

Optional

This flag is used to enable unified search experience for full app embed.

Supported embed types: AppEmbed

Version : SDK: 1.34.0 | ThoughtSpot:10.5.0.cl

default : true

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   isUnifiedSearchExperienceEnabled: true,
})

lazyLoadingForFullHeight🔗

lazyLoadingForFullHeight: boolean

Optional

This flag is used to enable the full height lazy load data.

Version : SDK: 1.40.0 | ThoughtSpot:10.12.0.cl

const embed = new AppEmbed('#embed-container', {
   // ...other options
   fullHeight: true,
   lazyLoadingForFullHeight: true,
})

default : false

lazyLoadingMargin🔗

lazyLoadingMargin: string

Optional

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.

Version : SDK: 1.40.0 | ThoughtSpot:10.12.0.cl

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',
})

linkOverride🔗

linkOverride: boolean

Optional

Flag to override the Open Link in New Tab context menu option.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   linkOverride:false,
})

liveboardXLSXCSVDownload🔗

liveboardXLSXCSVDownload: boolean

Optional

This flag is used to enable or disable the XLSX/CSV download option for Liveboards. To enable this feature on your instance, contact ThoughtSpot Support.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.41.0 | ThoughtSpot: 26.3.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   liveboardXLSXCSVDownload: true,
})

locale🔗

locale: string

Optional

The locale settings to apply to the embedded view.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   locale:'en',
})

minimumHeight🔗

minimumHeight: number

Optional

This is the minimum height (in pixels) for a full-height App. Setting this height helps resolve issues with empty Apps and other screens navigable from an App.

Version : SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl

default : 500

const embed = new AppEmbed('#embed', {
  ... // other app view config
  fullHeight: true,
  minimumHeight: 600,
});

modularHomeExperience🔗

modularHomeExperience: boolean

Optional

Enables the V2 navigation and modular home page experience. For more information, see full app embed documentation. Supported embed types: AppEmbed

Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl

default : false

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   modularHomeExperience : true,
})

overrideOrgId🔗

overrideOrgId: number

Optional

Overrides an Org context for embedding application users. This parameter allows a user authenticated to one Org to view the objects from another Org. The overrideOrgId setting is honoured only if the Per Org URL feature is enabled on your ThoughtSpot instance.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
  ... // other embed view config
  overrideOrgId: 142536,
});

pageId🔗

pageId: Page

Optional

The application page to set as the start page in the embedded view.

Use this to open to particular page in the app. To open to a specific path within the app, use the path attribute which is more flexible.

Supported embed types: AppEmbed

Version : SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   pageId : Page.Answers | Page.Data,
})

path🔗

path: string

Optional

A URL path to the embedded application page If both path and pageId attributes are defined, the path definition takes precedence. This is the path post the #/ in the URL of the standalone ThoughtSpot app. Use this to open the embedded view to a specific path.

For eg, if you want the component to open to a specific Liveboard you could set the path to pinboard/<liveboardId>/tab/<tabId>.

Supported embed types: AppEmbed

Version : SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   path:"pinboard/1234/tab/7464",
})

preRenderId🔗

preRenderId: string

Optional

PreRender id to be used for PreRendering the embed. Use PreRender to render the embed in the background and then show or hide the rendered embed using showPreRender or hidePreRender respectively.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
  preRenderId: "preRenderId-123",
});
embed.showPreRender();

primaryAction🔗

primaryAction: string

Optional

The primary action to display on top of the viz for Liveboard and App Embed. Use this to set the primary action.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
  primaryAction: Action.Download
});

reorderedHomepageModules🔗

reorderedHomepageModules: HomepageModule[]

Optional

Reorder home page modules. To specify the modules, import the HomepageModule enum. For example: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist] Note: This attribute is not supported in the classic (v1) homepage.

Supported embed types: AppEmbed

Version : SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw

import { HomepageModule } from '@thoughtspot/visual-embed-sdk';

const embed = new AppEmbed('#tsEmbed', {
   ...//V2/V3 navigation and home page experience attributes
   reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
   //... other embed view configuration attributes
})

runtimeFilters🔗

runtimeFilters: RuntimeFilter[]

Optional

The list of runtime filters to apply to a search Answer, visualization, or Liveboard.

Supported embed types: AppEmbed, LiveboardEmbed, SearchEmbed

Version : SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   runtimeFilters: [
          {
            columnName: 'value',
             operator: RuntimeFilterOp.EQ,
            values: ['string' | 123 | true],
          },
      ],
})

runtimeParameters🔗

runtimeParameters: RuntimeParameter[]

Optional

The list of parameter override to apply to a search Answer, visualization, or Liveboard.

Supported embed types: AppEmbed, LiveboardEmbed, SearchEmbed

Version : SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   runtimeParameters: [
    {
      name: 'value',
      value: 'string' | 123 | true,
    },
  ]
})

showAlerts🔗

showAlerts: boolean

Optional

Show alert messages and toast messages in the embed. Supported embed in all embed types.

Version : SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   showAlerts:true,
})

showLiveboardDescription🔗

showLiveboardDescription: boolean

Optional

Show or hide Liveboard description

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

default : false

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   showLiveboardDescription:true,
})

showLiveboardReverifyBanner🔗

showLiveboardReverifyBanner: boolean

Optional

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

default : true

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   showLiveboardReverifyBanner: true,
})

showLiveboardTitle🔗

showLiveboardTitle: boolean

Optional

Show or hide Liveboard title

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

default : false

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   showLiveboardTitle:true,
})

showLiveboardVerifiedBadge🔗

showLiveboardVerifiedBadge: boolean

Optional

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

default : true

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   showLiveboardVerifiedBadge: true,
})

showMaskedFilterChip🔗

showMaskedFilterChip: boolean

Optional

Show or hide masked filter chips

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.45.0 | Thoughtspot: 26.2.0.cl

default : false

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   showMaskedFilterChip: true,
})

showPrimaryNavbar🔗

showPrimaryNavbar: boolean

Optional

If true, the top navigation bar within the ThoughtSpot app is displayed. By default, the navigation bar is hidden. This flag also controls the homepage left navigation bar.

Supported embed types: AppEmbed

Version : SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl

default : true

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   showPrimaryNavbar:true,
})

tag🔗

tag: string

Optional

This puts a filter tag on the application. All metadata lists in the application, such as Liveboards and answers, would be filtered by this tag.

Supported embed types: AppEmbed

Version : SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   tag:'value',
})

updatedSpotterChatPrompt🔗

updatedSpotterChatPrompt: boolean

Optional

updatedSpotterChatPrompt : Controls the updated spotter chat prompt.

Supported embed types: AppEmbed

Version : SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl

default : false

const embed = new AppEmbed('#tsEmbed', {
   ... //other embed view config
   updatedSpotterChatPrompt : true,
})

visibleActions🔗

visibleActions: Action[]

Optional

The list of actions to display from the primary menu, more menu (…), and the contextual menu. These will be only actions that are visible to the user. Use this to hide all actions except the ones you want to show.

Use either this or hiddenActions.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   visibleActions: [Action.Download, Action.Export],
});