IHeatmapDataSeries Interface Members

The following tables list the members exposed by IHeatmapDataSeries.

Public Properties

Name | Description | |
---|---|---|

AcceptsUnsortedData | New to v3.3: when AcceptsUnsortedData is false, the DataSeries with throw an InvalidOperationException if unsorted data is appended. Unintentional unsorted data can result in much slower performance. To disable this check, set AcceptsUnsortedData = true. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

ArrayHeight | Returns one dimension of a heatmap. | |

ArrayWidth | Returns one dimension of a heatmap. | |

ChangeCount | Gets the change count for this data series. Allows to identify when data series was changed (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

Count | Gets the number of points in this dataseries. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

DataContainsNaN | Gets whether the Y data contains NaN values (Inherited from SciChart.Charting.Model.DataSeries.IDataDistributionProvider) | |

DataIsEvenlySpaced | Gets whether the X data is evenly spaced (Inherited from SciChart.Charting.Model.DataSeries.IDataDistributionProvider) | |

DataIsSortedAscending | Gets whether this DataSeries contains Sorted data in the X-direction. Note: Sorted data will result in far faster indexing operations. If at all possible, try to keep your data sorted in the X-direction (Inherited from SciChart.Charting.Model.DataSeries.IDataDistributionProvider) | |

DataSeriesType | Gets the DataSeriesType for this DataSeries. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

FifoCapacity | Gets or sets the size of the FIFO buffer. If null, then the dataseries is unlimited. If a value is set, when the point count reaches this value, older points will be discarded. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

HasMetadata | Gets whether the DataSeries contains metadata for any point(is not empty). (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

HasValues | Gets whether the DataSeries has values(is not empty). (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

IsFifo | Gets whether the dataseries 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. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

IsSorted | Gets whether this DataSeries contains Sorted data in the X-direction. Note: Sorted data will result in far faster indexing operations. If at all possible, try to keep your data sorted in the X-direction. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

IsSuspended | Gets a value indicating whether updates for the target are currently suspended (Inherited from SciChart.Core.Framework.ISuspendable) | |

LatestYValue | Gets the latest Y-Value of the DataSeries. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

Metadata | Gets a 2D array of SciChart.Charting.Model.DataSeries.IPointMetadata, if presents. | |

MinXSpacing | Gets the minimal spacing between X Values (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

ParentSurface | Gets or sets the parent SciChart.Charting.Visuals.ISciChartSurface which this SciChart.Charting.Model.DataSeries.IDataSeries instance is attached to. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

SeriesName | Gets or sets the name of this series. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

SyncRoot | Gets a synchronization object used to lock this data-series. Also locked on append, update, remove or clear. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

Tag | Gets or sets an arbitrary tag on the DataSeries (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

XMax | Gets the computed Maximum value in X for this series. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

XMin | Gets the computed Minimum value in X for this series. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

XRange | Gets the total extents of the SciChart.Charting.Model.DataSeries.IDataSeries in the X direction. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

XType | Gets the Type of X-data points in this DataSeries. Used to check compatibility with Axis types. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

XValues | Gets the XValues of this dataseries. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

YMax | Gets the computed Maximum value in Y for this series. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

YMin | Gets the computed Minimum value in Y for this series. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

YRange | Gets the total extents of the SciChart.Charting.Model.DataSeries.IDataSeries in the Y direction. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

YType | Gets the Type of Y-data points in this DataSeries. Used to check compatibility with Axis types. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

YValues | Gets the YValues of this dataseries. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

ZType | Returns the type of the Z values of a heatmap. |

Public Methods

Name | Description | |
---|---|---|

Clear | Clears the series, resetting internal lists to zero size. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

DecrementSuspend | Called by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called (Inherited from SciChart.Core.Framework.ISuspendable) | |

FindClosestLine | Finds the closest line to a point with given X and Y value. Search region is a vertical area with center in X and [maxXDistance] X units to left and right. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

FindClosestPoint | Finds the closest point to a point with given X and Y value. Search region is a vertical area with center in X and [maxXDistance] X units to left and right. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

FindIndex | Finds the index to the DataSeries at the specified X-Value. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

GetIndicesRange | Gets the integer indices of the XValues array that are currently in the VisibleRange passed in, and an indefinite range otherwise. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

GetWindowedYRange | Gets the YRange of the data (min, max of the series) in the input visible range point range, where the input range is the SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

GetXIndex | Returns the X index of this value on a heatmap. | |

GetXIndicesRange | Returns the X index range for the given X data range on a heatmap. | |

GetXRange | Gets the XRange of the data (min, max of the series). (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

GetXValue | Returns a start X value of the corresponding heatmap cell. | |

GetYIndex | Returns the Y index of this value on a heatmap. | |

GetYIndicesRange | Returns the Y index range for the given Y data range on a heatmap. | |

GetYValue | Returns a start Y value of the corresponding heatmap cell. | |

GetZValue | Returns the Z value of the corresponding heatmap cell. | |

InvalidateParentSurface | May be called to trigger a redraw on the parent SciChart.Charting.Visuals.SciChartSurface. This method is extremely useful when SciChart.Charting.Model.DataSeries.IDataSeries are in a ViewModel and bound via MVVM to SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries. Please see the rangeMode parameter for invalidation options. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

ResumeUpdates | Resumes updates on the target, intended to be called by IUpdateSuspender (Inherited from SciChart.Core.Framework.ISuspendable) | |

SuspendUpdates | Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued (Inherited from SciChart.Core.Framework.ISuspendable) | |

ToHitTestInfo | Returns heatmap details for given , . | |

ToPointSeries | Converts the default YValues to an SciChart.Data.Model.IPointSeries which is used to render XY series. (Inherited from SciChart.Charting.Model.DataSeries.IDataSeries) | |

UpdateZValue | Updates Z value for the given X and Y indexes on a heatmap |

Extension Methods

Name | Description | |
---|---|---|

ToPointSeries |

See Also