Skip to content
+

Charts - Export

Charts can be printed and exported as PDF.

Export is available for the following charts: <LineChartPro />, <BarChartPro />, <ScatterChartPro />, PieChartPro />, <Heatmap />, <FunnelChart /> and <RadarChartPro />.

The apiRef prop exposes a exportAsPrint() method that can be used to open the browser's print dialog.

The print dialog allows you to print the chart or save it as a PDF, as well as configuring other settings.

  • Series A
  • Series B

Export as image

The apiRef prop also exposes a exportAsImage() method to export the chart as an image.

Dependency

For exportAsImage() to work, you need to add therasterizehtml npm dependency in your project.

npm install rasterizehtml

Usage

The function accepts an options object with the type property, which specifies the image format. The available formats are:

  • image/png and image/jpeg, which are supported across all supported platforms;
  • image/webp which is only supported in some browsers.

If the format is not supported by the browser, exportAsImage() falls back to image/png.

Additionally, for lossy formats such as image/jpeg and image/webp, the options object also accepts the quality property, which is a number between 0 and 1. The default value is 0.9.

  • Series A
  • Series B

Only applicable to lossy formats.

Press Enter to start editing

Composition

As detailed in the Composition section, charts can alternatively be composed of more specific components to create custom visualizations.

When exporting a chart, the ChartsWrapper element is considered the root element of the chart, and every descendant is included in the export. As such, you need to ensure that the ChartsWrapper element is the root element of the chart you want to export.

If you want to use a custom wrapper element, you need to use the useChartRootRef() hook to set the reference to the chart's root element so that exporting works properly, as exemplified below.

  • Bar
  • Line

API

See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.