The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
grafana/docs/sources/packages_api/data/field.md

2.5 KiB

+++

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

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

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

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

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;

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;