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
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
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
Related Grafana video resources
Getting started with Grafana
Take a guided tour of Grafana and learn how to monitor a web service using Prometheus and Loki in this beginner-friendly webinar.
All about Grafana plugins: Visualizing disparate data sources in one place
Grafana Enterprise plugins are integrations with other commercial monitoring tools (such as Datadog, Splunk, New Relic, ServiceNow, Oracle, and Dynatrace) that are created, maintained, and supported by the Grafana Labs team.
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.
