EmbedEvent

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

Enumeration members🔗

ALL🔗

ALL:= "*"

This can be used to register an event listener which is triggered on all events.

Defined in : types.ts

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

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

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

Alert🔗

Alert:= "alert"

The embedded object has sent an alert

Defined in : types.ts

returns : alert - An alert object

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

AnswerDelete🔗

AnswerDelete:= "answerDelete"

Emitted when an answer is deleted in the app

Defined in : types.ts

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

AuthExpire🔗

AuthExpire:= "ThoughtspotAuthExpired"

The ThoughtSpot auth session has expired.

Defined in : types.ts

AuthInit🔗

AuthInit:= "authInit"

Authentication has either succeeded or failed.

Defined in : types.ts

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

CopyAEdit🔗

CopyAEdit:= "copyAEdit"

Emitted when the user creates a copy of an Answer

Defined in : types.ts

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

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

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

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

CreateWorksheet🔗

CreateWorksheet:= "createWorksheet"

Emitten when a user creates a new worksheet

Defined in : types.ts

Version : SDK : 1.27.0 | Thoughtspot: 9.8.0.cl

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

CustomAction🔗

CustomAction:= "customAction"

A custom action has been triggered

Defined in : types.ts

returns : actionId - The id of the custom action

returns : data - Answer or Liveboard data

Data🔗

Data:= "data"

Data pertaining to answer or Liveboard is received

Defined in : types.ts

returns : data - The answer or Liveboard data

DataSourceSelected🔗

DataSourceSelected:= "dataSourceSelected"

One or more data sources have been selected.

Defined in : types.ts

returns : dataSourceIds - the list of data sources

Delete🔗

Delete:= "delete"

Emitted when a user clicks Delete on a Liveboard

Defined in : types.ts

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

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

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

Download🔗

Download:= "download"

Emitted when the download action is triggered on an answer

Defined in : types.ts

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

DownloadAsCsv🔗

DownloadAsCsv:= "downloadAsCsv"

Emitted when the Download as CSV action is triggered on an answer

Defined in : types.ts

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

DownloadAsPdf🔗

DownloadAsPdf:= "downloadAsPdf"

Emitted when the Download as PDF action is triggered on an answer

Defined in : types.ts

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

DownloadAsPng🔗

DownloadAsPng:= "downloadAsPng"

Emitted when the download action is triggered on an answer

Defined in : types.ts

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

DownloadAsXlsx🔗

DownloadAsXlsx:= "downloadAsXlsx"

Emitted when the Download as XLSX action is triggered on an answer

Defined in : types.ts

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

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

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

Drilldown🔗

Drilldown:= "drillDown"

A drill-down operation has been performed.

Defined in : types.ts

returns : additionalFilters - Any additional filters applied

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

returns : nonFilteredColumns - The columns that were not filtered

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

EditTML🔗

EditTML:= "editTSL"

Emitted when a user clicks the Edit TML action

Defined in : types.ts

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

Error🔗

Error:= "Error"

An error has occurred.

Defined in : types.ts

returns : error - An error object or message

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

ExportTML🔗

ExportTML:= "exportTSL"

Emitted when the Export TML action is triggered on an an embedded object in the app

Defined in : types.ts

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

GetDataClick🔗

GetDataClick:= "getDataClick"

Emitted when the "Get Data" button in Search Bar embed is clicked.

Defined in : types.ts

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

Init🔗

Init:= "init"

Rendering has initialized.

Defined in : types.ts

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

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

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

Load🔗

Load:= "load"

The embed object container has loaded.

Defined in : types.ts

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

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

NoCookieAccess🔗

NoCookieAccess:= "noCookieAccess"

Emitted when the embed does not have cookie access. This happens on Safari where third-party cookies are blocked by default.

Defined in : types.ts

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

Pin🔗

Pin:= "pin"

Emitted when an answer is pinned to a Liveboard

Defined in : types.ts

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

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

QueryChanged🔗

QueryChanged:= "queryChanged"

Search query has been updated by the user.

Defined in : types.ts

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

RouteChange🔗

RouteChange:= "ROUTE_CHANGE"

Detects the route change.

Defined in : types.ts

SageEmbedQuery🔗

SageEmbedQuery:= "sageEmbedQuery"

Emitted when a user clicks the Go button on the Search page

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.

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

Defined in : types.ts

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

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

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

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

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

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

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

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

Defined in : types.ts

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

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

embed.on(ThoughtSpotEmbed.Event.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,
  )
});

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

VizPointDoubleClick🔗

VizPointDoubleClick:= "vizPointDoubleClick"

Listen to double clicks 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

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

EmbedEvent

Index🔗

Enumeration members🔗

ALL🔗

AddRemoveColumns🔗

AddToFavorites🔗

Alert🔗

AnswerChartSwitcher🔗

AnswerDelete🔗

AuthExpire🔗

AuthInit🔗

Cancel🔗

CopyAEdit🔗

CopyLink🔗

CopyToClipboard🔗

CreateConnection🔗

CreateWorksheet🔗

CrossFilterChanged🔗

CustomAction🔗

Data🔗

DataSourceSelected🔗

Delete🔗

DeletePersonalisedView🔗

DialogClose🔗

DialogOpen🔗

Download🔗

DownloadAsCsv🔗

DownloadAsPdf🔗

DownloadAsPng🔗

DownloadAsXlsx🔗

DrillExclude🔗

DrillInclude🔗

Drilldown🔗

Edit🔗

EditTML🔗

Error🔗

Explore🔗

ExportTML🔗

GetDataClick🔗

Init🔗

LiveboardInfo🔗

LiveboardRendered🔗

Load🔗

MakeACopy🔗

NoCookieAccess🔗

Pin🔗

Present🔗

QueryChanged🔗

ResetLiveboard🔗

RouteChange🔗

SageEmbedQuery🔗

SageWorksheetUpdated🔗

Save🔗

SaveAsView🔗

SavePersonalisedView🔗

Schedule🔗

SchedulesList🔗

Share🔗

ShowUnderlyingData🔗

SpotIQAnalyze🔗

UpdateConnection🔗

UpdatePersonalisedView🔗

UpdateTML🔗

VizPointClick🔗

VizPointDoubleClick🔗

VizPointRightClick🔗