Fields  Properties  Methods  Events


DataSeries<TX,TY> Class Members

The following tables list the members exposed by DataSeries<TX,TY>.

Protected Constructors
 NameDescription
Protected ConstructorInitializes a new instance of the DataSeries<TX,TY> class.  
Top
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)  
Public Fieldstatic (Shared in Visual Basic)  
Top
Protected Fields
 NameDescription
Protected Field The metadata column for this DataSeries  
Protected Fieldstatic (Shared in Visual Basic) The lock object for the resample operation  
Protected Field The XColumn for this DataSeries  
Protected Field The primary YColumn for this DataSeries  
Top
Public Properties
 NameDescription
Public Property 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.  
Public Property Gets the change count for this data series. Allows to identify when data series was changed.  
Public Property Gets the number of points in this data series  
Public Property Gets whether the data contains NaN values  
Public Property Gets or Sets the DataDistrutionCalculator instance for this DataSeries. Used when resampling data to determine the correct algorithm  
Public Property Gets whether the data is evenly paced  
Public Property 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  
Public PropertyGets the DataSeriesType for this DataSeries  
Public Property 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  
Public PropertyGets whether the SciChart.Charting.Model.DataSeries contains points' metadata  
Public PropertyGets whether the SciChart.Charting.Model.DataSeries has values (is not empty)  
Public Property 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  
Public Property 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  
Public Property Gets a value indicating whether updates for the target are currently suspended  
Public PropertyGets the item at the index from the specified DataSeriesColumn.  
Public Property Gets the latest Y-Value of the DataSeries  
Public Property Gets the Metadata of this series  
Public Property Gets the minimal spacing between X Values  
Public PropertyGets or sets the parent SciChart.Charting.Visuals.ISciChartSurface which this IDataSeries instance is attached to  
Public Property Gets or sets the name of this series  
Public Property Synchronization object (per instance)  
Public Property Gets or sets an arbitrary tag on the DataSeries  
Public Property Gets the computed Maximum value in X for this series  
Public Property Gets the computed Minimum value in X for this series  
Public PropertyGets the computed XRange, which is an SciChart.Data.Model.IRange wrapping XMin and XMax properties  
Public Property Gets the Type of X-data points in this DataSeries. Used to check compatibility with Axis types  
Public Property Gets the X Values of this series  
Public Property Gets the computed Maximum value in Y for this series  
Public Property Gets the computed Minimum value in Y for this series  
Public PropertyGets the computed YRange, which is an SciChart.Data.Model.IRange wrapping YMin and YMax properties  
Public Property Gets the Type of Y-data points in this DataSeries. Used to check compatibility with Axis types  
Public Property Gets the Y Values of this series  
Top
Public Methods
 NameDescription
Public MethodOverloaded.  Appends an X, Y point to the series  
Public Method Clears the series, resetting internal lists to zero size.  
Public Method Creates a deep copy of a DataSeries.  
Public Method Called by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called  
Public Method 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  
Public Method 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  
Public Method Finds the index to the DataSeries at the specified X-Value  
Public Method Gets the integer indices of the XValues array that are currently in the VisibleRange passed in, and an indefinite range otherwise.  
Public MethodOverloaded. 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  
Public Method When overriden in a derived class, gets the Min(existingXMin, currentMin), where currentMin is the minimum at the specified index  
Public Method Gets the XRange of the data (min, max of the series).  
Public Method When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index  
Public Method When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index  
Public MethodMay 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  
Public Method Removes the X,Y values at the specified index  
Public Method Removes a range of points starting from the specified index  
Public Method Resumes updates on the target, intended to be called by IUpdateSuspender  
Public Method Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued  
Public MethodWhen overridden in a derived class, returns a SciChart.Charting.Visuals.RenderableSeries.HitTestInfo struct containing data about the data-point at the specified index  
Public MethodConverts the default YValues to an SciChart.Data.Model.IPointSeries which is used to render XY series  
Top
Protected Methods
 NameDescription
Protected MethodOverloaded. Appends a single metadata value to the end of the Metadata list.  
Protected Method When overridden in a derived class, clears all columns in the Data Series  
Protected Method When overriden in a derived class, should convert between FIFO and normal columns and ensure column capacity  
Protected Method  
Protected Method Gets the minimum positive value of (positiveMin, min)  
Protected MethodOverloaded.   
Protected MethodRaises the DataSeriesChanged event  
Protected MethodOverloaded. Raises the System.ComponentModel.INotifyPropertyChanged.PropertyChanged event (Inherited from SciChart.Data.Model.BindableObject)
Protected Methodstatic (Shared in Visual Basic) Recreates a column with capacity  
Protected Method Recreates a column with Fifo capacity  
Protected Method Asserts correct number of parameters supplied to Append(TX, params TY) and throws if necessary  
Protected Method Asserts that lists of X values and Y values are not null and throws if necessary  
Protected Method Asserts that lists of X values and Y values have the same number of values and throws if necessary  
Protected Method  
Top
Extension Methods
 NameDescription
Public Extension Method Notifies that finalizer has been invoked
Public Extension MethodOverloaded. Converts an System.IComparable array to double array
Public Extension MethodYields a single item, converting it to System.Collections.IEnumerable.
Public Extension Method
Public Extension Method
Top
Public Events
 NameDescription
Public Event Event raised whenever points are added to, removed or one or more DataSeries properties changes  
Public Event Occurs when a property value changes. (Inherited from SciChart.Data.Model.BindableObject)
Top
See Also