Menu
Enterprise Open source

Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

Dashboard kind

Maturity: experimental

Version: 0.0

Properties

PropertyTypeRequiredDescription
editablebooleanYesWhether a dashboard is editable or not. Default: true.
graphTooltipintegerYes0 for no shared crosshair or tooltip (default).
1 for shared crosshair.
2 for shared crosshair AND shared tooltip. Possible values are: 0, 1, 2. Default: 0.
revisionintegerYesVersion of the current dashboard data Default: -1.
schemaVersionintegerYesVersion of the JSON schema, incremented each time a Grafana update brings
changes to said schema.
TODO this is the existing schema numbering system. It will be replaced by Thema’s themaVersion Default: 36.
stylestringYesTheme of dashboard. Possible values are: dark, light. Default: dark.
annotationsobjectNoTODO docs
descriptionstringNoDescription of dashboard.
fiscalYearStartMonthintegerNoThe month that the fiscal year starts on. 0 = January, 11 = December Default: 0.
gnetIdstringNo
idintegerNoUnique numeric identifier for the dashboard.
TODO must isolate or remove identifiers local to a Grafana instance…?
linksDashboardLink[]NoTODO docs
liveNowbooleanNoTODO docs
panelsobject[]No
refreshNoRefresh rate of dashboard. Represented via interval string, e.g. “5s”, “1m”, “1h”, “1d”.
snapshotSnapshotNoTODO docs
tagsstring[]NoTags associated with dashboard.
templatingobjectNoTODO docs
timeobjectNoTime range for dashboard, e.g. last 6 hours, last 7 days, etc
timepickerobjectNoTODO docs
TODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes
timezonestringNoTimezone of dashboard. Accepts IANA TZDB zone ID or “browser” or “utc”. Default: browser.
titlestringNoTitle of dashboard.
uidstringNoUnique dashboard identifier that can be generated by anyone. string (8-40)
versionintegerNoVersion of the dashboard, incremented each time the dashboard is updated.
weekStartstringNoTODO docs

FROM public/app/features/dashboard/state/DashboardModels.ts - ish TODO docs

Properties

PropertyTypeRequiredDescription
asDropdownbooleanYesDefault: false.
iconstringYes
includeVarsbooleanYesDefault: false.
keepTimebooleanYesDefault: false.
tagsstring[]Yes
targetBlankbooleanYesDefault: false.
titlestringYes
tooltipstringYes
typestringYesTODO docs Possible values are: link, dashboards.
urlstringYes

Snapshot

TODO docs

Properties

PropertyTypeRequiredDescription
createdstringYesTODO docs
expiresstringYesTODO docs
externalUrlstringYesTODO docs
externalbooleanYesTODO docs
idintegerYesTODO docs
keystringYesTODO docs
namestringYesTODO docs
orgIdintegerYesTODO docs
updatedstringYesTODO docs
userIdintegerYesTODO docs
urlstringNoTODO docs

annotations

TODO docs

Properties

PropertyTypeRequiredDescription
listAnnotationQuery[]No

AnnotationQuery

TODO docs FROM: AnnotationQuery in grafana-data/src/types/annotations.ts

Properties

PropertyTypeRequiredDescription
builtInintegerYesDefault: 0.
datasourceobjectYesDatasource to use for annotation.
enablebooleanYesWhether annotation is enabled. Default: true.
showInintegerYesDefault: 0.
typestringYesDefault: dashboard.
hidebooleanNoWhether to hide annotation. Default: false.
iconColorstringNoAnnotation icon color.
namestringNoName of annotation.
rawQuerystringNoQuery for annotation data.
targetAnnotationTargetNoTODO docs

AnnotationTarget

TODO docs

Properties
PropertyTypeRequiredDescription
limitintegerYes
matchAnybooleanYes
tagsstring[]Yes
typestringYes

datasource

Datasource to use for annotation.

Properties
PropertyTypeRequiredDescription
typestringNo
uidstringNo

panels

PropertyTypeRequiredDescription

templating

TODO docs

Properties

PropertyTypeRequiredDescription
listVariableModel[]No

VariableModel

FROM: packages/grafana-data/src/types/templateVars.ts TODO docs TODO what about what’s in public/app/features/types.ts? TODO there appear to be a lot of different kinds of [template] vars here? if so need a disjunction

Properties

PropertyTypeRequiredDescription
globalbooleanYesDefault: false.
hideintegerYesPossible values are: 0, 1, 2.
idstringYesDefault: 00000000-0000-0000-0000-000000000000.
indexintegerYesDefault: -1.
namestringYes
skipUrlSyncbooleanYesDefault: false.
statestringYesPossible values are: NotStarted, Loading, Streaming, Done, Error.
typestringYesFROM: packages/grafana-data/src/types/templateVars.ts
TODO docs
TODO this implies some wider pattern/discriminated union, probably? Possible values are: query, adhoc, constant, datasource, interval, textbox, custom, system.
datasourceDataSourceRefNoRef to a DataSource instance
descriptionstringNo
errorobjectNo
labelstringNo
queryNoTODO: Move this into a separated QueryVariableModel type
rootStateKeystringNo

DataSourceRef

Ref to a DataSource instance

Properties
PropertyTypeRequiredDescription
typestringNoThe plugin type-id
uidstringNoSpecific datasource instance

error

PropertyTypeRequiredDescription

time

Time range for dashboard, e.g. last 6 hours, last 7 days, etc

Properties

PropertyTypeRequiredDescription
fromstringYesDefault: now-6h.
tostringYesDefault: now.

timepicker

TODO docs TODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes

Properties

PropertyTypeRequiredDescription
collapsebooleanYesWhether timepicker is collapsed or not. Default: false.
enablebooleanYesWhether timepicker is enabled or not. Default: true.
hiddenbooleanYesWhether timepicker is visible or not. Default: false.
refresh_intervalsstring[]YesSelectable intervals for auto-refresh. Default: [5s 10s 30s 1m 5m 15m 30m 1h 2h 1d].
time_optionsstring[]YesTODO docs Default: [5m 15m 1h 6h 12h 24h 2d 7d 30d].