grafana/docs/sources/packages_api/ui/bargauge.md

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "BarGauge" keywords = ["grafana","documentation","sdk","@grafana/ui"] type = "docs" +++

BarGauge class

Signature

export declare class BarGauge extends PureComponent<Props> 

Import

import { BarGauge } from '@grafana/ui';

Properties

Property	Modifiers	Type	Description
defaultProps	static	Partial<Props>

Methods

Method	Modifiers	Description
getCellColor(positionValue)
render()
renderBarAndValue()
renderBasicAndGradientBars()
renderRetroBars()

defaultProps property

Signature

static defaultProps: Partial<Props>;

getCellColor method

Signature

getCellColor(positionValue: TimeSeriesValue): CellColors;

Parameters

Parameter	Type	Description
positionValue	TimeSeriesValue

Returns:

CellColors

render method

Signature

render(): JSX.Element;

Returns:

JSX.Element

renderBarAndValue method

Signature

renderBarAndValue(): React.ReactNode;

Returns:

React.ReactNode

renderBasicAndGradientBars method

Signature

renderBasicAndGradientBars(): ReactNode;

Returns:

ReactNode

renderRetroBars method

Signature

renderRetroBars(): ReactNode;

Returns:

ReactNode