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.

Documentation Grafana documentation API Reference @grafana/data FieldCache

FieldCache class

Signature

typescript Copy

export declare class FieldCache 

Import

typescript Copy

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

Constructors

Properties

Methods

constructor(data)

Constructs a new instance of the FieldCache class

Signature

typescript Copy

constructor(data: DataFrame);

Parameters

fields property

Signature

typescript Copy

fields: FieldWithIndex[];

getFieldByName method

Returns the first field with the given name.

Signature

typescript Copy

getFieldByName(name: string): FieldWithIndex | undefined;

Parameters

Returns:

FieldWithIndex | undefined

getFields method

Signature

typescript Copy

getFields(type?: FieldType): FieldWithIndex[];

Parameters

Returns:

FieldWithIndex[]

getFieldsByLabel method

Returns the fields with the given label.

Signature

typescript Copy

getFieldsByLabel(label: string, value: string): FieldWithIndex[];

Parameters

Returns:

FieldWithIndex[]

getFirstFieldOfType method

Signature

typescript Copy

getFirstFieldOfType(type: FieldType, includeHidden?: boolean): FieldWithIndex | undefined;

Parameters

Returns:

FieldWithIndex | undefined

hasFieldNamed method

Signature

typescript Copy

hasFieldNamed(name: string): boolean;

Parameters

Returns:

boolean

hasFieldOfType method

Signature

typescript Copy

hasFieldOfType(type: FieldType): boolean;

Parameters

Returns:

boolean

hasFieldWithNameAndType method

Signature

typescript Copy

hasFieldWithNameAndType(name: string, type: FieldType): boolean;

Parameters

Returns:

boolean