LiveboardEmbed
AppEmbed
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
. 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 |
|---|---|---|
| The Favorites (star) icon on a Liveboard page. | |
| The AI highlights button on a Liveboard page. | |
| Share | |
| Edit | |
| The Request access action for view-only Liveboards. Allows sending a request to the Liveboard owner to obtain edit permissions. | |
Add filters | ||
| The filter configuration options in the Add Filters modal. | |
| The Add Parameters option in the top panel of the Liveboard. | |
| The Add Tab action on a Liveboard. | |
| Action ID to disable or hide the filter visibility on Liveboard tabs. Applicable if the filter visibility on tabs feature is enabled on your instance. | |
| Action ID for disabling filter chip reordering on a Liveboard. | |
| Save | |
| Make a copy | |
| Download as PDF | |
| Download Liveboard | |
| Download Liveboard as Continuous PDF | |
| Download Liveboard as CSV | |
| Download Liveboard as XLSX | |
| Action ID to hide the checkboxes for including or excluding cover and filter pages in the Liveboard PDF download dialog. | |
| Present | |
| Schedule | |
| Manage schedules | |
| Show Liveboard details | |
| The Style panel on a Liveboard. | |
| The Rename menu action on Liveboards. Allows editing the name of the Liveboard. | |
| The Request verification menu action on Liveboards. Initiates a request for Liveboard verification. | |
| The Liveboard verified banner text. | |
| The Liveboard personalized views drop-down. | |
| The Liveboard personalized views drop-down. | |
| The Approve action visible to Liveboard verifiers. | |
| The Manage Alerts menu action on KPI visualizations. | |
| The Create Group menu action on a Liveboard. | |
| The Move to Group menu action on a Liveboard. | |
| The Move out of Group menu action on a Liveboard. | |
| The Ungroup menu action on a Liveboard group. | |
| The Publish action for Liveboards. | |
| The Manage Publishing action for Liveboards. | |
| The Unpublish action for Liveboards. | |
| The Sync to Slack action on Liveboard visualizations. Allows sending data to Slack. | |
| The Sync to Teams action on Liveboard visualizations. Allows sending data to Microsoft Teams. | |
| The Viewers panel inside the Show Liveboard details modal. | |
| Action ID for the parent TML action. The parent action TML must be included to access TML-related options within the cascading menu. | |
| Export TML | |
| Update Liveboard | |
| Edit TML |
Visualizations on a Liveboardπ
The visualizations pinned to a Liveboard have the following types of actions:
-
More menu
actions -
Contextual menu actions
-
Actions for editing chart and table properties in a visualization. For more information on these actions, see Answers.
More (β¦β) options menuπ
The following actions are available for ThoughtSpot visualizations More menu
:
| Action string in SDK | Required SDK library | Action label in the UI |
|---|---|---|
| The Spotter button on a visualization. | |
| Explore | |
| The Create alert icon on KPI charts. | |
| The Manage Alerts menu action on KPI visualizations. | |
| The Analyze call-to-action button on KPI charts. | |
| Initiates contextual change analysis on KPI charts. | |
| Action ID to hide or disable the Iterative Change Analysis option in the contextual change analysis insight charts context menu. | |
| Pin | |
| Download
| |
| Download > CSV | |
| Download > XLSX | |
| Download > PDF | |
| Download > PNG | |
| Copy link | |
| The Resize icons in the More actions menu. | |
| The Sync to sheets action in the More actions menu. | |
| The Sync to other apps action in the More actions menu. | |
| The Manage pipelines action in the More actions menu. | |
| The Viewers panel inside the Show Liveboard details modal. | |
| Delete |
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 |
|---|---|---|
| Filter action in the contextual menu on a visualization. | |
| Remove filter option in the contextual menu on a visualization. | |
| Drill down | |
| Exclude | |
| Include | |
| Chart switching toggle. | |
| The visualization title edit icon. | |
| The Move to tab action on a Liveboard in the edit mode. Allows moving a visualization to a different tab. | |
| SpotIQ analyze | |
| Show underlying data | |
| Copy to clipboard |
Spotterπ
The following action IDs are available for the Spotter component:
| Action string in SDK | Required SDK library | Action label in the UI |
|---|---|---|
| Preview data action on the Spotter conversation panel. | |
| The Reset button on the Spotter conversation panel. | |
| The edit icon on the Spotter prompt panel. | |
| The delete icon on the Spotter prompt panel. | |
| The Spotter feedback widget in the generated Answer. | |
| Action ID to hide or disable editing tokens generated from Spotter results. | |
| The Data model instructions button on the Spotter interface. | |
| Action ID to hide or disable the Add to Coaching workflow in Spotter conversations. | |
| Action ID to hide the warnings banner in Spotter results. | |
| Action ID to hide the warnings border on the knowledge card in Spotter results. | |
| Action ID to disable the click event handler on knowledge cards in Spotter results. | |
| Controls visibility and disable state of the New Chat button in the Spotter past conversations sidebar. | |
| Controls visibility of the past conversation banner alert in the Spotter interface. | |
| Controls visibility of the sidebar header (title and toggle button) in the Spotter past conversations sidebar. | |
| Controls visibility of the sidebar footer (documentation link) in the Spotter past conversations sidebar. | |
| Controls visibility and disable state of the sidebar toggle/expand button in the Spotter past conversations sidebar. | |
| Controls visibility and disable state of the conversation edit menu (three-dot menu) in the Spotter past conversations sidebar. | |
| Controls visibility and disable state of the Rename action in the Spotter conversation edit menu. | |
| Controls visibility and disable state of the Delete action in the Spotter conversation edit menu. | |
| Controls visibility and disable state of the documentation/best practices link in the Spotter sidebar footer. | |
| Controls visibility and disable state of the connectors in the Spotter chat interface. | |
| Controls visibility and disable state of the connector resources section in the Spotter chat interface. | |
| 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.
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 |
|---|---|---|
| The Choose sources option in the Search page and Spotter conversation panel. | |
| Create formula option on the data panel of an Answer page. | |
| Add Parameters option in the data panel on a Search page. | |
| Chart toggle icon. | |
| Edit action on charts and tables generated from a Spotter query. | |
| Pin action on the visualization generated from a Spotter query. | |
| Save action on the visualization generated from a Spotter query. | |
| SpotIQ analyze | |
| Share | |
| The Query visualizer and Query SQL buttons in Query details on the Answer page.
| |
| Download 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:
| |
| Download > CSV | |
| Download > XLSX | |
| Download > PDF | |
| Download > PNG | |
| Show underlying data | |
| Delete | |
| The Sync to sheets action in the More actions menu. | |
| The Sync to other apps action in the More actions menu. | |
| The Manage pipelines action in the More actions menu. | |
| Export TML | |
| Edit TML | |
| Import TML | |
| Update TML |
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 |
|---|---|---|
| Exclude | |
| Include | |
| Drill down | |
| Copy to clipboard |
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 |
|---|---|---|
| Aggregate option in the chart axis or the table column customization menu. | |
| Conditional formatting menu option. | |
| Edit action in the axis customization menu. | |
| Filter action in the chart axis or table column customization menu. | |
| Group option in the chart axis or table column customization menu. | |
| Number format option to customize the format of the data labels on a chart or table. | |
| Position option in axis customization menu. | |
| Remove in the chart axis or table column customization menu. | |
| Rename option in the chart axis or table column customization menu. | |
| Sort option to sort the data in the ascending or descending order on a chart or table. | |
| Text wrapping option on a table visualization. | |
| Time bucket option in the chart axis or table column customization menu. | |
| Compare with option in the chart axis customization menu. | |
| Merge with option in the chart axis customization menu. |
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 |
|---|---|---|
| Share | |
| Delete | |
| The Create Liveboard action on the Liveboards page. Allows users to create a Liveboard. | |
| The Manage Tags action on the Liveboards page. | |
| Export TML |
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 |
|---|---|---|
| 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. | |
| The Collapse data panel icon on the Search page. Collapses the data panel view. | |
| The Add Formula action allows adding formulas to an Answer. | |
| The Add Parameter action allows adding Parameters to an Answer. | |
| The Add Column Set action allows adding column sets to an Answer. | |
| 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 |
|---|---|---|
| Share | |
| Delete | |
| 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 |
|---|---|---|
| Share action on the Data > Home page. | |
| Delete action on the Data > Home and Data > Connections pages. | |
| Export TML action on the Data > Home page. | |
| Edit TML action on the Data > Home page. | |
| 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 |
|---|---|---|
| The Add KPI to Watchlist action on Home page watchlist. | |
| The Remove from watchlist menu action on KPI watchlist. | |
| The Organize Favourites action on Homepage Favorites module. | |
| The Organize Favorites action on Homepage Favorites module. | |
| Copy link | |
| The Edit action on the Liveboard Schedules page. | |
| The Delete action on the Liveboard Schedules page. | |
| The Pause action on the Liveboard Schedules page. | |
| Unsubscribe option for the alerts on the Monitor Subscriptions page. | |
| The View run history action on the Liveboard Schedules page. | |
| Share option for objects in the library. |