Layer.Legend Property
Gets or sets a map legend associated with this layer.
Syntax
public Legend Legend { get; set; }Property Value
Remarks
The map legend for a layer is typically configured in Carmenta Studio. There are two ways to use a Legend object:
As metadata. When a Legend object is used only as the Legend property of a Layer or a View, it will not be displayed in the map window. However, you can write application code that will access such a Legend and display in some other GUI panel. Carmenta Explorer is an application that behaves in this way: if a view or a layer with a Legend property is selected in the Layers panel, then the legend will be displayed in the Properties panel.
As part of the map window. When a Legend object is used in a ScreenLayer as one of its ScreenLayer.Elements, it will be displayed in the map window.
Example
// Set a default Legend in the Layer
public static void SetDefaultLegend(Layer layer, Legend defaultLegend)
{
// This property is a member of a type that might be referred to by a View
// or a GlobeView, either directly or indirectly through other objects, which means
// that you must use the Guard class to take the global configuration lock when it
// is modified to synchronize access with any running Carmenta Engine threads.
using (Guard guard = new Guard())
{
// Set the default legend in the Layer
layer.Legend = defaultLegend;
}
}
// Get all Legend texts
public static StringCollection GetLegendTexts(Layer layer)
{
StringCollection legendTexts = new StringCollection();
// Loop over all LegendItems in the Legend. This example assumes
// the method is called on the GUI thread which makes it safe to
// access the Legend property without synchronization.
foreach (LegendItem legendItem in layer.Legend.Items)
{
legendTexts.Add(legendItem.Description);
}
// Return the legend texts
return legendTexts;
}
Platforms
Windows, Linux, Android