grafana/docs/sources/packages_api/data/panelprops.md

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "PanelProps" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" +++

PanelProps interface

Signature

export interface PanelProps<T = any> 

Import

import { PanelProps } from '@grafana/data';

Properties

Property	Type	Description
data	PanelData	Result set of panel queries
fieldConfig	FieldConfigSource	Field options configuration
height	number	Current height of the panel
id	number	ID of the panel within the current dashboard
onChangeTimeRange	(timeRange: AbsoluteTimeRange) => void	Time range change handler
onFieldConfigChange	(config: FieldConfigSource) => void	Field config change handler
onOptionsChange	(options: T) => void	Panel options change handler
options	T	Panel options
replaceVariables	InterpolateFunction	Template variables interpolation function
timeRange	TimeRange	Time range of the current dashboard
timeZone	TimeZone	Time zone of the current dashboard
transparent	boolean	Indicates whether or not panel should be rendered transparent
width	number	Current width of the panel

data property

Result set of panel queries

Signature

data: PanelData;

fieldConfig property

Field options configuration

Signature

fieldConfig: FieldConfigSource;

height property

Current height of the panel

Signature

height: number;

id property

ID of the panel within the current dashboard

Signature

id: number;

onChangeTimeRange property

Time range change handler

Signature

onChangeTimeRange: (timeRange: AbsoluteTimeRange) => void;

onFieldConfigChange property

Field config change handler

Signature

onFieldConfigChange: (config: FieldConfigSource) => void;

onOptionsChange property

Panel options change handler

Signature

onOptionsChange: (options: T) => void;

options property

Panel options

Signature

options: T;

replaceVariables property

Template variables interpolation function

Signature

replaceVariables: InterpolateFunction;

timeRange property

Time range of the current dashboard

Signature

timeRange: TimeRange;

timeZone property

Time zone of the current dashboard

Signature

timeZone: TimeZone;

transparent property

Indicates whether or not panel should be rendered transparent

Signature

transparent: boolean;

width property

Current width of the panel

Signature

width: number;