Calculates and creates box Plot Series based on sourceSeries. SourceSeries is one or more semi-colon separated series names. As a result each Box Plot point values will be calculated and added for each series specified in the parameter. The First Y value of the series will be used by default. Optionally, with the name of the series, the user can specify which value to use. For example, "Price:Y2;Volume"
Syntax
Visual Basic (Usage) |
Copy Code |
Dim chart As Chart
Dim sourceSeries As String
Dim boxPlotWhiskerPercentileDefault As Double
Dim boxPlotPercentileDefault As Double
Dim value As Series
value = HorizontalBoxPlot.CalculateHorizontalBoxPlot(chart, sourceSeries, boxPlotWhiskerPercentileDefault, boxPlotPercentileDefault)
|
Parameters
- chart
- Chart control
- sourceSeries
- Semi-colon separated series names.
- boxPlotWhiskerPercentileDefault
- The percentile value of the whiskers of the box plot chart.
- boxPlotPercentileDefault
- The percentile value of the box of the box plot chart.
Return Value
Series with calculated box plot data points
Exceptions
Exception |
Description |
ArgumentNullException |
Thrown when any passed parameter is null or sourceSeries is empty. |
ArgumentOutOfRangeException |
Thrown when boxPlotWhiskerPercentileDefault or boxPlotPercentileDefault are out of possible ranges, or passed wrong use value. |
Requirements
Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family
See Also