Menu

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.

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
hideFromDefaultsbooleanHides option from the Field config tab
hideFromOverridesbooleanIndicates that option should not be available for the overrides
isCustombooleantrue for plugin field config properties
overrideComponentType<FieldOverrideEditorProps<TValue, TSettings>>
process(value: any, context: FieldOverrideContext, settings?: TSettings) => TValue | undefined | nullConvert the override value to a well typed value
shouldApply(field: Field) => booleanChecks if field should be processed

hideFromDefaults property

Hides option from the Field config tab

Signature

typescript
hideFromDefaults?: boolean;

hideFromOverrides property

Indicates that option should not be available for the overrides

Signature

typescript
hideFromOverrides?: boolean;

isCustom property

true for plugin field config properties

Signature

typescript
isCustom?: boolean;

override property

Signature

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

process property

Convert the override value to a well typed value

Signature

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

shouldApply property

Checks if field should be processed

Signature

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