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.

Grafana documentation API Reference @grafana/data FieldConfigPropertyItem

FieldConfigPropertyItem interface

Signature

typescript Copy

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

Import

typescript Copy

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

Properties

hideFromDefaults property

Hides option from the Field config tab

Signature

typescript Copy

hideFromDefaults?: boolean;

hideFromOverrides property

Indicates that option should not be available for the overrides

Signature

typescript Copy

hideFromOverrides?: boolean;

isCustom property

true for plugin field config properties

Signature

typescript Copy

isCustom?: boolean;

override property

Signature

typescript Copy

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

process property

Convert the override value to a well typed value

Signature

typescript Copy

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

shouldApply property

Checks if field should be processed

Signature

typescript Copy

shouldApply: (field: Field) => boolean;