iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x
SCILegendModifier
@interface SCILegendModifier : SCIChartModifierBase <ISCIThemeable>
Defines a custom chart modifier which shows a Legend on the SCIChartSurface
and also can provide a data-source via sourceMode
property.
-
Gets or sets the position of the current
SCILegendModifier
instance.Declaration
Objective-C
@property (nonatomic) SCIAlignment position;
Swift
var position: SCIAlignment { get set }
-
Gets or sets the margins to position of the current ‘SCILegendModifier’ instance
Declaration
Objective-C
@property (nonatomic) UIEdgeInsets margins;
Swift
var margins: UIEdgeInsets { get set }
-
Gets or sets the orientation of the current
SCILegendModifier
instance.Declaration
Objective-C
@property (nonatomic) SCIOrientation orientation;
Swift
var orientation: SCIOrientation { get set }
-
Gets or sets whether the legend should be displayed.
Declaration
Objective-C
@property (nonatomic) BOOL showLegend;
Swift
var showLegend: Bool { get set }
-
Gets or sets whether the legend should display checkboxes.
Declaration
Objective-C
@property (nonatomic) BOOL showCheckBoxes;
Swift
var showCheckBoxes: Bool { get set }
-
Gets or sets whether the legend should display series markers.
Declaration
Objective-C
@property (nonatomic) BOOL showSeriesMarkers;
Swift
var showSeriesMarkers: Bool { get set }
-
Gets or sets the
SCISourceMode
value for legend.Declaration
Objective-C
@property (nonatomic) SCISourceMode sourceMode;
Swift
var sourceMode: SCISourceMode { get set }
-
Creates a new instance of
SCILegendModifier
class.Declaration
Objective-C
- (nonnull instancetype)initWithLegend:(nonnull SCIChartLegend *)legend;
Swift
convenience init(legend: SCIChartLegend)
Parameters
legend
The
SCIChartLegend
instance which should be used by this modifier. -
Creates a new instance of
SCILegendModifier
class.Declaration
Objective-C
- (nonnull instancetype)initWithLegend:(nonnull SCIChartLegend *)legend dataSource:(nonnull SCILegendDataSource *)dataSource useAutoPlacement:(BOOL)useAutoPlacement;
Swift
init(legend: SCIChartLegend, dataSource: SCILegendDataSource, useAutoPlacement: Bool)
Parameters
legend
The
SCIChartLegend
instance which should be used by this modifier.dataSource
The
SCILegendDataSource
instance which should be used by legend.useAutoPlacement
If true modifier will try to place legend inside chart, otherwise legend is already placed somewhere and shouldn’t be moved.
-
Refreshes content of the legend with up-to-date values
Declaration
Objective-C
- (void)updateLegend;
Swift
func updateLegend()