mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 19:42:30 +08:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
5.4 KiB
5.4 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "MutableDataFrame" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++
MutableDataFrame class
Signature
export declare class MutableDataFrame<T = any> 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 |
||
| values | KeyValue<MutableVector> |
Methods
| Method | Modifiers | Description |
|---|---|---|
| add(value, addMissingFields) | Add all properties of the value as fields on the frame | |
| 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, addMissingFields) | ||
| toArray() | ||
| 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;
values property
Signature
values: KeyValue<MutableVector>;
add method
Add all properties of the value as fields on the frame
Signature
add(value: T, addMissingFields?: boolean): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| value | T |
|
| addMissingFields | boolean |
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, addMissingFields?: boolean): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| index | number |
|
| value | T |
|
| addMissingFields | boolean |
Returns:
void
toArray method
Signature
toArray(): T[];
Returns:
T[]
toJSON method
The simplified JSON values used in JSON.stringify()
Signature
toJSON(): DataFrameDTO;
Returns:
DataFrameDTO
validate method
Signature
validate(): void;
Returns:
void