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 FieldGets the last SciChart.Data.Model.IPointSeries as a result of a Resampling operation e.g. calling ToPointSeries. This cached value is also returned when resampling a series more than once with the same parameters.  
Protected FieldThe metadata column for this DataSeries  
Protected FieldThe XColumn for this DataSeries  
Protected FieldThe primary YColumn for this DataSeries  
Top
Public Properties
 NameDescription
Public PropertyNew 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 PropertyGets the change count for this data series. Allows to indentify when data series was changed  
Public PropertyGets the number of points in this data series  
Public PropertyGets whether the data contains NaN values  
Public PropertyGets or Sets the DataDistrutionCalculator instance for this DataSeries. Used when resampling data to determine the correct algorithm  
Public PropertyGets whether the data is evenly paced  
Public PropertyGets 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 PropertyGets 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 PropertyGets a value indicating whether this instance is attached.  
Public PropertyGets 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 PropertyGets 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 a value indicating whether updates for the target are currently suspended  
Public PropertyGets the item at the index from the specified DataSeriesColumn.  
Public PropertyGets the latest Y-Value of the DataSeries  
Public PropertyGets the Metadata of this series  
Public PropertyGets the minimal spacing between X Values  
Public PropertyGets or sets the parent SciChart.Charting.Visuals.ISciChartSurface which this IDataSeries instance is attached to  
Public PropertyGets or sets the name of this series  
Public PropertySynchronization object (per instance)  
Public PropertyGets or sets an arbitrary tag on the DataSeries  
Public PropertyGets the computed Maximum value in X for this series  
Public PropertyGets 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 PropertyGets the Type of X-data points in this DataSeries. Used to check compatibility with Axis types  
Public PropertyGets the X Values of this series  
Public PropertyGets the computed Maximum value in Y for this series  
Public PropertyGets 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 PropertyGets the Type of Y-data points in this DataSeries. Used to check compatibility with Axis types  
Public PropertyGets the Y Values of this series  
Top
Public Methods
 NameDescription
Public MethodOverloaded. Appends an X, Y point to the series  
Public MethodClears the series, resetting internal lists to zero size.  
Public MethodCreates a deep copy of a DataSeries.  
Public MethodCalled by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called  
Public MethodFinds 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 MethodFinds 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 MethodFinds the index to the DataSeries at the specified X-Value  
Public MethodGets 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 MethodWhen overriden in a derived class, gets the Min(existingXMin, currentMin), where currentMin is the minimum at the specified index  
Public MethodWhen overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index  
Public MethodWhen 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 MethodRemoves the X,Y values at the specified index  
Public MethodRemoves a range of points starting from the specified index  
Public MethodResumes updates on the target, intended to be called by IUpdateSuspender  
Public MethodSuspends 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 MethodWhen overridden in a derived class, clears all columns in the Data Series  
Protected MethodGets 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)  
Protected Method  
Protected MethodAsserts correct number of parameters supplied to Append(TX, params TY) and throws if necessary  
Protected MethodAsserts that lists of X values and Y values are not null and throws if necessary  
Protected MethodAsserts 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 MethodYields a single item, converting it to System.Collections.IEnumerable.
Public Extension Method
Public Extension Method
Top
Public Events
 NameDescription
Public EventEvent raised whenever points are added to, removed or one or more DataSeries properties changes  
Public EventOccurs when a property value changes. (Inherited from SciChart.Data.Model.BindableObject)
Top
See Also