6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
135 lines
2.5 KiB
Markdown
135 lines
2.5 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> | |
|
|
| [height](#height-property) | <code>number</code> | |
|
|
| [id](#id-property) | <code>number</code> | |
|
|
| [onChangeTimeRange](#onchangetimerange-property) | <code>(timeRange: AbsoluteTimeRange) => void</code> | |
|
|
| [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;
|
|
```
|
|
|
|
### 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;
|
|
```
|
|
|
|
### 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;
|
|
```
|