Class UniformHeatmapDataSeries<TX,TY,TZ>
Inheritance
UniformHeatmapDataSeries<TX,TY,TZ>
Implements
com.scichart.charting.model.dataSeries.IUniformHeatmapDataSeries<TX,TY,TZ>
Namespace:
Assembly: .dll
public class UniformHeatmapDataSeries<TX,TY,TZ> extends dataSeries.DataSeries<TX,TY> implements dataSeries.IUniformHeatmapDataSeries<TX,TY,TZ>
Type Parameters
Name |
Description |
TX |
|
TY |
|
TZ |
|
Constructors
Declaration
public UniformHeatmapDataSeries(Class<TX> xType, Class<TY> yType, Class<TZ> zType, int xSize, int ySize)
Parameters
Type |
Name |
Description |
Class<TX> |
xType |
The type of X-Data
|
Class<TY> |
yType |
The type of Y-Data
|
Class<TZ> |
zType |
The type of Z-Data
|
int |
xSize |
The size of the heatmap data in x direction
|
int |
ySize |
The size of the heatmap data in y direction
|
Fields
Declaration
protected final int count
Field Value
Declaration
protected final int xSize
Field Value
Declaration
protected final int ySize
Field Value
Declaration
protected final IMath<TZ> zMath
Field Value
Type |
Description |
IMath<TZ> |
|
Declaration
protected final Class<TZ> zType
Field Value
Type |
Description |
Class<TZ> |
|
Methods
Clears the series, resetting internal lists to zero size.
Declaration
public void clear(boolean retainCapacity)
Parameters
Type |
Name |
Description |
boolean |
retainCapacity |
|
Gets the number of points in this series.
Declaration
public final int getCount()
Returns
Declaration
public final dataSeries.DataSeriesType getDataSeriesType()
Returns
Gets the size of the FIFO buffer.
If null, then the series is unlimited.
If a value is set, when the point count reaches this value, older points will be discarded.
Declaration
public final Integer getFifoCapacity()
Returns
Sets the integer indices of the XValues array that are currently in the range passed in with xCoordinateCalculator,
and an indefinite range otherwise.
Declaration
public void getIndicesXRange(IndexRange xIndicesRange, coordinateCalculators.ICoordinateCalculator xCoordinateCalculator)
Parameters
Sets the integer indices of the YValues array that are currently in the range passed in with yCoordinateCalculator,
and an indefinite range otherwise.
Declaration
public void getIndicesYRange(IndexRange yIndicesRange, coordinateCalculators.ICoordinateCalculator yCoordinateCalculator)
Parameters
Gets start X value for 2D heatmap
Declaration
public final TX getStartX()
Returns
Gets start Y value for 2D heatmap
Declaration
public final TY getStartY()
Returns
Gets the size for each cell in 2D heatmap in X direction
Declaration
public final TX getStepX()
Returns
Gets the size for each cell in 2D heatmap in Y direction
Declaration
Returns
Gets the YRange of the data (min, max of the series) in the input visible range point range, where the input range is the IAxisCore#getVisibleRange()
Declaration
public IRange<TY> getWindowedYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean getPositiveRange)
Parameters
Returns
Gets the YRange of the data (min, max of the series) in the input IndexRange, where indices are point-indices on the DataSeries columns.
Declaration
public IRange<TY> getWindowedYRange(IndexRange xIndexRange, boolean getPositiveRange)
Parameters
Returns
Declaration
public final int getXIndex(int zIndex)
Parameters
Type |
Name |
Description |
int |
zIndex |
|
Returns
Gets the size of 2D heatmap data in X direction
Declaration
public final int getXSize()
Returns
Gets the X value for specified index
Declaration
public TX getXValueAt(int xIndex)
Parameters
Type |
Name |
Description |
int |
xIndex |
|
Returns
Declaration
public final int getYIndex(int zIndex)
Parameters
Type |
Name |
Description |
int |
zIndex |
|
Returns
Gets the size of 2D heatmap data in Y direction
Declaration
public final int getYSize()
Returns
Gets the Y value for specified index
Declaration
public TY getYValueAt(int yIndex)
Parameters
Type |
Name |
Description |
int |
yIndex |
|
Returns
Gets raw zIndex based on xIndex and yIndex
Declaration
public final int getZIndex(int xIndex, int yIndex)
Parameters
Type |
Name |
Description |
int |
xIndex |
|
int |
yIndex |
|
Returns
Gets the Z value for specified xIndex and yIndex
Declaration
public TZ getZValueAt(int xIndex, int yIndex)
Parameters
Type |
Name |
Description |
int |
xIndex |
|
int |
yIndex |
|
Returns
Gets the Z values of this series
Declaration
public final ISciList<TZ> getZValues()
Returns
Declaration
public final boolean isDataEvenlySpaced()
Returns
Declaration
public final boolean isDataSortedAscending()
Returns
Gets whether the series behaves as a FIFO.
If True, when the FifoCapacity is reached, old points will be
discarded in favour of new points, resulting in a scrolling chart.
Declaration
public final boolean isFifo()
Returns
Sets the size of the FIFO buffer.
If null, then the series is unlimited.
If a value is set, when the point count reaches this value, older points will be discarded.
Declaration
public final void setFifoCapacity(Integer fifoCapacity)
Parameters
Type |
Name |
Description |
Integer |
fifoCapacity |
|
Sets start X value for 2D heatmap
Declaration
public final void setStartX(TX startX)
Parameters
Type |
Name |
Description |
TX |
startX |
|
Sets start Y value for 2D heatmap
Declaration
public final void setStartY(TY startY)
Parameters
Type |
Name |
Description |
TY |
startY |
|
Sets the size for each cell in 2D heatmap in X direction
Declaration
public final void setStepX(TX stepX)
Parameters
Type |
Name |
Description |
TX |
stepX |
|
Sets the size for each cell in 2D heatmap in Y direction
Declaration
public final void setStepY(TY stepY)
Parameters
Type |
Name |
Description |
TY |
stepY |
|
Updates the range of Z values for this series
Declaration
public void updateRangeZAt(int xIndex, int yIndex, TZ[] values)
Parameters
Type |
Name |
Description |
int |
xIndex |
|
int |
yIndex |
|
TZ[] |
values |
|
Updates the range of Z values for this series
Declaration
public void updateRangeZAt(int xIndex, int yIndex, IValues<TZ> values)
Parameters
Updates the range of Z values for this series
Declaration
public void updateRangeZAt(int xIndex, int yIndex, List<TZ> values)
Parameters
Type |
Name |
Description |
int |
xIndex |
|
int |
yIndex |
|
List<TZ> |
values |
|
Sets the total extents of the IDataSeries in the X direction.
Declaration
protected void updateXRange(IRange<TX> xRange)
Parameters
Type |
Name |
Description |
IRange<TX> |
xRange |
|
Overrides
Sets the total extents of the IDataSeries in the Y direction.
Declaration
protected void updateYRange(IRange<TY> yRange)
Parameters
Type |
Name |
Description |
IRange<TY> |
yRange |
|
Overrides
Updates Z Value at specified xIndex and yIndex
Declaration
public void updateZAt(int xIndex, int yIndex, TZ value)
Parameters
Type |
Name |
Description |
int |
xIndex |
|
int |
yIndex |
|
TZ |
value |
|
Updates all Z values for this series
Declaration
public void updateZValues(TZ[] values)
Parameters
Type |
Name |
Description |
TZ[] |
values |
|
Updates all Z values for this series
Declaration
public void updateZValues(IValues<TZ> values)
Parameters
Type |
Name |
Description |
IValues<TZ> |
values |
|
Updates all Z values for this series
Declaration
public void updateZValues(List<TZ> values)
Parameters
Type |
Name |
Description |
List<TZ> |
values |
|
Implements
com.scichart.charting.model.dataSeries.IUniformHeatmapDataSeries<TX,TY,TZ>