recharts-to-png
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.1 • Public • Published

    npm Build Status GitHub

    recharts-to-png

    Uses html2canvas to convert a Recharts chart to PNG.

    Inspired by these Stack Overflow questions and answers from peter.bartos and AlbertMunichMar. Special thanks to HarmNullix for helping to improve the performance of this library.

    Install

    npm install recharts-to-png
    

    Demo

    See the demo here. It implements useCurrentPng with different chart types and file-saver.

    Source:

    Edit recharts-to-png

    Usage

    Compatible with React ^16.8.0:

    useCurrentPng

    useCurrentPng is a React hook that returns a tuple. The first parameter is a promise that will return a string if the PNG is valid. The second parameter is an object with two properties: ref, which is required to be attached to the target Recharts component, and isLoading, which is optional and changes state from false to true while the PNG is being generated and downloaded.

    function MyApp(props) {
      // useCurrentPng usage (isLoading is optional)
      const [getPng, { ref, isLoading }] = useCurrentPng();
    
      // Can also pass in options for html2canvas
      // const [getPng, { ref }] = useCurrentPng({ backgroundColor: '#000' });
    
      const handleDownload = useCallback(async () => {
        const png = await getPng();
    
        // Verify that png is not undefined
        if (png) {
          // Download with FileSaver
          FileSaver.saveAs(png, 'myChart.png');
        }
      }, [getPng]);
    
      return (
        <>
          <ComposedChart data={props.data} ref={ref}>
            <XAxis dataKey="name" />
            <YAxis />
            <Tooltip />
            <Legend />
            <CartesianGrid stroke="#f5f5f5" />
            <Area type="monotone" dataKey="amt" fill="#8884d8" stroke="#8884d8" />
            <Bar dataKey="pv" barSize={20} fill="#413ea0" />
            <Line type="monotone" dataKey="uv" stroke="#ff7300" />
            <Brush dataKey="name" height={30} stroke="#8884d8" />
          </ComposedChart>
          <br/>
          <button onClick={handleDownload}>
            {isLoading ? 'Downloading...' : 'Download Chart'}
          </button>
        </>
      );

    useRechartToPng

    This function has been deprecated and is no longer recommended for use due to poor performance.

    function MyComponent() {
      // Attach ref to a Recharts component, and the png will be returned
      // Also accepts an optional argument for Html2Canvas options: useRechartToPng(options)
      const [png, ref] = useRechartToPng();
    
      const handleDownload = React.useCallback(async () => {
        FileSaver.saveAs(png, "myChart.png");
      }, [png]);
    
      return (
        <LineChart ref={ref} ... />
      )
    }

    Install

    npm i recharts-to-png

    DownloadsWeekly Downloads

    777

    Version

    1.1.1

    License

    MIT

    Unpacked Size

    15 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar