This is documentation for the next version of Grafana. For the latest stable release, go to the latest version.

API Reference@grafana/dataFieldColorMode

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

export interface FieldColorMode extends RegistryItem 

Import

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

Properties

Property Type Description
getCalculator (field: Field, theme: GrafanaTheme2) => FieldValueColorCalculator (BETA)
getColors (theme: GrafanaTheme2) => string[] (BETA)
isByValue boolean (BETA)
isContinuous boolean (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

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

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

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

isContinuous?: boolean;