Collapse data panel
Minimizes the data panel on the left navigation bar.
The Playground allows developers to try Visual Embed APIs, play with the code, and view results instantly.
You can explore the following SDK components in the Playground.
To explore the Search embed function:
Go to Playground > Search.
Select a data source or a saved Answer.
Try using any of the following customization settings and click Run to preview the result.
Hide data panel Hides the default data panel. You can use this function to create a custom data panel when embedding the search module in your application. | ||||
Hide chart or table Hides the charts and tables that appear beneath the search bar by default. For example, if you want to create a custom visualization using raw data from an existing Answer, you can enable this checkbox. | ||||
Modify available actions Allows you to show or hide the primary buttons or menu actions that appear in More
For more information, see Show or hide actions. | ||||
Add search tokens Allows constructing a TML-based search query string to set search tokens and execute search. The following example shows how to create a search a
| ||||
Handle custom actions Allows you to view the code for a custom action event. If the embedded instance has a custom action, use this checkbox to view the event generated by the custom action and send ThoughtSpot data as a payload. |
To explore the visualization embedding function:
Go to Playground > Visualization.
Select a Liveboard or visualization.
Try using any of the following customization settings and click Run to preview the result.
Modify available actions Allows you to show or hide the primary buttons or menu actions that appear in More
For more information, see Show or hide actions. | ||||
Set runtime filters Enables Runtime Filters. Runtime filters provide the ability to filter data at the time of retrieval.
To apply Runtime Filters, pass the
For more information, see Runtime filters. | ||||
Handle custom actions Allows you to view the code for a custom action event. If the embedded instance has a custom action, use this checkbox to view the event generated by the custom action and send ThoughtSpot data as a payload. | ||||
Enable Search Assist Enables the Search Assist feature that provides a custom onboarding experience for users searching data on an embedded instance. With Search Assist, data engineers and Worksheet owners can create a set of questions to assist users with the search. + Try it out + |
To explore the Liveboard embedding SDK functions:
Go to Playground > Liveboard.
Select a Liveboard.
Try using any of the following customization settings and click Run to preview the result.
Full Height Dynamically resizes the embedded Liveboard frame according to the height of the Liveboard. If the embedded Liveboard does not fit vertically within your application page, a second scroll bar may appear. When Full Height is selected, the embedded Liveboard container is automatically adjusted according to the height of the Liveboard. | ||||
Modify available actions Allows you to show or hide the primary buttons or menu actions that appear in More
For more information, see Show or hide actions. | ||||
Set runtime filters Enables Runtime Filters on a visualization in a Liveboard. Runtime filters provide the ability to filter data at the time of retrieval.
To apply Runtime Filters, pass the
For more information, see Runtime filters. | ||||
Handle custom actions Allows you to view the code for a custom action event. If the embedded instance has a custom action, use this checkbox to view the event generated by the custom action and send ThoughtSpot data as a payload. |
To explore the full ThoughtSpot embedding function:
Go to Playground > Full app.
Select a tab to set a default page view for embedded application users.
Try using any of the following customization settings and click Run to preview the result.
Modify available actions Allows you to show or hide the primary buttons or menu actions that appear in More
For more information, see Show or hide actions. | ||||
Show navigation bar Displays the ThoughtSpot top navigation bar. By default, the navigation bar is hidden. | ||||
Navigate to URL Allows you to define a specific URL path for loading a ThoughtSpot application page. For example, you can set the path to a specific Liveboard page as shown here: path: 'pinboard/d084c256-e284-4fc4-b80c-111cb606449a' If both | ||||
Set runtime filters Enables Runtime Filters on a visualization in a Liveboard. Runtime filters provide the ability to filter data at the time of retrieval.
To apply Runtime Filters, pass the
For more information, see Runtime filters. | ||||
Handle custom actions Allows you to view the code for a custom action event. If the embedded instance has a custom action, use this checkbox to view the event generated by the custom action and send ThoughtSpot data as a payload. |