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.
MutableDataFrame class
Signature
export declare class MutableDataFrame<T = any> extends FunctionalVector<T> implements DataFrame, MutableVector<T>
Import
import { MutableDataFrame } from '@grafana/data';
Constructors
Constructor | Modifiers | Description |
---|---|---|
constructor(source, creator) | Constructs a new instance of the MutableDataFrame class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
fields | MutableField[] | ||
length | number | ||
meta | QueryResultMeta | ||
name | string | ||
refId | string |
Methods
Method | Modifiers | Description |
---|---|---|
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) | ||
toJSON() | The simplified JSON values used in JSON.stringify() | |
validate() |
constructor(source, creator)
Constructs a new instance of the MutableDataFrame
class
Signature
constructor(source?: DataFrame | DataFrameDTO, creator?: MutableVectorCreator);
Parameters
Parameter | Type | Description |
---|---|---|
source | DataFrame | DataFrameDTO | |
creator | MutableVectorCreator |
fields property
Signature
fields: MutableField[];
length property
Signature
get length(): number;
meta property
Signature
meta?: QueryResultMeta;
name property
Signature
name?: string;
refId property
Signature
refId?: string;
add method
Add values from an object to corresponding fields. Similar to appendRow but does not create new fields.
Signature
add(value: T): void;
Parameters
Parameter | Type | Description |
---|---|---|
value | T |
Returns:
void
addField method
Signature
addField(f: Field | FieldDTO, startLength?: number): MutableField;
Parameters
Parameter | Type | Description |
---|---|---|
f | Field | FieldDTO | |
startLength | number |
Returns:
MutableField
addFieldFor method
Signature
addFieldFor(value: any, name?: string): MutableField;
Parameters
Parameter | Type | Description |
---|---|---|
value | any | |
name | string |
Returns:
MutableField
appendRow method
This will add each value to the corresponding column
Signature
appendRow(row: any[]): void;
Parameters
Parameter | Type | Description |
---|---|---|
row | any[] |
Returns:
void
get method
Get an object with a property for each field in the DataFrame
Signature
get(idx: number): T;
Parameters
Parameter | Type | Description |
---|---|---|
idx | number |
Returns:
T
reverse method
Reverse all values
Signature
reverse(): void;
Returns:
void
set method
Signature
set(index: number, value: T): void;
Parameters
Parameter | Type | Description |
---|---|---|
index | number | |
value | T |
Returns:
void
toJSON method
The simplified JSON values used in JSON.stringify()
Signature
toJSON(): DataFrameDTO;
Returns:
DataFrameDTO
validate method
Signature
validate(): void;
Returns:
void