LiveboardViewConfig

LiveboardViewConfig

The configuration for the embedded Liveboard or visualization page view.

Index🔗

activeTabId

additionalFlags

collapseSearchBar

contextMenuTrigger

coverAndFilterOptionInPDF

customizations

dataPanelV2

defaultHeight

disableRedirectionLinksInNewTab

disabledActionReason

disabledActions

doNotTrackPreRenderSize

enable2ColumnLayout

enableAskSage

enableCustomColumnGroups

enableV2Shell_experimental

enableVizTransformations

excludeRuntimeFiltersfromURL

excludeRuntimeParametersfromURL

exposeTranslationIDs

frameParams

fullHeight

hiddenActions

hiddenListColumns

hiddenTabs

hideIrrelevantChipsInLiveboardTabs

hideLiveboardHeader

hideTabPanel

insertAsSibling

isLiveboardCompactHeaderEnabled

isLiveboardHeaderSticky

linkOverride

liveboardId

liveboardV2

locale

overrideOrgId

preRenderId

preventLiveboardFilterRemoval

primaryAction

runtimeFilters

runtimeParameters

showAlerts

showLiveboardDescription

showLiveboardReverifyBanner

showLiveboardTitle

showLiveboardVerifiedBadge

showPreviewLoader

visibleActions

visibleTabs

visibleVizs

vizId

Properties🔗

activeTabId🔗

activeTabId: string

Optional

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

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

const embed = new LiveboardEmbed('#tsEmbed', {
   ... // other options
   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.

Index Signature Parameters

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

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

Version : SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl

default : true

const embed = new LiveboardEmbed('#embed', {
  liveboardId: '123',
  collapseSearchBar: true
});

contextMenuTrigger🔗

contextMenuTrigger: ContextMenuTriggerOptions

Optional

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

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

const embed = new LiveboardEmbed('#tsEmbed', {
   ... // other options
   contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
})

coverAndFilterOptionInPDF🔗

coverAndFilterOptionInPDF: boolean

Optional

This flag is for show/hide checkboxes for include or exclude cover page and filters in the Liveboard PDF.

Version : SDK: 1.37.0 | ThoughtSpot:10.8.0.cl

default : true

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

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

Version : SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl

default : false

const embed = new AppEmbed('#tsEmbed', {
   ... // other options
   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.

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.

Version : SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl

const embed = new LiveboardEmbed('#embed', {
  disableRedirectionLinksInNewTab: true
});

disabledActionReason🔗

disabledActionReason: string

Optional

The tooltip to display for disabled actions.

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

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

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

const embed = new LiveboardEmbed('#embed', {
  ... // other liveboard 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 flag is used to enable the 2 column layout on a Liveboard

Version : SDK: 1.32.0 | ThoughtSpot:10.1.0.cl

default : false

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

enableAskSage🔗

enableAskSage: boolean

Optional

enable or disable ask sage

Version : SDK: 1.29.0 | Thoughtspot: 9.12.0.cl

default : false

const embed = new SearchEmbed('#tsEmbed', {
   ... // other options
   enableAskSage:true,
})

enableCustomColumnGroups🔗

enableCustomColumnGroups: boolean

Optional

To enable custom column groups in data panel v2

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

default : false

const embed = new SearchEmbed('#tsEmbed', {
  ... // other options
  enableCustomColumnGroups: true,
});

enableV2Shell_experimental🔗

enableV2Shell_experimental: boolean

Optional

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

Version : SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl

const embed = new LiveboardEmbed('#embed', {
  liveboardId: '123',
  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 options
   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.

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

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

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.

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

const embed = new LiveboardEmbed('#embed', {
  ... // other liveboard view config
  hiddenActions: [Action.Download, Action.Export]
});

hiddenListColumns🔗

hiddenListColumns: ListPageColumns[]

Optional

Hide list page columns For example: hiddenListColumns = [ListPageColumns.Author]

Note: This option is available only in full app embedding.

Version : SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl

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

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.

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

const embed = new LiveboardEmbed('#embed', {
  ... // other liveboard 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 a Liveboard tab

Version : SDK: 1.36.0 | ThoughtSpot:10.6.0.cl

default : false

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

hideLiveboardHeader🔗

hideLiveboardHeader: boolean

Optional

Show or hide the Liveboard header.

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw

default : false

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

hideTabPanel🔗

hideTabPanel: boolean

Optional

Show or hide the tab panel of the embedded Liveboard.

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

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

insertAsSibling🔗

insertAsSibling: boolean

Optional

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

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

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

isLiveboardCompactHeaderEnabled🔗

isLiveboardCompactHeaderEnabled: boolean

Optional

Enables or disables the compact header feature on a Liveboard. Compact Liveboard header is turned off by default on Liveboards in ThoughtSpot Embedded apps.

Version : SDK: 1.35.0 | ThoughtSpot:10.3.0.cl

default : false

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

isLiveboardHeaderSticky🔗

isLiveboardHeaderSticky: boolean

Optional

Control the position and visibility of the Liveboard header as the users scroll down the embedded Liveboard page.

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw

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

linkOverride🔗

linkOverride: boolean

Optional

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

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   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.

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

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   liveboardId:id of liveboard,
})

liveboardV2🔗

liveboardV2: boolean

Optional

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

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

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

locale🔗

locale: string

Optional

The locale settings to apply to the embedded view.

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

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   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.

Version : SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl

const embed = new LiveboardEmbed('#embed', {
  ... // other options
  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.

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

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

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

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   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.

Version : SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl

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

runtimeFilters🔗

runtimeFilters: RuntimeFilter[]

Optional

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

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

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   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.

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

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   runtimeParameters: [
    {
      name: 'value',
      value: 'string' | 123 | true,
    },
  ],
})

showAlerts🔗

showAlerts: boolean

Optional

Show alert messages and toast messages in the embedded view in full app embed.

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

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

showLiveboardDescription🔗

showLiveboardDescription: boolean

Optional

Show or hide the Liveboard description.

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw

default : false

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

showLiveboardReverifyBanner🔗

showLiveboardReverifyBanner: boolean

Optional

This flag is used to show/hide the re-verify banner in Liveboard compact header

Version : SDK: 1.35.0 | ThoughtSpot:10.4.0.cl

default : true

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

showLiveboardTitle🔗

showLiveboardTitle: boolean

Optional

Show or hide the Liveboard title.

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw

default : false

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

showLiveboardVerifiedBadge🔗

showLiveboardVerifiedBadge: boolean

Optional

This flag is used to show/hide verified icon in the Liveboard compact header

Version : SDK: 1.35.0 | ThoughtSpot:10.4.0.cl

default : true

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   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.

Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl

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

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.

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

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

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

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   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.

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

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

vizId🔗

vizId: string

Optional

The visualization within the Liveboard to display.

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

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