Gizmo Type: parameterGizmo

Content

parameterGizmo

Description

Example

Properties

Description

The parameterGizmo allows you to pass parameters into a Gizmo that renders functionality in a Dashboard.

Example

See Dashboards → Parameter Gizmos.

parameterGizmo Properties
Property Name Description
Gizmo Properties Defines high-level characteristics of the Gizmo:
Property NameDescription
title title of the Gizmo.
Tab IdIf using tabs, specify an identifier for the tab. If not using tabs, leave this blank. If you leave this blank and you are using tabs, the Gizmo will not be displayed.
Show GizmoYes/No shows/hides the Gizmo.
WidthWidth of the Gizmo in pixels.
HeightHeight of the Gizmo in pixels.
Enable ResizeYes/No allows/prevents resizing of the Gizmo.
Options Details concerning properties that appear on options dialogs:
Property NameDescription
Property Id Identifier of the property that appears on an options dialog. If this is in a collection or property list, include the full path using the dot character (.) as a separator.
EditableNo disables editing of the property, but it will still be visible.
Parameters Choose the Parameters to define.
Property NameDescription
Parameter IdUnique identifier for this Parameter.
Editor styleChoose an Editor style for the input field.
Default ValueDefault value for this Parameter.
titletitle for the input field.
Read OnlyWhen Parameters are set from other Gizmos, sent into the request, or set in the API, a Read Only parameter can be used to show the parameter value (such as selection of Samples or the currently selected Query).
To Refresh Identifies which Gizmos to refresh when Parameters are changed.