mirror of
https://github.com/grafana/grafana.git
synced 2025-08-02 02:26:19 +08:00
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.
157 lines
2.9 KiB
Markdown
157 lines
2.9 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "FieldConfig"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## FieldConfig interface
|
|
|
|
Every property is optional
|
|
|
|
Plugins may extend this with additional properties. Something like series overrides
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface FieldConfig
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { FieldConfig } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [color](#color-property) | <code>FieldColor</code> | |
|
|
| [custom](#custom-property) | <code>Record<string, any></code> | |
|
|
| [decimals](#decimals-property) | <code>number | null</code> | |
|
|
| [filterable](#filterable-property) | <code>boolean</code> | |
|
|
| [links](#links-property) | <code>DataLink[]</code> | |
|
|
| [mappings](#mappings-property) | <code>ValueMapping[]</code> | |
|
|
| [max](#max-property) | <code>number | null</code> | |
|
|
| [min](#min-property) | <code>number | null</code> | |
|
|
| [noValue](#novalue-property) | <code>string</code> | |
|
|
| [nullValueMode](#nullvaluemode-property) | <code>NullValueMode</code> | |
|
|
| [scopedVars](#scopedvars-property) | <code>ScopedVars</code> | |
|
|
| [thresholds](#thresholds-property) | <code>ThresholdsConfig</code> | |
|
|
| [title](#title-property) | <code>string</code> | |
|
|
| [unit](#unit-property) | <code>string</code> | |
|
|
|
|
### color property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
color?: FieldColor;
|
|
```
|
|
|
|
### custom property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
custom?: Record<string, any>;
|
|
```
|
|
|
|
### decimals property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
decimals?: number | null;
|
|
```
|
|
|
|
### filterable property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
filterable?: boolean;
|
|
```
|
|
|
|
### links property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
links?: DataLink[];
|
|
```
|
|
|
|
### mappings property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
mappings?: ValueMapping[];
|
|
```
|
|
|
|
### max property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
max?: number | null;
|
|
```
|
|
|
|
### min property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
min?: number | null;
|
|
```
|
|
|
|
### noValue property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
noValue?: string;
|
|
```
|
|
|
|
### nullValueMode property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
nullValueMode?: NullValueMode;
|
|
```
|
|
|
|
### scopedVars property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
scopedVars?: ScopedVars;
|
|
```
|
|
|
|
### thresholds property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
thresholds?: ThresholdsConfig;
|
|
```
|
|
|
|
### title property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
title?: string;
|
|
```
|
|
|
|
### unit property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
unit?: string;
|
|
```
|