HlcDataSeries
The HlcDataSeries provides a generic data-source in High-Low-Close format for Hlc charts as well as Error bar charts. See also which requires this DataSeries type as a Data-source. Any 2D renderable Series type such as will render the X-Close value as X-Y.
Inherits: DataSeries<T, T>
Implements: IHlcDataSeries<T, T>, IDataSeries<T, T>, IDataSeries, ISuspendable, IHlcDataSeries
Constructors
public HlcDataSeries()
hlcDataSeries = HlcDataSeries()
Initializes a new instance of the HlcDataSeries class.
Properties
public override DataSeriesType DataSeriesType { get; }
value = hlcDataSeries.DataSeriesType
Gets the DataSeriesType for this DataSeries
public override bool HasValues { get; }
value = hlcDataSeries.HasValues
Gets a value indicating whether this instance has values.
public IList<TY> HighValues { get; }
value = hlcDataSeries.HighValues
Gets the High Values of this DataSeries
public IList<TY> LowValues { get; }
value = hlcDataSeries.LowValues
Gets the Low Values of this DataSeries
StockSharp#Xaml#Charting#Model#DataSeries#IHlcDataSeries#HighValues
Gets the High Values of this DataSeries as a List of IComparable
StockSharp#Xaml#Charting#Model#DataSeries#IHlcDataSeries#LowValues
Gets the Low Values of this DataSeries as a List of IComparable
public override IRange YRange { get; }
value = hlcDataSeries.YRange
Gets the computed YRange, which is an IRange wrapping YMin and YMax properties
Methods
public void Append(IEnumerable<TX> x, IEnumerable<TY> y, IEnumerable<TY> high, IEnumerable<TY> low)
hlcDataSeries.Append(x, y, high, low)
Appends a list of Open, High, Low, Close points to the series
- x
- The list of X values
- y
- The list of Y values
- high
- The list of High values
- low
- The list of Low values
public void Append(TX x, TY y, TY high, TY low)
hlcDataSeries.Append(x, y, high, low)
Appends an Open, High, Low, Close point to the series
- x
- The X value
- y
- The Y value
- high
- The High value
- low
- The Low value
public override void Append(IEnumerable<TX> x, IEnumerable<TY>[] yValues)
hlcDataSeries.Append(x, yValues)
Appends a list of X, Y points to the series
- x
- The list of X points
- yValues
- Lists of Y points (depends on series type)
public override void Append(TX x, TY[] yValues)
hlcDataSeries.Append(x, yValues)
Appends an X, Y point to the series
- x
- The X Value
- yValues
- The Y Values (depends on series type)
protected override void ClearColumns()
hlcDataSeries.ClearColumns()
When overridden in a derived class, clears all columns in the Data Series
public override IDataSeries<TX, TY> Clone()
result = hlcDataSeries.Clone()
Creates a deep copy of a DataSeries
public override TY GetYMaxAt(int index, TY existingYMax)
result = hlcDataSeries.GetYMaxAt(index, existingYMax)
When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index
- index
- The index to the underlying dataset
- existingYMax
- The existing maximum
Returns: The new YMax, which is the Min(existingYMax, currentMax)
public override TY GetYMinAt(int index, TY existingYMin)
result = hlcDataSeries.GetYMinAt(index, existingYMin)
When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index
- index
- The index to the underlying dataset
- existingYMin
- The existing minimum
Returns: The new YMin, which is the Min(existingYMin, currentMin)
public void Insert(int index, TX x, TY y, TY high, TY low)
hlcDataSeries.Insert(index, x, y, high, low)
Inserts an Open, High, Low, Close point at the specified index
- index
- The index to insert at
- x
- The X value
- y
- The Y value
- high
- The High value
- low
- The low value
public void InsertRange(int startIndex, IEnumerable<TX> x, IEnumerable<TY> y, IEnumerable<TY> high, IEnumerable<TY> low)
hlcDataSeries.InsertRange(startIndex, x, y, high, low)
Inserts a list of Open, High, Low, Close points at the specified index
- startIndex
- The index to insert at
- x
- The list of X values
- y
- The list of y values
- high
- The list of High values
- low
- The list of Low values
public override void RemoveAt(int index)
hlcDataSeries.RemoveAt(index)
Removes the X,Y values at the specified index
- index
- The index to remove at
public override void RemoveRange(int startIndex, int count)
hlcDataSeries.RemoveRange(startIndex, count)
Removes a range of points starting from the specified index
- startIndex
- Starting index of the range of elements to remove
- count
- The number of elements to remove
public override HitTestInfo ToHitTestInfo(int index)
result = hlcDataSeries.ToHitTestInfo(index)
When overridden in a derived class, returns a HitTestInfo struct containing data about the data-point at the specified index
- index
- The index to the DataSeries
Returns: The HitTestInfo
public override IPointSeries ToPointSeries(ResamplingMode resamplingMode, IndexRange pointRange, int viewportWidth, bool isCategoryAxis, bool? dataIsDisplayedAs2D, IRange visibleXRange, IPointResamplerFactory factory, object pointSeriesArg)
result = hlcDataSeries.ToPointSeries(resamplingMode, pointRange, viewportWidth, isCategoryAxis, dataIsDisplayedAs2D, visibleXRange, factory, pointSeriesArg)
Converts the default YValues to an IPointSeries which is used to render XY series
- resamplingMode
- The desired ResamplingMode
- pointRange
- The integer Indices range in the parent data-set
- viewportWidth
- The current width of the viewport
- isCategoryAxis
- If true, uses the indices to form the resampled X-values, else uses the X-Values themselves
- dataIsDisplayedAs2D
- If true, then data is presented as a scatter series without relationship between the points, e.g. not a line series
- visibleXRange
- The XAxis VisibleRange at the time of resampling
- factory
- The IPointResamplerFactory Instance
- pointSeriesArg
- Additional parameter to the point series.
Returns: A IPointSeries which is used to render XY series
public void Update(TX x, TY y, TY high, TY low)
hlcDataSeries.Update(x, y, high, low)
Updates an Open, High, Low, Close point specified by the X-Value passed in.
- x
- The X Value to key on when updating
- y
- The Y value
- high
- The High value
- low
- The Low value