mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 12:12:35 +08: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.
111 lines
2.1 KiB
Markdown
111 lines
2.1 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# 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
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface Field<T = any, V = Vector<T>>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { Field } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [calcs](#calcs-property) | <code>FieldCalcs</code> | Cache of reduced values |
|
|
| [config](#config-property) | <code>FieldConfig</code> | Meta info about how field and how to display it |
|
|
| [display](#display-property) | <code>DisplayProcessor</code> | Convert a value for display |
|
|
| [labels](#labels-property) | <code>Labels</code> | |
|
|
| [name](#name-property) | <code>string</code> | Name of the field (column) |
|
|
| [parse](#parse-property) | <code>(value: any) => T</code> | Convert text to the field value |
|
|
| [type](#type-property) | <code>FieldType</code> | Field value type (string, number, etc) |
|
|
| [values](#values-property) | <code>V</code> | |
|
|
|
|
### calcs property
|
|
|
|
Cache of reduced values
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
calcs?: FieldCalcs;
|
|
```
|
|
|
|
### config property
|
|
|
|
Meta info about how field and how to display it
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
config: FieldConfig;
|
|
```
|
|
|
|
### display property
|
|
|
|
Convert a value for display
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
display?: DisplayProcessor;
|
|
```
|
|
|
|
### labels property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
labels?: Labels;
|
|
```
|
|
|
|
### name property
|
|
|
|
Name of the field (column)
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
name: string;
|
|
```
|
|
|
|
### parse property
|
|
|
|
Convert text to the field value
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
parse?: (value: any) => T;
|
|
```
|
|
|
|
### type property
|
|
|
|
Field value type (string, number, etc)
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
type: FieldType;
|
|
```
|
|
|
|
### values property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
values: V;
|
|
```
|