| layout | post |
|---|---|
| title | Getting Stared | Blazor Chart Component | Syncfusion |
| description | Checkout and learn about getting started with Blazor Charts component in Blazor Server App using Visual Studio and more. |
| platform | Blazor |
| control | Chart |
| documentation | ug |
This section briefly explains about how to include Syncfusion® Blazor Charts component in your Blazor Server 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
{% tabcontents %}
{% tabcontent Visual Studio %}
Create a Blazor Server App by using the Blazor Web App template in Visual Studio via Microsoft Templates or the Syncfusion® Blazor Extension. For detailed instructions, refer to the Blazor Server App Getting Started documentation.
{% endtabcontent %}
{% tabcontent Visual Studio Code %}
Create a Blazor Server App using Visual Studio Code via Microsoft Templates or the Syncfusion® Blazor Extension. For detailed instructions, refer to the Blazor Server App Getting Started documentation.
Alternatively, create a Server application by using the following command in the integrated terminal (Ctrl+`).
{% tabs %}
{% highlight c# tabtitle="Blazor Server App" %}
dotnet new blazor -o BlazorApp -int Server cd BlazorApp
{% endhighlight %}
{% endtabs %}
{% endtabcontent %}
{% tabcontent .NET CLI %}
Install the latest version of .NET SDK. If the .NET SDK is already installed, determine the installed version by running the following command in a command prompt (Windows), terminal (macOS), or command shell (Linux).
{% tabs %} {% highlight c# tabtitle=".NET CLI" %}
dotnet --version
{% endhighlight %} {% endtabs %}
Run the following command to create a new Blazor Server App in a command prompt (Windows) or terminal (macOS) or command shell (Linux). For detailed instructions, refer to the Blazor Server App Getting Started documentation.
{% tabs %} {% highlight c# tabtitle=".NET CLI" %}
dotnet new blazor -o BlazorApp -int Server cd BlazorApp
{% endhighlight %} {% endtabs %}
{% endtabcontent %}
{% endtabcontents %}
N> Configure the appropriate Interactive render mode and Interactivity location while creating a Blazor Server App. For detailed information, refer to the interactive render mode documentation.
Install 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), or the .NET CLI.
Alternatively, run the following command in the Package Manager Console to achieve the same.
{% tabs %} {% highlight C# tabtitle="Package Manager" %}
Install-Package Syncfusion.Blazor.Charts -Version {{ site.releaseversion }}
{% endhighlight %} {% endtabs %}
N> All Syncfusion Blazor packages are available on nuget.org. See the NuGet packages topic for details.
After the package is installed, open the ~/_Imports.razor file and import the Syncfusion.Blazor and Syncfusion.Blazor.Charts namespaces.
{% tabs %} {% highlight razor tabtitle="~/_Imports.razor" %}
@using Syncfusion.Blazor @using Syncfusion.Blazor.Charts
{% endhighlight %} {% endtabs %}
Register the Syncfusion® Blazor service in the Program.cs file of your Blazor Server App.
{% tabs %} {% highlight C# tabtitle="Program.cs" %}
.... using Syncfusion.Blazor; .... builder.Services.AddSyncfusionBlazor(); ....
{% endhighlight %} {% endtabs %}
The script can be accessed from NuGet through Static Web Assets. Include script reference in the App.razor file.
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>N> Check out the Adding Script Reference topic to learn different approaches for adding script references in the Blazor application.
Add the Syncfusion® Blazor Chart component in the ~/Components/Pages/Home.razor file. If the interactivity location is set to Per page/component, define a render mode at the top of the ~Pages/Home.razor file.
N> If the Interactivity Location is set to Global, the render mode is automatically configured in the App.razor file by default.
{% tabs %} {% highlight razor %}
@* desired render mode define here *@ @rendermode InteractiveServer
{% endhighlight %} {% endtabs %}
{% tabs %} {% highlight razor tabtitle="Home.razor" %}
{% endhighlight %} {% endtabs %}
- Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This will render the Syncfusion® Blazor Chart component in the default web browser.
{% previewsample "https://blazorplayground.syncfusion.com/embed/rZLzNsLepwXKBvNw?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor Chart Component" %}
To bind data for the chart component, you can assign a IEnumerable object to the DataSource property. It can also be provided as an instance of the DataManager.
{% tabs %} {% highlight razor tabtitle="Home.razor" %}
public class SalesInfo { public string Month { get; set; } public double SalesValue { get; set; } }
public List Sales = new List { 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 } };
{% endhighlight %} {% endtabs %}
Now, map the data fields Month and Sales 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.
{% tabs %} {% highlight razor tabtitle="Home.razor" %}
@using Syncfusion.Blazor.Charts
@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 }
};
}
{% endhighlight %} {% endtabs %}
{% previewsample "https://blazorplayground.syncfusion.com/embed/rtBTNiLezckHqsGf?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor Column Chart" %}
Using the Title property, you can add a title to the chart and the axes to provide the user with quick information about the data plotted in the chart.
{% tabs %} {% highlight razor tabtitle="Home.razor" %}
{% endhighlight %} {% endtabs %}
{% previewsample "https://blazorplayground.syncfusion.com/embed/VNBJjihozcpDsXHf?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor Column Chart with Title" %}
You can add data labels to improve the readability of the chart. This can be achieved by setting the Visible property to true in the ChartDataLabel.
{% tabs %} {% highlight razor tabtitle="Home.razor" %}
{% endhighlight %} {% endtabs %}
{% previewsample "https://blazorplayground.syncfusion.com/embed/hDVpjMhIzmJRkHwA?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor Column Chart with DataLabel" %}
When space constraints prevent you from displaying information using data labels, the tooltip comes in handy. The tooltip can be enabled by setting the Enable property in ChartTooltipSettings to true.
{% tabs %} {% highlight razor tabtitle="Home.razor" %}
{% endhighlight %} {% endtabs %}
{% previewsample "https://blazorplayground.syncfusion.com/embed/rjVTNChepGIwhetf?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor Column Chart with Tooltip" %}
You can use legend for the chart by setting the Visible property to true in ChartLegendSettings. The legend name can be changed by using the Name property in the series.
{% tabs %} {% highlight razor tabtitle="Home.razor" %}
{% endhighlight %} {% endtabs %}
{% previewsample "https://blazorplayground.syncfusion.com/embed/VZrTDCLIpQHyGNEq?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor Column Chart with Legend" %}