WidgetInput is an input datatype for providing settings for widgets when creating or updating a dashboard.

This datatype is used by two other datatypes: CreateDashboardInput, which is used by the createDashboard() mutation field; and UpdateDashboardInput, which is used by the updateDashboard() mutation.

Table: WidgetInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 23, 2024
descriptionstring  Long-TermThe description of the widget.
heightintegeryes Long-TermThe height of the widget.
idstringyes Long-TermThe unique identifier of the widget.
linkOptionsWidgetLinkPropertiesInput  Long-TermAny options related to the URL link for the widget. See WidgetLinkPropertiesInput.
noteOptionsWidgetNotePropertiesInput  Long-TermAny options related to the notes for the widget. See WidgetNotePropertiesInput.
parameterPanelOptionsWidgetParameterPanelPropertiesInput  Long-TermThe parameter of the panel options. See WidgetParameterPanelPropertiesInput.
queryOptionsWidgetQueryPropertiesInput  Long-TermAny options for the query which is the basis of the widget. See WidgetQueryPropertiesInput.
titlestringyes Long-TermThe title to display for the widget.
widthintegeryes Long-TermThe width of the widget.
xintegeryes Long-TermThe value of the X axis for the widget.
yintegeryes Long-TermThe value of the `Y` axis for the widget.