BoxPlot Constructor (InArraySingle, InArraySingle, Double, Boolean, Boolean, NullableColor, NullableColor, NullableColor, NullableColor, NullableColor, Int32, Int32, Int32, Single, DashStyle, DashStyle, DashStyle, Object)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Constructor defines BoxPlot on the basis of the row vector X and the matrix Data.

[ILNumerics Drawing2 Toolbox]

Namespace: ILNumerics.Drawing.Plotting
Assembly: ILNumerics.Toolboxes.Drawing2 (in ILNumerics.Toolboxes.Drawing2.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

Copy

public BoxPlot(
	InArray<float> X,
	InArray<float> Data,
	double boxWidth = 0,6,
	bool drawScatteredPlot = false,
	bool drawVertical = true,
	Nullable<Color> fillAreaColor = null,
	Nullable<Color> frameColor = null,
	Nullable<Color> medianColor = null,
	Nullable<Color> whiskerColor = null,
	Nullable<Color> pointColor = null,
	int frameWidth = 1,
	int medianWidth = 2,
	int whiskerWidth = 1,
	float pointSize = 5f,
	DashStyle frameStyle = DashStyle.Solid,
	DashStyle medianStyle = DashStyle.Solid,
	DashStyle whiskerStyle = DashStyle.Dashed,
	Object tag = null
)

Public Sub New ( 
	X As InArray(Of Single),
	Data As InArray(Of Single),
	Optional boxWidth As Double = 0,6,
	Optional drawScatteredPlot As Boolean = false,
	Optional drawVertical As Boolean = true,
	Optional fillAreaColor As Nullable(Of Color) = Nothing,
	Optional frameColor As Nullable(Of Color) = Nothing,
	Optional medianColor As Nullable(Of Color) = Nothing,
	Optional whiskerColor As Nullable(Of Color) = Nothing,
	Optional pointColor As Nullable(Of Color) = Nothing,
	Optional frameWidth As Integer = 1,
	Optional medianWidth As Integer = 2,
	Optional whiskerWidth As Integer = 1,
	Optional pointSize As Single = 5F,
	Optional frameStyle As DashStyle = DashStyle.Solid,
	Optional medianStyle As DashStyle = DashStyle.Solid,
	Optional whiskerStyle As DashStyle = DashStyle.Dashed,
	Optional tag As Object = Nothing
)

Dim X As InArray(Of Single)
Dim Data As InArray(Of Single)
Dim boxWidth As Double
Dim drawScatteredPlot As Boolean
Dim drawVertical As Boolean
Dim fillAreaColor As Nullable(Of Color)
Dim frameColor As Nullable(Of Color)
Dim medianColor As Nullable(Of Color)
Dim whiskerColor As Nullable(Of Color)
Dim pointColor As Nullable(Of Color)
Dim frameWidth As Integer
Dim medianWidth As Integer
Dim whiskerWidth As Integer
Dim pointSize As Single
Dim frameStyle As DashStyle
Dim medianStyle As DashStyle
Dim whiskerStyle As DashStyle
Dim tag As Object

Dim instance As New BoxPlot(X, Data, 
	boxWidth, drawScatteredPlot, drawVertical, 
	fillAreaColor, frameColor, medianColor, 
	whiskerColor, pointColor, frameWidth, 
	medianWidth, whiskerWidth, pointSize, 
	frameStyle, medianStyle, whiskerStyle, 
	tag)

Parameters

X: Type: ILNumericsInArraySingle
Row vector that contains horizontal or vertical positions of each box plot.
Data: Type: ILNumericsInArraySingle
Matrix that contains data. For each column a box plot is drawn.
boxWidth (Optional): Type: SystemDouble
[optional] Width of box plots, default: 0.6.
drawScatteredPlot (Optional): Type: SystemBoolean
[optional] Draws an additional scattered plot based on Data when set to true, default: false.
drawVertical (Optional): Type: SystemBoolean
[optional] Draws box plots vertical or horizontal when set to false, default: true.
fillAreaColor (Optional): Type: SystemNullableColor
[optional] Color of fill areas, default: White.
frameColor (Optional): Type: SystemNullableColor
[optional] Color of frames, default: Black.
medianColor (Optional): Type: SystemNullableColor
[optional] Color of medians, default: Black.
whiskerColor (Optional): Type: SystemNullableColor
[optional] Color of whiskers, default: Black.
pointColor (Optional): Type: SystemNullableColor
[optional] Color of scattered plots or outliers, default: Black.
frameWidth (Optional): Type: SystemInt32
[optional] Line width of frames, default: 1px.
medianWidth (Optional): Type: SystemInt32
[optional] Line width of medians, default: 2px.
whiskerWidth (Optional): Type: SystemInt32
[optional] Line width of whiskers, defualt: 1px.
pointSize (Optional): Type: SystemSingle
[optional] Size of points of scattered plots or outliers, default: 5.
frameStyle (Optional): Type: ILNumerics.DrawingDashStyle
[optional] Linestyle of frames, default: solid.
medianStyle (Optional): Type: ILNumerics.DrawingDashStyle
[optional] Linestyle of medians, default: solid.
whiskerStyle (Optional): Type: ILNumerics.DrawingDashStyle
[optional] Linestyle of whiskers, default: dashed.
tag (Optional): Type: SystemObject
[optional] Identifies the BarPlot object in the scene graph.

Remarks

[ILNumerics Drawing2 Toolbox]

Examples

Creating an BoxPlot object

Copy

private void ilPanel1_Load(object sender, EventArgs e)
{
Array<float> X = linspace<float>(1, 3, 2);
Array<float> Data = new float[,] { { 10, 2, 1, 0, 2, 4 }, { 8, 9, 8, 0, 10, 7 } };
var plotCube = ilPanel1.Scene.Add(new PlotCube());
var boxPlot = plotCube.Add(new BoxPlot(X, Data, boxWidth: 1));
}

Reference

BoxPlot Class

BoxPlot Overload

ILNumerics.Drawing.Plotting Namespace