the {@link TSciChart | SciChart WebAssembly Context} containing native methods and access to our underlying WebGL2 rendering engine
defines the Start point on the XAxis where this heatmap will be drawn
defines Step on the XAxis for each cell in the heatmap
defines the Start point on the YAxis where this heatmap will be drawn
defines Step on the YAxis for each cell in the heatmap
the 2-Dimensional array of cells which can be passed to populate the BaseHeatmapDataSeries at construct time. The numeric values in these cells will be used to render the heatmap according to the Color Map provided
Gets the height of the 2-dimensional array of Z-Values where array is ranked [width][height]
Gets the width of the 2-dimensional array of Z-Values where array is ranked [width][height]
An EventHandler which is raised when the data changes.
When true, the BaseHeatmapDataSeries has data changes and requires redrawing
A normalized {@link FloatVector} is a native / WebAssembly vector (array) of Float32 values with normalized values ready for drawing in SciChart's WebGL2 Rendering Engine
Gets the size of the heatmap where size = arrayWidth * arrayHeight
Gets the EDataSeriesType type of the DataSeries
The {@link TSciChart | SciChart WebAssembly Context} containing native methods and access to our underlying WebGL2 rendering engine
xStart defines the Start point on the XAxis where this heatmap will be drawn
xStep defines Step on the XAxis for each cell in the heatmap
yStart defines the Start point on the YAxis where this heatmap will be drawn
yStep defines Step on the YAxis for each cell in the heatmap
Gets or sets whether the Y data contains NaN values. Set containsNaN = false for the performance optimization when the series has no NaNs
Gets or sets whether the Y data contains NaN values. Set containsNaN = false for the performance optimization when the series has no NaNs
Gets the DataSeries name. This is used in legend controls and tooltips to identify the series
Gets the DataSeries name. This is used in legend controls and tooltips to identify the series
Returns true if the Heatmap DataSeries has data changes. This flag is set to true when notifyDataChanged is called, and reset to false after
Gets whether this Heatmap has values to display
Gets or sets whether the X-values are sorted or not. See remarks at IDataSeries.isSorted for further information
Gets or sets whether the X-values are sorted or not. See remarks at IDataSeries.isSorted for further information
Gets the maximum X-value for this heatmap, which controls where it is displayed on a cartesian chart
Gets the minimum X-value for this heatmap, which controls where it is displayed on a cartesian chart
Gets the XRange for this heatmap, which controls where it is displayed on a cartesian chart
Gets the maximum Y-value for this heatmap, which controls where it is displayed on a cartesian chart
Gets the minimum Y-value for this heatmap, which controls where it is displayed on a cartesian chart
Gets the YRange for this heatmap, which controls where it is displayed on a cartesian chart
Computes the maximum Z-value for this heatmap
Computes the minimum Z-value for this heatmap
Computes the ZRange for this heatmap, which controls where it is displayed on a cartesian chart
Gets the number of heatmap cells
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
Returns true if this DataSeries has been deleted and native memory destroyed
Gets a native / WebAssembly Vector of Indexes in the DataSeries
Gets a native / WebAssembly vector of X-values in the DataSeries
Gets a native / WebAssembly vector of Y-values in the DataSeries
Returns a FloatVector with normalized values based on the color map passed in
the IColorMapParams provides properties used to map heatmap Z-values into colors for rendering in SciChart's Realtime JavaScript Charts
Gets the Y-range of the data within the specified X-Range: a 'windowed' Y-range used for zooming into series on the SciChartSurface
When true, return the positive part of the Y-range only
When true, treat the XAxis as a CategoryAxis - an axis type which measures by x-index not x-value
Gets the X-value at the specified index. This will be computed from constructor parameters xStep and xStart
Gets the Y-value at the specified index. This will be computed from constructor parameters yStep and yxStart
Computes the range in the Z-direction for this DataSeries
Gets the ZValue at the specific Y,X index where Y must be within 0-arrayHeight and X must be within 0-arrayWidth
the y-index from 0 to arrayHeight
the x-index from 0 to arrayWidth
Gets a readonly collection of Z-values which can be read in the format zValues[y][x] Note that changes or manipulation of the 2D array will not update the Heatmap. Set it back via setZValues() to see changes to the chart
Recreates the normalized vector (internally used for drawing heatmap) according to zMin and zMax values
Sets the ZValue at the specific Y,X index where Y must be within 0-arrayHeight and X must be within 0-arrayWidth
the y-index from 0 to arrayHeight
the x-index from 0 to arrayWidth
the new Z-value
Sets a 2D array of zValues. Input is in the format zValues[y][x] where Y is 0 to height and X is 0 to Width
Generated using TypeDoc
Creates an instance of UniformHeatmapDataSeries