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
export declare class PanelOptionsEditorBuilder<TOptions> extends OptionsUIRegistryBuilder<TOptions, StandardEditorProps, PanelOptionsEditorItem<TOptions>> Import
import { PanelOptionsEditorBuilder } from '@grafana/data';Methods
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
Was this page helpful?
Related resources from Grafana Labs
Getting started with the Grafana LGTM Stack
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.
Getting started with Grafana dashboard design (EMEA Timezone)
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
Unify your data with Grafana plugins: Datadog, Splunk, MongoDB, and more
In this webinar, learn how to leverage Grafana's plugin ecosystem for access to 80+ data sources, including plugins for Datadog, Splunk, MongoDB, and more.