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.9 KiB
2.9 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "FieldConfig" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++
FieldConfig interface
Every property is optional
Plugins may extend this with additional properties. Something like series overrides
Signature
export interface FieldConfig
Import
import { FieldConfig } from '@grafana/data';
Properties
| Property | Type | Description |
|---|---|---|
| color | FieldColor |
|
| custom | Record<string, any> |
|
| decimals | number | null |
|
| filterable | boolean |
|
| links | DataLink[] |
|
| mappings | ValueMapping[] |
|
| max | number | null |
|
| min | number | null |
|
| noValue | string |
|
| nullValueMode | NullValueMode |
|
| scopedVars | ScopedVars |
|
| thresholds | ThresholdsConfig |
|
| title | string |
|
| unit | string |
color property
Signature
color?: FieldColor;
custom property
Signature
custom?: Record<string, any>;
decimals property
Signature
decimals?: number | null;
filterable property
Signature
filterable?: boolean;
links property
Signature
links?: DataLink[];
mappings property
Signature
mappings?: ValueMapping[];
max property
Signature
max?: number | null;
min property
Signature
min?: number | null;
noValue property
Signature
noValue?: string;
nullValueMode property
Signature
nullValueMode?: NullValueMode;
scopedVars property
Signature
scopedVars?: ScopedVars;
thresholds property
Signature
thresholds?: ThresholdsConfig;
title property
Signature
title?: string;
unit property
Signature
unit?: string;