Action

Table of Contents

Index
Enumeration members

ThoughtSpot application pages include actions and menu commands for various user-initiated operations. These actions are represented as enumeration members in the SDK. To show, hide, or disable specific actions in the embedded view, define the Action enumeration members in the disabledActions, visibleActions, or hiddenActions array.

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
   disabledActions: [Action.Download],
   //hiddenActions: [], // Set either this or visibleActions
})

const embed = new LiveboardEmbed('#embed-container', {
   ... // other options
   //visibleActions: [],
   disabledActions: [Action.Download],
   hiddenActions: [Action.Edit, ActionAction.Explore],
})

Index🔗

AxisMenuConditionalFormat

EnableContextualChangeAnalysis

PersonalisedViewsDropdown

RenameModalTitleDescription

Enumeration members🔗

AIHighlights🔗

AIHighlights:= "AIHighlights"

Action ID for AI Highlights button

Defined in : types.ts

Version : SDK: 1.27.10 | Thoughtspot: 9.12.5.cl

hiddenAction: [Action.AIHighlights]

AddFilter🔗

AddFilter:= "addFilter"

The Add filter action on a Liveboard and Search page. Allows adding filters to Answers and visualizations on a Liveboard.

Defined in : types.ts

disabledActions: [Action.AddFilter]

AddFormula🔗

AddFormula:= "addFormula"

The Create formula action on a Search or Answer page. Allows adding formulas to an Answer.

Defined in : types.ts

disabledActions: [Action.AddFormula]

AddParameter🔗

AddParameter:= "addParameter"

The Add parameter action on a Liveboard or Answer. Allows adding Parameters to a Liveboard or Answer.

Defined in : types.ts

disabledActions: [Action.AddParameter]

AddTab🔗

AddTab:= "addTab"

Defined in : types.ts

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

AddToFavorites🔗

AddToFavorites:= "addToFavorites"

Favorites icon (*) on Answers, Liveboard, and Data pages

Defined in : types.ts

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

disabledActions: [Action.AddToFavorites]

AddToWatchlist🔗

AddToWatchlist:= "addToWatchlist"

The Add KPI to Watchlist action on Home page watchlist.

Defined in : types.ts

Version : SDK : 1.27.9 | Thoughtspot: 9.12.5.cl

disabledActions: [Action.AddToWatchlist]

AnswerChartSwitcher🔗

AnswerChartSwitcher:= "answerChartSwitcher"

The Chart switcher icon on Answer and visualization pages.

Defined in : types.ts

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

disabledActions: [Action.AnswerChartSwitcher]

AnswerDelete🔗

AnswerDelete:= "onDeleteAnswer"

The Delete action for Answers.

Defined in : types.ts

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

disabledActions: [Action.AnswerDelete]

AskAi🔗

AskAi:= "AskAi"

Action ID for ask sage button

Defined in : types.ts

Version : SDK: 1.29.0 | Thoughtspot: 9.12.0.cl

hiddenAction: [Action.AskAi]

AxisMenuAggregate🔗

AxisMenuAggregate:= "axisMenuAggregate"

The Aggregate option in the chart axis or the table column customization menu. Provides aggregation options to analyze the data on a chart or table.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuAggregate]

AxisMenuConditionalFormat🔗

AxisMenuConditionalFormat:= "axisMenuConditionalFormat"

The Conditional formatting action on chart or table. Allows adding rules for conditional formatting of data points on a chart or table.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuConditionalFormat]

AxisMenuEdit🔗

AxisMenuEdit:= "axisMenuEdit"

The Edit action in the axis customization menu. Allows editing the axis name, position, minimum and maximum values, and format of a column.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuEdit]

AxisMenuFilter🔗

AxisMenuFilter:= "axisMenuFilter"

The Filter action in the chart axis or table column customization menu.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuFilter]

AxisMenuGroup🔗

AxisMenuGroup:= "axisMenuGroup"

The Group option in the chart axis or table column customization menu. Allows grouping data points if the axes use the same unit of measurement and a similar scale.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuGroup]

AxisMenuNumberFormat🔗

AxisMenuNumberFormat:= "axisMenuNumberFormat"

The Number format action to customize the format of the data labels on a chart or table.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuNumberFormat]

AxisMenuPosition🔗

AxisMenuPosition:= "axisMenuPosition"

The Position option in the axis customization menu. Allows changing the position of the axis to the left or right side of the chart.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuPosition]

AxisMenuRemove🔗

AxisMenuRemove:= "axisMenuRemove"

The Remove action in the chart axis or table column customization menu. Removes the data labels from a chart or the column of a table visualization.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuRemove]

AxisMenuRename🔗

AxisMenuRename:= "axisMenuRename"

The Rename option in the chart axis or table column customization menu. Renames the axis label on a chart or the column header on a table.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuRename]

AxisMenuSort🔗

AxisMenuSort:= "axisMenuSort"

The Sort menu action on a table or chart axis Sorts data in ascending or descending order. Allows adding, editing, or removing filters.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuConditionalFormat]

AxisMenuTextWrapping🔗

AxisMenuTextWrapping:= "axisMenuTextWrapping"

The Text wrapping action on a table. Wraps or clips column text on a table.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuTextWrapping]

AxisMenuTimeBucket🔗

AxisMenuTimeBucket:= "axisMenuTimeBucket"

The Time bucket option in the chart axis or table column customization menu. Allows defining time metric for date comparison.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.AxisMenuTimeBucket]

ChooseDataSources🔗

ChooseDataSources:= "chooseDataSources"

The Choose sources button on Search page. Allows selecting data sources for search queries.

Defined in : types.ts

disabledActions: [Action.ChooseDataSources]

CollapseDataSources🔗

CollapseDataSources:= "collapseDataSources"

Defined in : types.ts

ConfigureFilter🔗

ConfigureFilter:= "configureFilter"

Filter configuration options on a Liveboard and Search page. Allows configuring filter options when adding filters to a Liveboard or Answer.

Defined in : types.ts

disabledActions: [Action.ConfigureFilter]

CopyAndEdit🔗

CopyAndEdit:= "context-menu-item-copy-and-edit"

Defined in : types.ts

CopyKpiLink🔗

CopyKpiLink:= "copyKpiLink"

The Copy KPI Link menu action on KPI watchlist.

Defined in : types.ts

Version : SDK : 1.27.9 | Thoughtspot: 9.12.5.cl

disabledActions: [Action.CopyKpiLink]

CopyLink🔗

CopyLink:= "embedDocument"

The Copy link menu action on a Liveboard visualization. Copies the visualization URL

Defined in : types.ts

disabledActions: [Action.CopyLink]

CopyToClipboard🔗

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

The Copy to clipboard menu action on tables in an Answer or Liveboard. Copies the selected data point.

Defined in : types.ts

disabledActions: [Action.CopyToClipboard]

CreateMonitor🔗

CreateMonitor:= "createMonitor"

The Create alert action on KPI charts.

Defined in : types.ts

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

disabledActions: [Action.CreateMonitor ]

CrossFilter🔗

CrossFilter:= "context-menu-item-cross-filter"

The Filter action on Liveboard visualizations. Allows users to apply cross-filters on a Liveboard.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.CrossFilter]

Download🔗

Download:= "download"

The Download menu action on Liveboard visualizations and Answers. Allows downloading a visualization or Answer.

Defined in : types.ts

disabledActions: [Action.DownloadAsPng]

DownloadAsCsv🔗

DownloadAsCsv:= "downloadAsCSV"

The Download > CSV menu action for tables on a Liveboard or Answer page. Downloads a visualization or Answer in the XLSX format.

Defined in : types.ts

disabledActions: [Action.DownloadAsCsv]

DownloadAsPdf🔗

DownloadAsPdf:= "downloadAsPdf"

The Download > PDF menu action on a Liveboard. Downloads a visualization or Answer as a PDF file.

Defined in : types.ts

disabledActions: [Action.DownloadAsPdf]

DownloadAsPng🔗

DownloadAsPng:= "downloadAsPng"

The Download > PNG menu action for charts on a Liveboard or Answer page. Downloads a visualization or Answer as a PNG file.

Defined in : types.ts

disabledActions: [Action.DownloadAsPng]

DownloadAsXlsx🔗

DownloadAsXlsx:= "downloadAsXLSX"

The Download > XLSX menu action for tables on a Liveboard or Answer page. Downloads a visualization or Answer in the XLSX format.

Defined in : types.ts

disabledActions: [Action.DownloadAsXlsx]

DrillDown🔗

DrillDown:= "DRILL"

The Drill down menu action on Answers and Liveboard visualizations. Allows drilling down to a specific data point on a chart or table.

Defined in : types.ts

disabledActions: [Action.DrillDown]

DrillExclude🔗

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

The action to exclude data points on a drilled-down Answer or visualization

Defined in : types.ts

disabledActions: [Action.DrillInclude]

DrillInclude🔗

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

The action to include data points on a drilled-down Answer or visualization

Defined in : types.ts

disabledActions: [Action.DrillInclude]

Edit🔗

Edit:= "edit"

The Edit action on the Liveboard page and in the visualization menu. Opens a Liveboard or visualization in edit mode.

Defined in : types.ts

disabledActions: [Action.Edit]

EditACopy🔗

EditACopy:= "editACopy"

The Copy and Edit action on a Liveboard. This action is now replaced with Action.MakeACopy.

Defined in : types.ts

disabledActions: [Action.EditACopy]

EditDetails🔗

EditDetails:= "editDetails"

The edit icon on Liveboards (Classic experience).

Defined in : types.ts

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

disabledActions: [Action.EditDetails]

EditMeasure🔗

EditMeasure:= "context-menu-item-edit-measure"

Defined in : types.ts

EditSageAnswer🔗

EditSageAnswer:= "editSageAnswer"

Defined in : types.ts

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

EditTML🔗

EditTML:= "editTSL"

The Edit TML menu action for Liveboards and Answers. Opens the TML editor.

Defined in : types.ts

disabledActions: [Action.EditTML]

EditTitle🔗

EditTitle:= "editTitle"

The text edit option for Liveboard and visualization titles.

Defined in : types.ts

disabledActions: [Action.EditTitle]

EnableContextualChangeAnalysis🔗

EnableContextualChangeAnalysis:= "enableContextualChangeAnalysis"

Defined in : types.ts

Version : SDK: 1.25.0 | Thoughtspot: 9.6.0.cl

Explore🔗

Explore:= "explore"

The Explore action on Liveboard visualizations

Defined in : types.ts

disabledActions: [Action.Explore]

ExportTML🔗

ExportTML:= "exportTSL"

The Export TML menu action on Liveboard, Answers Worksheets and Data Connections page. Exports an object as a TML file.

Defined in : types.ts

disabledActions: [Action.ExportTML]

ImportTML🔗

ImportTML:= "importTSL"

The Import TML menu action for Liveboards and Answers. Imports TML representation of ThoughtSpot objects.

Defined in : types.ts

disabledActions: [Action.ImportTML]

LiveboardInfo🔗

LiveboardInfo:= "pinboardInfo"

The Show Liveboard details menu action on a Liveboard. Displays details such as the name, description, and author of the Liveboard, and timestamp of Liveboard creation and update.

Defined in : types.ts

disabledActions: [Action.LiveboardInfo]

LiveboardUsers🔗

LiveboardUsers:= "liveboardUsers"

Action ID for Liveboard Users ( Recently Visited / social proof )

Defined in : types.ts

Version : SDK : 1.26.0 | Thoughtspot: 9.7.0.cl

disabledActions: [Action.LiveboardUsers]

MakeACopy🔗

MakeACopy:= "makeACopy"

The Make a copy action on a Liveboard or Answer page. Creates a copy of the Liveboard. In LiveboardEmbed, the Make a copy action is not available for visualizations in the embedded Liveboard view. In AppEmbed, the Make a copy action is available on both Liveboards and visualizations.

Defined in : types.ts

disabledActions: [Action.MakeACopy]

ManageMonitor🔗

ManageMonitor:= "ManageMonitor"

The Manage Alertsb menu action on KPI visualizations.

Defined in : types.ts

disabledActions: [Action.ManageMonitor]

ManagePipelines🔗

ManagePipelines:= "manage-pipeline"

The Manage pipelines action on Answers and Liveboard visualizations. Allows users to manage data sync pipelines to third-party apps.

Defined in : types.ts

Version : SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw

disabledActions: [Action.SyncToOtherApps]

MarkAsVerified🔗

MarkAsVerified:= "markAsVerified"

Defined in : types.ts

Version : SDK: 1.25.0 | Thoughtspot: 9.6.0.cl

ModifySageAnswer🔗

ModifySageAnswer:= "modifySageAnswer"

Defined in : types.ts

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

MoveToTab🔗

MoveToTab:= "onContainerMove"

The Move to Tab menu action on visualizations in liveboard edit mode. Allows moving a visualization to a different tab.

Defined in : types.ts

disabledActions: [Action.MoveToTab]

PersonalisedViewsDropdown🔗

PersonalisedViewsDropdown:= "personalisedViewsDropdown"

Action ID for Liveboard Personalised Views dropdown

Defined in : types.ts

Version : SDK : 1.26.0 | Thoughtspot: 9.7.0.cl

disabledActions: [Action.PersonalisedViewsDropdown]

Pin🔗

Pin:= "pin"

The Pin menu action on an Answer or Search results page.

Defined in : types.ts

disabledActions: [Action.Pin]

Present🔗

Present:= "present"

The Present menu action for Liveboards and Answers. Allows presenting a Liveboard or visualization in slideshow mode.

Defined in : types.ts

disabledActions: [Action.Present]

QueryDetailsButtons🔗

QueryDetailsButtons:= "queryDetailsButtons"

The Query visualizer and Query SQL buttons in Query details panel of the Answer page

Defined in : types.ts

disabledActions: [Action.QueryDetailsButtons]

Remove🔗

Remove:= "delete"

The Delete menu action on Liveboards and visualizations. Deletes a Liveboard or a visualization from a Liveboard.

Defined in : types.ts

disabledActions: [Action.Remove]

RemoveCrossFilter🔗

RemoveCrossFilter:= "context-menu-item-remove-cross-filter"

The Remove action that appears when cross filters are applied on a Liveboard. Removes filters applied o a visualization.

Defined in : types.ts

Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl

disabledActions: [Action.RemoveCrossFilter]

RemoveFromWatchlist🔗

RemoveFromWatchlist:= "removeFromWatchlist"

The Remove from watchlist menu action on KPI watchlist.

Defined in : types.ts

Version : SDK : 1.27.9 | Thoughtspot: 9.12.5.cl

disabledActions: [Action.RemoveFromWatchlist]

RenameModalTitleDescription🔗

RenameModalTitleDescription:= "renameModalTitleDescription"

The Rename menu action on Liveboards and visualizations. Allows renaming a Liveboard or visualization.

Defined in : types.ts

Version : SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl

disabledActions: [Action.RenameModalTitleDescription]

ReportError🔗

ReportError:= "reportError"

Defined in : types.ts

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

disabledActions: [Action.ReportError]

RequestAccess🔗

RequestAccess:= "requestAccess"

The request access action on Liveboards. Allows users with view permissions to request edit access to a Liveboard.

Defined in : types.ts

disabledActions: [Action.RequestAccess]

RequestVerification🔗

RequestVerification:= "requestVerification"

Defined in : types.ts

Version : SDK: 1.25.0 | Thoughtspot: 9.6.0.cl

SageAnswerFeedback🔗

SageAnswerFeedback:= "sageAnswerFeedback"

Defined in : types.ts

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

Save🔗

Save:= "save"

The Save action on an Answer or Liveboard. Allows users to save the changes.

Defined in : types.ts

disabledActions: [Action.SaveAsView]

SaveAsView🔗

SaveAsView:= "saveAsView"

The Save as View action on the Answer page. Saves an Answer as a View object.

Defined in : types.ts

disabledActions: [Action.SaveAsView]

Schedule🔗

Schedule:= "subscription"

The Schedule menu action on a Liveboard. Allows scheduling a Liveboard notification.

Defined in : types.ts

disabledActions: [Action.Schedule]

SchedulesList🔗

SchedulesList:= "schedule-list"

The Manage schedules menu action on a Liveboard. Allows users to manage scheduled Liveboard jobs.

Defined in : types.ts

disabledActions: [Action.SchedulesList]

Separator🔗

Separator:= "context-menu-item-separator"

Defined in : types.ts

Share🔗

Share:= "share"

The Share action on a Liveboard, Answer, or Worksheet. Allows users to share an object with other users and groups.

Defined in : types.ts

disabledActions: [Action.Share]

ShareViz🔗

ShareViz:= "shareViz"

Defined in : types.ts

ShowSageQuery🔗

ShowSageQuery:= "showSageQuery"

Defined in : types.ts

Version : SDK: 1.26.0 | Thoughtspot: 9.7.0.cl

ShowUnderlyingData🔗

ShowUnderlyingData:= "showUnderlyingData"

The Show underlying data menu action on a visualization or Answer page.

Defined in : types.ts

disabledActions: [Action.ShowUnderlyingData]

SpotIQAnalyze🔗

SpotIQAnalyze:= "spotIQAnalyze"

The SpotIQ analyze menu action on a visualization or Answer page.

Defined in : types.ts

disabledActions: [Action.SpotIQAnalyze]

Subscription🔗

Subscription:= "subscription"

The Schedule menu action on a Liveboard.

Defined in : types.ts

disabledActions: [Action.Subscription]

SyncToOtherApps🔗

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

The Sync to other apps action on Answers and Liveboard visualizations. Allows sending data to third-party apps like Slack, Salesforce, Microsoft Teams, and so on.

Defined in : types.ts

Version : SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw

disabledActions: [Action.SyncToOtherApps]

SyncToSheets🔗

SyncToSheets:= "sync-to-sheets"

The Sync to sheets action on Answers and Liveboard visualizations. Allows sending data to a Google Sheet.

Defined in : types.ts

Version : SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw

disabledActions: [Action.SyncToSheets]

TML🔗

TML:= "tml"

Action ID for the Parent TML action The parent action TML must be included to access TML-related options within the cascading menu (specific to the answer page)

Defined in : types.ts

Version : SDK : 1.28.2 | Thoughtspot: 9.10.5.cl

// to include specific TML actions
visibleActions: [Action.TML, Action.ExportTML, Action.EditTML]

hiddenAction: [Action.TML] // hide all TML actions
disabledActions: [Action.TML] // to disable all TML actions

ToggleSize🔗

ToggleSize:= "toggleSize"

The tile resize options in the visualization menu. Allows switching between different preset layouts.

Defined in : types.ts

disabledActions: [Action.ToggleSize]

UpdateTML🔗

UpdateTML:= "updateTSL"

The Update TML menu action for Liveboards and Answers. Update TML representation of ThoughtSpot objects.

Defined in : types.ts

disabledActions: [Action.UpdateTML]

VerifiedLiveboard🔗

VerifiedLiveboard:= "verifiedLiveboard"

Action ID for to hide Verified Liveboard Banner

Defined in : types.ts

Version : SDK: 1.29.0 | Thoughtspot: 9.10.0.cl

hiddenAction: [Action.VerifiedLiveboard]