GridChartsRendererProxy API

API reference docs for the React GridChartsRendererProxy component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import { GridChartsRendererProxy } from '@mui/x-data-grid-premium/context';
// or
import { GridChartsRendererProxy } from '@mui/x-data-grid-premium';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Required

The unique identifier for the chart.

Type:string

renderer

Required

The renderer component that will render the chart.

Type:func | { contextType?: func, defaultProps?: { chartType?: string, configuration?: Record, dimensions?: Array<{}>, onRender?: func, values?: Array<{}> }, displayName?: string, getDerivedStateFromError?: func, getDerivedStateFromProps?: func, propTypes?: any }

label

The label for the chart.

Type:string

onRender

Callback function called when the chart is about to be rendered. Use this to check and modify the chart props before it is rendered.

Type:func

Signature:

function(type: string, props: Record, Component: ComponentType) => ReactNode

The ref is forwarded to the root element.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.