AppViewConfig

The view configuration for full app embedding.

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

const embed = new LiveboardEmbed('#embed', {
  ... // other liveboard view config
  additionalFlags: {
       flag1: 'value1',
       flag2: 'value2'
    }
});

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,
})

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.

Version : SDK: 1.2.0 | Thoughtspot: 8.4.0.cl

default : false

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

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);

enableAskSage🔗

enableAskSage: boolean

Optional

enable or disable ask sage

Version : SDK: 1.29.0 | Thoughtspot: 9.12.0.cl

default : false

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

default : true

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

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 pages which support fullHeight mode.

Version : SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw

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

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. * @example

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

Version : SDK: 1.28.0 | Thoughtspot: 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).

Version : SDK: 1.28.0 | Thoughtspot: 9.12.5.cl

const embed = new AppEmbed('#tsEmbed', {
   ... // other options
   hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
})

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. 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).

Version : SDK: 1.28.0 | Thoughtspot: 9.12.5.cl

default : false

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

Version : SDK: 1.28.0 | Thoughtspot: 9.12.5.cl

default : false

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

hideLiveboardHeader🔗

hideLiveboardHeader: boolean

Optional

Show or hide Liveboard header

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

default : false

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

hideObjects🔗

hideObjects: string[]

Optional

The array of GUIDs to be hidden

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

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

Version : SDK: 1.28.0 | Thoughtspot: 9.12.5.cl

default : true

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

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

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

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

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

modularHomeExperience🔗

modularHomeExperience: boolean

Optional

Flag to control new Modular Home experience.

Version : SDK: 1.28.0 | Thoughtspot: 9.12.5.cl

default : false

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

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.

Version : SDK: 1.1.0 | Thoughtspot: 9.4.0.cl

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

Version : SDK: 1.1.0 | Thoughtspot: 9.4.0.cl

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

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] 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).

Version : SDK: 1.28.0| Thoughtspot: 9.12.5.cl

const embed = new AppEmbed('#tsEmbed', {
   ... // other options
   reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary]
})

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.

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

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

showLiveboardDescription🔗

showLiveboardDescription: boolean

Optional

Show or hide Liveboard description

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

default : false

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

showLiveboardTitle🔗

showLiveboardTitle: boolean

Optional

Show or hide Liveboard title

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

default : false

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

Version : SDK: 1.2.0 | Thoughtspot: 8.4.0.cl

default : true

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

Version : SDK: 1.1.0 | Thoughtspot: 9.4.0.cl

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

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]
});

AppViewConfig

Index🔗

Properties🔗

additionalFlags🔗

contextMenuTrigger🔗

customizations🔗

disableProfileAndHelp🔗

disabledActionReason🔗

disabledActions🔗

doNotTrackPreRenderSize🔗

enableAskSage🔗

enableSearchAssist🔗

excludeRuntimeFiltersfromURL🔗

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🔗