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

FieldColorConfigSettings interface

Signature

typescript
export interface FieldColorConfigSettings 

Import

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

Properties

PropertyTypeDescription
bySeriesSupportbooleanSet to true if the visualization supports both by value and by series This will enable the Color by series UI option that sets the color.seriesBy option.
byValueSupportbooleanWhen switching to a visualization that does not support by value coloring then Grafana will switch to a by series palette based color mode
preferThresholdsModebooleanWhen switching to a visualization that has this set to true then Grafana will change color mode to from thresholds if it was set to a by series palette

bySeriesSupport property

Set to true if the visualization supports both by value and by series This will enable the Color by series UI option that sets the color.seriesBy option.

Signature

typescript
bySeriesSupport?: boolean;

byValueSupport property

When switching to a visualization that does not support by value coloring then Grafana will switch to a by series palette based color mode

Signature

typescript
byValueSupport?: boolean;

preferThresholdsMode property

When switching to a visualization that has this set to true then Grafana will change color mode to from thresholds if it was set to a by series palette

Signature

typescript
preferThresholdsMode?: boolean;