mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 07:52:21 +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.
171 lines
2.8 KiB
Markdown
171 lines
2.8 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "AnnotationEvent"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## AnnotationEvent interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface AnnotationEvent
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { AnnotationEvent } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [annotation](#annotation-property) | <code>any</code> | |
|
|
| [avatarUrl](#avatarurl-property) | <code>string</code> | |
|
|
| [dashboardId](#dashboardid-property) | <code>number</code> | |
|
|
| [email](#email-property) | <code>string</code> | |
|
|
| [id](#id-property) | <code>string</code> | |
|
|
| [isRegion](#isregion-property) | <code>boolean</code> | |
|
|
| [login](#login-property) | <code>string</code> | |
|
|
| [panelId](#panelid-property) | <code>number</code> | |
|
|
| [source](#source-property) | <code>any</code> | |
|
|
| [tags](#tags-property) | <code>string[]</code> | |
|
|
| [text](#text-property) | <code>string</code> | |
|
|
| [time](#time-property) | <code>number</code> | |
|
|
| [timeEnd](#timeend-property) | <code>number</code> | |
|
|
| [title](#title-property) | <code>string</code> | |
|
|
| [type](#type-property) | <code>string</code> | |
|
|
| [userId](#userid-property) | <code>number</code> | |
|
|
|
|
### annotation property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
annotation?: any;
|
|
```
|
|
|
|
### avatarUrl property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
avatarUrl?: string;
|
|
```
|
|
|
|
### dashboardId property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
dashboardId?: number;
|
|
```
|
|
|
|
### email property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
email?: string;
|
|
```
|
|
|
|
### id property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
id?: string;
|
|
```
|
|
|
|
### isRegion property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
isRegion?: boolean;
|
|
```
|
|
|
|
### login property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
login?: string;
|
|
```
|
|
|
|
### panelId property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
panelId?: number;
|
|
```
|
|
|
|
### source property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
source?: any;
|
|
```
|
|
|
|
### tags property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
tags?: string[];
|
|
```
|
|
|
|
### text property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
text?: string;
|
|
```
|
|
|
|
### time property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
time?: number;
|
|
```
|
|
|
|
### timeEnd property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
timeEnd?: number;
|
|
```
|
|
|
|
### title property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
title?: string;
|
|
```
|
|
|
|
### type property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
type?: string;
|
|
```
|
|
|
|
### userId property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
userId?: number;
|
|
```
|