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

FieldState interface

Signature

typescript
export interface FieldState 

Import

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

Properties

PropertyTypeDescription
calcsFieldCalcsCache of reduced values
displayNamestring | nullAn appropriate name for the field (does not include frame info)
rangeNumericRangeThe numeric range for values in this field. This value will respect the min/max set in field config, or when set to auto this will have the min/max for all data in the response
scopedVarsScopedVarsAppropriate values for templating
seriesIndexnumberSeries index is index for this field in a larger data set that can span multiple DataFrames Useful for assigning color to series by looking up a color in a palette using this index

calcs property

Cache of reduced values

Signature

typescript
calcs?: FieldCalcs;

displayName property

An appropriate name for the field (does not include frame info)

Signature

typescript
displayName?: string | null;

range property

The numeric range for values in this field. This value will respect the min/max set in field config, or when set to auto this will have the min/max for all data in the response

Signature

typescript
range?: NumericRange;

scopedVars property

Appropriate values for templating

Signature

typescript
scopedVars?: ScopedVars;

seriesIndex property

Series index is index for this field in a larger data set that can span multiple DataFrames Useful for assigning color to series by looking up a color in a palette using this index

Signature

typescript
seriesIndex?: number;