RasterLegendItem Class
Represents a raster color in a legend.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class RasterLegendItem : LegendItemRemarks
This class is used to explain a thematic raster visualization in a Legend. The Visualizers should refer to the RasterVisualizer used in the map, and the CellValue should contain one of the possible values of the raster. So, to explain the complete raster visualization, you need many raster legend items: one for each possible color in the visualization. Each item will generate a colored rectangle.
To generate a colored rectangle, you could have used a PolygonLegendItem instead. But the advantage of using a RasterLegendItem is that it can keep a reference to the RasterVisualizer that is used for the map. So if you modify the configuration by replacing one of the raster colors, the new color will appear both in the map and in the legend.
However, if you increase the number of colors for the raster, you will need to create more raster legend items.
Note that the RasterLegendItem is designed for thematic maps, where the integers in the raster cells represent discrete categories (like Water, Forest or City). If, instead, the raster cells should be interpreted as numbers, it is better to use a ColorRampLegendItem.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
LegendItem
RasterLegendItem
Platforms
Windows, Linux, Android
RasterLegendItem Members
The RasterLegendItem type has the following members.
Constructors
| Name | Description |
|---|---|
| RasterLegendItem | Initializes a new instance of the RasterLegendItem class. |
Properties
| Name | Description |
|---|---|
| Attributes | Gets the set of attributes for the feature of this RasterLegendItem. Inherited from LegendItem |
| BackgroundColor | Gets or sets a color used as background for the image. Inherited from LegendItem |
| CellValue | Gets or sets the raster cell value used in this RasterLegendItem. |
| Crop | Gets or set a flag whether the image should be cropped. Inherited from LegendItem |
| Description | Gets or sets the description. Inherited from LegendItem |
| Height | Gets or sets the image height in pixels. Inherited from LegendItem |
| IsDisposed | Gets a value that tells whether the current RasterLegendItem has been disposed. Inherited from EngineObject |
| Name | Gets or sets the name of the RasterLegendItem. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current RasterLegendItem represents. Inherited from EngineObject |
| OutlineColor | Gets or sets a color used for a rectangular outline for the image. Inherited from LegendItem |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
| Visualizers | Gets the list of visualizers used to generate the image. Inherited from LegendItem |
| Width | Gets or sets the image width in pixels. Inherited from LegendItem |
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. Inherited from LegendItem |
| GetLocalizedDescription | Gets a localized version of the legend item description in a specific language. Inherited from LegendItem |
| HasLocalizedDescription | Checks if a localized version of the legend item description is available in a specific language. Inherited from LegendItem |
| SetLocalizedDescription | Sets the legend item description in a specific language. Inherited from LegendItem |