API Reference@grafana/data › Field

Field interface

Signature

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

Import

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

Properties

Property Type Description
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
state FieldState | null Cached values with appropriate display and id values
type FieldType Field value type (string, number, etc)
values V

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;

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;

state property

Cached values with appropriate display and id values

Signature

state?: FieldState | null;

type property

Field value type (string, number, etc)

Signature

type: FieldType;

values property

Signature

values: V;