| NChartLegend Class |
The NChartLegend class provides methods to display the legend of the chart.
Inheritance HierarchyNamespace: NChart3D_UWP
Assembly: NChart3D_UWP (in NChart3D_UWP.dll)
SyntaxThe NChartLegend type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Background |
Brush filling the background of the text container.
|
| BlockAlignment |
Alignment of the legend.
Please note that if alignment is NChartLegendBlockAlignment.Left NChartLegendBlockAlignment.Right
NChartLegendBlockAlignment.Bottom or NChartLegendBlockAlignment.Top the border radius is
ignored (assumed to be 0).
|
| BorderColor |
Color of the border that is drawn around the text container.
|
| BorderRadius |
Corner rounding radius (in pixels) of the border that is drawn around the text container.
|
| BorderThickness |
Thickness of the border (in pixels) that is drawn around the text container.
|
| Chart |
Chart the object belongs to.
This property is assigned automatically whenever the object is assigned to the chart.
|
| ColumnCount |
Number of columns in legend. If 0 or less than 0 entries are aligned in lines with no columns.
The default value is 0.
|
| ContentAlignment |
Alignment of legend's content in legend's area. The default value is NChartLegendContentAlignment.Center.
|
| Delegate |
Delegate of the legend.
|
| Font |
Font of the legend's text.
|
| Footer |
Label that is placed on the bottom of the legend. It's null by default.
|
| Frame |
Frame of the legend in the view's coordinate system.
The frame is a rect fully enclosing the entire legend. This rect is calculated during UpdateData |
| HandlerNormalColor |
Get color of legend's handler normal state.
|
| HandlerPushedColor |
Get color of legend's handler pushed state.
|
| Header |
Label that is placed on the top of the legend. It's null by default.
|
| LineBreakMode |
Line break mode of the legend's text.
|
| Margin |
Margin of the text container in pixels (spacing from the bounds of the enclosing area).
|
| MaxSize |
Maximal size of legend in pixels. The default value is 200. If the legend's block alignment is so that the legend
grows vertically it is interpreted as maximal height if the legend grows horizontally -- as maximal width.
For details see INChartLegend.MaxSize
|
| MinimalEntriesPadding |
Minimal padding between entries in pixels. The default value is 10.
|
| Opacity |
Opacity of the text container. Value should be in 0..1. The default value is 1.
|
| Orientation |
Orientation of the legend.
|
| Origin |
Origin of the legend. It's a starting point that has effect only with orientation set to one of "free"-kinds.
|
| Padding |
Padding of the text container in pixels (spacing to sub-areas).
|
| ScrollBarColor |
Color of the legend's scrollbar.
|
| ScrollerPadding |
Padding inside the scroller.
|
| ShouldAutodetectColumnCount |
Flag determining if ColumnCount should be detected automatically to ensure good-looking legend (true) or not (false).
If this property is true, the value set to ColumnCount takes no effect. The default value is false.
|
| TextColor |
Color of the legend's text.
|
| Visible |
Flag that determines if the object is visible (true) or not (false). The default value is true.
|
Methods| Name | Description | |
|---|---|---|
 | Close | |
| Equals | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| SetHandlerColor |
Set color for legend's handler.
|
| SetHandlerImage |
Set image for legend's handler.
|
| ToString | (Inherited from Object.) |
See Also