Menu
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.
Enterprise
Open source
Field interface
Signature
typescript
export interface Field<T = any, V = Vector<T>>
Import
typescript
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
typescript
config: FieldConfig;
display property
Convert a value for display
Signature
typescript
display?: DisplayProcessor;
getLinks property
Get value data links with variables interpolated
Signature
typescript
getLinks?: (config: ValueLinkConfig) => Array<LinkModel<Field>>;
labels property
Signature
typescript
labels?: Labels;
name property
Name of the field (column)
Signature
typescript
name: string;
parse property
Convert text to the field value
Signature
typescript
parse?: (value: any) => T;
state property
Cached values with appropriate display and id values
Signature
typescript
state?: FieldState | null;
type property
Field value type (string, number, etc)
Signature
typescript
type: FieldType;
values property
Signature
typescript
values: V;
Was this page helpful?
Related resources from Grafana Labs
Additional helpful documentation, links, and articles:
Video
Getting started with the Grafana LGTM Stack
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.
Video
Getting started with Grafana dashboard design
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
Video
Building advanced Grafana dashboards
In this webinar, we’ll demo how to build and format Grafana dashboards.