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

FieldConfigEditorConfig interface

Signature

typescript
export interface FieldConfigEditorConfig<TOptions, TSettings = any, TValue = any> extends OptionEditorConfig<TOptions, TSettings, TValue> 

Import

typescript
import { FieldConfigEditorConfig } from '@grafana/data';

Properties

PropertyTypeDescription
hideFromDefaultsbooleanIndicates that option shoukd not be available in the Field config tab
hideFromOverridesbooleanIndicates that option should not be available for the overrides
shouldApply(field: Field) => booleanFunction that allows specifying whether or not this field config should apply to a given field.

hideFromDefaults property

Indicates that option shoukd not be available in the Field config tab

Signature

typescript
hideFromDefaults?: boolean;

hideFromOverrides property

Indicates that option should not be available for the overrides

Signature

typescript
hideFromOverrides?: boolean;

shouldApply property

Function that allows specifying whether or not this field config should apply to a given field.

Signature

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