Syncfusion AI Assistant

How can I help you?

Getting Started with Blazor Chart Component in Blazor Web App

29 May 20268 minutes to read

This section briefly explains how to include Syncfusion® Blazor Chart component in your Blazor Web App using Visual Studio, Visual Studio Code, and the .NET CLI.

Ready to streamline your Syncfusion® Blazor development?
Discover the full potential of Syncfusion® Blazor components with Syncfusion® AI Coding Assistants. Effortlessly integrate, configure, and enhance your projects with intelligent, context-aware code suggestions, streamlined setups, and real-time insights—all seamlessly integrated into your preferred AI-powered IDEs like VS Code, Cursor, Syncfusion® CodeStudio and more. Explore Syncfusion® AI Coding Assistants

Prerequisites

Create a new Blazor Web App in Visual Studio

Create a Blazor Web App using Visual Studio via Microsoft Templates or the Syncfusion® Blazor Extension. For detailed instructions, refer to the Blazor Web App Getting Started documentation.

Prerequisites

Create a new Blazor Web App in Visual Studio Code

Create a Blazor Web App using Visual Studio Code via Microsoft Templates or the Syncfusion® Blazor Extension. For detailed instructions, refer to the Blazor Web App Getting Started documentation.

For example, in a Blazor Web App with the Auto interactive render mode, use the following commands in the integrated terminal (Ctrl+`).

dotnet new blazor -o BlazorWebApp -int Auto
cd BlazorWebApp

NOTE

If the application is configured with WebAssembly or Auto render modes, you may optionally navigate to the client project directory to manage client-specific dependencies. Once the required changes are completed, ensure that you navigate back to the root project directory.

cd BlazorWebApp.Client
cd ..

Prerequisites

Install the latest version of .NET SDK. If you previously installed the SDK, you can determine the installed version by executing the following command in a command prompt (Windows) or terminal (macOS) or command shell (Linux).

dotnet --version

Create a Blazor Web App using .NET CLI

Run the following command to create a new Blazor Web App in a command prompt (Windows) or terminal (macOS) or command shell (Linux). For detailed instructions, refer to the Blazor Web App Getting Started documentation.

For example, in a Blazor Web App with the Auto interactive render mode, use the following commands:

dotnet new blazor -o BlazorApp -int Auto
cd BlazorApp

This command creates a new Blazor Web App and places it in a new directory called BlazorApp inside your current location. See the Create a Blazor App and dotnet new CLI command topics for more details.

NOTE

If the application is configured with WebAssembly or Auto render modes, you may optionally navigate to the client project directory to manage client-specific dependencies. Once the required changes are completed, ensure that you navigate back to the root project directory.

cd BlazorWebApp.Client
cd ..

NOTE

Configure the appropriate Interactive render mode and Interactivity location while creating a Blazor Web App. For detailed information, refer to the interactive render mode documentation.

Install Syncfusion® Blazor packages

Install the Syncfusion.Blazor.Charts NuGet package in your project using the NuGet Package Manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), or the integrated terminal in Visual Studio Code (dotnet add package Syncfusion.Blazor.Charts –version 33.2.3), or the .NET CLI.

Alternatively, run the following command in the Package Manager Console to achieve the same.

Install-Package Syncfusion.Blazor.Charts -Version 33.2.3

If using the WebAssembly or Auto render modes in the Blazor Web App, install this package in the client project.

NOTE

All Syncfusion Blazor packages are available on nuget.org. See the NuGet packages topic for details.

Add import namespaces

After the package is installed, open the ~/_Imports.razor file from the client project and import the Syncfusion.Blazor and Syncfusion.Blazor.Charts namespaces.

NOTE

The ~/ notation represents the root directory of your project. This file is typically located in your project’s root folder.

@using Syncfusion.Blazor
@using Syncfusion.Blazor.Charts

Register Syncfusion® Blazor service

Register the Syncfusion® Blazor service in the Program.cs file of your Blazor Web App. This step enables the Syncfusion components to work in your application.

....
using Syncfusion.Blazor;
....
builder.Services.AddSyncfusionBlazor();
....

NOTE

If the Interactive Render Mode is set to WebAssembly or Auto, register the Syncfusion® Blazor service in Program.cs files of both the server and client projects in your Blazor Web App.

Add script resources

The Syncfusion JavaScript library needs to be included in your application. The script can be accessed from NuGet through Static Web Assets. Include the script reference in the ~/Components/App.razor file (this is the root layout file of your application).

<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>

NOTE

Check out the Adding Script Reference topic to learn different approaches for adding script references in your Blazor application.

Add Syncfusion® Blazor Chart component

Add the Syncfusion® Blazor Chart component in the ~/Components/Pages/Home.razor file. If the interactivity location is set to Per page/component in the Web App, define a render mode at the top of the ~Pages/Home.razor file. (For example, InteractiveServer, InteractiveWebAssembly or InteractiveAuto).

NOTE

If the Interactivity Location is set to Global with Auto or WebAssembly, the render mode is automatically configured in the App.razor file by default.

@* desired render mode defined here *@
@rendermode InteractiveAuto
<!-- SfChart is the root container component for the chart -->
<SfChart>

</SfChart>
  • Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This will render the Syncfusion® Blazor Chart component in the default web browser.
Blazor Chart Component

Populate Blazor chart with data

To bind data for the chart component, you can assign an IEnumerable object to the DataSource property. It can also be provided as an instance of the DataManager.

Map the data fields Month and SalesValue to the series XName and YName properties, then set the data to the DataSource property, and the chart type to Column because we will be viewing the data in a column chart.

<SfChart>
    <!-- ChartPrimaryXAxis configures the X-axis properties such as value type and labels -->
    <ChartPrimaryXAxis ValueType="Syncfusion.Blazor.Charts.ValueType.Category"></ChartPrimaryXAxis>
    <!-- ChartSeriesCollection contains one or more data series to be plotted on the chart -->
    <ChartSeriesCollection>
        <!-- ChartSeries defines a data series with its data source and axis mappings -->
        <ChartSeries DataSource="@Sales" XName="Month" YName="SalesValue" Type="ChartSeriesType.Column">
        </ChartSeries>
    </ChartSeriesCollection>
</SfChart>

@code {
    public class SalesInfo
    {
        public string Month { get; set;}
        public double SalesValue { get; set;}
    }

    public List<SalesInfo> Sales = new List<SalesInfo>
    {
        new SalesInfo { Month = "Jan", SalesValue = 35 },
        new SalesInfo { Month = "Feb", SalesValue = 28 },
        new SalesInfo { Month = "Mar", SalesValue = 34 },
        new SalesInfo { Month = "Apr", SalesValue = 32 },
        new SalesInfo { Month = "May", SalesValue = 40 },
        new SalesInfo { Month = "Jun", SalesValue = 32 },
        new SalesInfo { Month = "Jul", SalesValue = 35 }
    };
}
Blazor Column Chart

NOTE

View Sample in GitHub.

See also

  1. Getting Started with Syncfusion® Blazor Web Assembly App in Visual Studio or .NET CLI
  2. Getting Started with Syncfusion® Blazor Web App in Visual Studio or .NET CLI