LineLegendItem Class
Represents a line feature in a legend.
NuGet/Assembly: Carmenta.Engine.5.17.0.nupkg (in the CECore assembly)
Syntax
public class LineLegendItem : LegendItemInheritance Hierarchy
System.Object
EngineObject
ResourceObject
LegendItem
LineLegendItem
Platforms
Windows, Linux, Android
LineLegendItem Members
The LineLegendItem type has the following members.
Constructors
| Name | Description |
|---|---|
| LineLegendItem | Initializes a new instance of the LineLegendItem class. |
Properties
| Name | Description |
|---|---|
| Attributes | Gets the set of attributes for the feature of this LineLegendItem. Inherited from LegendItem |
| BackgroundColor | Gets or sets a color used as background for the image. Inherited from LegendItem |
| 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 LineLegendItem has been disposed. Inherited from EngineObject |
| LineType | Gets or sets the type of line (straight, curved, etc.) |
| Name | Gets or sets the name of the LineLegendItem. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current LineLegendItem 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 |