Interaction
Every widget not just display the data, but allows to interact with the data. These capabilities varies from a widget to widget, but there are common features.
Any widget has a set of button displayed on the bottom:
The buttons have the following meaning:
- JS shows the code to embed on the web page to display this widget. Look Embedding widgets for details
- GraphQL shows the GraphiQL interface allowing to construct queries
- CSV button is optional, allows to download results displayed on the widget, as a CSV file
GraphiQL is a visual tool, called with a button from every widget.
Using this tool, you can:
- see, edit GraphQL query for the widget. Use the left query pane to edit the query. Note that GraphiQL helps you to edit the query by auto completion and error highlighting. Refer to the GraphiQL documentation on usage details.
- execute the query by pressing "Play" button on the top and see the response on the right pane
- apply the changes by pressing "Apply" button on the bottom and displaying modified query on widget. Note, that the widget query is not saved in the widget, and after page reloading they will be lost, unless the page is programmed in the special way to save that changes.
- navigate GraphQL schema and explore new requests. Button "Docs" opens the GraphQL schema navigator, which is a very useful tool for API exploration and building new queries.