Files
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

143 lines
2.6 KiB
Markdown

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Gauge"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## Gauge class
<b>Signature</b>
```typescript
export declare class Gauge extends PureComponent<Props>
```
<b>Import</b>
```typescript
import { Gauge } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [canvasElement](#canvaselement-property) | | <code>any</code> | |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>Partial&lt;Props&gt;</code> | |
| [renderVisualization](#rendervisualization-property) | | <code>() =&gt; JSX.Element</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [componentDidMount()](#componentdidmount-method) | | |
| [componentDidUpdate()](#componentdidupdate-method) | | |
| [draw()](#draw-method) | | |
| [getFontScale(length)](#getfontscale-method) | | |
| [getFormattedThresholds(decimals)](#getformattedthresholds-method) | | |
| [render()](#render-method) | | |
### canvasElement property
<b>Signature</b>
```typescript
canvasElement: any;
```
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: Partial<Props>;
```
### renderVisualization property
<b>Signature</b>
```typescript
renderVisualization: () => JSX.Element;
```
### componentDidMount method
<b>Signature</b>
```typescript
componentDidMount(): void;
```
<b>Returns:</b>
`void`
### componentDidUpdate method
<b>Signature</b>
```typescript
componentDidUpdate(): void;
```
<b>Returns:</b>
`void`
### draw method
<b>Signature</b>
```typescript
draw(): void;
```
<b>Returns:</b>
`void`
### getFontScale method
<b>Signature</b>
```typescript
getFontScale(length: number): number;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| length | <code>number</code> | |
<b>Returns:</b>
`number`
### getFormattedThresholds method
<b>Signature</b>
```typescript
getFormattedThresholds(decimals: number): Threshold[];
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| decimals | <code>number</code> | |
<b>Returns:</b>
`Threshold[]`
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`