Interface IRenderableSeries

Defines the interface for all RenderableSeries within SciChart. See Also: IDataSeries, FastColumnRenderableSeries, FastMountainRenderableSeries, XyScatterRenderableSeries, FastCandlestickRenderableSeries, FastLineRenderableSeries, FastImpulseRenderableSeries, BaseRenderableSeries, IPointMarker

Implements

renderableSeries.IRenderableSeriesCore

IDrawable

IUpdatable

IThemeable

IRenderSurfaceChangedListener

Namespace:

Assembly: .dll

Syntax

public interface IRenderableSeries extends renderableSeries.IRenderableSeriesCore, IDrawable, IUpdatable, IThemeable, IRenderSurfaceChangedListener

Methods

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 abstract void getCategoryXRange(IRange<Double> categoryXRange)

Parameters

Type	Name	Description
IRange<Double>	categoryXRange	The category XRange instance to set based on value of this series

getCurrentRenderPassData()

Returns the current ISeriesRenderPassData instance which is used for render pass

Declaration

public abstract renderableSeriesISeriesRenderPassData getCurrentRenderPassData()

Returns

Type	Description
renderableSeriesISeriesRenderPassData	The current render pass data

getDataSeries()

Gets the IDataSeries associated with this series

Declaration

public abstract dataSeries.IDataSeries getDataSeries()

Returns

Type	Description
IDataSeries	The current data series

getDataSeriesLock()

Gets the IReadWriteLock instance to lock data series

Declaration

public abstract IReadWriteLock getDataSeriesLock()

Returns

Type	Description
IReadWriteLock	The IReadWriteLock instance to lock data series

getPaletteProvider()

Gets the IPaletteProvider instance associated with this series

Declaration

public abstract renderableSeries.paletteProviders.IPaletteProvider getPaletteProvider()

Returns

Type	Description
renderableSeries.paletteProviders.IPaletteProvider	The current IPaletteProvider instance

getPointMarker()

Gets the IPointMarker for this renderable series

Declaration

public abstract IPointMarker getPointMarker()

Returns

Type	Description
IPointMarker	The current point marker

getRenderPassDataLock()

Gets the IReadWriteLock instance to lock render pass data

Declaration

public abstract IReadWriteLock getRenderPassDataLock()

Returns

Type	Description
IReadWriteLock	The IReadWriteLock instance to lock render pass data

getRenderPassDataTransformation()

Get's the IRenderPassDataTransformation instance associated with this series.

Declaration

public abstract renderableSeriesIRenderPassDataTransformation getRenderPassDataTransformation()

Returns

Type	Description
renderableSeriesIRenderPassDataTransformation	The current IRenderPassDataTransformation instance.

getResamplingMode()

Gets the ResamplingMode used when drawing this series

Declaration

public abstract ResamplingMode getResamplingMode()

Returns

Type	Description
ResamplingMode	The current resampling mode

getSeriesColor()

Gets the color which represents this IRenderableSeries instance.

Declaration

public abstract int getSeriesColor()

Returns

Type	Description
int	The color which represents this IRenderableSeries instance.

getSeriesInfoProvider()

Gets the ISeriesInfoProvider instance associated with this series.

Declaration

public abstract renderableSeries.hitTest.ISeriesInfoProvider getSeriesInfoProvider()

Returns

Type	Description
renderableSeries.hitTest.ISeriesInfoProvider	The current ISeriesInfoProvider instance

getStrokeStyle()

Gets the stroke style for this renderable series

Declaration

public abstract PenStyle getStrokeStyle()

Returns

Type	Description
PenStyle	The current stroke style

getXAxis()

Gets the XAxis that this IRenderableSeries is associated with

Declaration

public abstract IAxis getXAxis()

Returns

Type	Description
IAxis	The XAxis instance

getXAxisId()

Gets the id of XAxis that this IRenderableSeries is associated with

Declaration

public abstract String getXAxisId()

Returns

Type	Description
String	The XAxis id

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 abstract IRange getXRange()

Returns

Type	Description
IRange	The XRange of this series

getYAxis()

Gets the YAxis that this IRenderableSeries is associated with

Declaration

public abstract IAxis getYAxis()

Returns

Type	Description
IAxis	The YAxis instance

getYAxisId()

Gets the id of YAxis that this IRenderableSeries is associated with

Declaration

public abstract String getYAxisId()

Returns

Type	Description
String	The YAxis id

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 abstract IRange getYRange()

Returns

Type	Description
IRange	The Y-Range of this series.

getYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean getPositiveRange)

Returns the data range of the IRenderableSeries on Y direction by querying the associated data series

Declaration

public abstract IRange getYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean getPositiveRange)

Parameters

Type	Name	Description
coordinateCalculators.ICoordinateCalculator	xCoordCalc	The XAxis coordinate calculator currently used.
boolean	getPositiveRange	Indicates whether to return positive YRange only

Returns

Type	Description
IRange	The YRange of this series

hasDataSeries()

Gets whether this renderable series has data series to draw

Declaration

public abstract boolean hasDataSeries()

Returns

Type	Description
boolean	True if has data series to draw

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 abstract void hitTest(renderableSeries.hitTest.HitTestInfo hitTestResult, float x, float y)

Parameters

Type	Name	Description
renderableSeries.hitTest.HitTestInfo	hitTestResult	The HitTestInfo instance where result of hit-test should be stored
float	x	The x coordinate in pixels relative to parent com.scichart.charting.visuals.IRenderableSeriesArea
float	y	The y coordinate in pixels relative to parent com.scichart.charting.visuals.IRenderableSeriesArea

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 abstract void hitTest(renderableSeries.hitTest.HitTestInfo hitTestResult, float x, float y, float hitTestRadius)

Parameters

Type	Name	Description
renderableSeries.hitTest.HitTestInfo	hitTestResult	The HitTestInfo instance where result of hit-test should be stored
float	x	The x coordinate in pixels relative to parent com.scichart.charting.visuals.IRenderableSeriesArea
float	y	The y coordinate in pixels relative to parent com.scichart.charting.visuals.IRenderableSeriesArea
float	hitTestRadius	The radius in pixels to determine whether hit point is over a data point

invalidateRenderPassData()

Asynchronously requests invalidate of renderPassData provided by ISeriesRenderPassData and then invalidates this renderable series

Declaration

public abstract void invalidateRenderPassData()

setDataSeries(dataSeries.IDataSeries dataSeries)

Sets the IDataSeries associated with this series

Declaration

public abstract void setDataSeries(dataSeries.IDataSeries dataSeries)

Parameters

Type	Name	Description
IDataSeries	dataSeries	New data series

setPaletteProvider(renderableSeries.paletteProviders.IPaletteProvider paletteProvider)

Set the IPaletteProvider instance associated with this series

Declaration

public abstract void setPaletteProvider(renderableSeries.paletteProviders.IPaletteProvider paletteProvider)

Parameters

Type	Name	Description
renderableSeries.paletteProviders.IPaletteProvider	paletteProvider	The new IPaletteProvider instance

setPointMarker(IPointMarker pointMarker)

Sets the IPointMarker for this renderable series

Declaration

public abstract void setPointMarker(IPointMarker pointMarker)

Parameters

Type	Name	Description
IPointMarker	pointMarker	New point marker

setRenderPassDataTransformation(renderableSeriesIRenderPassDataTransformation renderPassDataTransformation)

Set's the IRenderPassDataTransformation instance associated with this series.

Declaration

public abstract void setRenderPassDataTransformation(renderableSeriesIRenderPassDataTransformation renderPassDataTransformation)

Parameters

Type	Name	Description
renderableSeriesIRenderPassDataTransformation	renderPassDataTransformation	New IRenderPassDataTransformation instance.

setResamplingMode(ResamplingMode resamplingMode)

Sets the ResamplingMode used when drawing this series

Declaration

public abstract void setResamplingMode(ResamplingMode resamplingMode)

Parameters

Type	Name	Description
ResamplingMode	resamplingMode	New resampling mode

setSeriesInfoProvider(renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider)

Sets the ISeriesInfoProvider instance associated with this series.

Declaration

public abstract void setSeriesInfoProvider(renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider)

Parameters

Type	Name	Description
renderableSeries.hitTest.ISeriesInfoProvider	seriesInfoProvider	New ISeriesInfoProvider instance

setStrokeStyle(PenStyle strokeStyle)

Sets the stroke style of this renderable series

Declaration

public abstract void setStrokeStyle(PenStyle strokeStyle)

Parameters

Type	Name	Description
PenStyle	strokeStyle	New stroke style

setXAxisId(String xAxisId)

Sets the id of XAxis that this IRenderableSeries is associated with

Declaration

public abstract void setXAxisId(String xAxisId)

Parameters

Type	Name	Description
String	xAxisId	New XAxis id

setYAxisId(String yAxisId)

Sets the id of YAxis that this IRenderableSeries is associated with

Declaration

public abstract void setYAxisId(String yAxisId)

Parameters

Type	Name	Description
String	yAxisId	New YAxis id

updateRenderPassData(IAxis xAxis, IAxis yAxis, RenderPassState renderPassState)

Called during render pass and updates current render pass data

Declaration

public abstract void updateRenderPassData(IAxis xAxis, IAxis yAxis, RenderPassState renderPassState)

Parameters

Type	Name	Description
IAxis	xAxis	The XAxis instance that this IRenderableSeries is associated with
IAxis	yAxis	The YAxis instance that this IRenderableSeries is associated with
RenderPassState	renderPassState	The current render pass state

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 abstract void verticalSliceHitTest(renderableSeries.hitTest.HitTestInfo hitTestResult, float x, float y)

Parameters

Type	Name	Description
renderableSeries.hitTest.HitTestInfo	hitTestResult	The HitTestInfo instance where result of hit-test should be stored
float	x	The x coordinate in pixels relative to parent com.scichart.charting.visuals.IRenderableSeriesArea
float	y	The y coordinate in pixels relative to parent com.scichart.charting.visuals.IRenderableSeriesArea

Implements

IRenderableSeriesCore

IDrawable

IUpdatable

IThemeable

IRenderSurfaceChangedListener