Class VerticallyStackedSeriesCollection<T>
Defines the Base class for collections which will be used to provide vertical stacking within SciChart. See Also: HorizontallyStackedColumnsCollection, VerticallyStackedSeriesCollection, VerticallyStackedColumnsCollection, VerticallyStackedMountainsCollection
Inheritance
Implements
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class VerticallyStackedSeriesCollection<T> extends renderableSeries.StackedSeriesCollectionBase<T> implements renderableSeries.IStackedRenderableSeries
Type Parameters
Name | Description |
---|---|
T |
Constructors
VerticallyStackedSeriesCollection()
Creates a new instance of VerticallyStackedSeriesCollection class
Declaration
public VerticallyStackedSeriesCollection()
VerticallyStackedSeriesCollection(Collection<T> collection)
Creates a new instance of VerticallyStackedSeriesCollection class
Declaration
public VerticallyStackedSeriesCollection(Collection<T> collection)
Parameters
Type | Name | Description |
---|---|---|
Collection<T> | collection | The collection of stacked series to add |
Fields
isOneHundredPercent
Declaration
protected final SmartPropertyBoolean isOneHundredPercent
Field Value
Type | Description |
---|---|
SmartPropertyBoolean |
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 void getCategoryXRange(IRange<Double> categoryXRange)
Parameters
Type | Name | Description |
---|---|---|
IRange<Double> | categoryXRange |
getFirstDataSeries()
Get the dataSeries instance of this series.
Declaration
public dataSeries.IDataSeries getFirstDataSeries()
Returns
Type | Description |
---|---|
IDataSeries |
getFirstRenderPassData()
Get the renderPassData instance of this series.
Declaration
public renderableSeriesISeriesRenderPassData getFirstRenderPassData()
Returns
Type | Description |
---|---|
renderableSeriesISeriesRenderPassData |
getIsOneHundredPercent()
Gets a value which indicates whether the series will appear 100% stacked.
Declaration
public boolean getIsOneHundredPercent()
Returns
Type | Description |
---|---|
boolean | True if this series will appear 100% stacked. |
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 |
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 |
hasValidRenderPassData()
Checks whether this stacked renderable series has valid render pass data.
Declaration
public final boolean hasValidRenderPassData()
Returns
Type | Description |
---|---|
boolean |
isUpdateOfStackedRenderPassDataRequired(coordinateCalculators.ICoordinateCalculator xCoordCalc, coordinateCalculators.ICoordinateCalculator yCoordCalc, Size viewportSize)
Checks whether this stacked renderable series need to update its render pass data.
Declaration
public boolean isUpdateOfStackedRenderPassDataRequired(coordinateCalculators.ICoordinateCalculator xCoordCalc, coordinateCalculators.ICoordinateCalculator yCoordCalc, Size viewportSize)
Parameters
Type | Name | Description |
---|---|---|
coordinateCalculators.ICoordinateCalculator | xCoordCalc | |
coordinateCalculators.ICoordinateCalculator | yCoordCalc | |
Size | viewportSize |
Returns
Type | Description |
---|---|
boolean |
setIsOneHundredPercent(boolean isOneHundredPercent)
Sets a value which indicates whether the series will appear 100% stacked.
Declaration
public void setIsOneHundredPercent(boolean isOneHundredPercent)
Parameters
Type | Name | Description |
---|---|---|
boolean | isOneHundredPercent | Value which indicates whether the series will appear 100% stacked. |
tryAddSeriesToLegendDataSource(List<renderableSeries.IRenderableSeries> legendDataSource)
When overridden in derived classes, should add all needed IRenderableSeries into legend data source.
Declaration
public void tryAddSeriesToLegendDataSource(List<renderableSeries.IRenderableSeries> legendDataSource)
Parameters
Type | Name | Description |
---|---|---|
List<IRenderableSeries> | legendDataSource |
updateStackedRenderPassDataValues(IAxis xAxis, IAxis yAxis)
Called during render pass and updates every stacked render pass data of the children series
Declaration
protected void updateStackedRenderPassDataValues(IAxis xAxis, IAxis yAxis)
Parameters
Type | Name | Description |
---|---|---|
IAxis | xAxis | |
IAxis | yAxis |
Overrides
updateXValuesPositions(int[] xPointHasYValues)
Used internally to determine which x Values does have y values, and which doesn't have them.
Declaration
protected abstract void updateXValuesPositions(int[] xPointHasYValues)
Parameters
Type | Name | Description |
---|---|---|
int[] | xPointHasYValues | Array which contains information about the positions of the x values. |