EmbedEvent

Table of Contents

Index
Enumeration members

Event types emitted by the embedded ThoughtSpot application.

To add an event listener use the corresponding LiveboardEmbed.on or AppEmbed.on or SearchEmbed.on method.

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

// create the liveboard embed.

liveboardEmbed.on(EmbedEvent.Drilldown, (drilldown) => {
  console.log('Drilldown event', drilldown);
}));

If you are using React components for embedding, you can register to any events from the EmbedEvent list by using the on<EventName> convention. For example,onAlert, onCopyToClipboard and so on.

// ...
const MyComponent = ({ dataSources }) => {
     const onLoad = () => {
     console.log(EmbedEvent.Load, {});
     };

     return (
         <SearchEmbed
             dataSources={dataSources}
             onLoad = {logEvent("Load")}
         />
    );
};

Index🔗

DataModelInstructions

DataSourceSelected

Delete

DeletePersonalisedView

OnBeforeGetVizDataIntercept

ResetSpotterConversation

SpotterConversationDeleted

SpotterConversationRenamed

SpotterConversationSelected

SpotterData

SpotterInit

SpotterLoadComplete

SpotterQueryTriggered

TableVizRendered

UpdateConnection

UpdatePersonalisedView

Enumeration members🔗

AIHighlights🔗

AIHighlights:= "AIHighlights"

Emitted when the AI Highlights action is triggered on a Liveboard

Defined in : types.ts

Version : SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl

liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
  console.log('AI Highlights', payload);
})

ALL🔗

ALL:= "*"

Emits all events.

Defined in : types.ts

Version : SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw

appEmbed.on(EmbedEvent.ALL, payload => {
 console.log('Embed Events', payload)
})

AddRemoveColumns🔗

AddRemoveColumns:= "addRemoveColumns"

One or more data columns have been selected.

Defined in : types.ts

Version : SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw

returns : columnIds - the list of columns

appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
  console.log('AddRemoveColumns', payload);
})

AddToCoaching🔗

AddToCoaching:= "addToCoaching"

Emitted when user opens up the Add to Coaching modal on any visualization in Spotter Embed.

Defined in : types.ts

Version : SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl

spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
    console.log('payload', payload);
})

AddToFavorites🔗

AddToFavorites:= "addToFavorites"

Emitted when a user clicks on the Favorite icon on a Liveboard

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
   console.log('favorites', payload);
})

Alert🔗

Alert:= "alert"

The embedded object has sent an alert.

Defined in : types.ts

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw

returns : alert - An alert object

searchEmbed.on(EmbedEvent.Alert)

AnswerChartSwitcher🔗

AnswerChartSwitcher:= "answerChartSwitcher"

Emitted when an Answer is switched to a chart or table view.

Defined in : types.ts

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

searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
   console.log('switch view', payload);
})

AnswerDelete🔗

AnswerDelete:= "answerDelete"

Emitted when an Answer is deleted in the app Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.

Defined in : types.ts

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

//emit when action starts
appEmbed.on(EmbedEvent.AnswerDelete, payload => {
   console.log('delete answer', payload)}, {start: true })
//trigger when action is completed
appEmbed.on(EmbedEvent.AnswerDelete, payload => {
   console.log('delete answer', payload)})

ApiIntercept🔗

ApiIntercept:= "ApiIntercept"

Emitted when the user intercepts a URL.

Supported on all embed types.

Defined in : types.ts

Version : SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl

embed.on(EmbedEvent.ApiIntercept, (payload, responder) => {
    console.log('payload', payload);
    responder({
        data: {
            execute: false,
            error: {
                errorText: 'Error Occurred',
            }
        }
    })
})

// We can also send a response for the intercepted api
embed.on(EmbedEvent.ApiIntercept, (payload, responder) => {
    console.log('payload', payload);
    responder({
        data: {
            execute: false,
            response: {
               body: {
                   data: {
                      // Some api response
                   },
               }
            }
        }
    })
})

// here embed will use the response from the responder as the response for the api

// We can also send error in response for the intercepted api
embed.on(EmbedEvent.ApiIntercept, (payload, responder) => {
    console.log('payload', payload);
    responder({
        data: {
            execute: false,
            response: {
               body: {
                   errors: [{
                     title: 'Error Occurred',
                     description: 'Error Description',
                     isUserError: true,
                   }],
                   data: {},
               },
            }
        }
    })
})

AskSageInit🔗

AskSageInit:= "AskSageInit"

Emitted when the Ask Sage is initialized.

Defined in : types.ts

Version : SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl

returns : viewName: string

returns : viewId: string

returns : liveboardId: string

returns : isPublic: boolean

AuthExpire🔗

AuthExpire:= "ThoughtspotAuthExpired"

The ThoughtSpot authentication session has expired.

Defined in : types.ts

Version : SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw

appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
//show auth expired banner
function showAuthExpired() {
   document.getElementById("authExpiredBanner");
}

AuthInit🔗

AuthInit:= "authInit"

Authentication has either succeeded or failed.

Defined in : types.ts

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw

appEmbed.on(EmbedEvent.AuthInit, payload => {
   console.log('AuthInit', payload);
})

returns : isLoggedIn - A Boolean specifying whether authentication was successful.

Cancel🔗

Cancel:= "cancel"

Emitted when a user clicks Cancel in edit mode on a Liveboard

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.Cancel)

CopyAEdit🔗

CopyAEdit:= "copyAEdit"

Emitted when the user creates a copy of an Answer. Use start:true to subscribe to when copy and edit is initiated, or end:true to subscribe to when copy and edit is completed. Default is end:true.

Defined in : types.ts

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

//emit when action starts
appEmbed.on(EmbedEvent.CopyAEdit, payload => {
   console.log('Copy and edit', payload)}, {start: true })
//emit when action ends
appEmbed.on(EmbedEvent.CopyAEdit, payload => {
   console.log('Copy and edit', payload)})

CopyLink🔗

CopyLink:= "embedDocument"

Emitted when a user clicks Copy link action on a visualization.

Defined in : types.ts

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

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

CopyToClipboard🔗

CopyToClipboard:= "context-menu-item-copy-to-clipboard"

Emitted when a column value is copied in the embedded app.

Defined in : types.ts

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

seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
   console.log('copy to clipboard', payload);
})

CreateConnection🔗

CreateConnection:= "createConnection"

Emitted when a user updates a connection on the Data page

Defined in : types.ts

Version : SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw

CreateLiveboard🔗

CreateLiveboard:= "createLiveboard"

Emitted when the liveboard is created from pin modal or Liveboard list page. You can use this event as a hook to trigger other events on liveboard creation.

liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
    console.log('payload', payload);
})

Defined in : types.ts

Version : SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl

CreateModel🔗

CreateModel:= "createModel"

Emitted when a user creates a Model.

Defined in : types.ts

Version : SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl

CreateWorksheet🔗

CreateWorksheet:= "createWorksheet"

Emitted when a user creates a Worksheet.

Defined in : types.ts

Version : SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw

CrossFilterChanged🔗

CrossFilterChanged:= "cross-filter-changed"

Emitted when a user interacts with cross filters on a visualization or Liveboard.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw

liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
   vizId: '730496d6-6903-4601-937e-2c691821af3c'})

CustomAction🔗

CustomAction:= "customAction"

A custom action has been triggered.

Defined in : types.ts

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw

returns : actionId - ID of the custom action

returns : payload CustomActionPayload - Response payload with the Answer or Liveboard data

appEmbed.on(EmbedEvent.customAction, payload => {
    const data = payload.data;
    if (data.id === 'insert Custom Action ID here') {
        console.log('Custom Action event:', data.embedAnswerData);
    }
})

Data🔗

Data:= "data"

Data pertaining to an Answer, Liveboard or Spotter visualization is received. The event payload includes the raw data of the object.

Defined in : types.ts

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw

returns : data - Answer of Liveboard data

liveboardEmbed.on(EmbedEvent.Data, payload => {
   console.log('data', payload);
})

DataModelInstructions🔗

DataModelInstructions:= "DataModelInstructions"

Emitted when user opens up the data model instructions modal in Spotter embed.

Defined in : types.ts

Version : SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl

spotterEmbed.on(EmbedEvent.DataModelInstructions, (payload) => {
    console.log('payload', payload);
})

DataSourceSelected🔗

DataSourceSelected:= "dataSourceSelected"

One or more data sources have been selected.

Defined in : types.ts

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw

returns : dataSourceIds - the list of data sources

searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
   console.log('DataSourceSelected', payload);
})

Delete🔗

Delete:= "delete"

Emitted when a user clicks Delete on a visualization

Defined in : types.ts

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

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

DeletePersonalisedView🔗

DeletePersonalisedView:= "deletePersonalisedView"

Emitted when a PersonalisedView is deleted.

Defined in : types.ts

Version : SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw

returns : views: string[]

returns : liveboardId: string

DialogClose🔗

DialogClose:= "dialog-close"

Emitted when any modal is closed in the app

Defined in : types.ts

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

appEmbed.on(EmbedEvent.DialogClose, payload => {
    console.log('dialog close', payload);
})

DialogOpen🔗

DialogOpen:= "dialog-open"

Emitted when any modal is opened in the app

Defined in : types.ts

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

appEmbed.on(EmbedEvent.DialogOpen, payload => {
   console.log('dialog open', payload);
 })

Download🔗

Download:= "download"

Emitted when the download action is triggered on an Answer.

Note: This event is deprecated in v1.21.0. To fire an event when a download action is initiated on a chart or table, use EmbedEvent.DownloadAsPng, EmbedEvent.DownloadAsPDF, EmbedEvent.DownloadAsCSV, or EmbedEvent.DownloadAsXLSX

Defined in : types.ts

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

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

DownloadAsCsv🔗

DownloadAsCsv:= "downloadAsCsv"

Emitted when the Download as CSV action is triggered on an Answer. Use start:true to subscribe to when download as CSV is initiated, or end:true to subscribe to when download as CSV is completed. Default is end:true.

Defined in : types.ts

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

//emit when action starts
searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
  console.log('download CSV', payload)}, {start: true })
//emit when action ends
searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
   console.log('download CSV', payload)})

DownloadAsPdf🔗

DownloadAsPdf:= "downloadAsPdf"

Emitted when the Download as PDF action is triggered on an Answer Use start:true to subscribe to when download as PDF is initiated, or end:true to subscribe to when download as PDF is completed. Default is end:true.

Defined in : types.ts

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

//emit when action starts
searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
  console.log('download PDF', payload)}, {start: true })
//emit when action ends
searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
  console.log('download PDF', payload)})

DownloadAsPng🔗

DownloadAsPng:= "downloadAsPng"

Emitted when the download action is triggered on an Answer. Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw

//emit when action starts
searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
  console.log('download PNG', payload)}, {start: true })
//emit when action ends
searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
  console.log('download PNG', payload)})

DownloadAsXlsx🔗

DownloadAsXlsx:= "downloadAsXlsx"

Emitted when the Download as XLSX action is triggered on an Answer. Use start:true to subscribe to when download as XLSX is initiated, or end:true to subscribe to when download as XLSX is completed. Default is end:true.

Defined in : types.ts

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

//emit when action starts
searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
  console.log('download Xlsx', payload)}, { start: true })
//emit when action ends
searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
  console.log('download Xlsx', payload)})

DrillExclude🔗

DrillExclude:= "context-menu-item-exclude"

Emitted when a user clicks the Exclude action to exclude a specific value or data on a chart or table

Defined in : types.ts

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

appEmbed.on(EmbedEvent.DrillExclude, payload => {
    console.log('Drill exclude', payload);
})

DrillInclude🔗

DrillInclude:= "context-menu-item-include"

Emitted when a user clicks the Include action to include a specific value or data on a chart or table.

Defined in : types.ts

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

appEmbed.on(EmbedEvent.DrillInclude, payload => {
   console.log('Drill include', payload);
})

Drilldown🔗

Drilldown:= "drillDown"

A drill-down operation has been performed.

Defined in : types.ts

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw

returns : additionalFilters - Any additional filters applied

returns : drillDownColumns - The columns on which drill down was performed

returns : nonFilteredColumns - The columns that were not filtered

searchEmbed.on(EmbedEvent.DrillDown, {
   points: {
       clickedPoint,
       selectedPoints: selectedPoint
   },
   autoDrillDown: true,
})

In this example, VizPointDoubleClick event is used for triggering the DrillDown event when an area or specific data point on a table or chart is double-clicked.

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

Edit🔗

Edit:= "edit"

Emitted when a user clicks Edit on a Liveboard or visualization

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.Edit, payload => {
   console.log(`Liveboard edit', payload);
})

EditTML🔗

EditTML:= "editTSL"

Emitted when a user clicks the Edit TML action on an embedded Liveboard.

Defined in : types.ts

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

appEmbed.on(EmbedEvent.EditTML, payload => {
   console.log('Edit TML', payload);
})

Error🔗

Error:= "Error"

An error has occurred. This event is fired for the following error types:

API - API call failure. FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode. SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter. NON_EXIST_FILTER - Error due to a non-existent filter. INVALID_DATE_VALUE - Invalid date value error. INVALID_OPERATOR - Use of invalid operator during filter application.

For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType

Defined in : types.ts

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw

returns : error - An error object or message

// API error
SearchEmbed.on(EmbedEvent.Error, (error) => {
  console.log(error);
 // { type: "Error", data: { errorType: "API", error: { message: '...', error: '...' } } }
 // { errorType: "API", message: '...', code: '...' } new format
});

// Fullscreen error (Errors during presenting of a liveboard)
LiveboardEmbed.on(EmbedEvent.Error, (error) => {
  console.log(error);
  // { type: "Error", data: { errorType: "FULLSCREEN", error: {
  //   message: "Fullscreen API is not enabled",
  //   stack: "..."
  // } }}
  // { errorType: "FULLSCREEN", message: "Fullscreen API is not enabled", code: '...' } new format
})

Explore🔗

Explore:= "explore"

Emitted when a user clicks Explore on a visualization

Defined in : types.ts

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

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

ExportTML🔗

ExportTML:= "exportTSL"

Emitted when the Export TML action is triggered on an an embedded object in the app Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.

Defined in : types.ts

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

//emit when action starts
searchEmbed.on(EmbedEvent.ExportTML, payload => {
    console.log('Export TML', payload)}, { start: true })
//emit when action ends
searchEmbed.on(EmbedEvent.ExportTML, payload => {
    console.log('Export TML', payload)})

FilterChanged🔗

FilterChanged:= "filterChanged"

Emitted when a user changes any filter on a Liveboard. Returns filter type and name, column name and ID, and runtime filter details.

Defined in : types.ts

LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
   console.log('payload', payload);
})

@version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw

GetDataClick🔗

GetDataClick:= "getDataClick"

Emitted when the Get Data action is initiated. Applicable to SearchBarEmbed only.

Defined in : types.ts

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

searchbarEmbed.on(EmbedEvent.GetDataClick)
 .then(data => {
 console.log('Answer Data:', data);
})

Init🔗

Init:= "init"

Rendering has initialized.

Defined in : types.ts

liveboardEmbed.on(EmbedEvent.Init, showLoader)
 //show a loader
function showLoader() {
document.getElementById("loader");
}

returns : timestamp - The timestamp when the event was generated.

LastPromptDeleted🔗

LastPromptDeleted:= "LastPromptDeleted"

Emitted when the last Spotter query is deleted in Spotter embed.

Defined in : types.ts

Version : SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl

spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
    console.log('payload', payload);
})

LastPromptEdited🔗

LastPromptEdited:= "LastPromptEdited"

Emitted when the last Spotter query is edited in Spotter embed.

Defined in : types.ts

Version : SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl

spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
    console.log('payload', payload);
})

LiveboardInfo🔗

LiveboardInfo:= "pinboardInfo"

Emitted when a user clicks Show Liveboard details on a Liveboard

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
   console.log('Liveboard details', payload);
})

LiveboardRendered🔗

LiveboardRendered:= "PinboardRendered"

Emitted when the Liveboard shell loads. You can use this event as a hook to trigger other events on the rendered Liveboard.

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
console.log('Liveboard is rendered', payload);
})

The following example shows how to trigger SetVisibleVizs event using LiveboardRendered embed event:

const embedRef = useEmbedRef();
const onLiveboardRendered = () => {
embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
};

Load🔗

Load:= "load"

The embed object container has loaded.

Defined in : types.ts

Version : SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw

returns : timestamp - The timestamp when the event was generated.

liveboardEmbed.on(EmbedEvent.Load, hideLoader)
   //hide loader
function hideLoader() {
  document.getElementById("loader");
}

MakeACopy🔗

MakeACopy:= "makeACopy"

Emitted when a user clicks Make a copy on a Liveboard

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
   console.log(`Copy', payload);
})

NoCookieAccess🔗

NoCookieAccess:= "noCookieAccess"

Emitted when the embed does not have cookie access. This happens when Safari and other Web browsers block third-party cookies are blocked by default. NoCookieAccess can trigger.

Defined in : types.ts

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

appEmbed.on(EmbedEvent.NoCookieAccess)

OnBeforeGetVizDataIntercept🔗

OnBeforeGetVizDataIntercept:= "onBeforeGetVizDataIntercept"

This event can be emitted to intercept search execution initiated by users and implement logic to allow or restrict search execution. You can also show custom error text if the search query must be restricted due to your application or business requirements.

Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled to true for this embed event to get emitted.

Defined in : types.ts

Version : SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl

Parameter

Includes the following event listener parameters:

payload: The payload received from the embed related to the Data API call.
responder: Contains elements that let developers define whether ThoughtSpot should run the search, and if not, what error message should be shown to the user.

execute - When execute returns true, the search will be run. When execute returns false, the search will not be executed.

error - Developers can customize the error message text when execute is false using the errorText and errorDescription parameters in responder.

errorText - The error message text to be shown to the user. errorDescription (ThoughtSpot: 10.15.0.cl and above) - The error description to be shown to the user.

embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
(payload, responder) => {
 responder({
     data: {
         execute:false,
         error: {
         //Provide a custom error message to explain to your end user
         //why their search did not run
         errorText: "This search query cannot be run.
         Please contact your administrator for more details."
         }
 }})
})

embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
(payload, responder) => {
const query = payload.data.data.answer.search_query
responder({
 data: {
     // returns true as long as the query does not include
     // both the 'sales' AND the 'county' column
     execute: !(query.includes("sales")&&query.includes("county")),
     error: {
     //Provide a custom error message to explain to your end user
     // why their search did not run, and which searches are accepted by your custom logic.
     errorText: "Error Occurred",
     errorDescription: "You can't use this query :" + query + ".
     The 'sales' measures can never be used at the 'county' level.
     Please try another measure, or remove 'county' from your search."
     }
 }})
})

OrgSwitched🔗

OrgSwitched:= "orgSwitched"

Emitted when the organization is switched.

Defined in : types.ts

Version : SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl

appEmbed.on(EmbedEvent.OrgSwitched, (payload) => {
    console.log('payload', payload);
})

ParameterChanged🔗

ParameterChanged:= "parameterChanged"

Emitted when parameter changes in an Answer or Liveboard.

liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
    console.log('payload', payload);
})

Defined in : types.ts

Version : SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl

Pin🔗

Pin:= "pin"

Emitted when a user initiates the Pin action to add an Answer to a Liveboard. Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.

Defined in : types.ts

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

//emit when action starts
searchEmbed.on(EmbedEvent.Pin, payload => {
   console.log('pin', payload)
}, {
start: true
})
//emit when action ends
searchEmbed.on(EmbedEvent.Pin, payload => {
   console.log('pin', payload)
})

Present🔗

Present:= "present"

Emitted when a user clicks Present on a Liveboard or visualization

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.Present)

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

PreviewSpotterData🔗

PreviewSpotterData:= "PreviewSpotterData"

Emitted when user opens up the data source preview modal in Spotter embed.

Defined in : types.ts

Version : SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl

spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
    console.log('payload', payload);
})

QueryChanged🔗

QueryChanged:= "queryChanged"

Search query has been updated by the user.

Defined in : types.ts

Version : SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw

searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))

Rename🔗

Rename:= "rename"

Emitted when a Liveboard or visualization is renamed.

Defined in : types.ts

Version : SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw

ResetLiveboard🔗

ResetLiveboard:= "resetLiveboard"

Emitted when a Liveboard is reset.

Defined in : types.ts

Version : SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw

returns : viewName: string

returns : viewId: string

returns : liveboardId: string

returns : isPublic: boolean

ResetSpotterConversation🔗

ResetSpotterConversation:= "ResetSpotterConversation"

Emitted when the coversation is reset in spotter embed.

Defined in : types.ts

Version : SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl

spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
    console.log('payload', payload);
})

RouteChange🔗

RouteChange:= "ROUTE_CHANGE"

Detects the route change.

Defined in : types.ts

Version : SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw

searchEmbed.on(EmbedEvent.RouteChange, payload =>
   console.log('data', payload))

SageEmbedQuery🔗

SageEmbedQuery:= "sageEmbedQuery"

Emitted when a user clicks the Go button to initiate a Natural Language Search query

Defined in : types.ts

Version : SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw

SageWorksheetUpdated🔗

SageWorksheetUpdated:= "sageWorksheetUpdated"

Emitted when a user selects a data source on the embedded Natural Language Search interface.

Defined in : types.ts

Version : SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw

Save🔗

Save:= "save"

Emitted when an Answer is saved in the app. Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.

Defined in : types.ts

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

//Emit when action starts
 searchEmbed.on(EmbedEvent.Save, payload => {
   console.log('Save', payload)
 }, {
   start: true
})
//emit when action ends
searchEmbed.on(EmbedEvent.Save, payload => {
   console.log('Save', payload)
})

SaveAsView🔗

SaveAsView:= "saveAsView"

Emitted when an Answer is saved as a View.

Defined in : types.ts

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

appEmbed.on(EmbedEvent.SaveAsView, payload => {
   console.log('View', payload);
})

SavePersonalisedView🔗

SavePersonalisedView:= "savePersonalisedView"

Emitted when a Personalised view is saved.

Defined in : types.ts

Version : SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw

returns : viewName: string

returns : viewId: string

returns : liveboardId: string

returns : isPublic: boolean

Schedule🔗

Schedule:= "subscription"

Emitted when a user clicks Schedule on a Liveboard

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.Schedule, payload => {
   console.log(`Liveboard schedule', payload);
})

SchedulesList🔗

SchedulesList:= "schedule-list"

Emitted when a user clicks Manage schedules on a Liveboard

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.SchedulesList)

Share🔗

Share:= "share"

Emitted when a user shares an object with another user or group

Defined in : types.ts

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

//emit when action starts
searchEmbed.on(EmbedEvent.Share, payload => {
   console.log('Share', payload)
}, {
start: true
})
//emit when action ends
searchEmbed.on(EmbedEvent.Share, payload => {
  console.log('Share', payload)
})

ShowUnderlyingData🔗

ShowUnderlyingData:= "showUnderlyingData"

Emitted when a user clicks Show underlying data on an Answer.

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
   console.log('show data', payload);
})

SpotIQAnalyze🔗

SpotIQAnalyze:= "spotIQAnalyze"

Emitted when SpotIQ analysis is triggered

Defined in : types.ts

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

//emit when action starts
searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
  console.log('SpotIQAnalyze', payload)
}, {
start: true
})
//emit when action ends
searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
  console.log('SpotIQ analyze', payload)
})

SpotterConversationDeleted🔗

SpotterConversationDeleted:= "spotterConversationDeleted"

Emitted when a Spotter conversation is deleted.

Defined in : types.ts

Version : SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl

spotterEmbed.on(EmbedEvent.SpotterConversationDeleted, (payload) => {
    console.log('Conversation deleted', payload);
    // payload: { convId: string, title: string }
})

SpotterConversationRenamed🔗

SpotterConversationRenamed:= "spotterConversationRenamed"

Emitted when a Spotter conversation is renamed.

Defined in : types.ts

Version : SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl

spotterEmbed.on(EmbedEvent.SpotterConversationRenamed, (payload) => {
    console.log('Conversation renamed', payload);
    // payload: { convId: string, oldTitle: string, newTitle: string }
})

SpotterConversationSelected🔗

SpotterConversationSelected:= "spotterConversationSelected"

Emitted when a Spotter conversation is selected/clicked.

Defined in : types.ts

Version : SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl

spotterEmbed.on(EmbedEvent.SpotterConversationSelected, (payload) => {
    console.log('Conversation selected', payload);
    // payload: { convId: string, title: string, worksheetId: string }
})

SpotterData🔗

SpotterData:= "SpotterData"

Emitted when Spotter response is text data

Defined in : types.ts

Version : SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl

spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
    console.log('payload', payload);
})

SpotterInit🔗

SpotterInit:= "spotterInit"

Emitted when the Spotter is initialized.

Defined in : types.ts

Version : SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl

spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
    console.log('payload', payload);
})

SpotterLoadComplete🔗

SpotterLoadComplete:= "spotterLoadComplete"

Emitted when a Spotter conversation has been successfully created.

Defined in : types.ts

Version : SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl

spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
    console.log('payload', payload);
})

SpotterQueryTriggered🔗

SpotterQueryTriggered:= "SpotterQueryTriggered"

Emitted when the Spotter query is triggered in Spotter embed.

Defined in : types.ts

Version : SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl

spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
    console.log('payload', payload);
})

TableVizRendered🔗

TableVizRendered:= "TableVizRendered"

Emits when a table visualization is rendered in the ThoughtSpot embedded app.

You can also use this event as a hook to trigger host events such as HostEvent.TransformTableVizData on the table visualization. The event payload contains the data used in the rendered table. You can extract the relevant data from the payload stored in payload.data.data.columnDataLite.

columnDataLite is a multidimensional array that contains data values for each column, which was used in the query to generate the table visualization. To find and modify specific cell data, you can either loop through the array or directly access a cell if you know its position and data index.

In the following code sample, the first cell in the first column (columnDataLite[0].dataValue[0]) is set to new fob. Note that any changes made to the data in the payload will only update the visual presentation and do not affect the underlying data. To persist data value modifications after a reload or during chart interactions such as drill down, ensure that the modified payload in the columnDataLite is passed on to HostEvent.TransformTableVizData and trigger an update to the table visualization.

If the Row-Level Security (RLS) rules are applied on the Model, exercise caution when changing column or table cell values to maintain data security.

Defined in : types.ts

Version : SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl

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);
})

UpdateConnection🔗

UpdateConnection:= "updateConnection"

Emitted when a user updates a connection on the Data page

Defined in : types.ts

Version : SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw

UpdatePersonalisedView🔗

UpdatePersonalisedView:= "updatePersonalisedView"

Emitted when name, status (private or public) or filter values of a Personalised view is updated.

Defined in : types.ts

Version : SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw

returns : viewName: string

returns : viewId: string

returns : liveboardId: string

returns : isPublic: boolean

UpdateTML🔗

UpdateTML:= "updateTSL"

Emitted when a user clicks the Update TML action on embedded Liveboard.

Defined in : types.ts

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

liveboardEmbed.on(EmbedEvent.UpdateTML)
})

VizPointClick🔗

VizPointClick:= "vizPointClick"

Listen to clicks on a visualization in a Liveboard or Search result.

Defined in : types.ts

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

returns : viz, clickedPoint - metadata about the point that is clicked

embed.on(EmbedEvent.VizPointClick, ({data}) => {
  console.log(
   data.vizId, // viz id
   data.clickedPoint.selectedAttributes[0].value,
   data.clickedPoint.selectedAttributes[0].column.name,
   data.clickedPoint.selectedMeasures[0].value,
   data.clickedPoint.selectedMeasures[0].column.name,
  )
});

VizPointDoubleClick🔗

VizPointDoubleClick:= "vizPointDoubleClick"

Listen to double click actions on a visualization.

Defined in : types.ts

Version : SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1

returns : ContextMenuInputPoints - Data point that is double-clicked

LiveboardEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
     console.log('VizPointDoubleClick', payload);
})

VizPointRightClick🔗

VizPointRightClick:= "vizPointRightClick"

Emitted when a user right clicks on a visualization (chart or table)

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw

LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
   console.log('VizPointClick', payload)
})