LiveboardViewConfig

Table of Contents

Index
Properties

The configuration for the embedded Liveboard or visualization page view.

Index🔗

coverAndFilterOptionInPDF

disableRedirectionLinksInNewTab

disabledActionReason

disabledActions

doNotTrackPreRenderSize

enable2ColumnLayout

enableAskSage

enableCustomColumnGroups

enableLinkOverridesV2

enableLiveboardDataCache

enableScrollableContainerLazyLoading

enableStopAnswerGenerationEmbed

enableV2Shell_experimental

enableVizTransformations

excludeRuntimeFiltersfromURL

excludeRuntimeParametersfromURL

hideIrrelevantChipsInLiveboardTabs

isCentralizedLiveboardFilterUXEnabled

isContinuousLiveboardPDFEnabled

isEnhancedFilterInteractivityEnabled

isGranularXLSXCSVSchedulesEnabled

isLinkParametersEnabled

isLiveboardAlwaysOn12ColLayout

isLiveboardCompactHeaderEnabled

isLiveboardHeaderSticky

isLiveboardMasterpiecesEnabled

isLiveboardStylingAndGroupingEnabled

isLiveboardXLSXCSVDownloadEnabled

isOnBeforeGetVizDataInterceptEnabled

isPNGInScheduledEmailsEnabled

isScopedLiveboardFilteringEnabled

isThisPeriodInDateFiltersEnabled

lazyLoadingForFullHeight

preventLiveboardFilterRemoval

primaryAction

refreshAuthTokenOnNearExpiry

runtimeFilters

runtimeParameters

shouldBypassPayloadValidation

showAlerts

showLiveboardDescription

showLiveboardReverifyBanner

showLiveboardTitle

showLiveboardVerifiedBadge

showMaskedFilterChip

showPreviewLoader

showSpotterLimitations

showSpotterRadiance

spotterChatConfig

spotterViz

updatedSpotterChatPrompt

updatedSpotterExperience

Properties🔗

activeTabId🔗

activeTabId: string

Optional

Set a Liveboard tab as an active tab. Specify the tab ID.

Supported embed types: LiveboardEmbed

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw

const embed = new LiveboardEmbed('#tsEmbed', {
   ... //other embed view config
   activeTabId:'id-1234',
})

additionalFlags🔗

additionalFlags: {[key: string ] : string | number | boolean}

Optional

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 overridden 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, 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: AppEmbed, SearchBarEmbed

Version : SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl

default : true

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

contextMenuTrigger🔗

contextMenuTrigger: ContextMenuTriggerOptions

Optional

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

Supported embed types: AppEmbed, SearchEmbed

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, 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, SearchEmbed, SpotterEmbed

Version : SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl

import {
  CustomActionPayload,
  CustomActionsPosition,
  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: [
    {
      // Unique identifier for the custom action
      id: 'my-custom-action',

      // Display name shown to users in the UI
      name: 'My Custom Action',

      // Where the action appears in the UI
      // PRIMARY: Shows as a primary button (e.g., in the toolbar)
      // MENU: Shows in the "More" menu (three dots menu)
      // CONTEXTMENU: Shows in the right-click context menu
      position: CustomActionsPosition.PRIMARY,

      // What type of content this action applies to
      // ANSWER: Available on answer pages
      target: CustomActionTarget.ANSWER,

      // Optional: Restrict where this action appears based on data models
      // dataModelIds: {
      //     // Restrict to specific data models
      //     modelIds: ['model-id-1', 'model-id-2'],
      //     // Restrict to specific columns within models
      //     modelColumnNames: ['model-id::column-name']
      // },

      // Optional: Restrict where this action appears based on metadata
      // metadataIds: {
      //     // Restrict to specific answers
      //     answerIds: ['answer-id-1', 'answer-id-2'],
      // },
      //     // Restrict to specific groups (for group-based access control)
      //     groupIds: ['group-id-1', 'group-id-2'],
      //     // Restrict to specific organizations (for multi-org deployments)
      //     orgIds: ['org-id-1', 'org-id-2'],
    }
  ],
})

// 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);
})

import {
  CustomActionsPosition,
  CustomActionTarget,
} from '@thoughtspot/visual-embed-sdk';
const embed = new LiveboardEmbed('#tsEmbed', {
  ... // other embed config options
  customActions: [
    {
      // Unique identifier for the custom action
      id: 'my-custom-action',

      // Display name shown to users in the UI
      name: 'My Custom Action',

      // Where the action appears in the UI
      // MENU: Shows in the "More" menu (three dots menu)
      // CONTEXTMENU: Shows in the right-click context menu
      position: CustomActionsPosition.MENU,

      // What type of content this action applies to
      // SPOTTER: Available in Spotter (AI-powered search)
      target: CustomActionTarget.SPOTTER,

      // Optional: Restrict where this action appears based on data models
      // dataModelIds: {
      //     // Restrict to specific data models
      //     modelIds: ['model-id-1', 'model-id-2'],
      // },
      //     // Restrict to specific groups (for group-based access control)
      //     groupIds: ['group-id-1'],
      //     // Restrict to specific organizations (for multi-org deployments)
      //     orgIds: ['org-id-1'],
    }
  ],
})

import {
  CustomActionsPosition,
  CustomActionTarget,
} from '@thoughtspot/visual-embed-sdk';
const embed = new LiveboardEmbed('#tsEmbed', {
  ... // other embed config options
  customActions: [
    {
      // Unique identifier for the custom action
      id: 'my-liveboard-custom-action',

      // Display name shown to users in the UI
      name: 'My Liveboard Custom Action',

      // Where the action appears in the UI
      // PRIMARY: Shows as a primary button (e.g., in the toolbar)
      // MENU: Shows in the "More" menu (three dots menu)
      position: CustomActionsPosition.PRIMARY,

      // What type of content this action applies to
      // LIVEBOARD: Available on liveboard pages
      target: CustomActionTarget.LIVEBOARD,

      // Optional: Restrict where this action appears based on metadata
      // metadataIds: {
      //     // Restrict to specific liveboards
      //     liveboardIds: ['liveboard-id-1', 'liveboard-id-2'],
      // },
      //     // Restrict to specific groups (for group-based access control)
      //     groupIds: ['group-id-1', 'group-id-2'],
      //     // Restrict to specific organizations (for multi-org deployments)
      //     orgIds: ['org-id-1', 'org-id-2'],
    },
    {
      // Unique identifier for the custom action
      id: 'my-viz-custom-action',

      // Display name shown to users in the UI
      name: 'My Viz Custom Action',

      // Where the action appears in the UI
      // PRIMARY: Shows as a primary button (e.g., in the toolbar)
      // MENU: Shows in the "More" menu (three dots menu)
      // CONTEXTMENU: Shows in the right-click context menu
      position: CustomActionsPosition.PRIMARY,

      // What type of content this action applies to
      // VIZ: Available on individual visualizations
      target: CustomActionTarget.VIZ,

      // Optional: Restrict where this action appears based on metadata
      // metadataIds: {
      //     // Restrict to specific answers
      //     answerIds: ['answer-id-1', 'answer-id-2'],
      //     // Restrict to specific liveboard. If liveboardId is
      //     // passed, custom actions will appear on all vizzes of liveboard
      //     liveboardIds: ['liveboard-id-1'],
      //     // Restrict to specific vizIds
      //     vizIds: ['viz-id-1']
      // },
      // dataModelIds: {
      //     // Restrict to specific data models
      //     modelIds: ['model-id-1', 'model-id-2'],
      //     // Restrict to specific columns within models
      //     modelColumnNames: ['model-id::column-name']
      // },
      //     // Restrict to specific groups (for group-based access control)
      //     groupIds: ['group-id-1', 'group-id-2'],
      //     // Restrict to specific organizations (for multi-org deployments)
      //     orgIds: ['org-id-1', 'org-id-2'],
    }
  ],
})

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 : ''

dataPanelV2🔗

dataPanelV2: boolean

Optional

Flag to control Data panel experience

Supported embed types: AppEmbed, SearchBarEmbed, LiveboardEmbed, SearchEmbed

Deprecated : from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl

default : true

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

defaultHeight🔗

defaultHeight: number

Optional

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

Supported embed types: LiveboardEmbed

Version : SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1

Deprecated : Use minimumHeight instead.

default : 500

const embed = new LiveboardEmbed('#embed', {
  ... // other liveboard view config
  fullHeight: true,
  defaultHeight: 600,
});

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.

Note: When set to true, this flag automatically disables SpotterEmbedViewConfig.enableLinkOverridesV2 for the embed session. The two features are mutually exclusive — link overrides mutate anchors (delete href, attach a JS click handler), which breaks native browser behavior (Cmd/Ctrl+Click, middle-click, right-click "Open in new tab") when combined with the disable flag. The disable flag preserves native anchor semantics instead.

Supported embed types: AppEmbed, LiveboardEmbed, 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, 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. Disabled actions are grayed out and still visible to the user, but cannot be clicked. Use this when you want to disable an action (keep it visible but non-interactive). To completely remove an action from the UI, use SpotterEmbedViewConfig.hiddenActions instead.

Supported embed types: AppEmbed, LiveboardEmbed, 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],
});

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

Deprecated : Use {@link PreRenderConfig.doNotTrackSize} via preRenderConfig instead.

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: 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, SearchBarEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
  ... // other embed view config
  enableCustomColumnGroups: true,
});

enableLinkOverridesV2🔗

enableLinkOverridesV2: boolean

Optional

Enables the V2 link override mechanism with improved handling. When enabled, navigation links within the embedded ThoughtSpot app are intercepted and routed through the SDK via the EmbedEvent.DialogOpen event.

The SDK automatically sends SpotterEmbedViewConfig.linkOverride alongside this flag for backward compatibility with older ThoughtSpot versions.

Note: This flag is ignored when SpotterEmbedViewConfig.disableRedirectionLinksInNewTab is true.

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

Version : SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl

const embed = new LiveboardEmbed('#tsEmbed', {
   ... // other embed view config
   enableLinkOverridesV2: true,
});

embed.on(EmbedEvent.DialogOpen, (payload) => {
   console.log('Link clicked:', payload);
});

enableLiveboardDataCache🔗

enableLiveboardDataCache: boolean

Optional

If set to true, enables visualization data caching on the Liveboard.

Version : SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   enableLiveboardDataCache: true,
})

enableScrollableContainerLazyLoading🔗

enableScrollableContainerLazyLoading: boolean

Optional

Computes the visible region of the embed against its scrollable and clipping ancestors, instead of treating the browser window as the only viewport, and tracks scroll and resize on those ancestors.

From SDK 1.52.0 this is enabled automatically whenever fullHeight is true. On SDK 1.51.0 and earlier it defaulted to false and had to be set explicitly. Set it to false when the page scrolls with the window and the embed has no clipping ancestor, to skip the extra ancestor tracking.

default : true when fullHeight is enabled, from SDK 1.52.0

enableStopAnswerGenerationEmbed🔗

enableStopAnswerGenerationEmbed: boolean

Optional

Enables the stop answer generation button in the Spotter embed UI, allowing users to interrupt an ongoing answer generation.

Supported embed types: LiveboardEmbed

Version : SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl

default : false

enableV2Shell_experimental🔗

enableV2Shell_experimental: boolean

Optional

Enable the V2 shell. This can provide performance benefits due to a lighter-weight shell.

Supported embed types: AppEmbed, LiveboardEmbed, 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,
});

enableVizTransformations🔗

enableVizTransformations: boolean

Optional

If set to true, the context menu in visualizations will be enabled.

Version : SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw

Deprecated : this option is deprecated.

const embed = new LiveboardEmbed('#tsEmbed', {
   ... //other embed view config
   enableVizTransformations: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 (default behavior from SDK 1.45.0). when set to false, runtime filters will be included in the URL (default behavior before SDK 1.45.0).

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 : true

excludeRuntimeParametersfromURL🔗

excludeRuntimeParametersfromURL: boolean

Optional

Boolean to exclude runtimeParameters from the URL when set to true, this flag removes runtime parameters from the URL (default behavior from SDK 1.45.0). when set to false, runtime parameters will be included in the URL (default behavior before SDK 1.45.0).

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

Version : SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl

default : true

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, 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 embedded object 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.

From SDK 1.52.0, enabling fullHeight also turns on LiveboardViewConfig.lazyLoadingForFullHeight and LiveboardViewConfig.enableScrollableContainerLazyLoading, so visualizations load as they scroll into view. Set either flag to false to opt out.

Supported embed types: LiveboardEmbed

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

const embed = new LiveboardEmbed('#embed', {
  ... // other liveboard view config
 fullHeight: true,
});

hiddenActions🔗

hiddenActions: Action[]

Optional

The list of actions to completely remove from the embedded view. Hidden actions are not visible to the user at all (fully removed from the UI). Use this when you want to remove an action entirely. To keep an action visible but non-interactive (grayed out), use SpotterEmbedViewConfig.disabledActions instead.

Supported embed types: AppEmbed, LiveboardEmbed, 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.ExportTML],
});

hiddenTabs🔗

hiddenTabs: string[]

Optional

The list of tab IDs to hide from the embedded Liveboard. These tabs will be hidden from their respective Liveboards. Use this to hide a tab ID.

Supported embed types: LiveboardEmbed

Version : SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw

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

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

hideTabPanel🔗

hideTabPanel: boolean

Optional

Show or hide the tab panel of the embedded Liveboard.

Supported embed types: LiveboardEmbed

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

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

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, 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

How long, in milliseconds, an intercepted request waits for the EmbedEvent.ApiIntercept responder before it is abandoned. Defaults to 30000. On timeout the request fails and EmbedEvent.Error is emitted.

Version : SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl

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

interceptUrls🔗

interceptUrls: string[]

Optional

The requests to intercept, given as InterceptedApiType groups, absolute URLs, or paths beginning with / that are resolved against the ThoughtSpot host. Setting this is what turns interception on.

A URL matches only on exact equality with the request’s fully resolved URL, query string included, so prefer an InterceptedApiType group where one covers the API you need.

Each intercepted request pauses and emits EmbedEvent.ApiIntercept, then proceeds according to the response passed to that event’s responder.

Version : SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl

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

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.46.0 | ThoughtSpot: 26.4.0.cl

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

isContinuousLiveboardPDFEnabled🔗

isContinuousLiveboardPDFEnabled: boolean

Optional

Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page following the exact UI layout, instead of splitting visualizations across multiple A4 pages. This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl

default : true

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isContinuousLiveboardPDFEnabled: 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,
})

isGranularXLSXCSVSchedulesEnabled🔗

isGranularXLSXCSVSchedulesEnabled: boolean

Optional

This flag is used to enable/disable the granular XLSX/CSV schedules feature This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl

default : true

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isGranularXLSXCSVSchedulesEnabled: 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,
})

isLiveboardAlwaysOn12ColLayout🔗

isLiveboardAlwaysOn12ColLayout: boolean

Optional

This attribute keeps an embedded Liveboard on the 12-column layout at every width, instead of switching to the two-column or single-column layout as the container narrows.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl

default : false

// Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isLiveboardAlwaysOn12ColLayout: 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. Use LiveboardViewConfig.isLiveboardMasterpiecesEnabled instead.

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl

Deprecated : This flag is deprecated.Supported embed types: LiveboardEmbed, AppEmbed

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

isLiveboardXLSXCSVDownloadEnabled🔗

isLiveboardXLSXCSVDownloadEnabled: boolean

Optional

This flag is used to enable/disable the XLSX/CSV download option for Liveboards This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl

default : true

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

isOnBeforeGetVizDataInterceptEnabled🔗

isOnBeforeGetVizDataInterceptEnabled: boolean

Optional

Emits EmbedEvent.OnBeforeGetVizDataIntercept before the Answer data APIs are called. This is the earlier, narrower form of interception, kept for backward compatibility and implemented on top of EmbedEvent.ApiIntercept. Prefer interceptUrls with InterceptedApiType.AnswerData in new code.

Setting this also intercepts the Answer data APIs, so both EmbedEvent.OnBeforeGetVizDataIntercept and EmbedEvent.ApiIntercept are emitted for those requests.

Can be used for Search 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,
})

isScopedLiveboardFilteringEnabled🔗

isScopedLiveboardFilteringEnabled: boolean

Optional

This flag is used to enable or disable scoped Liveboard filtering. When enabled, filters and parameters can be scoped to a group of visualizations on a Liveboard, in addition to the Liveboard and tab levels.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl

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

isThisPeriodInDateFiltersEnabled🔗

isThisPeriodInDateFiltersEnabled: boolean

Optional

To enable Include current period checkbox for date filters. Controls the visibility of the option to include the current time period in filter results.

Supported embed types: AppEmbed, SearchBarEmbed, LiveboardEmbed, SearchEmbed

Version : SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl

const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   isThisPeriodInDateFiltersEnabled: true,
})

lazyLoadingForFullHeight🔗

lazyLoadingForFullHeight: boolean

Optional

Loads visualizations only as they scroll into the viewport, instead of loading the whole full-height Liveboard at once.

From SDK 1.52.0 this is enabled automatically whenever fullHeight is true. On SDK 1.51.0 and earlier it defaulted to false and had to be set explicitly. Set it to false to load every visualization upfront. The flag has no effect unless fullHeight is enabled.

Version : SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl

default : true when fullHeight is enabled, from SDK 1.52.0

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

lazyLoadingMargin🔗

lazyLoadingMargin: string

Optional

How far outside the viewport a visualization starts loading, when LiveboardViewConfig.lazyLoadingForFullHeight is enabled.

For example, if the margin is set to '10px', the visualization will be loaded 10px before its top edge is visible in the viewport.

The format is similar to CSS margin, so '500px 0px' extends the prefetch 500px above and below the viewport and not sideways. Accepted units are px, em, rem, %, vh and vw, plus bare 0 and auto; an invalid value is logged and ignored.

From SDK 1.52.0 this defaults to '500px 0px' — roughly one visualization ahead of the scroll position, so a chart has usually finished loading by the time it scrolls into view. Use a smaller margin to cut warehouse queries further, or '0px' to load a visualization only once it is actually visible.

Version : SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl

default : '500px 0px' when fullHeight is enabled, from SDK 1.52.0

const embed = new LiveboardEmbed('#embed-container', {
   // ...other options
   fullHeight: true,
   lazyLoadingForFullHeight: true,
  // Using 0px, the visualization will be only loaded when it's visible in the viewport.
   lazyLoadingMargin: '0px',
})

linkOverride🔗

linkOverride: boolean

Optional

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

Note: Setting this flag implicitly enables SpotterEmbedViewConfig.enableLinkOverridesV2. V1 is auto-upgraded to V2 to ensure consistent link-override behavior; the legacy V1-only path is no longer used in isolation.

Note: This flag is ignored when SpotterEmbedViewConfig.disableRedirectionLinksInNewTab is true.

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

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

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

liveboardGutter🔗

liveboardGutter: number

Optional

Sets the gutter space (in pixels) between the visualization tiles of an embedded Liveboard grid layout and its outer layout padding. Accepts a non-negative integer; 0 renders the tiles without any gap and removes the outer padding. When omitted, the gutter saved in the Liveboard’s styling settings (or the ThoughtSpot default) applies.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl

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

liveboardId🔗

liveboardId: string

Optional

The Liveboard to display in the embedded view. Use either liveboardId or pinboardId to reference the Liveboard to embed.

Supported embed types: LiveboardEmbed

Version : SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1

const embed = new LiveboardEmbed('#tsEmbed', {
   ... //other embed view config
   liveboardId:'id of liveboard',
})

liveboardV2🔗

liveboardV2: boolean

Optional

Render embedded Liveboards and visualizations in the new Liveboard experience mode.

Supported embed types: LiveboardEmbed

Version : SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw

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

locale🔗

locale: string

Optional

The locale settings to apply to the embedded view.

Supported embed types: AppEmbed, LiveboardEmbed, 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 Liveboard. Setting this height helps resolve issues with empty Liveboards and other screens navigable from a Liveboard.

Version : SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl

default : 500

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

newChartsLibrary🔗

newChartsLibrary: boolean

Optional

Enable or disable Muze chart phase 1 GA

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.49.0 | ThoughtSpot Cloud: 26.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
   newChartsLibrary: true,
})

overrideHistoryState🔗

overrideHistoryState: boolean

Optional

Overrides the browser history behavior for embedding application users. This parameter changes standard history navigation (pushState) into a state replacement (replaceState), preventing users from getting trapped in back-button loops inside the embedded iframe environment. The overrideHistoryState setting is honored only if the application is running within an embedded context.

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

Version : SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
    // ... other embed view config
    overrideHistoryState: 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, 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,
});

personalizedViewId🔗

personalizedViewId: string

Optional

The GUID of a saved personalized view to load. A personalized view is a saved configuration of a Liveboard that includes specific filter selections.

Supported embed types: LiveboardEmbed

Version : SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl

const embed = new LiveboardEmbed('#tsEmbed', {
   liveboardId: 'liveboard-guid',
   personalizedViewId: 'view-guid',
   activeTabId: 'tab-guid',
})

preRenderConfig🔗

preRenderConfig: PreRenderConfig

Optional

Configuration for the pre-render wrapper element. Each property here supersedes its deprecated top-level counterpart on BaseViewConfig — id over preRenderId, containerSelector over preRenderContainer and doNotTrackSize over doNotTrackPreRenderSize — and takes precedence when both are set, so existing top-level usage continues to work without any changes. See PreRenderConfig for available options.

Version : SDK: 1.52.0

const embed = new LiveboardEmbed('#tsEmbed', {
  preRenderConfig: {
    id: 'my-liveboard',
    zIndex: -10,
  },
});
embed.preRender();
embed.showPreRender();

preRenderContainer🔗

preRenderContainer: string | HTMLElement

Optional

The DOM element or CSS selector string specifying the container into which the pre-rendered wrapper is inserted. Defaults to document.body when not specified.

When to use a target container: set this when the pre-render should live somewhere other than document.body — for example when <body> has overflow: hidden and scrolling is handled by an inner element, or when you need the wrapper to sit inside a specific stacking/positioning context. The wrapper is positioned to track the embedding element within this container, so choose the scrollable/positioned ancestor you want it aligned to.

Pass a stable container: the wrapper is mounted into the resolved container once, during preRender(). The container must stay mounted for the lifetime of the pre-render — if the host app unmounts and remounts it (for example React replacing the node), the wrapper is orphaned on the detached node. Mount the container above the part of the tree that re-renders so its identity is stable. Prefer a CSS selector string over a raw element: a selector can be re-resolved to the fresh node on the next reposition, whereas an element reference cannot be recovered once detached.

When the embed host lives inside a Shadow DOM, a selector string is resolved against that shadow root as well (since document.querySelector cannot pierce shadow boundaries); pass the element directly if the container lives in a different root.

Version : SDK: 1.49.2 | ThoughtSpot: *

Deprecated : Use {@link PreRenderConfig.containerSelector} via preRenderConfig instead.

const embed = new LiveboardEmbed('#tsEmbed', {
  preRenderId: 'my-liveboard',
  // Prefer a selector for a stable, scrollable container.
  preRenderContainer: '#my-scroll-container',
});

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, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

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

Deprecated : Use {@link PreRenderConfig.id} via preRenderConfig instead.

// 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();

preventLiveboardFilterRemoval🔗

preventLiveboardFilterRemoval: boolean

Optional

If set to true, all filter chips from a Liveboard page will be read-only (no X buttons)

Supported embed types: LiveboardEmbed

Version : SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw

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

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
});

refreshAuthTokenOnNearExpiry🔗

refreshAuthTokenOnNearExpiry: boolean

Optional

Refresh the auth token when the token is near expiry.

Version : SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl

default : true

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

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 overrides 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,
    },
  ]
})

shouldBypassPayloadValidation🔗

shouldBypassPayloadValidation: boolean

Optional

This flag skips payload validation so events can be processed even if the payload is old, incomplete, or from a trusted system.

Version : SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl

default : false

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

showAlerts🔗

showAlerts: boolean

Optional

Show alert messages and toast messages in the embed. Supported 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,
})

showPreviewLoader🔗

showPreviewLoader: boolean

Optional

Show a preview image of the visualization before the visualization loads. Only works for visualizations embeds with a viz id.

Also, viz snapshot should be enabled in the ThoughtSpot instance. Contact ThoughtSpot support to enable this feature.

Since this will show preview images, be careful that it may show undesired data to the user when using row level security.

Supported embed types: LiveboardEmbed

Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl

const embed = new LiveboardEmbed('#tsEmbed', {
  liveboardId: 'liveboard-id',
  vizId: 'viz-id',
  showPreviewLoader: true,
});
embed.render();

showSpotterLimitations🔗

showSpotterLimitations: boolean

Optional

showSpotterLimitations : show limitation text of the spotter underneath the chat input. default is false.

Version : SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl

const embed = new LiveboardEmbed('#embed-container', {
   // ...other options
   showSpotterLimitations: true,
})

showSpotterRadiance🔗

showSpotterRadiance: boolean

Optional

showSpotterRadiance : Controls the radiance on the Spotter page.

Supported embed types: LiveboardEmbed

Version : SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl

default : false

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

spotterChatConfig🔗

spotterChatConfig: SpotterChatViewConfig

Optional

Configuration for customizing Spotter chat UI branding in tool response cards.

Supported embed types: LiveboardEmbed

Version : SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl

const embed = new LiveboardEmbed('#tsEmbed', {
   ... //other embed view config
   spotterChatConfig: {
       hideToolResponseCardBranding: true,
       toolResponseCardBrandingLabel: 'MyBrand',
   },
})

spotterViz🔗

spotterViz: SpotterVizConfig

Optional

Configuration for the SpotterViz interface shown on the Liveboard. Customize the brand name, description, chat input placeholder, starter prompts, and visibility of starter prompts in the SpotterViz panel.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   spotterViz: {
       brandName: 'MyBrand',
       brandHeadline: 'Hi, there! I\'m',
       description: 'Ask questions about your data',
       inputChatPlaceholder: 'Ask a question...',
       hideStarterPrompts: false,
       customStarterPrompts: [{ id: '1', displayText: 'Top products', fullPrompt: 'What are the top products by revenue?' }],
       // The options below require SDK: 1.51.0
       loaderHeadline: 'Crunching the numbers...',
       loaderTips: [
           { label: 'Tip', text: 'try asking about revenue by region' },
           { label: 'Tip', text: 'use natural language' },
       ],
       liveboardBrandName: 'Reports',
       spotterBrandName: 'Analyst',
       insightTileBrandName: 'Insight card',
       insightTileViewPlanLabel: 'View plan',
       insightTileLoaderText: 'Generating insight',
   },
})

updatedSpotterChatPrompt🔗

updatedSpotterChatPrompt: boolean

Optional

updatedSpotterChatPrompt : Controls the updated spotter chat prompt.

Supported embed types: LiveboardEmbed

Version : SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl

default : false

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

updatedSpotterExperience🔗

updatedSpotterExperience: boolean

Optional

updatedSpotterExperience : Controls the updated Spotter experience.

Supported embed types: LiveboardEmbed

Version : SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl

default : false

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

useHostEventsV2🔗

useHostEventsV2: boolean

Optional

Flag to use host events v2. This is used to enable the new host events v2 API.

Version : SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl

default : false

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   useHostEventsV2: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 as an allowlist — only the actions listed here will be shown. All other actions will be hidden. Use either this or SpotterEmbedViewConfig.hiddenActions, not both.

Supported embed types: AppEmbed, LiveboardEmbed, 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.ExportTML],
});

visibleTabs🔗

visibleTabs: string[]

Optional

The list of tab IDs to show in the embedded Liveboard. Only the tabs specified in the array will be shown in the Liveboard.

Use either visibleTabs or hiddenTabs.

Supported embed types: LiveboardEmbed

Version : SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw

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

visibleVizs🔗

visibleVizs: string[]

Optional

Array of visualization IDs which should be visible when the Liveboard renders. This can be changed by triggering the SetVisibleVizs event.

Supported embed types: LiveboardEmbed

Version : SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw

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

vizId🔗

vizId: string

Optional

The visualization within the Liveboard to display.

Supported embed types: LiveboardEmbed

Version : SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw

const embed = new LiveboardEmbed('#tsEmbed', {
   ... //other embed view config
   vizId:'430496d6-6903-4601-937e-2c691821af3c',
})