mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 19:22:34 +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.
187 lines
3.4 KiB
Markdown
187 lines
3.4 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "CircularVector"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## CircularVector class
|
|
|
|
Circular vector uses a single buffer to capture a stream of values overwriting the oldest value on add.
|
|
|
|
This supports addting to the 'head' or 'tail' and will grow the buffer to match a configured capacity.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare class CircularVector<T = any> implements MutableVector<T>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { CircularVector } from '@grafana/data';
|
|
```
|
|
<b>Constructors</b>
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [constructor(options)](#constructor-options) | | Constructs a new instance of the <code>CircularVector</code> class |
|
|
|
|
<b>Properties</b>
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [add](#add-property) | | <code>(value: T) => void</code> | Add the value to the buffer |
|
|
| [length](#length-property) | | <code>number</code> | |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [get(index)](#get-method) | | |
|
|
| [reverse()](#reverse-method) | | |
|
|
| [set(index, value)](#set-method) | | |
|
|
| [setAppendMode(mode)](#setappendmode-method) | | |
|
|
| [setCapacity(v)](#setcapacity-method) | | |
|
|
| [toArray()](#toarray-method) | | |
|
|
| [toJSON()](#tojson-method) | | |
|
|
|
|
### constructor(options)
|
|
|
|
Constructs a new instance of the `CircularVector` class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
constructor(options: CircularOptions<T>);
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| options | <code>CircularOptions<T></code> | |
|
|
|
|
### add property
|
|
|
|
Add the value to the buffer
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
add: (value: T) => void;
|
|
```
|
|
|
|
### length property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
get length(): number;
|
|
```
|
|
|
|
### get method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
get(index: number): T;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| index | <code>number</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`T`
|
|
|
|
### reverse method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
reverse(): void;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### set method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
set(index: number, value: T): void;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| index | <code>number</code> | |
|
|
| value | <code>T</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### setAppendMode method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
setAppendMode(mode: 'head' | 'tail'): void;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| mode | <code>'head' | 'tail'</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### setCapacity method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
setCapacity(v: number): void;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| v | <code>number</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### toArray method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
toArray(): T[];
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`T[]`
|
|
|
|
### toJSON method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
toJSON(): T[];
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`T[]`
|
|
|