API Reference@grafana/dataDataFrameView

DataFrameView class

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This abstraction will present the contents of a DataFrame as if it were a well typed javascript object Vector.

Signature

export declare class DataFrameView<T = any> extends FunctionalVector<T> 

Import

import { DataFrameView } from '@grafana/data';

Remarks

The DataFrameView.get() is optimized for use in a loop and will return same object. See function for more details.

Constructors

Constructor Modifiers Description
constructor(data) (BETA) Constructs a new instance of the DataFrameView class

Properties

Property Modifiers Type Description
dataFrame DataFrame (BETA)
fields {
readonly [Property in keyof T]: Field<T[Property]>;
}
(BETA)
length number (BETA)

Methods

Method Modifiers Description
get(idx) (BETA) The contents of the object returned from this function are optimized for use in a loop. All calls return the same object but the index has changed.
getFieldDisplayProcessor(colIndex) (BETA) Helper function to return the DisplayProcessor for a given field column.
toArray() (BETA)

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

constructor(data)

Constructs a new instance of the DataFrameView class

Signature

constructor(data: DataFrame);

Parameters

Parameter Type Description
data DataFrame

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

dataFrame property

Signature

get dataFrame(): DataFrame;

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

fields property

Signature

readonly fields: {
        readonly [Property in keyof T]: Field<T[Property]>;
    };

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

length property

Signature

get length(): number;

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

get method

The contents of the object returned from this function are optimized for use in a loop. All calls return the same object but the index has changed.

Signature

get(idx: number): T;

Parameters

Parameter Type Description
idx number The index of the object you currently are inspecting

Returns:

T

Example

  // `first`, `second` and `third` will all point to the same contents at index 2:
  const first = view.get(0);
  const second = view.get(1);
  const third = view.get(2);

  // If you need three different objects, consider something like:
  const first = { ...view.get(0) };
  const second = { ...view.get(1) };
  const third = { ...view.get(2) };

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

getFieldDisplayProcessor method

Helper function to return the DisplayProcessor for a given field column.

Signature

getFieldDisplayProcessor(colIndex: number): DisplayProcessor | undefined;

Parameters

Parameter Type Description
colIndex number the field column index for the data frame.

Returns:

DisplayProcessor | undefined

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

toArray method

Signature

toArray(): T[];

Returns:

T[]