LiveboardViewConfig
- Index
- Properties
- activeTabId
- additionalFlags
- contextMenuTrigger
- customizations
- defaultHeight
- disabledActionReason
- disabledActions
- doNotTrackPreRenderSize
- enableVizTransformations
- frameParams
- fullHeight
- hiddenActions
- hiddenTabs
- hideLiveboardHeader
- hideTabPanel
- insertAsSibling
- isLiveboardHeaderSticky
- linkOverride
- liveboardId
- liveboardV2
- locale
- preRenderId
- preventLiveboardFilterRemoval
- runtimeFilters
- runtimeParameters
- showAlerts
- showLiveboardDescription
- showLiveboardTitle
- visibleActions
- visibleTabs
- visibleVizs
- vizId
The configuration for the embedded Liveboard or visualization page view.
Index🔗
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
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. 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
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
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
: ''
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
disabledActionReason🔗
disabledActionReason: string
Optional
The tooltip to display for disabled actions.
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.
const embed = new LiveboardEmbed('#embed', {
... // other liveboard view config
disabledActions: [Action.Download, Action.Save]
});
doNotTrackPreRenderSize🔗
doNotTrackPreRenderSize: boolean
Optional
Determines whether the PreRender component should not dynamically track the size of its embedding element and adjust its own size accordingly. Enabling this option allows the PreRender component to automatically adapt its dimensions based on changes to the size of the embedding element.
default
: false
const config = { doNotTrackPreRenderSize: true, };
const myComponent = new MyComponent(config);
enableVizTransformations🔗
enableVizTransformations: boolean
Optional
Deprecated : If set to true, the context menu in visualizations will be enabled.
frameParams🔗
frameParams: FrameParams
Optional
The <b>width</b> and <b>height</b> dimensions to render an embedded object inside your app. Specify the values in pixels or percentage.
fullHeight🔗
fullHeight: boolean
Optional
If set to true, the embedded object container dynamically resizes according to the height of the Liveboard.
Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
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.
const embed = new LiveboardEmbed('#embed', {
... // other liveboard 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.
Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
const embed = new LiveboardEmbed('#embed', {
... // other liveboard view config
hiddenTabs: [
'430496d6-6903-4601-937e-2c691821af3c',
'f547ec54-2a37-4516-a222-2b06719af726']
});
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
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
insertAsSibling🔗
insertAsSibling: boolean
Optional
Insert as a sibling of the target container, instead of appending to a child inside it.
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 openNew tab context menu link
Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
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
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
locale🔗
locale: string
Optional
/** The locale/language to use for the embedded view.
Version : SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
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
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
runtimeFilters🔗
runtimeFilters: RuntimeFilter[]
Optional
The list of runtime filters to apply to a search answer, visualization, or Liveboard.
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
showAlerts🔗
showAlerts: boolean
Optional
Show alert messages and toast messages in the embedded view.
Version : SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
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
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
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
visibleTabs🔗
visibleTabs: string[]
Optional
The list of tab IDs to show in the embedded. Only this Tabs will be shown in their respective LBs. Use this to show an tabID. Use either this or hiddenTabs.
Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
const embed = new LiveboardEmbed('#embed', {
... // other liveboard 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.
Version : SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
vizId🔗
vizId: string
Optional
The visualization within the Liveboard to display.