NChartScaleLegend Class

The NChartScaleLegend class provides methods to display the legend associated with the NChartBrushScale instance.

Inheritance Hierarchy

SystemObject
NChart3D_UWPNChartScaleLegend

Namespace: NChart3D_UWP
Assembly: NChart3D_UWP (in NChart3D_UWP.dll)

Syntax

C++

Copy

public sealed class NChartScaleLegend : IClosable, 
	INChartObject, INChartPlaced, INChartLegend

Public NotInheritable Class NChartScaleLegend
	Implements IClosable, INChartObject, INChartPlaced, INChartLegend

public ref class NChartScaleLegend sealed : IClosable, 
	INChartObject, INChartPlaced, INChartLegend

The NChartScaleLegend type exposes the following members.

Constructors

	Name	Description
	NChartScaleLegend	Create scale legend with given brush scale.

Top

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 Copy UpdateData call when the chat lays out its elements. This rect may change interactively when the legend is dragged by its handler.
	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.
	IsDescending	Flag determining if the values in the scale legend are sorted descending (the largest is on the top, true) or not (the largest is on the bottom, false). The default value is true.
	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).
	Scale	Brush scale associated with the scale legend. The default value is null.
	ScaleDelegate	Delegate of the scale legend.
	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.
	ShowLowerBoundary	Flag determining if the lower boundary of the scale should be shown in the scale legend (true) or not (false). The default value is true.
	ShowMiddleValues	Flag determining if the middle values of the scale should be shown in the scale legend (true) or not (false). The default value is true.
	ShowUpperBoundary	Flag determining if the upper boundary of the scale should be shown in the scale legend (true) or not (false). The default value is true.
	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.

Top

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.)

Top

Reference

NChart3D_UWP Namespace