Class StackedSeriesCollectionBase<T>

Defines the Base class for all collections of the IStackedRenderableSeries within SciChart. See Also: HorizontallyStackedColumnsCollection, VerticallyStackedSeriesCollection, VerticallyStackedColumnsCollection, VerticallyStackedMountainsCollection

Inheritance
java.lang.Object
java.util.AbstractCollection
java.util.AbstractList
ArrayList
ObservableCollection
StackedSeriesCollectionBase<T>
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class StackedSeriesCollectionBase<T> extends ObservableCollection<T> implements renderableSeries.IRenderableSeries, ISciChartSurfaceProvider
Type Parameters
Name Description
T

Constructors

StackedSeriesCollectionBase(renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider)

Creates a new instance of StackedSeriesCollectionBase class

Declaration
protected StackedSeriesCollectionBase(renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider)
Parameters
Type Name Description
renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider

The ISeriesInfoProvider instance associated with this series.

StackedSeriesCollectionBase(Collection<T> collection, renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider)

Creates a new instance of StackedSeriesCollectionBase class

Declaration
protected StackedSeriesCollectionBase(Collection<T> collection, renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider)
Parameters
Type Name Description
Collection<T> collection

The collection of stacked series to add
renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider

The ISeriesInfoProvider instance associated with this series.

Fields

OPERATION_NOT_SUPPORTED_MESSAGE

Declaration
protected static final String OPERATION_NOT_SUPPORTED_MESSAGE
Field Value
Type Description
String

TAG

Declaration
protected static final String TAG
Field Value
Type Description
String

invalidateElementCallback

Declaration
protected final InvalidatableElementCallback invalidateElementCallback
Field Value
Type Description
InvalidatableElementCallback

isSelectedProperty

Declaration
protected final SmartPropertyBoolean isSelectedProperty
Field Value
Type Description
SmartPropertyBoolean

isVisibleProperty

Declaration
protected final SmartPropertyBoolean isVisibleProperty
Field Value
Type Description
SmartPropertyBoolean

resamplingModeProperty

Declaration
protected final SmartProperty<ResamplingMode> resamplingModeProperty
Field Value
Type Description
SmartProperty<ResamplingMode>

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>

Methods

addIsSelectedChangeListener(renderableSeries.RenderableSeriesChangeListener listener)

Add the listener which should be invoked if this series becomes selected/unselected

Declaration
public final void addIsSelectedChangeListener(renderableSeries.RenderableSeriesChangeListener listener)
Parameters
Type Name Description
renderableSeries.RenderableSeriesChangeListener listener

addIsVisibleChangeListener(renderableSeries.RenderableSeriesChangeListener listener)

Add the listener which should be invoked if this series becomes visible/invisible

Declaration
public final void addIsVisibleChangeListener(renderableSeries.RenderableSeriesChangeListener listener)
Parameters
Type Name Description
renderableSeries.RenderableSeriesChangeListener listener

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

decrementSuspend()

Declaration
public void decrementSuspend()

detach()

Declaration
public void detach()

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 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

getIsSelected()

Gets whether this series is selected

Declaration
public boolean getIsSelected()
Returns
Type Description
boolean

getIsSuspended()

Declaration
public final boolean getIsSuspended()
Returns
Type Description
boolean

getIsVisible()

Gets whether this series is visible when drawn

Declaration
public boolean getIsVisible()
Returns
Type Description
boolean

getOpacity()

Gets the opacity factor applied to IRenderableSeriesCore the when it is rendered on chart. Default opacity is 1.0. Expected values are between 0.0 and 1.0.

Declaration
public float getOpacity()
Returns
Type Description
float

getPaletteProvider()

Gets the IPaletteProvider instance associated with this series

Declaration
public 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 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 ResamplingMode getResamplingMode()
Returns
Type Description
ResamplingMode

getSelectedSeriesStyle()

Gets the IStyle which is applied when series is selected

Declaration
public renderableSeries.IStyle getSelectedSeriesStyle()
Returns
Type Description
renderableSeries.IStyle

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 renderableSeries.hitTest.ISeriesInfoProvider getSeriesInfoProvider()
Returns
Type Description
renderableSeries.hitTest.ISeriesInfoProvider

getServices()

Declaration
public final IServiceContainer getServices()
Returns
Type Description
IServiceContainer

getStrokeStyle()

Gets the stroke style for this renderable series

Declaration
public PenStyle getStrokeStyle()
Returns
Type Description
PenStyle

getUpdateSuspenderCount()

Declaration
public final AtomicInteger getUpdateSuspenderCount()
Returns
Type Description
AtomicInteger

getVisibleSeries()

Gets the collection of IStackedRenderableSeries that are visible.

Declaration
protected List<T> getVisibleSeries()
Returns
Type Description
List<T>

List which contains only visible series from this collection.

getXAxis()

Gets the XAxis that this IRenderableSeries is associated with

Declaration
public IAxis getXAxis()
Returns
Type Description
IAxis

getXAxisId()

Gets the id of XAxis that this IRenderableSeries is associated with

Declaration
public String getXAxisId()
Returns
Type Description
String

getYAxis()

Gets the YAxis that this IRenderableSeries is associated with

Declaration
public IAxis getYAxis()
Returns
Type Description
IAxis

getYAxisId()

Gets the id of YAxis that this IRenderableSeries is associated with

Declaration
public String getYAxisId()
Returns
Type Description
String

hasDataSeries()

Gets whether this renderable series has data series to draw

Declaration
public 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 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 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

internalUpdate(IAssetManager2D assetManager2D, RenderPassState renderPassState)

Updates this renderable series instance and it's children.

Declaration
protected abstract 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

invalidateElement()

Declaration
public void invalidateElement()

invalidateRenderPassData()

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

Declaration
public void invalidateRenderPassData()

isAttached()

Declaration
public final boolean isAttached()
Returns
Type Description
boolean

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

onDraw(IRenderContext2D renderContext, IAssetManager2D assetManager)

Declaration
public 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()

removeIsSelectedChangeListener(renderableSeries.RenderableSeriesChangeListener listener)

Removes the listener which should invoke if this series become selected/unselected

Declaration
public final void removeIsSelectedChangeListener(renderableSeries.RenderableSeriesChangeListener listener)
Parameters
Type Name Description
renderableSeries.RenderableSeriesChangeListener listener

removeIsVisibleChangeListener(renderableSeries.RenderableSeriesChangeListener listener)

Removes the listener which should invoke if this series become visible/invisible

Declaration
public final void removeIsVisibleChangeListener(renderableSeries.RenderableSeriesChangeListener listener)
Parameters
Type Name Description
renderableSeries.RenderableSeriesChangeListener listener

resumeUpdates(IUpdateSuspender suspender)

Declaration
public void resumeUpdates(IUpdateSuspender suspender)
Parameters
Type Name Description
IUpdateSuspender suspender

setDataSeries(dataSeries.IDataSeries dataSeries)

Sets the IDataSeries associated with this series

Declaration
public void setDataSeries(dataSeries.IDataSeries dataSeries)
Parameters
Type Name Description
IDataSeries dataSeries

setIsSelected(boolean isSelected)

Sets whether this series is selected

Declaration
public void setIsSelected(boolean isSelected)
Parameters
Type Name Description
boolean isSelected

setIsVisible(boolean isVisible)

Sets whether this series is visible when drawn

Declaration
public void setIsVisible(boolean isVisible)
Parameters
Type Name Description
boolean isVisible

setOpacity(float opacity)

Sets the opacity factor applied to IRenderableSeriesCore the when it is rendered on chart. Default opacity is 1.0. Expected values are between 0.0 and 1.0.

Declaration
public void setOpacity(float opacity)
Parameters
Type Name Description
float opacity

setPaletteProvider(renderableSeries.paletteProviders.IPaletteProvider paletteProvider)

Set the IPaletteProvider instance associated with this series

Declaration
public 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 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

setSelectedSeriesStyle(renderableSeries.IStyle selectedSeriesStyle)

Sets the IStyle which is applied when series is selected

Declaration
public void setSelectedSeriesStyle(renderableSeries.IStyle selectedSeriesStyle)
Parameters
Type Name Description
renderableSeries.IStyle selectedSeriesStyle

setSeriesInfoProvider(renderableSeries.hitTest.ISeriesInfoProvider seriesInfoProvider)

Sets the ISeriesInfoProvider instance associated with this series.

Declaration
public 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 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 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 void setYAxisId(String yAxisId)
Parameters
Type Name Description
String yAxisId

suspendUpdates()

Declaration
public final IUpdateSuspender suspendUpdates()
Returns
Type Description
IUpdateSuspender

update(IAssetManager2D assetManager, RenderPassState renderPassState)

Updates the state of this IUpdatable before rendering

Declaration
public void update(IAssetManager2D assetManager, RenderPassState renderPassState)
Parameters
Type Name Description
IAssetManager2D assetManager
RenderPassState renderPassState

updateRenderPassData(IAxis xAxis, IAxis yAxis, RenderPassState renderPassState)

Called during render pass and updates current render pass data

Declaration
public void updateRenderPassData(IAxis xAxis, IAxis yAxis, RenderPassState renderPassState)
Parameters
Type Name Description
IAxis xAxis
IAxis yAxis
RenderPassState renderPassState

updateStackedRenderPassDataValues(IAxis xAxis, IAxis yAxis)

Called during render pass and updates every stacked render pass data of the children series

Declaration
protected abstract void updateStackedRenderPassDataValues(IAxis xAxis, IAxis yAxis)
Parameters
Type Name Description
IAxis xAxis

The XAxis instance that this StackedSeriesCollectionBase is associated with
IAxis yAxis

The YAxis instance that this StackedSeriesCollectionBase is associated with

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

Implements