grafana/docs/sources/packages_api/data/flotdatapoint.md

80 lines
1.4 KiB
Markdown
Raw Normal View History

Docs: adding first version of the auto-generated packages API docs. (#22107) * 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.
2020-02-26 17:03:53 +08:00
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FlotDataPoint"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## FlotDataPoint interface
<b>Signature</b>
```typescript
export interface FlotDataPoint
```
<b>Import</b>
```typescript
import { FlotDataPoint } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [dataIndex](#dataindex-property) | <code>number</code> | |
| [datapoint](#datapoint-property) | <code>number[]</code> | |
| [pageX](#pagex-property) | <code>number</code> | |
| [pageY](#pagey-property) | <code>number</code> | |
| [series](#series-property) | <code>any</code> | |
| [seriesIndex](#seriesindex-property) | <code>number</code> | |
### dataIndex property
<b>Signature</b>
```typescript
dataIndex: number;
```
### datapoint property
<b>Signature</b>
```typescript
datapoint: number[];
```
### pageX property
<b>Signature</b>
```typescript
pageX: number;
```
### pageY property
<b>Signature</b>
```typescript
pageY: number;
```
### series property
<b>Signature</b>
```typescript
series: any;
```
### seriesIndex property
<b>Signature</b>
```typescript
seriesIndex: number;
```