ConversationViewConfig

The configuration for the embedded spotterEmbed options.

Deprecated : from SDK: 1.39.0 | ThoughtSpot: 10.10.0.clUse {@link SpotterEmbedViewConfig} instead

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.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Index Signature Parameters

Version : SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
  additionalFlags: {
       flag1: 'value1',
       flag2: 'value2'
    },
});

customActions🔗

customActions: CustomAction[]

Optional

Custom Actions allows users to define interactive UI actions (like buttons or menu items) that appear in ThoughtSpot’s visualizations, answers, and Liveboards. These actions enable users to trigger custom workflows — such as navigating to an external app, calling an API, or opening a modal — based on the data context of what they clicked can be used to trigger custom logic when the action is clicked.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterEmbed

Version : SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl

import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk';
// Use supported embed types such as AppEmbed or LiveboardEmbed
const embed = new LiveboardEmbed('#tsEmbed', {
  ... // other embed config options
  customActions: [
    {
      name: 'customAction',
      id: 'customAction',
      target: CustomActionTarget.VISUALIZATION,
      position: CustomActionPosition.PRIMARY,
      }
    }
  ]
})

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

Supported embed types: SageEmbed, AppEmbed, SearchBarEmbed, LiveboardEmbed, SearchEmbed

Version : SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl

default : true

// Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   dataPanelV2: true,
})

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.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
  ... // other embed view config
  disableRedirectionLinksInNewTab: true,
});

disableSourceSelection🔗

disableSourceSelection: boolean

Optional

disableSourceSelection : Disables data source selection but still display the selected data source.

Supported embed types: SpotterEmbed

Version : SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl

const embed = new SpotterEmbed('#tsEmbed', {
   ... //other embed view config
   disableSourceSelection : true,
})

disabledActionReason🔗

disabledActionReason: string

Optional

The tooltip to display for disabled actions.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed 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.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed 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);

enableV2Shell_experimental🔗

enableV2Shell_experimental: boolean

Optional

Enable the V2 shell. This can provide performance benefits due to a lighterweight shell.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
  enableV2Shell_experimental: true,
});

excludeRuntimeFiltersfromURL🔗

excludeRuntimeFiltersfromURL: boolean

Optional

Flag to control whether runtime filters should be included in the URL. If true, filters will be passed via app initialization payload instead. If false/undefined, filters will be added to URL (default behavior).

Supported embed types: SpotterEmbed

Version : SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl

default : false

excludeRuntimeParametersfromURL🔗

excludeRuntimeParametersfromURL: boolean

Optional

Flag to control whether runtime parameters should be included in the URL. If true, parameters will be passed via app initialization payload instead. If false/undefined, parameters will be added to URL (default behavior).

Supported embed types: SpotterEmbed

Version : SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl

default : false

exposeTranslationIDs🔗

exposeTranslationIDs: boolean

Optional

This flag can be used to expose translation IDs on the embedded app.

Version : SDK: 1.37.0 | ThoughtSpot: 10.9.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.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed 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.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   hiddenActions: [Action.Download, Action.Export],
});

hideSampleQuestions🔗

hideSampleQuestions: boolean

Optional

hideSampleQuestions : Hide sample questions on the initial screen of the conversation.

Supported embed types: SpotterEmbed

Version : SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl

const embed = new SpotterEmbed('#tsEmbed', {
   ... //other embed view config
   hideSampleQuestions : true,
})

hideSourceSelection🔗

hideSourceSelection: boolean

Optional

hideSourceSelection : Hide data source selection

Supported embed types: SpotterEmbed

Version : SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl

const embed = new SpotterEmbed('#tsEmbed', {
   ... //other embed view config
   hideSourceSelection : true,
})

insertAsSibling🔗

insertAsSibling: boolean

Optional

Insert as a sibling of the target container, instead of appending to a child inside it.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   insertAsSibling:true,
})

linkOverride🔗

linkOverride: boolean

Optional

Flag to override the Open Link in New Tab context menu option.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   linkOverride:false,
})

locale🔗

locale: string

Optional

The locale settings to apply to the embedded view.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   locale:'en',
})

overrideOrgId🔗

overrideOrgId: number

Optional

Overrides an Org context for embedding application users. This parameter allows a user authenticated to one Org to view the objects from another Org. The overrideOrgId setting is honoured only if the Per Org URL feature is enabled on your ThoughtSpot instance.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
  ... // other embed view config
  overrideOrgId: 142536,
});

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.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed 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.

Supported embed types: SpotterEmbed

Version : SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl

const embed = new SpotterEmbed('#tsEmbed', {
   // other embed view config
   runtimeFilters: [
          {
            columnName: 'color',
            operator: RuntimeFilterOp.EQ,
            values: ['red'],
          },
      ],
})

runtimeParameters🔗

runtimeParameters: RuntimeParameter[]

Optional

The list of runtime parameters to apply to the conversation.

Supported embed types: SpotterEmbed

Version : SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl

const embed = new SpotterEmbed('#tsEmbed', {
   // other embed view config
   runtimeParameters: [
          {
            name: 'Integer Param',
            value: 10,
          },
      ],
})

searchOptions🔗

searchOptions: SearchOptions

Optional

Ability to pass a starting search query to the conversation.

showAlerts🔗

showAlerts: boolean

Optional

Show alert messages and toast messages in the embed. Supported embed in all embed types.

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

const embed = new AppEmbed('#tsEmbed', {
   ... // other embed view config
   showAlerts:true,
})

showSpotterLimitations🔗

showSpotterLimitations: boolean

Optional

showSpotterLimitations : show limitation text of the spotter underneath the chat input. default is false.

Supported embed types: SpotterEmbed

Version : SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl

const embed = new SpotterEmbed('#tsEmbed', {
   ... //other embed view config
   showSpotterLimitations : true,
})

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.

Supported embed types: AppEmbed, LiveboardEmbed, SageEmbed, SearchEmbed, SpotterAgentEmbed, SpotterEmbed, SearchBarEmbed

Version : SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw

// Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
const embed = new <EmbedComponent>('#tsEmbed', {
   ... // other embed view config
   visibleActions: [Action.Download, Action.Export],
});

worksheetId🔗

worksheetId: string

The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.

ConversationViewConfig

Index🔗

Properties🔗

additionalFlags🔗

customActions🔗

customizations🔗

dataPanelV2🔗

disableRedirectionLinksInNewTab🔗

disableSourceSelection🔗

disabledActionReason🔗

disabledActions🔗

doNotTrackPreRenderSize🔗

enableV2Shell_experimental🔗

excludeRuntimeFiltersfromURL🔗

excludeRuntimeParametersfromURL🔗

exposeTranslationIDs🔗

frameParams🔗

hiddenActions🔗

hideSampleQuestions🔗

hideSourceSelection🔗

insertAsSibling🔗

linkOverride🔗

locale🔗

overrideOrgId🔗

preRenderId🔗

runtimeFilters🔗

runtimeParameters🔗

searchOptions🔗

showAlerts🔗

showSpotterLimitations🔗

visibleActions🔗

worksheetId🔗