mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 09:52:12 +08:00

* 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.
239 lines
6.0 KiB
Markdown
239 lines
6.0 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "Graph"
|
|
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## Graph class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare class Graph extends PureComponent<GraphProps, GraphState>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { Graph } from '@grafana/ui';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [$element](#_element-property) | | <code>any</code> | |
|
|
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>{</code><br/><code> showLines: boolean;</code><br/><code> showPoints: boolean;</code><br/><code> showBars: boolean;</code><br/><code> isStacked: boolean;</code><br/><code> lineWidth: number;</code><br/><code> }</code> | |
|
|
| [element](#element-property) | | <code>HTMLElement | null</code> | |
|
|
| [getBarWidth](#getbarwidth-property) | | <code>() => number</code> | |
|
|
| [onPlotClick](#onplotclick-property) | | <code>(event: JQueryEventObject, contextPos: FlotPosition, item?: FlotItem<GraphSeriesXY> | undefined) => void</code> | |
|
|
| [onPlotHover](#onplothover-property) | | <code>(event: JQueryEventObject, pos: FlotPosition, item?: FlotItem<GraphSeriesXY> | undefined) => void</code> | |
|
|
| [onPlotSelected](#onplotselected-property) | | <code>(event: JQueryEventObject, ranges: {</code><br/><code> xaxis: {</code><br/><code> from: number;</code><br/><code> to: number;</code><br/><code> };</code><br/><code> }) => void</code> | |
|
|
| [renderContextMenu](#rendercontextmenu-property) | | <code>() => JSX.Element | null</code> | |
|
|
| [renderTooltip](#rendertooltip-property) | | <code>() => React.ReactElement<TooltipProps, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null</code> | |
|
|
| [state](#state-property) | | <code>GraphState</code> | |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [componentDidMount()](#componentdidmount-method) | | |
|
|
| [componentDidUpdate(prevProps, prevState)](#componentdidupdate-method) | | |
|
|
| [componentWillUnmount()](#componentwillunmount-method) | | |
|
|
| [draw()](#draw-method) | | |
|
|
| [getYAxes(series)](#getyaxes-method) | | |
|
|
| [render()](#render-method) | | |
|
|
|
|
### $element property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
$element: any;
|
|
```
|
|
|
|
### defaultProps property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
static defaultProps: {
|
|
showLines: boolean;
|
|
showPoints: boolean;
|
|
showBars: boolean;
|
|
isStacked: boolean;
|
|
lineWidth: number;
|
|
};
|
|
```
|
|
|
|
### element property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
element: HTMLElement | null;
|
|
```
|
|
|
|
### getBarWidth property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
getBarWidth: () => number;
|
|
```
|
|
|
|
### onPlotClick property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onPlotClick: (event: JQueryEventObject, contextPos: FlotPosition, item?: FlotItem<GraphSeriesXY> | undefined) => void;
|
|
```
|
|
|
|
### onPlotHover property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onPlotHover: (event: JQueryEventObject, pos: FlotPosition, item?: FlotItem<GraphSeriesXY> | undefined) => void;
|
|
```
|
|
|
|
### onPlotSelected property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onPlotSelected: (event: JQueryEventObject, ranges: {
|
|
xaxis: {
|
|
from: number;
|
|
to: number;
|
|
};
|
|
}) => void;
|
|
```
|
|
|
|
### renderContextMenu property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
renderContextMenu: () => JSX.Element | null;
|
|
```
|
|
|
|
### renderTooltip property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
renderTooltip: () => React.ReactElement<TooltipProps, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null;
|
|
```
|
|
|
|
### state property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
state: GraphState;
|
|
```
|
|
|
|
### componentDidMount method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
componentDidMount(): void;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### componentDidUpdate method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
componentDidUpdate(prevProps: GraphProps, prevState: GraphState): void;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| prevProps | <code>GraphProps</code> | |
|
|
| prevState | <code>GraphState</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### componentWillUnmount method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
componentWillUnmount(): void;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### draw method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
draw(): void;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### getYAxes method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
getYAxes(series: GraphSeriesXY[]): {
|
|
show: boolean;
|
|
index: number;
|
|
position: string;
|
|
min: import("@grafana/data").DecimalCount;
|
|
tickDecimals: import("@grafana/data").DecimalCount;
|
|
}[] | {
|
|
show: boolean;
|
|
min: number;
|
|
max: number;
|
|
}[];
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| series | <code>GraphSeriesXY[]</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`{
|
|
show: boolean;
|
|
index: number;
|
|
position: string;
|
|
min: import("@grafana/data").DecimalCount;
|
|
tickDecimals: import("@grafana/data").DecimalCount;
|
|
}[] | {
|
|
show: boolean;
|
|
min: number;
|
|
max: number;
|
|
}[]`
|
|
|
|
### render method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
render(): JSX.Element;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`JSX.Element`
|
|
|