Menu

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.

Enterprise Open source

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

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

Import

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

Constructors

ConstructorModifiersDescription
constructor(options)Constructs a new instance of the CircularVector class

Properties

PropertyModifiersTypeDescription
add(value: T) => voidAdd the value to the buffer
lengthnumber

Methods

MethodModifiersDescription
get(index)
reverse()
set(index, value)
setAppendMode(mode)
setCapacity(v)
toArray()
toJSON()

constructor(options)

Constructs a new instance of the CircularVector class

Signature

typescript
constructor(options: CircularOptions<T>);

Parameters

ParameterTypeDescription
optionsCircularOptions<T>

add property

Add the value to the buffer

Signature

typescript
add: (value: T) => void;

length property

Signature

typescript
get length(): number;

get method

Signature

typescript
get(index: number): T;

Parameters

ParameterTypeDescription
indexnumber

Returns:

T

reverse method

Signature

typescript
reverse(): void;

Returns:

void

set method

Signature

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

Parameters

ParameterTypeDescription
indexnumber
valueT

Returns:

void

setAppendMode method

Signature

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

Parameters

ParameterTypeDescription
mode‘head’ | ’tail’

Returns:

void

setCapacity method

Signature

typescript
setCapacity(v: number): void;

Parameters

ParameterTypeDescription
vnumber

Returns:

void

toArray method

Signature

typescript
toArray(): T[];

Returns:

T[]

toJSON method

Signature

typescript
toJSON(): T[];

Returns:

T[]