grafana/docs/sources/packages_api/data/fieldconfig.md

+++

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

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

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
filterable	boolean
links	DataLink[]
mappings	ValueMapping[]
max	number | null
min	number | null
noValue	string
nullValueMode	NullValueMode
scopedVars	ScopedVars
thresholds	ThresholdsConfig
title	string
unit	string

color property

Signature

color?: FieldColor;

custom property

Signature

custom?: TOptions;

decimals property

Signature

decimals?: number | null;

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;

scopedVars property

Signature

scopedVars?: ScopedVars;

thresholds property

Signature

thresholds?: ThresholdsConfig;

title property

Signature

title?: string;

unit property

Signature

unit?: string;