Class ColumnRenderableSeries3D
Provides 3D Columns series rendering
Inheritance
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class ColumnRenderableSeries3D extends renderableSeries.XyzRenderableSeries3DBase
Constructors
ColumnRenderableSeries3D()
Creates a new instance of ColumnRenderableSeries3D class
Declaration
public ColumnRenderableSeries3D()
ColumnRenderableSeries3D(renderableSeriesColumnRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Creates a new instance of ColumnRenderableSeries3D class
Declaration
protected ColumnRenderableSeries3D(renderableSeriesColumnRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesColumnRenderPassData3D | currentRenderPassData | The render pass data to use |
BaseRenderableSeriesSceneEntity3D | sceneEntity | The scene entity to use |
Fields
columnFixedSizeProperty
Declaration
protected final SmartPropertyFloat columnFixedSizeProperty
Field Value
Type | Description |
---|---|
SmartPropertyFloat |
columnShapeProperty
Declaration
protected final SmartProperty<SciChartMeshTemplate> columnShapeProperty
Field Value
Type | Description |
---|---|
SmartProperty<SciChartMeshTemplate> |
columnSpacingModeProperty
Declaration
protected final SmartProperty<renderableSeriesColumnSpacingMode> columnSpacingModeProperty
Field Value
Type | Description |
---|---|
SmartProperty<ColumnSpacingMode> |
dataPointWidthProperty
Declaration
protected final SmartPropertyDouble dataPointWidthProperty
Field Value
Type | Description |
---|---|
SmartPropertyDouble |
dataPointWidthXProperty
Declaration
protected final SmartPropertyDouble dataPointWidthXProperty
Field Value
Type | Description |
---|---|
SmartPropertyDouble |
dataPointWidthZProperty
Declaration
protected final SmartPropertyDouble dataPointWidthZProperty
Field Value
Type | Description |
---|---|
SmartPropertyDouble |
fillProperty
Declaration
protected final SmartPropertyInteger fillProperty
Field Value
Type | Description |
---|---|
SmartPropertyInteger |
Methods
applyThemeProvider(IThemeProvider themeProvider)
Declaration
public void applyThemeProvider(IThemeProvider themeProvider)
Parameters
Type | Name | Description |
---|---|---|
IThemeProvider | themeProvider |
Overrides
getColumnFixedSize()
Gets size of column for ColumnSpacingMode#FixedSize mode
Declaration
public final float getColumnFixedSize()
Returns
Type | Description |
---|---|
float | The current |
getColumnShape()
Gets the shape of the columns
Declaration
public final SciChartMeshTemplate getColumnShape()
Returns
Type | Description |
---|---|
SciChartMeshTemplate | The shape of the columns |
getColumnSpacingMode()
Gets the value determining how colum size and spacing between them is calculated
Declaration
public final renderableSeriesColumnSpacingMode getColumnSpacingMode()
Returns
Type | Description |
---|---|
renderableSeriesColumnSpacingMode | The current |
getDataPointWidth()
Gets the DataPointWidth a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in X and Z dimension
Declaration
public final double getDataPointWidth()
Returns
Type | Description |
---|---|
double | The current |
getDataPointWidthX()
Gets the DataPointWidthX, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in X dimension
Declaration
public final double getDataPointWidthX()
Returns
Type | Description |
---|---|
double | The current |
getDataPointWidthZ()
Gets the DataPointWidthZ, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in Z dimension
Declaration
public final double getDataPointWidthZ()
Returns
Type | Description |
---|---|
double | The current |
getFill()
Gets the Fill color for columns
Declaration
public final int getFill()
Returns
Type | Description |
---|---|
int | The current fill color |
getSeriesColor()
Declaration
public int getSeriesColor()
Returns
Type | Description |
---|---|
int |
internalUpdate(RenderPassState3D renderPassState)
Updates this renderable series instances
Declaration
protected void internalUpdate(RenderPassState3D renderPassState)
Parameters
Type | Name | Description |
---|---|---|
RenderPassState3D | renderPassState |
Overrides
internalUpdateRenderPassMetadata(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider)
Updates the current render pass data using data provided by #getMetadataProvider()
Declaration
protected void internalUpdateRenderPassMetadata(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.ISeriesRenderPassData3D | renderPassDataToUpdate | |
renderableSeries.metadataProviders.IMetadataProvider3D | metadataProvider |
Overrides
setColumnFixedSize(float columnFixedSize)
Sets size of column for ColumnSpacingMode#FixedSize mode
Declaration
public final void setColumnFixedSize(float columnFixedSize)
Parameters
Type | Name | Description |
---|---|---|
float | columnFixedSize | The new |
setColumnShape(SciChartMeshTemplate columnShape)
Sets the shape of the columns
Declaration
public final void setColumnShape(SciChartMeshTemplate columnShape)
Parameters
Type | Name | Description |
---|---|---|
SciChartMeshTemplate | columnShape | The new shape of columns |
setColumnSpacingMode(renderableSeriesColumnSpacingMode columnSpacingMode)
Sets the value determining how colum size and spacing between them is calculated
Declaration
public final void setColumnSpacingMode(renderableSeriesColumnSpacingMode columnSpacingMode)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesColumnSpacingMode | columnSpacingMode | The new |
setDataPointWidth(double dataPointWidth)
Sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in X and Z dimension
Declaration
public final void setDataPointWidth(double dataPointWidth)
Parameters
Type | Name | Description |
---|---|---|
double | dataPointWidth | The new |
setDataPointWidthX(double dataPointWidthX)
Sets the DataPointWidthX, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in X dimension
Declaration
public final void setDataPointWidthX(double dataPointWidthX)
Parameters
Type | Name | Description |
---|---|---|
double | dataPointWidthX | The new |
setDataPointWidthZ(double dataPointWidthZ)
Sets the DataPointWidthZ, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in Z dimension
Declaration
public final void setDataPointWidthZ(double dataPointWidthZ)
Parameters
Type | Name | Description |
---|---|---|
double | dataPointWidthZ | The new |
setFill(int fill)
Sets the Fill color for columns
Declaration
public final void setFill(int fill)
Parameters
Type | Name | Description |
---|---|---|
int | fill | The fill color |