Getting Started with Blazor Sparkline Component
10 Feb 202315 minutes to read
This section briefly explains about how to include Blazor Sparkline component in your Blazor Server App and Blazor WebAssembly App using Visual Studio.
Prerequisites
Create a new Blazor App in Visual Studio
You can create Blazor Server App or Blazor WebAssembly App using Visual Studio in one of the following ways,
Install Syncfusion Blazor Sparkline NuGet in the App
Syncfusion Blazor components are available in nuget.org. To use Syncfusion Blazor components in the application, add reference to the corresponding NuGet. Refer to NuGet packages topic for available NuGet packages list with component details and Benefits of using individual NuGet packages.
To add Blazor Sparkline component in the app, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for Syncfusion.Blazor.Sparkline and then install it.
Register Syncfusion Blazor Service
Open ~/_Imports.razor file and import the Syncfusion.Blazor namespace.
@using Syncfusion.Blazor
Now, register the Syncfusion Blazor Service in the Blazor Server App or Blazor WebAssembly App. Here, Syncfusion Blazor Service is registered by setting IgnoreScriptIsolation property as true to load the scripts externally in the next steps.
NOTE
From 2022 Vol-1 (20.1) version, the default value of
IgnoreScriptIsolation
is changed totrue
. It is not necessary to set theIgnoreScriptIsolation
property to refer scripts externally, since the default value has already been changed to true, and this property is obsolete.
Blazor Server App
-
For .NET 6 and .NET 7 app, open the ~/Program.cs file and register the Syncfusion Blazor Service.
-
For .NET 5 and .NET 3.X app, open the ~/Startup.cs file and register the Syncfusion Blazor Service.
using Microsoft.AspNetCore.Components;
using Microsoft.AspNetCore.Components.Web;
using Syncfusion.Blazor;
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddServerSideBlazor();
builder.Services.AddSyncfusionBlazor();
var app = builder.Build();
....
using Syncfusion.Blazor;
namespace BlazorApplication
{
public class Startup
{
...
public void ConfigureServices(IServiceCollection services)
{
services.AddRazorPages();
services.AddServerSideBlazor();
services.AddSyncfusionBlazor();
}
...
}
}
Blazor WebAssembly App
Open ~/Program.cs file and register the Syncfusion Blazor Service in the client web app.
using Microsoft.AspNetCore.Components.Web;
using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
using Syncfusion.Blazor;
var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.RootComponents.Add<App>("#app");
builder.RootComponents.Add<HeadOutlet>("head::after");
builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri(builder.HostEnvironment.BaseAddress) });
builder.Services.AddSyncfusionBlazor();
await builder.Build().RunAsync();
....
using Syncfusion.Blazor;
namespace WebApplication1
{
public class Program
{
public static async Task Main(string[] args)
{
....
builder.Services.AddSyncfusionBlazor();
await builder.Build().RunAsync();
}
}
}
Add Style Sheet
Checkout the Blazor Themes topic to learn different ways (Static Web Assets, CDN and CRG) to refer themes in Blazor application, and to have the expected appearance for Syncfusion Blazor components. Here, the theme is referred using Static Web Assets. Refer to Enable static web assets usage topic to use static assets in your project.
To add theme to the app, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for Syncfusion.Blazor.Themes and then install it. Then, the theme style sheet from NuGet can be referred as follows,
NOTE
If you are using Syncfusion.Blazor single NuGet, you don’t have to refer Syncfusion.Blazor.Themes NuGet. Since style sheets already inside the assets of
Syncfusion.Blazor
NuGet.
Blazor Server App
-
For .NET 6 app, add the Syncfusion bootstrap5 theme in the
<head>
of the ~/Pages/_Layout.cshtml file. -
For .NET 3.X, .NET 5 and .NET 7 app, add the Syncfusion bootstrap5 theme in the
<head>
of the ~/Pages/_Host.cshtml file.
<head>
...
<link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
<!--Refer theme style sheet as below if you are using Syncfusion.Blazor Single NuGet-->
<!--<link href="_content/Syncfusion.Blazor/styles/bootstrap5.css" rel="stylesheet" />-->
</head>
<head>
...
<link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
<!--Refer theme style sheet as below if you are using Syncfusion.Blazor Single NuGet-->
<!--<link href="_content/Syncfusion.Blazor/styles/bootstrap5.css" rel="stylesheet" />-->
</head>
Blazor WebAssembly App
For Blazor WebAssembly App, Refer the theme style sheet from NuGet in the <head>
of wwwroot/index.html file in the client web app.
<head>
...
<link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
<!--Refer theme style sheet as below if you are using Syncfusion.Blazor Single NuGet-->
<!--<link href="_content/Syncfusion.Blazor/styles/bootstrap5.css" rel="stylesheet" />-->
</head>
Add Script Reference
Checkout Adding Script Reference topic to learn different ways to add script reference in Blazor Application. In this getting started walk-through, the required scripts are referred using Static Web Assets externally inside the <head>
as follows. Refer to Enable static web assets usage topic to use static assets in your project.
Blazor Server App
-
For .NET 6 app, Refer script in the
<head>
of the ~/Pages/_Layout.cshtml file. -
For .NET 3.X, .NET 5 and .NET 7 app, Refer script in the
<head>
of the ~/Pages/_Host.cshtml file.
<head>
....
<link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>
<!--Use below script reference if you are using Syncfusion.Blazor Single NuGet-->
<!--<script src="_content/Syncfusion.Blazor/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>-->
</head>
<head>
....
<link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>
<!--Use below script reference if you are using Syncfusion.Blazor Single NuGet-->
<!--<script src="_content/Syncfusion.Blazor/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>-->
</head>
Blazor WebAssembly App
For Blazor WebAssembly App, Refer script in the <head>
of the ~/index.html file.
<head>
....
<link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>
<!--Use below script reference if you are using Syncfusion.Blazor Single NuGet-->
<!--<script src="_content/Syncfusion.Blazor/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>-->
</head>
NOTE
Syncfusion recommends to reference scripts using Static Web Assets, CDN and CRG by disabling JavaScript isolation for better loading performance of the Blazor application.
Add Blazor Sparkline Component
- Open ~/_Imports.razor file or any other page under the
~/Pages
folder where the component is to be added and import the Syncfusion.Blazor.Charts namespace.
@using Syncfusion.Blazor
@using Syncfusion.Blazor.Charts
- Now, add the Syncfusion Sparkline component in razor file. Here, the Sparkline component is added in the ~/Pages/Index.razor file under the ~/Pages folder.
<SfSparkline>
</SfSparkline>
Populate Sparkline with Data
To bind data for the Sparkline component, assign a IEnumerable
object to the DataSource property. It can also be provided as an instance of the DataManager.
@code {
public class WeatherReport
{
public string Month { get; set; }
public double Celsius { get; set; }
};
public List<WeatherReport> ClimateData = new List<WeatherReport> {
new WeatherReport { Month= "Jan", Celsius= 34 },
new WeatherReport { Month= "Feb", Celsius= 36 },
new WeatherReport { Month= "Mar", Celsius= 32 },
new WeatherReport { Month= "Apr", Celsius= 35 },
new WeatherReport { Month= "May", Celsius= 40 },
new WeatherReport { Month= "Jun", Celsius= 38 },
new WeatherReport { Month= "Jul", Celsius= 33 },
new WeatherReport { Month= "Aug", Celsius= 37 },
new WeatherReport { Month= "Sep", Celsius= 34 },
new WeatherReport { Month= "Oct", Celsius= 31 },
new WeatherReport { Month= "Nov", Celsius= 30 },
new WeatherReport { Month= "Dec", Celsius= 29}
};
}
Now map the Month
and the Celsius
fields from the datasource to XName and YName properties for x-axis and y-axis in the Sparkline and then set the ClimateData
to DataSource property. Because the Month
field is a value-based category, the ValueType property is used to specify it.
<SfSparkline XName="Month"
YName="Celsius"
ValueType="SparklineValueType.Category"
TValue="WeatherReport"
DataSource="ClimateData"
Height="80px"
Width="150px">
</SfSparkline>
Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to run the application. Then, the Syncfusion Blazor Sparkline
component will be rendered in the default web browser.
Sparkline chart types
Change the Sparkline type using the Type property set to Line, Column, WinLoss, Pie or Area. Here, the Sparkline type is set to Area.
<SfSparkline XName="Month"
YName="Celsius"
ValueType="SparklineValueType.Category"
Type="SparklineType.Area"
TValue="WeatherReport"
DataSource="ClimateData"
Height="80px"
Width="150px">
</SfSparkline>
NOTE
Refer to code block to know about the property value of ClimateData.
Adding Data Label
Add the Data Labels to improve the readability of the Sparkline component. This can be achieved by setting the Visible property to true in the SparklineDataLabelSettings.
Available types are:
- Start
- End
- All
- High
- Low
- Negative
<SfSparkline DataSource="ClimateData"
TValue="WeatherReport"
XName="Month"
YName="Celsius"
ValueType="SparklineValueType.Category"
Height="80px"
Width="150px">
<SparklineDataLabelSettings Visible="new List<VisibleType> { VisibleType.Start, VisibleType.End }"></SparklineDataLabelSettings>
<SparklinePadding Left="10" Right="10"></SparklinePadding>
</SfSparkline>
NOTE
Refer to the code block to know about the property value of ClimateData.
Enable tooltip
When space constraints prevent from displaying information using Data Labels, the tooltip comes in handy. The tooltip can be enabled by setting the Visible property to true in the SparklineTooltipSettings.
<SfSparkline DataSource="ClimateData"
TValue="WeatherReport"
XName="Month"
YName="Celsius"
ValueType="SparklineValueType.Category"
Height="80px"
Width="150px">
<SparklineDataLabelSettings Visible="new List<VisibleType> { VisibleType.Start, VisibleType.End }"></SparklineDataLabelSettings>
<SparklinePadding Left="10" Right="10"></SparklinePadding>
<SparklineTooltipSettings TValue="WeatherReport" Visible="true"></SparklineTooltipSettings>
</SfSparkline>
NOTE
Refer to the code block to know about the property value of the ClimateData.
NOTE
See also
-
Getting Started with Syncfusion Blazor for Client-Side in .NET Core CLI
-
Getting Started with Syncfusion Blazor for Server-Side in Visual Studio
-
Getting Started with Syncfusion Blazor for Server-Side in .NET Core CLI
NOTE
You can also explore our Blazor Sparkline Chart example that shows you how to render and configure the sparkline chart.