Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/grafana/v8.0/packages_api/ui/graphngprops.md, or by sending Accept: text/markdown to https://grafana.com/docs/grafana/v8.0/packages_api/ui/graphngprops/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
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.
GraphNGProps interface
Signature
export interface GraphNGProps extends Themeable2 Import
import { GraphNGProps } from '@grafana/ui';Properties
| Property | Type | Description |
|---|---|---|
| children | (builder: UPlotConfigBuilder, alignedFrame: DataFrame) => React.ReactNode | |
| fields | XYFieldMatchers | |
| frames | DataFrame[] | |
| height | number | |
| legend | VizLegendOptions | |
| onLegendClick | (event: GraphNGLegendEvent) => void | |
| preparePlotFrame | (frames: DataFrame[], dimFields: XYFieldMatchers) => DataFrame | |
| prepConfig | (alignedFrame: DataFrame, allFrames: DataFrame[], getTimeRange: () => TimeRange) => UPlotConfigBuilder | |
| propsToDiff | string[] | |
| renderLegend | (config: UPlotConfigBuilder) => React.ReactElement | null | |
| structureRev | number | |
| timeRange | TimeRange | |
| timeZone | TimeZone | |
| width | number |
children property
Signature
children?: (builder: UPlotConfigBuilder, alignedFrame: DataFrame) => React.ReactNode;fields property
Signature
fields?: XYFieldMatchers;frames property
Signature
frames: DataFrame[];height property
Signature
height: number;legend property
Signature
legend: VizLegendOptions;onLegendClick property
Signature
onLegendClick?: (event: GraphNGLegendEvent) => void;preparePlotFrame property
Signature
preparePlotFrame?: (frames: DataFrame[], dimFields: XYFieldMatchers) => DataFrame;prepConfig property
Signature
prepConfig: (alignedFrame: DataFrame, allFrames: DataFrame[], getTimeRange: () => TimeRange) => UPlotConfigBuilder;propsToDiff property
Signature
propsToDiff?: string[];renderLegend property
Signature
renderLegend: (config: UPlotConfigBuilder) => React.ReactElement | null;structureRev property
Signature
structureRev?: number;timeRange property
Signature
timeRange: TimeRange;timeZone property
Signature
timeZone: TimeZone;width property
Signature
width: number;