mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
6a0abf895e
* fixes so we match the transformer based on name properly. * changed the signature on the FieldMatcher. * introduced a names option so you can filter in name specificly. * changed so the matcher UI uses the new options format. * moved the exported functions together. * changing editors a bit. * made the filter by name work with both regex and name filtering. * fixed failing tests and make sure we always parse regex the same way. * removed unused code. * simplified to make the existing field overrides still working. * fixed issue reported by hugo. * added tests for the name matcher. * added tests for filter by name. * added more tests. * generated new version of the packages docs. * fixed spelling error. * regenerated the docs.
147 lines
2.7 KiB
Markdown
147 lines
2.7 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "FieldConfig"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## FieldConfig interface
|
|
|
|
Every property is optional
|
|
|
|
Plugins may extend this with additional properties. Something like series overrides
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface FieldConfig<TOptions extends object = any>
|
|
```
|
|
<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>TOptions</code> | |
|
|
| [decimals](#decimals-property) | <code>number | null</code> | |
|
|
| [displayName](#displayname-property) | <code>string</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> | |
|
|
| [thresholds](#thresholds-property) | <code>ThresholdsConfig</code> | |
|
|
| [unit](#unit-property) | <code>string</code> | |
|
|
|
|
### color property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
color?: FieldColor;
|
|
```
|
|
|
|
### custom property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
custom?: TOptions;
|
|
```
|
|
|
|
### decimals property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
decimals?: number | null;
|
|
```
|
|
|
|
### displayName property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
displayName?: string;
|
|
```
|
|
|
|
### 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;
|
|
```
|
|
|
|
### thresholds property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
thresholds?: ThresholdsConfig;
|
|
```
|
|
|
|
### unit property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
unit?: string;
|
|
```
|