IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-14 01:23:32 -06:00
Code Issues Packages Projects Releases Wiki Activity
7e18ca7ed1
grafana/docs/sources/packages_api/ui/gauge.md
Marcus Andersson 6a0abf895e
Docs: generated a 7.0 version of the packages reference docs. (#24708) 
* fixes so we match the transformer based on name properly.

* changed the signature on the FieldMatcher.

* introduced a names option so you can filter in name specificly.

* changed so the matcher UI uses the new options format.

* moved the exported functions together.

* changing editors a bit.

* made the filter by name work with both regex and name filtering.

* fixed failing tests and make sure we always parse regex the same way.

* removed unused code.

* simplified to make the existing field overrides still working.

* fixed issue reported by hugo.

* added tests for the name matcher.

* added tests for filter by name.

* added more tests.

* generated new version of the packages docs.

* fixed spelling error.

* regenerated the docs.
2020-05-14 21:34:59 +02:00

2.6 KiB
Raw Blame History

+++

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

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(decimals)
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(decimals: number): Threshold[];

Parameters

Parameter Type Description
decimals number

Returns:

Threshold[]

render method

Signature

render(): JSX.Element;

Returns:

JSX.Element