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

MutableDataFrame class

Signature

typescript
export declare class MutableDataFrame<T = any> extends FunctionalVector<T> implements DataFrame, MutableVector<T> 

Import

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

Constructors

ConstructorModifiersDescription
constructor(source, creator)Constructs a new instance of the MutableDataFrame class

Properties

PropertyModifiersTypeDescription
fieldsMutableField[]
lengthnumber
metaQueryResultMeta
namestring
refIdstring

Methods

MethodModifiersDescription
add(value)Add values from an object to corresponding fields. Similar to appendRow but does not create new fields.
addField(f, startLength)
addFieldFor(value, name)
appendRow(row)This will add each value to the corresponding column
get(idx)Get an object with a property for each field in the DataFrame
reverse()Reverse all values
set(index, value)
setParser(field, parser)
toJSON()The simplified JSON values used in JSON.stringify()
validate()

constructor(source, creator)

Constructs a new instance of the MutableDataFrame class

Signature

typescript
constructor(source?: DataFrame | DataFrameDTO, creator?: MutableVectorCreator);

Parameters

ParameterTypeDescription
sourceDataFrame | DataFrameDTO
creatorMutableVectorCreator

fields property

Signature

typescript
fields: MutableField[];

length property

Signature

typescript
get length(): number;

meta property

Signature

typescript
meta?: QueryResultMeta;

name property

Signature

typescript
name?: string;

refId property

Signature

typescript
refId?: string;

add method

Add values from an object to corresponding fields. Similar to appendRow but does not create new fields.

Signature

typescript
add(value: T): void;

Parameters

ParameterTypeDescription
valueT

Returns:

void

addField method

Signature

typescript
addField(f: Field | FieldDTO, startLength?: number): MutableField;

Parameters

ParameterTypeDescription
fField | FieldDTO
startLengthnumber

Returns:

MutableField

addFieldFor method

Signature

typescript
addFieldFor(value: any, name?: string): MutableField;

Parameters

ParameterTypeDescription
valueany
namestring

Returns:

MutableField

appendRow method

This will add each value to the corresponding column

Signature

typescript
appendRow(row: any[]): void;

Parameters

ParameterTypeDescription
rowany[]

Returns:

void

get method

Get an object with a property for each field in the DataFrame

Signature

typescript
get(idx: number): T;

Parameters

ParameterTypeDescription
idxnumber

Returns:

T

reverse method

Reverse all values

Signature

typescript
reverse(): void;

Returns:

void

set method

Signature

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

Parameters

ParameterTypeDescription
indexnumber
valueT

Returns:

void

setParser method

Signature

typescript
setParser(field: Field, parser: (v: string) => any): (v: string) => any;

Parameters

ParameterTypeDescription
fieldField
parser(v: string) => any

Returns:

(v: string) => any

toJSON method

The simplified JSON values used in JSON.stringify()

Signature

typescript
toJSON(): DataFrameDTO;

Returns:

DataFrameDTO

validate method

Signature

typescript
validate(): void;

Returns:

void