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.

Documentation Grafana documentation API Reference @grafana/data compareDataFrameStructures

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 name, fields, labels and configs.

Signature

typescript Copy

export declare function compareDataFrameStructures(a: DataFrame, b: DataFrame, skipConfig?: boolean): boolean;

Import

typescript Copy

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

Parameters

Returns:

boolean

Example

To compare multiple frames use:

Copy

compareArrayValues(a, b, framesHaveSameStructure);

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