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.
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 |
eventBus | EventBus | EventBus |
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 |
title | string | Panel title |
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;
eventBus property
EventBus
Signature
eventBus: EventBus;
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;
title property
Panel title
Signature
title: string;
transparent property
Indicates whether or not panel should be rendered transparent
Signature
transparent: boolean;
width property
Current width of the panel
Signature
width: number;