SpotterVizConfig

Table of Contents

Index
Properties

Configuration for the SpotterViz interface shown on the Liveboard. Supported embed types: AppEmbed, LiveboardEmbed

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

const embed = new AppEmbed('#embed-container', {
   ... // other options,
   spotterViz: {
       brandName: 'MyBrand',
       brandHeadline: 'Hi, there! I\'m',
       description: 'Ask questions about your data',
       inputChatPlaceholder: 'Ask a question...',
       hideStarterPrompts: false,
       customStarterPrompts: [
           { id: '1', displayText: 'Top products', fullPrompt: 'What are the top products by revenue?' }
       ],
       // loaderHeadline and loaderTips require SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
       loaderHeadline: 'Crunching the numbers...',
       loaderTips: [
           { label: 'Tip', text: 'try asking about revenue by region' },
           { label: 'Tip', text: 'use natural language' },
       ],
   },
})

Index🔗

Properties🔗

brandHeadline🔗

brandHeadline: string

Optional

Custom headline text shown before the brand name in the SpotterViz interface. Replaces the default greeting prefix (e.g. "Hi, there! I’m").

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

default : ''

brandName🔗

brandName: string

Optional

Rename the default "SpotterViz" label shown in the SpotterViz interface with a custom brand name.

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

default : ''

customStarterPrompts🔗

customStarterPrompts: SpotterVizStarterPrompt[]

Optional

Overrides the starter prompts with a custom list. Each entry must match the SpotterVizStarterPrompt shape. Has no effect when hideStarterPrompts is true.

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

description🔗

description: string

Optional

Custom description text shown in the SpotterViz interface. Replaces the default SpotterViz description.

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

hideStarterPrompts🔗

hideStarterPrompts: boolean

Optional

Hides the starter prompts section entirely in the SpotterViz interface. When set to true, the starter prompts are not displayed.

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

default : false

inputChatPlaceholder🔗

inputChatPlaceholder: string

Optional

Custom placeholder text for the chat input in the SpotterViz interface. Replaces the default chat input placeholder text.

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

loaderHeadline🔗

loaderHeadline: string

Optional

Custom headline text shown in the SpotterViz loading state. Replaces the default loading headline.

Version : SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl

loaderTips🔗

loaderTips: SpotterVizLoaderTip[]

Optional

Custom tips shown in the SpotterViz loading state. Replaces the default loading tips with the provided list.

Version : SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl