iOS Charting Documentation - SciChart iOS Charts SDK v3.x

SCILegendModifier3D

@interface SCILegendModifier3D : SCIChartModifier3DBase

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

  • Defines the position of the current SCILegendModifier3D instance.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        SCIAlignment position;

    Swift

    var position: SCIAlignment { get set }
  • Defines the orientation of the current SCILegendModifier instance.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        SCIOrientation orientation;

    Swift

    var orientation: SCIOrientation { get set }
  • Defines the value indicating whether the legend should be displayed.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL showLegend;

    Swift

    var showLegend: Bool { get set }
  • Defines the value indicating whether the legend should display checkboxes.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL showCheckBoxes;

    Swift

    var showCheckBoxes: Bool { get set }
  • Defines the value indicating whether the legend should display series markers.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        BOOL showSeriesMarkers;

    Swift

    var showSeriesMarkers: Bool { get set }
  • Defines the SCISourceMode value for legend.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        SCISourceMode sourceMode;

    Swift

    var sourceMode: SCISourceMode { get set }
  • Creates a new instance of SCILegendModifier3D class.

    Declaration

    Objective-C

    - (instancetype)initWithLegend:(SCIChartLegend *)legend;

    Swift

    init!(legend: SCIChartLegend!)

    Parameters

    legend

    The SCIChartLegend instance which should be used by this modifier.

  • Creates a new instance of SCILegendModifier3D class.

    Declaration

    Objective-C

    - (instancetype)initWithLegend:(SCIChartLegend *)legend
                        dataSource:(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.