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.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/databreadcrumb arrow FieldConfigPropertyItem
Enterprise Open source

FieldConfigPropertyItem interface

Signature

typescript 
export interface FieldConfigPropertyItem<TOptions = any, TValue = any, TSettings extends {} = any> extends OptionsEditorItem<TOptions, TSettings, FieldConfigEditorProps<TValue, TSettings>, TValue>

Import

typescript 
import { FieldConfigPropertyItem } from '@grafana/data';

Properties

PropertyTypeDescription
isCustombooleantrue for plugin field config properties
overrideComponentType<FieldOverrideEditorProps<TValue, TSettings>>
process(value: any, context: FieldOverrideContext, settings?: TSettings) => TValue | undefined | null
shouldApply(field: Field) => boolean

isCustom property

true for plugin field config properties

Signature

typescript 
isCustom?: boolean;

override property

Signature

typescript 
override: ComponentType<FieldOverrideEditorProps<TValue, TSettings>>;

process property

Signature

typescript 
process: (value: any, context: FieldOverrideContext, settings?: TSettings) => TValue | undefined | null;

shouldApply property

Signature

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