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;


                        
                        
                        yRange

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

Declaration

Objective-C

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


                        
                        
                        dataSeriesType

Gets the SCIDataSeriesType for this DataSeries.

Declaration

Objective-C

@property (nonatomic, readonly) SCIDataSeriesType dataSeriesType;


                        
                        
                        xMin

Gets the computed Minimum value in X for this series.

Declaration

Objective-C

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


                        
                        
                        xMax

Gets the computed Maximum value in X for this series.

Declaration

Objective-C

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


                        
                        
                        yMin

Gets the computed Minimum value in Y for this series.

Declaration

Objective-C

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


                        
                        
                        yMax

Gets the computed Maximum value in Y for this series.

Declaration

Objective-C

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


                        
                        
                        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;


                        
                        
                        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;


                        
                        
                        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;


                        
                        
                        xType

Gets the type of the X-Data.

Declaration

Objective-C

@property (nonatomic, readonly) SCIDataType xType;


                        
                        
                        yType

Gets the type of the Y-Data.

Declaration

Objective-C

@property (nonatomic, readonly) SCIDataType yType;


                        
                        
                        xMath

Gets the ISCIMath instance for operations with X-Data.

Declaration

Objective-C

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


                        
                        
                        yMath

Gets the ISCIMath instance for operations with Y-Data.

Declaration

Objective-C

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


                        
                        
                        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;


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

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;

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.


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

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;

Parameters

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