Panelπ
Constructorπ
Methodsπ
buildπ
Builds the object.
axis_border_showπ
axis_centered_zeroπ
axis_color_modeπ
axis_grid_showπ
axis_labelπ
axis_placementπ
axis_soft_maxπ
axis_soft_minπ
axis_widthπ
cache_timeoutπ
Sets panel queries cache timeout.
color_schemeπ
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.
dimsπ
Table Mode (auto)
display_nameπ
The display value for this field. This supports template variables blank is auto
grid_posπ
Grid position.
heightπ
Panel height. The height is the number of rows from the top edge of the panel.
hide_fromπ
hide_time_overrideπ
Controls if the timeFrom or timeShift overrides are shown in the panel header
id_valπ
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
labelπ
label_valueπ
legendπ
library_panelπ
Dynamically load the panel
line_colorπ
line_styleπ
line_widthπ
linksπ
Panel links.
mappingsπ
Convert input values into a display string
max_valπ
The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.
max_data_pointsπ
The maximum number of data points that the panel queries are retrieving.
max_per_rowπ
Option for repeated panels that controls max items per row
Only relevant for horizontally repeated panels
min_valπ
The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.
no_valueπ
Alternative to empty string
overridesπ
Overrides are the options applied to specific fields overriding the defaults.
def overrides(overrides: list[cogbuilder.Builder[dashboard.DashboardFieldConfigSourceOverrides]]) -> typing.Self
point_colorπ
point_sizeπ
query_caching_ttlπ
Overrides the data source configured time-to-live for a query cache item in milliseconds
repeatπ
Name of template variable to repeat for.
repeat_directionπ
Direction to repeat in if 'repeat' is set.
h
for horizontal, v
for vertical.
scale_distributionπ
def scale_distribution(scale_distribution: cogbuilder.Builder[common.ScaleDistributionConfig]) -> typing.Self
seriesπ
Manual Mode
series_mappingπ
showπ
spanπ
Panel width. The width is the number of columns from the left edge of the panel.
targetsπ
Depends on the panel plugin. See the plugin documentation for details.
thresholdsπ
Map numeric values to states
time_fromπ
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
time_shiftπ
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.
with_overrideπ
Overrides are the options applied to specific fields overriding the defaults.
def with_override(matcher: dashboard.MatcherConfig, properties: list[dashboard.DynamicConfigValue]) -> typing.Self
with_targetπ
Depends on the panel plugin. See the plugin documentation for details.
with_transformationπ
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.