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.
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 |
---|---|---|
hideFromDefaults | boolean | Hides option from the Field config tab |
hideFromOverrides | boolean | Indicates that option should not be available for the overrides |
isCustom | boolean | true for plugin field config properties |
override | ComponentType<FieldOverrideEditorProps<TValue, TSettings>> | |
process | (value: any, context: FieldOverrideContext, settings?: TSettings) => TValue | undefined | null | Convert the override value to a well typed value |
shouldApply | (field: Field) => boolean | Checks if field should be processed |
hideFromDefaults property
Hides option from the Field config tab
Signature
hideFromDefaults?: boolean;
hideFromOverrides property
Indicates that option should not be available for the overrides
Signature
hideFromOverrides?: boolean;
isCustom property
true for plugin field config properties
Signature
isCustom?: boolean;
override property
Signature
override: ComponentType<FieldOverrideEditorProps<TValue, TSettings>>;
process property
Convert the override value to a well typed value
Signature
process: (value: any, context: FieldOverrideContext, settings?: TSettings) => TValue | undefined | null;
shouldApply property
Checks if field should be processed
Signature
shouldApply: (field: Field) => boolean;