React Charts - Export Several Charts

The DevExpress.viz.exportWidgets(widgetInstances, options) method allows you to export several charts to a single image or document.

The widgetInstances parameter accepts an array with the following format:

[
    [ widgetInstance0_1, widgetInstance0_2, ..., widgetInstance0_N ],
    [ widgetInstance1_1, widgetInstance1_2, ..., widgetInstance1_M ],
    ...
    [ widgetInstanceP_1, widgetInstanceP_2, ..., widgetInstanceP_R ]
]

TS JS

Backend API

import React, { useCallback, useRef } from 'react'; import Chart, { Series, Label, Legend } from 'devextreme-react/chart'; import type { ChartRef } from 'devextreme-react/chart'; import PieChart, { Series as PieSeries, Label as PieLabel, Connector } from 'devextreme-react/pie-chart'; import type { PieChartRef } from 'devextreme-react/pie-chart'; import { Button } from 'devextreme-react/button'; import { exportWidgets } from 'devextreme/viz/export'; import { allMedals, goldMedals } from './data.ts'; function App() { const chartRef = useRef<ChartRef>(null); const pieChartRef = useRef<PieChartRef>(null); const onClick = useCallback(() => { const chart = chartRef.current?.instance(); const pieChart = pieChartRef.current?.instance(); if (!chart || !pieChart) { return; } exportWidgets([[chart, pieChart]], { fileName: 'chart', format: 'PNG', }); }, []); return ( <div id="chart-demo"> <div className="charts"> <Chart id="chart" ref={chartRef} dataSource={goldMedals} rotated={true} title="Olympic Gold Medals in 2008" > <Series type="bar" argumentField="country" valueField="medals" color="#f3c40b" > <Label visible={true} /> </Series> <Legend visible={false} /> </Chart> <PieChart id="pieChart" ref={pieChartRef} dataSource={allMedals} palette="Harmony Light" title={'Total Olympic Medals\n in 2008'} > <PieSeries argumentField="country" valueField="medals" > <PieLabel visible={true}> <Connector visible={true} /> </PieLabel> </PieSeries> </PieChart> </div> <div className="controls-pane"> <Button id="export" width={145} icon="export" text="Export" type="default" onClick={onClick} /> </div> </div> ); } export default App;

import React, { useCallback, useRef } from 'react'; import Chart, { Series, Label, Legend } from 'devextreme-react/chart'; import PieChart, { Series as PieSeries, Label as PieLabel, Connector, } from 'devextreme-react/pie-chart'; import { Button } from 'devextreme-react/button'; import { exportWidgets } from 'devextreme/viz/export'; import { allMedals, goldMedals } from './data.js'; function App() { const chartRef = useRef(null); const pieChartRef = useRef(null); const onClick = useCallback(() => { const chart = chartRef.current?.instance(); const pieChart = pieChartRef.current?.instance(); if (!chart || !pieChart) { return; } exportWidgets([[chart, pieChart]], { fileName: 'chart', format: 'PNG', }); }, []); return ( <div id="chart-demo"> <div className="charts"> <Chart id="chart" ref={chartRef} dataSource={goldMedals} rotated={true} title="Olympic Gold Medals in 2008" > <Series type="bar" argumentField="country" valueField="medals" color="#f3c40b" > <Label visible={true} /> </Series> <Legend visible={false} /> </Chart> <PieChart id="pieChart" ref={pieChartRef} dataSource={allMedals} palette="Harmony Light" title={'Total Olympic Medals\n in 2008'} > <PieSeries argumentField="country" valueField="medals" > <PieLabel visible={true}> <Connector visible={true} /> </PieLabel> </PieSeries> </PieChart> </div> <div className="controls-pane"> <Button id="export" width={145} icon="export" text="Export" type="default" onClick={onClick} /> </div> </div> ); } export default App;

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );

export const allMedals = [{ country: 'USA', medals: 110, }, { country: 'China', medals: 100, }, { country: 'Russia', medals: 71, }, { country: 'UK', medals: 47, }, { country: 'Australia', medals: 46, }, { country: 'Germany', medals: 41, }, { country: 'France', medals: 41, }, { country: 'South Korea', medals: 31, }]; export const goldMedals = [{ country: 'China', medals: 51, }, { country: 'USA', medals: 36, }, { country: 'Russia', medals: 22, }, { country: 'UK', medals: 19, }, { country: 'Germany', medals: 16, }, { country: 'Australia', medals: 14, }, { country: 'South Korea', medals: 13, }, { country: 'France', medals: 7, }];

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));

export const allMedals = [ { country: 'USA', medals: 110, }, { country: 'China', medals: 100, }, { country: 'Russia', medals: 71, }, { country: 'UK', medals: 47, }, { country: 'Australia', medals: 46, }, { country: 'Germany', medals: 41, }, { country: 'France', medals: 41, }, { country: 'South Korea', medals: 31, }, ]; export const goldMedals = [ { country: 'China', medals: 51, }, { country: 'USA', medals: 36, }, { country: 'Russia', medals: 22, }, { country: 'UK', medals: 19, }, { country: 'Germany', medals: 16, }, { country: 'Australia', medals: 14, }, { country: 'South Korea', medals: 13, }, { country: 'France', medals: 7, }, ];

<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/26.1.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="./bundle.css" /> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> <script src="bundles/vendor/react.vendor.js"></script> <script src="./bundle.js"></script> </body> </html>

#chart-demo { height: 460px; } .charts { width: 820px; margin: 0 auto; height: 374px; margin-bottom: 40px; font-size: 0; } #chart, #pieChart { width: 395px; height: 100%; display: inline-block; vertical-align: top; } #chart { margin-right: 30px; } .controls-pane { text-align: center; }

Each nested array contains component instances that should be in the same row in the exported document. In this demo, chartInstance and pieChartInstance occupy the only row in the document.

The options parameter accepts an object whose fields allow you to configure export properties. In this demo, we specify the fileName and format. Refer to the method description for information on other available fields.