# Action IDs in the SDK > For the complete documentation index, see [llms.txt](https://developers.thoughtspot.com/docs/llms.txt) Source: https://developers.thoughtspot.com/docs/actions # Action IDs in the SDK ThoughtSpot application components such as Liveboards, Answers, visualizations, Search and Spotter interface, and application pages support several actions and menu commands for user-initiated operations. To allow developers to customize the menu options and feature availability for their embedded application users, Visual Embed SDK provides action IDs for the actions in the ThoughtSpot application interface. Developers can use these action IDs in the `visibleActions`, `disabledActions`, or `hiddenActions` arrays to show, disable, or hide specific actions in the embedded view. The availability of these actions may vary based on user privileges and the SDK library used for embedding. For information about the action IDs available for embed components, browse through the lists in the following sections. ## Liveboard The actions associated with the Liveboards are available in the Liveboard header and the **More** options menu ![the more options menu](/docs/doc-images/images/icon-more-10px.png). These actions are also available on the Liveboards page in full application embed. | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.AddToFavorites`]({{navprefix}}/{{Action}}#_addtofavorites) | `LiveboardEmbed` `AppEmbed` | The **Favorites** (star) icon on a Liveboard page. Allows adding a Liveboard to the user’s favorites list. | | [`Action.AIHighlights`]({{navprefix}}/{{Action}}#_aihighlights) | `LiveboardEmbed` `AppEmbed` | The AI highlights button on a Liveboard page. Displays quick insights on how top metrics changed in your Liveboard. To enable **AI Highlights**, ensure that the [KPI anomaly detection](https://docs.thoughtspot.com/cloud/latest/time-series-anomaly) feature is enabled on your instance. | | [`Action.Share`]({{navprefix}}/{{Action}}#_share) | `LiveboardEmbed` `AppEmbed` | **Share** Allows sharing a Liveboard with another user or group. | | [`Action.Edit`]({{navprefix}}/{{Action}}#_edit) | `LiveboardEmbed` `AppEmbed` | **Edit** Allows editing the contents of a Liveboard. Available only if you have edit privileges to the object. | | [`Action.RequestAccess`]({{navprefix}}/{{Action}}#_requestaccess) | `LiveboardEmbed` `AppEmbed` | The **Request access** action for view-only Liveboards. Allows sending a request to the Liveboard owner to obtain edit permissions. | | [`Action.AddFilter`]({{navprefix}}/{{Action}}#_addfilter) | `LiveboardEmbed` `AppEmbed` | **Add filters** Adds filters to visualizations on a Liveboard. | | [`Action.ConfigureFilter`]({{navprefix}}/{{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`]({{navprefix}}/{{Action}}#_addparameter) | `LiveboardEmbed` `AppEmbed` | The **Add Parameters** option in the top panel of the Liveboard. Allows adding parameters to a Liveboard. | | [`Action.AddTab`]({{navprefix}}/{{Action}}#_addtab) | `LiveboardEmbed` `AppEmbed` | The **Add Tab** action on a Liveboard. Allows adding a new tab to a Liveboard view. | | [`Action.ChangeFilterVisibilityInTab`]({{navprefix}}/{{Action}}#_changefiltervisibilityintab) | `LiveboardEmbed` `AppEmbed` | Action ID to disable or hide the filter visibility on Liveboard tabs. Applicable if [the filter visibility on tabs](https://docs.thoughtspot.com/cloud/latest/liveboard-filters#_apply_filters_to_specific_visualizations_or_tabs) feature is enabled on your instance. See also, [hideIrrelevantChipsInLiveboardTabs]({{navprefix}}/{{LiveboardViewConfig}}#_hideirrelevantchipsinliveboardtabs). | | [`Action.DisableChipReorder`]({{navprefix}}/{{Action}}#_disablechipreorder) | `LiveboardEmbed` `SearchEmbed` `AppEmbed` | Action ID for disabling filter chip reordering on a Liveboard. | | [`Action.Save`]({{navprefix}}/{{Action}}#_save) | `LiveboardEmbed` `AppEmbed` | **Save** Saves Liveboard modifications. | | [`Action.MakeACopy`]({{navprefix}}/{{Action}}#_makeacopy) | `LiveboardEmbed` `AppEmbed` | **Make a copy** 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 action is available on both Liveboards and visualizations. | | [`Action.DownloadAsPdf`]({{navprefix}}/{{Action}}#_downloadaspdf) | `LiveboardEmbed` `AppEmbed` | **Download as PDF** Downloads the Liveboard as a PDF file. | | [`Action.DownloadLiveboard`]({{navprefix}}/{{Action}}#_downloadliveboard) | `LiveboardEmbed` `AppEmbed` | **Download Liveboard** Downloads the entire Liveboard. | | [`Action.DownloadLiveboardAsContinuousPDF`]({{navprefix}}/{{Action}}#_downloadliveboardascontinuouspdf) | `LiveboardEmbed` `AppEmbed` | **Download Liveboard as Continuous PDF** Downloads the entire Liveboard as a continuous PDF file. | | [`Action.DownloadLiveboardAsCsv`]({{navprefix}}/{{Action}}#_downloadliveboardascsv) | `LiveboardEmbed` `AppEmbed` | **Download Liveboard as CSV** Downloads the entire Liveboard as a CSV file. | | [`Action.DownloadLiveboardAsXlsx`]({{navprefix}}/{{Action}}#_downloadliveboardasxlsx) | `LiveboardEmbed` `AppEmbed` | **Download Liveboard as XLSX** Downloads the entire Liveboard as an XLSX file. | | [`Action.CoverAndFilterOptionInPDF`]({{navprefix}}/{{Action}}#_coverandfilteroptioninpdf) | `LiveboardEmbed` `AppEmbed` | Action ID to hide the checkboxes for including or excluding cover and filter pages in the Liveboard PDF download dialog. | | [`Action.Present`]({{navprefix}}/{{Action}}#_present) | `LiveboardEmbed` `AppEmbed` | **Present** Presents a fullscreen Liveboard in the slideshow mode. | | [`Action.Schedule`]({{navprefix}}/{{Action}}#_schedule) [`Action.Subscription`]({{navprefix}}/{{Action}}#_subscription) | `LiveboardEmbed` `AppEmbed` | **Schedule** Allows scheduling Liveboard notifications. | | [`Action.SchedulesList`]({{navprefix}}/{{Action}}#_scheduleslist) | `LiveboardEmbed` `AppEmbed` | **Manage schedules** Allows you to manage scheduled Liveboard jobs. | | [`Action.LiveboardInfo`]({{navprefix}}/{{Action}}#_liveboardinfo) | `LiveboardEmbed` `AppEmbed` | **Show Liveboard details** Displays information about the Liveboard. | | [`Action.LiveboardStylePanel`]({{navprefix}}/{{Action}}#_liveboardstylepanel) | `LiveboardEmbed` `AppEmbed` | The **Style panel** on a Liveboard. Controls the visibility of the Liveboard style panel. | | [`Action.RenameModalTitleDescription`]({{navprefix}}/{{Action}}#_renamemodaltitledescription) | `LiveboardEmbed` `AppEmbed` | The **Rename** menu action on Liveboards. Allows editing the name of the Liveboard. | | [`Action.RequestVerification`]({{navprefix}}/{{Action}}#_requestverification) | `LiveboardEmbed` `AppEmbed` | The **Request verification** menu action on Liveboards. Initiates a request for Liveboard verification. | | [`Action.VerifiedLiveboard`]({{navprefix}}/{{Action}}#_verifiedliveboard) | `LiveboardEmbed` `AppEmbed` | The Liveboard verified banner text. Indicates the Liveboard is verified. See also, [showLiveboardVerifiedBadge]({{navprefix}}/{{LiveboardViewConfig}}#_showliveboardverifiedbadge). | | [`Action.PersonalisedViewsDropdown`]({{navprefix}}/{{Action}}#_personalisedviewsdropdown) | `LiveboardEmbed` `AppEmbed` | The Liveboard personalized views drop-down. Available if personalized views are saved on the Liveboard. Allows switching between the saved personalized views of a Liveboard. \[NOTE\] ==== This action is deprecated. Use `Action.PersonalizedViewsDropdown` instead. ==== | | [`Action.PersonalizedViewsDropdown`]({{navprefix}}/{{Action}}#_personalizedviewsdropdown) | `LiveboardEmbed` `AppEmbed` | The Liveboard personalized views drop-down. Allows switching between the saved personalized views of a Liveboard. | | [`Action.MarkAsVerified`]({{navprefix}}/{{Action}}#_markasverified) | `LiveboardEmbed` `AppEmbed` | The **Approve** action visible to Liveboard verifiers. Marks the Liveboard as approved. | | [`Action.ManageMonitor`]({{navprefix}}/{{Action}}#_managemonitor) | `LiveboardEmbed` `AppEmbed` | The **Manage Alerts** menu action on KPI visualizations. Allows creating, viewing, and editing monitor alerts for a KPI chart. | | [`Action.CreateGroup`]({{navprefix}}/{{Action}}#_creategroup) | `LiveboardEmbed` `AppEmbed` | The **Create Group** menu action on a Liveboard. Allows creating a new visualization group on a Liveboard. | | [`Action.MoveToGroup`]({{navprefix}}/{{Action}}#_movetogroup) | `LiveboardEmbed` `AppEmbed` | The **Move to Group** menu action on a Liveboard. Allows moving a visualization to a different group. | | [`Action.MoveOutOfGroup`]({{navprefix}}/{{Action}}#_moveoutofgroup) | `LiveboardEmbed` `AppEmbed` | The **Move out of Group** menu action on a Liveboard. Allows moving a visualization out of a group. | | [`Action.UngroupLiveboardGroup`]({{navprefix}}/{{Action}}#_ungroupliveboardgroup) | `LiveboardEmbed` `AppEmbed` | The **Ungroup** menu action on a Liveboard group. Allows ungrouping a Liveboard visualization group. | | [`Action.Publish`]({{navprefix}}/{{Action}}#_publish) | `LiveboardEmbed` `AppEmbed` | The **Publish** action for Liveboards. Opens the publishing modal. Acts as a parent action for **Manage Publishing** and **Unpublish** if the object is already published. | | [`Action.ManagePublishing`]({{navprefix}}/{{Action}}#_managepublishing) | `LiveboardEmbed` `AppEmbed` | The **Manage Publishing** action for Liveboards. Opens the publishing modal. Appears as a child action to **Publish** if the object is already published. | | [`Action.Unpublish`]({{navprefix}}/{{Action}}#_unpublish) | `LiveboardEmbed` `AppEmbed` | The **Unpublish** action for Liveboards. Appears as a child action to **Publish** if the object is already published. | | [`Action.SyncToSlack`]({{navprefix}}/{{Action}}#_synctoslack) | `LiveboardEmbed` `AppEmbed` | The **Sync to Slack** action on Liveboard visualizations. Allows sending data to Slack. | | [`Action.SyncToTeams`]({{navprefix}}/{{Action}}#_synctoteams) | `LiveboardEmbed` `AppEmbed` | The **Sync to Teams** action on Liveboard visualizations. Allows sending data to Microsoft Teams. | | [`Action.LiveboardUsers`]({{navprefix}}/{{Action}}#_liveboardusers) | `LiveboardEmbed` `AppEmbed` | The **Viewers** panel inside the **Show Liveboard details** modal. Displays the list of users who have access to the Liveboard. Use this action ID to hide the viewers panel in the Liveboard details view. | | [`Action.TML`]({{navprefix}}/{{Action}}#_tml) | `LiveboardEmbed` `AppEmbed` | Action ID for the parent TML action. The parent action **TML** must be included to access TML-related options within the cascading menu. | | [`Action.ExportTML`]({{navprefix}}/{{Action}}#_exporttml) | `LiveboardEmbed` `AppEmbed` | **Export TML** Exports the TML representation of a Liveboard object from ThoughtSpot. The parent action **TML** must be included to access TML-related options within the cascading menu. | | [`Action.UpdateTML`]({{navprefix}}/{{Action}}#_updatetml) | `LiveboardEmbed` `AppEmbed` | **Update Liveboard** Allows importing the TML representation of a Liveboard object to ThoughtSpot. The parent action **TML** must be included to access TML-related options within the cascading menu. | | [`Action.EditTML`]({{navprefix}}/{{Action}}#_edittml) | `LiveboardEmbed` `AppEmbed` | **Edit TML** Allows editing the ThoughtSpot Modelling Language (TML) representation of a Liveboard object loaded on the ThoughtSpot server. The parent action **TML** must be included to access TML-related options within the cascading menu. | ## Visualizations on a Liveboard The visualizations pinned to a Liveboard have the following types of actions: - **More** menu ![the more options menu](/docs/doc-images/images/icon-more-10px.png) actions - Contextual menu actions - Actions for editing chart and table properties in a visualization. For more information on these actions, see [Answers]({{navprefix}}/{{embed-action-ref}}#answer-actions). ### More (…​) options menu The following actions are available for ThoughtSpot visualizations **More** menu ![the more options menu](/docs/doc-images/images/icon-more-10px.png): | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.AskAi`]({{navprefix}}/{{Action}}#_askai) | `LiveboardEmbed` `AppEmbed` | The Spotter button on a visualization. Available if Spotter is enabled on your instance. Allows users to initiate a conversation with Spotter. | | [`Action.Explore`]({{navprefix}}/{{Action}}#_explore) | `LiveboardEmbed` `AppEmbed` | **Explore** Allows users to explore a visualization. | | [`Action.CreateMonitor`]({{navprefix}}/{{Action}}#_createmonitor) | `LiveboardEmbed` `AppEmbed` | The **Create alert** icon on KPI charts. Allows you to schedule threshold-based alerts for KPI charts. | | [`Action.ManageMonitor`]({{navprefix}}/{{Action}}#_managemonitor) | `LiveboardEmbed` `AppEmbed` | The **Manage Alerts** menu action on KPI visualizations. Allows creating, viewing, and editing monitor alerts for a KPI chart. | | [`Action.KPIAnalysisCTA`]({{navprefix}}/{{Action}}#_kpianalysiscta) | `LiveboardEmbed` `AppEmbed` | The **Analyze** call-to-action button on KPI charts. Allows initiating KPI analysis directly from the chart. | | [`Action.EnableContextualChangeAnalysis`]({{navprefix}}/{{Action}}#_enablecontextualchangeanalysis) | `LiveboardEmbed` `AppEmbed` | Initiates contextual change analysis on KPI charts. | | [`Action.EnableIterativeChangeAnalysis`]({{navprefix}}/{{Action}}#_enableiterativechangeanalysis) | `LiveboardEmbed` `AppEmbed` | Action ID to hide or disable the Iterative Change Analysis option in the contextual change analysis insight charts context menu. | | [`Action.Pin`]({{navprefix}}/{{Action}}#_pin) | `LiveboardEmbed` `AppEmbed` | **Pin** Pins a visualization to a Liveboard. | | [`Action.Download`]({{navprefix}}/{{Action}}#_download) | `LiveboardEmbed` `AppEmbed` | **Download** The **Download** menu action to download a visualization as a CSV, PNG, PDF, or XLSX file. 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 using `visibleActions` 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`]({{navprefix}}/{{Action}}#_downloadascsv) | `LiveboardEmbed` `AppEmbed` | **Download** > **CSV** Downloads the answer data in the CSV file format. | | [`Action.DownloadAsXlsx`]({{navprefix}}/{{Action}}#_downloadasxlsx) | `LiveboardEmbed` `AppEmbed` | **Download** > **XLSX** Downloads the answer data in the XLSX file format. | | [`Action.DownloadAsPdf`]({{navprefix}}/{{Action}}#_downloadaspdf) | `LiveboardEmbed` `AppEmbed` | **Download** > **PDF** Downloads the answer data as a PDF file. Available only for tables. | | [`Action.DownloadAsPng`]({{navprefix}}/{{Action}}#_downloadaspng) | `LiveboardEmbed` `AppEmbed` | **Download** > **PNG** Downloads the chart as a PNG file. Available only for charts. | | [`Action.CopyLink`]({{navprefix}}/{{Action}}#_copylink) | `LiveboardEmbed` `AppEmbed` | **Copy link** Displays a link that you can copy and use for embedding a visualization object. | | [`Action.ToggleSize`]({{navprefix}}/{{Action}}#_togglesize) | `LiveboardEmbed` `AppEmbed` | The **Resize** icons in the **More** actions menu. Allows resizing a visualization on a Liveboard. | | [`Action.SyncToSheets`]({{navprefix}}/{{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`]({{navprefix}}/{{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`]({{navprefix}}/{{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.LiveboardUsers`]({{navprefix}}/{{Action}}#_liveboardusers) | `LiveboardEmbed` `AppEmbed` | The **Viewers** panel inside the **Show Liveboard details** modal. Displays the list of users who have access to the Liveboard. Use this action ID to hide the viewers panel in the Liveboard details view. | | [`Action.AnswerDelete`]({{navprefix}}/{{Action}}#_answerdelete) | `LiveboardEmbed` `AppEmbed` | **Delete** Deletes the visualization from the Liveboard. | ### Contextual menu The following actions are available in the contextual menu of visualizations on a Liveboard. These actions are visible when a user right-clicks on a chart or table. | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.CrossFilter`]({{navprefix}}/{{Action}}#_crossfilter) | `LiveboardEmbed` `AppEmbed` | **Filter** action in the contextual menu on a visualization. Applies filters across visualizations for brushing and linking data on a Liveboard. | | [`Action.RemoveCrossFilter`]({{navprefix}}/{{Action}}#_removecrossfilter) | `LiveboardEmbed` `AppEmbed` | **Remove filter** option in the contextual menu on a visualization. Removes the cross-filters applied on a visualization. | | [`Action.DrillDown`]({{navprefix}}/{{Action}}#_drilldown) | `LiveboardEmbed` `AppEmbed` | **Drill down** Allows drilling down on a data point in the visualization to get granular details. | | [`Action.DrillExclude`]({{navprefix}}/{{Action}}#_drillexclude) | `LiveboardEmbed` `AppEmbed` | **Exclude** Allows you to exclude a specific data point on a visualization. | | [`Action.DrillInclude`]({{navprefix}}/{{Action}}#_drillinclude) | `LiveboardEmbed` `AppEmbed` | **Include** Allows you to include a specific data point on a visualization. | | [`Action.AnswerChartSwitcher`]({{navprefix}}/{{Action}}#_answerchartswitcher) | `LiveboardEmbed` `AppEmbed` | Chart switching toggle. Allows switching to the table or chart mode when editing a visualization. | | [`Action.EditTitle`]({{navprefix}}/{{Action}}#_edittitle) | `LiveboardEmbed` `AppEmbed` | The visualization title edit icon. Updates the title of the visualization. | | [`Action.MoveToTab`]({{navprefix}}/{{Action}}#_movetotab) | `LiveboardEmbed` `AppEmbed` | The **Move to tab** action on a Liveboard in the edit mode. Allows moving a visualization to a different tab. | | [`Action.SpotIQAnalyze`]({{navprefix}}/{{Action}}#_spotiqanalyze) | `LiveboardEmbed` `AppEmbed` | **SpotIQ analyze** Allows you to run SpotIQ analyses. | | [`Action.ShowUnderlyingData`]({{navprefix}}/{{Action}}#_showunderlyingdata) | `LiveboardEmbed` `AppEmbed` | **Show underlying data** Displays detailed information and raw data for a given visualization. | | [`Action.CopyToClipboard`]({{navprefix}}/{{Action}}#_copytoclipboard) | `LiveboardEmbed` `AppEmbed` | **Copy to clipboard** Copies the selected data point. Available as a contextual menu action for table data. | ## Spotter The following action IDs are available for the Spotter component: | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.PreviewDataSpotter`]({{navprefix}}/{{Action}}#_previewdataspotter) | `SpotterEmbed` `AppEmbed` | **Preview data** action on the Spotter conversation panel. Shows the underlying data used for Spotter queries. | | [`Action.ResetSpotterChat`]({{navprefix}}/{{Action}}#_resetspotterchat) | `SpotterEmbed` `AppEmbed` | The **Reset** button on the Spotter conversation panel. Clears the current Spotter conversation and starts a new session. | | [`Action.EditPreviousPrompt`]({{navprefix}}/{{Action}}#_editpreviousprompt) | `SpotterEmbed` `AppEmbed` | The edit icon on the Spotter prompt panel. Allows editing the prompt sent to Spotter. | | [`Action.DeletePreviousPrompt`]({{navprefix}}/{{Action}}#_deletepreviousprompt) | `SpotterEmbed` `AppEmbed` | The delete icon on the Spotter prompt panel. Allows deleting the prompt sent to Spotter. | | [`Action.SpotterFeedback`]({{navprefix}}/{{Action}}#_spotterfeedback) | `SpotterEmbed` `AppEmbed` | The Spotter feedback widget in the generated Answer. Allows sending feedback about the response received from Spotter. | | [`Action.EditTokens`]({{navprefix}}/{{Action}}#_edittokens) | `SpotterEmbed` `AppEmbed` | Action ID to hide or disable editing tokens generated from Spotter results. | | [`Action.DataModelInstructions`]({{navprefix}}/{{Action}}#_datamodelinstructions) | `SpotterEmbed` `AppEmbed` | The **Data model instructions** button on the Spotter interface. Allows opening the data model instructions modal. | | [`Action.InConversationTraining`]({{navprefix}}/{{Action}}#_inconversationtraining) | `SpotterEmbed` `AppEmbed` | Action ID to hide or disable the **Add to Coaching** workflow in Spotter conversations. The **Add to Coaching** feature allows adding reference questions and business terms to improve Spotter’s responses. This feature is GA from ThoughtSpot 26.2.0.cl and enabled by default on embed deployments. | | [`Action.SpotterWarningsBanner`]({{navprefix}}/{{Action}}#_spotterwarningsbanner) | `SpotterEmbed` `AppEmbed` | Action ID to hide the warnings banner in Spotter results. | | [`Action.SpotterWarningsOnTokens`]({{navprefix}}/{{Action}}#_spotterwarningsontokens) | `SpotterEmbed` `AppEmbed` | Action ID to hide the warnings border on the knowledge card in Spotter results. | | [`Action.SpotterTokenQuickEdit`]({{navprefix}}/{{Action}}#_spottertokenquickedit) | `SpotterEmbed` `AppEmbed` | Action ID to disable the click event handler on knowledge cards in Spotter results. | | [`Action.SpotterNewChat`]({{navprefix}}/{{Action}}#_spotternewchat) | `SpotterEmbed` `AppEmbed` | Controls visibility and disable state of the **New Chat** button in the Spotter past conversations sidebar. | | [`Action.SpotterPastChatBanner`]({{navprefix}}/{{Action}}#_spotterpastchatbanner) | `SpotterEmbed` `AppEmbed` | Controls visibility of the past conversation banner alert in the Spotter interface. | | [`Action.SpotterSidebarHeader`]({{navprefix}}/{{Action}}#_spottersidebarheader) | `SpotterEmbed` `AppEmbed` | Controls visibility of the sidebar header (title and toggle button) in the Spotter past conversations sidebar. | | [`Action.SpotterSidebarFooter`]({{navprefix}}/{{Action}}#_spottersidebarfooter) | `SpotterEmbed` `AppEmbed` | Controls visibility of the sidebar footer (documentation link) in the Spotter past conversations sidebar. | | [`Action.SpotterSidebarToggle`]({{navprefix}}/{{Action}}#_spottersidebartoggle) | `SpotterEmbed` `AppEmbed` | Controls visibility and disable state of the sidebar toggle/expand button in the Spotter past conversations sidebar. | | [`Action.SpotterChatMenu`]({{navprefix}}/{{Action}}#_spotterchatmenu) | `SpotterEmbed` `AppEmbed` | Controls visibility and disable state of the conversation edit menu (three-dot menu) in the Spotter past conversations sidebar. | | [`Action.SpotterChatRename`]({{navprefix}}/{{Action}}#_spotterchatrename) | `SpotterEmbed` `AppEmbed` | Controls visibility and disable state of the **Rename** action in the Spotter conversation edit menu. | | [`Action.SpotterChatDelete`]({{navprefix}}/{{Action}}#_spotterchatdelete) | `SpotterEmbed` `AppEmbed` | Controls visibility and disable state of the **Delete** action in the Spotter conversation edit menu. | | [`Action.SpotterDocs`]({{navprefix}}/{{Action}}#_spotterdocs) | `SpotterEmbed` `AppEmbed` | Controls visibility and disable state of the documentation/best practices link in the Spotter sidebar footer. | | [`Action.SpotterChatConnectors`]({{navprefix}}/{{Action}}#_spotterchatconnectors) | `SpotterEmbed` `AppEmbed` | Controls visibility and disable state of the connectors in the Spotter chat interface. | | [`Action.SpotterChatConnectorResources`]({{navprefix}}/{{Action}}#_spotterchatconnectorresources) | `SpotterEmbed` `AppEmbed` | Controls visibility and disable state of the connector resources section in the Spotter chat interface. | | [`Action.SpotterChatModeSwitcher`]({{navprefix}}/{{Action}}#_spotterchatmodeswitcher) | `SpotterEmbed` `AppEmbed` | Controls visibility and disable state of the mode switcher in the Spotter chat interface. | For information about the action IDs available for Answers generated from Spotter (`SpotterEmbed`), see [Answers]({{navprefix}}/{{embed-action-ref}}#answer-actions). ## Answers The following actions are available on saved Answers and the Answers generated by passing a search query on the Search Data page or from a conversation with Spotter. | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.ChooseDataSources`]({{navprefix}}/{{Action}}#_choosedatasources) | `SpotterEmbed` `SearchEmbed` `SearchBarEmbed` `AppEmbed` | The **Choose sources** option in the Search page and Spotter conversation panel. Allows selecting data sources to query data. | | [`Action.AddFormula`]({{navprefix}}/{{Action}}#_addformula) | `SpotterEmbed` `SearchEmbed` `SearchBarEmbed` `AppEmbed` | **Create formula** option on the data panel of an Answer page. Allows adding formulas to a search query. | | [`Action.AddParameter`]({{navprefix}}/{{Action}}#_addparameter) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Add Parameters** option in the data panel on a Search page. Allows adding parameters to an Answer. | | [`Action.AnswerChartSwitcher`]({{navprefix}}/{{Action}}#_answerchartswitcher) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | Chart toggle icon. Allows switching to the table or chart mode. | | [`Action.Edit`]({{navprefix}}/{{Action}}#_edit) | `SpotterEmbed` `AppEmbed` | **Edit** action on charts and tables generated from a Spotter query. Opens a table or chart in the edit mode. | | [`Action.Pin`]({{navprefix}}/{{Action}}#_pin) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Pin** action on the visualization generated from a Spotter query. Allows adding a visualization generated from Spotter to a Liveboard. | | [`Action.Save`]({{navprefix}}/{{Action}}#_save) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Save** action on the visualization generated from a Spotter query. Saves the visualization generated from Spotter. | | [`Action.SpotIQAnalyze`]({{navprefix}}/{{Action}}#_spotiqanalyze) | `SearchEmbed` `AppEmbed` | **SpotIQ analyze** Allows generating SpotIQ analyses. Available as a primary button and contextual menu action. | | [`Action.Share`]({{navprefix}}/{{Action}}#_share) | `SearchEmbed` `AppEmbed` | **Share** Allows you to share an Answer with another user or group. | | [`Action.QueryDetailsButtons`]({{navprefix}}/{{Action}}#_querydetailsbuttons) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | The **Query visualizer** and **Query SQL** buttons in **Query details** on the Answer page. - 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.Download`]({{navprefix}}/{{Action}}#_download) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Download** The **Download** action to download the Answer data. If you are using Visual Embed SDK version 1.21.0 or later to embed Liveboard, Search, or full app experience, 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`]({{navprefix}}/{{Action}}#_downloadascsv) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Download** > **CSV** Downloads the answer data in the CSV file format. | | [`Action.DownloadAsXlsx`]({{navprefix}}/{{Action}}#_downloadasxlsx) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Download** > **XLSX** Downloads the answer data in the XLSX file format. | | [`Action.DownloadAsPdf`]({{navprefix}}/{{Action}}#_downloadaspdf) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Download** > **PDF** Downloads the answer data as a PDF file. Available only for tables. | | [`Action.DownloadAsPng`]({{navprefix}}/{{Action}}#_downloadaspng) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Download** > **PNG** Downloads the chart as a PNG file. Available only for charts. | | [`Action.ShowUnderlyingData`]({{navprefix}}/{{Action}}#_showunderlyingdata) | `SpotterEmbed` `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](/docs/doc-images/images/icon-more-10px.png) and the contextual menu. | | [`Action.AnswerDelete`]({{navprefix}}/{{Action}}#_answerdelete) | `AppEmbed` | **Delete** Deletes the answer. | | [`Action.SyncToSheets`]({{navprefix}}/{{Action}}#_synctosheets) | `SearchEmbed` `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`]({{navprefix}}/{{Action}}#_synctootherapps) | `SearchEmbed` `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`]({{navprefix}}/{{Action}}#_managepipelines) | `SearchEmbed` `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.ExportTML`]({{navprefix}}/{{Action}}#_exporttml) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Export TML** Exports the TML representation of an answer from ThoughtSpot. | | [`Action.EditTML`]({{navprefix}}/{{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`]({{navprefix}}/{{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`]({{navprefix}}/{{Action}}#_updatetml) | `AppEmbed` | **Update TML** Publishes the modified TML representation of an answer. | ### Contextual menu The following actions are available in the contextual menu of an Answer: | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.DrillExclude`]({{navprefix}}/{{Action}}#_drillexclude) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Exclude** Allows you to exclude a specific data point when drilling down on an Answer. | | [`Action.DrillInclude`]({{navprefix}}/{{Action}}#_drillinclude) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Include** Allows you to include a specific data point during drill down on an Answer. | | [`Action.DrillDown`]({{navprefix}}/{{Action}}#_drilldown) | `SpotterEmbed` `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`]({{navprefix}}/{{Action}}#_copytoclipboard) | `SpotterEmbed` `SearchEmbed` `AppEmbed` | **Copy to clipboard** Copies the selected data point. Available as a contextual menu action for table data. | ## Axis and column customization menu 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 on the Answer page. | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.AxisMenuAggregate`]({{navprefix}}/{{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`]({{navprefix}}/{{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`]({{navprefix}}/{{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`]({{navprefix}}/{{Action}}#_axismenufilter) | `AppEmbed` `SearchEmbed` `LiveboardEmbed` | **Filter** action in the chart axis or table column customization menu. Allows adding, editing, or removing filters. | | [`Action.AxisMenuGroup`]({{navprefix}}/{{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`]({{navprefix}}/{{Action}}#_axismenunumberformat) | `AppEmbed` `SearchEmbed` `LiveboardEmbed` | **Number format** option to customize the format of the data labels on a chart or table. | | [`Action.AxisMenuPosition`]({{navprefix}}/{{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`]({{navprefix}}/{{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`]({{navprefix}}/{{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`]({{navprefix}}/{{Action}}#_axismenusort) | `AppEmbed` `SearchEmbed` `LiveboardEmbed` | **Sort** option to sort the data in the ascending or descending order on a chart or table. | | [`Action.AxisMenuTextWrapping`]({{navprefix}}/{{Action}}#_axismenutextwrapping) | `AppEmbed` `SearchEmbed` `LiveboardEmbed` | **Text wrapping** option on a table visualization. Wraps or clips column text on a table. | | [`Action.AxisMenuTimeBucket`]({{navprefix}}/{{Action}}#_axismenutimebucket) | `AppEmbed` `SearchEmbed` `LiveboardEmbed` | **Time bucket** option in the chart axis or table column customization menu. Allows defining time metric for date comparison. | | [`Action.AxisMenuCompare`]({{navprefix}}/{{Action}}#_axismenucompare) | `AppEmbed` `SearchEmbed` `LiveboardEmbed` | **Compare with** option in the chart axis customization menu. Allows comparing data across dimensions or measures. | | [`Action.AxisMenuMerge`]({{navprefix}}/{{Action}}#_axismenumerge) | `AppEmbed` `SearchEmbed` `LiveboardEmbed` | **Merge with** option in the chart axis customization menu. Allows merging data across dimensions or measures. | ## Full app embed ### Liveboards page The following actions are available on the **Liveboards** page in the full app embedded view: | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.Share`]({{navprefix}}/{{Action}}#_share) | `AppEmbed` | **Share** Allows sharing a Liveboard with another user or group. | | [`Action.Remove`]({{navprefix}}/{{Action}}#_remove) | `AppEmbed` | **Delete** Allows deleting a Liveboard. | | [`Action.CreateLiveboard`]({{navprefix}}/{{Action}}#_createliveboard) | `AppEmbed` | The **Create Liveboard** action on the Liveboards page. Allows users to create a Liveboard. | | [`Action.ManageTags`]({{navprefix}}/{{Action}}#_managetags) | `AppEmbed` | The **Manage Tags** action on the Liveboards page. | | [`Action.ExportTML`]({{navprefix}}/{{Action}}#_exporttml) | `AppEmbed` | **Export TML** Exports the TML representation of a Liveboard object from ThoughtSpot. | ### Search page The following actions are available on the **Search** page in the full app embedded view: | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.AddDataPanelObjects`]({{navprefix}}/{{Action}}#_adddatapanelobjects) | `AppEmbed` | The **Add Data Panel Objects** action on the data panel v2. Allows showing action menu to add different objects (such as formulas, Parameters) in the data panel new experience. | | [`Action.CollapseDataPanel`]({{navprefix}}/{{Action}}#_collapsedatapanel) | `AppEmbed` | The **Collapse data panel** icon on the Search page. Collapses the data panel view. | | [`Action.AddFormula`]({{navprefix}}/{{Action}}#_addformula) | `AppEmbed` | The **Add Formula** action allows adding formulas to an Answer. | | [`Action.AddParameter`]({{navprefix}}/{{Action}}#_addparameter) | `AppEmbed` | The **Add Parameter** action allows adding Parameters to an Answer. | | [`Action.AddColumnSet`]({{navprefix}}/{{Action}}#_addcolumnset) | `AppEmbed` | The **Add Column Set** action allows adding column sets to an Answer. | | [`Action.AddQuerySet`]({{navprefix}}/{{Action}}#_addqueryset) | `AppEmbed` | The **Add Query Set** action allows adding query sets to an Answer. | ### Answers page The following actions are available on the **Answers** page in the full app embedded view: | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.Share`]({{navprefix}}/{{Action}}#_share) | `AppEmbed` | **Share** Allows sharing a saved Answer with another user or group. | | [`Action.Remove`]({{navprefix}}/{{Action}}#_remove) | `AppEmbed` | **Delete** Allows deleting an Answer. | | [`Action.ManageTags`]({{navprefix}}/{{Action}}#_managetags) | `AppEmbed` | The **Manage Tags** action on the Answers page. | ### Data Workspace page The following actions are available on the **Data** page in the full app embedded view. | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.Share`]({{navprefix}}/{{Action}}#_share) | `AppEmbed` | **Share** action on the **Data** > **Home** page. Allows sharing a Model, Table, or View with another user or group. | | [`Action.Remove`]({{navprefix}}/{{Action}}#_remove) | `AppEmbed` | **Delete** action on the **Data** > **Home** and **Data** > **Connections** pages. Allows deleting a Model, Table, or View. | | [`Action.ExportTML`]({{navprefix}}/{{Action}}#_exporttml) | `AppEmbed` | **Export TML** action on the **Data** > **Home** page. Allows exporting a Model, Table, or View as a TML file. | | [`Action.EditTML`]({{navprefix}}/{{Action}}#_edittml) | `AppEmbed` | **Edit TML** action on the **Data** > **Home** page. Opens the TML Editor that allows you to modify the TML file of a Model, Table, or View. | | [`Action.ImportTML`]({{navprefix}}/{{Action}}#_importtml) | `AppEmbed` | The **Import TML** menu action imports the TML representation of ThoughtSpot objects. | ### Home (New Homepage experience) The following actions are available on the **Home** page in the full app embedded view. | Action string in SDK | Required SDK library | Action label in the UI | | --- | --- | --- | | [`Action.AddToWatchlist`]({{navprefix}}/{{Action}}#_addtowatchlist) | `AppEmbed` | The **Add KPI to Watchlist** action on Home page watchlist. Adds a KPI chart to the watchlist on the Home page. | | [`Action.RemoveFromWatchlist`]({{navprefix}}/{{Action}}#_removefromwatchlist) | `AppEmbed` | The **Remove from watchlist** menu action on KPI watchlist. Removes a KPI chart from the watchlist on the Home page. | | [`Action.OrganiseFavourites`]({{navprefix}}/{{Action}}#_organisefavourites) | `AppEmbed` | The **Organize Favourites** action on Homepage Favorites module. \[NOTE\] ==== This action is deprecated. Use `Action.OrganizeFavorites` instead. ==== | | [`Action.OrganizeFavorites`]({{navprefix}}/{{Action}}#_organizefavorites) | `AppEmbed` | The **Organize Favorites** action on Homepage Favorites module. | | [`Action.CopyLink`]({{navprefix}}/{{Action}}#_copylink) | `AppEmbed` | **Copy link** Allows users to copy a link from the **Watchlist** on the Homepage. | | [`Action.EditScheduleHomepage`]({{navprefix}}/{{Action}}#_editschedulehomepage) | `AppEmbed` | The **Edit** action on the **Liveboard Schedules** page. Allows editing Liveboard schedules. | | [`Action.DeleteScheduleHomepage`]({{navprefix}}/{{Action}}#_deleteschedulehomepage) | `AppEmbed` | The **Delete** action on the Liveboard Schedules page. Deletes a Liveboard schedule. | | [`Action.PauseScheduleHomepage`]({{navprefix}}/{{Action}}#_pauseschedulehomepage) | `AppEmbed` | The **Pause** action on the **Liveboard Schedules** page. Pauses a scheduled Liveboard job. | | [`Action.UnsubscribeScheduleHomepage`]({{navprefix}}/{{Action}}#_unsubscribeschedulehomepage) | `AppEmbed` | **Unsubscribe** option for the alerts on the **Monitor Subscriptions** page. Unsubscribes from alerts. | | [`Action.ViewScheduleRunHomepage`]({{navprefix}}/{{Action}}#_viewschedulerunhomepage) | `AppEmbed` | The **View run history** action on the Liveboard Schedules page. Allows viewing schedule run history. | | [`Action.Share`]({{navprefix}}/{{Action}}#_share) | `AppEmbed` | **Share** option for objects in the library. Allows sharing an object with another user. |