SearchViewConfig
Table of Contents
- Index
- Properties
- additionalFlags
- answerId
- collapseDataSources
- contextMenuTrigger
- customizations
- dataPanelV2
- dataSource
- dataSources
- disabledActionReason
- disabledActions
- doNotTrackPreRenderSize
- enableSearchAssist
- forceTable
- frameParams
- hiddenActions
- hideDataSources
- hideResults
- hideSearchBar
- insertAsSibling
- linkOverride
- locale
- preRenderId
- runtimeFilters
- runtimeParameters
- searchOptions
- searchQuery
- showAlerts
- useLastSelectedSources
- visibleActions
The configuration attributes for the embedded search view.
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
answerId🔗
answerId: string
Optional
The GUID of a saved answer to load initially.
collapseDataSources🔗
collapseDataSources: boolean
Optional
If set to true, the data sources panel is collapsed on load, but can be expanded manually.
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 : ''
dataPanelV2🔗
dataPanelV2: boolean
Optional
Flag to control Data panel experience
Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
default : false
dataSource🔗
dataSource: string
Optional
The array of data source GUIDs to set on load.
version: : SDK: 1.19.0
dataSources🔗
dataSources: string[]
Optional
The array of data source GUIDs to set on load. Only a single data source is supported currently.
Deprecated : Use dataSource instead.
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
forceTable🔗
forceTable: boolean
Optional
If set to true, the tabular view is set as the default format for presenting search data.
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.
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]
});hideDataSources🔗
hideDataSources: boolean
Optional
Show or hide the data sources panel.
hideResults🔗
hideResults: boolean
Optional
Show or hide the charts and tables in search answers. This attribute can be used to create a custom visualization using raw answer data.
hideSearchBar🔗
hideSearchBar: boolean
Optional
If set to true, the search page will render without the Search Bar The chart/table should still be visible.
Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
insertAsSibling🔗
insertAsSibling: boolean
Optional
Insert as a sibling of the target container, instead of appending to a child inside it.
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
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();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
searchOptions🔗
searchOptions: SearchOptions
Optional
Configuration for search options.
Includes the following properties:
searchTokenString: Search tokens to pass in the query.
`executeSearch`: Boolean to define if the search should be executed or not. If it is executed, the focus is placed on the results. If it’s not executed, the focus is placed at the end of the token string in the search bar.
searchOptions: {
searchTokenString: '[quantity purchased] [region]',
executeSearch: true,
}searchQuery🔗
searchQuery: string
Optional
The initial search query to load the answer with.
Deprecated : Use {@link searchOptions} instead.
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
useLastSelectedSources🔗
useLastSelectedSources: boolean
Optional
Flag to set if last selected dataSource should be used
version: : SDK: 1.24.0
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