LibrarypanelLibraryPanelModelBuilderπ
Constructorπ
Methodsπ
buildπ
Builds the object.
cacheTimeoutπ
Sets panel queries cache timeout.
datasourceπ
The datasource used in all targets.
descriptionπ
Panel description.
fieldConfigπ
Field options allow you to change how the data is displayed in your visualizations.
hideTimeOverrideπ
Controls if the timeFrom or timeShift overrides are shown in the panel header
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
linksπ
Panel links.
@param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\DashboardLink>> $links
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
optionsπ
It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.
@param mixed $options
pluginVersionπ
The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs.
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.
targetsπ
Depends on the panel plugin. See the plugin documentation for details.
@param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Cog\Dataquery>> $targets
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.
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.
@param array<\Grafana\Foundation\Dashboard\DataTransformerConfig> $transformations
transparentπ
Whether to display the panel without a background.
typeπ
The panel plugin type id. This is used to find the plugin to display the panel.