Actions Reference

Actions Reference

ThoughtSpot visualizations, Liveboards, and saved search answers support several actions and menu commands for various user-initiated operations. The Visual Embed SDK maps these actions to a set of Action enumeration members and visibleActions, disabledActions, and hiddenActions APIs for granular access control.

By default, ThoughtSpot provides a set of standard actions for embedded objects such as Liveboards, visualizations, and answers. The availability of these actions may vary based on user privileges, and the SDK library used for embedding.

Liveboard (New experience)🔗

The following actions are available for the embedded Liveboard objects:

Action string in SDKRequired SDK libraryAction label in the UI

Action.AddToFavorites

LiveboardEmbed
AppEmbed

The Favorites (star) icon on a Liveboard page.
Allows adding a Liveboard to the user’s favorites list.

Action.Edit

LiveboardEmbed
AppEmbed

Edit
Opens Liveboard in the edit mode.

Action.AddFilter

LiveboardEmbed
AppEmbed

Add filters
Adds filters to visualizations on a Liveboard.

Action.ConfigureFilter

LiveboardEmbed
AppEmbed

The filter configuration options in the Add Filters modal.
Applies filters and allows configuring filters applied to a visualization on a Liveboard.

Action.AddParameter

SearchBarEmbed
AppEmbed

The Add Parameters option in the top panel of the Liveboard
Allows adding parameters to a Liveboard.

Action.Save

LiveboardEmbed
AppEmbed

Save
Saves Liveboard modifications.

Action.Share

LiveboardEmbed
AppEmbed

Share
Allows sharing a Liveboard with another user or group.

Action.MakeACopy

LiveboardEmbed
AppEmbed

Make a copy
Creates a copy of the Liveboard.

Action.DownloadAsPdf

LiveboardEmbed
AppEmbed

Download as PDF
Downloads the Liveboard as a PDF file.

Action.Present

LiveboardEmbed
AppEmbed

Present
Presents the Liveboard in fullscreen mode.

Action.Schedule
Action.Subscription

LiveboardEmbed
AppEmbed

Schedule
Allows scheduling Liveboard notifications.

Action.SchedulesList

LiveboardEmbed
AppEmbed

Manage schedules
Allows you to manage Liveboard jobs. Saves Liveboard modifications.

Action.ExportTML

AppEmbed
LiveboardEmbed

Export TML
Exports the TML representation of a Liveboard object from ThoughtSpot.

Action.UpdateTML

LiveboardEmbed
AppEmbed

Update TML
Publishes the modified TML representation of a Liveboard object.

Action.EditTML

LiveboardEmbed
AppEmbed

Edit TML
Allows editing the ThoughtSpot Modelling Language (TML) representation of a Liveboard object loaded on the ThoughtSpot server.

Action.ImportTML

AppEmbed

Import TML
Allows importing the TML representation of a Liveboard object to ThoughtSpot.

Action.LiveboardInfo

LiveboardEmbed
AppEmbed

Show Liveboard details
Displays information about the Liveboard.

Action.Remove

AppEmbed

Delete
Deletes a Liveboard.

Visualizations on a Liveboard (New experience)🔗

The following actions are available for ThoughtSpot visualizations pinned to a Liveboard:

Action string in SDKRequired SDK libraryAction label in the UI

Action.Explore

LiveboardEmbed
AppEmbed

Explore
Allows users to explore a visualization.

Action.CreateMonitor

LiveboardEmbed
AppEmbed

Alert icon
Allows you to schedule threshold-based alerts for KPI charts.

Action.Edit

LiveboardEmbed
AppEmbed

Edit
Allows you to edit a visualization. Available only if you have edit privileges to a visualization.

Action.Pin

LiveboardEmbed
AppEmbed

Pin
Pins a visualization to a Liveboard.

Action.ShowUnderlyingData

LiveboardEmbed
AppEmbed

Show underlying data
Displays detailed information and raw data for a given visualization. Available as a contextual menu action

Action.Download

LiveboardEmbed
AppEmbed

Download
The Download menu action to download a visualization as CSV, PDF, PNG, and XLSX.
If you are using Visual Embed SDK version 1.21.0 or later, note the following behavior:

  • To disable or hide download actions, you can use Action.Download in the disabledActions and hiddenActions arrays respectively.

  • If you are using the visibleActions array to show or hide actions on a visualization or Answer, include the following action enumerations along with Action.Download in the array:

    • Action.DownloadAsCsv

    • Action.DownloadAsPdf

    • Action.DownloadAsXlsx

    • Action.DownloadAsPng

Action.DownloadAsCsv

LiveboardEmbed
AppEmbed

Download > CSV
Downloads the answer data in the CSV file format.

Action.DownloadAsXLSX

LiveboardEmbed
AppEmbed

Download > XLSX
Downloads the answer data in the XLSX file format.

Action.DownloadAsPdf

LiveboardEmbed
AppEmbed

Download > PDF
Downloads the answer data as a PDF file. Available only for tables.

Action.DownloadAsPng

LiveboardEmbed
AppEmbed

Download > PNG
Downloads the chart as a PNG file. Available only for charts.

Action.Present

LiveboardEmbed
AppEmbed

Present
Presents the visualization in a fullscreen mode.

Action.SpotIQAnalyze

LiveboardEmbed
AppEmbed

SpotIQ analyze
Allows you to run SpotIQ analyses. Available as a contextual menu action.

Action.CopyLink

LiveboardEmbed
AppEmbed

Copy link
Displays a link that you can copy and use for embedding a visualization object.

Action.Remove

AppEmbed

Delete
Removes the visualization from the Liveboard.

Action.ToggleSize

LiveboardEmbed
AppEmbed

The Resize icons in the More actions menu.
Allows resizing a visualization on a Liveboard.

Action.SyncToSheets

LiveboardEmbed
AppEmbed

The Sync to sheets action in the More actions menu.
Allows creating a sync to send data to the Google Sheets app.

Action.SyncToOtherApps

LiveboardEmbed
AppEmbed

The Sync to other apps action in the More actions menu.
Allows creating a sync to send data to external business apps such as Slack, Salesforce, and Microsoft Teams.

Action.ManagePipelines

LiveboardEmbed
AppEmbed

The Manage pipelines action in the More actions menu.
Allows managing data sync pipelines to external business apps set as sync destinations in ThoughtSpot.

Action.CrossFilter

LiveboardEmbed
AppEmbed

Filter menu action in the left click menu on a visualization.
Applies filters across visualizations for brushing and linking data on a Liveboard. This menu action is available only when the Cross filters* feature is enabled on your cluster.

Action.RemoveCrossFilter

LiveboardEmbed
AppEmbed

Remove filter option in the left-click menu on a visualization.
Removes the cross-filters applied on a visualization.

Action.DrillDown

LiveboardEmbed
AppEmbed

Drill down
Allows drilling down the visualization to get granular data. Available as a contextual menu action.

Action.DrillExclude

LiveboardEmbed
AppEmbed

Exclude
Allows you to exclude a specific data point on a search answer. Available as a contextual menu action.

Action.DrillInclude

LiveboardEmbed
AppEmbed

Include
Allows you to include a specific data point on a search answer. Available as a contextual menu action.

Action.AnswerChartSwitcher

LiveboardEmbed
AppEmbed

Chart switching toggle
Allows switching to the table or chart mode when editing a visualization.

Liveboard (Classic experience)🔗

The following actions are available for the embedded Liveboard objects:

Action string in SDKRequired SDK libraryAction label in the UI

Action.AddToFavorites

LiveboardEmbed
AppEmbed

The Favorites (star) icon on a Liveboard page.
Allows adding a Liveboard to the user’s favorites list.

Action.EditDetails

LiveboardEmbed
AppEmbed

The edit icon on a Liveboard.
Indicates edit access to the Liveboard.

Action.RequestAcess

LiveboardEmbed
AppEmbed

Request access
Allows you to request access to edit a Liveboard. The Liveboards page shows a locked icon if a user does not have edit access to a Liveboard. A user can request edit access to a Liveboard by clicking the locked icon.

Action.Schedule
Action.Subscription

LiveboardEmbed
AppEmbed

Schedule
Allows scheduling Liveboard notifications.

Action.Share

LiveboardEmbed
AppEmbed

Share
Allows sharing a Liveboard with another user or group.

Action.Save

LiveboardEmbed
AppEmbed

Save
Saves Liveboard modifications.

Action.MakeACopy

LiveboardEmbed
AppEmbed

Make a copy
Creates a copy of the Liveboard.

Action.AddFilter

LiveboardEmbed
AppEmbed

Add filters
Adds filters to visualizations in a Liveboard.

Action.ConfigureFilter

LiveboardEmbed
AppEmbed

Configure filters
Allows configuring filters for visualizations on a Liveboard.

Action.DownloadAsPdf

LiveboardEmbed
AppEmbed

Download as PDF
Downloads the Liveboard as a PDF file.

Action.Present

LiveboardEmbed
AppEmbed

Present
Presents the Liveboard in fullscreen mode.

Action.SchedulesList

LiveboardEmbed
AppEmbed

Manage schedules
Allows you to manage Liveboard jobs.

Action.LiveboardInfo

LiveboardEmbed
AppEmbed

Liveboard info
Displays information about the Liveboard.

Action.EditTML

AppEmbed

Edit TML
Allows editing the ThoughtSpot Modelling Language (TML) representation of a Liveboard object loaded on the ThoughtSpot server.

Action.ImportTML

AppEmbed

Import TML
Allows importing the TML representation of a Liveboard object to ThoughtSpot.

Action.ExportTML

LiveboardEmbed
AppEmbed

Export TML
Exports the TML representation of a Liveboard object from ThoughtSpot.

Action.UpdateTML

LiveboardEmbed
AppEmbed

Update TML
Publishes the modified TML representation of a Liveboard object.

Action.Remove

AppEmbed

Delete
Deletes a Liveboard.

Visualizations on a Liveboard (Classic experience)🔗

The following actions are available for ThoughtSpot visualizations pinned to a Liveboard:

Action string in SDKRequired SDK libraryAction label in the UI

Action.Explore

LiveboardEmbed
AppEmbed

Explore
Allows users to explore a visualization.

Action.CreateMonitor

LiveboardEmbed
AppEmbed

Alert icon
Allows you to schedule threshold-based alerts for KPI charts.

Action.Pin

LiveboardEmbed
AppEmbed

Pin
Pins a visualization to a Liveboard.

Action.SpotIQAnalyze

LiveboardEmbed
AppEmbed

SpotIQ analyze
Allows you to run SpotIQ analyses. Available as a contextual menu action.

Action.ShareViz

LiveboardEmbed
AppEmbed

Share
Allows sharing visualization with another user or group.

Action.Edit

LiveboardEmbed
AppEmbed

Edit
Allows you to edit a visualization. Available only if you have edit privileges to a visualization.

Action.EditTitle

LiveboardEmbed
AppEmbed

The visualization title edit icon.
Changes the title of the visualization.

Action.Present

LiveboardEmbed
AppEmbed

Present
Presents the visualization in a fullscreen mode.

Action.CopyLink

LiveboardEmbed
AppEmbed

Copy link
Displays a link that you can copy and use for embedding a visualization object.

Action.Download

LiveboardEmbed
AppEmbed

Download
Downloads the visualization.

Action.Remove

AppEmbed

Delete
Removes the visualization from the Liveboard.

Action.ToggleSize

LiveboardEmbed
AppEmbed

The Resize icons in the More actions menu.
Allows resizing a visualization on a Liveboard.

Action.DrillDown

LiveboardEmbed
AppEmbed

Drill down
Allows drilling down the visualization to get granular data. Available as a contextual menu action.

Action.DrillExclude

LiveboardEmbed
AppEmbed

Exclude
Allows you to exclude a specific data point on a search answer. Available as a contextual menu action.

Action.DrillInclude

LiveboardEmbed
AppEmbed

Include Allows you to include a specific data point on a search answer. Available as a contextual menu action.

Action.ShowUnderlyingData

LiveboardEmbed
AppEmbed

Show underlying data
Displays detailed information and raw data for a given visualization. Available as a contextual menu action.

Action.AnswerChartSwitcher

LiveboardEmbed
AppEmbed

Chart toggle icon
Allows switching to the table or chart mode when editing a visualization.

Answers🔗

The following actions are available for saved answers and the answers generated using the embedded ThoughtSpot search component:

Action string in SDKRequired SDK libraryAction label in the UI

Action.ChooseDataSources

SearchEmbed
SearchBarEmbed
AppEmbed

Choose sources option in the data panel on a Search page
Allows selecting data sources from which you want to query data.

Action.AddFormula

SearchEmbed
SearchBarEmbed
AppEmbed

Create formula option in the data panel on a Search page
Allows adding formulas to a search query.

Action.AddParameter

SearchEmbed
SearchBarEmbed
AppEmbed

Add Parameters option in the data panel on a Search page
Allows adding parameters to a search Answer.

Action.AnswerChartSwitcher

SearchEmbed
AppEmbed

Chart toggle icon
Allows switching to the table or chart mode.

Action.SpotIQAnalyze

SearchEmbed
AppEmbed

SpotIQ analyze
Allows you to run SpotIQ analyses. Available as a primary button and contextual menu action.

Action.Share

SearchEmbed
AppEmbed

Share
Allows you to share an answer with another user or group.

Action.Pin

SearchEmbed
AppEmbed

Pin
Pins the answer to a Liveboard.

Action.QueryDetailsButtons

SearchEmbed

The Query visualizer and Query SQL buttons in Query details

  • The Query visualizer button displays the tables and filters used in a search query.

  • The Query SQL button displays the SQL statements used in a search query to fetch data.

Action.Save

SearchEmbed
AppEmbed

Save
Saves the answer and any modifications made to the answer.

Action.Download

SearchEmbed
AppEmbed

Download
The Download action to download the Answer data as CSV, PDF, PNG, and XLSX.

If you are using Visual Embed SDK version 1.21.0 or later, note the following behavior:

  • To disable or hide download actions, you can use Action.Download in the disabledActions and hiddenActions arrays respectively.

  • If you are using the visibleActions array to show or hide actions on a visualization or Answer, include the following action enumerations along with Action.Download in the array:

    • Action.DownloadAsCsv

    • Action.DownloadAsPdf

    • Action.DownloadAsXlsx

    • Action.DownloadAsPng

Action.DownloadAsCsv

SearchEmbed
AppEmbed

Download > CSV
Downloads the answer data in the CSV file format.

Action.DownloadAsXLSX

SearchEmbed
AppEmbed

Download > XLSX
Downloads the answer data in the XLSX file format.

Action.DownloadAsPdf

SearchEmbed
AppEmbed

Download > PDF
Downloads the answer data as a PDF file. Available only for tables.

Action.DownloadAsPng

SearchEmbed
AppEmbed

Download > PNG
Downloads the chart as a PNG file. Available only for charts.

Action.ShowUnderlyingData

SearchEmbed
AppEmbed

Show underlying data
Displays detailed information and raw data for a given visualization. Available as a menu action in the More menu the more options menu and the contextual menu.

Action.AnswerDelete

AppEmbed

Delete
Deletes the answer.

Action.SyncToSheets

LiveboardEmbed
AppEmbed

The Sync to sheets action in the More actions menu.
Allows creating a sync to send data to the Google Sheets app.

Action.SyncToOtherApps

LiveboardEmbed
AppEmbed

The Sync to other apps action in the More actions menu.
Allows creating a sync to send data to external business apps such as Slack, Salesforce, and Microsoft Teams.

Action.ManagePipelines

LiveboardEmbed
AppEmbed

The Manage pipelines action in the More actions menu.
Allows managing data sync pipelines to external business apps set as sync destinations in ThoughtSpot.

Action.DrillExclude

SearchEmbed
AppEmbed

Exclude
Allows you to exclude a specific data point on a search answer. Available as a contextual menu action.

Action.DrillInclude

SearchEmbed
AppEmbed

Include
Allows you to include a specific data point on a search answer. Available as a contextual menu action.

Action.DrillDown

SearchEmbed
AppEmbed

Drill down
Allows you to drill down the data for additional details and granular information. Available as a contextual menu action.

Action.CopyToClipboard

SearchEmbed
AppEmbed

Copy to clipboard
Copies the selected data point. Available as a contextual menu action for table data.

Action.ExportTML

SearchEmbed
AppEmbed

Export TML
Exports the TML representation of an answer from ThoughtSpot.

Action.EditTML

AppEmbed

Edit TML
Allows editing the TML representation of the answer object. This action is available on the saved answers page.

Action.ImportTML

AppEmbed

Import TML
Allows importing the TML representation of an answer into ThoughtSpot. This action is available on the saved answers page.

Action.UpdateTML

AppEmbed

Update TML
Publishes the modified TML representation of an answer.

Axis and column customization actions on charts and tables🔗

The SDK provides the following Action enumerations for the contextual menu actions available in the X and Y axis of a chart and column headers of a table in a Liveboard visualization or saved Answer.

Action string in SDKRequired SDK libraryAction label in the UI

Action.AxisMenuAggregate

AppEmbed
SearchEmbed
LiveboardEmbed

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

Action.AxisMenuConditionalFormat

AppEmbed
SearchEmbed
LiveboardEmbed

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

Action.AxisMenuEdit

AppEmbed
SearchEmbed
LiveboardEmbed

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

Action.AxisMenuFilter

AppEmbed
SearchEmbed
LiveboardEmbed

Filter action in the chart axis or table column customization menu.
Allows adding, editing, or removing filters.

Action.AxisMenuGroup

AppEmbed
SearchEmbed
LiveboardEmbed

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.

Action.AxisMenuNumberFormat

AppEmbed
SearchEmbed
LiveboardEmbed

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

Action.AxisMenuPosition

AppEmbed
SearchEmbed
LiveboardEmbed

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

Action.AxisMenuRemove

AppEmbed
SearchEmbed
LiveboardEmbed

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

Action.AxisMenuRename

AppEmbed
SearchEmbed
LiveboardEmbed

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

Action.AxisMenuSort

AppEmbed
SearchEmbed
LiveboardEmbed

Sort option to sort the data in the ascending or descending order on a chart or table.

Action.AxisMenuTextWrapping

AppEmbed
SearchEmbed
LiveboardEmbed

Text wrapping option on a table visualization.
Wraps or clips column text on a table.

Action.AxisMenuTimeBucket

AppEmbed
SearchEmbed
LiveboardEmbed

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

Liveboards list page (Full app embed only)🔗

The following actions are available on the Liveboards page in the embedded view:

Action string in SDKRequired SDK libraryAction label in the UI

Action.Share

AppEmbed

Share
Allows sharing a Liveboard with another user or group.

Action.Remove

AppEmbed

Delete
Allows deleting a Liveboard.

Action.ExportTML

AppEmbed

Export TML
Allows exporting the Liveboard as a TML object.

Action.EditTML

AppEmbed

Edit TML
Opens the TML Editor that allows you to modify the properties of the Liveboard object.

Action.ImportTML

AppEmbed

Import TML
Allows importing the TML representation of Liveboard objects into ThoughtSpot.

Answers list page (Full app embed only)🔗

The following actions are available on the Answers page in the embedded view:

Action string in SDKRequired SDK libraryAction label in the UI

Action.Share

AppEmbed

Share
Allows sharing a saved Answer with another user or group.

Action.Remove

AppEmbed

Delete
Allows deleting an Answer.

Action.ExportTML

AppEmbed

Export TML
Allows exporting a saved Answer as a TML object.

Action.EditTML

AppEmbed

Edit TML
Opens the TML Editor that allows you to modify the properties of an Answer object.

Action.ImportTML

AppEmbed

Import TML
Allows importing the TML representation of Answer objects into ThoughtSpot.

Data page (Full app embed only)🔗

The following action enumerations are available for the menu actions on the Data page in the embedded view:

Action string in SDKRequired SDK libraryAction label in the UI

Action.Share

AppEmbed

Share action on the Data > Home page
Allows sharing a Worksheet, Table, or View with another user or group.

Action.Remove

AppEmbed

Delete action on the Data > Home and Data > Connections pages
Allows deleting a Worksheet, Table, or View.

Action.ExportTML

AppEmbed

Export TML action on the Data > Home page
Allows exporting a Worksheet, Table, or View as a TML file.

Action.EditTML

AppEmbed

Edit TML action on the Data > Home page
Opens the TML Editor that allows you to modify the TML file of Worksheet, Table, or View.

Additional resources🔗