Skip to content

getting-started-with-web-app.md

Latest commit

 

History

History
259 lines (163 loc) · 12.9 KB

getting-started-with-web-app.md

File metadata and controls

259 lines (163 loc) · 12.9 KB
layout post
title Getting Started with Syncfusion BulletChart in Blazor Web App
description Checkout and learn about the documentation for getting started with Blazor Bullet Chart Component in Blazor Web App.
platform Blazor
component Bullet Chart
documentation ug

Getting Started with Blazor BulletChart in Blazor Web App

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

{% tabcontents %}

{% tabcontent Visual Studio %}

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.

{% endtabcontent %}

{% tabcontent Visual Studio Code %}

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 command in the integrated terminal (Ctrl+`).

{% tabs %} {% highlight c# tabtitle="Blazor Web App" %}

dotnet new blazor -o BlazorWebApp -int Auto cd BlazorWebApp cd BlazorWebApp.Client

{% endhighlight %} {% endtabs %}

{% endtabcontent %}

{% tabcontent .NET CLI %}

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).

{% tabs %} {% highlight c# tabtitle=".NET CLI" %}

dotnet --version

{% endhighlight %} {% endtabs %}

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:

{% tabs %} {% highlight c# tabtitle="Blazor Web App" %}

dotnet new blazor -o BlazorWebApp -int Auto cd BlazorWebApp cd BlazorWebApp.Client

{% endhighlight %} {% endtabs %}

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

{% endtabcontent %}

{% endtabcontents %}

N> 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 BulletChart NuGet in the App

Install Syncfusion.Blazor.BulletChart 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 commands in the Package Manager Console to achieve the same.

{% tabs %} {% highlight C# tabtitle="Package Manager" %}

Install-Package Syncfusion.Blazor.BulletChart -Version {{ site.releaseversion }}

{% endhighlight %} {% endtabs %}

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

N> 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 in the client project and import the Syncfusion.Blazor and Syncfusion.Blazor.Charts namespaces.

{% tabs %} {% highlight C# tabtitle="~/_Imports.razor" %}

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

{% endhighlight %} {% endtabs %}

Register Syncfusion® Blazor service

Register the Syncfusion® Blazor service in the Program.cs file of your Blazor Web App.

{% tabs %} {% highlight c# tabtitle="Program.cs" %}

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

{% endhighlight %} {% endtabs %}

N> 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 script can be accessed from NuGet through Static Web Assets. Include the script reference in the ~/Components/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 Syncfusion® Blazor Bullet Chart component

Add the Syncfusion® Blazor Bullet Chart component in the ~/Components/Pages/*.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/*.razor file. (For example, InteractiveServer, InteractiveWebAssembly or InteractiveAuto).

N> 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.

{% tabs %} {% highlight razor %}

@* desired render mode define here *@ @rendermode InteractiveAuto

{% endhighlight %} {% endtabs %}

{% tabs %} {% highlight razor tabtitle="Home.razor" %}

@using Syncfusion.Blazor.Charts

@code{ public class ChartData { public double FieldValue { get; set; } public double TargetValue { get; set; } } public List BulletChartData = new List { new ChartData { FieldValue = 270, TargetValue = 250 } }; }

{% endhighlight %} {% endtabs %}

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

{% previewsample "https://blazorplayground.syncfusion.com/embed/hNLJZMByKuOOgQjA?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor Bullet Chart Component" %}

N> View Sample in GitHub.

Adding title

Add a title by using the Title property in the Bullet Chart to provide quick information to the user about the data plotted in the component.

{% tabs %} {% highlight razor tabtitle="Home.razor" %}

{% endhighlight %} {% endtabs %}

{% previewsample "https://blazorplayground.syncfusion.com/embed/VZhpXWByfNMLYFQO?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor Bullet Chart with Title" %}

Adding ranges

Add ranges by using the BulletChartRangeCollection to measure the qualitative state by observing the distance between each range.

{% tabs %} {% highlight razor tabtitle="Home.razor" %}

{% endhighlight %} {% endtabs %}

{% previewsample "https://blazorplayground.syncfusion.com/embed/rXrJXMhezDHBfdQU?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Adding Range in Blazor Bullet Chart" %}

Adding tooltip

Use the tooltip to show the measured values by setting the Enable property to true in the BulletChartTooltip.

{% tabs %} {% highlight razor tabtitle="Home.razor" %}

{% endhighlight %} {% endtabs %}

{% previewsample "https://blazorplayground.syncfusion.com/embed/VNBzDWVITXPjsQbH?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor Bullet Chart displays ToolTip" %}

N> You can also explore our Blazor Bullet Chart example that shows you how to render and configure the bullet chart.

See also

  1. Getting Started with Syncfusion® Blazor for client-side in .NET Core CLI
  2. Getting Started with Syncfusion® Blazor for client-side in Visual Studio
  3. Getting Started with Syncfusion® Blazor for server-side in .NET Core CLI