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.

Documentation Grafana documentation API Reference @grafana/data FieldConfig

FieldConfig interface

Every property is optional

Plugins may extend this with additional properties. Something like series overrides

Signature

typescript Copy

export interface FieldConfig<TOptions extends object = any> 

Import

typescript Copy

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

Properties

color property

Signature

typescript Copy

color?: FieldColor;

custom property

Signature

typescript Copy

custom?: TOptions;

decimals property

Signature

typescript Copy

decimals?: number | null;

displayName property

The display value for this field. This supports template variables blank is auto

Signature

typescript Copy

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

typescript Copy

displayNameFromDS?: string;

filterable property

True if data source field supports ad-hoc filters

Signature

typescript Copy

filterable?: boolean;

links property

Signature

typescript Copy

links?: DataLink[];

mappings property

Signature

typescript Copy

mappings?: ValueMapping[];

max property

Signature

typescript Copy

max?: number | null;

min property

Signature

typescript Copy

min?: number | null;

noValue property

Signature

typescript Copy

noValue?: string;

nullValueMode property

Signature

typescript Copy

nullValueMode?: NullValueMode;

thresholds property

Signature

typescript Copy

thresholds?: ThresholdsConfig;

unit property

Signature

typescript Copy

unit?: string;