MutableDataFrame class

Signature

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

Import

  1. 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

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

Parameters

ParameterTypeDescription
sourceDataFrame | DataFrameDTO
creatorMutableVectorCreator

fields property

Signature

  1. fields: MutableField[];

length property

Signature

  1. get length(): number;

meta property

Signature

  1. meta?: QueryResultMeta;

name property

Signature

  1. name?: string;

refId property

Signature

  1. refId?: string;

add method

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

Signature

  1. add(value: T): void;

Parameters

ParameterTypeDescription
valueT

Returns:

void

addField method

Signature

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

Parameters

ParameterTypeDescription
fField | FieldDTO
startLengthnumber

Returns:

MutableField

addFieldFor method

Signature

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

Parameters

ParameterTypeDescription
valueany
namestring

Returns:

MutableField

appendRow method

This will add each value to the corresponding column

Signature

  1. appendRow(row: any[]): void;

Parameters

ParameterTypeDescription
rowany[]

Returns:

void

get method

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

Signature

  1. get(idx: number): T;

Parameters

ParameterTypeDescription
idxnumber

Returns:

T

reverse method

Reverse all values

Signature

  1. reverse(): void;

Returns:

void

set method

Signature

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

Parameters

ParameterTypeDescription
indexnumber
valueT

Returns:

void

setParser method

Signature

  1. 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

  1. toJSON(): DataFrameDTO;

Returns:

DataFrameDTO

validate method

Signature

  1. validate(): void;

Returns:

void