NChartLegend Class Reference

Inherits from NChartPlaced : NChartObject : NSObject
Declared in NChartLegend.h

Overview

The NChartLegend class provides methods to display the legend of the chart.

  font

Font of the legend’s text.

@property (nonatomic, retain) UIFont *font

Declared In

NChartLegend.h

  textColor

Color of the legend’s text.

@property (nonatomic, retain) UIColor *textColor

Declared In

NChartLegend.h

  lineBreakMode

Line break mode of the legend’s text.

@property (nonatomic, assign) NSLineBreakMode lineBreakMode

Declared In

NChartLegend.h

  footer

Label that is placed on the bottom of the legend. It’s nil by default.

@property (nonatomic, retain) NChartLabel *footer

See Also

Declared In

NChartLegend.h

  header

Label that is placed on the top of the legend. It’s nil by default.

@property (nonatomic, retain) NChartLabel *header

See Also

Declared In

NChartLegend.h

  blockAlignment

Alignment of the legend. Please note, that if alignment is NChartLegendBlockAlignmentLeft, NChartLegendBlockAlignmentRight, NChartLegendBlockAlignmentBottom or NChartLegendBlockAlignmentTop, the border radius is ignored (assumed to be 0).

@property (nonatomic, assign) NChartLegendBlockAlignment blockAlignment

Declared In

NChartLegend.h

  contentAlignment

Alignment of legend’s content in legend’s area. The default value is NChartLegendContentAlignmentJustified.

@property (nonatomic, assign) NChartLegendContentAlignment contentAlignment

Declared In

NChartLegend.h

  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.

@property (nonatomic, assign) NSInteger columnCount

Declared In

NChartLegend.h

  shouldAutodetectColumnCount

Flag determining if columnCount should be detected automatically to ensure good-looking legend (YES) or not (NO). If this property is YES, the value set to columnCount takes no effect. The default value is NO.

@property (nonatomic, assign) BOOL shouldAutodetectColumnCount

Declared In

NChartLegend.h

  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. To be more precise, the mapping works as follows - by NChartLegendBlockAlignmentBottomLeft it is height; - by NChartLegendBlockAlignmentBottomCenter it is height; - by NChartLegendBlockAlignmentBottomRight it is height; - by NChartLegendBlockAlignmentCenterLeft it is width; - by NChartLegendBlockAlignmentCenterCenter it is ignored; - by NChartLegendBlockAlignmentCenterRight it is width; - by NChartLegendBlockAlignmentTopLeft it is height; - by NChartLegendBlockAlignmentTopCenter it is height; - by NChartLegendBlockAlignmentTopRight it is height; - by NChartLegendBlockAlignmentLeft it is width; - by NChartLegendBlockAlignmentRight it is width; - by NChartLegendBlockAlignmentBottom it is height; - by NChartLegendBlockAlignmentTop it is height.

@property (nonatomic, assign) float maxSize

Declared In

NChartLegend.h

  minimalEntriesPadding

Minimal padding between entries in pixels. The default value is 10.

@property (nonatomic, assign) float minimalEntriesPadding

Declared In

NChartLegend.h

  scrollerPadding

Padding inside the scroller.

@property (nonatomic, assign) NChartMargin scrollerPadding

Declared In

NChartLegend.h

  orientation

Orientation of the legend.

@property (nonatomic, assign) NChartLegendOrientation orientation

Declared In

NChartLegend.h

  origin

Origin of the legend. It’s a starting point that has effect only with orientation set to one of “free”-kinds.

@property (nonatomic, assign) CGPoint origin

Declared In

NChartLegend.h

  scrollBarColor

Color of the legend’s scrollbar.

@property (nonatomic, retain) UIColor *scrollBarColor

Declared In

NChartLegend.h

– setHandlerNormalColor:andPushedColor:

Set color for legend’s handler.

- (void)setHandlerNormalColor:(UIColor *)normal andPushedColor:(UIColor *)pushed

Parameters

normal
  • color for normal state.
pushed
  • color for pushed state.

Declared In

NChartLegend.h

  handlerNormalColor

Get color of legend’s handler normal state.

@property (nonatomic, readonly) UIColor *handlerNormalColor

Declared In

NChartLegend.h

  handlerPushedColor

Get color of legend’s handler pushed state.

@property (nonatomic, readonly) UIColor *handlerPushedColor

Declared In

NChartLegend.h

– setHandlerNormalImage:andPushedImage:

Set images for legend’s handler.

- (void)setHandlerNormalImage:(UIImage *)normal andPushedImage:(UIImage *)pushed

Parameters

normal
  • image for normal state.
pushed
  • image for pushed state.

Declared In

NChartLegend.h

  frame

Frame of the legend in the view’s coordinate system.

@property (nonatomic, readonly) CGRect frame

Discussion

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.

Declared In

NChartLegend.h

  userInteractionsEnabled

Flag determining if user interactions in the legend (scrolling, etc.) are enabled (YES) or disabled (NO). The default value is YES.

@property (nonatomic, assign) BOOL userInteractionsEnabled

Declared In

NChartLegend.h

  delegate

Delegate of the legend.

@property (nonatomic, assign) id<NChartLegendDelegate> delegate

Declared In

NChartLegend.h