Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
FieldConfig interface
Every property is optional
Plugins may extend this with additional properties. Something like series overrides
Signature
export interface FieldConfig<TOptions = any> Import
import { FieldConfig } from '@grafana/data';Properties
| Property | Type | Description |
|---|---|---|
| color | FieldColor | |
| custom | TOptions | |
| decimals | number | null | |
| description | string | Human readable field metadata |
| displayName | string | The display value for this field. This supports template variables blank is auto |
| displayNameFromDS | string | This can be used by data sources that return and explicit naming structure for values and labels When this property is configured, this value is used rather than the default naming strategy. |
| filterable | boolean | True if data source field supports ad-hoc filters |
| links | DataLink[] | |
| mappings | ValueMapping[] | |
| max | number | null | |
| min | number | null | |
| noValue | string | |
| nullValueMode | NullValueMode | |
| path | string | An explict path to the field in the datasource. When the frame meta includes a path, This will default to `${frame.meta.path}/${field.name}When defined, this value can be used as an identifier within the datasource scope, and may be used to update the results |
| thresholds | ThresholdsConfig | |
| unit | string | |
| writeable | boolean | True if data source can write a value to the path. Auth/authz are supported separately |
color property
Signature
color?: FieldColor;custom property
Signature
custom?: TOptions;decimals property
Signature
decimals?: number | null;description property
Human readable field metadata
Signature
description?: string;displayName property
The display value for this field. This supports template variables blank is auto
Signature
displayName?: string;displayNameFromDS property
This can be used by data sources that return and explicit naming structure for values and labels When this property is configured, this value is used rather than the default naming strategy.
Signature
displayNameFromDS?: string;filterable property
True if data source field supports ad-hoc filters
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;path property
An explict path to the field in the datasource. When the frame meta includes a path, This will default to `${frame.meta.path}/${field.name}
When defined, this value can be used as an identifier within the datasource scope, and may be used to update the results
Signature
path?: string;thresholds property
Signature
thresholds?: ThresholdsConfig;unit property
Signature
unit?: string;writeable property
True if data source can write a value to the path. Auth/authz are supported separately
Signature
writeable?: boolean;Was this page helpful?
Related resources from Grafana Labs
