Click or drag to resize
INChartLegend Interface
The INChartLegend interface provides methods to display the legend of the chart.

Namespace:  NChart3D_UWP
Assembly:  NChart3D_UWP (in NChart3D_UWP.dll)
Syntax
public interface INChartLegend : INChartObject, 
	INChartPlaced

The INChartLegend type exposes the following members.

Properties
  NameDescription
Public propertyBackground
Brush filling the background of the text container.
(Inherited from INChartPlaced.)
Public propertyBlockAlignment
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).
Public propertyBorderColor
Color of the border that is drawn around the text container.
(Inherited from INChartPlaced.)
Public propertyBorderRadius
Corner rounding radius (in pixels) of the border that is drawn around the text container.
(Inherited from INChartPlaced.)
Public propertyBorderThickness
Thickness of the border (in pixels) that is drawn around the text container.
(Inherited from INChartPlaced.)
Public propertyChart
Chart the object belongs to. This property is assigned automatically whenever the object is assigned to the chart.
(Inherited from INChartObject.)
Public propertyColumnCount
Number of columns in legend. If 0 or less than 0 entries are aligned in lines with no columns. The default value is 0.
Public propertyContentAlignment
Alignment of legend's content in legend's area. The default value is NChartLegendContentAlignment.Center.
Public propertyDelegate
Delegate of the legend.
Public propertyFont
Font of the legend's text.
Public propertyFooter
Label that is placed on the bottom of the legend. It's null by default.
Public propertyFrame
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
call when the chat lays out its elements. This rect may change interactively when the legend is dragged by its handler.
Public propertyHandlerNormalColor
Get color of legend's handler normal state.
Public propertyHandlerPushedColor
Get color of legend's handler pushed state.
Public propertyHeader
Label that is placed on the top of the legend. It's null by default.
Public propertyLineBreakMode
Line break mode of the legend's text.
Public propertyMargin
Margin of the text container in pixels (spacing from the bounds of the enclosing area).
(Inherited from INChartPlaced.)
Public propertyMaxSize
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. To be more precise the mapping works as follows
- by NChartLegendBlockAlignment.BottomLeft it is height;
- by NChartLegendBlockAlignment.BottomCenter it is height;
- by NChartLegendBlockAlignment.BottomRight it is height;
- by NChartLegendBlockAlignment.CenterLeft it is width;
- by NChartLegendBlockAlignment.CenterCenter it is ignored;
- by NChartLegendBlockAlignment.CenterRight it is width;
- by NChartLegendBlockAlignment.TopLeft it is height;
- by NChartLegendBlockAlignment.TopCenter it is height;
- by NChartLegendBlockAlignment.TopRight it is height;
- by NChartLegendBlockAlignment.Left it is width;
- by NChartLegendBlockAlignment.Right it is width;
- by NChartLegendBlockAlignment.Bottom it is height;
- by NChartLegendBlockAlignment.Top it is height.
Public propertyMinimalEntriesPadding
Minimal padding between entries in pixels. The default value is 10.
Public propertyOpacity
Opacity of the text container. Value should be in 0..1. The default value is 1.
(Inherited from INChartPlaced.)
Public propertyOrientation
Orientation of the legend.
Public propertyOrigin
Origin of the legend. It's a starting point that has effect only with orientation set to one of "free"-kinds.
Public propertyPadding
Padding of the text container in pixels (spacing to sub-areas).
(Inherited from INChartPlaced.)
Public propertyScrollBarColor
Color of the legend's scrollbar.
Public propertyScrollerPadding
Padding inside the scroller.
Public propertyShouldAutodetectColumnCount
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.
Public propertyTextColor
Color of the legend's text.
Public propertyVisible
Flag that determines if the object is visible (true) or not (false). The default value is true.
(Inherited from INChartObject.)
Top
Methods
  NameDescription
Public methodSetHandlerColor
Set color for legend's handler.
Public methodSetHandlerImage
Set image for legend's handler.
Top
See Also