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.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/databreadcrumb arrow FieldNamePickerConfigSettings
Enterprise Open source

FieldNamePickerConfigSettings interface

Signature

typescript 
export interface FieldNamePickerConfigSettings

Import

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

Properties

PropertyTypeDescription
filter(field: Field) => booleanFunction is a predicate, to test each element of the array. Return a value that coerces to true to keep the field, or to false otherwise.
infoComponentType<FieldNamePickerInfoProps> | nullWhen a field is selected, this component can show aditional information, including validation etc
noFieldsMessagestringShow this text when no values are found
placeholderTextstringPlaceholder text to display when nothing is selected.
widthnumberSets the width to a pixel value.

filter property

Function is a predicate, to test each element of the array. Return a value that coerces to true to keep the field, or to false otherwise.

Signature

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

info property

When a field is selected, this component can show aditional information, including validation etc

Signature

typescript 
info?: ComponentType<FieldNamePickerInfoProps> | null;

noFieldsMessage property

Show this text when no values are found

Signature

typescript 
noFieldsMessage?: string;

placeholderText property

Placeholder text to display when nothing is selected.

Signature

typescript 
placeholderText?: string;

width property

Sets the width to a pixel value.

Signature

typescript 
width?: number;