Class UniformHeatmapDataSeries<TX,TY,TZ>

A data series to store uniform heatmap data, containing X, Y and Z values See Also: com.scichart.charting.visuals.renderableSeries.FastUniformHeatmapRenderableSeries

Inheritance

java.lang.Object

DataSeriesCore

dataSeries.DataSeries

UniformHeatmapDataSeries<TX,TY,TZ>

Implements

com.scichart.charting.model.dataSeries.IUniformHeatmapDataSeries<TX,TY,TZ>

Inherited Members

dataSeries.DataSeries.getAcceptsUnsortedData()

dataSeries.DataSeries.getLock()

dataSeries.DataSeries.getXMath()

dataSeries.DataSeries.getXMax()

dataSeries.DataSeries.getXMin()

dataSeries.DataSeries.getXRange()

dataSeries.DataSeries.getXType()

dataSeries.DataSeries.getYMath()

dataSeries.DataSeries.getYMax()

dataSeries.DataSeries.getYMin()

dataSeries.DataSeries.getYRange()

dataSeries.DataSeries.getYType()

dataSeries.DataSeries.setAcceptsUnsortedData(boolean)

dataSeries.DataSeries.updateXRange(IRange<TX>)

dataSeries.DataSeries.updateYRange(IRange<TY>)

dataSeries.DataSeriesCore.addObserver(dataSeries.IDataSeriesObserver)

dataSeries.DataSeriesCore.clear()

dataSeries.DataSeriesCore.decrementSuspend()

dataSeries.DataSeriesCore.getHasValues()

dataSeries.DataSeriesCore.getIsSuspended()

dataSeries.DataSeriesCore.getSeriesName()

dataSeries.DataSeriesCore.getUpdateSuspenderCount()

dataSeries.DataSeriesCore.onDataSeriesChanged(int)

dataSeries.DataSeriesCore.removeObserver(dataSeries.IDataSeriesObserver)

dataSeries.DataSeriesCore.resumeUpdates(IUpdateSuspender)

dataSeries.DataSeriesCore.setSeriesName(String)

dataSeries.DataSeriesCore.suspendUpdates()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Namespace:

Assembly: .dll

Syntax

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

UniformHeatmapDataSeries(Class<TX> xType, Class<TY> yType, Class<TZ> zType, int xSize, int ySize)

Creates a new UniformHeatmapDataSeries instance

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

count

Declaration

protected final int count

Field Value

Type	Description
int

xSize

Declaration

protected final int xSize

Field Value

Type	Description
int

ySize

Declaration

protected final int ySize

Field Value

Type	Description
int

zMath

Declaration

protected final IMath<TZ> zMath

Field Value

Type	Description
IMath<TZ>

zType

Declaration

protected final Class<TZ> zType

Field Value

Type	Description
Class<TZ>

Methods

clear(boolean retainCapacity)

Clears the series, resetting internal lists to zero size.

Declaration

public void clear(boolean retainCapacity)

Parameters

Type	Name	Description
boolean	retainCapacity

getCount()

Gets the number of points in this series.

Declaration

public final int getCount()

Returns

Type	Description
int

getDataSeriesType()

Gets the DataSeriesType for this DataSeries.

Declaration

public final dataSeries.DataSeriesType getDataSeriesType()

Returns

Type	Description
dataSeries.DataSeriesType

getFifoCapacity()

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

Type	Description
Integer

getIndicesXRange(IndexRange xIndicesRange, coordinateCalculators.ICoordinateCalculator xCoordinateCalculator)

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

Type	Name	Description
IndexRange	xIndicesRange
coordinateCalculators.ICoordinateCalculator	xCoordinateCalculator

getIndicesYRange(IndexRange yIndicesRange, coordinateCalculators.ICoordinateCalculator yCoordinateCalculator)

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

Type	Name	Description
IndexRange	yIndicesRange
coordinateCalculators.ICoordinateCalculator	yCoordinateCalculator

getStartX()

Gets start X value for 2D heatmap

Declaration

public final TX getStartX()

Returns

Type	Description
TX

getStartY()

Gets start Y value for 2D heatmap

Declaration

public final TY getStartY()

Returns

Type	Description
TY

getStepX()

Gets the size for each cell in 2D heatmap in X direction

Declaration

public final TX getStepX()

Returns

Type	Description
TX

getStepY()

Gets the size for each cell in 2D heatmap in Y direction

Declaration

public TY getStepY()

Returns

Type	Description
TY

getWindowedYRange(coordinateCalculators.ICoordinateCalculator xCoordCalc, boolean getPositiveRange)

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

Type	Name	Description
coordinateCalculators.ICoordinateCalculator	xCoordCalc
boolean	getPositiveRange

Returns

Type	Description
IRange<TY>

getWindowedYRange(IndexRange xIndexRange, boolean getPositiveRange)

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

Type	Name	Description
IndexRange	xIndexRange
boolean	getPositiveRange

Returns

Type	Description
IRange<TY>

getXIndex(int zIndex)

Gets xIndex based on index from IUniformHeatmapDataSeriesValues#getZValues() list

Declaration

public final int getXIndex(int zIndex)

Parameters

Type	Name	Description
int	zIndex

Returns

Type	Description
int

getXSize()

Gets the size of 2D heatmap data in X direction

Declaration

public final int getXSize()

Returns

Type	Description
int

getXValueAt(int xIndex)

Gets the X value for specified index

Declaration

public TX getXValueAt(int xIndex)

Parameters

Type	Name	Description
int	xIndex

Returns

Type	Description
TX

getYIndex(int zIndex)

Gets yIndex based on index from IUniformHeatmapDataSeriesValues#getZValues() list

Declaration

public final int getYIndex(int zIndex)

Parameters

Type	Name	Description
int	zIndex

Returns

Type	Description
int

getYSize()

Gets the size of 2D heatmap data in Y direction

Declaration

public final int getYSize()

Returns

Type	Description
int

getYValueAt(int yIndex)

Gets the Y value for specified index

Declaration

public TY getYValueAt(int yIndex)

Parameters

Type	Name	Description
int	yIndex

Returns

Type	Description
TY

getZIndex(int xIndex, int yIndex)

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

Type	Description
int

getZValueAt(int xIndex, int yIndex)

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

Type	Description
TZ

getZValues()

Gets the Z values of this series

Declaration

public final ISciList<TZ> getZValues()

Returns

Type	Description
ISciList<TZ>

isDataEvenlySpaced()

Declaration

public final boolean isDataEvenlySpaced()

Returns

Type	Description
boolean

isDataSortedAscending()

Declaration

public final boolean isDataSortedAscending()

Returns

Type	Description
boolean

isFifo()

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

Type	Description
boolean

setFifoCapacity(Integer fifoCapacity)

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

setStartX(TX startX)

Sets start X value for 2D heatmap

Declaration

public final void setStartX(TX startX)

Parameters

Type	Name	Description
TX	startX

setStartY(TY startY)

Sets start Y value for 2D heatmap

Declaration

public final void setStartY(TY startY)

Parameters

Type	Name	Description
TY	startY

setStepX(TX stepX)

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

setStepY(TY stepY)

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

updateRangeZAt(int xIndex, int yIndex, TZ[] values)

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

updateRangeZAt(int xIndex, int yIndex, IValues<TZ> values)

Updates the range of Z values for this series

Declaration

public void updateRangeZAt(int xIndex, int yIndex, IValues<TZ> values)

Parameters

Type	Name	Description
int	xIndex
int	yIndex
IValues<TZ>	values

updateRangeZAt(int xIndex, int yIndex, List<TZ> values)

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

updateXRange(IRange<TX> xRange)

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

DataSeries<TX,TY>.updateXRange(IRange<TX> xRange)

updateYRange(IRange<TY> yRange)

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

DataSeries<TX,TY>.updateYRange(IRange<TY> yRange)

updateZAt(int xIndex, int yIndex, TZ value)

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

updateZValues(TZ[] values)

Updates all Z values for this series

Declaration

public void updateZValues(TZ[] values)

Parameters

Type	Name	Description
TZ[]	values

updateZValues(IValues<TZ> values)

Updates all Z values for this series

Declaration

public void updateZValues(IValues<TZ> values)

Parameters

Type	Name	Description
IValues<TZ>	values

updateZValues(List<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>