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

FieldColorMode interface

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Signature

typescript
export interface FieldColorMode extends RegistryItem 

Import

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

Properties

PropertyTypeDescription
getCalculator(field: Field, theme: GrafanaTheme2) => FieldValueColorCalculator(BETA)
getColors(theme: GrafanaTheme2) => string[](BETA)
isByValueboolean(BETA)
isContinuousboolean(BETA)

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

getCalculator property

Signature

typescript
getCalculator: (field: Field, theme: GrafanaTheme2) => FieldValueColorCalculator;

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

getColors property

Signature

typescript
getColors?: (theme: GrafanaTheme2) => string[];

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

isByValue property

Signature

typescript
isByValue?: boolean;

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

isContinuous property

Signature

typescript
isContinuous?: boolean;