DataSeries<TX,TY> Class Members
The following tables list the members exposed by DataSeries<TX,TY>.
Protected Constructors
Name | Description | |
---|---|---|
DataSeries<TX,TY> Constructor | Initializes a new instance of the DataSeries<TX,TY> class. |
Public Fields
Protected Fields
Name | Description | |
---|---|---|
_metaColumn | The metadata column for this DataSeries | |
_resamplerLock | The lock object for the resample operation | |
_xColumn | The XColumn for this DataSeries | |
_yColumn | The primary YColumn for this DataSeries |
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. | |
ChangeCount | Gets the change count for this data series. Allows to identify when data series was changed. | |
Count | Gets the number of points in this data series | |
DataContainsNaN | Gets whether the data contains NaN values | |
DataDistributionCalculator | Gets or Sets the DataDistrutionCalculator instance for this DataSeries. Used when resampling data to determine the correct algorithm | |
DataIsEvenlySpaced | Gets whether the data is evenly paced | |
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 | |
DataSeriesType | Gets the DataSeriesType for this DataSeries | |
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 | |
HasMetadata | Gets whether the SciChart.Charting.Model.DataSeries contains points' metadata | |
HasValues | Gets whether the SciChart.Charting.Model.DataSeries has values (is not empty) | |
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 | |
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 | |
IsSuspended | Gets a value indicating whether updates for the target are currently suspended | |
Item | Gets the item at the index from the specified DataSeriesColumn. | |
LatestYValue | Gets the latest Y-Value of the DataSeries | |
Metadata | Gets the Metadata of this series | |
MinXSpacing | Gets the minimal spacing between X Values | |
ParentSurface | Gets or sets the parent SciChart.Charting.Visuals.ISciChartSurface which this IDataSeries instance is attached to | |
SeriesName | Gets or sets the name of this series | |
SyncRoot | Synchronization object (per instance) | |
Tag | Gets or sets an arbitrary tag on the DataSeries | |
XMax | Gets the computed Maximum value in X for this series | |
XMin | Gets the computed Minimum value in X for this series | |
XRange | Gets the computed XRange, which is an SciChart.Data.Model.IRange wrapping XMin and XMax properties | |
XType | Gets the Type of X-data points in this DataSeries. Used to check compatibility with Axis types | |
XValues | Gets the X Values of this series | |
YMax | Gets the computed Maximum value in Y for this series | |
YMin | Gets the computed Minimum value in Y for this series | |
YRange | Gets the computed YRange, which is an SciChart.Data.Model.IRange wrapping YMin and YMax properties | |
YType | Gets the Type of Y-data points in this DataSeries. Used to check compatibility with Axis types | |
YValues | Gets the Y Values of this series |
Public Methods
Name | Description | |
---|---|---|
Append | Overloaded. Appends an X, Y point to the series | |
Clear | Clears the series, resetting internal lists to zero size. | |
Clone | Creates a deep copy of a DataSeries. | |
DecrementSuspend | Called by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called | |
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 | |
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 | |
FindIndex | Finds the index to the DataSeries at the specified X-Value | |
GetIndicesRange | Gets the integer indices of the XValues array that are currently in the VisibleRange passed in, and an indefinite range otherwise. | |
GetWindowedYRange | Overloaded. 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 | |
GetXMinAt | When overriden in a derived class, gets the Min(existingXMin, currentMin), where currentMin is the minimum at the specified index | |
GetXRange | Gets the XRange of the data (min, max of the series). | |
GetYMaxAt | When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index | |
GetYMinAt | When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index | |
InvalidateParentSurface | May be called to trigger a redraw on the parent SciChart.Charting.Visuals.SciChartSurface. This method is extremely useful when IDataSeries are in a ViewModel and bound via MVVM to SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries. Please see the rangeMode parameter for invalidation options | |
RemoveAt | Removes the X,Y values at the specified index | |
RemoveRange | Removes a range of points starting from the specified index | |
ResumeUpdates | Resumes updates on the target, intended to be called by IUpdateSuspender | |
SuspendUpdates | Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued | |
ToHitTestInfo | When overridden in a derived class, returns a SciChart.Charting.Visuals.RenderableSeries.HitTestInfo struct containing data about the data-point at the specified index | |
ToPointSeries | Converts the default YValues to an SciChart.Data.Model.IPointSeries which is used to render XY series |
Protected Methods
Name | Description | |
---|---|---|
AppendMetadata | Overloaded. Appends a single metadata value to the end of the Metadata list. | |
ClearColumns | When overridden in a derived class, clears all columns in the Data Series | |
EnsureColumnTypeAndCapacity | When overriden in a derived class, should convert between FIFO and normal columns and ensure column capacity | |
EnsureFifoBufferSizeAfterMemoryRelease | ||
GetPositiveMin<T> | Gets the minimum positive value of (positiveMin, min) | |
InsertMetadata | Overloaded. | |
OnDataSeriesChanged | Raises the DataSeriesChanged event | |
OnPropertyChanged | Overloaded. Raises the System.ComponentModel.INotifyPropertyChanged.PropertyChanged event (Inherited from SciChart.Data.Model.BindableObject) | |
Recreate<T> | Recreates a column with capacity | |
RecreateAsFifo<T> | Recreates a column with Fifo capacity | |
ThrowWhenAppendInvalid | Asserts correct number of parameters supplied to Append(TX, params TY) and throws if necessary | |
ThrowWhenParamsAreNull | Asserts that lists of X values and Y values are not null and throws if necessary | |
ThrowWhenParamsHaveDifferentSize | Asserts that lists of X values and Y values have the same number of values and throws if necessary | |
ToPointSeriesInternal |
Extension Methods
Name | Description | |
---|---|---|
DebugFinalizer<T> | Notifies that finalizer has been invoked | |
ToDoubleArray | Overloaded. Converts an System.IComparable array to double array | |
ToEnumerable<T> | Yields a single item, converting it to System.Collections.IEnumerable. | |
ToPointSeries | ||
ToStringArray2D<T> |
Public Events
Name | Description | |
---|---|---|
DataSeriesChanged | Event raised whenever points are added to, removed or one or more DataSeries properties changes | |
PropertyChanged | Occurs when a property value changes. (Inherited from SciChart.Data.Model.BindableObject) |
See Also
Reference
DataSeries<TX,TY> Class
SciChart.Charting.Model.DataSeries Namespace
DataSeries<TX,TY> Class
IDataSeries Interface
IDataSeries<TX,TY> Interface
IXyDataSeries<TX,TY> Interface
IXyDataSeries Interface
XyDataSeries<TX,TY> Class
IXyyDataSeries<TX,TY> Interface
IXyyDataSeries Interface
XyyDataSeries<TX,TY> Class
IOhlcDataSeries<TX,TY> Interface
IOhlcDataSeries Interface
OhlcDataSeries<TX,TY> Class
IHlcDataSeries<TX,TY> Interface
IHlcDataSeries Interface
HlcDataSeries<TX,TY> Class
IXyzDataSeries<TX,TY,TZ> Interface
IXyzDataSeries Interface
XyzDataSeries<TX,TY,TZ> Class
BaseRenderableSeries Class
DataSeries Property