IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
cc3fc18076
grafana/docs/sources/packages_api/data/fieldconfigeditorbuilder.md
Marcus Andersson cc3fc18076
Docs: enable packages reference docs for 7-beta (#23953) 
* added packages reference menu item.

* removed the draft flag.

* Updated docs by running script.
2020-04-28 09:53:58 +02:00

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