Marcus Andersson
a2d741f60f
* regenerated packages docs. * fixed spelling issues. * fixed spelling issues.
157 lines
3.1 KiB
Markdown
157 lines
3.1 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "PanelProps"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## PanelProps interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface PanelProps<T = any>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { PanelProps } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [data](#data-property) | <code>PanelData</code> | |
|
|
| [fieldConfig](#fieldconfig-property) | <code>FieldConfigSource</code> | Panel fields configuration |
|
|
| [height](#height-property) | <code>number</code> | |
|
|
| [id](#id-property) | <code>number</code> | |
|
|
| [onChangeTimeRange](#onchangetimerange-property) | <code>(timeRange: AbsoluteTimeRange) => void</code> | |
|
|
| [onFieldConfigChange](#onfieldconfigchange-property) | <code>(config: FieldConfigSource) => void</code> | Enables panel field config manipulation |
|
|
| [onOptionsChange](#onoptionschange-property) | <code>(options: T) => void</code> | |
|
|
| [options](#options-property) | <code>T</code> | |
|
|
| [renderCounter](#rendercounter-property) | <code>number</code> | |
|
|
| [replaceVariables](#replacevariables-property) | <code>InterpolateFunction</code> | |
|
|
| [timeRange](#timerange-property) | <code>TimeRange</code> | |
|
|
| [timeZone](#timezone-property) | <code>TimeZone</code> | |
|
|
| [transparent](#transparent-property) | <code>boolean</code> | |
|
|
| [width](#width-property) | <code>number</code> | |
|
|
|
|
### data property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
data: PanelData;
|
|
```
|
|
|
|
### fieldConfig property
|
|
|
|
Panel fields configuration
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
fieldConfig: FieldConfigSource;
|
|
```
|
|
|
|
### height property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
height: number;
|
|
```
|
|
|
|
### id property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
id: number;
|
|
```
|
|
|
|
### onChangeTimeRange property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onChangeTimeRange: (timeRange: AbsoluteTimeRange) => void;
|
|
```
|
|
|
|
### onFieldConfigChange property
|
|
|
|
Enables panel field config manipulation
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onFieldConfigChange: (config: FieldConfigSource) => void;
|
|
```
|
|
|
|
### onOptionsChange property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onOptionsChange: (options: T) => void;
|
|
```
|
|
|
|
### options property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
options: T;
|
|
```
|
|
|
|
### renderCounter property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
renderCounter: number;
|
|
```
|
|
|
|
### replaceVariables property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
replaceVariables: InterpolateFunction;
|
|
```
|
|
|
|
### timeRange property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
timeRange: TimeRange;
|
|
```
|
|
|
|
### timeZone property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
timeZone: TimeZone;
|
|
```
|
|
|
|
### transparent property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
transparent: boolean;
|
|
```
|
|
|
|
### width property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
width: number;
|
|
```
|