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 Field

Field interface

Signature

typescript Copy

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

Import

typescript Copy

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

Properties

config property

Meta info about how field and how to display it

Signature

typescript Copy

config: FieldConfig;

display property

Convert a value for display

Signature

typescript Copy

display?: DisplayProcessor;

getLinks property

Get value data links with variables interpolated

Signature

typescript Copy

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

labels property

Signature

typescript Copy

labels?: Labels;

name property

Name of the field (column)

Signature

typescript Copy

name: string;

state property

Cached values with appropriate display and id values

Signature

typescript Copy

state?: FieldState | null;

type property

Field value type (string, number, etc)

Signature

typescript Copy

type: FieldType;

values property

Signature

typescript Copy

values: V;