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.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/databreadcrumb arrow DisplayValue
Enterprise Open source

DisplayValue interface

Signature

typescript 
export interface DisplayValue extends FormattedValue

Import

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

Properties

PropertyTypeDescription
colorstringColor based on mappings or threshold
descriptionstringUsed in limited scenarios like legend reducer calculations
iconstringIcon based on mappings or threshold
numericnumberUse isNaN to check if it is a real number
percentnumber0-1 between min & max
titlestring

color property

Color based on mappings or threshold

Signature

typescript 
color?: string;

description property

Used in limited scenarios like legend reducer calculations

Signature

typescript 
description?: string;

icon property

Icon based on mappings or threshold

Signature

typescript 
icon?: string;

numeric property

Use isNaN to check if it is a real number

Signature

typescript 
numeric: number;

percent property

0-1 between min & max

Signature

typescript 
percent?: number;

title property

Signature

typescript 
title?: string;