Class XDataSeries<TX,TY>
Defines a base data series class which contains X values
Implements
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class XDataSeries<TX,TY> extends dataSeries.DataSeries<TX,TY> implements dataSeries.IXDataSeriesValues<TX,TY>
Type Parameters
Name | Description |
---|---|
TX | |
TY |
Constructors
XDataSeries(Class<TX> xType, Class<TY> yType, IDataDistributionCalculator<TX> dataDistributionCalculator)
Creates a new instance of XDataSeries class
Declaration
protected XDataSeries(Class<TX> xType, Class<TY> yType, IDataDistributionCalculator<TX> dataDistributionCalculator)
Parameters
Type | Name | Description |
---|---|---|
Class<TX> | xType | The type of X-Data |
Class<TY> | yType | The type of Y-Data |
IDataDistributionCalculator<TX> | dataDistributionCalculator | The IDataDistributionCalculator instance for this series |
Fields
dataDistributionCalculator
Declaration
protected final IDataDistributionCalculator<TX> dataDistributionCalculator
Field Value
Type | Description |
---|---|
IDataDistributionCalculator<TX> |
xColumn
Declaration
protected ISciList<TX> xColumn
Field Value
Type | Description |
---|---|
ISciList<TX> |
Methods
clear(boolean retainValues)
Clears the series, resetting internal lists to zero size.
Declaration
public final void clear(boolean retainValues)
Parameters
Type | Name | Description |
---|---|---|
boolean | retainValues |
clearColumns()
Clears content of series without recreation of internal lists
Declaration
protected void clearColumns()
getCount()
Gets the number of points in this series.
Declaration
public int getCount()
Returns
Type | Description |
---|---|
int |
getFifoCapacity()
Gets the size of the FIFO buffer. If null, then the series is unlimited. If a value is set, when the point count reaches this value, older points will be discarded.
Declaration
public final Integer getFifoCapacity()
Returns
Type | Description |
---|---|
Integer |
getIndicesXRange(IndexRange xIndicesRange, coordinateCalculators.ICoordinateCalculator 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
public final void getIndicesXRange(IndexRange xIndicesRange, coordinateCalculators.ICoordinateCalculator xCoordinateCalculator)
Parameters
Type | Name | Description |
---|---|---|
IndexRange | xIndicesRange | |
coordinateCalculators.ICoordinateCalculator | xCoordinateCalculator |
getIndicesXRange(IndexRange indicesRange, double xMinAsDouble, double xMaxAsDouble, boolean isCategoryAxis)
Sets the integer indices of the XValues array that are currently in the range passed in with xCoordinateCalculator, and an indefinite range otherwise.
Declaration
protected void getIndicesXRange(IndexRange indicesRange, double xMinAsDouble, double xMaxAsDouble, boolean isCategoryAxis)
Parameters
Type | Name | Description |
---|---|---|
IndexRange | indicesRange | The index range to set |
double | xMinAsDouble | The min value of XAxis visible range |
double | xMaxAsDouble | The max value of XAxis visible range |
boolean | isCategoryAxis | If true XAxis is a category axis |
getIndicesYRange(IndexRange yIndicesRange, coordinateCalculators.ICoordinateCalculator 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
public final void getIndicesYRange(IndexRange yIndicesRange, coordinateCalculators.ICoordinateCalculator yCoordinateCalculator)
Parameters
Type | Name | Description |
---|---|---|
IndexRange | yIndicesRange | |
coordinateCalculators.ICoordinateCalculator | yCoordinateCalculator |
getWindowedYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean 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 IAxisCore#getVisibleRange()
Declaration
public final IRange<TY> getWindowedYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean getPositiveRange)
Parameters
Type | Name | Description |
---|---|---|
coordinateCalculators.ICoordinateCalculator | xCoordCalc | |
boolean | getPositiveRange |
Returns
Type | Description |
---|---|
IRange<TY> |
getXValues()
Gets the X Values of this series
Declaration
public ISciList<TX> getXValues()
Returns
Type | Description |
---|---|
ISciList<TX> |
initColumns()
Creates internal lists
Declaration
protected void initColumns()
initColumnsAsFifo(int fifoCapacity)
Creates internal list as FIFO
Declaration
protected void initColumnsAsFifo(int fifoCapacity)
Parameters
Type | Name | Description |
---|---|---|
int | fifoCapacity | The FIFO capacity of lists |
isDataEvenlySpaced()
Declaration
public final boolean isDataEvenlySpaced()
Returns
Type | Description |
---|---|
boolean |
isDataSortedAscending()
Declaration
public final boolean isDataSortedAscending()
Returns
Type | Description |
---|---|
boolean |
isFifo()
Gets whether the series behaves as a FIFO. If True, when the FifoCapacity is reached, old points will be discarded in favour of new points, resulting in a scrolling chart.
Declaration
public final boolean isFifo()
Returns
Type | Description |
---|---|
boolean |
setFifoCapacity(Integer fifoCapacity)
Sets the size of the FIFO buffer. If null, then the series is unlimited. If a value is set, when the point count reaches this value, older points will be discarded.
Declaration
public final void setFifoCapacity(Integer fifoCapacity)
Parameters
Type | Name | Description |
---|---|---|
Integer | fifoCapacity |
updateXRange(IRange<TX> xRange)
Sets the total extents of the IDataSeries in the X direction.
Declaration
protected void updateXRange(IRange<TX> xRange)
Parameters
Type | Name | Description |
---|---|---|
IRange<TX> | xRange |