IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
67467c0eaa
grafana/docs/sources/packages_api/data/fieldconfig.md
Marcus Andersson 6a0abf895e
Docs: generated a 7.0 version of the packages reference docs. (#24708) 
* 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.
2020-05-14 21:34:59 +02:00

2.7 KiB
Raw Blame History

+++

-----------------------------------------------------------------------

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

Signature

export interface FieldConfig<TOptions extends object = any>

Import

import { FieldConfig } from '@grafana/data';

Properties

Property Type Description
color FieldColor
custom TOptions
decimals number | null
displayName string
filterable boolean
links DataLink[]
mappings ValueMapping[]
max number | null
min number | null
noValue string
nullValueMode NullValueMode
thresholds ThresholdsConfig
unit string

color property

Signature

color?: FieldColor;

custom property

Signature

custom?: TOptions;

decimals property

Signature

decimals?: number | null;

displayName property

Signature

displayName?: string;

filterable property

Signature

filterable?: boolean;

links property

Signature

links?: DataLink[];

mappings property

Signature

mappings?: ValueMapping[];

max property

Signature

max?: number | null;

min property

Signature

min?: number | null;

noValue property

Signature

noValue?: string;

nullValueMode property

Signature

nullValueMode?: NullValueMode;

thresholds property

Signature

thresholds?: ThresholdsConfig;

unit property

Signature

unit?: string;