OhlcDataSeries<TAllPoints> Class Members

The following tables list the members exposed by OhlcDataSeries<TAllPoints>.

Public Constructors

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

OhlcDataSeries<TAllPoints> Constructor |

Protected Fields

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

_metaColumn | The metadata column for this DataSeries (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

_xColumn | The XColumn for this DataSeries (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

_yColumn | The primary YColumn for this DataSeries (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) |

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.DataSeries<TX,TY>) | |

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

CloseValues | Gets the Close Values of this DataSeries, if the data is OHLC (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

Count | Gets the number of points in this data series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

DataContainsNaN | Gets whether the data contains NaN values (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

DataDistributionCalculator | Gets 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>) | |

DataIsEvenlySpaced | Gets whether the data is evenly paced (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

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.DataSeries<TX,TY>) | |

DataSeriesType | Gets the DataSeriesType for this DataSeries (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

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.DataSeries<TX,TY>) | |

HasMetadata | Gets whether the SciChart.Charting.Model.DataSeries contains points' metadata (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

HasValues | Gets whether the SciChart.Charting.Model.DataSeries has values (is not empty) (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

HighValues | Gets the High Values of this DataSeries, if the data is OHLC (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

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 (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

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.DataSeries<TX,TY>) | |

IsSuspended | Gets a value indicating whether updates for the target are currently suspended (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

Item | Gets the item at the index from the specified DataSeriesColumn. (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

LatestYValue | Gets the latest Y-Value of the DataSeries (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

LowValues | Gets the Low Values of this DataSeries, if the data is OHLC (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

Metadata | Gets the Metadata of this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

MinXSpacing | Gets the minimal spacing between X Values (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

OpenValues | Gets the Open Values of this DataSeries, if the data is OHLC (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

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

SeriesName | Gets or sets the name of this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

SyncRoot | Synchronization object (per instance) (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

Tag | Gets or sets an arbitrary tag on the DataSeries (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

XMax | Gets the computed Maximum value in X for this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

XMin | Gets the computed Minimum value in X for this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

XRange | Gets the computed XRange, which is an SciChart.Data.Model.IRange wrapping XMin and XMax properties (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

XType | Gets 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>) | |

XValues | Gets the X Values of this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

YMax | Gets the computed Maximum value in Y for this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

YMin | Gets the computed Minimum value in Y for this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

YRange | Gets the computed YRange, which is an SciChart.Data.Model.IRange wrapping YMin and YMax properties (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

YType | Gets 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>) | |

YValues | Gets the Y Values of this series (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) |

Public Methods

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

Append | Overloaded. (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

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

Clone | Creates a deep copy of a DataSeries. (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

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.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

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.DataSeries<TX,TY>) | |

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.DataSeries<TX,TY>) | |

FindIndex | Finds the index to the DataSeries at the specified X-Value (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

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.DataSeries<TX,TY>) | |

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 (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

GetXMinAt | When 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>) | |

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

GetYMaxAt | When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

GetYMinAt | When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

Insert | Overloaded. (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

InsertRange | Overloaded. (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

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 (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

RemoveAt | Removes the X,Y values at the specified index (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

RemoveRange | Removes a range of points starting from the specified index (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

ResumeUpdates | Resumes updates on the target, intended to be called by IUpdateSuspender (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

SuspendUpdates | Suspends 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>) | |

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 (Inherited from SciChart.Charting.Model.DataSeries.OhlcDataSeries<TAllPoints,TAllPoints>) | |

ToPointSeries | Converts 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>) | |

Update |

Protected Methods

Top

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 (Inherited from SciChart.Charting.Model.DataSeries.DataSeries<TX,TY>) | |

PropertyChanged | Occurs when a property value changes. (Inherited from SciChart.Data.Model.BindableObject) |

See Also