WPF Charting Documentation - SciChart WPF Charts SDK v5.x
HlcDataSeries<TX,TY> Class Members
Fields  Properties  Methods  Events


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

Public Constructors
 NameDescription
Public ConstructorHlcDataSeries<TX,TY> ConstructorInitializes a new instance of the HlcDataSeries<TX,TY> class.  
Top
Protected Fields
 NameDescription
Protected Field_lastPointSeriesGets 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. (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected Field_metaColumnThe metadata column for this DataSeries (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected Field_xColumnThe XColumn for this DataSeries (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected Field_yColumnThe primary YColumn for this DataSeries (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Top
Public Properties
 NameDescription
Public PropertyAcceptsUnsortedDataNew 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.DataSeries<TX,TY>)
Public PropertyChangeCountGets the change count for this data series. Allows to indentify when data series was changed (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyCountGets the number of points in this data series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyDataContainsNaNGets whether the data contains NaN values (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyDataDistributionCalculatorGets or Sets the DataDistrutionCalculator instance for this DataSeries. Used when resampling data to determine the correct algorithm (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyDataIsEvenlySpacedGets whether the data is evenly paced (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyDataIsSortedAscendingGets 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.DataSeries<TX,TY>)
Public PropertyDataSeriesTypeOverridden. Gets the DataSeriesType for this DataSeries  
Public PropertyFifoCapacityGets 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.DataSeries<TX,TY>)
Public PropertyHasMetadataGets whether the SciChart.Charting.Model.DataSeries contains points' metadata (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyHasValuesOverridden. Gets whether the SciChart.Charting.Model.DataSeries has values (is not empty)  
Public PropertyHighValuesGets the High Values of this DataSeries.  
Public PropertyIsAttachedGets a value indicating whether this instance is attached. (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyIsFifoGets whether the dataseries behaves as a FIFO If True, when the FifoCapacity is reached, old points will be discarded in favour of new points (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyIsSortedGets 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.DataSeries<TX,TY>)
Public PropertyIsSuspendedGets a value indicating whether updates for the target are currently suspended (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyItemGets the item at the index from the specified DataSeriesColumn. (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyLatestYValueGets the latest Y-Value of the DataSeries (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyLowValuesGets the Low Values of this DataSeries.  
Public PropertyMetadataGets the Metadata of this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyMinXSpacingGets the minimal spacing between X Values (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyParentSurfaceGets or sets the parent SciChart.Charting.Visuals.ISciChartSurface which this IDataSeries instance is attached to (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertySeriesNameGets or sets the name of this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertySyncRootSynchronization object (per instance) (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyTagGets or sets an arbitrary tag on the DataSeries (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyXMaxGets the computed Maximum value in X for this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyXMinGets the computed Minimum value in X for this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyXRangeGets the computed XRange, which is an SciChart.Data.Model.IRange wrapping XMin and XMax properties (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyXTypeGets the Type of X-data points in this DataSeries. Used to check compatibility with Axis types (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyXValuesGets the X Values of this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyYMaxGets the computed Maximum value in Y for this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyYMinGets the computed Minimum value in Y for this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyYRangeOverridden. Gets the computed YRange, which is an SciChart.Data.Model.IRange wrapping YMin and YMax properties  
Public PropertyYTypeGets the Type of Y-data points in this DataSeries. Used to check compatibility with Axis types (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public PropertyYValuesGets the Y Values of this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Top
Public Methods
 NameDescription
Public MethodAppendOverloaded. Overridden. Appends an X, Y point to the series  
Public MethodClearClears the series, resetting internal lists to zero size. (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public MethodCloneOverridden. Creates a deep copy of a DataSeries.  
Public MethodDecrementSuspendCalled by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public MethodFindClosestLineFinds 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.DataSeries<TX,TY>)
Public MethodFindClosestPointFinds 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.DataSeries<TX,TY>)
Public MethodFindIndexFinds the index to the DataSeries at the specified X-Value (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public MethodGetIndicesRangeGets 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.DataSeries<TX,TY>)
Public MethodGetWindowedYRangeOverloaded. 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.DataSeries<TX,TY>)
Public MethodGetXMinAtWhen overriden in a derived class, gets the Min(existingXMin, currentMin), where currentMin is the minimum at the specified index (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public MethodGetYMaxAtOverridden. When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index  
Public MethodGetYMinAtOverridden. When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index  
Public MethodInsertOverloaded. Inserts an Open, High, Low, Close point at the specified index.  
Public MethodInsertRangeOverloaded. Inserts a list of Open, High, Low, Close points at the specified index.  
Public MethodInvalidateParentSurfaceMay 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 (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public MethodRemoveAtOverridden. Removes the X,Y values at the specified index  
Public MethodRemoveRangeOverridden. Removes a range of points starting from the specified index  
Public MethodResumeUpdatesResumes updates on the target, intended to be called by IUpdateSuspender (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public MethodSuspendUpdatesSuspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public MethodToHitTestInfoOverridden. When overridden in a derived class, returns a SciChart.Charting.Visuals.RenderableSeries.HitTestInfo struct containing data about the data-point at the specified index  
Public MethodToPointSeriesConverts the default YValues to an SciChart.Data.Model.IPointSeries which is used to render XY series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Public MethodUpdateOverloaded. Updates an Open, High, Low, Close point at the specified index. Automatically triggers a redraw.  
Top
Protected Methods
 NameDescription
Protected MethodAppendMetadataOverloaded. Appends a single metadata value to the end of the Metadata list. (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected MethodClearColumnsOverridden. When overridden in a derived class, clears all columns in the Data Series  
Protected MethodGetPositiveMin<T>Gets the minimum positive value of (positiveMin, min) (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected MethodInsertMetadataOverloaded.  (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected MethodOnDataSeriesChangedRaises the DataSeriesChanged event (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected MethodOnPropertyChangedOverloaded. Raises the System.ComponentModel.INotifyPropertyChanged.PropertyChanged event (Inherited from SciChart.Data.Model.BindableObject)
Protected MethodRecreateAsFifo<T> (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected MethodThrowWhenAppendInvalidAsserts correct number of parameters supplied to Append(TX, params TY) and throws if necessary (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected MethodThrowWhenParamsAreNullAsserts that lists of X values and Y values are not null and throws if necessary (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected MethodThrowWhenParamsHaveDifferentSizeAsserts that lists of X values and Y values have the same number of values and throws if necessary (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Protected MethodToPointSeriesInternalOverridden. Converts the default YValues to an SciChart.Data.Model.IPointSeries which is used to render XY series.  
Top
Extension Methods
 NameDescription
Public Extension MethodToEnumerable<T>Yields a single item, converting it to System.Collections.IEnumerable.
Public Extension MethodToPointSeries
Public Extension MethodToStringArray2D<T>
Top
Public Events
 NameDescription
Public EventDataSeriesChangedEvent raised whenever points are added to, removed or one or more DataSeries properties changes (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>)
Top
Protected Events
 NameDescription
Protected Event_propertyChangedOccurs when a property value changes. (Inherited from SciChart.Data.Model.BindableObject)
Top
See Also

Reference

HlcDataSeries<TX,TY> Class
SciChart.Charting.Model.DataSeries Namespace
FastErrorBarsRenderableSeries Class
FastLineRenderableSeries Class
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
BoxPlotDataSeries<TX,TY> Class
BaseRenderableSeries Class
FastErrorBarsRenderableSeries Class

 

 


SCICHART ® is a Registered Trademark in the UK, US and EU. Copyright SciChart Ltd 2011-2018.

Send Feedback