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

+++

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

Do not edit this file. It is automatically generated by API Documenter.

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

title = "Field" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++

Field interface

Signature

export interface Field<T = any, V = Vector<T>> 

Import

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

Properties

Property	Type	Description
calcs	FieldCalcs	Cache of reduced values
config	FieldConfig	Meta info about how field and how to display it
display	DisplayProcessor	Convert a value for display
getLinks	(config: ValueLinkConfig) => Array<LinkModel<Field>>	Get value data links with variables interpolated
labels	Labels
name	string	Name of the field (column)
parse	(value: any) => T	Convert text to the field value
type	FieldType	Field value type (string, number, etc)
values	V

calcs property

Cache of reduced values

Signature

calcs?: FieldCalcs;

config property

Meta info about how field and how to display it

Signature

config: FieldConfig;

display property

Convert a value for display

Signature

display?: DisplayProcessor;

getLinks property

Get value data links with variables interpolated

Signature

getLinks?: (config: ValueLinkConfig) => Array<LinkModel<Field>>;

labels property

Signature

labels?: Labels;

name property

Name of the field (column)

Signature

name: string;

parse property

Convert text to the field value

Signature

parse?: (value: any) => T;

type property

Field value type (string, number, etc)

Signature

type: FieldType;

values property

Signature

values: V;