Menu

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.

Enterprise Open source

GraphNGProps interface

Signature

typescript
export interface GraphNGProps extends Themeable2 

Import

typescript
import { GraphNGProps } from '@grafana/ui';

Properties

PropertyTypeDescription
children(builder: UPlotConfigBuilder, alignedFrame: DataFrame) => React.ReactNode
fieldsXYFieldMatchers
framesDataFrame[]
heightnumber
legendVizLegendOptions
onLegendClick(event: GraphNGLegendEvent) => void
preparePlotFrame(frames: DataFrame[], dimFields: XYFieldMatchers) => DataFrame
prepConfig(alignedFrame: DataFrame, allFrames: DataFrame[], getTimeRange: () => TimeRange) => UPlotConfigBuilder
propsToDiffArray<string | PropDiffFn>
renderLegend(config: UPlotConfigBuilder) => React.ReactElement | null
structureRevnumber
timeRangeTimeRange
timeZoneTimeZone
widthnumber

children property

Signature

typescript
children?: (builder: UPlotConfigBuilder, alignedFrame: DataFrame) => React.ReactNode;

fields property

Signature

typescript
fields?: XYFieldMatchers;

frames property

Signature

typescript
frames: DataFrame[];

height property

Signature

typescript
height: number;

legend property

Signature

typescript
legend: VizLegendOptions;

onLegendClick property

Signature

typescript
onLegendClick?: (event: GraphNGLegendEvent) => void;

preparePlotFrame property

Signature

typescript
preparePlotFrame?: (frames: DataFrame[], dimFields: XYFieldMatchers) => DataFrame;

prepConfig property

Signature

typescript
prepConfig: (alignedFrame: DataFrame, allFrames: DataFrame[], getTimeRange: () => TimeRange) => UPlotConfigBuilder;

propsToDiff property

Signature

typescript
propsToDiff?: Array<string | PropDiffFn>;

renderLegend property

Signature

typescript
renderLegend: (config: UPlotConfigBuilder) => React.ReactElement | null;

structureRev property

Signature

typescript
structureRev?: number;

timeRange property

Signature

typescript
timeRange: TimeRange;

timeZone property

Signature

typescript
timeZone: TimeZone;

width property

Signature

typescript
width: number;