QueryBasedWidget is a
datatype for a widget with a visualization of a query result.
Table: QueryBasedWidget
| Parameter | Type | Required | Default | Stability | Description |
|---|---|---|---|---|---|
| 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: Mar 17, 2025 | |||||
description | string | Long-Term | A description of the widget. | ||
end | string | yes | Long-Term | The emd point for events included in the widget's query. | |
height | integer | yes | Long-Term | The height of the widget. | |
id | string | yes | Long-Term | The unique identifier of the widget. | |
interactions | [QueryBasedWidgetInteraction] | yes | Long-Term | The interactions of the query based widget. See QueryBasedWidgetInteraction. | |
isLive | boolean | yes | Long-Term | Whether the query is performed on live, continuous data. | |
options | json | Long-Term | An optional JSON value containing styling and other settings for the widget. This is solely used by the UI. | ||
queryString | string | yes | Long-Term | The query for the widget. | |
start | string | yes | Long-Term | The start point for events included in the widget's query. | |
title | string | yes | Long-Term | The title or heading of the widget. | |
widgetType | string | yes | Long-Term | The type of widget. | |
width | integer | yes | Long-Term | The width of the widget. | |
x | integer | yes | Long-Term | The value of the X axis for the widget. | |
y | integer | yes | Long-Term | The value of the `Y` axis for the widget. | |