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

Inheritance diagram for com.nchart3d.NChart.NChartScaleLegend:

Public Member Functions
	NChartScaleLegend (NChartBrushScale scale)
	Create scale legend with given brush scale. More...

NChartBrushScale	getScale ()
	Brush scale associated with the scale legend. More...

void	setScale (NChartBrushScale scale)
	For details see getScale().

boolean	showLowerBoundary ()
	Flag determining if the lower boundary of the scale should be shown in the scale legend (true) or not (false). More...

void	setShowLowerBoundary (boolean showLowerBoundary)
	For details see showLowerBoundary().

boolean	showUpperBoundary ()
	Flag determining if the upper boundary of the scale should be shown in the scale legend (true) or not (false). More...

void	setShowUpperBoundary (boolean showUpperBoundary)
	For details see showUpperBoundary().

boolean	showMiddleValues ()
	Flag determining if the middle values of the scale should be shown in the scale legend (true) or not (false). More...

void	setShowMiddleValues (boolean showMiddleValues)
	For details see showMiddleValues().

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

void	setDescending (boolean isDescending)
	For details see isDescending().

boolean	isContinuous ()
	Flag determining if the legend displays continuous gradient (true) or discrete color steps (false). More...

void	setContinuous (boolean isContinuous)
	For details see isContinuous().

PointF	getMarkerSize ()
	Size of legend markers (in pixels). More...

void	setMarkerSize (PointF markerSize)
	For details see getMarkerSize().

NChartScaleLegendDelegate	getScaleDelegate ()
	Delegate of the scale legend.

void	setScaleDelegate (NChartScaleLegendDelegate delegate)
	For details see getDelegate().

Public Member Functions inherited from com.nchart3d.NChart.NChartLegend
NChartFont	getFont ()
	Font of the legend's text.

void	setFont (NChartFont font)
	For details see getFont().

int	getTextColor ()
	Color of the legend's text.

void	setTextColor (int textColor)
	For details see getTextColor().

NChartLineBreakMode	getLineBreakMode ()
	Line break mode of the legend's text.

NChartLabel	getFooter ()
	Label that is placed on the bottom of the legend. More...

void	setFooter (NChartLabel footer)
	For details see getFooter().

NChartLabel	getHeader ()
	Label that is placed on the top of the legend. More...

void	setHeader (NChartLabel header)
	For details see getHeader().

NChartLegendBlockAlignment	getBlockAlignment ()
	Alignment of the legend. More...

void	setBlockAlignment (NChartLegendBlockAlignment blockAlignment)
	For details see getBlockAlignment().

NChartLegendContentAlignment	getContentAlignment ()
	Alignment of legend's content in legend's area. More...

void	setContentAlignment (NChartLegendContentAlignment contentAlignment)
	For details see getContentAlignment().

int	getColumnCount ()
	Number of columns in legend. More...

void	setColumnCount (int columnCount)
	For details see getColumnCount().

boolean	shouldAutodetectColumnCount ()
	Flag determining if `columnCount` should be detected automatically to ensure good-looking legend (true) or not (false). More...

void	setShouldAutodetectColumnCount (boolean shouldAutodetectColumnCount)
	For details see shouldAutodetectColumnCount().

float	getMaxSize ()
	Maximal size of legend in pixels. More...

void	setMaxSize (float maxSize)
	For details see getMaxSize().

float	getMinimalEntriesPadding ()
	Minimal padding between entries in pixels. More...

void	setMinimalEntriesPadding (float minimalEntriesPadding)
	For details see getMinimalEntriesPadding().

NChartMargin	getScrollerPadding ()
	Padding inside the scroller.

void	setScrollerPadding (NChartMargin scrollerPadding)
	For details see getScrollerPadding().

NChartLegendOrientation	getOrientation ()
	Orientation of the legend. More...

void	setOrientation (NChartLegendOrientation orientation)
	For details see getOrientation().

PointF	getOrigin ()
	Origin of the legend. More...

void	setOrigin (PointF origin)
	For details see getOrigin().

int	getScrollBarColor ()
	Color of the legend's scrollbar.

void	setScrollBarColor (int scrollBarColor)
	For details see getScrollBarColor().

void	setHandlerColors (int normal, int pushed)
	Set color for legend's handler. More...

void	setHandlerImages (Bitmap normal, Bitmap pushed)
	Set images for legend's handler. More...

RectF	getFrame ()
	Frame of the legend in the view's coordinate system. More...

int	handlerNormalColor ()
	Get color of legend's handler normal state.

int	handlerPushedColor ()
	Get color of legend's handler pushed state.

boolean	isUserInteractionsEnabled ()
	Flag determining if user interactions in the legend (scrolling, etc.) are enabled (true) or disabled (false). More...

void	setUserInteractionsEnabled (boolean userInteractionsEnabled)
	For details see isUserInteractionsEnabled().

NChartLegendLabelPosition	getLabelPosition ()
	Position of the legend labels related to the legend markers. More...

void	setLabelPosition (NChartLegendLabelPosition labelPosition)
	For details see getLabelPosition().

NChartLegendDelegate	getDelegate ()
	Delegate of the legend.

void	setDelegate (NChartLegendDelegate delegate)
	For details see getDelegate().

Public Member Functions inherited from com.nchart3d.NChart.NChartPlaced
NChartBrush	getBackground ()
	Brush filling the background of the text container. More...

void	setBackground (NChartBrush background)
	For details see getBackground().

int	getBorderColor ()
	Color of the border that is drawn around the text container.

void	setBorderColor (int borderColor)
	For details see getBorderColor().

float	getBorderRadius ()
	Corner rounding radius (in pixels) of the border that is drawn around the text container.

void	setBorderRadius (float borderRadius)
	For details see getBorderRadius().

float	getBorderThickness ()
	Thickness of the border (in pixels) that is drawn around the text container.

void	setBorderThickness (float borderThickness)
	For details see getBorderThickness().

NChartMargin	getMargin ()
	Margin of the text container in pixels (spacing from the bounds of the enclosing area).

void	setMargin (NChartMargin margin)
	For details see getMargin().

NChartMargin	getPadding ()
	Padding of the text container in pixels (spacing to sub-areas).

void	setPadding (NChartMargin padding)
	For details see getPadding().

float	getOpacity ()
	Opacity of the text container. More...

void	setOpacity (float opacity)
	For details see getOpacity().

Public Member Functions inherited from com.nchart3d.NChart.NChartObject
boolean	isVisible ()
	Flag that determines if the object is visible or not. More...

void	setVisible (boolean visible)
	For details see isVisible().

NChart	getChart ()
	Chart the object belongs to. More...

Detailed Description

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

Constructor & Destructor Documentation

com.nchart3d.NChart.NChartScaleLegend.NChartScaleLegend ( NChartBrushScale scale )

inline

Create scale legend with given brush scale.

Parameters

scale - brush scale for the scale legend.

Member Function Documentation

PointF com.nchart3d.NChart.NChartScaleLegend.getMarkerSize ( )

inline

Size of legend markers (in pixels).

The default value is 30x15.

NChartBrushScale com.nchart3d.NChart.NChartScaleLegend.getScale ( )

inline

Brush scale associated with the scale legend.

The default value is null.

See also: NChartBrushScale

boolean com.nchart3d.NChart.NChartScaleLegend.isContinuous ( )

inline

Flag determining if the legend displays continuous gradient (true) or discrete color steps (false).

The default value is false.

boolean com.nchart3d.NChart.NChartScaleLegend.isDescending ( )

inline

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.

boolean com.nchart3d.NChart.NChartScaleLegend.showLowerBoundary ( )

inline

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.

boolean com.nchart3d.NChart.NChartScaleLegend.showMiddleValues ( )

inline

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.

boolean com.nchart3d.NChart.NChartScaleLegend.showUpperBoundary ( )

inline

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.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation