Syncfusion.AspNetMvc.Sankey

Syncfusion ASP.NET MVC Sankey component

A flow diagram visualization component that displays flow and proportional relationships between values using node-link diagrams. Commonly used for energy flows, budget allocation, and resource tracking.

Using this package with an AI coding agent

Before generating Syncfusion code, ask your AI coding agent to run the Syncfusion setup using the following prompt:

Set up this project for Syncfusion before generating code. Fetch and follow the official instructions at https://ai.syncfusion.com, then report the detected platform, installed skill pack, MCP status, and any required licensing action.

The setup detects your project's platform and loads the appropriate Syncfusion skill pack. No Syncfusion account or MCP key is required to install or read Syncfusion agent skills.

Platform reference: https://ai.syncfusion.com/aspnet-mvc/llms.txt

Key features

• Flow Visualization: Visualizes directional flow of quantities between nodes
• Configurable Node Layout: Supports customization of node width, padding, and alignment
• Flexible Link Coloring: Provides gradient and solid link colorization
• Interactive Tooltips: Interactive tooltip on hover for link and node details
• Legend Support: Includes a built-in legend for identifying node groups
• Custom Labels: Supports custom node and link labels
• Export Capabilities: Export to PNG, JPEG, SVG, and PDF

Common setup

These setup steps are required only once for your application, regardless of which Syncfusion components you use.

1. Install NuGet package

Install-Package Syncfusion.AspNetMvc.Sankey

2. Add namespace reference

Edit Web.config under the Views folder and add the Syncfusion.EJ2 namespace:

<namespaces>
    <add namespace="Syncfusion.EJ2"/>
</namespaces>

3. Add stylesheet and script references

In your layout file (~/Views/Shared/_Layout.cshtml), add the following in the <head> section:

<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>@ViewBag.Title - Syncfusion Application</title>
    
    <!-- Syncfusion ASP.NET MVC controls styles -->
    <link rel="stylesheet" href="https://cdn.syncfusion.com/ej2/35.1.41/fluent2.css" />
    
    <!-- Syncfusion ASP.NET MVC controls scripts -->
    <script src="https://cdn.syncfusion.com/ej2/35.1.41/dist/ej2.min.js"></script>
</head>

4. Register script manager

At the end of the <body> tag in your layout file (~/Views/Shared/_Layout.cshtml):

<body>
    @RenderBody()
    
    <!-- Syncfusion ASP.NET MVC Script Manager -->
    @Html.EJS().ScriptManager()
</body>

Quick start

Step 1: Add the ASP.NET MVC Sankey control

Add the Syncfusion ASP.NET MVC Sankey control in the ~/Views/Home/Index.cshtml page:

@Html.EJS().Sankey("sankey-container")
    .Width("90%")
    .Height("420px")
    .Title("Sankey Chart")
    .Tooltip(tooltip => tooltip.Enable(true))
    .LegendSettings(legend => legend.Visible(true))
    .Nodes(ViewBag.SankeyNodes)
    .Links(ViewBag.SankeyLinks)
    .Render()

Step 2: Create controller ~/Controllers/HomeController.cs

public ActionResult Index()
{
    List<SankeyNode> nodes = new List<SankeyNode>
    {
        new SankeyNode { Id = "A" },
        new SankeyNode { Id = "B" },
        new SankeyNode { Id = "C" }
    };

    List<SankeyLink> links = new List<SankeyLink>
    {
        new SankeyLink { SourceId = "A", TargetId = "B", Value = 100 },
        new SankeyLink { SourceId = "B", TargetId = "C", Value = 80 }
    };

    ViewBag.SankeyNodes = nodes;
    ViewBag.SankeyLinks = links;

    return View();
}

Step 3: Run the application

Press Ctrl+F5 to run the application in your browser.

Documentation

• Getting started
• API reference
• Live demos

Support

• Submit a support ticket

• Community forums

• Feature requests

License

This is a commercial product and requires a paid license for possession or use. Review the Syncfusion EULA

• Purchase a license

• Start a free 30-day trial

About Syncfusion

Syncfusion provides 1800+ components and frameworks for web, mobile, and desktop development across multiple platforms:

Web: Blazor | ASP.NET Core | ASP.NET MVC | JavaScript | Angular | React | Vue

Mobile: Flutter | MAUI | UWP

Desktop: WinForms | WPF | WinUI

Learn more at www.syncfusion.com

[email protected] | Toll Free: 1-888-9-DOTNET