LegendItem Class
An item of a legend, for example a blue line labeled "river".
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public abstract class LegendItem : ResourceObjectRemarks
The images of legend items can be read from image files (see ImageLegendItem), but they are usually generated by the same visualizers that create the map itself. The visualizers are applied to special features that are generated by the legend item.
Meters and pixels
Some kinds of visualizers have numeric parameters that can be configured in meters in the map, but these are interpreted as pixels if they occur in a legend. For example, a LineVisualizer for a highway may have a width = 12.0, and if the lengthUnit = NominalMeters, then the line would appear to be 12 meters wide on the map, but would be drawn 12 pixels wide in a legend.
So, one can say that legend images are rendered in a scale of 1 meter per pixel (or about 1 : 3780 if we assume the usual screen resolution of 96 dpi).
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
LegendItem
ColorRampLegendItem
CustomLegendItem
ImageLegendItem
LineLegendItem
PointLegendItem
PolygonLegendItem
RasterLegendItem
Platforms
Windows, Linux, Android
LegendItem Members
The LegendItem type has the following members.
Properties
| Name | Description |
|---|---|
| Attributes | Gets the set of attributes for the feature of this LegendItem. |
| BackgroundColor | Gets or sets a color used as background for the image. |
| Crop | Gets or set a flag whether the image should be cropped. |
| Description | Gets or sets the description. |
| Height | Gets or sets the image height in pixels. |
| IsDisposed | Gets a value that tells whether the current LegendItem has been disposed. Inherited from EngineObject |
| Name | Gets or sets the name of the LegendItem. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current LegendItem represents. Inherited from EngineObject |
| OutlineColor | Gets or sets a color used for a rectangular outline for the image. |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
| Visualizers | Gets the list of visualizers used to generate the image. |
| Width | Gets or sets the image width in pixels. |
Methods
| Name | Description |
|---|---|
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| GetImage | Overloaded. Saves the image to a memory buffer in PNG format. |
| GetLocalizedDescription | Gets a localized version of the legend item description in a specific language. |
| HasLocalizedDescription | Checks if a localized version of the legend item description is available in a specific language. |
| SetLocalizedDescription | Sets the legend item description in a specific language. |