grafana/docs/sources/packages_api/ui/gauge.md
Marcus Andersson cc3fc18076
Docs: enable packages reference docs for 7-beta (#23953)
* added packages reference menu item.

* removed the draft flag.

* Updated docs by running script.
2020-04-28 09:53:58 +02:00

2.5 KiB

+++

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

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

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

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

Gauge class

Signature

export declare class Gauge extends PureComponent<Props> 

Import

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

Properties

Property Modifiers Type Description
canvasElement any
defaultProps static Partial<Props>
renderVisualization () => JSX.Element

Methods

Method Modifiers Description
componentDidMount()
componentDidUpdate()
draw()
getFontScale(length)
getFormattedThresholds()
render()

canvasElement property

Signature

canvasElement: any;

defaultProps property

Signature

static defaultProps: Partial<Props>;

renderVisualization property

Signature

renderVisualization: () => JSX.Element;

componentDidMount method

Signature

componentDidMount(): void;

Returns:

void

componentDidUpdate method

Signature

componentDidUpdate(): void;

Returns:

void

draw method

Signature

draw(): void;

Returns:

void

getFontScale method

Signature

getFontScale(length: number): number;

Parameters

Parameter Type Description
length number

Returns:

number

getFormattedThresholds method

Signature

getFormattedThresholds(): Threshold[];

Returns:

Threshold[]

render method

Signature

render(): JSX.Element;

Returns:

JSX.Element