Class FastUniformHeatmapRenderableSeries
Displays 2D data as an uniform heat map
Inheritance
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class FastUniformHeatmapRenderableSeries extends renderableSeries.BaseRenderableSeries
Constructors
FastUniformHeatmapRenderableSeries()
Creates a new instance of FastUniformHeatmapRenderableSeries class
Declaration
public FastUniformHeatmapRenderableSeries()
FastUniformHeatmapRenderableSeries(renderableSeriesUniformHeatmapRenderPassData currentRenderPassData, renderableSeries.hitTest.IHitProvider hitProvider, renderableSeries.hitTest.INearestPointProvider nearestPointProvider)
Creates a new instance of FastUniformHeatmapRenderableSeries class
Declaration
protected FastUniformHeatmapRenderableSeries(renderableSeriesUniformHeatmapRenderPassData currentRenderPassData, renderableSeries.hitTest.IHitProvider hitProvider, renderableSeries.hitTest.INearestPointProvider nearestPointProvider)
Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeriesUniformHeatmapRenderPassData | currentRenderPassData | The render pass data instance |
| renderableSeries.hitTest.IHitProvider | hitProvider | The hit provider instance |
| renderableSeries.hitTest.INearestPointProvider | nearestPointProvider | The nearest point provider instance |
Fields
cellTextStyleProperty
Declaration
protected final SmartProperty<FontStyle> cellTextStyleProperty
Field Value
| Type | Description |
|---|---|
| SmartProperty<FontStyle> |
colorMapProperty
Declaration
protected final SmartProperty<renderableSeries.ColorMap> colorMapProperty
Field Value
| Type | Description |
|---|---|
| SmartProperty<ColorMap> |
drawTextInCellProperty
Declaration
protected final SmartPropertyBoolean drawTextInCellProperty
Field Value
| Type | Description |
|---|---|
| SmartPropertyBoolean |
maximumProperty
Declaration
protected final SmartPropertyDouble maximumProperty
Field Value
| Type | Description |
|---|---|
| SmartPropertyDouble |
minimumProperty
Declaration
protected final SmartPropertyDouble minimumProperty
Field Value
| Type | Description |
|---|---|
| SmartPropertyDouble |
useLinearTextureFiltering
Declaration
protected final SmartPropertyBoolean useLinearTextureFiltering
Field Value
| Type | Description |
|---|---|
| SmartPropertyBoolean |
Methods
formatCellToString(double cellValue)
Gets a string with formatted value for rendering inside cell if FastUniformHeatmapRenderableSeries#getDrawTextInCell() is true
Declaration
protected String formatCellToString(double cellValue)
Parameters
| Type | Name | Description |
|---|---|---|
| double | cellValue | The value to format |
Returns
| Type | Description |
|---|---|
| String | The formatted value |
getCellTextStyle()
Gets the FontStyle for heat map cells
Declaration
public final FontStyle getCellTextStyle()
Returns
| Type | Description |
|---|---|
| FontStyle | The FontStyle for heat map cells |
getColorMap()
Gets the ColorMap associated with this FastUniformHeatmapRenderableSeries
Declaration
public final renderableSeries.ColorMap getColorMap()
Returns
| Type | Description |
|---|---|
| renderableSeries.ColorMap | The color map |
getDrawTextInCell()
Gets the value indicating whether this FastUniformHeatmapRenderableSeries should draw text in heat map cells
Declaration
public final boolean getDrawTextInCell()
Returns
| Type | Description |
|---|---|
| boolean | If true text will be drawn in heat map cells |
getMaximum()
Gets the maximum value for this FastUniformHeatmapRenderableSeries
Declaration
public final double getMaximum()
Returns
| Type | Description |
|---|---|
| double | The maximum value |
getMinimum()
Gets the minimum value for this FastUniformHeatmapRenderableSeries
Declaration
public final double getMinimum()
Returns
| Type | Description |
|---|---|
| double | The minimum value |
getUseLinearTextureFiltering()
Gets whether linear texture filtering is used. For more information see com.scichart.drawing.common.TextureFiltering
Declaration
public final boolean getUseLinearTextureFiltering()
Returns
| Type | Description |
|---|---|
| boolean | True if linear texture filtered is used |
internalDraw(IRenderContext2D renderContext, IAssetManager2D assetManager, renderableSeriesISeriesRenderPassData renderPassData)
Draws the series using the IRenderContext2D, the IAssetManager2D and the ISeriesRenderPassData passed in
Declaration
protected void internalDraw(IRenderContext2D renderContext, IAssetManager2D assetManager, renderableSeriesISeriesRenderPassData renderPassData)
Parameters
| Type | Name | Description |
|---|---|---|
| IRenderContext2D | renderContext | |
| IAssetManager2D | assetManager | |
| renderableSeriesISeriesRenderPassData | renderPassData |
Overrides
internalUpdateRenderPassData(renderableSeriesISeriesRenderPassData renderPassDataToUpdate, dataSeries.IDataSeries<?,?> dataSeries, ResamplingMode resamplingMode, IPointResamplerFactory factory)
Updates the current render pass data using the data series, resampling factory passed in
Declaration
protected void internalUpdateRenderPassData(renderableSeriesISeriesRenderPassData renderPassDataToUpdate, dataSeries.IDataSeries<?,?> dataSeries, ResamplingMode resamplingMode, IPointResamplerFactory factory)
Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeriesISeriesRenderPassData | renderPassDataToUpdate | |
| IDataSeries<?,?> | dataSeries | |
| ResamplingMode | resamplingMode | |
| IPointResamplerFactory | factory |
Overrides
Exceptions
| Type | Condition |
|---|---|
| Exception |
isOfValidType(dataSeries.IDataSeries dataSeries)
Checks whether the data series instance is valid for this series
Declaration
protected final boolean isOfValidType(dataSeries.IDataSeries dataSeries)
Parameters
| Type | Name | Description |
|---|---|---|
| IDataSeries | dataSeries |
Returns
| Type | Description |
|---|---|
| boolean |
Overrides
setCellTextStyle(FontStyle cellTextStyle)
Sets the FontStyle for heat map cells
Declaration
public final void setCellTextStyle(FontStyle cellTextStyle)
Parameters
| Type | Name | Description |
|---|---|---|
| FontStyle | cellTextStyle | The FontStyle for heat map cells |
setColorMap(renderableSeries.ColorMap colorMap)
Sets the ColorMap associated with this FastUniformHeatmapRenderableSeries
Declaration
public final void setColorMap(renderableSeries.ColorMap colorMap)
Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeries.ColorMap | colorMap | The color map |
setDrawTextInCell(boolean drawTextInCell)
Sets the value indicating whether this FastUniformHeatmapRenderableSeries should draw text in heat map cells
Declaration
public final void setDrawTextInCell(boolean drawTextInCell)
Parameters
| Type | Name | Description |
|---|---|---|
| boolean | drawTextInCell | If true text will be drawn in heat map cells |
setMaximum(double maximum)
Sets the maximum value for this FastUniformHeatmapRenderableSeries
Declaration
public final void setMaximum(double maximum)
Parameters
| Type | Name | Description |
|---|---|---|
| double | maximum | The maximum value |
setMinimum(double minimum)
Sets the minimum value for this FastUniformHeatmapRenderableSeries
Declaration
public final void setMinimum(double minimum)
Parameters
| Type | Name | Description |
|---|---|---|
| double | minimum | The minimum value |
setUseLinearTextureFiltering(boolean useLinearTextureFiltering)
Sets whether linear texture filtering is used. For more information see
Declaration
public final void setUseLinearTextureFiltering(boolean useLinearTextureFiltering)
Parameters
| Type | Name | Description |
|---|---|---|
| boolean | useLinearTextureFiltering | The new value |