Panel🔗

Constructor🔗

Panel()

Methods🔗

build🔗

Builds the object.

def build() -> dashboard.Panel

axis_border_show🔗

def axis_border_show(axis_border_show: bool) -> typing.Self

axis_centered_zero🔗

def axis_centered_zero(axis_centered_zero: bool) -> typing.Self

axis_color_mode🔗

def axis_color_mode(axis_color_mode: common.AxisColorMode) -> typing.Self

axis_grid_show🔗

def axis_grid_show(axis_grid_show: bool) -> typing.Self

axis_label🔗

def axis_label(axis_label: str) -> typing.Self

axis_placement🔗

def axis_placement(axis_placement: common.AxisPlacement) -> typing.Self

axis_soft_max🔗

def axis_soft_max(axis_soft_max: float) -> typing.Self

axis_soft_min🔗

def axis_soft_min(axis_soft_min: float) -> typing.Self

axis_width🔗

def axis_width(axis_width: float) -> typing.Self

bar_alignment🔗

def bar_alignment(bar_alignment: common.BarAlignment) -> typing.Self

bar_max_width🔗

def bar_max_width(bar_max_width: float) -> typing.Self

bar_width_factor🔗

def bar_width_factor(bar_width_factor: float) -> typing.Self

cache_timeout🔗

Sets panel queries cache timeout.

def cache_timeout(cache_timeout: str) -> typing.Self

candle_style🔗

Sets the style of the candlesticks

def candle_style(candle_style: candlestick.CandleStyle) -> typing.Self

color_scheme🔗

Panel color configuration

def color_scheme(color: cogbuilder.Builder[dashboard.FieldColor]) -> typing.Self

color_strategy🔗

Sets the color strategy for the candlesticks

def color_strategy(color_strategy: candlestick.ColorStrategy) -> typing.Self

colors🔗

Set which colors are used when the price movement is up or down

def colors(colors: cogbuilder.Builder[candlestick.CandlestickColors]) -> typing.Self

data_links🔗

The behavior when clicking on a result

def data_links(links: list[cogbuilder.Builder[dashboard.DashboardLink]]) -> typing.Self

datasource🔗

The datasource used in all targets.

def datasource(datasource: dashboard.DataSourceRef) -> typing.Self

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.

def decimals(decimals: float) -> typing.Self

description🔗

Panel description.

def description(description: str) -> typing.Self

display_name🔗

The display value for this field. This supports template variables blank is auto

def display_name(display_name: str) -> typing.Self

draw_style🔗

def draw_style(draw_style: common.GraphDrawStyle) -> typing.Self

fields🔗

Map fields to appropriate dimension

def fields(fields: cogbuilder.Builder[candlestick.CandlestickFieldMap]) -> typing.Self

fill_below_to🔗

def fill_below_to(fill_below_to: str) -> typing.Self

fill_color🔗

def fill_color(fill_color: str) -> typing.Self

fill_opacity🔗

def fill_opacity(fill_opacity: float) -> typing.Self

gradient_mode🔗

def gradient_mode(gradient_mode: common.GraphGradientMode) -> typing.Self

grid_pos🔗

Grid position.

def grid_pos(grid_pos: dashboard.GridPos) -> typing.Self

height🔗

Panel height. The height is the number of rows from the top edge of the panel.

def height(h: int) -> typing.Self

hide_from🔗

def hide_from(hide_from: cogbuilder.Builder[common.HideSeriesConfig]) -> typing.Self

hide_time_override🔗

Controls if the timeFrom or timeShift overrides are shown in the panel header

def hide_time_override(hide_time_override: bool) -> typing.Self

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.

def id_val(id_val: int) -> typing.Self

include_all_fields🔗

When enabled, all fields will be sent to the graph

def include_all_fields(include_all_fields: bool) -> typing.Self

insert_nulls🔗

def insert_nulls(insert_nulls: typing.Union[bool, float]) -> typing.Self

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

def interval(interval: str) -> typing.Self

legend🔗

def legend(legend: cogbuilder.Builder[common.VizLegendOptions]) -> typing.Self

library_panel🔗

Dynamically load the panel

def library_panel(library_panel: dashboard.LibraryPanelRef) -> typing.Self

line_color🔗

def line_color(line_color: str) -> typing.Self

line_interpolation🔗

def line_interpolation(line_interpolation: common.LineInterpolation) -> typing.Self

line_style🔗

def line_style(line_style: cogbuilder.Builder[common.LineStyle]) -> typing.Self

line_width🔗

def line_width(line_width: float) -> typing.Self

links🔗

Panel links.

def links(links: list[cogbuilder.Builder[dashboard.DashboardLink]]) -> typing.Self

mappings🔗

Convert input values into a display string

def mappings(mappings: list[dashboard.ValueMapping]) -> typing.Self

max_val🔗

The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.

def max_val(max_val: float) -> typing.Self

max_data_points🔗

The maximum number of data points that the panel queries are retrieving.

def max_data_points(max_data_points: float) -> typing.Self

max_per_row🔗

Option for repeated panels that controls max items per row

Only relevant for horizontally repeated panels

def max_per_row(max_per_row: float) -> typing.Self

min_val🔗

The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.

def min_val(min_val: float) -> typing.Self

mode🔗

Sets which dimensions are used for the visualization

def mode(mode: candlestick.VizDisplayMode) -> typing.Self

no_value🔗

Alternative to empty string

def no_value(no_value: str) -> typing.Self

overrides🔗

Overrides are the options applied to specific fields overriding the defaults.

def overrides(overrides: list[cogbuilder.Builder[dashboard.DashboardFieldConfigSourceOverrides]]) -> typing.Self

point_color🔗

def point_color(point_color: str) -> typing.Self

point_size🔗

def point_size(point_size: float) -> typing.Self

point_symbol🔗

def point_symbol(point_symbol: str) -> typing.Self

query_caching_ttl🔗

Overrides the data source configured time-to-live for a query cache item in milliseconds

def query_caching_ttl(query_caching_ttl: float) -> typing.Self

repeat🔗

Name of template variable to repeat for.

def repeat(repeat: str) -> typing.Self

repeat_direction🔗

Direction to repeat in if 'repeat' is set.

h for horizontal, v for vertical.

def repeat_direction(repeat_direction: typing.Literal["h", "v"]) -> typing.Self

scale_distribution🔗

def scale_distribution(scale_distribution: cogbuilder.Builder[common.ScaleDistributionConfig]) -> typing.Self

show_points🔗

def show_points(show_points: common.VisibilityMode) -> typing.Self

span🔗

Panel width. The width is the number of columns from the left edge of the panel.

def span(w: int) -> typing.Self

span_nulls🔗

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

def span_nulls(span_nulls: typing.Union[bool, float]) -> typing.Self

stacking🔗

def stacking(stacking: cogbuilder.Builder[common.StackingConfig]) -> typing.Self

targets🔗

Depends on the panel plugin. See the plugin documentation for details.

def targets(targets: list[cogbuilder.Builder[cogvariants.Dataquery]]) -> typing.Self

thresholds🔗

Map numeric values to states

def thresholds(thresholds: cogbuilder.Builder[dashboard.ThresholdsConfig]) -> typing.Self

thresholds_style🔗

def thresholds_style(thresholds_style: cogbuilder.Builder[common.GraphThresholdsStyleConfig]) -> typing.Self

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

def time_from(time_from: str) -> typing.Self

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

def time_shift(time_shift: str) -> typing.Self

title🔗

Panel title.

def title(title: str) -> typing.Self

tooltip🔗

def tooltip(tooltip: cogbuilder.Builder[common.VizTooltipOptions]) -> typing.Self

transform🔗

def transform(transform: common.GraphTransform) -> typing.Self

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.

def transformations(transformations: list[dashboard.DataTransformerConfig]) -> typing.Self

transparent🔗

Whether to display the panel without a background.

def transparent(transparent: bool) -> typing.Self

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.

def unit(unit: str) -> typing.Self

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.

def with_target(target: cogbuilder.Builder[cogvariants.Dataquery]) -> typing.Self

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.

def with_transformation(transformation: dashboard.DataTransformerConfig) -> typing.Self

See also🔗

• dashboard.Panel