Class HorizontallyStackedColumnsCollection
Provides Horizontally Stacked Columns rendering.
Inheritance
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class HorizontallyStackedColumnsCollection extends renderableSeries.StackedSeriesCollectionBase<renderableSeries.IStackedColumnRenderableSeries>Constructors
HorizontallyStackedColumnsCollection()
Creates a new instance of HorizontallyStackedColumnsCollection class
Declaration
public HorizontallyStackedColumnsCollection()HorizontallyStackedColumnsCollection(Collection<renderableSeries.IStackedColumnRenderableSeries> collection)
Creates a new instance of HorizontallyStackedColumnsCollection class
Declaration
public HorizontallyStackedColumnsCollection(Collection<renderableSeries.IStackedColumnRenderableSeries> collection)Parameters
| Type | Name | Description |
|---|---|---|
| Collection<IStackedColumnRenderableSeries> | collection | The collection of stacked series to add |
Fields
dataPointWidthProperty
Declaration
protected final SmartPropertyDouble dataPointWidthPropertyField Value
| Type | Description |
|---|---|
| SmartPropertyDouble |
spacing
Declaration
protected final SmartPropertyDouble spacingField Value
| Type | Description |
|---|---|
| SmartPropertyDouble |
spacingMode
Declaration
protected final SmartProperty<renderableSeries.SpacingMode> spacingModeField Value
| Type | Description |
|---|---|
| SmartProperty<SpacingMode> |
Methods
getCategoryXRange(IRange<Double> categoryXRange)
Declaration
public void getCategoryXRange(IRange<Double> categoryXRange)Parameters
| Type | Name | Description |
|---|---|---|
| IRange<Double> | categoryXRange |
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 |
getSpacing()
Gets the value which specifies the width of the gap between horizontally stacked columns.
Declaration
public double getSpacing()Returns
| Type | Description |
|---|---|
| double | The current spacing. |
getSpacingMode()
Gets the SpacingMode to use for the space between columns computations. E.g. the default of Absolute requires that the spacing value is in pixels. The value of Relative requires that the spacing value is a double value from 0.0 to 1.0.
Declaration
public renderableSeries.SpacingMode getSpacingMode()Returns
| Type | Description |
|---|---|
| renderableSeries.SpacingMode | The current SpacingMode instance. |
getXRange()
Declaration
public IRange getXRange()Returns
| Type | Description |
|---|---|
| IRange |
getYRange()
Declaration
public IRange getYRange()Returns
| Type | Description |
|---|---|
| IRange |
getYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean getPositiveRange)
Declaration
public IRange getYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean getPositiveRange)Parameters
| Type | Name | Description |
|---|---|---|
| coordinateCalculators.ICoordinateCalculator | xCoordCalc | |
| boolean | getPositiveRange |
Returns
| Type | Description |
|---|---|
| IRange |
internalUpdate(IAssetManager2D assetManager2D, RenderPassState renderPassState)
Updates this renderable series instance and it's children.
Declaration
protected void internalUpdate(IAssetManager2D assetManager2D, RenderPassState renderPassState)Parameters
| Type | Name | Description |
|---|---|---|
| IAssetManager2D | assetManager2D | |
| RenderPassState | renderPassState |
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 |
setSpacing(double spacing)
Sets the value which specifies the width of the gap between horizontally stacked columns. Can be set to either a relative or absolute value depending on the SpacingMode used.
Declaration
public void setSpacing(double spacing)Parameters
| Type | Name | Description |
|---|---|---|
| double | spacing | New spacing. |
setSpacingMode(renderableSeries.SpacingMode spacingMode)
Sets the SpacingMode to use for the space between columns computations. E.g. the default of Absolute requires that the spacing value is in pixels. The value of Relative requires that the spacing value is a double value from 0.0 to 1.0.
Declaration
public void setSpacingMode(renderableSeries.SpacingMode spacingMode)Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeries.SpacingMode | spacingMode | New SpacingMode instance. |
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 |