HostEvent

Table of Contents

Index
Enumeration members

Event types that can be triggered by the host application to the embedded ThoughtSpot app.

To trigger an event use the corresponding LiveboardEmbed.trigger or AppEmbed.trigger or SearchEmbed.trigger method.

import { HostEvent } from '@thoughtspot/visual-embed-sdk';
// Or
// const { HostEvent } = window.tsembed;

// create the liveboard embed.

liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
  { columnName: 'state', operator: RuntimeFilterOp.EQ, values: ["california"]}
]);

If using React components to embed, use the format shown in this example:

 const selectVizs = () => {
     embedRef.current.trigger(HostEvent.SetVisibleVizs, [
        "715e4613-c891-4884-be44-aa8d13701c06",
        "3f84d633-e325-44b2-be25-c6650e5a49cf"
     ]);
   };

You can also attach an Embed event to a Host event to trigger a specific action as shown in this example:

 const EmbeddedComponent = () => {
      const embedRef = useRef(null); // import { useRef } from react
      const onLiveboardRendered = () => {
         embedRef.current.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
     };

     return (
         <LiveboardEmbed
             ref={embedRef}
             liveboardId="<liveboard-guid>"
             onLiveboardRendered={onLiveboardRendered}
         />
     );
 }

Context Parameter (SDK: 1.45.2+)

Starting from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl, you can optionally pass a ContextType as the third parameter to the trigger method to specify the context from which the event is triggered. This helps ThoughtSpot understand the current page context (Search, Answer, Liveboard, or Spotter) for better event handling.

import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';

// Trigger Pin event with Search context
appEmbed.trigger(HostEvent.Pin, {
    vizId: "123",
    liveboardId: "456"
}, ContextType.Search);

Index🔗

Enumeration members🔗

AIHighlights🔗

AIHighlights:= "AIHighlights"

Version : SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl Trigger the AI Highlights action on an embedded Liveboard

Payload: none.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.AIHighlights)

AddColumns🔗

AddColumns:= "addColumns"

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl Add columns to the current search query. Payload: { columnIds: string[] }.

Defined in : types.ts

searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })

// Add columns from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
searchEmbed.trigger(HostEvent.AddColumns, {
    columnIds: ['col-guid-1', 'col-guid-2']
}, ContextType.Search);

AddToCoaching🔗

AddToCoaching:= "addToCoaching"

Version : SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl Opens the Add to Coaching modal from a visualization in Spotter Embed.

Defined in : types.ts

Parameter: `vizId ` refers to the Visualization ID in Spotter embed and is required.

spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });

AnswerChartSwitcher🔗

AnswerChartSwitcher:= "answerChartSwitcher"

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl Toggle the visualization to chart or table view. Payload: RequiredVizRequest.

Defined in : types.ts

Parameter: `vizId ` refers to the Visualization ID in Spotter embed and is required.

let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });

AskSage🔗

AskSage:= "AskSage"

Version : SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl Trigger the Ask Sage action for visualizations Payload: RequiredVizRequest.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.AskSage,
{vizId:'730496d6-6903-4601-937e-2c691821af3c'})

AskSpotter🔗

AskSpotter:= "AskSpotter"

Version : SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl Trigger the Spotter action for visualizations present on the liveboard’s vizzes. Payload: RequiredVizRequest.

Defined in : types.ts

Parameter: vizId refers to the Visualization ID in Spotter embed and is required.

let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.AskSpotter, { vizId: latestSpotterVizId });

CloseSpotterShareConversation🔗

CloseSpotterShareConversation:= "CloseSpotterShareConversation"

Version : SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl Closes the Spotter share-conversation modal. No-op if none is open. Payload: none.

Defined in : types.ts

spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);

CloseSpotterVizPanel🔗

CloseSpotterVizPanel:= "CloseSpotterVizPanel"

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl Closes the SpotterViz panel. Payload: none.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.CloseSpotterVizPanel);

CopyLink🔗

CopyLink:= "embedDocument"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Copy link action on a Liveboard or visualization Payload: VizScopedRequest.

Defined in : types.ts

Parameter: object - to trigger the action for a specific visualization in Liveboard embed, pass in vizId as a key

liveboardEmbed.trigger(HostEvent.CopyLink)

liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.CopyLink)

// Copy link from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);

// Copy link from liveboard visualization context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.CopyLink, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

// Copy link from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);

// Copy link from liveboard visualization context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.CopyLink, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

CreateMonitor🔗

CreateMonitor:= "createMonitor"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Create alert action on a KPI chart in a Liveboard or saved Answer. Payload: VizScopedRequest.

Defined in : types.ts

Parameter: an object with vizId as a key

liveboardEmbed.trigger(HostEvent.CreateMonitor, {
 vizId: '730496d6-6903-4601-937e-2c691821af3c'
})

searchEmbed.trigger(HostEvent.CreateMonitor)

// Create monitor from answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.CreateMonitor, {}, ContextType.Answer);

// Create monitor from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.CreateMonitor, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

DataModelInstructions🔗

DataModelInstructions:= "DataModelInstructions"

Version : SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl Opens the data model instructions modal in Spotter Embed.

Defined in : types.ts

spotterEmbed.trigger(HostEvent.DataModelInstructions);

Delete🔗

Delete:= "onDeleteAnswer"

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw Trigger the Delete action for a visualization in an embedded Liveboard, or a chart or table generated from Search. Payload: VizScopedRequest.

Defined in : types.ts

Parameter: Liveboard embed takes an object with vizId as a key. Can be left empty if embedding Search or visualization.

liveboardEmbed.trigger(HostEvent.Delete, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

searchEmbed.trigger(HostEvent.Delete)

// Delete from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.Delete, {}, ContextType.Liveboard);

// Delete from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.Delete, {}, ContextType.Search);

DeleteLastPrompt🔗

DeleteLastPrompt:= "DeleteLastPrompt"

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl Deletes the last prompt in spotter embed. Payload: none.

Defined in : types.ts

spotterEmbed.trigger(HostEvent.DeleteLastPrompt);

DestroyEmbed🔗

DestroyEmbed:= "EmbedDestroyed"

Version : SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl Notifies the embedded ThoughtSpot app that the embed is being torn down, so that it can release any resources it holds before the iframe is removed from the DOM.

This is triggered for you by embed.destroy(); you rarely need to trigger it directly. If waitForCleanupOnDestroy is set in the embed config, destroy() waits for the app to acknowledge this event (up to cleanupTimeout) before removing the iframe.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.DestroyEmbed);

Download🔗

Download:= "downloadAsPng"

Trigger the Download action on charts in the embedded view. Use HostEvent.DownloadAsPng instead.

Deprecated : from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw

Defined in : types.ts

Parameter: vizId refers to the Visualization ID in Spotter embed and is required in Spotter embed.

liveboardEmbed.trigger(HostEvent.Download, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

embed.trigger(HostEvent.Download)

// You can use the Data event dispatched on each answer creation to get the vizId and use in Download host event.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });

DownloadAsCsv🔗

DownloadAsCsv:= "downloadAsCSV"

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw Trigger the Download > CSV action on tables in the embedded view. Payload: VizScopedRequest.

Defined in : types.ts

Parameter: vizId refers to the Visualization ID in Spotter embed and is required in Spotter embed.

liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.DownloadAsCsv)

searchEmbed.trigger(HostEvent.DownloadAsCsv)

// You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsCsv host event.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });

// Download as CSV from search-answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);

// Download as CSV from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
searchEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);

DownloadAsPdf🔗

DownloadAsPdf:= "downloadAsPdf"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Download PDF action on an embedded Liveboard, visualization or Answer.

Payload: VizScopedRequest plus optional liveboardId.

Defined in : types.ts

Parameter: vizId refers to the Answer ID in Spotter embed and is required in Spotter embed.

NOTE: The Download > PDF action is available on visualizations and Answers if the data is in tabular format.

liveboardEmbed.trigger(HostEvent.DownloadAsPdf)

// You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPdf host event.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });

// Download as PDF from search-answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Search);

// Download as PDF from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Liveboard);

DownloadAsPng🔗

DownloadAsPng:= "downloadAsPng"

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw Trigger the Download > PNG action on charts in the embedded view. Payload: VizScopedRequest.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.DownloadAsPng,
{vizId:'730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.DownloadAsPng)

searchEmbed.trigger(HostEvent.DownloadAsPng)

// You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPng host event.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });

// Download as PNG from search-answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.DownloadAsPng, {}, ContextType.Search);

DownloadAsXlsx🔗

DownloadAsXlsx:= "downloadAsXLSX"

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw Trigger the Download > XLSX action on tables in the embedded view. Payload: VizScopedRequest.

Defined in : types.ts

Parameter: vizId refers to the Visualization ID in Spotter embed and is required in Spotter embed.

liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.DownloadAsXlsx)

searchEmbed.trigger(HostEvent.DownloadAsXlsx)

// You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsXlsx host event.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });

// Download as XLSX from answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Answer);

// Download as XLSX from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
searchEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Search);

DownloadLiveboardAsContinuousPDF🔗

DownloadLiveboardAsContinuousPDF:= "downloadLiveboardAsContinuousPDF"

Version : SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl Trigger the Download Liveboard as Continuous PDF action on an embedded Liveboard.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)

DrillDown🔗

DrillDown:= "triggerDrillDown"

Version : SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1 Triggers a drill on certain points of the specified column Payload: DrillDownRequest; in Liveboard context vizId is required (RequiredVizRequest). trigger() accepts the union now; per-context enforced next release. Includes the following properties:

Defined in : types.ts

Parameter

Includes the following keys:

points: An object containing selectedPoints and/or clickedPoint to drill to. For example, { selectedPoints: [] }.
columnGuid: Optional. GUID of the column to drill by. If not provided, it will auto drill by the configured column.
autoDrillDown: Optional. If true, the drill down will be done automatically on the most popular column.
vizId (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case of a Liveboard. In Spotter embed, vizId refers to the Answer ID and is required.

searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
      console.log(payload);
      const clickedPoint = payload.data.clickedPoint;
      const selectedPoint = payload.data.selectedPoints;
      console.log('>>> called', clickedPoint);
      searchEmbed.trigger(HostEvent.DrillDown, {
            points: {
                 clickedPoint,
                 selectedPoints: selectedPoint
            },
            autoDrillDown: true,
      });
})

 // Works with TS 9.8.0 and above

 liveboardEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
   console.log(payload);
   const clickedPoint = payload.data.clickedPoint;
   const selectedPoint = payload.data.selectedPoints;
   console.log('>>> called', clickedPoint);
   liveboardEmbed.trigger(HostEvent.DrillDown, {
     points: {
       clickedPoint,
       selectedPoints: selectedPoint
     },
     columnGuid: "<guid of the column to drill>",
     vizId: payload.data.vizId
   });
 })

// Drill down from answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.DrillDown, {
    points: { clickedPoint, selectedPoints },
    autoDrillDown: true
}, ContextType.Answer);

// Drill down from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
searchEmbed.trigger(HostEvent.DrillDown, {
    points: { clickedPoint, selectedPoints },
    columnGuid: "column-guid"
}, ContextType.Search);

Edit🔗

Edit:= "edit"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Edit action on a Liveboard or a visualization on a Liveboard.

This event is not supported in visualization embed and search embed. Payload: VizScopedRequest.

Defined in : types.ts

Parameter

Object parameter. Includes the following keys:

vizId: To trigger the action for a specific visualization in Liveboard embed, pass in vizId as a key. In Spotter embed, vizId refers to the Answer ID and is required.

liveboardEmbed.trigger(HostEvent.Edit)

liveboardEmbed.trigger(HostEvent.Edit, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

spotterEmbed.trigger(HostEvent.Edit);

// Using context parameter to edit liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.Edit, {}, ContextType.Liveboard);

// Edit from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.Edit, {}, ContextType.Search);

@example

// Edit from spotter context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.Edit, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Spotter);

EditLastPrompt🔗

EditLastPrompt:= "EditLastPrompt"

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl Edits the last prompt in spotter embed. Payload: string.

Defined in : types.ts

Parameter: query: Text string

spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");

// Edit last prompt from spotter context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
spotterEmbed.trigger(HostEvent.EditLastPrompt, "sales by region", ContextType.Spotter);

EditLiveboard🔗

EditLiveboard:= "editLiveboard"

Version : SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl Trigger the Edit action on a Liveboard only — does not affect a visualization’s edit surface.

Behaves like HostEvent.Edit restricted to the Liveboard surface. Use HostEvent.EditVisualization to target a visualization instead, or HostEvent.Edit to control whichever surface applies contextually (unchanged, existing behavior).

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.EditLiveboard)

EditTML🔗

EditTML:= "editTSL"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Edit TML action on an embedded Liveboard or saved Answers in the full application embedding. Payload: VizScopedRequest.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.EditTML)

// Edit TML from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.EditTML, {}, ContextType.Liveboard);

// Edit TML from search-answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.EditTML, {}, ContextType.Search);

EditVisualization🔗

EditVisualization:= "editVisualization"

Version : SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl Trigger the Edit action on a specific visualization inside a Liveboard only — does not affect the Liveboard-level edit surface.

Defined in : types.ts

Parameter

Object parameter. Includes the following keys:

vizId: Required. The visualization to edit.

liveboardEmbed.trigger(HostEvent.EditVisualization, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

ExitEditMode🔗

ExitEditMode:= "exitEditMode"

Version : SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl Exits Liveboard edit mode , equivalent to clicking the Cancel button in the Liveboard edit header. The Liveboard returns to view mode and the embedded app emits the EmbedEvent.Cancel event.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.ExitEditMode);

ExitSpotterSharedConversation🔗

ExitSpotterSharedConversation:= "ExitSpotterSharedConversation"

Version : SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl Exits the read-only shared-conversation view. Payload: none.

Defined in : types.ts

spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);

Explore🔗

Explore:= "explore"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Explore action on a visualization. Payload: RequiredVizRequest.

Defined in : types.ts

Parameter: an object with vizId as a key

liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})

// Explore from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.Explore, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

ExportTML🔗

ExportTML:= "exportTSL"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Export TML action on an embedded Liveboard or Answer. Payload: VizScopedRequest.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.ExportTML)

// Export TML from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Liveboard);

// Export TML from search-answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Search);

GetAnswerSession🔗

GetAnswerSession:= "getAnswerSession"

Version : SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw Get the Answer session for a Search or Liveboard visualization.

Note: This event is not typically used directly. Instead, use the getAnswerService() method on the embed instance to get an AnswerService object that provides a more convenient interface for working with answers.

Payload: GetAnswerSessionRequest. Response: GetAnswerSessionResponse.

Defined in : types.ts

// Preferred way to get an AnswerService
const service = await embed.getAnswerService();

// Alternative direct usage (not recommended)
const {session} = await embed.trigger(
 HostEvent.GetAnswerSession, {
     vizId: '123', // For Liveboard Visualization.
 })

// Preferred way to get an AnswerService
const service = await embed.getAnswerService();

// Alternative direct usage (not recommended)
const {session} = await embed.trigger( HostEvent.GetAnswerSession )

returns : session - Session identifier for the Answer, for use with the AnswerService.

returns : embedAnswerData - Data backing the Answer, when available.

GetFilters🔗

GetFilters:= "getFilters"

Version : SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl Get details of filters applied on the Liveboard. Returns arrays containing Liveboard filter and runtime filter elements. Each Liveboard filter includes an optional applicability attribute indicating the scope of the filter. It contains a level (LIVEBOARD, TAB, or GROUP) and, when level is TAB or GROUP, a targetId with the GUID of the target. At LIVEBOARD level there is no targetId, since the filter applies to the whole Liveboard. The applicability attribute is available from SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl. Payload: GetFiltersRequest. Response: GetFiltersResponse.

Defined in : types.ts

const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
    console.log('data', data);
// {
//   liveboardFilters: [ ... ],
//   runtimeFilters: [
//     { columnName: "Region", operator: "IN", values: ["West"] }
//   ]
// }

// Get filters from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
console.log('filters', data);

returns : liveboardFilters - Filters applied on the Liveboard.

returns : runtimeFilters - Runtime filters applied on the Liveboard.

GetGroups🔗

GetGroups:= "getGroups"

Version : SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl Get group details for the current Liveboard. Mirrors HostEvent.GetTabs for filter/parameter groups. Payload: none. Response: GetGroupsResponse.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
  console.log(
     groupDetails // GroupDetails of current Liveboard
  );
})

// Get groups from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
    console.log('groups', groupDetails);
});

returns : orderedGroupIds - Group GUIDs in the order they appear.

returns : numberOfGroups - Total number of groups on the Liveboard.

returns : Groups - Group details, each with at least id and name.

GetIframeUrl🔗

GetIframeUrl:= "GetIframeUrl"

Version : SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl Get iframe URL for the current embed view. Payload: none. Response: GetIframeUrlResponse.

Defined in : types.ts

const url = embed.trigger(HostEvent.GetIframeUrl);
console.log("iFrameURL",url);

// Get iframe URL from specific context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
console.log("iFrameURL", url);

returns : iframeUrl - The URL currently loaded in the embedded iframe.

GetParameters🔗

GetParameters:= "GetParameters"

Version : SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw Triggers GetParameters to fetch the runtime Parameters. Each parameter includes an optional applicability attribute indicating the scope of the parameter. It contains a level (LIVEBOARD, TAB, or GROUP) and, when level is TAB or GROUP, a targetId with the GUID of the target. At LIVEBOARD level there is no targetId, since the parameter applies to the whole Liveboard. The applicability attribute is available from SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl. Payload: none. Response: GetParametersResponse.

Defined in : types.ts

Parameter: vizId refers to the Answer ID in Spotter embed and is required in Spotter embed.

liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
 console.log('parameters', parameter);
});

// You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });

// Get parameters from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.GetParameters, {},
ContextType.Liveboard).then((parameters) => {
    console.log('parameters', parameters);
});

returns : parameters - Parameters currently applied on the Liveboard.

GetTML🔗

GetTML:= "getTML"

Version : SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw Get TML for the current search. Payload: GetTMLRequest. Response: Record<string, any>.

Defined in : types.ts

searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
  console.log(
     tml.answer.search_query // TML representation of the search query
  );
})

// You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.GetTML, {
  vizId: latestSpotterVizId
}).then((tml) => {
  console.log(
     tml.answer.search_query // TML representation of the search query
  );
})

// Get TML from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
  console.log(tml.answer.search_query);
});

// Get TML from search-answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
  console.log(tml.answer);
});

returns : The TML representation of the current Answer, as an object.

GetTabs🔗

GetTabs:= "getTabs"

Version : SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl Get tab details for the current Liveboard. Payload: none. Response: GetTabsResponse.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
  console.log(
     tabDetails // TabDetails of current Liveboard
  );
})

// Get tabs from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.GetTabs, {}, ContextType.Liveboard).then((tabDetails) => {
    console.log('tabs', tabDetails);
});

returns : orderedTabIds - Tab GUIDs in the order they appear.

returns : numberOfTabs - Total number of tabs on the Liveboard.

returns : Tabs - Tab details, each with at least id and name.

InitSpotterVizConversation🔗

InitSpotterVizConversation:= "InitSpotterVizConversation"

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl Initializes a new SpotterViz conversation. Payload: none.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.InitSpotterVizConversation);

LiveboardInfo🔗

LiveboardInfo:= "pinboardInfo"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Show Liveboard details action on an embedded Liveboard.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.LiveboardInfo)

// Show liveboard info from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.LiveboardInfo, {}, ContextType.Liveboard);

MakeACopy🔗

MakeACopy:= "makeACopy"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Make a copy action on a Liveboard, visualization, or Answer page.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.MakeACopy)

liveboardEmbed.trigger(HostEvent.MakeACopy, {
vizId: '730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.MakeACopy)

searchEmbed.trigger(HostEvent.MakeACopy)

// You can use the Data event dispatched on each answer creation to get the vizId and use in MakeACopy host event.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });

// Make a copy from answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Answer);

// Make a copy from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Search);

ManageMonitor🔗

ManageMonitor:= "manageMonitor"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Manage alerts action on a KPI chart in a visualization or saved Answer. Payload: VizScopedRequest.

Defined in : types.ts

Parameter: an object with vizId as a key

liveboardEmbed.trigger(HostEvent.ManageMonitor, {
 vizId: '730496d6-6903-4601-937e-2c691821af3c'
})

searchEmbed.trigger(HostEvent.ManageMonitor)

vizEmbed.trigger(HostEvent.ManageMonitor)

// Manage monitor from answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.ManageMonitor, {}, ContextType.Answer);

// Manage monitor from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.ManageMonitor, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

ManagePipelines🔗

ManagePipelines:= "manage-pipeline"

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw Trigger the Manage pipelines action on an embedded visualization or Answer. Allows users to manage ThoughtSpot Sync pipelines. Payload: VizScopedRequest.

Defined in : types.ts

Parameter: an object with vizId as a key

liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.ManagePipelines)

// Manage pipelines from answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.ManagePipelines, {}, ContextType.Answer);

// Manage pipelines from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.ManagePipelines, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

Navigate🔗

Navigate:= "Navigate"

Version : SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw Navigate to a specific page in the embedded ThoughtSpot application. This is the same as calling appEmbed.navigateToPage(path, true).

Accepts either a plain value or an object with path and an optional replace flag.

Payload: string | number | NavigateRequest.

Defined in : types.ts

Parameter

A string path, a numeric history delta, or an object { path: string | number, replace?: boolean }.

path — the route to navigate to, or a history delta such as 1 or -1 (calls window.history.go()).
replace — when true, replaces the current history entry instead of pushing a new one (uses window.location.replace).

// Preferred: use navigateToPage directly
appEmbed.navigateToPage(-1);

// Numeric delta — go back one step
appEmbed.trigger(HostEvent.Navigate, -1);

// String path — push a new history entry
appEmbed.trigger(HostEvent.Navigate, 'home');

// Object format — replace current history entry
appEmbed.trigger(HostEvent.Navigate, { path: 'home', replace: true }); // SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl

OpenAddFilterModal🔗

OpenAddFilterModal:= "openAddFilterModal"

Version : SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl Open the add-filter modal of a Liveboard, the same dialog that the Add filter button in the Liveboard edit header opens, so the host app can start the add-filter flow from its own UI.

The Liveboard must be in edit mode; the event is ignored otherwise. Hiding the Add filter button with hiddenActions: [Action.AddFilter] does not block this event, but disabling it with disabledActions does.

Unlike HostEvent.OpenFilter, which opens the panel of an existing filter, this event starts the creation of a new filter.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.OpenAddFilterModal);

OpenAddParameterModal🔗

OpenAddParameterModal:= "openAddParameterModal"

Version : SDK: 1.51.1 | ThoughtSpot Cloud: 26.8.0.cl Open the add-parameter panel of a Liveboard, the same panel that the Add parameter button in the Liveboard edit header opens. Mirrors HostEvent.OpenAddFilterModal for parameters.

The Liveboard must be in edit mode; the event is ignored otherwise. Hiding the Add parameter button with hiddenActions: [Action.AddParameter] does not block this event, but disabling it with disabledActions does.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.OpenAddParameterModal);

OpenFilter🔗

OpenFilter:= "openFilter"

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl Open the filter panel for a particular column. Works with Search and Liveboard embed. Payload: OpenFilterRequest (the cross-context superset). The accepted fields vary by context: OpenFilterLiveboardRequest, OpenFilterSpotterRequest, OpenFilterSearchRequest.

Defined in : types.ts

Parameter: { columnId: string, name: string, type: ATTRIBUTE/MEASURE, dataType: INT64/CHAR/DATE }

applicability - Optional. Scopes the filter to a specific target, for example, a single Liveboard tab, so the panel for the correct scoped filter is opened. Available from SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl. Includes the following attributes:

level: The scope of the filter: LIVEBOARD, TAB, or GROUP.
targetId: The GUID of the target, for example, the tab GUID. Required when level is TAB or GROUP. Do not pass it when level is LIVEBOARD, since the filter applies to the whole Liveboard. Omitting applicability targets the LIVEBOARD level.

searchEmbed.trigger(HostEvent.OpenFilter,
 {column: { columnId: '<column-GUID>', name: 'column name', type: 'ATTRIBUTE', dataType: 'INT64'}})

LiveboardEmbed.trigger(HostEvent.OpenFilter,
  { column: {columnId: '<column-GUID>'}})

// Open a filter scoped to a specific Liveboard tab
liveboardEmbed.trigger(HostEvent.OpenFilter, {
    column: { columnId: '<column-GUID>' },
    applicability: { level: 'TAB', targetId: '<tab-GUID>' }
});

// Open filter from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
searchEmbed.trigger(HostEvent.OpenFilter, {
    column: { columnId: '<column-GUID>', name: 'region', type: 'ATTRIBUTE', dataType: 'CHAR'}
}, ContextType.Search);

OpenParameter🔗

OpenParameter:= "openParameter"

Version : SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl Open the parameter panel for a particular parameter on a Liveboard. Mirrors HostEvent.OpenFilter for parameters. Payload: OpenParameterRequest.

Defined in : types.ts

Parameter

Includes the following keys:

parameter: An object identifying the parameter to open, for example, { parameterId: '<parameter-GUID>' }.
applicability: Optional. Scopes the parameter to a specific target, for example, a single Liveboard tab, so the panel for the correct scoped parameter is opened. Includes the following attributes:
level: The scope of the parameter: LIVEBOARD, TAB, or GROUP.
targetId: The GUID of the target, for example, the tab GUID. Required when level is TAB or GROUP. Do not pass it when level is LIVEBOARD, since the parameter applies to the whole Liveboard. Omitting applicability targets the LIVEBOARD level.

liveboardEmbed.trigger(HostEvent.OpenParameter, {
    parameter: { parameterId: '<parameter-GUID>' }
});

// Open a parameter scoped to a specific group
liveboardEmbed.trigger(HostEvent.OpenParameter, {
    parameter: { parameterId: '<parameter-GUID>' },
    applicability: { level: 'GROUP', targetId: '<group-GUID>' }
});

OpenSpotterVizPanel🔗

OpenSpotterVizPanel:= "OpenSpotterVizPanel"

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl Opens the SpotterViz panel. Payload: none.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.OpenSpotterVizPanel);

Pin🔗

Pin:= "pin"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger Pin action on an embedded object. If no parameters are defined, the pin action is triggered for the Answer that the user is currently on and a modal opens for Liveboard selection. To add an Answer or visualization to a Liveboard programmatically without requiring additional user input via the Pin to Liveboard modal, define the following parameters:

Payload: PinAnswerToLiveboardRequest. Response: PinAnswerToLiveboardResponse.

Defined in : types.ts

Parameter

Includes the following keys:

vizId: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard. Optional when pinning a new chart or table generated from a Search query. Required in Spotter Embed.
liveboardId: GUID of the Liveboard to pin an Answer. If there is no Liveboard, specify the newLiveboardName parameter to create a new Liveboard.
tabId: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab specified in the code.
newVizName: Name string for the Answer or visualization. If defined, this parameter adds a new visualization object or creates a copy of the Answer or visualization specified in vizId. Required.
newLiveboardName: Name string for the Liveboard. Creates a new Liveboard object with the specified name.
newTabName: Name of the tab. Adds a new tab Liveboard specified in the code.

const pinResponse = await appEmbed.trigger(HostEvent.Pin, {
    vizId: "123",
    newVizName: "Sales by region",
    liveboardId: "123",
    tabId: "123"
 });

const pinResponse = await appEmbed.trigger(HostEvent.Pin, {
    newVizName: "Total sales of Jackets",
    liveboardId: "123"
 });

const pinResponse = await searchEmbed.trigger(HostEvent.Pin, {
    newVizName: "Sales by state",
    newLiveboardName: "Sales",
    newTabName: "Products"
 });

appEmbed.trigger(HostEvent.Pin)

// You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });

// Using context parameter to specify the context type (SDK: 1.45.2+)
// Pin from a search answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.Pin, {
    vizId: "123",
    newVizName: "Sales by region",
    liveboardId: "456"
 }, ContextType.Search);

// Pin from an answer context (explore modal/page) (SDK: 1.45.2+)
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.Pin, {
    vizId: "789",
    newVizName: "Revenue trends",
    liveboardId: "456"
 }, ContextType.Answer);

// Pin from a spotter context (SDK: 1.45.2+)
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.Pin, {
    vizId: latestSpotterVizId,
    newVizName: "AI-generated insights",
    liveboardId: "456"
 }, ContextType.Spotter);

returns : liveboardId - GUID of the Liveboard the Answer was pinned to.

returns : tabId - GUID of the tab within that Liveboard.

returns : vizId - GUID of the newly created visualization.

PinSpotterConversation🔗

PinSpotterConversation:= "PinSpotterConversation"

Version : SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl Pins a saved Spotter conversation so it floats to the top of the past conversations sidebar. The conversationId of the conversation to pin is required.

This feature is available only when chat history is enabled on your ThoughtSpot instance. Contact your admin or ThoughtSpot Support to enable chat history on your instance.

Payload: ConversationScopedRequest.

Defined in : types.ts

spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
    conversationId: '<conversation-id>',
});

Present🔗

Present:= "present"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Present action on a Liveboard or visualization Payload: VizScopedRequest.

Defined in : types.ts

Parameter: object - to trigger the action for a specific visualization in Liveboard embed, pass in vizId as a key

liveboardEmbed.trigger(HostEvent.Present)

liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.Present)

// Present from liveboard visualization context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.Present, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

// Present from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);

// Present from liveboard visualization context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.Present, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

// Present from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);

PreviewSpotterData🔗

PreviewSpotterData:= "PreviewSpotterData"

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl Opens the data source preview modal in Spotter Embed. Payload: none.

Defined in : types.ts

spotterEmbed.trigger(HostEvent.PreviewSpotterData);

// Preview spotter data from spotter context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
spotterEmbed.trigger(HostEvent.PreviewSpotterData, {}, ContextType.Spotter);

RefreshLiveboardBrowserCache🔗

RefreshLiveboardBrowserCache:= "refreshLiveboardBrowserCache"

Version : SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl Clears browser cache and fetches new data for liveboard ChartViz Containers. Requires enableLiveboardDataCache to be enabled. Payload: ScheduleEmailRequest.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.RefreshLiveboardBrowserCache);

Remove🔗

Remove:= "delete"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw

Version : SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw Trigger the Delete action for a Liveboard. Payload varies by context: RequiredVizRequest (Liveboard, vizId required), VizScopedRequest (Search). trigger() accepts the union now; per-context enforced next release.

Defined in : types.ts

appEmbed.trigger(HostEvent.Remove)

liveboardEmbed.trigger(HostEvent.Remove)

RemoveColumn🔗

RemoveColumn:= "removeColumn"

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl Remove a column from the current search query. Payload: { columnId: string }.

Defined in : types.ts

searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })

// Remove column from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
searchEmbed.trigger(HostEvent.RemoveColumn, {
    columnId: 'column-guid'
}, ContextType.Search);

ResetLiveboardPersonalisedView🔗

ResetLiveboardPersonalisedView:= "ResetLiveboardPersonalisedView"

Trigger reset action for a personalized Liveboard view. This event is deprecated. Use HostEvent.ResetLiveboardPersonalizedView instead. Payload: none.

Deprecated : SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl

Version : SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);

ResetLiveboardPersonalizedView🔗

ResetLiveboardPersonalizedView:= "ResetLiveboardPersonalisedView"

Version : SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl Trigger reset action for a personalized Liveboard view.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalizedView);

ResetSearch🔗

ResetSearch:= "resetSearch"

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw Reset search operation on the Search or Answer page. Payload: none.

Defined in : types.ts

searchEmbed.trigger(HostEvent.ResetSearch)

appEmbed.trigger(HostEvent.ResetSearch)

// Reset search from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
searchEmbed.trigger(HostEvent.ResetSearch, {}, ContextType.Search);

ResetSpotterConversation🔗

ResetSpotterConversation:= "ResetSpotterConversation"

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl Resets the Spotter Embed Conversation. Payload: none.

Defined in : types.ts

spotterEmbed.trigger(HostEvent.ResetSpotterConversation);

Save🔗

Save:= "save"

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw Trigger the Save action on a Liveboard, Answer, or Spotter. Saves the changes.

Payload: VizScopedRequest.

Defined in : types.ts

Parameter: vizId refers to the Spotter Visualization Id used in Spotter embed. It is required and can be retrieved from the data embed event.

// Save changes in a Liveboard
liveboardEmbed.trigger(HostEvent.Save)

// Save the current Answer in Search embed
searchEmbed.trigger(HostEvent.Save)

// Save a Visualization in Spotter (requires vizId)
spotterEmbed.trigger(HostEvent.Save, {
  vizId: "730496d6-6903-4601-937e-2c691821af3c"
})

// How to get the vizId in Spotter?

// You can use the Data event dispatched on each answer creation to get the vizId.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });

// Save from answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.Save, {}, ContextType.Answer);

// Save from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
searchEmbed.trigger(HostEvent.Save, {}, ContextType.Search);

SaveAnswer🔗

SaveAnswer:= "saveAnswer"

Version : SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl Trigger the save action for an Answer. To programmatically save an answer without opening the Describe your Answer modal, define the name and description properties. If no parameters are specified, the save action is triggered with a modal to prompt users to add a name and description for the Answer. Payload: SaveAnswerRequest. Response: SaveAnswerResponse.

Defined in : types.ts

Parameter

Includes the following keys:

vizId: Refers to the Answer ID in Spotter embed and is required in Spotter embed.
name: Optional. Name string for the Answer.
description: Optional. Description text for the Answer.

const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
     name: "Sales by states",
     description: "Total sales by states in MidWest"
  });

// You can use the Data event dispatched on each answer creation to get the vizId and use in SaveAnswer host event.
let latestSpotterVizId = '';
spotterEmbed.on(EmbedEvent.Data, (payload) => {
  latestSpotterVizId = payload.data.id;
});

spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });

// Using context parameter to save answer from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
     name: "Regional sales analysis",
     description: "Sales breakdown by region"
  }, ContextType.Search);

// Save answer from answer context (explore modal)
import { ContextType } from '@thoughtspot/visual-embed-sdk';
const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
     name: "Modified analysis",
     description: "Updated from explore view"
  }, ContextType.Answer);

// Save answer from spotter context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
     vizId: latestSpotterVizId,
     name: "AI insights",
     description: "Generated from Spotter"
  }, ContextType.Spotter);

returns : answerId - GUID of the saved Answer.

returns : saveResponse - Raw response from the save operation.

returns : shareResponse - Raw response from the share operation, when the Answer was also made discoverable.

Schedule🔗

Schedule:= "subscription"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Schedule action on an embedded Liveboard. Payload: VizScopedRequest.

Defined in : types.ts

 liveboardEmbed.trigger(HostEvent.Schedule)

// Schedule from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.Schedule, {}, ContextType.Liveboard);

SchedulesList🔗

SchedulesList:= "schedule-list"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Manage schedule action on an embedded Liveboard Payload: VizScopedRequest.

Defined in : types.ts

 liveboardEmbed.trigger(HostEvent.SchedulesList)

// Manage schedules from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.SchedulesList, {}, ContextType.Liveboard);

Search🔗

Search:= "search"

Triggers a search operation with the search tokens specified in the search query string. Supported in AppEmbed and SearchEmbed deployments. Includes the following properties: Payload: SearchRequest.

Defined in : types.ts

Parameter

Includes the following keys:

searchQuery: Query string with search tokens.
dataSources: Data source GUID to search on. Although an array, only a single source is supported.
execute: Executes search and updates the existing query.

searchEmbed.trigger(HostEvent.Search, {
searchQuery: "[sales] by [item type]",
dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
execute: true
});

// Trigger search from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.Search, {
    searchQuery: "[revenue] by [region]",
    dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
    execute: true
}, ContextType.Search);

SelectPersonalizedView🔗

SelectPersonalizedView:= "SelectPersonalisedView"

Version : SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl Triggers selection of a specific Personalized View on a Liveboard without reloading the embed. Pass either a viewId (GUID) or viewName. If both are provided, viewId takes precedence. If neither is provided, the Liveboard resets to the original/default view. When a viewName is provided and multiple views share the same name, the first match is selected. Payload: PersonalisedViewRequest.

Defined in : types.ts

liveboardEmbed.trigger(
  HostEvent.SelectPersonalizedView,
  { viewId: '2a021a12-1aed-425d-984b-141ee916ce72' },
)

// Select by name
liveboardEmbed.trigger(
  HostEvent.SelectPersonalizedView,
  { viewName: 'Dr Smith Cardiology' },
)

// Reset to default view
liveboardEmbed.trigger(
  HostEvent.SelectPersonalizedView,
  {},
)

SendTestScheduleEmail🔗

SendTestScheduleEmail:= "sendTestScheduleEmail"

Version : SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl Trigger the Send Test Email action in the Liveboard schedule modal. Sends a test schedule email to self or all recipients. Requires isSendNowLiveboardSchedulingEnabled to be enabled. Payload: ScheduleEmailRequest.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
    sendToSelf: true,
})

// Send to all recipients
liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
    sendToSelf: false,
})

SetActiveTab🔗

SetActiveTab:= "SetActiveTab"

Version : SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.1-sw Set a Liveboard tab as an active tab. Payload: SetActiveTabRequest.

Defined in : types.ts

Parameter: tabId - string of id of Tab to show

liveboardEmbed.trigger(HostEvent.SetActiveTab,{
 tabId:'730496d6-6903-4601-937e-2c691821af3c'
})

// Set active tab from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.SetActiveTab, {
    tabId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

SetHiddenTabs🔗

SetHiddenTabs:= "SetPinboardHiddenTabs"

Version : SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw Set the hidden tabs on a Liveboard. Payload: string[].

Defined in : types.ts

Parameter: an array of the IDs of the tabs to hide. The IDs not passed will be shown.

liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
 '630496d6-6903-4601-937e-2c691821af3c',
 'i547ec54-2a37-4516-a222-2b06719af726'])

// Set hidden tabs from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
    '630496d6-6903-4601-937e-2c691821af3c',
    'i547ec54-2a37-4516-a222-2b06719af726'
], ContextType.Liveboard);

SetVisibleTabs🔗

SetVisibleTabs:= "SetPinboardVisibleTabs"

Version : SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw Set the visible tabs on a Liveboard. Payload: string[].

Defined in : types.ts

Parameter: an array of ids of tabs to show, the IDs not passed will be hidden.

liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
 '430496d6-6903-4601-937e-2c691821af3c',
 'f547ec54-2a37-4516-a222-2b06719af726'])

// Set visible tabs from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
    '430496d6-6903-4601-937e-2c691821af3c',
    'f547ec54-2a37-4516-a222-2b06719af726'
], ContextType.Liveboard);

SetVisibleVizs🔗

SetVisibleVizs:= "SetPinboardVisibleVizs"

Version : SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw Display specific visualizations on a Liveboard. Payload: string[].

Defined in : types.ts

Parameter: An array of GUIDs of the visualization to show. The visualization IDs not passed in this parameter will be hidden.

liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
 '730496d6-6903-4601-937e-2c691821af3c',
 'd547ec54-2a37-4516-a222-2b06719af726'])

// Set visible vizs from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
    '730496d6-6903-4601-937e-2c691821af3c',
    'd547ec54-2a37-4516-a222-2b06719af726'
], ContextType.Liveboard);

Share🔗

Share:= "share"

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw Trigger the Share action on an embedded Liveboard or Answer. Payload: VizScopedRequest.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.Share)

searchEmbed.trigger(HostEvent.Share)

// Share from Liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.Share, {}, ContextType.Liveboard);

// Share from search-answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.Share, {}, ContextType.Search);

ShareSpotterConversation🔗

ShareSpotterConversation:= "ShareSpotterConversation"

Version : SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl Opens the Spotter share-conversation modal for the given conversation. conversationId is mandatory — you must pass the id of the conversation to share. Also no-op when sharing is disabled (enableShareConversation off) or when already in the read-only shared view. Payload: ConversationScopedRequest.

Defined in : types.ts

spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });

ShowUnderlyingData🔗

ShowUnderlyingData:= "showUnderlyingData"

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw Trigger the Show underlying data action on a chart or table.

Payload: VizScopedRequest.

Defined in : types.ts

Parameter: an object with vizId as a key

liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.ShowUnderlyingData)

searchEmbed.trigger(HostEvent.ShowUnderlyingData)

// Show underlying data from liveboard visualization context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.ShowUnderlyingData, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

// Show underlying data from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.ShowUnderlyingData, {}, ContextType.Search);

SpotIQAnalyze🔗

SpotIQAnalyze:= "spotIQAnalyze"

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw Trigger the SpotIQ analyze action on a chart or table. Payload: VizScopedRequest.

Defined in : types.ts

Parameter: Liveboard embed takes vizId as a key. Can be left undefined when embedding Search or visualization.

liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.SpotIQAnalyze)

searchEmbed.trigger(HostEvent.SpotIQAnalyze)

// SpotIQ analyze from search-answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.SpotIQAnalyze, { vizId: '730496d6-6903-4601-937e-2c691821af3c' }, ContextType.Search);

// SpotIQ analyze from search context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

SpotterSearch🔗

SpotterSearch:= "SpotterSearch"

Version : SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl Triggers a search operation with the search tokens specified in the search query string in spotter embed. Payload: SpotterSearchRequest.

Defined in : types.ts

Parameter

Includes the following keys:

query: Text string in Natural Language format.
executeSearch: Boolean to execute search and update search query.

spotterEmbed.trigger(HostEvent.SpotterSearch, {
 query: 'revenue per year',
 executeSearch: true,
})

// Spotter search from spotter context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
spotterEmbed.trigger(HostEvent.SpotterSearch, {
    query: 'sales by region',
    executeSearch: true
}, ContextType.Spotter);

SpotterVizSendUserMessage🔗

SpotterVizSendUserMessage:= "SpotterVizSendUserMessage"

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl Sends a user message (prompt) to the SpotterViz panel programmatically. Payload: { query: string }.

Defined in : types.ts

Parameter: the prompt text to send.

liveboardEmbed.trigger(HostEvent.SpotterVizSendUserMessage, {
    query: 'Show me revenue by region',
});

StartNewSpotterConversation🔗

StartNewSpotterConversation:= "StartNewSpotterConversation"

Version : SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl Triggers a new conversation in Spotter embed.

This feature is available only when chat history is enabled on your ThoughtSpot instance. Contact your admin or ThoughtSpot Support to enable chat history on your instance.

Defined in : types.ts

spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);

SyncToOtherApps🔗

SyncToOtherApps:= "sync-to-other-apps"

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw Trigger the Sync to Other Apps action on an embedded visualization or Answer Sends data from an Answer or Liveboard visualization to third-party apps such as Slack, Salesforce, Microsoft Teams, ServiceNow and so on. Payload: VizScopedRequest.

Defined in : types.ts

Parameter: an object with vizId as a key

liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.SyncToOtherApps)

// Sync to other apps from answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.SyncToOtherApps, {}, ContextType.Answer);

// Sync to other apps from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

SyncToSheets🔗

SyncToSheets:= "sync-to-sheets"

Version : SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw Trigger the Sync to Sheets action on an embedded visualization or Answer Sends data from an Answer or Liveboard visualization to a Google sheet. Payload: VizScopedRequest.

Defined in : types.ts

Parameter: an object with vizId as a key

liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
'730496d6-6903-4601-937e-2c691821af3c'})

vizEmbed.trigger(HostEvent.SyncToSheets)

// Sync to sheets from answer context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
appEmbed.trigger(HostEvent.SyncToSheets, {}, ContextType.Answer);

// Sync to sheets from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.SyncToSheets, {
    vizId: '730496d6-6903-4601-937e-2c691821af3c'
}, ContextType.Liveboard);

TransformTableVizData🔗

TransformTableVizData:= "TransformTableVizData"

Version : SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl Triggers the table visualization re-render with the updated data. Includes the following properties:

Defined in : types.ts

Parameter: columnDataLite - an array of object containing the data value modifications retrieved from the EmbedEvent.TableVizRendered payload.For example, { columnDataLite: []}`.

searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
     console.log(payload);
     const columnDataLite = payload.data.data.columnDataLite;
     columnDataLite[0].dataValue[0]="new fob";
     console.log('>>> new Data', columnDataLite);
     searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
})

UnpinSpotterConversation🔗

UnpinSpotterConversation:= "UnpinSpotterConversation"

Version : SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl Unpins a previously pinned Spotter conversation. The conversationId of the conversation to unpin is required.

This feature is available only when chat history is enabled on your ThoughtSpot instance. Contact your admin or ThoughtSpot Support to enable chat history on your instance.

Payload: ConversationScopedRequest.

Defined in : types.ts

spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
    conversationId: '<conversation-id>',
});

UpdateCrossFilter🔗

UpdateCrossFilter:= "UpdateCrossFilter"

Version : SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw Trigger cross filter update action on a Liveboard.

Payload: UpdateCrossFilterRequest.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
     vizId: 'b535c760-8bbe-4e6f-bb26-af56b4129a1e',
     conditions: [
     { columnName: 'Category', values: ['mfgr#12','mfgr#14'] },
     { columnName: 'color', values: ['mint','hot'] },
   ],
});

UpdateFilters🔗

UpdateFilters:= "updateFilters"

Version : SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl Update one or several filters applied on a Liveboard. Payload: UpdateFiltersRequest.

Defined in : types.ts

Parameter

Includes the following keys:

filter: A single filter object containing column name, filter operator, and values.
filters: Multiple filter objects with column name, filter operator, and values for each.

Each filter object must include the following attributes:

columnName - Name of the column to filter on.

operator - Filter operator, for example, EQ, IN, CONTAINS. For information about the supported filter operators, see Developer Documentation.

values - An array of one or several values. The value definition on the data type you choose to filter on. For a complete list of supported data types, see Supported data types.

type - To update filters for date time, specify the date format type. For more information and examples, see Date filters.

applicability - Optional. Scopes the filter to a specific target, for example, a single Liveboard tab. Available from SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl. Includes the following attributes:

level: The scope of the filter: LIVEBOARD, TAB, or GROUP.
targetId: The GUID of the target, for example, the tab GUID. Required when level is TAB or GROUP. Do not pass it when level is LIVEBOARD, since the filter applies to the whole Liveboard.

liveboardEmbed.trigger(HostEvent.UpdateFilters, {
    filter: {
        columnName: "item type",
        operator: "IN",
        values: ["bags","shirts"]
       }
   });

liveboardEmbed.trigger(HostEvent.UpdateFilters, {
    filter: {
        columnName: "date",
        operator: "EQ",
        values: ["JULY","2023"],
        type: "MONTH_YEAR"
       }
   });

liveboardEmbed.trigger(HostEvent.UpdateFilters, {
 filters: [{
     columnName: "Item Type",
     operator: 'IN',
     values: ["bags","shirts"]
 },
   {
     columnName: "Region",
     operator: 'IN',
     values: ["West","Midwest"]
 },
   {
     columnName: "Date",
     operator: 'EQ',
     values: ["2023-07-31"],
     type: "EXACT_DATE"
   }]
});

If there are multiple columns with the same name, consider using WORKSHEET_NAME::COLUMN_NAME format.

liveboardEmbed.trigger(HostEvent.UpdateFilters, {
 filters: [{
     columnName: "(Sample) Retail - Apparel::city",
     operator: 'IN',
     values: ["atlanta"]
 },
 {
     columnName: "(Sample) Retail - Apparel::Region",
     operator: 'IN',
     values: ["West","Midwest"]
 }]
});

// Update filters from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.UpdateFilters, {
    filter: {
        columnName: "item type",
        operator: "IN",
        values: ["shoes", "boots"]
    }
}, ContextType.Liveboard);

// Scope the filter to a specific Liveboard tab
liveboardEmbed.trigger(HostEvent.UpdateFilters, {
    filter: {
        columnName: "item type",
        operator: "IN",
        values: ["bags", "shirts"],
        applicability: {
            level: "TAB",
            targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
        }
    }
});

Use columnName and operator - the same spelling as RuntimeFilter. The older column and oper spellings are deprecated; they are still accepted, but pass only one spelling of each field, never both. To reapply the filter state captured from EmbedEvent.FilterChanged, use convertFilterChangedToUpdateFiltersPayload to convert its payload into the shape expected here.

UpdateParameters🔗

UpdateParameters:= "UpdateParameters"

Version : SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw Triggers an action to update Parameter values on embedded Answers, Liveboard, and Spotter answer in Edit mode. Payload: RuntimeParameter[].

Defined in : types.ts

Parameter

Includes the following keys for each item:

name: Name of the parameter.
value: The value to set for the parameter.
isVisibleToUser: Optional. To control the visibility of the parameter chip.
applicability: Optional. Scopes the parameter to a specific target, for example, a single Liveboard tab. Available from SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl. Includes the following attributes:
level: The scope of the parameter: LIVEBOARD, TAB, or GROUP.
targetId: The GUID of the target, for example, the tab GUID. Required when level is TAB or GROUP. Do not pass it when level is LIVEBOARD, since the parameter applies to the whole Liveboard.

liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
  name: "Integer Range Param",
  value: 10,
  isVisibleToUser: false
}])

// Scope the parameter to a specific Liveboard tab
liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
  name: "Integer Range Param",
  value: 10,
  applicability: {
    level: "TAB",
    targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
  }
}])

// Update parameters from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
    name: "Region Param",
    value: "West",
    isVisibleToUser: true
}], ContextType.Liveboard);

UpdatePersonalisedView🔗

UpdatePersonalisedView:= "UpdatePersonalisedView"

Triggers an event to update a personalized view of a Liveboard. This event is deprecated. Use HostEvent.SelectPersonalizedView instead, which additionally accepts a viewName, resets to the original view when called with an empty payload, and reports an error when a named view cannot be found.

liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})

Payload: PersonalisedViewRequest (viewId only).

Deprecated : SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl

Version : SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl

Defined in : types.ts

// Update personalized view from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {
    viewId: '1234'
}, ContextType.Liveboard);

UpdatePersonalizedView🔗

UpdatePersonalizedView:= "UpdatePersonalisedView"

liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})

Deprecated : SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl

Version : SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl

Defined in : types.ts

UpdateRuntimeFilters🔗

UpdateRuntimeFilters:= "UpdateRuntimeFilters"

Version : SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw Updates the runtime filters applied on a Liveboard. The filter attributes passed with this event are appended to the existing runtime filters applied on a Liveboard.

Note: HostEvent.UpdateRuntimeFilters is supported in LiveboardEmbed and AppEmbed only. In full application embedding, this event updates the runtime filters applied on the Liveboard and saved Answer objects.

Payload: RuntimeFilter[].

Defined in : types.ts

Parameter

Array of RuntimeFilter objects. Each item includes:

columnName: Name of the column to filter on.
operator: RuntimeFilterOp to apply. For more information, see Developer Documentation.
values: List of operands. Some operators such as EQ and LE allow a single value, whereas BW and IN accept multiple values.

Note: Updating runtime filters resets the ThoughtSpot object to its original state and applies new filter conditions. Any user changes (like drilling into a visualization) will be cleared, restoring the original visualization with the updated filters.

liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
  {columnName: "state",operator: RuntimeFilterOp.EQ,values: ["michigan"]},
  {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
])

// Update runtime filters from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
    {columnName: "region", operator: RuntimeFilterOp.EQ, values: ["west"]},
    {columnName: "product", operator: RuntimeFilterOp.IN, values: ["shoes", "boots"]}
], ContextType.Liveboard);

UpdateTML🔗

UpdateTML:= "updateTSL"

Version : SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw Trigger the Update TML action on an embedded Liveboard. Payload: VizScopedRequest.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.UpdateTML)

// Update TML from liveboard context
import { ContextType } from '@thoughtspot/visual-embed-sdk';
liveboardEmbed.trigger(HostEvent.UpdateTML, {}, ContextType.Liveboard);

UpdateTheme🔗

UpdateTheme:= "UpdateTheme"

Version : SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl Switch the embed between dark appearance and its default appearance while it is open, without reloading it. Payload: UpdateThemeRequest.

Use it to keep the embed in step with a theme switch in your application; the appearance the embed loads with is set by isDarkMode. The event resolves with the applied value, such as { isDarkMode: true }. When dark appearance is not available in the embed, the embed does not change and the event rejects with an error message instead.

Defined in : types.ts

Parameter: isDarkMode - true for dark appearance, false for the default appearance.

appEmbed.trigger(HostEvent.UpdateTheme, { isDarkMode: true });

// Follow a theme switch in your application
const themeSwitch = document.querySelector('#theme-switch');
themeSwitch.addEventListener('change', async (event) => {
  try {
    await appEmbed.trigger(HostEvent.UpdateTheme, {
      isDarkMode: event.target.checked,
    });
  } catch (error) {
    console.warn(error);
  }
});

getExportRequestForCurrentPinboard🔗

getExportRequestForCurrentPinboard:= "getExportRequestForCurrentPinboard"

Version : SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw Get the transient state of a Liveboard as encoded content. This includes unsaved and ad hoc changes such as Liveboard filters, runtime filters applied on visualizations on a Liveboard, and Liveboard layout, changes to visualizations such as sorting, toggling of legends, and data drill down. For more information, see Liveboard data with unsaved changes. Payload: none. Response: GetExportRequestForCurrentPinboardResponse.

Defined in : types.ts

liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
data=>console.log(data))

returns : data - Object with a v2Content string: the export request payload for the current Liveboard.

returns : type - The passthrough event name, getExportRequestForCurrentPinboard.