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.

Documentation Grafana documentation API Reference @grafana/data PanelOptionsEditorConfig

PanelOptionsEditorConfig interface

Signature

typescript Copy

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

Import

typescript Copy

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

Properties

category property

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

Signature

typescript Copy

category?: string[];

defaultValue property

Signature

typescript Copy

defaultValue?: TValue;

description property

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

Signature

typescript Copy

description?: string;

name property

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

Signature

typescript Copy

name: string;

path property

Path of the option property to control.

Signature

typescript Copy

path: (keyof TOptions & string) | string;

Example

Given options object of a type:

ts Copy

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

path can be either ‘a’ or ‘a.b’.

settings property

al Custom settings of the editor.

Signature

typescript Copy

settings?: TSettings;

showIf property

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

Signature

typescript Copy

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