apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
25541 Commits
1680 Branches
645 Tags
2.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 157e54067d
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '157e54067d'
${ noResults }
grafana/docs/sources/packages_api/data/fieldconfigeditorbuilder.md

4.0 KiB
Raw Blame History

+++

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

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

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

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

FieldConfigEditorBuilder class

Fluent API for declarative creation of field config option editors

Signature

export declare class FieldConfigEditorBuilder<TOptions> extends OptionsUIRegistryBuilder<TOptions, FieldConfigEditorProps<any, any>, FieldConfigPropertyItem<TOptions>>

Import

import { FieldConfigEditorBuilder } from '@grafana/data';

Methods

Method Modifiers Description
addBooleanSwitch(config)
addColorPicker(config)
addNumberInput(config)
addRadio(config)
addSelect(config)
addTextInput(config)
addUnitPicker(config)

addBooleanSwitch method

Signature

addBooleanSwitch<TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings, boolean>): this;

Parameters

Parameter Type Description
config FieldConfigEditorConfig<TOptions, TSettings, boolean>

Returns:

this

addColorPicker method

Signature

addColorPicker<TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings & ColorFieldConfigSettings, string>): this;

Parameters

Parameter Type Description
config FieldConfigEditorConfig<TOptions, TSettings & ColorFieldConfigSettings, string>

Returns:

this

addNumberInput method

Signature

addNumberInput<TSettings>(config: FieldConfigEditorConfig<TOptions, TSettings & NumberFieldConfigSettings, number>): this;

Parameters

Parameter Type Description
config FieldConfigEditorConfig<TOptions, TSettings & NumberFieldConfigSettings, number>

Returns:

this

addRadio method

Signature

addRadio<TOption, TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings, TOption>): this;

Parameters

Parameter Type Description
config FieldConfigEditorConfig<TOptions, TSettings, TOption>

Returns:

this

addSelect method

Signature

addSelect<TOption, TSettings extends SelectFieldConfigSettings<TOption>>(config: FieldConfigEditorConfig<TOptions, TSettings, TOption>): this;

Parameters

Parameter Type Description
config FieldConfigEditorConfig<TOptions, TSettings, TOption>

Returns:

this

addTextInput method

Signature

addTextInput<TSettings>(config: FieldConfigEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string>): this;

Parameters

Parameter Type Description
config FieldConfigEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string>

Returns:

this

addUnitPicker method

Signature

addUnitPicker<TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings & UnitFieldConfigSettings, string>): this;

Parameters

Parameter Type Description
config FieldConfigEditorConfig<TOptions, TSettings & UnitFieldConfigSettings, string>

Returns:

this