Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana documentation API Reference @grafana/data CircularVector

CircularVector class

Circular vector uses a single buffer to capture a stream of values overwriting the oldest value on add.

This supports adding to the ‘head’ or ’tail’ and will grow the buffer to match a configured capacity.

Signature

typescript Copy

export declare class CircularVector<T = any> extends FunctionalVector implements MutableVector<T> 

Import

typescript Copy

import { CircularVector } from '@grafana/data';

Constructors

Properties

Methods

constructor(options)

Constructs a new instance of the CircularVector class

Signature

typescript Copy

constructor(options: CircularOptions<T>);

Parameters

add property

Add the value to the buffer

Signature

typescript Copy

add: (value: T) => void;

length property

Signature

typescript Copy

get length(): number;

get method

Signature

typescript Copy

get(index: number): T;

Parameters

Returns:

T

reverse method

Signature

typescript Copy

reverse(): void;

Returns:

void

set method

Signature

typescript Copy

set(index: number, value: T): void;

Parameters

Returns:

void

setAppendMode method

Signature

typescript Copy

setAppendMode(mode: 'head' | 'tail'): void;

Parameters

Returns:

void

setCapacity method

Signature

typescript Copy

setCapacity(v: number): void;

Parameters

Returns:

void

toArray method

Signature

typescript Copy

toArray(): T[];

Returns:

T[]

toJSON method

Signature

typescript Copy

toJSON(): T[];

Returns:

T[]