Getting Started with ASP.NET MVC Maps Component

30 Sep 20223 minutes to read

This section briefly explains about how to include ASP.NET MVC Maps component in your ASP.NET MVC application using Visual Studio.

You can explore some useful features in the Maps component using the following video.


System requirements for ASP.NET MVC components

Create ASP.NET MVC application with HTML helper

Install ASP.NET MVC package in the application

Syncfusion ASP.NET MVC components are available in Refer to NuGet packages topic to learn more about installing NuGet packages in various OS environments. To add ASP.NET MVC components in the application, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for Syncfusion.EJ2.MVC5 and then install it.

The Syncfusion.EJ2.MVC5 NuGet package has dependencies, Newtonsoft.Json for JSON serialization and Syncfusion.Licensing for validating Syncfusion license key.

If you create ASP.NET MVC application with MVC4 package, search for Syncfusion.EJ2.MVC4 and then install it.

Add namespace

Add Syncfusion.EJ2 namespace reference in Web.config under Views folder.

    <add namespace="Syncfusion.EJ2"/>

Add style sheet

Checkout the Themes topic to learn different ways (CDN, NPM package, and CRG) to refer styles in ASP.NET MVC application, and to have the expected appearance for Syncfusion ASP.NET MVC components. Here, the theme is referred using CDN inside the <head> of ~/Views/Shared/_Layout.cshtml file as follows,

    <!-- Syncfusion ASP.NET MVC components styles -->
    <link rel="stylesheet" href="" />

Add script reference

In this getting started walk-through, the required scripts are referred using CDN inside the <head> of ~/Views/Shared/_Layout.cshtml file as follows,

    <!-- Syncfusion ASP.NET MVC components scripts -->
    <script src=""></script>

Register Syncfusion Script Manager

Open ~/Views/Shared/_Layout.cshtml page and register the script manager EJS().ScriptManager() at the end of <body> in the ASP.NET MVC application as follows.

    <!-- Syncfusion ASP.NET MVC Script Manager -->

Add ASP.NET MVC Maps component

Now, add the Syncfusion ASP.NET MVC Maps component in ~/Views/Home/Index.cshtml page.

@Html.EJS().Maps("container").Layers(layer => { layer.ShapeData(Model).Add(); }).Render();

Place the WorldMap.json file in App_Data folder of the project. Read the content in WorldMap.json file in the code behind and assign the deserialized object to the shapeData property of the Maps component using the ViewBag object in HomeController.cs as shown below.

public ActionResult Index()
    return View(GetWorldMap());

public object GetWorldMap()
    string allText = System.IO.File.ReadAllText(Server.MapPath("~/App_Data/WorldMap.json"));
    return JsonConvert.DeserializeObject(allText, typeof(object));

The shapeData in the ViewBag object is already assigned to the Maps component.

Press Ctrl+F5 (Windows) or +F5 (macOS) to run the app. Then, the Syncfusion ASP.NET MVC Maps component will be rendered in the default web browser.

ASP.NET MVC - Essential JS2 Maps

View Sample in GitHub.