the SciChart WebAssembly Context containing native methods and access to our underlying WebGL2 rendering engine
the IUniformHeatmapSeriesOptions which must be passed to configure the series
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 unique Id for the IDataSeries
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 SciChart WebAssembly Context containing native methods and access to our underlying WebGL2 rendering engine
Gets the change count for this data series. Allows to indentify when data series was changed
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 IDataDistributionCalculator instance for this DataSeries. Used when resampling data to determine the correct algorithm
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/sets whether this Heatmap has NaN value, to display them as transparent tiles
Gets/sets whether this Heatmap has NaN value, to display them as transparent tiles
Gets whether this Heatmap has values to display
Gets or sets whether the X-values are evenly spaced or not. See remarks at IDataSeries.isEvenlySpaced for further information
Gets or sets whether the X-values are evenly spaced or not. See remarks at IDataSeries.isEvenlySpaced for further information
Gets or sets whether the X-values are sorted ascending or not. See remarks at IDataSeries.isSorted for further information
Gets or sets whether the X-values are sorted ascending 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
Clear all values from the DataSeries
Gets the number of heatmap cells
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
Gets the integer indices of the XValues array that are currently in the VisibleRange passed in, and an undefined range otherwise.
The VisibleRange to get the indices range
If True the renderable series uses CategoryAxis
Specifies the search mode used to look for the index of visibleRange.Min
Specifies the search mode used to look for the index of visibleRange.Max
numberRange The indices to the X-Data that are currently in range.
Returns true if this DataSeries has been deleted and native memory destroyed
Gets the metadata by Y and X indexes
The Y index
The X index
Gets the metadata matrix height
Gets the metadata matrix width
Gets a native / WebAssembly Vector of Indexes in the DataSeries
Get the value from a native vector , potentially accounting for fifo sweeping.
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 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 a function that will be used to generate metadata for values when they are appended/inserted, if no explicit metadata is supplied.
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
The point metadata
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
The array of arrays of point metadata
Generated using TypeDoc
Creates an instance of UniformHeatmapDataSeries