mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
6a0abf895e
* fixes so we match the transformer based on name properly. * changed the signature on the FieldMatcher. * introduced a names option so you can filter in name specificly. * changed so the matcher UI uses the new options format. * moved the exported functions together. * changing editors a bit. * made the filter by name work with both regex and name filtering. * fixed failing tests and make sure we always parse regex the same way. * removed unused code. * simplified to make the existing field overrides still working. * fixed issue reported by hugo. * added tests for the name matcher. * added tests for filter by name. * added more tests. * generated new version of the packages docs. * fixed spelling error. * regenerated the docs.
2.5 KiB
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 |
|---|---|---|
| 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;
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;
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;