LiveboardViewConfig
10.13.0.cl
Cloud (Latest)
10.12.0.cl
Cloud
10.11.0.cl
Cloud
10.10.0.sw
Software (Latest)
10.1.0.sw
Software

LiveboardViewConfig

The configuration for the embedded Liveboard or visualization page view.

Index🔗

activeTabId

additionalFlags

collapseSearchBar

contextMenuTrigger

coverAndFilterOptionInPDF

customActions

customizations

dataPanelV2

defaultHeight

disableRedirectionLinksInNewTab

disabledActionReason

disabledActions

doNotTrackPreRenderSize

enable2ColumnLayout

enableAskSage

enableCustomColumnGroups

enableV2Shell_experimental

enableVizTransformations

excludeRuntimeFiltersfromURL

excludeRuntimeParametersfromURL

exposeTranslationIDs

frameParams

fullHeight

hiddenActions

hiddenTabs

hideIrrelevantChipsInLiveboardTabs

hideLiveboardHeader

hideTabPanel

insertAsSibling

isLinkParametersEnabled

isLiveboardCompactHeaderEnabled

isLiveboardHeaderSticky

isLiveboardStylingAndGroupingEnabled

isPNGInScheduledEmailsEnabled

lazyLoadingForFullHeight

lazyLoadingMargin

linkOverride

liveboardId

liveboardV2

liveboardXLSXCSVDownload

locale

overrideOrgId

preRenderId

preventLiveboardFilterRemoval

primaryAction

runtimeFilters

runtimeParameters

showAlerts

showLiveboardDescription

showLiveboardReverifyBanner

showLiveboardTitle

showLiveboardVerifiedBadge

showPreviewLoader

showSpotterLimitations

visibleActions

visibleTabs

visibleVizs

vizId

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

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 { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
// Use supported embed types such as AppEmbed or LiveboardEmbed
const embed = new LiveboardEmbed('#tsEmbed', {
  ... // other embed config options
  customActions: [
    {
      name: 'customAction',
      id: 'customAction',
      target: CustomActionTarget.VISUALIZATION,
      position: CustomActionPosition.PRIMARY,
      }
    }
  ]
})

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: SageEmbed, AppEmbed, SearchBarEmbed, LiveboardEmbed, SearchEmbed

Version : SDK: 1.43.0 | 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,
})

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

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.

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

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

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

enableVizTransformations🔗

enableVizTransformations: boolean

Optional

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

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

version: : SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw

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

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1Supported embed types: LiveboardEmbed

const embed = new LiveboardEmbed('#embed', {
  ... // other liveboard 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],
});

hiddenTabs🔗

hiddenTabs: string[]

Optional

The list of tab IDs to hide from the embedded. This Tabs will be hidden from their respective LBs. Use this to hide an tabID.

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

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

isLiveboardStylingAndGroupingEnabled🔗

isLiveboardStylingAndGroupingEnabled: boolean

Optional

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

Supported embed types: LiveboardEmbed, AppEmbed

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

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

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 LiveboardEmbed('#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 LiveboardEmbed('#embed-container', {
   // ...other options
   fullHeight: true,
   lazyLoadingForFullHeight: true,
  // Using 0px, the visualization will be only loaded when its visible in the viewport.
   lazyLoadingMargin: '0px',
})

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

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

liveboardXLSXCSVDownload🔗

liveboardXLSXCSVDownload: boolean

Optional

This flag is used to enable or disable the XLSX/CSV download option for Liveboards.

Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.41.0 | ThoughtSpot: 10.14.0.cl

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

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

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

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

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

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

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

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',
})
© 2025 ThoughtSpot Inc. All Rights Reserved.