SageViewConfig
- Index
- Properties
- additionalFlags
- collapseSearchBar
- contextMenuTrigger
- customizations
- dataPanelV2
- dataSource
- disableRedirectionLinksInNewTab
- disableWorksheetChange
- disabledActionReason
- disabledActions
- doNotTrackPreRenderSize
- enableCustomColumnGroups
- enableV2Shell_experimental
- excludeRuntimeFiltersfromURL
- excludeRuntimeParametersfromURL
- frameParams
- hiddenActions
- hideAutocompleteSuggestions
- hideSageAnswerHeader
- hideSampleQuestions
- hideSearchBarTitle
- hideWorksheetSelector
- insertAsSibling
- linkOverride
- locale
- overrideOrgId
- preRenderId
- runtimeFilters
- runtimeParameters
- searchOptions
- showAlerts
- showObjectResults
- showObjectSuggestions
- visibleActions
The configuration attributes for the embedded Natural language search view. Based on GPT and LLM.
version:
: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
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.
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'
}
});
collapseSearchBarπ
collapseSearchBar: boolean
Optional
To set the initial state of the search bar in case of saved Answers.
Version : SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
default
: true
const embed = new LiveboardEmbed('#embed', {
liveboardId: '123',
collapseSearchBar: 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.34.0 | ThoughtSpot Cloud: 10.3.0.cl
default
: false
const embed = new AppEmbed('#tsEmbed', {
... // other options
dataPanelV2: true,
})
dataSourceπ
dataSource: string
Optional
The data source GUID (Worksheet GUID) to set on load.
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.
Version : SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
const embed = new LiveboardEmbed('#embed', {
disableRedirectionLinksInNewTab: true
});
disableWorksheetChangeπ
disableWorksheetChange: boolean
Optional
Disable the worksheet selection option.
Version : SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
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 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);
enableCustomColumnGroupsπ
enableCustomColumnGroups: boolean
Optional
To enable custom column groups in data panel v2
Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
default
: false
const embed = new SearchEmbed('#tsEmbed', {
... // other options
enableCustomColumnGroups: true,
});
enableV2Shell_experimentalπ
enableV2Shell_experimental: boolean
Optional
Enable the V2 shell. This can provide performance benefits due to a lighterweight shell.
Version : SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
const embed = new LiveboardEmbed('#embed', {
liveboardId: '123',
enableV2Shell_experimental: true
});