Menu
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
Enterprise
Open source
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
Returns:
this
addColorPicker method
Signature
addColorPicker<TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings & ColorFieldConfigSettings, FieldColor>): this;Parameters
Returns:
this
addNumberInput method
Signature
addNumberInput<TSettings>(config: FieldConfigEditorConfig<TOptions, TSettings & NumberFieldConfigSettings, number>): this;Parameters
Returns:
this
addRadio method
Signature
addRadio<TOption, TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings, TOption>): this;Parameters
Returns:
this
addSelect method
Signature
addSelect<TOption, TSettings extends SelectFieldConfigSettings<TOption>>(config: FieldConfigEditorConfig<TOptions, TSettings, TOption>): this;Parameters
Returns:
this
addTextInput method
Signature
addTextInput<TSettings>(config: FieldConfigEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string>): this;Parameters
Returns:
this
addUnitPicker method
Signature
addUnitPicker<TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings & UnitFieldConfigSettings, string>): this;Parameters
Returns:
this