mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
2.1 KiB
2.1 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "Field" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++
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 |
| 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;
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;