Reference
Field options
Options every data panel and every override accepts, such as unit, decimals, thresholds and mappings.
Fields
| Field | Type | Description |
|---|---|---|
unit |
unit |
A Grafana unit id, or a custom suffix:, prefix:, time:, si:, count: or currency: unit. |
decimals |
integer |
Between 0 and 10. |
min |
number |
|
max |
number |
|
fieldMinMax |
boolean |
Gauges and bar gauges that find their range from the data: true ranges each field by its own values, false (the default) by the values of every field shown. Other panels already range each field by its own values. |
thresholds |
thresholds |
Strictly ascending by value. |
thresholdMode |
"absolute", "percentage" |
|
color |
color |
A semantic color (ok, info, warning, critical, or text, the theme’s text color) or a #rrggbb hex color. |
colorMode |
"palette", "paletteByName", "fixed", "shades", "thresholds", "scheme" |
|
colorScheme |
"greenYellowRed", "redYellowGreen", "blueYellowRed", "yellowRed", "bluePurple", "yellowBlue", "blues", "reds", "greens", "purples", "oranges", "viridis", "magma", "plasma", "inferno", "cividis", "warm" |
|
colorBy |
"last", "min", "max" |
|
displayName |
string |
|
noValue |
string |
|
mappings |
array of mapping |
At most 50 items. |
links |
array of link |
At most 20 items. |
actions |
array of action |
HTTP actions a person with Edit runs from table cells, stat tiles, gauges and bars; only people and imports write them. At most 10 items. |
style |
"line", "bars", "points" |
|
fill |
integer |
Between 0 and 100. |
lineStyle |
"solid", "dashed", "dotted", "square" |
The pattern of a line: dashed, dotted (round dots) or square (square dots). |
lineDash |
array of integer |
The dash and gap lengths in pixels when lineStyle is dashed. At most 2 items. |
lineColor |
color |
A fixed color for the line, overriding the series color for the line only. |
fillColor |
color |
A fixed color for the area fill, overriding the series color for the fill only. |
pointColor |
color |
A fixed color for the points, overriding the series color for the points only. |
showValues |
boolean |
Print each point’s formatted value above it. |
lineInterpolation |
"linear", "smooth", "stepBefore", "stepAfter" |
|
lineWidth |
integer |
Between 0 and 10. |
points |
"auto", "always", "never" |
|
pointSize |
integer |
Between 1 and 40. |
pointShape |
"circle", "square" |
The shape of the points on every panel that draws points. |
pointStrokeWidth |
integer |
Between 0 and 20. |
spanNulls |
boolean or integer |
|
stack |
"none", "normal", "percent" |
|
axis |
"left", "right", "hidden" |
|
hidden |
boolean |
|
axisLabel |
string |
|
axisSoftMin |
number |
|
axisSoftMax |
number |
|
scale |
"linear", "log", "symlog" |
|
logBase |
2, 10 |
|
linearThreshold |
number |
|
axisCenteredZero |
boolean |
|
axisWidth |
integer |
Between 0 and 400. |
axisGrid |
boolean |
|
axisBorder |
boolean |
|
axisColor |
"text", "series" |
|
width |
integer |
A table column’s fixed width in pixels; absent means the column shares the remaining width. Only table panels draw it. Between 20 and 2000. |
minWidth |
integer |
The least width in pixels a table column shrinks to. Only table panels draw it. Between 20 and 2000. |
align |
"auto", "left", "center", "right" |
Where a table column puts its header and cells; auto right-aligns numbers and left-aligns the rest. Only table panels draw it. |
filterable |
boolean |
Adds a value filter to the table column’s header. Only table panels draw it. |
inspect |
boolean |
Adds a button to every cell of the table column that opens its value in a dialog. Only table panels draw it. |
hideHeader |
boolean |
Hides the text of the table column’s header; screen readers still read it. Only table panels draw it. |
wrapHeader |
boolean |
Wraps the text of the table column’s header onto several lines. Only table panels draw it. |
fieldDescription |
string |
Describes the field; a table shows it as a tooltip on the column header. Named apart from the panel’s own description because field props sit beside it on the panel. Only table panels draw it. |
tooltipField |
fieldName |
The name of a field whose value in the same row is shown as a tooltip on this column’s cells. Only table panels draw it. |
tooltipPlacement |
"auto", "top", "bottom", "left", "right" |
Where the cell tooltip of tooltipField opens; auto lets the browser choose. Only table panels draw it. |
cell |
object |
How a table column draws its cells; absent means the plain cell with colors from thresholds and colored mappings. Only table panels draw it. |
valueTransform |
"negativeY", "constant" |
|
hideInLegend |
boolean |
|
hideInTooltip |
boolean |
|
stackGroup |
string |
|
fillBelowTo |
string |
|
insertNulls |
integer or true |
Break the series where two points are further apart than this many milliseconds, or, as true, further apart than the query interval. |
neutral |
number |
The value a gauge or bar gauge bar grows from instead of the minimum. |
nullAsZero |
boolean |
|
barAlignment |
"before", "center", "after" |
|
barWidthFactor |
number |
Between 0.05 and 1. |
barMaxWidth |
integer |
Between 1 and 200. |
thresholdsStyle |
"off", "line", "dashed", "area", "line+area", "dashed+area", "series" |
Generated from spec/schema/observespec.v0.json at bac0fe39. Report a problem.