grafana/docs/sources/packages_api/data/paneloptionseditorconfig.md

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "PanelOptionsEditorConfig" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" +++

PanelOptionsEditorConfig interface

Signature

export interface PanelOptionsEditorConfig<TOptions, TSettings = any, TValue = any> 

Import

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

Properties

Property	Type	Description
category	string[]	Array of strings representing category of the option. First element in the array will make option render as collapsible section.
defaultValue	TValue
description	string	Description of the option. Will be displayed in the UI as form element description.
name	string	Name of the option. Will be displayed in the UI as form element label.
path	(keyof TOptions & string) | string	Path of the option property to control.
settings	TSettings	al Custom settings of the editor.
showIf	(currentConfig: TOptions) => boolean | undefined	Function that enables configuration of when option editor should be shown based on current panel option properties.

category property

Array of strings representing category of the option. First element in the array will make option render as collapsible section.

Signature

category?: string[];

defaultValue property

Signature

defaultValue?: TValue;

description property

Description of the option. Will be displayed in the UI as form element description.

Signature

description?: string;

name property

Name of the option. Will be displayed in the UI as form element label.

Signature

name: string;

path property

Path of the option property to control.

Signature

path: (keyof TOptions & string) | string;

Example

Given options object of a type:

interface Options {
  a: {
    b: string;
  }
}

path can be either 'a' or 'a.b'.

settings property

al Custom settings of the editor.

Signature

settings?: TSettings;

showIf property

Function that enables configuration of when option editor should be shown based on current panel option properties.

Signature

showIf?: (currentConfig: TOptions) => boolean | undefined;