PanelOptionsEditorBuilder class

Fluent API for declarative creation of panel options

Signature

export declare class PanelOptionsEditorBuilder<TOptions> extends OptionsUIRegistryBuilder<TOptions, StandardEditorProps, PanelOptionsEditorItem<TOptions>> 

Import

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

Methods

Method	Modifiers	Description
addBooleanSwitch(config)
addColorPicker(config)
addDashboardPicker(config)
addFieldNamePicker(config)
addMultiSelect(config)
addNestedOptions(opts)
addNumberInput(config)
addRadio(config)
addSelect(config)
addSliderInput(config)
addStringArray(config)
addTextInput(config)
addTimeZonePicker(config)
addUnitPicker(config)

addBooleanSwitch method

Signature

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

Parameters

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

Returns:

this

addColorPicker method

Signature

addColorPicker<TSettings = any>(config: PanelOptionsEditorConfig<TOptions, TSettings, string>): this;

Parameters

Parameter	Type	Description
config	PanelOptionsEditorConfig<TOptions, TSettings, string>

Returns:

this

addDashboardPicker method

Signature

addDashboardPicker<TSettings = any>(config: PanelOptionsEditorConfig<TOptions, TSettings & FieldNamePickerConfigSettings, string>): this;

Parameters

Parameter	Type	Description
config	PanelOptionsEditorConfig<TOptions, TSettings & FieldNamePickerConfigSettings, string>

Returns:

this

addFieldNamePicker method

Signature

addFieldNamePicker<TSettings = any>(config: PanelOptionsEditorConfig<TOptions, TSettings & FieldNamePickerConfigSettings, string>): this;

Parameters

Parameter	Type	Description
config	PanelOptionsEditorConfig<TOptions, TSettings & FieldNamePickerConfigSettings, string>

Returns:

this

addMultiSelect method

Signature

addMultiSelect<TOption, TSettings extends SelectFieldConfigSettings<TOption>>(config: PanelOptionsEditorConfig<TOptions, TSettings, TOption>): this;

Parameters

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

Returns:

this

addNestedOptions method

Signature

addNestedOptions<Sub>(opts: NestedPanelOptions<Sub>): this;

Parameters

Parameter	Type	Description
opts	NestedPanelOptions<Sub>

Returns:

this

addNumberInput method

Signature

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

Parameters

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

Returns:

this

addRadio method

Signature

addRadio<TOption, TSettings extends SelectFieldConfigSettings<TOption>>(config: PanelOptionsEditorConfig<TOptions, TSettings, TOption>): this;

Parameters

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

Returns:

this

addSelect method

Signature

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

Parameters

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

Returns:

this

addSliderInput method

Signature

addSliderInput<TSettings>(config: PanelOptionsEditorConfig<TOptions, TSettings & SliderFieldConfigSettings, number>): this;

Parameters

Parameter	Type	Description
config	PanelOptionsEditorConfig<TOptions, TSettings & SliderFieldConfigSettings, number>

Returns:

this

addStringArray method

Signature

addStringArray<TSettings>(config: PanelOptionsEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string[]>): this;

Parameters

Parameter	Type	Description
config	PanelOptionsEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string[]>

Returns:

this

addTextInput method

Signature

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

Parameters

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

Returns:

this

addTimeZonePicker method

Signature

addTimeZonePicker<TSettings = any>(config: PanelOptionsEditorConfig<TOptions, TSettings, string>): this;

Parameters

Parameter	Type	Description
config	PanelOptionsEditorConfig<TOptions, TSettings, string>

Returns:

this

addUnitPicker method

Signature

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

Parameters

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

Returns:

this