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

+++

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

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

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

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

FieldConfigPropertyItem interface

Signature

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

Import

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

Properties

Property	Type	Description
isCustom	boolean	true for plugin field config properties
override	ComponentType<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

isCustom?: boolean;

override property

Signature

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

process property

Signature

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

shouldApply property

Signature

shouldApply: (field: Field) => boolean;