HelpBot Assistant

How can I help you?

Getting started with React Sankey Chart component

19 Mar 202624 minutes to read

This section describes how to integrate the Syncfusion React Sankey Chart component into a new React application. You’ll learn about dependencies, installation steps, and how to create your first Sankey Chart visualization.

Prerequisites

Node.js version 14 or later
Basic knowledge of React and TypeScript (recommended)
A code editor like Visual Studio Code

Dependencies

Below is the list of minimum dependencies required to use the Sankey Chart component.


|-- @syncfusion/ej2-react-charts
    |-- @syncfusion/ej2-base
    |-- @syncfusion/ej2-data
    |-- @syncfusion/ej2-charts
    |-- @syncfusion/ej2-react-base
    |-- @syncfusion/ej2-pdf-export
    |-- @syncfusion/ej2-file-utils
    |-- @syncfusion/ej2-compression
    |-- @syncfusion/ej2-svg-base

Installation and Configuration

Setting Up the React Development Environment

To easily set up a React application, use the Vite CLI (npm create vite), which provides:

Faster development environment with instant hot module replacement (HMR)
Smaller bundle sizes
Optimized production builds
Better performance compared to traditional tools like create-react-app

For detailed steps, refer to the Vite installation instructions. Vite sets up your environment using JavaScript and optimizes your application for production.

Note: To create a React application using create-react-app instead, refer to this documentation for more details.

To create a new React application, run the following command.

npm create vite@latest my-app

This command will prompt you for a few settings for the new project, such as selecting a framework and a variant.

Initial_setup

To set up a React application in TypeScript environment, run the following command.

npm create vite@latest my-app -- --template react-ts
cd my-app
npm run dev

To set up a React application in JavaScript environment, run the following command.

npm create vite@latest my-app -- --template react
cd my-app
npm run dev

Install Syncfusion^® Sankey Chart Package

All the available Essential^® JS 2 packages are published in the npmjs.com public registry.

To install the Sankey Chart package, run the following command:

npm install @syncfusion/ej2-react-charts --save

The --save flag will instruct NPM to include the Sankey Chart package inside the dependencies section of the package.json file.

Add Sankey Chart to the project

Add the Sankey Chart component to src/App.tsx using the following code.

app.jsx
app.tsx
import * as React from "react";
import * as ReactDOM from "react-dom";
import {
  SankeyComponent, Inject, SankeyTooltip, SankeyLegend,
  SankeyExport,
  SankeyNodeDirective,
  SankeyNodesCollectionDirective,
  SankeyLinkDirective,
  SankeyLinksCollectionDirective
} from '@syncfusion/ej2-react-charts';

function App() {
  return (
    <div className="control-pane">
      <div className="control-section" id="sankey-container">
        <SankeyComponent
          width="90%"
          height="420px"
          title="Sankey Chart"
        >
          <SankeyNodesCollectionDirective>
            <SankeyNodeDirective id="A" />
            <SankeyNodeDirective id="B" />
            <SankeyNodeDirective id="C" />
          </SankeyNodesCollectionDirective>
          <SankeyLinksCollectionDirective>
            <SankeyLinkDirective sourceId="A" targetId="B" value={100} />
            <SankeyLinkDirective sourceId="B" targetId="C" value={80} />
          </SankeyLinksCollectionDirective>
          <Inject services={[SankeyTooltip, SankeyLegend, SankeyExport]} />
        </SankeyComponent>
      </div>
    </div>
  );
}

export default App;
ReactDOM.render(<App />, document.getElementById('sankey'));
import * as React from "react";
import * as ReactDOM from "react-dom";
import {
  SankeyComponent, Inject, SankeyTooltip, SankeyLegend,
  SankeyExport,
  SankeyNodeDirective,
  SankeyNodesCollectionDirective,
  SankeyLinkDirective,
  SankeyLinksCollectionDirective
} from '@syncfusion/ej2-react-charts';

function App() {
  return (
    <div className="control-pane">
      <div className="control-section" id="sankey-container">
        <SankeyComponent
          width="90%"
          height="420px"
          title="Sankey Chart"
        >
          <SankeyNodesCollectionDirective>
            <SankeyNodeDirective id="A" />
            <SankeyNodeDirective id="B" />
            <SankeyNodeDirective id="C" />
          </SankeyNodesCollectionDirective>
          <SankeyLinksCollectionDirective>
            <SankeyLinkDirective sourceId="A" targetId="B" value={100} />
            <SankeyLinkDirective sourceId="B" targetId="C" value={80} />
          </SankeyLinksCollectionDirective>
          <Inject services={[SankeyTooltip, SankeyLegend, SankeyExport]} />
        </SankeyComponent>
      </div>
    </div>
  );
}

export default App;
ReactDOM.render(<App />, document.getElementById('sankey'));

Run the Development Server

Now run the npm run dev command in the console to start the development server. This command compiles your code and serves the application locally in your browser:

npm run dev

Add data to Sankey Chart

Now you can add data to the Sankey Chart component by defining nodes and links. Nodes represent the categories, and links represent the flow between them.

app.jsx
app.tsx
import * as React from "react";
import * as ReactDOM from "react-dom";
import {
  SankeyComponent,
  Inject,
  SankeyTooltip,
  SankeyExport,
  SankeyNodeDirective,
  SankeyNodesCollectionDirective,
  SankeyLinkDirective,
  SankeyLinksCollectionDirective
} from '@syncfusion/ej2-react-charts';

function App() {
  return (
    <div className="control-pane">
      <div className="control-section" id="sankey-container">
        <SankeyComponent
          width="90%"
          height="420px"
          title="Energy Flow Diagram"
        >
          <SankeyNodesCollectionDirective>
            <SankeyNodeDirective id="Energy Input" label={{ text: 'Energy Input' }} />
            <SankeyNodeDirective id="Generation" label={{ text: 'Generation' }} />
            <SankeyNodeDirective id="Distribution" label={{ text: 'Distribution' }} />
            <SankeyNodeDirective id="Consumption" label={{ text: 'Consumption' }} />
          </SankeyNodesCollectionDirective>
          <SankeyLinksCollectionDirective>
            <SankeyLinkDirective sourceId="Energy Input" targetId="Generation" value={500} />
            <SankeyLinkDirective sourceId="Generation" targetId="Distribution" value={450} />
            <SankeyLinkDirective sourceId="Distribution" targetId="Consumption" value={400} />
          </SankeyLinksCollectionDirective>
          <Inject services={[SankeyTooltip, SankeyLegend, SankeyExport]} />
        </SankeyComponent>
      </div>
    </div>
  );
}

export default App;
ReactDOM.render(<App />, document.getElementById('sankey'));
import * as React from "react";
import * as ReactDOM from "react-dom";
import {
  SankeyComponent, Inject, SankeyTooltip, SankeyLegend, SankeyExport,
  SankeyNodeDirective,
  SankeyNodesCollectionDirective,
  SankeyLinkDirective,
  SankeyLinksCollectionDirective
} from '@syncfusion/ej2-react-charts';

function App() {
  return (
    <div className="control-pane">
      <div className="control-section" id="sankey-container">
        <SankeyComponent
          width="90%"
          height="420px"
          title="Energy Flow Diagram"
        >
          <SankeyNodesCollectionDirective>
            <SankeyNodeDirective id="Energy Input" label={{ text: 'Energy Input' }} />
            <SankeyNodeDirective id="Generation" label={{ text: 'Generation' }} />
            <SankeyNodeDirective id="Distribution" label={{ text: 'Distribution' }} />
            <SankeyNodeDirective id="Consumption" label={{ text: 'Consumption' }} />
          </SankeyNodesCollectionDirective>
          <SankeyLinksCollectionDirective>
            <SankeyLinkDirective sourceId="Energy Input" targetId="Generation" value={500} />
            <SankeyLinkDirective sourceId="Generation" targetId="Distribution" value={450} />
            <SankeyLinkDirective sourceId="Distribution" targetId="Consumption" value={400} />
          </SankeyLinksCollectionDirective>
          <Inject services={[SankeyTooltip, SankeyLegend, SankeyExport]} />
        </SankeyComponent>
      </div>
    </div>
  );
}

export default App;
ReactDOM.render(<App />, document.getElementById('sankey'));

Module injection

Sankey Chart component provides support for tooltip and legend interactions. To enable these features, you need to inject the required modules into the component.

SankeyTooltip - Inject this module to enable tooltip feature.
SankeyLegend - Inject this module to enable legend feature.

Import the above-mentioned modules from the chart package and inject them into the component as follows.

app.jsx
app.tsx
import * as React from "react";
import * as ReactDOM from "react-dom";
import {
  SankeyComponent, Inject, SankeyTooltip, SankeyLegend, SankeyExport,
  SankeyNodeDirective,
  SankeyNodesCollectionDirective,
  SankeyLinkDirective,
  SankeyLinksCollectionDirective
} from '@syncfusion/ej2-react-charts';
import { Browser } from '@syncfusion/ej2-base';

function App() {
  const onLoaded = () => {
    const element = document.getElementById('sankey-container');
    if (element) element.setAttribute('title', '');
  };

  return (
    <div className="control-pane">
      <div className="control-section" id="sankey-container">
        <SankeyComponent
          width="90%"
          height={Browser.isDevice ? '600px' : '450px'}
          title="California Energy Consumption in 2023"
          subTitle="Source: Lawrence Livermore National Laboratory"
          linkStyle={{ opacity: 0.6, curvature: 0.55, colorType: 'Source' }}
          labelSettings={{ visible: Browser.isDevice ? false : true }}
          tooltip={{ enable: true }}
          legendSettings={{ visible: true, position: 'Bottom', itemPadding: 8 }}
          loaded={onLoaded}
        >
          <SankeyNodesCollectionDirective>
            <SankeyNodeDirective id="Electricity Generation" offset={-120} />
            <SankeyNodeDirective id="Residential" offset={38} />
            <SankeyNodeDirective id="Commercial" offset={36} />
            <SankeyNodeDirective id="Industrial" offset={34} />
            <SankeyNodeDirective id="Transportation" offset={32} />
            <SankeyNodeDirective id="Rejected Energy" offset={-40} />
            <SankeyNodeDirective id="Energy Services" />
            <SankeyNodeDirective id="Solar" />
            <SankeyNodeDirective id="Nuclear" />
            <SankeyNodeDirective id="Wind" />
            <SankeyNodeDirective id="Geothermal" />
            <SankeyNodeDirective id="Natural Gas" />
            <SankeyNodeDirective id="Coal" />
            <SankeyNodeDirective id="Biomass" />
            <SankeyNodeDirective id="Petroleum" offset={-10} />
          </SankeyNodesCollectionDirective>
          <SankeyLinksCollectionDirective>
            <SankeyLinkDirective sourceId="Solar" targetId="Electricity Generation" value={454} />
            <SankeyLinkDirective sourceId="Nuclear" targetId="Electricity Generation" value={185} />
            <SankeyLinkDirective sourceId="Wind" targetId="Electricity Generation" value={47.8} />
            <SankeyLinkDirective sourceId="Geothermal" targetId="Electricity Generation" value={40} />
            <SankeyLinkDirective sourceId="Natural Gas" targetId="Electricity Generation" value={800} />
            <SankeyLinkDirective sourceId="Coal" targetId="Electricity Generation" value={28.7} />
            <SankeyLinkDirective sourceId="Biomass" targetId="Electricity Generation" value={50} />
            <SankeyLinkDirective sourceId="Electricity Generation" targetId="Residential" value={182} />
            <SankeyLinkDirective sourceId="Natural Gas" targetId="Residential" value={400} />
            <SankeyLinkDirective sourceId="Petroleum" targetId="Residential" value={50} />
            <SankeyLinkDirective sourceId="Electricity Generation" targetId="Commercial" value={351} />
            <SankeyLinkDirective sourceId="Natural Gas" targetId="Commercial" value={300} />
            <SankeyLinkDirective sourceId="Electricity Generation" targetId="Industrial" value={641} />
            <SankeyLinkDirective sourceId="Natural Gas" targetId="Industrial" value={786} />
            <SankeyLinkDirective sourceId="Biomass" targetId="Industrial" value={563} />
            <SankeyLinkDirective sourceId="Petroleum" targetId="Industrial" value={300} />
            <SankeyLinkDirective sourceId="Electricity Generation" targetId="Transportation" value={20} />
            <SankeyLinkDirective sourceId="Natural Gas" targetId="Transportation" value={51} />
            <SankeyLinkDirective sourceId="Biomass" targetId="Transportation" value={71} />
            <SankeyLinkDirective sourceId="Petroleum" targetId="Transportation" value={2486} />
            <SankeyLinkDirective sourceId="Residential" targetId="Rejected Energy" value={432} />
            <SankeyLinkDirective sourceId="Commercial" targetId="Rejected Energy" value={351} />
            <SankeyLinkDirective sourceId="Industrial" targetId="Rejected Energy" value={972} />
            <SankeyLinkDirective sourceId="Transportation" targetId="Rejected Energy" value={1920} />
            <SankeyLinkDirective sourceId="Residential" targetId="Energy Services" value={200} />
            <SankeyLinkDirective sourceId="Commercial" targetId="Energy Services" value={300} />
            <SankeyLinkDirective sourceId="Industrial" targetId="Energy Services" value={755} />
            <SankeyLinkDirective sourceId="Transportation" targetId="Energy Services" value={637} />
          </SankeyLinksCollectionDirective>
          <Inject services={[SankeyTooltip, SankeyLegend, SankeyExport]} />
        </SankeyComponent>
      </div>
    </div>
  );
}

export default App;
ReactDOM.render(<App />, document.getElementById('sankey'));
import * as React from "react";
import * as ReactDOM from "react-dom";
import {
    SankeyComponent, Inject, SankeyTooltip, SankeyLegend, SankeyExport,
    SankeyNodeDirective,
    SankeyNodesCollectionDirective,
    SankeyLinkDirective,
    SankeyLinksCollectionDirective
} from '@syncfusion/ej2-react-charts';
import { Browser } from '@syncfusion/ej2-base';

function App() {
    const onLoaded = () => {
        const element = document.getElementById('sankey-container');
        if (element) element.setAttribute('title', '');
    };

    return (
        <div className="control-pane">
            <div className="control-section">
                <SankeyComponent
                    id="sankey-container"
                    width="90%"
                    height={Browser.isDevice ? '600px' : '450px'}
                    title="California Energy Consumption in 2023"
                    subTitle="Source: Lawrence Livermore National Laboratory"
                    linkStyle={{ opacity: 0.6, curvature: 0.55, colorType: 'Source' }}
                    labelSettings={{ visible: Browser.isDevice ? false : true }}
                    tooltip={{ enable: true }}
                    legendSettings={{ visible: true, position: 'Bottom', itemPadding: 8 }}
                    loaded={onLoaded}
                >
                    <SankeyNodesCollectionDirective>
                        <SankeyNodeDirective id="Electricity Generation" offset={-120} />
                        <SankeyNodeDirective id="Residential" offset={38} />
                        <SankeyNodeDirective id="Commercial" offset={36} />
                        <SankeyNodeDirective id="Industrial" offset={34} />
                        <SankeyNodeDirective id="Transportation" offset={32} />
                        <SankeyNodeDirective id="Rejected Energy" offset={-40} />
                        <SankeyNodeDirective id="Energy Services" />
                        <SankeyNodeDirective id="Solar" />
                        <SankeyNodeDirective id="Nuclear" />
                        <SankeyNodeDirective id="Wind" />
                        <SankeyNodeDirective id="Geothermal" />
                        <SankeyNodeDirective id="Natural Gas" />
                        <SankeyNodeDirective id="Coal" />
                        <SankeyNodeDirective id="Biomass" />
                        <SankeyNodeDirective id="Petroleum" offset={-10} />
                    </SankeyNodesCollectionDirective>
                    <SankeyLinksCollectionDirective>
                        <SankeyLinkDirective sourceId="Solar" targetId="Electricity Generation" value={454} />
                        <SankeyLinkDirective sourceId="Nuclear" targetId="Electricity Generation" value={185} />
                        <SankeyLinkDirective sourceId="Wind" targetId="Electricity Generation" value={47.8} />
                        <SankeyLinkDirective sourceId="Geothermal" targetId="Electricity Generation" value={40} />
                        <SankeyLinkDirective sourceId="Natural Gas" targetId="Electricity Generation" value={800} />
                        <SankeyLinkDirective sourceId="Coal" targetId="Electricity Generation" value={28.7} />
                        <SankeyLinkDirective sourceId="Biomass" targetId="Electricity Generation" value={50} />
                        <SankeyLinkDirective sourceId="Electricity Generation" targetId="Residential" value={182} />
                        <SankeyLinkDirective sourceId="Natural Gas" targetId="Residential" value={400} />
                        <SankeyLinkDirective sourceId="Petroleum" targetId="Residential" value={50} />
                        <SankeyLinkDirective sourceId="Electricity Generation" targetId="Commercial" value={351} />
                        <SankeyLinkDirective sourceId="Natural Gas" targetId="Commercial" value={300} />
                        <SankeyLinkDirective sourceId="Electricity Generation" targetId="Industrial" value={641} />
                        <SankeyLinkDirective sourceId="Natural Gas" targetId="Industrial" value={786} />
                        <SankeyLinkDirective sourceId="Biomass" targetId="Industrial" value={563} />
                        <SankeyLinkDirective sourceId="Petroleum" targetId="Industrial" value={300} />
                        <SankeyLinkDirective sourceId="Electricity Generation" targetId="Transportation" value={20} />
                        <SankeyLinkDirective sourceId="Natural Gas" targetId="Transportation" value={51} />
                        <SankeyLinkDirective sourceId="Biomass" targetId="Transportation" value={71} />
                        <SankeyLinkDirective sourceId="Petroleum" targetId="Transportation" value={2486} />
                        <SankeyLinkDirective sourceId="Residential" targetId="Rejected Energy" value={432} />
                        <SankeyLinkDirective sourceId="Commercial" targetId="Rejected Energy" value={351} />
                        <SankeyLinkDirective sourceId="Industrial" targetId="Rejected Energy" value={972} />
                        <SankeyLinkDirective sourceId="Transportation" targetId="Rejected Energy" value={1920} />
                        <SankeyLinkDirective sourceId="Residential" targetId="Energy Services" value={200} />
                        <SankeyLinkDirective sourceId="Commercial" targetId="Energy Services" value={300} />
                        <SankeyLinkDirective sourceId="Industrial" targetId="Energy Services" value={755} />
                        <SankeyLinkDirective sourceId="Transportation" targetId="Energy Services" value={637} />
                    </SankeyLinksCollectionDirective>
                    <Inject services={[SankeyTooltip, SankeyLegend, SankeyExport]} />
                </SankeyComponent>
            </div>
        </div>
    );
}

export default App;
ReactDOM.render(<App />, document.getElementById('sankey'));

Search docs

Ask HelpBot

Search docs

Ask HelpBot

How can I help you?

Getting started with React Sankey Chart component

Prerequisites

Dependencies

Installation and Configuration

Setting Up the React Development Environment

Install Syncfusion^® Sankey Chart Package

Add Sankey Chart to the project

Run the Development Server

Add data to Sankey Chart

Module injection

How can I help you?

Getting started with React Sankey Chart component

Prerequisites

Dependencies

Installation and Configuration

Setting Up the React Development Environment

Install Syncfusion® Sankey Chart Package

Add Sankey Chart to the project

Run the Development Server

Add data to Sankey Chart

Module injection

Install Syncfusion^® Sankey Chart Package