AppViewConfig
- Index
- Properties
- additionalFlags
- collapseSearchBar
- collapseSearchBarInitially
- contextMenuTrigger
- coverAndFilterOptionInPDF
- customizations
- dataPanelCustomGroupsAccordionInitialState
- dataPanelV2
- disableProfileAndHelp
- disableRedirectionLinksInNewTab
- disabledActionReason
- disabledActions
- discoveryExperience
- doNotTrackPreRenderSize
- enable2ColumnLayout
- enableAskSage
- enableCustomColumnGroups
- enablePendoHelp
- enableSearchAssist
- enableV2Shell_experimental
- excludeRuntimeFiltersfromURL
- excludeRuntimeParametersfromURL
- exposeTranslationIDs
- frameParams
- fullHeight
- hiddenActions
- hiddenHomeLeftNavItems
- hiddenHomepageModules
- hiddenListColumns
- hideApplicationSwitcher
- hideHamburger
- hideHomepageLeftNav
- hideIrrelevantChipsInLiveboardTabs
- hideLiveboardHeader
- hideNotification
- hideObjectSearch
- hideObjects
- hideOrgSwitcher
- homePageSearchBarMode
- insertAsSibling
- isLiveboardCompactHeaderEnabled
- isLiveboardHeaderSticky
- isLiveboardStylingAndGroupingEnabled
- isOnBeforeGetVizDataInterceptEnabled
- isUnifiedSearchExperienceEnabled
- linkOverride
- locale
- modularHomeExperience
- overrideOrgId
- pageId
- path
- preRenderId
- primaryAction
- reorderedHomepageModules
- runtimeFilters
- runtimeParameters
- showAlerts
- showLiveboardDescription
- showLiveboardReverifyBanner
- showLiveboardTitle
- showLiveboardVerifiedBadge
- showPrimaryNavbar
- tag
- visibleActions
The view configuration for full app embedding.
Indexπ
Propertiesπ
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,
});
collapseSearchBarInitiallyπ
collapseSearchBarInitially: boolean
Optional
To set the initial state of the search bar in case of saved-answers.
Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
Deprecated : Use {@link collapseSearchBar} instead
default
: false
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,
})
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
: ''
dataPanelCustomGroupsAccordionInitialStateπ
dataPanelCustomGroupsAccordionInitialState: DataPanelCustomColumnGroupsAccordionState
Optional
This controls the initial behaviour of custom column groups accordion. It takes DataPanelCustomColumnGroupsAccordionState enum values as input. List of different enum values:- - EXPAND_ALL: Expand all the accordion initially in data panel v2. - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2. - EXPAND_FIRST: Expand the first accordion and collapse the rest.
Supported embed types: AppEmbed
Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
default
: DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
const embed = new AppEmbed('#embed', {
... // other app view config
dataPanelCustomGroupsAccordionInitialState:
DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
});
dataPanelV2π
dataPanelV2: boolean
Optional
Flag to control Data panel experience
Supported embed types: SageEmbed
, AppEmbed
, SearchBarEmbed
, LiveboardEmbed
, SearchEmbed
Version : SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
default
: false
// Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
... // other embed view config
dataPanelV2: true,
})
disableProfileAndHelpπ
disableProfileAndHelp: boolean
Optional
Control the visibility of the help (?) and profile buttons on the Global nav-bar. By default, these buttons are visible on the nav-bar.
Supported embed types: AppEmbed
Version : SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
default
: false
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
disableProfileAndHelp: true,
})
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],
});
discoveryExperienceπ
discoveryExperience: DiscoveryExperience
Optional
To configure the top-left navigation and home page experience
Supported embed types: AppEmbed
Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
default
: false
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
discoveryExperience : {
primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
homePage: HomePage.Modular,
},
})
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,
});
enablePendoHelpπ
enablePendoHelp: boolean
Optional
Version : SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
default
: true
Whether the help menu in the top nav bar should be served
from Pendo or ThoughtSpotβs internal help items.
Supported embed types: AppEmbed
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
enablePendoHelp: false,
});
enableSearchAssistπ
enableSearchAssist: boolean
Optional
If set to true, the Search Assist feature is enabled.
Supported embed types: AppEmbed
Version : SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
default
: true
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
enableSearchAssist: 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,
});
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 Liveboard 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.
Supported embed types: AppEmbed
Version : SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
const embed = new AppEmbed('#tsEmbed', {
... // other embed 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],
});
hiddenHomeLeftNavItemsπ
hiddenHomeLeftNavItems: HomeLeftNavItem[]
Optional
homepageLeftNavItems : Show or hide the left navigation bar items. There are 8 eight home navigation list items. To hide these items, specify the string in the array.
Supported embed types: AppEmbed
Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
const embed = new AppEmbed('#tsEmbed', {
... //other embed view config
hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
})
Note: This option does not apply to the classic homepage.
To access the updated modular homepage, set
modularHomeExperience
to true
(available as Early Access feature in 9.12.5.cl).
hiddenHomepageModulesπ
hiddenHomepageModules: HomepageModule[]
Optional
Hide the home page modules For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
Note: This option does not apply to the classic homepage.
To access the updated modular homepage, set
modularHomeExperience
to true
(available as Early Access feature in 9.12.5.cl).
Supported embed types: AppEmbed
Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
const embed = new AppEmbed('#tsEmbed', {
... //other embed view config
hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
})
hiddenListColumnsπ
hiddenListColumns: ListPageColumns[]
Optional
Hide list page columns For example: hiddenListColumns = [ListPageColumns.Author]
Note: This option is available only in full app embedding.
Supported embed types: AppEmbed
Version : SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
const embed = new AppEmbed('#tsEmbed', {
... //other embed view config
hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
})
hideApplicationSwitcherπ
hideApplicationSwitcher: boolean
Optional
Control the visibility of the application switcher button on the nav-bar. By default, the application switcher is shown.
Note: This option does not apply to the classic homepage.
To access the updated modular homepage, set
modularHomeExperience
to true
(available as Early Access feature in 9.12.5.cl).
Supported embed types: AppEmbed
Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
default
: false
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
hideApplicationSwitcher : true,
})
hideHamburgerπ
hideHamburger: boolean
Optional
Control the visibility of the hamburger icon on the top nav bar available when new navigation V3 is enabled.
Supported embed types: AppEmbed
Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
default
: false
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
hideHamburger : true,
})
hideHomepageLeftNavπ
hideHomepageLeftNav: boolean
Optional
Control the visibility of the left navigation bar on the Homepage. If showPrimaryNavbar is true, that is, if the Global and Homepage nav-bars are visible, this flag will only hide the homepage left nav-bar. The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
Note: This option does not apply to the classic homepage.
To access the updated modular homepage, set
modularHomeExperience
to true
(available as Early Access feature in 9.12.5.cl).
Supported embed types: AppEmbed
Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
default
: false
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
hideHomepageLeftNav : true,
})
hideIrrelevantChipsInLiveboardTabsπ
hideIrrelevantChipsInLiveboardTabs: boolean
Optional
This flag is used to enable/disable hide irrelevant filters in Liveboard tab
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,
})
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,
})
hideNotificationπ
hideNotification: boolean
Optional
Control the visibility of the notification on the top nav bar V3, available when new navigation V3 is enabled.
Supported embed types: AppEmbed
Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
default
: true
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
hideNotification: false,
})
hideObjectSearchπ
hideObjectSearch: boolean
Optional
Control the visibility of the Eureka search on the top nav bar this will control for both new V2 and new navigation V3.
Supported embed types: AppEmbed
Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
default
: true
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
hideObjectSearch: false,
})
hideObjectsπ
hideObjects: string[]
Optional
The array of GUIDs to be hidden
Supported embed types: AppEmbed
Version : SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
hideObjects: [
'430496d6-6903-4601-937e-2c691821af3c',
'f547ec54-2a37-4516-a222-2b06719af726'
]
})
hideOrgSwitcherπ
hideOrgSwitcher: boolean
Optional
Control the visibility of the Org switcher button on the nav-bar. By default, the Org switcher button is shown.
Note: This option does not apply to the classic homepage.
To access the updated modular homepage, set
modularHomeExperience
to true
(available as Early Access feature in 9.12.5.cl).
Supported embed types: AppEmbed
Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
default
: true
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
hideOrgSwitcher : true,
})
homePageSearchBarModeπ
homePageSearchBarMode: HomePageSearchBarMode
Optional
Flag to use home page search bar mode
Supported embed types: AppEmbed
Version : SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl
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,
})
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: AppEmbed
, LiveboardEmbed
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,
})
isOnBeforeGetVizDataInterceptEnabledπ
isOnBeforeGetVizDataInterceptEnabled: boolean
Optional
Flag that allows using EmbedEvent.OnBeforeGetVizDataIntercept
.
Version : SDK : 1.29.0 | ThoughtSpot: 10.1.0.cl
isUnifiedSearchExperienceEnabledπ
isUnifiedSearchExperienceEnabled: boolean
Optional
This flag is used to enable unified search experience for full app embed.
Supported embed types: AppEmbed
Version : SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
default
: true
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
isUnifiedSearchExperienceEnabled: true,
})
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,
})
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',
})
modularHomeExperienceπ
modularHomeExperience: boolean
Optional
Flag to control new Modular Home experience.
Supported embed types: AppEmbed
Version : SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
default
: false
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
modularHomeExperience : 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
, 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,
});
pageIdπ
pageId: Page
Optional
The application page to set as the start page in the embedded view.
Use this to open to particular page in the app. To open to a specific
path within the app, use the path
attribute which is more flexible.
Supported embed types: AppEmbed
Version : SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
pageId : Page.Answers | Page.Data,
})
pathπ
path: string
Optional
A URL path to the embedded application page
If both path and pageId attributes are defined, the path definition
takes precedence. This is the path post the #/
in the URL of the standalone
ThoughtSpot app. Use this to open the embedded view to a specific path.
For eg, if you want the component to open to a specific Liveboard
you could set the path to pinboard/<liveboardId>/tab/<tabId>
.
Supported embed types: AppEmbed
Version : SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
path:"pinboard/1234/tab/7464",
})
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();
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
});
reorderedHomepageModulesπ
reorderedHomepageModules: HomepageModule[]
Optional
reordering the home page modules eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
Note: This option does not apply to the classic homepage.
To access the updated modular homepage, set
modularHomeExperience
to true
(available as Early Access feature in 9.12.5.cl).
Supported embed types: AppEmbed
Version : SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
const embed = new AppEmbed('#tsEmbed', {
... //other embed view config
reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
})
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 embedded view in full app embed.
Supported embed types: AppEmbed
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,
})
showPrimaryNavbarπ
showPrimaryNavbar: boolean
Optional
If true, the top navigation bar within the ThoughtSpot app is displayed. By default, the navigation bar is hidden. This flag also controls the homepage left navigation bar.
Supported embed types: AppEmbed
Version : SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
default
: true
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
showPrimaryNavbar:true,
})
tagπ
tag: string
Optional
This puts a filter tag on the application. All metadata lists in the application, such as Liveboards and answers, would be filtered by this tag.
Supported embed types: AppEmbed
Version : SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
const embed = new AppEmbed('#tsEmbed', {
... // other embed view config
tag:'value',
})
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],
});