Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Enterprise Open source

PanelProps interface

Signature

typescript
export interface PanelProps<T = any> 

Import

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

Properties

PropertyTypeDescription
dataPanelDataResult set of panel queries
eventBusEventBusEventBus
fieldConfigFieldConfigSourceField options configuration
heightnumberCurrent height of the panel
idnumberID of the panel within the current dashboard
onChangeTimeRange(timeRange: AbsoluteTimeRange) => voidTime range change handler
onFieldConfigChange(config: FieldConfigSource) => voidField config change handler
onOptionsChange(options: T) => voidPanel options change handler
optionsTPanel options
replaceVariablesInterpolateFunctionTemplate variables interpolation function
timeRangeTimeRangeTime range of the current dashboard
timeZoneTimeZoneTime zone of the current dashboard
titlestringPanel title
transparentbooleanIndicates whether or not panel should be rendered transparent
widthnumberCurrent width of the panel

data property

Result set of panel queries

Signature

typescript
data: PanelData;

eventBus property

EventBus

Signature

typescript
eventBus: EventBus;

fieldConfig property

Field options configuration

Signature

typescript
fieldConfig: FieldConfigSource;

height property

Current height of the panel

Signature

typescript
height: number;

id property

ID of the panel within the current dashboard

Signature

typescript
id: number;

onChangeTimeRange property

Time range change handler

Signature

typescript
onChangeTimeRange: (timeRange: AbsoluteTimeRange) => void;

onFieldConfigChange property

Field config change handler

Signature

typescript
onFieldConfigChange: (config: FieldConfigSource) => void;

onOptionsChange property

Panel options change handler

Signature

typescript
onOptionsChange: (options: T) => void;

options property

Panel options

Signature

typescript
options: T;

replaceVariables property

Template variables interpolation function

Signature

typescript
replaceVariables: InterpolateFunction;

timeRange property

Time range of the current dashboard

Signature

typescript
timeRange: TimeRange;

timeZone property

Time zone of the current dashboard

Signature

typescript
timeZone: TimeZone;

title property

Panel title

Signature

typescript
title: string;

transparent property

Indicates whether or not panel should be rendered transparent

Signature

typescript
transparent: boolean;

width property

Current width of the panel

Signature

typescript
width: number;