Class HlDataSeries<TX,TY>
The HlcDataSeries provides a generic data-source in High-Low-Close format for HL charts as well as Error bar charts. See Also: com.scichart.charting.visuals.renderableSeries.FastFixedErrorBarsRenderableSeries, com.scichart.charting.visuals.renderableSeries.FastErrorBarsRenderableSeries, com.scichart.charting.visuals.renderableSeries.HlRenderableSeriesBase
Inheritance
Implements
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class HlDataSeries<TX,TY> extends dataSeries.XyDataSeries<TX,TY> implements dataSeries.IHlDataSeries<TX,TY>
Type Parameters
| Name | Description |
|---|---|
| TX | |
| TY |
Constructors
HlDataSeries(Class<TX> xType, Class<TY> yType)
Creates a new instance of the HlDataSeries class
Declaration
public HlDataSeries(Class<TX> xType, Class<TY> yType)
Parameters
| Type | Name | Description |
|---|---|---|
| Class<TX> | xType | The Type of X Data (TX) |
| Class<TY> | yType | The Type of Y Data (TY) |
HlDataSeries(Class<TX> xType, Class<TY> yType, IDataDistributionCalculator<TX> dataDistributionCalculator)
Creates a new instance of the HlDataSeries class
Declaration
public HlDataSeries(Class<TX> xType, Class<TY> yType, IDataDistributionCalculator<TX> dataDistributionCalculator)
Parameters
| Type | Name | Description |
|---|---|---|
| Class<TX> | xType | The Type of X Data (TX) |
| Class<TY> | yType | The Type of Y Data (TY) |
| IDataDistributionCalculator<TX> | dataDistributionCalculator | An optional DataDistributionCalculator, which can be used to specify Sorted Ascending and Evenly Spaced flags |
Methods
append(TX x, TY y, TY high, TY low)
Appends the X, Y, High and Low point to the series.
Declaration
public void append(TX x, TY y, TY high, TY low)
Parameters
| Type | Name | Description |
|---|---|---|
| TX | x | |
| TY | y | |
| TY | high | |
| TY | low |
append(TX[] xValues, TY[] yValues, TY[] high, TY[] low)
Appends an X, Y, High and Low points to the series.
Declaration
public void append(TX[] xValues, TY[] yValues, TY[] high, TY[] low)
Parameters
| Type | Name | Description |
|---|---|---|
| TX[] | xValues | |
| TY[] | yValues | |
| TY[] | high | |
| TY[] | low |
append(IValues<TX> xValues, IValues<TY> yValues, IValues<TY> high, IValues<TY> low)
Appends the X, Y, High and Low points to the series.
Declaration
public void append(IValues<TX> xValues, IValues<TY> yValues, IValues<TY> high, IValues<TY> low)
Parameters
| Type | Name | Description |
|---|---|---|
| IValues<TX> | xValues | |
| IValues<TY> | yValues | |
| IValues<TY> | high | |
| IValues<TY> | low |
append(Iterable<TX> xValues, Iterable<TY> yValues, Iterable<TY> high, Iterable<TY> low)
Appends the X, Y, High and Low points to the series.
Declaration
public void append(Iterable<TX> xValues, Iterable<TY> yValues, Iterable<TY> high, Iterable<TY> low)
Parameters
| Type | Name | Description |
|---|---|---|
| Iterable<TX> | xValues | |
| Iterable<TY> | yValues | |
| Iterable<TY> | high | |
| Iterable<TY> | low |
clearColumns()
Clears content of series without recreation of internal lists
Declaration
protected void clearColumns()
Overrides
getDataSeriesType()
Gets the DataSeriesType for this DataSeries.
Declaration
public dataSeries.DataSeriesType getDataSeriesType()
Returns
| Type | Description |
|---|---|
| dataSeries.DataSeriesType |
Overrides
getHasValues()
Gets whether the DataSeries has values(is not empty).
Declaration
public boolean getHasValues()
Returns
| Type | Description |
|---|---|
| boolean |
Overrides
getHighValues()
Gets the High Values of this series
Declaration
public ISciList<TY> getHighValues()
Returns
| Type | Description |
|---|---|
| ISciList<TY> |
getLowValues()
Gets the Low Values of this series
Declaration
public ISciList<TY> getLowValues()
Returns
| Type | Description |
|---|---|
| ISciList<TY> |
initColumns()
Creates internal lists
Declaration
protected void initColumns()
Overrides
initColumnsAsFifo(int fifoCapacity)
Creates internal list as FIFO
Declaration
protected void initColumnsAsFifo(int fifoCapacity)
Parameters
| Type | Name | Description |
|---|---|---|
| int | fifoCapacity |
Overrides
insert(int index, TX x, TY y, TY high, TY low)
Inserts the X and Y, High and Low point to the series at specified index.
Declaration
public void insert(int index, TX x, TY y, TY high, TY low)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| TX | x | |
| TY | y | |
| TY | high | |
| TY | low |
insertRange(int index, TX[] x, TY[] y, TY[] high, TY[] low)
Inserts the X and Y, High and Low points to the series at specified index.
Declaration
public void insertRange(int index, TX[] x, TY[] y, TY[] high, TY[] low)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| TX[] | x | |
| TY[] | y | |
| TY[] | high | |
| TY[] | low |
insertRange(int index, IValues<TX> x, IValues<TY> y, IValues<TY> high, IValues<TY> low)
Inserts the X and Y, High and Low points to the series at specified index.
Declaration
public void insertRange(int index, IValues<TX> x, IValues<TY> y, IValues<TY> high, IValues<TY> low)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| IValues<TX> | x | |
| IValues<TY> | y | |
| IValues<TY> | high | |
| IValues<TY> | low |
insertRange(int index, Iterable<TX> x, Iterable<TY> y, Iterable<TY> high, Iterable<TY> low)
Inserts the X and Y, High and Low points to the series at specified index.
Declaration
public void insertRange(int index, Iterable<TX> x, Iterable<TY> y, Iterable<TY> high, Iterable<TY> low)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| Iterable<TX> | x | |
| Iterable<TY> | y | |
| Iterable<TY> | high | |
| Iterable<TY> | low |
removeAt(int index)
Removes data points at specified location
Declaration
public void removeAt(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index |
Overrides
removeRange(int startIndex, int count)
Removes the range of data points
Declaration
public void removeRange(int startIndex, int count)
Parameters
| Type | Name | Description |
|---|---|---|
| int | startIndex | |
| int | count |
Overrides
update(int index, TY y, TY high, TY low)
Updates an Y, High and Low point to the series at specified index.
Declaration
public void update(int index, TY y, TY high, TY low)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| TY | y | |
| TY | high | |
| TY | low |
update(int index, TY[] y, TY[] high, TY[] low)
Updates the Y, High and Low points to the series at specified index.
Declaration
public void update(int index, TY[] y, TY[] high, TY[] low)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| TY[] | y | |
| TY[] | high | |
| TY[] | low |
update(int index, IValues<TY> y, IValues<TY> high, IValues<TY> low)
Updates the Y, High and Low points to the series at specified index.
Declaration
public void update(int index, IValues<TY> y, IValues<TY> high, IValues<TY> low)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| IValues<TY> | y | |
| IValues<TY> | high | |
| IValues<TY> | low |
update(int index, Iterable<TY> y, Iterable<TY> high, Iterable<TY> low)
Updates the Y, High and Low points to the series at specified index.
Declaration
public void update(int index, Iterable<TY> y, Iterable<TY> high, Iterable<TY> low)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| Iterable<TY> | y | |
| Iterable<TY> | high | |
| Iterable<TY> | low |
updateYRange(IRange<TY> yRange)
Sets the total extents of the IDataSeries in the Y direction.
Declaration
protected void updateYRange(IRange<TY> yRange)
Parameters
| Type | Name | Description |
|---|---|---|
| IRange<TY> | yRange |