BoxPlotDataSeries
A generic DataSeries which provides data in Min, Lower Quartile, Median, Upper Quartile, Max format for consumption by the .
Inherits: DataSeries<T, T>
Constructors
public BoxPlotDataSeries()
boxPlotDataSeries = BoxPlotDataSeries()
Initializes a new instance of the BoxPlotDataSeries class.
Properties
public override DataSeriesType DataSeriesType { get; }
value = boxPlotDataSeries.DataSeriesType
Gets the DataSeriesType for this DataSeries
public override bool HasValues { get; }
value = boxPlotDataSeries.HasValues
Gets a value indicating whether this instance has values.
Methods
public override void Append(TX x, TY[] yValues)
boxPlotDataSeries.Append(x, yValues)
Appends an X, Y point to the series
- x
- The X Value
- yValues
- The Y Values (depends on series type)
public override void Append(IEnumerable<TX> x, IEnumerable<TY>[] yValues)
boxPlotDataSeries.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)
private void Append(TX x, TY median, TY minimum, TY lowerQuartile, TY upperQuartile, TY maximum)
boxPlotDataSeries.Append(x, median, minimum, lowerQuartile, upperQuartile, maximum)
Appends an Box-plot point to the series, including X-value, Minimum, Lower Quartile, Median, Upper Quartile, Maximum value
- x
- The X value
- median
- The median.
- minimum
- The minimum.
- lowerQuartile
- The lower quartile.
- upperQuartile
- The upper quartile.
- maximum
- The maximum.
public void Append(IEnumerable<TX> x, IEnumerable<TY> median, IEnumerable<TY> minimum, IEnumerable<TY> lowerQuartile, IEnumerable<TY> upperQuartile, IEnumerable<TY> maximum)
boxPlotDataSeries.Append(x, median, minimum, lowerQuartile, upperQuartile, maximum)
Appends a collection of Box-plot points to the series, including X-values, Minimum, Lower Quartile, Median, Upper Quartile, Maximum values
- x
- The X value
- median
- The median.
- minimum
- The minimum.
- lowerQuartile
- The lower quartile.
- upperQuartile
- The upper quartile.
- maximum
- The maximum.
protected override void ClearColumns()
boxPlotDataSeries.ClearColumns()
When overridden in a derived class, clears all columns in the Data Series
public override IDataSeries<TX, TY> Clone()
result = boxPlotDataSeries.Clone()
Creates a deep copy of a DataSeries
public override TY GetYMaxAt(int index, TY existingYMax)
result = boxPlotDataSeries.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 = boxPlotDataSeries.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 override void RemoveAt(int index)
boxPlotDataSeries.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)
boxPlotDataSeries.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 = boxPlotDataSeries.ToHitTestInfo(index)
When overridden in a derived class, returns a HitTestInfo instance 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 = boxPlotDataSeries.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