Menu
Grafana Cloud
Enterprise
Open source
Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
TablePanelCfg
Maturity: experimental
Version: 0.0
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
FieldConfig | object | Yes | ||
Options | object | Yes |
FieldConfig
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
align | string | Yes | TODO – should not be table specific! TODO docs Possible values are: auto, left, right, center. | |
cellOptions | TableCellOptions | Yes | Table cell options. Each cell has a display mode and other potential options for that display. | |
inspect | boolean | Yes | false | |
displayMode | string | No | Internally, this is the “type” of cell that’s being displayed in the table such as colored text, JSON, gauge, etc. The color-background-solid, gradient-gauge, and lcd-gauge modes are deprecated in favor of new cell subOptions Possible values are: auto, color-text, color-background, color-background-solid, gradient-gauge, lcd-gauge, json-view, basic, image, gauge, sparkline, custom. | |
filterable | boolean | No | ||
hidden | boolean | No | ||
hideHeader | boolean | No | Hides any header for a column, useful for columns that show some static content or buttons. | |
minWidth | number | No | ||
width | number | No |
TableCellOptions
Table cell options. Each cell has a display mode and other potential options for that display.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
object | Possible types are: TableAutoCellOptions, TableSparklineCellOptions, TableBarGaugeCellOptions, TableColoredBackgroundCellOptions, TableColorTextCellOptions, TableImageCellOptions, TableJsonViewCellOptions. |
GraphThresholdsStyleConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
mode | string | Yes | TODO docs Possible values are: off, line, dashed, area, line+area, dashed+area, series. |
HideSeriesConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
legend | boolean | Yes | ||
tooltip | boolean | Yes | ||
viz | boolean | Yes |
LineStyle
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
dash | number[] | No | ||
fill | string | No | Possible values are: solid, dash, dot, square. |
ScaleDistributionConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | TODO docs Possible values are: linear, log, ordinal, symlog. | |
linearThreshold | number | No | ||
log | number | No |
StackingConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
group | string | No | ||
mode | string | No | TODO docs Possible values are: none, normal, percent. |
TableAutoCellOptions
Auto mode table cell options
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes |
TableBarGaugeCellOptions
Gauge cell options
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | ||
mode | string | No | Enum expressing the possible display modes for the bar gauge component of Grafana UI Possible values are: basic, lcd, gradient. | |
valueDisplayMode | string | No | Allows for the table cell gauge display type to set the gauge mode. Possible values are: color, text, hidden. |
TableColorTextCellOptions
Colored text cell options
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes |
TableColoredBackgroundCellOptions
Colored background cell options
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | ||
mode | string | No | Display mode to the “Colored Background” display mode for table cells. Either displays a solid color (basic mode) or a gradient. Possible values are: basic, gradient. |
TableImageCellOptions
Json view cell options
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes |
TableJsonViewCellOptions
Json view cell options
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes |
TableSparklineCellOptions
Sparkline cell options
It extends GraphFieldConfig.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | ||
axisBorderShow | boolean | No | (Inherited from GraphFieldConfig) | |
axisCenteredZero | boolean | No | (Inherited from GraphFieldConfig) | |
axisColorMode | string | No | (Inherited from GraphFieldConfig) TODO docs Possible values are: text, series. | |
axisGridShow | boolean | No | (Inherited from GraphFieldConfig) | |
axisLabel | string | No | (Inherited from GraphFieldConfig) | |
axisPlacement | string | No | (Inherited from GraphFieldConfig) TODO docs Possible values are: auto, top, right, bottom, left, hidden. | |
axisSoftMax | number | No | (Inherited from GraphFieldConfig) | |
axisSoftMin | number | No | (Inherited from GraphFieldConfig) | |
axisWidth | number | No | (Inherited from GraphFieldConfig) | |
barAlignment | integer | No | (Inherited from GraphFieldConfig) TODO docs Possible values are: -1, 0, 1. | |
barMaxWidth | number | No | (Inherited from GraphFieldConfig) | |
barWidthFactor | number | No | (Inherited from GraphFieldConfig) | |
drawStyle | string | No | (Inherited from GraphFieldConfig) TODO docs Possible values are: line, bars, points. | |
fillBelowTo | string | No | (Inherited from GraphFieldConfig) | |
fillColor | string | No | (Inherited from GraphFieldConfig) | |
fillOpacity | number | No | (Inherited from GraphFieldConfig) | |
gradientMode | string | No | (Inherited from GraphFieldConfig) TODO docs Possible values are: none, opacity, hue, scheme. | |
hideFrom | HideSeriesConfig | No | (Inherited from GraphFieldConfig) TODO docs | |
hideValue | boolean | No | ||
lineColor | string | No | (Inherited from GraphFieldConfig) | |
lineInterpolation | string | No | (Inherited from GraphFieldConfig) TODO docs Possible values are: linear, smooth, stepBefore, stepAfter. | |
lineStyle | LineStyle | No | (Inherited from GraphFieldConfig) TODO docs | |
lineWidth | number | No | (Inherited from GraphFieldConfig) | |
pointColor | string | No | (Inherited from GraphFieldConfig) | |
pointSize | number | No | (Inherited from GraphFieldConfig) | |
pointSymbol | string | No | (Inherited from GraphFieldConfig) | |
scaleDistribution | ScaleDistributionConfig | No | (Inherited from GraphFieldConfig) TODO docs | |
showPoints | string | No | (Inherited from GraphFieldConfig) TODO docs Possible values are: auto, never, always. | |
spanNulls | No | (Inherited from GraphFieldConfig) Indicate if null values should be treated as gaps or connected. When the value is a number, it represents the maximum delta in the X axis that should be considered connected. For timeseries, this is milliseconds | ||
stacking | StackingConfig | No | (Inherited from GraphFieldConfig) TODO docs | |
thresholdsStyle | GraphThresholdsStyleConfig | No | (Inherited from GraphFieldConfig) TODO docs | |
transform | string | No | (Inherited from GraphFieldConfig) TODO docs Possible values are: constant, negative-Y. |
GraphFieldConfig
TODO docs
It extends LineConfig and FillConfig and PointsConfig and AxisConfig and BarConfig and StackableFieldConfig and HideableFieldConfig.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
axisBorderShow | boolean | No | (Inherited from AxisConfig) | |
axisCenteredZero | boolean | No | (Inherited from AxisConfig) | |
axisColorMode | string | No | (Inherited from AxisConfig) TODO docs Possible values are: text, series. | |
axisGridShow | boolean | No | (Inherited from AxisConfig) | |
axisLabel | string | No | (Inherited from AxisConfig) | |
axisPlacement | string | No | (Inherited from AxisConfig) TODO docs Possible values are: auto, top, right, bottom, left, hidden. | |
axisSoftMax | number | No | (Inherited from AxisConfig) | |
axisSoftMin | number | No | (Inherited from AxisConfig) | |
axisWidth | number | No | (Inherited from AxisConfig) | |
barAlignment | integer | No | (Inherited from BarConfig) TODO docs Possible values are: -1, 0, 1. | |
barMaxWidth | number | No | (Inherited from BarConfig) | |
barWidthFactor | number | No | (Inherited from BarConfig) | |
drawStyle | string | No | TODO docs Possible values are: line, bars, points. | |
fillBelowTo | string | No | (Inherited from FillConfig) | |
fillColor | string | No | (Inherited from FillConfig) | |
fillOpacity | number | No | (Inherited from FillConfig) | |
gradientMode | string | No | TODO docs Possible values are: none, opacity, hue, scheme. | |
hideFrom | HideSeriesConfig | No | (Inherited from HideableFieldConfig) TODO docs | |
lineColor | string | No | (Inherited from LineConfig) | |
lineInterpolation | string | No | (Inherited from LineConfig) TODO docs Possible values are: linear, smooth, stepBefore, stepAfter. | |
lineStyle | LineStyle | No | (Inherited from LineConfig) TODO docs | |
lineWidth | number | No | (Inherited from LineConfig) | |
pointColor | string | No | (Inherited from PointsConfig) | |
pointSize | number | No | (Inherited from PointsConfig) | |
pointSymbol | string | No | (Inherited from PointsConfig) | |
scaleDistribution | ScaleDistributionConfig | No | (Inherited from AxisConfig) TODO docs | |
showPoints | string | No | (Inherited from PointsConfig) TODO docs Possible values are: auto, never, always. | |
spanNulls | No | (Inherited from LineConfig) Indicate if null values should be treated as gaps or connected. When the value is a number, it represents the maximum delta in the X axis that should be considered connected. For timeseries, this is milliseconds | ||
stacking | StackingConfig | No | (Inherited from StackableFieldConfig) TODO docs | |
thresholdsStyle | GraphThresholdsStyleConfig | No | TODO docs | |
transform | string | No | TODO docs Possible values are: constant, negative-Y. |
AxisConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
axisBorderShow | boolean | No | ||
axisCenteredZero | boolean | No | ||
axisColorMode | string | No | TODO docs Possible values are: text, series. | |
axisGridShow | boolean | No | ||
axisLabel | string | No | ||
axisPlacement | string | No | TODO docs Possible values are: auto, top, right, bottom, left, hidden. | |
axisSoftMax | number | No | ||
axisSoftMin | number | No | ||
axisWidth | number | No | ||
scaleDistribution | ScaleDistributionConfig | No | TODO docs |
BarConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
barAlignment | integer | No | TODO docs Possible values are: -1, 0, 1. | |
barMaxWidth | number | No | ||
barWidthFactor | number | No |
FillConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
fillBelowTo | string | No | ||
fillColor | string | No | ||
fillOpacity | number | No |
HideableFieldConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
hideFrom | HideSeriesConfig | No | TODO docs |
LineConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
lineColor | string | No | ||
lineInterpolation | string | No | TODO docs Possible values are: linear, smooth, stepBefore, stepAfter. | |
lineStyle | LineStyle | No | TODO docs | |
lineWidth | number | No | ||
spanNulls | No | Indicate if null values should be treated as gaps or connected. When the value is a number, it represents the maximum delta in the X axis that should be considered connected. For timeseries, this is milliseconds |
PointsConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
pointColor | string | No | ||
pointSize | number | No | ||
pointSymbol | string | No | ||
showPoints | string | No | TODO docs Possible values are: auto, never, always. |
StackableFieldConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
stacking | StackingConfig | No | TODO docs |
Options
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
frameIndex | number | Yes | 0 | Represents the index of the selected frame |
showHeader | boolean | Yes | true | Controls whether the panel should show the header |
cellHeight | string | No | Controls the height of the rows | |
footer | object | No | map[countRows:false reducer:[] show:false] | Controls footer options |
showTypeIcons | boolean | No | false | Controls whether the header should show icons for the column types |
sortBy | TableSortByFieldState[] | No | Used to control row sorting |
TableSortByFieldState
Sort by field state
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
displayName | string | Yes | Sets the display name of the field to sort by | |
desc | boolean | No | Flag used to indicate descending sort order |
Footer
Controls footer options
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
object | Possible types are: , . |
Was this page helpful?
Related resources from Grafana Labs
Getting started with the Grafana LGTM Stack
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.
Getting started with Grafana dashboard design (EMEA Timezone)
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
Unify your data with Grafana plugins: Datadog, Splunk, MongoDB, and more
In this webinar, learn how to leverage Grafana's plugin ecosystem for access to 80+ data sources, including plugins for Datadog, Splunk, MongoDB, and more.