iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

ISCIRenderableSeries

@protocol
    ISCIRenderableSeries <ISCIRenderableSeriesCore, ISCIDrawable, ISCIUpdatable,
                          ISCIThemeable, ISCIRenderSurfaceChangedListener>

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.

See

SCIRenderableSeriesBase.

See

ISCIDataSeries.

See

ISCIPointMarker.

See

SCIFastLineRenderableSeries.

See

SCIFastMountainRenderableSeries.

See

SCIFastColumnRenderableSeries.

See

SCIFastCandlestickRenderableSeries.

See

SCIFastImpulseRenderableSeries.

See

SCIXyScatterRenderableSeries.

  • Provides the color which represents this ISCIRenderableSeries instance.

    Declaration

    Objective-C

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

  • Gets or sets the stroke style of this renderable series instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) SCIPenStyle *_Nonnull strokeStyle;

  • 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 (nonatomic, copy) NSString *_Nonnull xAxisId;

  • 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 (nonatomic, copy) NSString *_Nonnull yAxisId;

  • Gets the X-Axis that this ISCIRenderableSeries is associated with.

    Declaration

    Objective-C

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

  • Gets the Y-Axis that this ISCIRenderableSeries is associated with.

    Declaration

    Objective-C

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

  • Defines the SCIResamplingMode used when drawing this series.

    Declaration

    Objective-C

    @property (nonatomic) SCIResamplingMode resamplingMode;

  • Provides the current ISCISeriesRenderPassData instance which is used for render pass.

    Declaration

    Objective-C

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

  • Defines the ISCIPointMarker for this renderable series.

    Declaration

    Objective-C

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

  • Defines the ISCISeriesInfoProvider instance associated with this series.

    Declaration

    Objective-C

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

  • Defines the ISCIRenderPassDataTransformation instance associated with this series.

    Declaration

    Objective-C

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

  • Defines the ISCIPaletteProvider instance associated with this series.

    Declaration

    Objective-C

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

  • 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 (nonatomic, strong, nullable) id<ISCIDataSeries> dataSeries;

  • Gets whether this renderable series has data series to draw. YES - if has data series to draw.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL hasDataSeries;

  • Gets the ISCIReadWriteLock instance to lock render pass data

    Declaration

    Objective-C

    @property (nonatomic, readonly) id<ISCIReadWriteLock> _Nonnull renderPassDataLock;

  • Gets the ISCIReadWriteLock instance to lock data series

    Declaration

    Objective-C

    @property (nonatomic, readonly) id<ISCIReadWriteLock> _Nonnull dataSeriesLock;

  • 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;

    Return Value

    The XRange of this series.

  • Sets the category data range (range of indices used by SCICategoryAxisBase 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

    - (void)getCategoryXRange:(nonnull id<ISCIRange>)categoryXRange;

    Parameters

    categoryXRange

    The category XRange instance to set based on value of this series

  • Returns the data range of the ISCIRenderableSeries on Y 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>)getYRange;

    Return Value

    The Y-Range 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;

    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;

    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;

    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;

    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;

    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.

  • Asynchronously requests invalidate of renderPassData provided by ISCISeriesRenderPassData and then invalidates this renderable series.

    Declaration

    Objective-C

    - (void)invalidateRenderPassData;

© 2023 SciChart. All rights reserved. (Last updated: 2023-01-23)

Generated by jazzy ♪♫ v0.13.6, a Realm project.