mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 07:42:23 +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.
3.4 KiB
3.4 KiB
+++
-----------------------------------------------------------------------
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.
Signature
export declare class CircularVector<T = any> implements MutableVector<T>
Import
import { CircularVector } from '@grafana/data';
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| constructor(options) | Constructs a new instance of the CircularVector class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| add | (value: T) => void |
Add the value to the buffer | |
| length | number |
Methods
| Method | Modifiers | Description |
|---|---|---|
| get(index) | ||
| reverse() | ||
| set(index, value) | ||
| setAppendMode(mode) | ||
| setCapacity(v) | ||
| toArray() | ||
| toJSON() |
constructor(options)
Constructs a new instance of the CircularVector class
Signature
constructor(options: CircularOptions<T>);
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | CircularOptions<T> |
add property
Add the value to the buffer
Signature
add: (value: T) => void;
length property
Signature
get length(): number;
get method
Signature
get(index: number): T;
Parameters
| Parameter | Type | Description |
|---|---|---|
| index | number |
Returns:
T
reverse method
Signature
reverse(): void;
Returns:
void
set method
Signature
set(index: number, value: T): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| index | number |
|
| value | T |
Returns:
void
setAppendMode method
Signature
setAppendMode(mode: 'head' | 'tail'): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| mode | 'head' | 'tail' |
Returns:
void
setCapacity method
Signature
setCapacity(v: number): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| v | number |
Returns:
void
toArray method
Signature
toArray(): T[];
Returns:
T[]
toJSON method
Signature
toJSON(): T[];
Returns:
T[]