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

PanelOptionsEditorBuilder class

Fluent API for declarative creation of panel options

Signature

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

Import

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

Methods

MethodModifiersDescription
addBooleanSwitch(config)
addColorPicker(config)
addFieldNamePicker(config)
addMultiSelect(config)
addNumberInput(config)
addRadio(config)
addSelect(config)
addSliderInput(config)
addStringArray(config)
addTextInput(config)
addTimeZonePicker(config)
addUnitPicker(config)

addBooleanSwitch method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings, boolean>

Returns:

this

addColorPicker method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings, string>

Returns:

this

addFieldNamePicker method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings & FieldNamePickerConfigSettings, string>

Returns:

this

addMultiSelect method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings, TOption>

Returns:

this

addNumberInput method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings & NumberFieldConfigSettings, number>

Returns:

this

addRadio method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings, TOption>

Returns:

this

addSelect method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings, TOption>

Returns:

this

addSliderInput method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings & SliderFieldConfigSettings, number>

Returns:

this

addStringArray method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string[]>

Returns:

this

addTextInput method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string>

Returns:

this

addTimeZonePicker method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings, string>

Returns:

this

addUnitPicker method

Signature

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

Parameters

ParameterTypeDescription
configPanelOptionsEditorConfig<TOptions, TSettings & UnitFieldConfigSettings, string>

Returns:

this