LiveboardViewConfig
- Index
- Properties
- 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
- 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
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.
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%',
},
})