public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: enable packages reference docs for 7-beta (#23953)

Browse Source 
* added packages reference menu item.

* removed the draft flag.

* Updated docs by running script.
This commit is contained in:
Marcus Andersson
2020-04-28 09:53:58 +02:00
committed by GitHub
parent 5442b0ab4f
commit cc3fc18076
719 changed files with 1069 additions and 1030 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/packages_api/data/panelprops.md
+37 -25
View File
@@ -5,7 +5,6 @@
title = "PanelProps"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## PanelProps interface
@@ -24,23 +23,24 @@ import { PanelProps } from '@grafana/data';
| 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) =&gt; void</code> | |
| [onFieldConfigChange](#onfieldconfigchange-property) | <code>(config: FieldConfigSource) =&gt; void</code> | Enables panel field config manipulation |
| [onOptionsChange](#onoptionschange-property) | <code>(options: T) =&gt; 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](#data-property) | <code>PanelData</code> | Result set of panel queries |
| [fieldConfig](#fieldconfig-property) | <code>FieldConfigSource</code> | Field options configuration |
| [height](#height-property) | <code>number</code> | Current height of the panel |
| [id](#id-property) | <code>number</code> | ID of the panel within the current dashboard |
| [onChangeTimeRange](#onchangetimerange-property) | <code>(timeRange: AbsoluteTimeRange) =&gt; void</code> | Time range change handler |
| [onFieldConfigChange](#onfieldconfigchange-property) | <code>(config: FieldConfigSource) =&gt; void</code> | Field config change handler |
| [onOptionsChange](#onoptionschange-property) | <code>(options: T) =&gt; void</code> | Panel options change handler |
| [options](#options-property) | <code>T</code> | Panel options |
| [replaceVariables](#replacevariables-property) | <code>InterpolateFunction</code> | Template variables interpolation function |
| [timeRange](#timerange-property) | <code>TimeRange</code> | Time range of the current dashboard |
| [timeZone](#timezone-property) | <code>TimeZone</code> | Time zone of the current dashboard |
| [transparent](#transparent-property) | <code>boolean</code> | Indicathes whether or not panel should be rendered transparent |
| [width](#width-property) | <code>number</code> | Current width of the panel |
### data property
Result set of panel queries
<b>Signature</b>
```typescript
@@ -49,7 +49,7 @@ data: PanelData;
### fieldConfig property
Panel fields configuration
Field options configuration
<b>Signature</b>
@@ -59,6 +59,8 @@ fieldConfig: FieldConfigSource;
### height property
Current height of the panel
<b>Signature</b>
```typescript
@@ -67,6 +69,8 @@ height: number;
### id property
ID of the panel within the current dashboard
<b>Signature</b>
```typescript
@@ -75,6 +79,8 @@ id: number;
### onChangeTimeRange property
Time range change handler
<b>Signature</b>
```typescript
@@ -83,7 +89,7 @@ onChangeTimeRange: (timeRange: AbsoluteTimeRange) => void;
### onFieldConfigChange property
Enables panel field config manipulation
Field config change handler
<b>Signature</b>
@@ -93,6 +99,8 @@ onFieldConfigChange: (config: FieldConfigSource) => void;
### onOptionsChange property
Panel options change handler
<b>Signature</b>
```typescript
@@ -101,22 +109,18 @@ onOptionsChange: (options: T) => void;
### options property
Panel options
<b>Signature</b>
```typescript
options: T;
```
### renderCounter property
<b>Signature</b>
```typescript
renderCounter: number;
```
### replaceVariables property
Template variables interpolation function
<b>Signature</b>
```typescript
@@ -125,6 +129,8 @@ replaceVariables: InterpolateFunction;
### timeRange property
Time range of the current dashboard
<b>Signature</b>
```typescript
@@ -133,6 +139,8 @@ timeRange: TimeRange;
### timeZone property
Time zone of the current dashboard
<b>Signature</b>
```typescript
@@ -141,6 +149,8 @@ timeZone: TimeZone;
### transparent property
Indicathes whether or not panel should be rendered transparent
<b>Signature</b>
```typescript
@@ -149,6 +159,8 @@ transparent: boolean;
### width property
Current width of the panel
<b>Signature</b>
```typescript