Data labels in ASP.NET MVC Maps Component

11 Oct 202317 minutes to read

Data labels provide information to users about the shapes of the Maps component. It can be enabled by setting the Visible property of the MapsDataLabelSettings to true.

Adding data labels

To display data labels in the Maps, the LabelPath property of MapsDataLabelSettings must be used. The value of the LabelPath property can be taken from the field name in the shape data or data source. In the following example, the value of the LabelPath property is the field name in the shape data of the Maps layer.

@using Syncfusion.EJ2.Maps;
@using Syncfusion.EJ2;


@Html.EJS().Maps("maps").Layers(l =>
{
    l.ShapeSettings(s => s.Autofill(true)).DataLabelSettings(label => label.Visible(true).LabelPath("name")).
      ShapeData(ViewBag.usmap).Add();
}).Render()
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using EJ2_Core_Application.Models;
using Newtonsoft.Json;

namespace EJ2_Core_Application.Controllers
{
    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            ViewBag.usa = GetUSMap();
            ViewBag.usmap = GetUnitedStatesMap();
            return View();
        }
        public object GetUSMap()
        {
            string allText = System.IO.File.ReadAllText("./wwwroot/scripts/MapsData/USA.js");
            return JsonConvert.DeserializeObject(allText);
        }
        public object GetUnitedStatesMap()
        {
            string text = System.IO.File.ReadAllText(Server.MapPath("~/App_Data/USA.json"));
            return JsonConvert.DeserializeObject(text, typeof(object));
        }
    }
}

Setting label path value

In the following example, the value of LabelPath property is set from the field name in the data source of the layer settings.

@using Syncfusion.EJ2.Maps;
@using Syncfusion.EJ2;

@{
    var data = new[]
    {
        new {name="Afghanistan", value=53, countryCode="AF", population=29863010, color="red",
             density=119, continent="Asia"},
        new {name="Albania", value=117, countryCode="AL", population=3195000, color="Blue",
             density=111, continent="Europe"},
        new {name="Algeria", value=15, countryCode="DZ", population=34895000, color="Green",
             density=15, continent="Africa"}
    };
}

@Html.EJS().Maps("maps").Layers(l =>
{
    l.ShapeSettings(s => s.Autofill(true)).DataLabelSettings(label => label.Visible(true).LabelPath("continent").SmartLabelMode(Syncfusion.EJ2.Maps.SmartLabelMode.Trim)).
      ShapeDataPath("name").ShapePropertyPath("name")
      .DataSource(data).ShapeData(ViewBag.worldMap).Add();
}).Render()
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using EJ2_Core_Application.Models;
using Newtonsoft.Json;

namespace EJ2_Core_Application.Controllers
{
    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            ViewBag.world_map = GetWorldMap();
            ViewBag.worldMap = GetMap();
            return View();
        }
        public object GetWorldMap()
        {
            string allText = System.IO.File.ReadAllText("./wwwroot/scripts/MapsData/WorldMap.js");
            return JsonConvert.DeserializeObject(allText);
        }
        public object GetMap()
        {
            string allText = System.IO.File.ReadAllText(Server.MapPath("~/App_Data/WorldMap.json"));
            return JsonConvert.DeserializeObject(allText, typeof(object));
        }
    }
}

Setting label path value from datasource

Customization

The following properties are available in the MapsDataLabelSettings to customize the data label of the Maps component.

  • Border - To customize the color, width and opacity for the border of the data labels in Maps.
  • Fill - To apply the color of the data labels in Maps.
  • Opacity - To customize the transparency of the data labels in Maps.
  • TextStyle - To customize the text style of the data labels in Maps.
@using Syncfusion.EJ2.Maps;
@using Syncfusion.EJ2;

@{
    var label = new MapsDataLabelSettings
    {
        Visible = true,
        LabelPath = "name",
        Border = new MapsBorder
        {
            Color = "green",
            Width = 2,
            Opacity = 1
        },
        Fill = "#CCD1D1",
        Opacity = 0.9,
        TextStyle = new MapsFont
        {
            Color = "blue",
            Size = "10px",
            FontStyle = "Sans-serif",
            FontWeight = "normal"
        }
    };
}

@Html.EJS().Maps("maps").Layers(l =>
{
    l.ShapeSettings(s => s.Autofill(true)).DataLabelSettings(label).
      ShapeData(ViewBag.usmap).Add();
}).Render()
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using EJ2_Core_Application.Models;
using Newtonsoft.Json;

namespace EJ2_Core_Application.Controllers
{
    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            ViewBag.usa = GetUSMap();
            ViewBag.usmap = GetUnitedStatesMap();
            return View();
        }
        public object GetUSMap()
        {
            string allText = System.IO.File.ReadAllText("./wwwroot/scripts/MapsData/USA.js");
            return JsonConvert.DeserializeObject(allText);
        }
        public object GetUnitedStatesMap()
        {
            string text = System.IO.File.ReadAllText(Server.MapPath("~/App_Data/USA.json"));
            return JsonConvert.DeserializeObject(text, typeof(object));
        }
    }
}

Data label customization

Label animation

The data labels can be animated during the initial rendering of the Maps. This can be enabled by setting the AnimationDuration property in the DataLabelSettings of the Maps. The duration of the animation is specified in milliseconds.

@using Syncfusion.EJ2.Maps;
@using Syncfusion.EJ2;

@{
    var label = new MapsDataLabelSettings
    {
        Visible = true,
        LabelPath = "name",
        IntersectionAction = Syncfusion.EJ2.Maps.IntersectAction.Trim,
        SmartLabelMode = Syncfusion.EJ2.Maps.SmartLabelMode.Hide,
        AnimationDuration = 4000
    };
}

@Html.EJS().Maps("maps").Layers(l =>
{
    l.ShapeSettings(s => s.Autofill(true)).DataLabelSettings(label).TooltipSettings(ts =>ts.ValuePath("name").Visible(true)).
      ShapeData(ViewBag.usmap).Add();
}).Render()
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using EJ2_Core_Application.Models;
using Newtonsoft.Json;

namespace EJ2_Core_Application.Controllers
{
    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            ViewBag.usa = GetUSMap();
            ViewBag.usmap = GetUnitedStatesMap();
            return View();
        }
        public object GetUSMap()
        {
            string allText = System.IO.File.ReadAllText("./wwwroot/scripts/MapsData/USA.js");
            return JsonConvert.DeserializeObject(allText);
        }
        public object GetUnitedStatesMap()
        {
            string text = System.IO.File.ReadAllText(Server.MapPath("~/App_Data/USA.json"));
            return JsonConvert.DeserializeObject(text, typeof(object));
        }
    }
}

ASP.NET MVC Maps with Data Label Animation

Smart labels

The Maps component provides an option to handle the labels when they intersect with the corresponding shape borders using the SmartLabelMode property. The following options are available in the SmartLabelMode property.

  • None
  • Hide
  • Trim
@using Syncfusion.EJ2.Maps;
@using Syncfusion.EJ2;

@{
    var label = new MapsDataLabelSettings
    {
        Visible = true,
        LabelPath = "name",
        SmartLabelMode = Syncfusion.EJ2.Maps.SmartLabelMode.Hide
    };
}

@Html.EJS().Maps("maps").Layers(l =>
{
    l.ShapeSettings(s => s.Autofill(true)).DataLabelSettings(label).
      ShapeData(ViewBag.usmap).Add();
}).Render()
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using EJ2_Core_Application.Models;
using Newtonsoft.Json;

namespace EJ2_Core_Application.Controllers
{
    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            ViewBag.usa = GetUSMap();
            ViewBag.usmap = GetUnitedStatesMap();
            return View();
        }
        public object GetUSMap()
        {
            string allText = System.IO.File.ReadAllText("./wwwroot/scripts/MapsData/USA.js");
            return JsonConvert.DeserializeObject(allText);
        }
        public object GetUnitedStatesMap()
        {
            string text = System.IO.File.ReadAllText(Server.MapPath("~/App_Data/USA.json"));
            return JsonConvert.DeserializeObject(text, typeof(object));
        }
    }
}

Smart labels

Intersect action

The Maps component provides an option to handle the labels when a label intersects with another label using the IntersectionAction property. The following options are available in the IntersectionAction property.

  • None
  • Hide
  • Trim
@using Syncfusion.EJ2.Maps;
@using Syncfusion.EJ2;

@{
    var label = new MapsDataLabelSettings
    {
        Visible = true,
        LabelPath = "name",
        IntersectionAction = Syncfusion.EJ2.Maps.IntersectAction.Trim
    };
}

@Html.EJS().Maps("maps").Layers(l =>
{
    l.ShapeSettings(s => s.Autofill(true)).DataLabelSettings(label).
      ShapeData(ViewBag.usmap).Add();
}).Render()
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using EJ2_Core_Application.Models;
using Newtonsoft.Json;

namespace EJ2_Core_Application.Controllers
{
    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            ViewBag.usa = GetUSMap();
            ViewBag.usmap = GetUnitedStatesMap();
            return View();
        }
        public object GetUSMap()
        {
            string allText = System.IO.File.ReadAllText("./wwwroot/scripts/MapsData/USA.js");
            return JsonConvert.DeserializeObject(allText);
        }
        public object GetUnitedStatesMap()
        {
            string text = System.IO.File.ReadAllText(Server.MapPath("~/App_Data/USA.json"));
            return JsonConvert.DeserializeObject(text, typeof(object));
        }
    }
}

Intersect action

Adding data label as a template

The data label can be added as a template in the Maps component. The Template property of MapsDataLabelSettings is used to set the data label as a template. Any text or HTML element can be added as the template in data labels.

NOTE

The properties of data label such as, SmartLabelMode , IntersectionAction, AnimationDuration, Border, Fill, Opacity and TextStyle properties are not applicable to Template property. The styles can be applied to the label template using the CSS styles of the HTML element.

@using Syncfusion.EJ2.Maps;
@using Syncfusion.EJ2;

@{
    var label = new MapsDataLabelSettings
    {
        Visible = true,
        Template = "Label"
    };
}

@Html.EJS().Maps("maps").Layers(l =>
{
    l.ShapeSettings(s => s.Autofill(true)).DataLabelSettings(label).
      ShapeData(ViewBag.usmap).Add();
}).Render()
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using EJ2_Core_Application.Models;
using Newtonsoft.Json;

namespace EJ2_Core_Application.Controllers
{
    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            ViewBag.usa = GetUSMap();
            ViewBag.usmap = GetUnitedStatesMap();
            return View();
        }
        public object GetUSMap()
        {
            string allText = System.IO.File.ReadAllText("./wwwroot/scripts/MapsData/USA.js");
            return JsonConvert.DeserializeObject(allText);
        }
        public object GetUnitedStatesMap()
        {
            string text = System.IO.File.ReadAllText(Server.MapPath("~/App_Data/USA.json"));
            return JsonConvert.DeserializeObject(text, typeof(object));
        }
    }
}

Intersect action