PanelBuilderπ
Constructorπ
Methodsπ
buildπ
Builds the object.
cacheTimeoutπ
Sets panel queries cache timeout.
colorSchemeπ
Panel color configuration
@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\FieldColor> $color
dataLinksπ
The behavior when clicking on a result
@param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\DashboardLink>> $links
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
.
dedupStrategyπ
descriptionπ
Panel description.
displayNameπ
The display value for this field. This supports template variables blank is auto
displayedFieldsπ
@param array Grid position. Panel height. The height is the number of rows from the top edge of the panel. Controls if the timeFrom or timeShift overrides are shown in the panel header Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. 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 @param mixed $isFilterLabelActive Dynamically load the panel Panel links. @param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\DashboardLink>> $links @param mixed $logRowMenuIconsAfter @param mixed $logRowMenuIconsBefore Convert input values into a display string @param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\ValueMap>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\RangeMap>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\RegexMap>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\SpecialValueMap>> $mappings The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. The maximum number of data points that the panel queries are retrieving. Option for repeated panels that controls max items per row Only relevant for horizontally repeated panels The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. Alternative to empty string TODO: figure out how to define callbacks @param mixed $onClickFilterLabel @param mixed $onClickFilterOutLabel @param mixed $onClickFilterOutString @param mixed $onClickFilterString @param mixed $onClickHideField @param mixed $onClickShowField Overrides are the options applied to specific fields overriding the defaults. @param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\DashboardFieldConfigSourceOverrides>> $overrides Overrides the data source configured time-to-live for a query cache item in milliseconds Name of template variable to repeat for. Direction to repeat in if 'repeat' is set. Panel width. The width is the number of columns from the left edge of the panel. Depends on the panel plugin. See the plugin documentation for details. @param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Cog\Dataquery>> $targets Map numeric values to states @param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\ThresholdsConfig> $thresholds 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: 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 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 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 Panel title. 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. @param array<\Grafana\Foundation\Dashboard\DataTransformerConfig> $transformations Whether to display the panel without a background. 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: Overrides are the options applied to specific fields overriding the defaults. @param array<\Grafana\Foundation\Dashboard\DynamicConfigValue> $properties Depends on the panel plugin. See the plugin documentation for details. @param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Cog\Dataquery> $target 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. enableLogDetailsπ
gridPosπ
heightπ
hideTimeOverrideπ
idπ
intervalπ
isFilterLabelActiveπ
libraryPanelπ
linksπ
logRowMenuIconsAfterπ
logRowMenuIconsBeforeπ
mappingsπ
maxπ
maxDataPointsπ
maxPerRowπ
minπ
noValueπ
onClickFilterLabelπ
onClickFilterOutLabelπ
onClickFilterOutStringπ
onClickFilterStringπ
onClickHideFieldπ
onClickShowFieldπ
overridesπ
prettifyLogMessageπ
queryCachingTTLπ
repeatπ
repeatDirectionπ
h
for horizontal, v
for vertical. showCommonLabelsπ
showLabelsπ
showLogContextToggleπ
showTimeπ
sortOrderπ
spanπ
targetsπ
thresholdsπ
timeFromπ
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). timeShiftπ
2h
. titleπ
transformationsπ
transparentπ
unitπ
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π
withTargetπ
withTransformationπ
wrapLogMessageπ
See alsoπ