AppViewConfig
- Index
- Properties
- additionalFlags
- contextMenuTrigger
- customizations
- disableProfileAndHelp
- disabledActionReason
- disabledActions
- doNotTrackPreRenderSize
- enableSearchAssist
- frameParams
- fullHeight
- hiddenActions
- hiddenHomeLeftNavItems
- hiddenHomepageModules
- hiddenTabs
- hideApplicationSwitcher
- hideHomepageLeftNav
- hideLiveboardHeader
- hideObjects
- hideOrgSwitcher
- insertAsSibling
- isLiveboardHeaderSticky
- linkOverride
- locale
- modularHomeExperience
- pageId
- path
- preRenderId
- reorderedHomepageModules
- runtimeFilters
- runtimeParameters
- showAlerts
- showLiveboardDescription
- showLiveboardTitle
- 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. 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
: ''
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.
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);
enableSearchAssist🔗
enableSearchAssist: boolean
Optional
If set to true, the Search Assist feature is enabled.
Version : SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
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 pages which support fullHeight mode.
Version : SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
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]
});
hiddenHomeLeftNavItems🔗
hiddenHomeLeftNavItems: HomeLeftNavItem[]
Optional
homepageLeftNavItems : show/hide Homeapage Left Nav Bar Items There are 8 home nav list items, we will send those item as list which we want to hide for TSE. eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
Version : SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
hiddenHomepageModules🔗
hiddenHomepageModules: HomepageModule[]
Optional
Hide the home page modules eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
Version : SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
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']
});
hideApplicationSwitcher🔗
hideApplicationSwitcher: boolean
Optional
Control the visibility of the application switcher button on the nav-bar. By default, the application switcher is shown.
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.
Version : SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
default
: false
hideLiveboardHeader🔗
hideLiveboardHeader: boolean
Optional
Show or hide Liveboard header
Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
default
: false
hideObjects🔗
hideObjects: string[]
Optional
The array of GUIDs to be hidden
hideOrgSwitcher🔗
hideOrgSwitcher: boolean
Optional
Control the visibility of the Org switcher button on the nav-bar. By default, the Org switcher button is shown.
insertAsSibling🔗
insertAsSibling: boolean
Optional
Insert as a sibling of the target container, instead of appending to a child inside it.
isLiveboardHeaderSticky🔗
isLiveboardHeaderSticky: boolean
Optional
Boolean to control if Liveboard header is sticky or not.
Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
const embed = new AppEmbed('#embed', {
... // other app 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
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
modularHomeExperience🔗
modularHomeExperience: boolean
Optional
Flag to control new Modular Home experience
Version : SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
default
: false
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.
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>
.
<AppEmbed 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.
Version : SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
const embed = new LiveboardEmbed('#embed', {
... // other liveboard view config
preRenderId: "preRenderId-123"
});
embed.showPreRender();
reorderedHomepageModules🔗
reorderedHomepageModules: HomepageModule[]
Optional
reordering the home page modules eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
Version : SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
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 Liveboard description
Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
default
: false
showLiveboardTitle🔗
showLiveboardTitle: boolean
Optional
Show or hide Liveboard title
Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
default
: false
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.
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.
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