Getting Started with Blazor Maps Component in Blazor Server App

18 Nov 201810 minutes to read

This section briefly explains how to include Blazor Maps component in your Blazor Server App using Visual Studio, Visual Studio Code, and the .NET CLI.

• Visual Studio
• Visual Studio Code
• .NET CLI

Prerequisites

• System requirements for Blazor components

Create a new Blazor App in 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.

Prerequisites

• System requirements for Blazor components

Create a new Blazor App in 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+`).

Blazor Server App

dotnet new blazor -o BlazorApp -int Server
cd BlazorApp

Prerequisites

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

.NET CLI

dotnet --version

Create a Blazor Server App using .NET CLI

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.

.NET CLI

dotnet new blazor -o BlazorApp -int Server
cd BlazorApp

NOTE

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 required Blazor packages

Install the Syncfusion.Blazor.Maps 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.Maps –version 34.1.29), or the .NET CLI.

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

Package Manager

Install-Package Syncfusion.Blazor.Maps -Version 34.1.29

NOTE

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

Add import namespaces

After the packages are installed, open the ~/_Imports.razor file and import the Syncfusion.Blazor and Syncfusion.Blazor.Maps namespaces.

NOTE

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

~/_Imports.razor

@using Syncfusion.Blazor
@using Syncfusion.Blazor.Maps

Register Blazor service

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

Program.cs

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

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 the Blazor application.

Add Blazor Maps component with GeoJSON data

Add the Blazor Maps 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.

NOTE

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

RAZOR

@* desired render mode defined here *@
@rendermode InteractiveServer

Bind GeoJSON data to the Maps to render any geometric shape in SVG (Scalable Vector Graphics) for powerful data visualization of shapes. You can use the ShapeData property in MapsLayer to load the GeoJSON shape data into the Maps component.

Home.razor

<!-- SfMaps is the root container component for the maps -->
<SfMaps>
    <!-- MapsLayers contains one or more map layers to display on the map -->
    <MapsLayers>
        <!-- MapsLayer defines a map layer with shape data and configuration -->
        <MapsLayer ShapeData='new {dataOptions= "https://cdn.syncfusion.com/maps/map-data/world-map.json"}' TValue="string">
        </MapsLayer>
    </MapsLayers>
</SfMaps>

NOTE

The “world-map.json” file contains the World map GeoJSON data.

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

Bind data source

The DataSource property is used to represent statistical data in the Maps component. We can define a list of objects as a data source to the Maps component. This data source will be further used to color the map, display data labels, display tooltips, and more. Assign the below list SecurityCouncilDetails to the DataSource property in MapsLayer.

Home.razor

@code {
    public List<UNCouncilCountry> SecurityCouncilDetails = new List<UNCouncilCountry>{
         new UNCouncilCountry { Name= "China", Membership= "Permanent" },
         new UNCouncilCountry { Name= "France", Membership= "Permanent" },
         new UNCouncilCountry { Name= "Russia", Membership= "Permanent" },
         new UNCouncilCountry { Name= "Kazakhstan", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Poland", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Sweden", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "United Kingdom", Membership= "Permanent" },
         new UNCouncilCountry { Name= "United States", Membership= "Permanent" },
         new UNCouncilCountry { Name= "Bolivia", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Eq. Guinea", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Ethiopia", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Côte d Ivoire", Membership= "Permanent" },
         new UNCouncilCountry { Name= "Kuwait", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Netherlands", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Peru", Membership= "Non-Permanent" }
    };

    public class UNCouncilCountry
    {
        public string Name { get; set; }
        public string Membership { get; set; }
    };
}

NOTE

The United Nations Security Council data is referred from source.

You should also specify the field names in the shape data and data source to the ShapePropertyPath and ShapeDataPath properties, respectively. These are used to identify the appropriate shapes and match the specific data source values to them.

The following complete example shows a Maps component with the GeoJSON layer and data source binding:

Home.razor

@using Syncfusion.Blazor.Maps
@rendermode InteractiveServer

<SfMaps>
    <MapsLayers>
        <MapsLayer ShapeData='new {dataOptions= "https://cdn.syncfusion.com/maps/map-data/world-map.json"}'
                   ShapePropertyPath='new string[] {"name"}'
                   DataSource="SecurityCouncilDetails"
                   ShapeDataPath="Name" TValue="UNCouncilCountry">
        </MapsLayer>
    </MapsLayers>
</SfMaps>

@code {
    public List<UNCouncilCountry> SecurityCouncilDetails = new List<UNCouncilCountry>{
         new UNCouncilCountry { Name= "China", Membership= "Permanent" },
         new UNCouncilCountry { Name= "France", Membership= "Permanent" },
         new UNCouncilCountry { Name= "Russia", Membership= "Permanent" },
         new UNCouncilCountry { Name= "Kazakhstan", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Poland", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Sweden", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "United Kingdom", Membership= "Permanent" },
         new UNCouncilCountry { Name= "United States", Membership= "Permanent" },
         new UNCouncilCountry { Name= "Bolivia", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Eq. Guinea", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Ethiopia", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Côte d Ivoire", Membership= "Permanent" },
         new UNCouncilCountry { Name= "Kuwait", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Netherlands", Membership= "Non-Permanent" },
         new UNCouncilCountry { Name= "Peru", Membership= "Non-Permanent" }
    };

    public class UNCouncilCountry
    {
        public string Name { get; set; }
        public string Membership { get; set; }
    };
}

This example demonstrates the complete setup with:

• The ShapeData pointing to the GeoJSON world map
• The ShapePropertyPath set to "name" to match shape names
• The DataSource bound to SecurityCouncilDetails
• The ShapeDataPath set to "Name" to match data source field

NOTE

Please refer to the section for more information on data binding.

NOTE

View Sample in GitHub.

See also

• Getting Started with Blazor for WebAssembly application in .NET Core CLI

• Getting Started with Blazor for server-side application in Visual Studio

• Getting Started with Blazor for server-side application in .NET Core CLI