SearchViewConfig
- Index
- Properties
- additionalFlags
- answerId
- collapseDataSources
- contextMenuTrigger
- customizations
- dataPanelV2
- dataSource
- dataSources
- disabledActionReason
- disabledActions
- doNotTrackPreRenderSize
- enableSearchAssist
- excludeRuntimeFiltersfromURL
- expandAllDataSource
- 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
const embed = new LiveboardEmbed('#embed', {
... // other liveboard view config
additionalFlags: {
flag1: 'value1',
flag2: 'value2'
}
});
answerIdπ
answerId: string
Optional
The GUID of a saved answer to load initially.
version:
: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
const embed = new SearchEmbed('#tsEmbed', {
... // other options
answerId:'sed-1234',
})
collapseDataSourcesπ
collapseDataSources: boolean
Optional
If set to true, the data sources panel is collapsed on load, but can be expanded manually.
version:
: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
const embed = new SearchEmbed('#tsEmbed', {
... // other options
collapseDataSources:true,
})
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
: ''
dataPanelV2π
dataPanelV2: boolean
Optional
Flag to control Data panel experience
Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
default
: false
const embed = new SearchEmbed('#tsEmbed', {
... // other options
dataPanelV2:false,
})
dataSourceπ
dataSource: string
Optional
The array of data source GUIDs to set on load.
version:
: SDK: 1.19.0
const embed = new SearchEmbed('#tsEmbed', {
... // other options
dataSource:'id-234',
})
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.
const embed = new SearchEmbed('#tsEmbed', {
... // other options
dataSources:['id-234','id-456'],
})
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);
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
const embed = new SearchEmbed('#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
expandAllDataSourceπ
expandAllDataSource: boolean
Optional
If set to true, expands all the data sources panel.
forceTableπ
forceTable: boolean
Optional
If set to true, the tabular view is set as the default format for presenting search data.
version:
: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
const embed = new SearchEmbed('#tsEmbed', {
... // other options
forceTable:true,
})
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%',
},
});
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]
});
hideDataSourcesπ
hideDataSources: boolean
Optional
Show or hide the data sources panel.
version:
: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
const embed = new SearchEmbed('#tsEmbed', {
... // other options
hideDataSources:true,
})
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.
version:
: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
const embed = new SearchEmbed('#tsEmbed', {
... // other options
hideResults:true,
})
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
const embed = new SearchEmbed('#tsEmbed', {
... // other options
hideSearchBar: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,
})
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',
})
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();
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,
},
],
})
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
const embed = new LiveboardEmbed('#embed-container', {
... // other options
showAlerts:true,
})
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
const embed = new LiveboardEmbed('#embed', {
... // other liveboard view config
visibleActions: [Action.Download, Action.Export]
});