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 FieldConfigEditorConfig

FieldConfigEditorConfig interface

Signature

typescript Copy

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

Import

typescript Copy

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

Properties

category property

Array of strings representing category of the field config property. 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 field config property. Will be displayed in the UI as form element description.

Signature

typescript Copy

description?: string;

name property

Name of the field config property. Will be displayed in the UI as form element label.

Signature

typescript Copy

name: string;

path property

Path of the field config property to control.

Signature

typescript Copy

path: (keyof TOptions & string) | string;

Example

Given field config object of a type:

ts Copy

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

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

settings property

Custom settings of the editor.

Signature

typescript Copy

settings?: TSettings;

shouldApply property

Function that allows specifying whether or not this field config should apply to a given field.

Signature

typescript Copy

shouldApply?: (field: Field) => boolean;

showIf property

Function that enables configuration of when field config property editor should be shown based on current panel field config.

Signature

typescript Copy

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