Skip to main content
All docs
V25.1
  • DevExpress v25.1 Update — Your Feedback Matters

    Our What's New in v25.1 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

    Take the survey Not interested

    LegendDirection Enum

    Lists values that specify the direction in which legend items are arranged.

    Namespace: DevExpress.XtraTreeMap

    Assembly: DevExpress.XtraTreeMap.v25.1.dll

    NuGet Package: DevExpress.TreeMap

    #Declaration

    public enum LegendDirection

    #Members

    Name Description
    TopToBottom

    Legend items are positioned vertically from the top to the bottom of the legend.

    BottomToTop

    Legend items are positioned vertically from the bottom to the top of the legend.

    LeftToRight

    Legend items are positioned horizontally from the left to the right of the legend.

    RightToLeft

    Legend items are positioned horizontally from the right to the left of the legend.

    #Related API Members

    The following properties accept/return LegendDirection values:

    #Remarks

    If the legend displays group names, they are positioned in the order of the groups in the data source.

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

    Treemap legend

    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;
        }
    
    See Also