Class OhlcDataSeries<TX,TY>
A DataSeries to store OHLC data-points, containing X and Y-Open, Y-High, Y-Low, Y-Close values. See Also: com.scichart.charting.visuals.renderableSeries.OhlcRenderableSeriesBase, com.scichart.charting.visuals.renderableSeries.FastCandlestickRenderableSeries, com.scichart.charting.visuals.renderableSeries.FastOhlcRenderableSeries
Inheritance
Implements
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class OhlcDataSeries<TX,TY> extends dataSeries.XDataSeries<TX,TY> implements dataSeries.IOhlcDataSeries<TX,TY>, dataSeries.IXyDataSeriesValues<TX,TY>
Type Parameters
| Name | Description |
|---|---|
| TX | |
| TY |
Constructors
OhlcDataSeries(Class<TX> xType, Class<TY> yType)
Creates a new Instance of OhlcDataSeries class
Declaration
public OhlcDataSeries(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 (Open, High, Low, Close) Data (TY) |
OhlcDataSeries(Class<TX> xType, Class<TY> yType, IDataDistributionCalculator<TX> dataDistributionCalculator)
Creates a new Instance of OhlcDataSeries class
Declaration
public OhlcDataSeries(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 (Open, High, Low, Close) 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 open, TY high, TY low, TY close)
Append X, Open, High, Low and Close value to the series
Declaration
public void append(TX x, TY open, TY high, TY low, TY close)
Parameters
| Type | Name | Description |
|---|---|---|
| TX | x | |
| TY | open | |
| TY | high | |
| TY | low | |
| TY | close |
append(TX[] xValues, TY[] openValues, TY[] highValues, TY[] lowValues, TY[] closeValues)
Append X, Open, High, Low and Close values to the series
Declaration
public void append(TX[] xValues, TY[] openValues, TY[] highValues, TY[] lowValues, TY[] closeValues)
Parameters
| Type | Name | Description |
|---|---|---|
| TX[] | xValues | |
| TY[] | openValues | |
| TY[] | highValues | |
| TY[] | lowValues | |
| TY[] | closeValues |
append(IValues<TX> xValues, IValues<TY> openValues, IValues<TY> highValues, IValues<TY> lowValues, IValues<TY> closeValues)
Append X, Open, High, Low and Close values to the series
Declaration
public void append(IValues<TX> xValues, IValues<TY> openValues, IValues<TY> highValues, IValues<TY> lowValues, IValues<TY> closeValues)
Parameters
| Type | Name | Description |
|---|---|---|
| IValues<TX> | xValues | |
| IValues<TY> | openValues | |
| IValues<TY> | highValues | |
| IValues<TY> | lowValues | |
| IValues<TY> | closeValues |
append(Iterable<TX> xValues, Iterable<TY> openValues, Iterable<TY> highValues, Iterable<TY> lowValues, Iterable<TY> closeValues)
Append X, Open, High, Low and Close values to the series
Declaration
public void append(Iterable<TX> xValues, Iterable<TY> openValues, Iterable<TY> highValues, Iterable<TY> lowValues, Iterable<TY> closeValues)
Parameters
| Type | Name | Description |
|---|---|---|
| Iterable<TX> | xValues | |
| Iterable<TY> | openValues | |
| Iterable<TY> | highValues | |
| Iterable<TY> | lowValues | |
| Iterable<TY> | closeValues |
clearColumns()
Clears content of series without recreation of internal lists
Declaration
protected void clearColumns()
Overrides
getCloseValues()
Gets the High Values of this series
Declaration
public ISciList<TY> getCloseValues()
Returns
| Type | Description |
|---|---|
| ISciList<TY> |
getDataSeriesType()
Gets the DataSeriesType for this DataSeries.
Declaration
public dataSeries.DataSeriesType getDataSeriesType()
Returns
| Type | Description |
|---|---|
| dataSeries.DataSeriesType |
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 High Values of this series
Declaration
public ISciList<TY> getLowValues()
Returns
| Type | Description |
|---|---|
| ISciList<TY> |
getOpenValues()
Gets the High Values of this series
Declaration
public ISciList<TY> getOpenValues()
Returns
| Type | Description |
|---|---|
| ISciList<TY> |
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 IRange<TY> getWindowedYRange(IndexRange xIndexRange, boolean getPositiveRange)
Parameters
| Type | Name | Description |
|---|---|---|
| IndexRange | xIndexRange | |
| boolean | getPositiveRange |
Returns
| Type | Description |
|---|---|
| IRange<TY> |
getYValues()
Gets the Y Values of this series
Declaration
public ISciList<TY> getYValues()
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 open, TY high, TY low, TY close)
Inserts X, Open, High, Low and Close value at specified location
Declaration
public void insert(int index, TX x, TY open, TY high, TY low, TY close)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| TX | x | |
| TY | open | |
| TY | high | |
| TY | low | |
| TY | close |
insertRange(int startIndex, TX[] x, TY[] open, TY[] high, TY[] low, TY[] close)
Inserts Open, High, Low and Close values at specified location
Declaration
public void insertRange(int startIndex, TX[] x, TY[] open, TY[] high, TY[] low, TY[] close)
Parameters
| Type | Name | Description |
|---|---|---|
| int | startIndex | |
| TX[] | x | |
| TY[] | open | |
| TY[] | high | |
| TY[] | low | |
| TY[] | close |
insertRange(int startIndex, IValues<TX> x, IValues<TY> open, IValues<TY> high, IValues<TY> low, IValues<TY> close)
Inserts X, Open, High, Low and Close values at specified location
Declaration
public void insertRange(int startIndex, IValues<TX> x, IValues<TY> open, IValues<TY> high, IValues<TY> low, IValues<TY> close)
Parameters
| Type | Name | Description |
|---|---|---|
| int | startIndex | |
| IValues<TX> | x | |
| IValues<TY> | open | |
| IValues<TY> | high | |
| IValues<TY> | low | |
| IValues<TY> | close |
insertRange(int startIndex, Iterable<TX> x, Iterable<TY> open, Iterable<TY> high, Iterable<TY> low, Iterable<TY> close)
Inserts X, Open, High, Low and Close values at specified location
Declaration
public void insertRange(int startIndex, Iterable<TX> x, Iterable<TY> open, Iterable<TY> high, Iterable<TY> low, Iterable<TY> close)
Parameters
| Type | Name | Description |
|---|---|---|
| int | startIndex | |
| Iterable<TX> | x | |
| Iterable<TY> | open | |
| Iterable<TY> | high | |
| Iterable<TY> | low | |
| Iterable<TY> | close |
removeAt(int index)
Removes data points at specified location
Declaration
public void removeAt(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index |
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 |
update(int index, TY open, TY high, TY low, TY close)
Updates X, Open, High, Low and Close value at specified location
Declaration
public void update(int index, TY open, TY high, TY low, TY close)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| TY | open | |
| TY | high | |
| TY | low | |
| TY | close |
update(int index, TY[] open, TY[] high, TY[] low, TY[] close)
Updates Open, High, Low and Close values at specified location
Declaration
public void update(int index, TY[] open, TY[] high, TY[] low, TY[] close)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| TY[] | open | |
| TY[] | high | |
| TY[] | low | |
| TY[] | close |
update(int index, IValues<TY> open, IValues<TY> high, IValues<TY> low, IValues<TY> close)
Updates Open, High, Low and Close values at specified location
Declaration
public void update(int index, IValues<TY> open, IValues<TY> high, IValues<TY> low, IValues<TY> close)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| IValues<TY> | open | |
| IValues<TY> | high | |
| IValues<TY> | low | |
| IValues<TY> | close |
update(int index, Iterable<TY> open, Iterable<TY> high, Iterable<TY> low, Iterable<TY> close)
Updates Open, High, Low and Close values at specified location
Declaration
public void update(int index, Iterable<TY> open, Iterable<TY> high, Iterable<TY> low, Iterable<TY> close)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| Iterable<TY> | open | |
| Iterable<TY> | high | |
| Iterable<TY> | low | |
| Iterable<TY> | close |
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 |