QueryBasedWidget is a datatype for a widget with a visualization of a query result.

Table: QueryBasedWidget

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 2, 2024
descriptionstring  A description of the widget.
endstringyes The emd point for events included in the widget's query.
heightintegeryes The height of the widget.
idstringyes The unique identifier of the widget.
isLivebooleanyes Whether the query is performed on live, continuous data.
Interactions[QueryBasedWidgetInteraction]yes The interactions of the query based widget. See QueryBasedWidgetInteraction.
optionsjson  An optional JSON value containing styling and other settings for the widget. This is solely used by the UI.
queryStringstringyes The query for the widget.
startstringyes The start point for events included in the widget's query.
titlestringyes The title or heading of the widget.
xintegeryes The value of the `X` axis for the widget.
yintegeryes The value of the `Y` axis for the widget.
widgetTypestringyes The type of widget.
widthintegeryes The width of the widget.