SCILegendModifier Class Reference

Defines a custom chart modifier which shows a Legend on the SCIChartSurface and also can provide a data-source via SCILegendModifier::sourceMode property. More...

#import <SCILegendModifier.h>

Inheritance diagram for SCILegendModifier:
SCIChartModifierBase <SCIThemeableProtocol> <SCIChartModifierProtocol>

Instance Methods

(instancetype) - initWithLegend:
 Creates a new instance of SCILegendModifier class. More...
 
(instancetype) - initWithLegend:dataSource:useAutoPlacement:
 Creates a new instance of SCILegendModifier class. More...
 
- Instance Methods inherited from <SCIChartModifierProtocol>
(id< SCIAxis2DProtocol >) - xAxis
 
(id< SCIAxis2DProtocol >) - yAxis
 
(SCIAxisCollection *) - xAxes
 
(SCIAxisCollection *) - yAxes
 
(id< SCIAxis2DProtocol >) - getXAxis:
 
(id< SCIAxis2DProtocol >) - getYAxis:
 
(void) - resetInertia
 
(void) - draw
 
(void) - onAttached
 
(void) - onDetached
 
- Instance Methods inherited from <SCIThemeableProtocol>
(void) - applyThemeProvider:
 Applies specified theme to current instance. More...
 

Properties

SCILegendPosition position
 Gets or sets the position of the current SCILegendModifier instance. More...
 
SCIOrientation orientation
 Gets or sets the orientation of the current SCILegendModifier instance. More...
 
BOOL showLegend
 Gets or sets whether the legend should be displayed. More...
 
BOOL showCheckBoxes
 Gets or sets whether the legend should display checkboxes. More...
 
BOOL showSeriesMarkers
 Gets or sets whether the legend should display series markers. More...
 
SCISourceMode sourceMode
 Gets or sets the SCISourceMode value for legend. More...
 
- Properties inherited from <SCIChartModifierProtocol>
id< SCIChartSurfaceProtocolparentSurface
 
BOOL isAttached
 
BOOL isEnabled
 
NSString * modifierName
 
BOOL autoPassAreaCheck
 

Detailed Description

Defines a custom chart modifier which shows a Legend on the SCIChartSurface and also can provide a data-source via SCILegendModifier::sourceMode property.

Method Documentation

◆ initWithLegend:()

- (instancetype) initWithLegend: (SCIChartLegend *)  legend

Creates a new instance of SCILegendModifier class.

Parameters
legendThe SCIChartLegend instance which should be used by this modifier.

◆ initWithLegend:dataSource:useAutoPlacement:()

- (instancetype) initWithLegend: (SCIChartLegend *)  legend
dataSource: (SCILegendDataSource *)  dataSource
useAutoPlacement: (BOOL)  useAutoPlacement 

Creates a new instance of SCILegendModifier class.

Parameters
legendThe SCIChartLegend instance which should be used by this modifier.
dataSourceThe SCILegendDataSource instance which should be used by legend.
useAutoPlacementIf true modifier will try to place legend inside chart, otherwise legend is already placed somewhere and shouldn't be moved.

Property Documentation

◆ orientation

- (SCIOrientation) orientation
readwritenonatomicassign

Gets or sets the orientation of the current SCILegendModifier instance.

◆ position

- (SCILegendPosition) position
readwritenonatomicassign

Gets or sets the position of the current SCILegendModifier instance.

◆ showCheckBoxes

- (BOOL) showCheckBoxes
readwritenonatomicassign

Gets or sets whether the legend should display checkboxes.

◆ showLegend

- (BOOL) showLegend
readwritenonatomicassign

Gets or sets whether the legend should be displayed.

◆ showSeriesMarkers

- (BOOL) showSeriesMarkers
readwritenonatomicassign

Gets or sets whether the legend should display series markers.

◆ sourceMode

- (SCISourceMode) sourceMode
readwritenonatomicassign

Gets or sets the SCISourceMode value for legend.


The documentation for this class was generated from the following file: