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

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;