Class OhlcRenderableSeriesBase

An abstract base class for IOhlcDataSeriesValues based renderable series

Inheritance
java.lang.Object
RenderableSeriesCore
renderableSeries.BaseRenderableSeries
OhlcRenderableSeriesBase
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class OhlcRenderableSeriesBase extends renderableSeries.BaseRenderableSeries

Constructors

OhlcRenderableSeriesBase(renderableSeriesOhlcRenderPassData currentRenderPassData, renderableSeries.hitTest.IHitProvider hitProvider, renderableSeries.hitTest.INearestPointProvider nearestPointProvider)

Creates a new instance of OhlcRenderableSeriesBase class

Declaration
protected OhlcRenderableSeriesBase(renderableSeriesOhlcRenderPassData currentRenderPassData, renderableSeries.hitTest.IHitProvider hitProvider, renderableSeries.hitTest.INearestPointProvider nearestPointProvider)
Parameters
Type Name Description
renderableSeriesOhlcRenderPassData currentRenderPassData

The render pass data instance
renderableSeries.hitTest.IHitProvider hitProvider

The hit provider instance
renderableSeries.hitTest.INearestPointProvider nearestPointProvider

The nearest point provider instance

Fields

dataPointWidthProperty

Declaration
protected final SmartPropertyDouble dataPointWidthProperty
Field Value
Type Description
SmartPropertyDouble

strokeDownStyleProperty

Declaration
protected final SmartProperty<PenStyle> strokeDownStyleProperty
Field Value
Type Description
SmartProperty<PenStyle>

strokeUpStyleProperty

Declaration
protected final SmartProperty<PenStyle> strokeUpStyleProperty
Field Value
Type Description
SmartProperty<PenStyle>

Methods

applyThemeProvider(IThemeProvider themeProvider)

Applies specified theme to current instance

Declaration
public void applyThemeProvider(IThemeProvider themeProvider)
Parameters
Type Name Description
IThemeProvider themeProvider
Overrides

disposeCachedData()

This method is called when series should dispose any cached data

Declaration
protected void disposeCachedData()
Overrides

drawAsLines(IAssetManager2D assetManager, renderableSeries.ISeriesDrawingManager drawingManager, renderableSeriesOhlcRenderPassData rpd)

Draws this series as vertical lines

Declaration
protected final void drawAsLines(IAssetManager2D assetManager, renderableSeries.ISeriesDrawingManager drawingManager, renderableSeriesOhlcRenderPassData rpd)
Parameters
Type Name Description
IAssetManager2D assetManager

The IAssetManager2D for this render pass
renderableSeries.ISeriesDrawingManager drawingManager

The ISeriesDrawingManager for this render pass
renderableSeriesOhlcRenderPassData rpd

The current render pass data

getDataPointWidth()

Gets a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy

Declaration
public final double getDataPointWidth()
Returns
Type Description
double

The data point width

getSeriesColor()

Gets the color which represents this IRenderableSeries instance.

Declaration
public int getSeriesColor()
Returns
Type Description
int
Overrides

getStrokeDownStyle()

Gets the PenStyle used for wicks and outlines on down-candles (close < open)

Declaration
public final PenStyle getStrokeDownStyle()
Returns
Type Description
PenStyle

The stroke down PenStyle

getStrokeUpStyle()

Gets the PenStyle used for wicks and outlines on up-candles (close > open)

Declaration
public final PenStyle getStrokeUpStyle()
Returns
Type Description
PenStyle

The stroke up PenStyle

getXRange()

Returns the data range of the IRenderableSeries on X direction by querying the associated data series Individual RenderableSeries implementations may override this method to provide custom ranging on per-series basis

Declaration
public IRange getXRange()
Returns
Type Description
IRange
Overrides

internalUpdate(IAssetManager2D assetManager, RenderPassState renderPassState)

Updates this renderable series instances

Declaration
protected void internalUpdate(IAssetManager2D assetManager, RenderPassState renderPassState)
Parameters
Type Name Description
IAssetManager2D assetManager
RenderPassState renderPassState
Overrides

internalUpdateRenderPassData(renderableSeriesISeriesRenderPassData renderPassDataToUpdate, dataSeries.IDataSeries<?,?> dataSeries, ResamplingMode resamplingMode, IPointResamplerFactory factory)

Updates the current render pass data using the data series, resampling factory passed in

Declaration
protected void internalUpdateRenderPassData(renderableSeriesISeriesRenderPassData renderPassDataToUpdate, dataSeries.IDataSeries<?,?> dataSeries, ResamplingMode resamplingMode, IPointResamplerFactory factory)
Parameters
Type Name Description
renderableSeriesISeriesRenderPassData renderPassDataToUpdate
IDataSeries<?,?> dataSeries
ResamplingMode resamplingMode
IPointResamplerFactory factory
Overrides
Exceptions
Type Condition
Exception

isOfValidType(dataSeries.IDataSeries dataSeries)

Checks whether the data series instance is valid for this series

Declaration
protected final boolean isOfValidType(dataSeries.IDataSeries dataSeries)
Parameters
Type Name Description
IDataSeries dataSeries
Returns
Type Description
boolean
Overrides

setDataPointWidth(double dataPointWidth)

Sets a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy

Declaration
public final void setDataPointWidth(double dataPointWidth)
Parameters
Type Name Description
double dataPointWidth

The data point width

setStrokeDownStyle(PenStyle strokeStyle)

Sets the PenStyle used for wicks and outlines on down-candles (close < open)

Declaration
public final void setStrokeDownStyle(PenStyle strokeStyle)
Parameters
Type Name Description
PenStyle strokeStyle

The stroke down PenStyle

setStrokeUpStyle(PenStyle strokeStyle)

Sets the PenStyle used for wicks and outlines on up-candles (close > open)

Declaration
public final void setStrokeUpStyle(PenStyle strokeStyle)
Parameters
Type Name Description
PenStyle strokeStyle

The stroke up PenStyle

updateCategoryXRangeInternal(IRange<Double> categoryXRange, dataSeries.IDataSeries<?,?> dataSeries)

Updates specified category XRange (range of indices used by com.scichart.charting.visuals.axes.CategoryAxisBase) on X direction by querying the associated data series

Declaration
protected void updateCategoryXRangeInternal(IRange<Double> categoryXRange, dataSeries.IDataSeries<?,?> dataSeries)
Parameters
Type Name Description
IRange<Double> categoryXRange
IDataSeries<?,?> dataSeries
Overrides