API Reference@grafana/datagetLuminance

colorManipulator.getLuminance() function

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.

colorManipulator.getLuminance() function

The relative brightness of any point in a color space, normalized to 0 for darkest black and 1 for lightest white.

Formula: https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests

Signature

export declare function getLuminance(color: string, background?: string): number;

Import

import { colorManipulator } from '@grafana/data';
const { getLuminance } = colorManipulator;

Parameters

Parameter Type Description
color string CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
background string CSS color that needs to be take in to account to calculate luminance for colors with opacity

Returns:

number

The relative brightness of the color in the range 0 - 1