ColorListLegend Class
A legend that displays the descriptions of colors used to paint a treemap or sunburst.
Namespace: DevExpress.XtraTreeMap
Assembly: DevExpress.XtraTreeMap.v24.2.dll
NuGet Package: DevExpress.TreeMap
Declaration
Remarks
You can use a ColorListLegend object to specify the HierarchicalChartControlBase.Legend property.
The following image shows a ColorListLegend in a sunburst chart:
Example
How to Add a Legend to a Treemap
This example adds a legend to a treemap and configures its title, border, and text settings.
Create a
ColorListLegendobject.Use the LegendBase.Title property to access the legend title settings. Specify the following title options:
Configure the options below to customize the position and alignment of the legend and legend items:
The following properties allow you to customize the legend border’s color and width:
Use the treemap’s Legend property to assign the legend to the treemap.
using DevExpress.XtraTreeMap;
using System;
using System.Drawing;
using System.Windows.Forms;
//...
private void Form1_Load(object sender, EventArgs e) {
//...
// Create a legend.
ColorListLegend legend = new ColorListLegend();
// Specify the legend title, and the title's color and font.
legend.Title.Text = "Field of Activity";
legend.Title.TextColor = Color.Black;
legend.Title.DXFont = new DXFont("Tahoma", 10);
// Define the color for legend items.
legend.TextColor = Color.Black;
// Set the offset beween an item's marker and text.
legend.TextOffset = 16;
// Specify the legend alignment and position.
legend.Direction = LegendDirection.LeftToRight;
legend.HorizontalAlignment = LegendHorizontalAlignment.Center;
legend.VerticalAlignment = LegendVerticalAlignment.BottomOutside;
// Define whether to arrange items in left-aligned columns.
legend.EquallySpacedItems = true;
// Configure the border color and width.
legend.BorderColor = Color.LightGray;
legend.BorderWidth = 1;
// Assign the legend to the treemap.
treeMapControl1.Legend = legend;
}