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

VizLegendItem interface

Signature

typescript
export interface VizLegendItem<T = any> 

Import

typescript
import { VizLegendItem } from '@grafana/ui';

Properties

PropertyTypeDescription
colorstring
dataT
disabledboolean
fieldIndexDataFrameFieldIndex
getDisplayValues() => DisplayValue[]
getItemKey() => string
gradientstring
labelstring
yAxisnumber

color property

Signature

typescript
color?: string;

data property

Signature

typescript
data?: T;

disabled property

Signature

typescript
disabled?: boolean;

fieldIndex property

Signature

typescript
fieldIndex?: DataFrameFieldIndex;

getDisplayValues property

Signature

typescript
getDisplayValues?: () => DisplayValue[];

getItemKey property

Signature

typescript
getItemKey?: () => string;

gradient property

Signature

typescript
gradient?: string;

label property

Signature

typescript
label: string;

yAxis property

Signature

typescript
yAxis: number;