Getting Started with Blazor Charts Component in Blazor Web App
7 Jul 20268 minutes to read
This section briefly explains how to include Blazor Charts component in your Blazor Web App using Visual Studio, Visual Studio Code, and the .NET CLI.
Ready to streamline your Blazor development?
Discover the full potential of Blazor components with 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, CodeStudio and more. Explore AI Coding Assistants
Create a new Blazor Web App
Create a Blazor Web App using Visual Studio via Microsoft Templates or the Blazor Extension.
Run the following command to create a new Blazor Web App.
dotnet new blazor -o BlazorWebApp --interactivity Auto
cd BlazorWebApp
cd BlazorWebApp.ClientAlternatively, create a Blazor Web App using Visual Studio Code via Microsoft Templates, the Blazor Extension, or the C# Dev Kit extension.
Run the following command to create a new Blazor Web App.
dotnet new blazor -o BlazorWebApp --interactivity Auto
cd BlazorWebApp
cd BlazorWebApp.ClientNOTE
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 the required Blazor package
Install the Syncfusion.Blazor.Charts NuGet package. All Syncfusion Blazor packages are available on nuget.org. See the NuGet packages topic for details. If using the WebAssembly or Auto render modes in the Blazor Web App, install this package in the .Client project.
- Go to Tools → NuGet Package Manager → Manage NuGet Packages for Solution.
- Search the required NuGet package (
Syncfusion.Blazor.Charts) and install it.
Alternatively, you can install the same package using the Package Manager Console with the following command.
Install-Package Syncfusion.Blazor.Charts -Version 34.1.29Open the terminal and run the following command.
dotnet add package Syncfusion.Blazor.Charts -v 34.1.29Open the command prompt and run the following command.
dotnet add package Syncfusion.Blazor.Charts -v 34.1.29Add 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.- If the Interactive Render Mode is set to
WebAssemblyorAuto, add these namespaces in both the server and client project ~/_Imports.razor files.
@using Syncfusion.Blazor
@using Syncfusion.Blazor.ChartsRegister the Blazor service
Open the Program.cs file in Blazor Web App and register the Blazor service. If the Interactive Render Mode is set to WebAssembly or Auto, register the Blazor service in Program.cs files of both the server and client projects in your Blazor Web App.
....
using Syncfusion.Blazor;
....
builder.Services.AddSyncfusionBlazor();
....Add script resources
The script can be accessed from NuGet through Static Web Assets. Include the script references in the App.razor file.
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>Add Blazor Charts component
Open a Razor file located in the ~/Pages/*.razor (for example, Home.razor) and add the Blazor Charts component inside the razor file.
NOTE
If the interactivity location is set to
Per page/componentin the Web App, define a render mode at the top of the razor file. (For example,InteractiveServer,InteractiveWebAssemblyorInteractiveAuto). If the Interactivity is set toGlobalwithAutoorWebAssembly, the render mode is automatically configured in theApp.razorfile by default.
@rendermode InteractiveAuto
@* SfChart is the root container component for the chart *@
<SfChart>
</SfChart>Run the application
Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. The Blazor Charts component will render in your default web browser.
Open the terminal and navigate to the main project folder (for example, BlazorWebApp) and run the following command.
cd ..
cd BlazorWebApp
dotnet runOpen the command prompt and navigate to the main project folder (for example, BlazorWebApp) and run the following command.
cd ..
cd BlazorWebApp
dotnet run
Populate Blazor Charts with data
To bind data for the Blazor charts 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 }
};
}
NOTE