PanelBuilderπ
Constructorπ
Methodsπ
buildπ
Builds the object.
axisBorderShowπ
axisCenteredZeroπ
axisColorModeπ
axisGridShowπ
axisLabelπ
axisPlacementπ
axisSoftMaxπ
axisSoftMinπ
axisWidthπ
barRadiusπ
Controls the radius of each bar.
barWidthπ
Controls the width of bars. 1 = Max width, 0 = Min width.
cacheTimeoutπ
Sets panel queries cache timeout.
colorByFieldπ
Use the color value for a sibling field to color each bar value.
colorSchemeπ
Panel color configuration
datasourceπ
The datasource used in all targets.
decimalsπ
Specify the number of decimals Grafana includes in the rendered value.
If you leave this field blank, Grafana automatically truncates the number of decimals based on the value.
For example 1.1234 will display as 1.12 and 100.456 will display as 100.
To display all decimals, set the unit to String
.
descriptionπ
Panel description.
displayNameπ
The display value for this field. This supports template variables blank is auto
fillOpacityπ
Controls the fill opacity of the bars.
fullHighlightπ
Enables mode which highlights the entire bar area and shows tooltip when cursor
hovers over highlighted area
gradientModeπ
Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.
Gradient appearance is influenced by the Fill opacity setting.
gridPosπ
Grid position.
groupWidthπ
Controls the width of groups. 1 = max with, 0 = min width.
heightπ
Panel height. The height is the number of rows from the top edge of the panel.
hideFromπ
hideTimeOverrideπ
Controls if the timeFrom or timeShift overrides are shown in the panel header
idπ
Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally.
intervalπ
The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.
This value must be formatted as a number followed by a valid time
identifier like: "40s", "3d", etc.
See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options
legendπ
libraryPanelπ
Dynamically load the panel
lineWidthπ
Controls line width of the bars.
linksπ
Panel links.
mappingsπ
Convert input values into a display string
maxπ
The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.
maxDataPointsπ
The maximum number of data points that the panel queries are retrieving.
maxPerRowπ
Option for repeated panels that controls max items per row
Only relevant for horizontally repeated panels
minπ
The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.
noValueπ
Alternative to empty string
orientationπ
Controls the orientation of the bar chart, either vertical or horizontal.
overridesπ
Overrides are the options applied to specific fields overriding the defaults.
overrides(overrides: {
matcher: dashboard.MatcherConfig;
properties: dashboard.DynamicConfigValue[];
}[])
queryCachingTTLπ
Overrides the data source configured time-to-live for a query cache item in milliseconds
repeatπ
Name of template variable to repeat for.
repeatDirectionπ
Direction to repeat in if 'repeat' is set.
h
for horizontal, v
for vertical.
scaleDistributionπ
showValueπ
This controls whether values are shown on top or to the left of bars.
spanπ
Panel width. The width is the number of columns from the left edge of the panel.
stackingπ
Controls whether bars are stacked or not, either normally or in percent mode.
targetsπ
Depends on the panel plugin. See the plugin documentation for details.
textπ
thresholdsπ
Map numeric values to states
thresholdsStyleπ
Threshold rendering
timeFromπ
Overrides the relative time range for individual panels,
which causes them to be different than what is selected in
the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different
time periods or days on the same dashboard.
The value is formatted as time operation like: now-5m
(Last 5 minutes), now/d
(the day so far),
now-5d/d
(Last 5 days), now/w
(This week so far), now-2y/y
(Last 2 years).
Note: Panel time overrides have no effect when the dashboardβs time range is absolute.
See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options
timeShiftπ
Overrides the time range for individual panels by shifting its start and end relative to the time picker.
For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting 2h
.
Note: Panel time overrides have no effect when the dashboardβs time range is absolute.
See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options
titleπ
Panel title.
tooltipπ
transformationsπ
List of transformations that are applied to the panel data before rendering.
When there are multiple transformations, Grafana applies them in the order they are listed.
Each transformation creates a result set that then passes on to the next transformation in the processing pipeline.
transparentπ
Whether to display the panel without a background.
unitπ
Unit a field should use. The unit you select is applied to all fields except time.
You can use the units ID availables in Grafana or a custom unit.
Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts
As custom unit, you can use the following formats:
suffix:<suffix>
for custom unit that should go after value.
prefix:<prefix>
for custom unit that should go before value.
time:<format>
For custom date time formats type for example time:YYYY-MM-DD
.
si:<base scale><unit characters>
for custom SI units. For example: si: mF
. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.
count:<unit>
for a custom count unit.
currency:<unit>
for custom a currency unit.
withOverrideπ
Overrides are the options applied to specific fields overriding the defaults.
withOverride(override: {
matcher: dashboard.MatcherConfig;
properties: dashboard.DynamicConfigValue[];
})
withTargetπ
Depends on the panel plugin. See the plugin documentation for details.
withTransformationπ
List of transformations that are applied to the panel data before rendering.
When there are multiple transformations, Grafana applies them in the order they are listed.
Each transformation creates a result set that then passes on to the next transformation in the processing pipeline.
xFieldπ
Manually select which field from the dataset to represent the x field.
xTickLabelMaxLengthπ
Sets the max length that a label can have before it is truncated.
xTickLabelRotationπ
Controls the rotation of the x axis labels.
xTickLabelSpacingπ
Controls the spacing between x axis labels.
negative values indicate backwards skipping behavior