ISCIDataSeries Protocol Reference


                        
                        
                        xRange

Gets the total extents of the ISCIDataSeries in the Y direction.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIRange> _Nonnull xRange;

Swift

var xRange: any ISCIRange { get }


                        
                        
                        yRange

Gets the total extents of the ISCIDataSeries in the Y direction.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIRange> _Nonnull yRange;

Swift

var yRange: any ISCIRange { get }


                        
                        
                        dataSeriesType

Gets the SCIDataSeriesType for this DataSeries.

Declaration

Objective-C

@property (nonatomic, readonly) SCIDataSeriesType dataSeriesType;

Swift

var dataSeriesType: SCIDataSeriesType { get }


                        
                        
                        xMin

Gets the computed Minimum value in X for this series.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIComparable> _Nonnull xMin;

Swift

var xMin: any ISCIComparable { get }


                        
                        
                        xMax

Gets the computed Maximum value in X for this series.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIComparable> _Nonnull xMax;

Swift

var xMax: any ISCIComparable { get }


                        
                        
                        yMin

Gets the computed Minimum value in Y for this series.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIComparable> _Nonnull yMin;

Swift

var yMin: any ISCIComparable { get }


                        
                        
                        yMax

Gets the computed Maximum value in Y for this series.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIComparable> _Nonnull yMax;

Swift

var yMax: any ISCIComparable { get }


                        
                        
                        isFifo

Gets whether the series behaves as a FIFO.

Note

If YES - when the FifoCapacity is reached, old points will be discarded in favour of new points, resulting in a scrolling chart.

Declaration

Objective-C

@property (nonatomic, readonly) BOOL isFifo;

Swift

var isFifo: Bool { get }


                        
                        
                        fifoCapacity

Defines the size of the FIFO buffer.

Note

If fifoCapacity = 0 - then the series is unlimited. If a value is set, when the point count reaches this value, older points will be discarded.

Declaration

Objective-C

@property (nonatomic) NSInteger fifoCapacity;

Swift

var fifoCapacity: Int { get set }


                        
                        
                        acceptsUnsortedData

Defines the value indicating whether this series accepts unsorted data.

Warning

If it is NO, the DataSeries will throw exception is unsorted data is appended. Unintentional unsorted data can result in much slower performance. To disable this check - set this property to YES;

Declaration

Objective-C

@property (nonatomic) BOOL acceptsUnsortedData;

Swift

var acceptsUnsortedData: Bool { get set }


                        
                        
                        xType

Gets the type of the X-Data.

Declaration

Objective-C

@property (nonatomic, readonly) SCIDataType xType;

Swift

var xType: SCIDataType { get }


                        
                        
                        yType

Gets the type of the Y-Data.

Declaration

Objective-C

@property (nonatomic, readonly) SCIDataType yType;

Swift

var yType: SCIDataType { get }


                        
                        
                        xMath

Gets the ISCIMath instance for operations with X-Data.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIMath> _Nonnull xMath;

Swift

var xMath: any ISCIMath { get }


                        
                        
                        yMath

Gets the ISCIMath instance for operations with Y-Data.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIMath> _Nonnull yMath;

Swift

var yMath: any ISCIMath { get }


                        
                        
                        lock

Gets a synchronization object used to lock this data-series. Also locked on append, update, remove or clear.

Declaration

Objective-C

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

Swift

var lock: any ISCIReadWriteLock { get }


                        
                        
                        -getWindowYRangeWithXCoordCalc:getPositiveRange:

Gets the YRange of the data (min, max of the series) in the input visible range point range, where the input range is the ISCIAxisCore.visibleRange.

Declaration

Objective-C

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

Swift

func getWindowYRange(withXCoordCalc xCoordCalc: any ISCICoordinateCalculator, getPositiveRange: Bool) -> any ISCIRange

Parameters

`xCoordCalc`	The X CoordinateCalculator currently used by corresponding XAxis.
`getPositiveRange`	If YES, returns the `ISCIRange` which has positive values, e.g., when viewing a logarithmic chart this value might be set.

Return Value

The windowed yRange for specified xRange.


                        
                        
                        -getWindowYRangeWithIndexRange:getPositiveRange:

Gets the YRange of the data (min, max of the series) in the input IndexRange, where indices are point-indices on the DataSeries columns.

Declaration

Objective-C

- (nonnull id<ISCIRange>)getWindowYRangeWithIndexRange:
                             (nonnull SCIIndexRange *)xIndexRange
                                      getPositiveRange:(BOOL)getPositiveRange;

Swift

func getWindowYRange(with xIndexRange: SCIIndexRange, getPositiveRange: Bool) -> any ISCIRange

Parameters

`xIndexRange`	The XAxis indices currently in view.
`getPositiveRange`	If YES, returns the `ISCIRange` which has positive values, e.g., when viewing a logarithmic chart this value might be set.

Return Value

The windowed yRange for specified xIndexRange.


                        
                        
                        -getWindowXRangeWithIndexRange:getPositiveRange:

Gets the XRange of the data (min, max of the series) in the input IndexRange, where indices are point-indices on the DataSeries columns.

Declaration

Objective-C

- (nonnull id<ISCIRange>)getWindowXRangeWithIndexRange:
                             (nonnull SCIIndexRange *)yIndexRange
                                      getPositiveRange:(BOOL)getPositiveRange;

Swift

func getWindowXRange(with yIndexRange: SCIIndexRange, getPositiveRange: Bool) -> any ISCIRange

Parameters

`yIndexRange`	The YAxis indices currently in view.
`getPositiveRange`	If YES, returns the `ISCIRange` which has positive values, e.g., when viewing a logarithmic chart this value might be set.

Return Value

The windowed xRange for specified yIndexRange.


                        
                        
                        -getIndicesXRange:xCoordinateCalculator:

Sets the integer indices of the XValues array that are currently in the range passed in with xCoordinateCalculator, and an indefinite range otherwise.

Declaration

Objective-C

- (void)getIndicesXRange:(nonnull SCIIndexRange *)xIndicesRange
    xCoordinateCalculator:
        (nonnull id<ISCICoordinateCalculator>)xCoordinateCalculator;

Swift

func getIndicesXRange(_ xIndicesRange: SCIIndexRange, xCoordinateCalculator: any ISCICoordinateCalculator)

Parameters

`xIndicesRange`	The index range to set.
`xCoordinateCalculator`	The current `ISCICoordinateCalculator` of XAxis.


                        
                        
                        -getIndicesYRange:yCoordinateCalculator:

Sets the integer indices of the YValues array that are currently in the range passed in with yCoordinateCalculator, and an indefinite range otherwise.

Declaration

Objective-C

- (void)getIndicesYRange:(nonnull SCIIndexRange *)yIndicesRange
    yCoordinateCalculator:
        (nonnull id<ISCICoordinateCalculator>)yCoordinateCalculator;

Swift

func getIndicesYRange(_ yIndicesRange: SCIIndexRange, yCoordinateCalculator: any ISCICoordinateCalculator)

Parameters

`yIndicesRange`	The index range to set.
`yCoordinateCalculator`	The current `ISCICoordinateCalculator` of YAxis.