Interface IDataSeries<TX,TY>
Defines the base interface to a DataSeries which provides a data-source for com.scichart.charting.visuals.renderableSeries.IRenderableSeries See Also: IHlDataSeries, UniformHeatmapDataSeries, IXyyDataSeries, XyzDataSeries, IRenderableSeries#setDataSeries(IDataSeries), IXyDataSeries, XyyDataSeries, OhlcDataSeries, IUniformHeatmapDataSeries, HlDataSeries, XyDataSeries, IRenderableSeries#getDataSeries(), IDataSeries, IOhlcDataSeries, IXyzDataSeries, DataSeries
Namespace:
Assembly: .dll
Syntax
public interface IDataSeries<TX,TY> extends dataSeries.IDataSeriesCore, IDataDistributionProviderType Parameters
| Name | Description |
|---|---|
| TX | |
| TY |
Methods
getAcceptsUnsortedData()
Gets the value indicating whether this series accepts unsorted data. If it is false, the DataSeries will throw exception is unsorted data is appended. Unintentional unsorted data can result in much slower performance. To disable this check, call IDataSeries#setAcceptsUnsortedData(boolean) with true passed in.
Declaration
public abstract boolean getAcceptsUnsortedData()Returns
| Type | Description |
|---|---|
| boolean | True if this series accepts unsorted data |
getDataSeriesType()
Gets the DataSeriesType for this DataSeries.
Declaration
public abstract dataSeries.DataSeriesType getDataSeriesType()Returns
| Type | Description |
|---|---|
| dataSeries.DataSeriesType | The type of this DataSeries |
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 abstract Integer getFifoCapacity()Returns
| Type | Description |
|---|---|
| Integer | The size of FIFO buffer |
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 abstract void getIndicesXRange(IndexRange xIndicesRange, coordinateCalculators.ICoordinateCalculator xCoordinateCalculator)Parameters
| Type | Name | Description |
|---|---|---|
| IndexRange | xIndicesRange | The index range to set |
| coordinateCalculators.ICoordinateCalculator | xCoordinateCalculator | The current ICoordinateCalculator of XAxis |
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 abstract void getIndicesYRange(IndexRange yIndicesRange, coordinateCalculators.ICoordinateCalculator yCoordinateCalculator)Parameters
| Type | Name | Description |
|---|---|---|
| IndexRange | yIndicesRange | The index range to set |
| coordinateCalculators.ICoordinateCalculator | yCoordinateCalculator | The current ICoordinateCalculator of YAxis |
getLock()
Gets a synchronization object used to lock this data-series. Also locked on append, update, remove or clear.
Declaration
public abstract IReadWriteLock getLock()Returns
| Type | Description |
|---|---|
| IReadWriteLock | The lock for this series |
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 abstract IRange<TY> getWindowedYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean getPositiveRange)Parameters
| Type | Name | Description |
|---|---|---|
| coordinateCalculators.ICoordinateCalculator | xCoordCalc | The X CoordinateCalculator currently used by corresponding XAxis |
| boolean | getPositiveRange | If true, returns the IRange which has positive values, e.g., when viewing a logarithmic chart this value might be set |
Returns
| Type | Description |
|---|---|
| IRange<TY> | The windowed yRange for specified xRange |
getWindowedYRange(IndexRange xIndexRange, boolean 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
public abstract IRange<TY> getWindowedYRange(IndexRange xIndexRange, boolean getPositiveRange)Parameters
| Type | Name | Description |
|---|---|---|
| IndexRange | xIndexRange | The XAxis indices currently in view |
| boolean | getPositiveRange | If true, returns the IRange which has positive values, e.g., when viewing a logarithmic chart this value might be set |
Returns
| Type | Description |
|---|---|
| IRange<TY> | The windowed yRange for specified xIndexRange |
getXMath()
Gets the IMath instance for operations with X-Data
Declaration
public abstract IMath<TX> getXMath()Returns
| Type | Description |
|---|---|
| IMath<TX> | The math instance for X-Data |
getXMax()
Gets the computed Maximum value in X for this series.
Declaration
public abstract TX getXMax()Returns
| Type | Description |
|---|---|
| TX | The maximum X for this series |
getXMin()
Gets the computed Minimum value in X for this series.
Declaration
public abstract TX getXMin()Returns
| Type | Description |
|---|---|
| TX | The minimum X for this series |
getXRange()
Gets the total extents of the IDataSeries in the X direction.
Declaration
public abstract IRange<TX> getXRange()Returns
| Type | Description |
|---|---|
| IRange<TX> | The range in the X direction |
getXType()
Gets the type of the X-Data
Declaration
public abstract Class<TX> getXType()Returns
| Type | Description |
|---|---|
| Class<TX> | X-Data type |
getYMath()
Gets the IMath instance for operations with Y-Data
Declaration
public abstract IMath<TY> getYMath()Returns
| Type | Description |
|---|---|
| IMath<TY> | The math instance for Y-Data |
getYMax()
Gets the computed Maximum value in Y for this series.
Declaration
public abstract TY getYMax()Returns
| Type | Description |
|---|---|
| TY | The maximum Y for this series |
getYMin()
Gets the computed Minimum value in Y for this series.
Declaration
public abstract TY getYMin()Returns
| Type | Description |
|---|---|
| TY | The minimum Y for this series |
getYRange()
Gets the total extents of the IDataSeries in the Y direction.
Declaration
public abstract IRange<TY> getYRange()Returns
| Type | Description |
|---|---|
| IRange<TY> | The range in the Y direction |
getYType()
Gets the type of the Y-Data
Declaration
public abstract Class<TY> getYType()Returns
| Type | Description |
|---|---|
| Class<TY> | Y-Data type |
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 abstract boolean isFifo()Returns
| Type | Description |
|---|---|
| boolean | True if this series behaves as a FIFO |
setAcceptsUnsortedData(boolean acceptsUnsortedData)
Sets the value indicating whether this series accepts unsorted data. If it is false, the DataSeries will throw exception is unsorted data is appended. Unintentional unsorted data can result in much slower performance. To disable this check pass true into this method
Declaration
public abstract void setAcceptsUnsortedData(boolean acceptsUnsortedData)Parameters
| Type | Name | Description |
|---|---|---|
| boolean | acceptsUnsortedData | The new acceptsUnsortedData value |
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 abstract void setFifoCapacity(Integer fifoCapacity)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | fifoCapacity | the new size of the FIFO buffer |