iOS Charting Documentation - SciChart iOS Charts SDK v3.x

ISCIRenderableSeries

Defines the protocol for all RenderableSeries within SciChart.

Note

Renderable series is charts visual part. For it to be displayed you have to attach renderable series to SCIChartSurface, setup axes ID and provide data series.
  • Provides the color which represents this ISCIRenderableSeries instance.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) UIColor *_Nonnull seriesColor;

    Swift

    var seriesColor: UIColor { get }
  • Gets or sets the stroke style of this renderable series instance.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) SCIPenStyle *strokeStyle;

    Swift

    var strokeStyle: SCIPenStyle? { get set }
  • Gets or sets the id of XAxis that this ISCIRenderableSeries is associated with.

    Warning

    Make sure that axis with given ID attached to SCIChartSurface.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSString *_Nonnull xAxisId;

    Swift

    var xAxisId: String { get set }
  • Gets or sets the id of YAxis that this ISCIRenderableSeries is associated with.

    Warning

    Make sure that axis with given ID attached to SCIChartSurface.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSString *_Nonnull yAxisId;

    Swift

    var yAxisId: String { get set }
  • Gets the X-Axis that this ISCIRenderableSeries is associated with.

    Declaration

    Objective-C

    @property (readonly, nonatomic) id<ISCIAxis> _Nullable xAxis;

    Swift

    weak var xAxis: ISCIAxis? { get }
  • Gets the Y-Axis that this ISCIRenderableSeries is associated with.

    Declaration

    Objective-C

    @property (readonly, nonatomic) id<ISCIAxis> _Nullable yAxis;

    Swift

    weak var yAxis: ISCIAxis? { get }
  • Defines the SCIResamplingMode used when drawing this series.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) SCIResamplingMode resamplingMode;

    Swift

    var resamplingMode: SCIResamplingMode { get set }
  • Provides the current ISCISeriesRenderPassData instance which is used for render pass.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic)
        id<ISCISeriesRenderPassData> _Nonnull currentRenderPassData;

    Swift

    var currentRenderPassData: ISCISeriesRenderPassData { get }
  • Defines the ISCIPointMarker for this renderable series.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) id<ISCIPointMarker>
        pointMarker;

    Swift

    var pointMarker: ISCIPointMarker? { get set }
  • Defines the ISCISeriesInfoProvider instance associated with this series.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        id<ISCISeriesInfoProvider> _Nonnull seriesInfoProvider;

    Swift

    var seriesInfoProvider: ISCISeriesInfoProvider { get set }
  • Defines the ISCIRenderPassDataTransformation instance associated with this series.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        id<ISCIRenderPassDataTransformation>
            renderPassDataTransformation;

    Swift

    var renderPassDataTransformation: ISCIRenderPassDataTransformation? { get set }
  • Defines the ISCIPaletteProvider instance associated with this series.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) id<ISCIPaletteProvider>
        paletteProvider;

    Swift

    var paletteProvider: ISCIPaletteProvider? { get set }
  • Defines the ISCIDataSeries associated with this series.

    Warning

    Make sure that data series type is suitable for specific given renderable series. Check in documentation for specific renderable series.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) id<ISCIDataSeries> dataSeries;

    Swift

    var dataSeries: ISCIDataSeries? { get set }
  • Gets whether this renderable series has data series to draw. YES - if has data series to draw.

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL hasDataSeries;

    Swift

    var hasDataSeries: Bool { get }
  • Returns the data range of the ISCIRenderableSeries on X direction by querying the associated data series. Individual RenderableSeries implementations may override this method to provide custom ranging on per-series basis.

    Declaration

    Objective-C

    - (nonnull id<ISCIRange>)getXRange;

    Swift

    func getXRange() -> ISCIRange

    Return Value

    The XRange of this series.

  • Returns the data range of the ISCIRenderableSeries on Y direction by querying the associated data series.

    Declaration

    Objective-C

    - (nonnull id<ISCIRange>)getYRange:
                                 (nonnull id<ISCICoordinateCalculator>)xCoordCalc
                              positive:(BOOL)getPositiveRange;

    Swift

    func getYRange(_ xCoordCalc: ISCICoordinateCalculator, positive getPositiveRange: Bool) -> ISCIRange

    Parameters

    xCoordCalc

    The XAxis coordinate calculator currently used.

    getPositiveRange

    Indicates whether to return positive YRange only.

    Return Value

    The YRange of this series.

  • Performs a hit-test at the specific point (x,y coordinate) on the parent renderableSeries area.

    Declaration

    Objective-C

    - (void)hitTest:(nonnull SCIHitTestInfo *)hitTestResult at:(CGPoint)point;

    Swift

    func hitTest(_ hitTestResult: SCIHitTestInfo, at point: CGPoint)

    Parameters

    hitTestResult

    The SCIHitTestInfo instance where result of hit-test should be stored.

    point

    The x-y coordinates in pixels relative to parent renderableSeries area.

  • Performs a hit-test at the specific point (x,y coordinate) on the parent renderableSeries area.

    Declaration

    Objective-C

    - (void)hitTest:(nonnull SCIHitTestInfo *)hitTestResult
                       at:(CGPoint)point
        withHitTestRadius:(float)hitTestRadius;

    Swift

    func hitTest(_ hitTestResult: SCIHitTestInfo, at point: CGPoint, withHitTestRadius hitTestRadius: Float)

    Parameters

    hitTestResult

    The SCIHitTestInfo instance where result of hit-test should be stored.

    point

    The x-y coordinates in pixels relative to parent renderableSeries area.

    hitTestRadius

    The radius in pixels to determine whether hit point is over a data point.

  • Performs a hit-test at the specific point with zero hit-test radius. Method consider only X values and returns the closes X value.

    Declaration

    Objective-C

    - (void)verticalSliceHitTest:(nonnull SCIHitTestInfo *)hitTestResult
                              at:(CGPoint)point;

    Swift

    func verticalSliceHitTest(_ hitTestResult: SCIHitTestInfo, at point: CGPoint)

    Parameters

    hitTestResult

    The SCIHitTestInfo instance where result of hit-test should be stored.

    point

    The x-y coordinates in pixels relative to parent renderableSeries area.

  • Called during render pass and updates current render pass data.

    Declaration

    Objective-C

    - (void)updateRenderPassDataWithXAxis:(nonnull id<ISCIAxis>)xAxis
                                    yAxis:(nonnull id<ISCIAxis>)yAxis
                          renderPassState:
                              (nonnull SCIRenderPassState *)renderPassState;

    Swift

    func updateRenderPassData(withXAxis xAxis: ISCIAxis, yAxis: ISCIAxis, renderPassState: SCIRenderPassState)

    Parameters

    xAxis

    The X-Axis instance that this ISCIRenderableSeries is associated with.

    yAxis

    The Y-Axis instance that this ISCIRenderableSeries is associated with.

    renderPassState

    The current render pass state.