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
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, string>): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| config | FieldConfigEditorConfig<TOptions, TSettings, 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
addSliderInput method
Signature
addSliderInput<TSettings>(config: FieldConfigEditorConfig<TOptions, TSettings & SliderFieldConfigSettings, number>): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| config | FieldConfigEditorConfig<TOptions, TSettings & SliderFieldConfigSettings, number> |
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
Related Grafana resources
Getting started with Grafana 8
Grafana 8.0 is here! Join us for a live walkthrough on how to get started using Grafana 8 and the Grafana 8 user interface while showing how to set up monitoring for a web service that uses Prometheus and Loki to store metrics and logs.
Unify your data with Grafana plugins: Splunk, MongoDB, Datadog, and more
Show how Grafana can be used to take data from multiple different sources and unify it, without disrupting the investments that are working today.
Demo: Getting started with Grafana Enterprise and observability
Join the Grafana Labs team for a 30-minute demo of how to get started with the Grafana Stack, so you can go from zero to observability in just a few minutes.
