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
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
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;
Was this page helpful?
Related resources from Grafana Labs
Additional helpful documentation, links, and articles:

Getting started with the Grafana LGTM Stack
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.

Getting started with Grafana dashboard design (EMEA Timezone)
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.

Unify your data with Grafana plugins: Datadog, Splunk, MongoDB, and more
In this webinar, learn how to leverage Grafana's plugin ecosystem for access to 80+ data sources, including plugins for Datadog, Splunk, MongoDB, and more.