Welcome to DevExpress .NET Documentation
WinForms Controls
ASP.NET Controls and MVC Extensions
ASP.NET Bootstrap Controls
ASP.NET Core Bootstrap Controls
WPF Controls
	Prerequisites
	What's Installed
	Common Concepts
	MVVM Framework
	Controls and Libraries
		Windows and Utility Controls
		Dialogs, Notifications and Panels
		Reporting
		Data Grid
		Ribbon, Bars and Menu
		Charts Suite
		Pivot Grid
		Scheduler
		Spreadsheet
		Rich Text Editor
		Tree List
		Gauge Controls
		Map Control
			Getting Started
			Layers
			Coordinate Systems
			Map Image Data
			GIS Data
			Vector Data
			Visual Elements
				Map Area
				Mini Map
				Navigation Elements
				Search Panel
				Vector Items
				Legends
			End-User Interaction
			Examples
		Layout Management
		Windows Modern UI
		Printing-Exporting
		Data Editors
		Navigation Controls
		Spell Checker
		Property Grid
		PDF Viewer
		TreeMap Control
		Diagram Control
		Scheduler (legacy)
	Scaffolding Wizard
	Localization
	Redistribution and Deployment
	Get More Help
	API Reference
Xamarin Controls
Windows 10 App Controls
Document Server
Reporting
Report Server
Dashboard
eXpressApp Framework
CodeRush
CodeRush Classic
Cross-Platform Core Libraries
Tools and Utilities
End-User Documentation

WPF Controls > Controls and Libraries > Map Control > Visual Elements > Legends

Legends

A Legend is a panel that shows information about value meanings of vector items. This may be information about either item colors or item sizes, depending on the item's nature.

To add a legend to the Map control, it is necessary to create an appropriate MapLegendBase class descendant (either a color-based or size-based legend) and add it to the MapControl.Legends collection.

Then, it is required to specify a layer which contains vector items to be annotated by this legend. To do this, assign this layer object to the ItemsLayerLegend.Layer property.

Below you will find the more detailed information about various types of legends supported by the Map control.

Color-Based Legend

A Color-Based Legend is intended to detail the meaning of specific colors. In this case, a layer specified by a legend's ItemsLayerLegend.Layer property should contain vector items colorized by one of the following colorizers:

There are two types of color-based legends.

The main properties that affect element appearance and functionality are listed below.

Group	Properties
Availability	MapControl.Legends
Layout	HorizontalAlignment, VerticalAlignment
Elements	ItemsLayerLegend.Layer, ColorLegend.CustomItems
Appearance	MapLegendBase.Header, MapLegendBase.Description, ColorLegend.ItemTemplate, MapLegendBase.ItemLabelTemplate, Background, Foreground, BorderBrush

For more information on using these legends, see the following examples:

How to: Colorize Map Contours Using the Choropleth Colorizer (an example of using a ColorScaleLegend);
Lesson 3 - Add Analytical Data to a Geographical Map (an example of using a ColorListLegend).

Size-Based Legend

A Size-Based Legend details the meaning of various sizes in MapBubble or MapPie charts.

This legend type is represented by the SizeLegend class. The appearance of the size-based legend is defined by its SizeLegend.Type property value.

SizeLegend.Type = Inline

SizeLegend.Type = Nested

The main properties that affect element appearance and functionality are listed below.

Group	Properties
Availability	MapControl.Legends
Layout	HorizontalAlignment, VerticalAlignment
Elements	ItemsLayerLegend.Layer, SizeLegend.CustomItems
Appearance	MapLegendBase.Header, MapLegendBase.Description, MapLegendBase.ItemLabelTemplate, Background, BorderBrush, Foreground, SizeLegend.Type, SizeLegend.ShowTickMarks

To learn how to create a SizeLegend object, refer to Lesson 3 - Add Analytical Data to a Geographical Map.

Is this topic helpful?