ErrorBarPlot Constructor (InArrayDouble, InArrayDouble, InArrayDouble, Boolean, Boolean, NullableColor, Int32, Single, MarkerStyle, NullableColor, NullableColor, Int32, DashStyle, Object)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Constructor defines ErrorBarPlot on the basis of the matrix XY and the row vectors L and T

[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 ErrorBarPlot(
	InArray<double> XY,
	InArray<double> L,
	InArray<double> T = null,
	bool drawVertical = true,
	bool visibleLine = true,
	Nullable<Color> errorbarColor = null,
	int errorbarLineWidth = 1,
	float errorbarWidth = 0,025f,
	MarkerStyle markerStyle = MarkerStyle.Dot,
	Nullable<Color> markerColor = null,
	Nullable<Color> lineColor = null,
	int lineWidth = 1,
	DashStyle lineStyle = DashStyle.Solid,
	Object tag = null
)

Public Sub New ( 
	XY As InArray(Of Double),
	L As InArray(Of Double),
	Optional T As InArray(Of Double) = Nothing,
	Optional drawVertical As Boolean = true,
	Optional visibleLine As Boolean = true,
	Optional errorbarColor As Nullable(Of Color) = Nothing,
	Optional errorbarLineWidth As Integer = 1,
	Optional errorbarWidth As Single = 0,025F,
	Optional markerStyle As MarkerStyle = MarkerStyle.Dot,
	Optional markerColor As Nullable(Of Color) = Nothing,
	Optional lineColor As Nullable(Of Color) = Nothing,
	Optional lineWidth As Integer = 1,
	Optional lineStyle As DashStyle = DashStyle.Solid,
	Optional tag As Object = Nothing
)

Dim XY As InArray(Of Double)
Dim L As InArray(Of Double)
Dim T As InArray(Of Double)
Dim drawVertical As Boolean
Dim visibleLine As Boolean
Dim errorbarColor As Nullable(Of Color)
Dim errorbarLineWidth As Integer
Dim errorbarWidth As Single
Dim markerStyle As MarkerStyle
Dim markerColor As Nullable(Of Color)
Dim lineColor As Nullable(Of Color)
Dim lineWidth As Integer
Dim lineStyle As DashStyle
Dim tag As Object

Dim instance As New ErrorBarPlot(XY, L, T, 
	drawVertical, visibleLine, errorbarColor, 
	errorbarLineWidth, errorbarWidth, 
	markerStyle, markerColor, lineColor, 
	lineWidth, lineStyle, tag)

Parameters

XY: Type: ILNumericsInArrayDouble
Matrix that contains x and y coordinates of an arbitrary two dimensional curve.
L: Type: ILNumericsInArrayDouble
Row vector that contains distance between bottom of error bar to vertex of curve.
T (Optional): Type: ILNumericsInArrayDouble
[optional] Row vector that contains distance between top of error bar to vertex of curve, default: L.
drawVertical (Optional): Type: SystemBoolean
[optional] Draws error bars vertical or horizontal when set to false, default: true
visibleLine (Optional): Type: SystemBoolean
[optional] Displays line plot when set to true, default: true
errorbarColor (Optional): Type: SystemNullableColor
[optional] Line color of error bar, default: Red
errorbarLineWidth (Optional): Type: SystemInt32
[optional] Line width of error bar, default: 1px
errorbarWidth (Optional): Type: SystemSingle
[optional] Width of error bar, default: 0.025
markerStyle (Optional): Type: ILNumerics.DrawingMarkerStyle
[optional] Marker style, default: Dot
markerColor (Optional): Type: SystemNullableColor
[optional] Marker color, default: Blue
lineColor (Optional): Type: SystemNullableColor
[optional] Line color, default: Blue
lineWidth (Optional): Type: SystemInt32
[optional] Line width, default: 1px
lineStyle (Optional): Type: ILNumerics.DrawingDashStyle
[optional] Line style, default: solid
tag (Optional): Type: SystemObject
[optional] Identifies the ErrorBarPlot object in the scene graph

Exceptions

Exception	Condition
ArgumentException	If input argument XY is not a matrix.
ArgumentException	If input argument XY is not a (2 x n) matrix.

Remarks

[ILNumerics Drawing2 Toolbox]

Examples

Creating an ErrorBarPlot object

Copy

private void ilPanel1_Load(object sender, EventArgs e)
{
    // Generate Data
    Array<double> XY = linspace<double>(0, 20, 25);
    XY[1,full] = 2 * cos(XY[0,full]);
    Array<double> L = rand(1, 25);
    Array<double> T = rand(1, 25);
    // Create PlotCube object
    var myPlotCube = ilPanel1.Scene.Add(new PlotCube());
    // Create ErrorBarPlot object
    var myErrorBarPlot = myPlotCube.Add(new ErrorBarPlot(XY, L, T, errorbarWidth: 0.5f, visibleLine: false));
}

Reference

ErrorBarPlot Class

ErrorBarPlot Overload

ILNumerics.Drawing.Plotting Namespace