Class WaterfallRenderableSeries3D
Provides a series type for Waterfall chart rendering.
Inheritance
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class WaterfallRenderableSeries3D extends renderableSeries.BaseRenderableSeries3D
Constructors
WaterfallRenderableSeries3D()
Declaration
public WaterfallRenderableSeries3D()
WaterfallRenderableSeries3D(renderableSeriesWaterfallRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Creates a new instance of XyzRenderableSeries3DBase class
Declaration
protected WaterfallRenderableSeries3D(renderableSeriesWaterfallRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesWaterfallRenderPassData3D | currentRenderPassData | The render pass data to use |
BaseRenderableSeriesSceneEntity3D | sceneEntity | The scene entity to use |
Fields
clipModeProperty
Declaration
protected final SmartProperty<renderableSeriesWaterfallClipMode> clipModeProperty
Field Value
Type | Description |
---|---|
SmartProperty<WaterfallClipMode> |
selectedColorMappingProperty
Declaration
protected final SmartProperty<renderableSeriesMeshColorPalette> selectedColorMappingProperty
Field Value
Type | Description |
---|---|
SmartProperty<MeshColorPalette> |
sliceThicknessProperty
Declaration
protected final SmartPropertyFloat sliceThicknessProperty
Field Value
Type | Description |
---|---|
SmartPropertyFloat |
strokeProperty
Declaration
protected final SmartPropertyInteger strokeProperty
Field Value
Type | Description |
---|---|
SmartPropertyInteger |
strokeThicknessProperty
Declaration
protected final SmartPropertyFloat strokeThicknessProperty
Field Value
Type | Description |
---|---|
SmartPropertyFloat |
yColorMappingProperty
Declaration
protected final SmartProperty<renderableSeriesMeshColorPalette> yColorMappingProperty
Field Value
Type | Description |
---|---|
SmartProperty<MeshColorPalette> |
yStrokeColorMappingProperty
Declaration
protected final SmartProperty<renderableSeriesMeshColorPalette> yStrokeColorMappingProperty
Field Value
Type | Description |
---|---|
SmartProperty<MeshColorPalette> |
zColorMappingProperty
Declaration
protected final SmartProperty<renderableSeriesMeshColorPalette> zColorMappingProperty
Field Value
Type | Description |
---|---|
SmartProperty<MeshColorPalette> |
zStrokeColorMappingProperty
Declaration
protected final SmartProperty<renderableSeriesMeshColorPalette> zStrokeColorMappingProperty
Field Value
Type | Description |
---|---|
SmartProperty<MeshColorPalette> |
Methods
canUpdateRenderPassData(RenderPassState3D renderPassState)
Checks if current renderable series can update render pass data
Declaration
protected boolean canUpdateRenderPassData(RenderPassState3D renderPassState)
Parameters
Type | Name | Description |
---|---|---|
RenderPassState3D | renderPassState |
Returns
Type | Description |
---|---|
boolean |
Overrides
deselectAll()
Declaration
public void deselectAll()
getClipMode()
Gets how a waterfall chart renders its data
Declaration
public final renderableSeriesWaterfallClipMode getClipMode()
Returns
Type | Description |
---|---|
renderableSeriesWaterfallClipMode | The current clip mode |
getSelectedColorMapping()
Gets the color mapping for selected slices of waterfall chart
Declaration
public final renderableSeriesMeshColorPalette getSelectedColorMapping()
Returns
Type | Description |
---|---|
renderableSeriesMeshColorPalette | The current color mapping for selected slices |
getSeriesColor()
Declaration
public int getSeriesColor()
Returns
Type | Description |
---|---|
int |
getSliceThickness()
Gets the thickness of waterfall chart slices
Declaration
public final float getSliceThickness()
Returns
Type | Description |
---|---|
float | The current slice thickness |
getStroke()
Gets the stroke color of the waterfall chart slices.
Declaration
public final int getStroke()
Returns
Type | Description |
---|---|
int | The stroke color |
getStrokeThickness()
Gets the stroke thickness to apply to the waterfall chart slice
Declaration
public final float getStrokeThickness()
Returns
Type | Description |
---|---|
float | The stroke thickness |
getYColorMapping()
Gets the Y mapping for filling slices of a waterfall chart
Declaration
public final renderableSeriesMeshColorPalette getYColorMapping()
Returns
Type | Description |
---|---|
renderableSeriesMeshColorPalette | The current Y mapping |
getYStrokeColorMapping()
Gets the Y mapping for filling Y stroke of a waterfall chart
Declaration
public final renderableSeriesMeshColorPalette getYStrokeColorMapping()
Returns
Type | Description |
---|---|
renderableSeriesMeshColorPalette | The current Y mapping |
getZColorMapping()
Gets the Z mapping for filling slices of a waterfall chart
Declaration
public final renderableSeriesMeshColorPalette getZColorMapping()
Returns
Type | Description |
---|---|
renderableSeriesMeshColorPalette | The current Z mapping |
getZStrokeColorMapping()
Gets the Z mapping for filling Z stroke of a waterfall chart
Declaration
public final renderableSeriesMeshColorPalette getZStrokeColorMapping()
Returns
Type | Description |
---|---|
renderableSeriesMeshColorPalette | The current Z mapping |
internalUpdateRenderPassData(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, dataSeries.IDataSeries3D<?,?,?> dataSeries, int updateFlags)
Updates the current render pass data using the data series
Declaration
protected void internalUpdateRenderPassData(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, dataSeries.IDataSeries3D<?,?,?> dataSeries, int updateFlags)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.ISeriesRenderPassData3D | renderPassDataToUpdate | |
IDataSeries3D<?,?,?> | dataSeries | |
int | updateFlags |
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
isOfValidType(dataSeries.IDataSeries3D dataSeries)
Checks whether the data series instance is valid for this series
Declaration
protected boolean isOfValidType(dataSeries.IDataSeries3D dataSeries)
Parameters
Type | Name | Description |
---|---|---|
IDataSeries3D | dataSeries |
Returns
Type | Description |
---|---|
boolean |
Overrides
performSelection(boolean isSelected, renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)
Declaration
public void performSelection(boolean isSelected, renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)
Parameters
Type | Name | Description |
---|---|---|
boolean | isSelected | |
renderableSeries.hitTest.HitTestInfo3D | hitTestInfo3D |
performSelection(renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)
Declaration
public void performSelection(renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.hitTest.HitTestInfo3D | hitTestInfo3D |
setClipMode(renderableSeriesWaterfallClipMode clipMode)
Sets how a waterfall chart renders its data
Declaration
public final void setClipMode(renderableSeriesWaterfallClipMode clipMode)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesWaterfallClipMode | clipMode | The clip mode to use |
setSelectedColorMapping(renderableSeriesMeshColorPalette selectedColorMapping)
Sets the color mapping for selected slices of waterfall chart
Declaration
public final void setSelectedColorMapping(renderableSeriesMeshColorPalette selectedColorMapping)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesMeshColorPalette | selectedColorMapping | The new color mapping for selected slices |
setSliceThickness(float sliceThickness)
Sets the thickness of waterfall chart slices
Declaration
public final void setSliceThickness(float sliceThickness)
Parameters
Type | Name | Description |
---|---|---|
float | sliceThickness | The new slice thickness |
setStroke(int stroke)
Sets the stroke color of the waterfall chart slices.
Declaration
public final void setStroke(int stroke)
Parameters
Type | Name | Description |
---|---|---|
int | stroke | The new stroke color |
setStrokeThickness(float strokeThickness)
Sets the stroke thickness to apply to the waterfall chart slice
Declaration
public final void setStrokeThickness(float strokeThickness)
Parameters
Type | Name | Description |
---|---|---|
float | strokeThickness | The new stroke thickness |
setYColorMapping(renderableSeriesMeshColorPalette yColorMapping)
Sets the Y mapping for filling slices of a waterfall chart
Declaration
public final void setYColorMapping(renderableSeriesMeshColorPalette yColorMapping)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesMeshColorPalette | yColorMapping | The new Y mapping |
setYStrokeColorMapping(renderableSeriesMeshColorPalette yStrokeColorMapping)
Sets the Y mapping for filling Y stroke of a waterfall chart
Declaration
public final void setYStrokeColorMapping(renderableSeriesMeshColorPalette yStrokeColorMapping)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesMeshColorPalette | yStrokeColorMapping | The new Y mapping |
setZColorMapping(renderableSeriesMeshColorPalette zColorMapping)
Sets the Z mapping for filling slices of a waterfall chart
Declaration
public final void setZColorMapping(renderableSeriesMeshColorPalette zColorMapping)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesMeshColorPalette | zColorMapping | The new Z mapping |
setZStrokeColorMapping(renderableSeriesMeshColorPalette zStrokeColorMapping)
Sets the Z mapping for filling Z stroke of a waterfall chart
Declaration
public final void setZStrokeColorMapping(renderableSeriesMeshColorPalette zStrokeColorMapping)
Parameters
Type | Name | Description |
---|---|---|
renderableSeriesMeshColorPalette | zStrokeColorMapping | The new Z mapping |