FieldConfigEditorConfig

FieldConfigEditorConfig interface

Signature

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

Import

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

Properties

Property	Type	Description
category	`string[]`	Array of strings representing category of the field config property. First element in the array will make option render as collapsible section.
defaultValue	`TValue`
description	`string`	Description of the field config property. Will be displayed in the UI as form element description.
name	`string`	Name of the field config property. Will be displayed in the UI as form element label.
path	`(keyof TOptions & string) \| string`	Path of the field config property to control.
settings	`TSettings`	Custom settings of the editor.
shouldApply	`(field: Field) => boolean`	Function that allows specifying whether or not this field config should apply to a given field.
showIf	`(currentConfig: TOptions) => boolean`	Function that enables configuration of when field config property editor should be shown based on current panel field config.

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

Signature

category?: string[];

Signature

defaultValue?: TValue;

Description of the field config property. Will be displayed in the UI as form element description.

Signature

description?: string;

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

Signature

name: string;

Path of the field config property to control.

Signature

path: (keyof TOptions & string) | string;

Given field config object of a type:

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

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

Custom settings of the editor.

Signature

settings?: TSettings;

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

Signature

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

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

Signature

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