Class BaseRenderableSeries
Defines the Base class for all RenderableSeries within SciChart. See Also: FastBandRenderableSeries, FastUniformHeatmapRenderableSeries, FastFixedErrorBarsRenderableSeries, FastColumnRenderableSeries, IRenderContext2D, FastCandlestickRenderableSeries, FastImpulseRenderableSeries, IAssetManager2D, FastOhlcRenderableSeries, FastErrorBarsRenderableSeries, IDataSeries, FastMountainRenderableSeries, FastLineRenderableSeries, IPointMarker
Implements
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class BaseRenderableSeries extends renderableSeries.RenderableSeriesCore implements renderableSeries.IRenderableSeries, ISciChartSurfaceProvider, dataSeries.IDataSeriesObserver
Constructors
BaseRenderableSeries(renderableSeriesISeriesRenderPassData currentRenderPassData, renderableSeries.hitTest.IHitProvider hitProvider, renderableSeries.hitTest.INearestPointProvider nearestPointProvider)
Creates a new instance of BaseRenderableSeries class
Declaration
protected BaseRenderableSeries(renderableSeriesISeriesRenderPassData currentRenderPassData, renderableSeries.hitTest.IHitProvider hitProvider, renderableSeries.hitTest.INearestPointProvider nearestPointProvider)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesISeriesRenderPassData | currentRenderPassData | The render pass data instance |
renderableSeries.hitTest.IHitProvider | hitProvider | The hit provider instance |
renderableSeries.hitTest.INearestPointProvider | nearestPointProvider | The nearest point provider instance |
Fields
TAG
Declaration
protected static final String TAG
Field Value
Type | Description |
---|---|
String |
clipToBoundsProperty
Declaration
protected final SmartPropertyBoolean clipToBoundsProperty
Field Value
Type | Description |
---|---|
SmartPropertyBoolean |
drawNaNAsProperty
Declaration
protected final SmartProperty<renderableSeries.LineDrawMode> drawNaNAsProperty
Field Value
Type | Description |
---|---|
SmartProperty<LineDrawMode> |
invalidateRenderPassDataCallback
Declaration
protected final renderableSeries.BaseRenderableSeries.InvalidateRenderPassDataCallback invalidateRenderPassDataCallback
Field Value
Type | Description |
---|---|
renderableSeries.BaseRenderableSeries.InvalidateRenderPassDataCallback |
resamplingModeProperty
Declaration
protected final SmartProperty<ResamplingMode> resamplingModeProperty
Field Value
Type | Description |
---|---|
SmartProperty<ResamplingMode> |
strokeStyleProperty
Declaration
protected final SmartProperty<PenStyle> strokeStyleProperty
Field Value
Type | Description |
---|---|
SmartProperty<PenStyle> |
xAxisIdProperty
Declaration
protected final SmartProperty<String> xAxisIdProperty
Field Value
Type | Description |
---|---|
SmartProperty<String> |
yAxisIdProperty
Declaration
protected final SmartProperty<String> yAxisIdProperty
Field Value
Type | Description |
---|---|
SmartProperty<String> |
zeroLineYProperty
Declaration
protected final SmartPropertyDouble zeroLineYProperty
Field Value
Type | Description |
---|---|
SmartPropertyDouble |
Methods
applyThemeProvider(IThemeProvider themeProvider)
Applies specified theme to current instance
Declaration
public void applyThemeProvider(IThemeProvider themeProvider)
Parameters
Type | Name | Description |
---|---|---|
IThemeProvider | themeProvider |
attachTo(IServiceContainer services)
Declaration
public void attachTo(IServiceContainer services)
Parameters
Type | Name | Description |
---|---|---|
IServiceContainer | services |
Overrides
detach()
Declaration
public void detach()
Overrides
disposeCachedData()
This method is called when series should dispose any cached data
Declaration
protected void disposeCachedData()
drawPointMarkers(IRenderContext2D renderContext, IAssetManager2D assetManager, FloatValues xCoords, FloatValues yCoords)
Draw the current point marker using the IRenderContext2D, the IAssetManager2D and coordinates passed in
Declaration
protected final void drawPointMarkers(IRenderContext2D renderContext, IAssetManager2D assetManager, FloatValues xCoords, FloatValues yCoords)
Parameters
Type | Name | Description |
---|---|---|
IRenderContext2D | renderContext | The render context. This is a graphics object which has methods to draw lines, quads and polygons to the screen |
IAssetManager2D | assetManager | The asset manager. This is manager for graphic assets which has method for creation pens, brushes and textures |
FloatValues | xCoords | The x coordinates to draw point marker at |
FloatValues | yCoords | The y coordinates to draw point marker at |
getCategoryXRange(IRange<Double> categoryXRange)
Sets the category data range (range of indices used by com.scichart.charting.visuals.axes.CategoryAxisBase) 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 final void getCategoryXRange(IRange<Double> categoryXRange)
Parameters
Type | Name | Description |
---|---|---|
IRange<Double> | categoryXRange |
getClipToBounds()
Gets the value indicating whether this renderable series should be clipped to bounds calculated by BaseRenderableSeries#setClipRect(Rect) method
Declaration
public final boolean getClipToBounds()
Returns
Type | Description |
---|---|
boolean | If true then renderable series will be clipped to bounds |
getContext()
Declaration
public final Context getContext()
Returns
Type | Description |
---|---|
android.content.Context |
getCurrentRenderPassData()
Returns the current ISeriesRenderPassData instance which is used for render pass
Declaration
public final renderableSeriesISeriesRenderPassData getCurrentRenderPassData()
Returns
Type | Description |
---|---|
renderableSeriesISeriesRenderPassData |
getDataSeries()
Gets the IDataSeries associated with this series
Declaration
public final dataSeries.IDataSeries getDataSeries()
Returns
Type | Description |
---|---|
IDataSeries |
getDataSeriesLock()
Gets the IReadWriteLock instance to lock data series
Declaration
public final IReadWriteLock getDataSeriesLock()
Returns
Type | Description |
---|---|
IReadWriteLock |
getDrawNaNAs()
Gets a value indicating how this renderable series will treat double.NaN. See LineDrawMode for available options
Declaration
public final renderableSeries.LineDrawMode getDrawNaNAs()
Returns
Type | Description |
---|---|
renderableSeries.LineDrawMode | The current drawNaNAs value |
getPaletteProvider()
Gets the IPaletteProvider instance associated with this series
Declaration
public final renderableSeries.paletteProviders.IPaletteProvider getPaletteProvider()
Returns
Type | Description |
---|---|
renderableSeries.paletteProviders.IPaletteProvider |
getParentSurface()
Gets the parent surface that this instance is associated with
Declaration
public final ISciChartSurface getParentSurface()
Returns
Type | Description |
---|---|
ISciChartSurface |
getPointMarker()
Gets the IPointMarker for this renderable series
Declaration
public final IPointMarker getPointMarker()
Returns
Type | Description |
---|---|
IPointMarker |
getRenderPassDataLock()
Gets the IReadWriteLock instance to lock render pass data
Declaration
public final IReadWriteLock getRenderPassDataLock()
Returns
Type | Description |
---|---|
IReadWriteLock |
getRenderPassDataTransformation()
Get's the IRenderPassDataTransformation instance associated with this series.
Declaration
public final renderableSeriesIRenderPassDataTransformation getRenderPassDataTransformation()
Returns
Type | Description |
---|---|
renderableSeriesIRenderPassDataTransformation |
getResamplingMode()
Gets the ResamplingMode used when drawing this series
Declaration
public final ResamplingMode getResamplingMode()
Returns
Type | Description |
---|---|
ResamplingMode |
getSeriesColor()
Gets the color which represents this IRenderableSeries instance.
Declaration
public int getSeriesColor()
Returns
Type | Description |
---|---|
int |
getSeriesInfoProvider()
Gets the ISeriesInfoProvider instance associated with this series.
Declaration
public final renderableSeries.hitTest.ISeriesInfoProvider getSeriesInfoProvider()
Returns
Type | Description |
---|---|
renderableSeries.hitTest.ISeriesInfoProvider |
getStrokeStyle()
Gets the stroke style for this renderable series
Declaration
public final PenStyle getStrokeStyle()
Returns
Type | Description |
---|---|
PenStyle |
getXAxis()
Gets the XAxis that this IRenderableSeries is associated with
Declaration
public final IAxis getXAxis()
Returns
Type | Description |
---|---|
IAxis |
getXAxisId()
Gets the id of XAxis that this IRenderableSeries is associated with
Declaration
public final String getXAxisId()
Returns
Type | Description |
---|---|
String |
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 |
getYAxis()
Gets the YAxis that this IRenderableSeries is associated with
Declaration
public final IAxis getYAxis()
Returns
Type | Description |
---|---|
IAxis |
getYAxisId()
Gets the id of YAxis that this IRenderableSeries is associated with
Declaration
public final String getYAxisId()
Returns
Type | Description |
---|---|
String |
getYRange()
Returns the data range of the ISCIRenderableSeries
on Y 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 getYRange()
Returns
Type | Description |
---|---|
IRange |
getYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean getPositiveRange)
Returns the data range of the IRenderableSeries on Y direction by querying the associated data series
Declaration
public IRange getYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean getPositiveRange)
Parameters
Type | Name | Description |
---|---|---|
coordinateCalculators.ICoordinateCalculator | xCoordCalc | |
boolean | getPositiveRange |
Returns
Type | Description |
---|---|
IRange |
getYZeroCoord(coordinateCalculators.ICoordinateCalculator yCoordCalc)
Gets a value that determines the position of Y zero line on a chart. Significant for the series types that render negative data points differently, such as the FastColumnRenderableSeries, FastMountainRenderableSeries, FastImpulseRenderableSeries
Declaration
protected float getYZeroCoord(coordinateCalculators.ICoordinateCalculator yCoordCalc)
Parameters
Type | Name | Description |
---|---|---|
coordinateCalculators.ICoordinateCalculator | yCoordCalc | The ICoordinateCalculator for YAxis |
Returns
Type | Description |
---|---|
float | The value in pixels indicating the position of zero line |
getZeroLineY()
Gets the value which determines the zero line in Y direction. Used to set the bottom of a column, or the zero line in a mountain
Declaration
public final double getZeroLineY()
Returns
Type | Description |
---|---|
double | The current zeroLineY value |
hasDataSeries()
Gets whether this renderable series has data series to draw
Declaration
public final boolean hasDataSeries()
Returns
Type | Description |
---|---|
boolean |
hitTest(renderableSeries.hitTest.HitTestInfo hitTestResult, float x, float y)
Performs a hit-test at the specific point (x,y coordinate on the parent com.scichart.charting.visuals.IRenderableSeriesArea
Declaration
public final void hitTest(renderableSeries.hitTest.HitTestInfo hitTestResult, float x, float y)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.hitTest.HitTestInfo | hitTestResult | |
float | x | |
float | y |
hitTest(renderableSeries.hitTest.HitTestInfo hitTestResult, float x, float y, float hitTestRadius)
Performs a hit-test at the specific point (x,y coordinate on the parent com.scichart.charting.visuals.IRenderableSeriesArea
Declaration
public final void hitTest(renderableSeries.hitTest.HitTestInfo hitTestResult, float x, float y, float hitTestRadius)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.hitTest.HitTestInfo | hitTestResult | |
float | x | |
float | y | |
float | hitTestRadius |
internalDraw(IRenderContext2D renderContext, IAssetManager2D assetManager, renderableSeriesISeriesRenderPassData renderPassData)
Draws the series using the IRenderContext2D, the IAssetManager2D and the ISeriesRenderPassData passed in
Declaration
protected abstract void internalDraw(IRenderContext2D renderContext, IAssetManager2D assetManager, renderableSeriesISeriesRenderPassData renderPassData)
Parameters
Type | Name | Description |
---|---|---|
IRenderContext2D | renderContext | The render context. This is a graphics object which has methods to draw lines, quads and polygons to the screen |
IAssetManager2D | assetManager | The asset manager. This is manager for graphic assets which has method for creation pens, brushes and textures |
renderableSeriesISeriesRenderPassData | renderPassData | The render pass data which contain a resampled point series, the index range of point on the screen and the current coordinate calculator of XAxis and YAxis to convert data-point to screen points |
internalUpdate(IAssetManager2D assetManager2D, RenderPassState renderPassState)
Updates this renderable series instances
Declaration
protected void internalUpdate(IAssetManager2D assetManager2D, RenderPassState renderPassState)
Parameters
Type | Name | Description |
---|---|---|
IAssetManager2D | assetManager2D | The IAssetManager2D used for this render pass |
RenderPassState | renderPassState | The RenderPassState for this render pass |
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 abstract void internalUpdateRenderPassData(renderableSeriesISeriesRenderPassData renderPassDataToUpdate, dataSeries.IDataSeries<?,?> dataSeries, ResamplingMode resamplingMode, IPointResamplerFactory factory)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesISeriesRenderPassData | renderPassDataToUpdate | The render pass data to update |
IDataSeries<?,?> | dataSeries | The data series associated with this renderable series instance |
ResamplingMode | resamplingMode | The resampling mode associated with this renderable series instance |
IPointResamplerFactory | factory | The IPointResamplerFactory to use |
Exceptions
Type | Condition |
---|---|
Exception | If any exception occurs |
invalidateElement()
Declaration
public void invalidateElement()
invalidateRenderPassData()
Asynchronously requests invalidate of renderPassData provided by ISeriesRenderPassData and then invalidates this renderable series
Declaration
public final void invalidateRenderPassData()
isOfValidType(dataSeries.IDataSeries dataSeries)
Checks whether the data series instance is valid for this series
Declaration
protected abstract boolean isOfValidType(dataSeries.IDataSeries dataSeries)
Parameters
Type | Name | Description |
---|---|---|
IDataSeries | dataSeries | The data series instance to check |
Returns
Type | Description |
---|---|
boolean | True if this data series is valid for this series |
isUpdateOfRenderPassDataRequired(coordinateCalculators.ICoordinateCalculator xCoordCalc, coordinateCalculators.ICoordinateCalculator yCoordCalc, Size viewportSize)
Checks whether this renderable series need to update its render pass data
Declaration
protected boolean isUpdateOfRenderPassDataRequired(coordinateCalculators.ICoordinateCalculator xCoordCalc, coordinateCalculators.ICoordinateCalculator yCoordCalc, Size viewportSize)
Parameters
Type | Name | Description |
---|---|---|
coordinateCalculators.ICoordinateCalculator | xCoordCalc | The current coordinate calculator for XAxis |
coordinateCalculators.ICoordinateCalculator | yCoordCalc | The current coordinate calculator for YAxis |
Size | viewportSize | The current viewport manager |
Returns
Type | Description |
---|---|
boolean | If true update is required and BaseRenderableSeries#internalUpdateRenderPassData(ISeriesRenderPassData, IDataSeries, ResamplingMode, IPointResamplerFactory) should be called |
isValidForDrawing()
Checks whether this series is valid for drawing
Declaration
public boolean isValidForDrawing()
Returns
Type | Description |
---|---|
boolean |
isValidForUpdate()
Checks whether this series is valid for update
Declaration
public boolean isValidForUpdate()
Returns
Type | Description |
---|---|
boolean |
onDataSeriesChanged(dataSeries.IDataSeriesCore dataSeries, int dataSeriesUpdate)
Called when data series changes
Declaration
public void onDataSeriesChanged(dataSeries.IDataSeriesCore dataSeries, int dataSeriesUpdate)
Parameters
Type | Name | Description |
---|---|---|
dataSeries.IDataSeriesCore | dataSeries | |
int | dataSeriesUpdate |
onDraw(IRenderContext2D renderContext, IAssetManager2D assetManager)
Declaration
public final void onDraw(IRenderContext2D renderContext, IAssetManager2D assetManager)
Parameters
Type | Name | Description |
---|---|---|
IRenderContext2D | renderContext | |
IAssetManager2D | assetManager |
onRenderSurfaceChanged()
Called when new IRenderSurface instance is set for parent ISciChartSurface
Declaration
public void onRenderSurfaceChanged()
onStrokeStyleChanged(PenStyle oldStrokeStyle, PenStyle newStrokeStyle)
Called when #getStrokeStyle() property changes
Declaration
protected void onStrokeStyleChanged(PenStyle oldStrokeStyle, PenStyle newStrokeStyle)
Parameters
Type | Name | Description |
---|---|---|
PenStyle | oldStrokeStyle | The old stroke style |
PenStyle | newStrokeStyle | The new stroke style |
setClipRect(Rect clipRect)
Sets the clip rect which is used by this series if BaseRenderableSeries#getClipToBounds() is true
Declaration
protected void setClipRect(Rect clipRect)
Parameters
Type | Name | Description |
---|---|---|
android.graphics.Rect | clipRect | The clip rect to set |
setClipToBounds(boolean clipToBounds)
Sets the value indicating whether this renderable series should be clipped to bounds calculated by BaseRenderableSeries#setClipRect(Rect) method
Declaration
public final void setClipToBounds(boolean clipToBounds)
Parameters
Type | Name | Description |
---|---|---|
boolean | clipToBounds | The new |
setDataSeries(dataSeries.IDataSeries dataSeries)
Sets the IDataSeries associated with this series
Declaration
public final void setDataSeries(dataSeries.IDataSeries dataSeries)
Parameters
Type | Name | Description |
---|---|---|
IDataSeries | dataSeries |
setDrawNaNAs(renderableSeries.LineDrawMode drawNaNAs)
Sets a value indicating how this renderable series will treat double.NaN. See LineDrawMode for available options
Declaration
public final void setDrawNaNAs(renderableSeries.LineDrawMode drawNaNAs)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.LineDrawMode | drawNaNAs | New drawNaNAs value |
setPaletteProvider(renderableSeries.paletteProviders.IPaletteProvider paletteProvider)
Set the IPaletteProvider instance associated with this series
Declaration
public final void setPaletteProvider(renderableSeries.paletteProviders.IPaletteProvider paletteProvider)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.paletteProviders.IPaletteProvider | paletteProvider |
setPointMarker(IPointMarker pointMarker)
Sets the IPointMarker for this renderable series
Declaration
public final void setPointMarker(IPointMarker pointMarker)
Parameters
Type | Name | Description |
---|---|---|
IPointMarker | pointMarker |
setRenderPassDataTransformation(renderableSeriesIRenderPassDataTransformation renderPassDataTransformation)
Set's the IRenderPassDataTransformation instance associated with this series.
Declaration
public final void setRenderPassDataTransformation(renderableSeriesIRenderPassDataTransformation renderPassDataTransformation)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesIRenderPassDataTransformation | renderPassDataTransformation |
setResamplingMode(ResamplingMode resamplingMode)
Sets the ResamplingMode used when drawing this series
Declaration
public void setResamplingMode(ResamplingMode resamplingMode)
Parameters
Type | Name | Description |
---|---|---|
ResamplingMode | resamplingMode |
setSeriesInfoProvider(renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider)
Sets the ISeriesInfoProvider instance associated with this series.
Declaration
public final void setSeriesInfoProvider(renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.hitTest.ISeriesInfoProvider | seriesInfoProvider |
setStrokeStyle(PenStyle strokeStyle)
Sets the stroke style of this renderable series
Declaration
public final void setStrokeStyle(PenStyle strokeStyle)
Parameters
Type | Name | Description |
---|---|---|
PenStyle | strokeStyle |
setXAxisId(String xAxisId)
Sets the id of XAxis that this IRenderableSeries is associated with
Declaration
public final void setXAxisId(String xAxisId)
Parameters
Type | Name | Description |
---|---|---|
String | xAxisId |
setYAxisId(String yAxisId)
Sets the id of YAxis that this IRenderableSeries is associated with
Declaration
public final void setYAxisId(String yAxisId)
Parameters
Type | Name | Description |
---|---|---|
String | yAxisId |
setZeroLineY(double zeroLineY)
Sets the value which determines the zero line in Y direction. Used to set the bottom of a column, or the zero line in a mountain
Declaration
public final void setZeroLineY(double zeroLineY)
Parameters
Type | Name | Description |
---|---|---|
double | zeroLineY | The new zeroLieY value |
update(IAssetManager2D assetManager, RenderPassState renderPassState)
Updates the state of this IUpdatable before rendering
Declaration
public final void update(IAssetManager2D assetManager, RenderPassState renderPassState)
Parameters
Type | Name | Description |
---|---|---|
IAssetManager2D | assetManager | |
RenderPassState | renderPassState |
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 | Category XRange to set |
IDataSeries<?,?> | dataSeries | The data series associated with this renderable series |
updateRenderPassData(IAxis xAxis, IAxis yAxis, RenderPassState renderPassState)
Called during render pass and updates current render pass data
Declaration
public final void updateRenderPassData(IAxis xAxis, IAxis yAxis, RenderPassState renderPassState)
Parameters
Type | Name | Description |
---|---|---|
IAxis | xAxis | |
IAxis | yAxis | |
RenderPassState | renderPassState |
verticalSliceHitTest(renderableSeries.hitTest.HitTestInfo hitTestResult, float x, float y)
Performs a hit-test at the specific point with zero hit-test radium. Method consider only X values and returns the closes X value
Declaration
public final void verticalSliceHitTest(renderableSeries.hitTest.HitTestInfo hitTestResult, float x, float y)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.hitTest.HitTestInfo | hitTestResult | |
float | x | |
float | y |