API Reference@grafana/datacompareDataFrameStructures

compareDataFrameStructures() function

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.

compareDataFrameStructures() function

Returns true if both frames have the same list of fields and configs. Field may have diferent names, labels and values but share the same structure

To compare multiple frames use:

areArraysEqual(a, b, framesHaveSameStructure);

NOTE: this does a shallow check on the FieldConfig properties, when using the query editor, this should be sufficient, however if applicaitons are mutating properties deep in the FieldConfig this will not recognize a change

Signature

export declare function compareDataFrameStructures(a: DataFrame, b: DataFrame, skipProperties?: string[]): boolean;

Import

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

Parameters

Parameter Type Description
a DataFrame
b DataFrame
skipProperties string[]

Returns:

boolean