Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 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

ColorListLegend Class

Represents a color legend as a list of colors.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v24.2.dll

NuGet Package: DevExpress.Win.Map

#Declaration

public class ColorListLegend :
    ColorLegendBase,
    IImageCollectionHelper

#Remarks

To show this legend on a map, create an instance of the ColorListLegend class and add it to the MapControl.Legends. Then, specify the ItemsLayerLegend.Layer property of the instance. Note that a layer assigned to the legend should contain a colorizer.

The following image shows an instance of Color List Legend.

Color List

For more information, refer to Legends.

#Example

To add a color legend listing the colors on the Map, create an instance of the ColorListLegend class and specify its ItemsLayerLegend.Layer property. Optionally, specify MapLegendBase.Header, MapLegendBase.Description and other properties.

// Add a legend to the map.
map.Legends.Add(new ColorListLegend() {
    Header = "Room Type",
    Layer = hotelLayer
});
See Also