mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 08:33:00 +08:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
138 lines
2.5 KiB
Markdown
138 lines
2.5 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "Gauge"
|
|
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## 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<Props></code> | |
|
|
| [renderVisualization](#rendervisualization-property) | | <code>() => JSX.Element</code> | |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [componentDidMount()](#componentdidmount-method) | | |
|
|
| [componentDidUpdate()](#componentdidupdate-method) | | |
|
|
| [draw()](#draw-method) | | |
|
|
| [getFontScale(length)](#getfontscale-method) | | |
|
|
| [getFormattedThresholds()](#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(): Threshold[];
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`Threshold[]`
|
|
|
|
### render method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
render(): JSX.Element;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`JSX.Element`
|
|
|