BoxPlot Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

A class used to create error bars.

[ILNumerics Drawing2 Toolbox]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.Drawing.PlottingBoxPlot

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

Syntax

Copy

[SerializableAttribute]
public class BoxPlot : Group

<SerializableAttribute>
Public Class BoxPlot
	Inherits Group

Dim instance As BoxPlot

The BoxPlot type exposes the following members.

Constructors

	Name	Description
	BoxPlot	Default constructor. [ILNumerics Drawing2 Toolbox]
	BoxPlot(BoxPlot)	Copy constructor. [ILNumerics Drawing2 Toolbox]
	BoxPlot(InArrayDouble, InArrayDouble, Double, Boolean, Boolean, NullableColor, NullableColor, NullableColor, NullableColor, NullableColor, Int32, Int32, Int32, Single, DashStyle, DashStyle, DashStyle, Object)	Constructor defines BoxPlot on the basis of the row vector X and the matrix Data [ILNumerics Drawing2 Toolbox]
	BoxPlot(InArraySingle, InArraySingle, Double, Boolean, Boolean, NullableColor, NullableColor, NullableColor, NullableColor, NullableColor, Int32, Int32, Int32, Single, DashStyle, DashStyle, DashStyle, Object)	Constructor defines BoxPlot on the basis of the row vector X and the matrix Data. [ILNumerics Drawing2 Toolbox]

Top

Properties

	Name	Description
	Alpha	Alpha value, range [0...1], if set, this value modifies the alpha values for ALL nodes of this subtree. Use for blend effects only! [ILNumerics Visualization Engine] (Inherited from Group.)
	Animations	(Inherited from Group.)
	Children	Collection of child for this group [ILNumerics Visualization Engine] (Inherited from Group.)
	Clipping	Gets all 6 available clipping planes for the group or sets it. Null: derive clipping from parent node (default) [ILNumerics Visualization Engine] (Inherited from Group.)
	ColorOverride	If set, this color will override all individual colors in this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	FillArea	Provides a reference to the fill areas of box plots [ILNumerics Drawing2 Toolbox]
	Frame	Provides a reference to the frames of box plots [ILNumerics Drawing2 Toolbox]
	ID	Unique ID for the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	IsSynchedNode	(Inherited from Node.)
	Markable	Determines, if this node can be marked by the user [ILNumerics Visualization Engine] (Inherited from Node.)
	Marked	Marked state for the node [ILNumerics Visualization Engine] (Inherited from Node.)
	Median	Provides a reference to the medians of box plots [ILNumerics Drawing2 Toolbox]
	Parent	Get the parent of this node or null, if this node is a root node [ILNumerics Visualization Engine] (Inherited from Node.)
	PickingID	If set to a valid shape ID, that shape will be marked in picking operations insted of this shape. [ILNumerics Visualization Engine] (Inherited from Node.)
	ScatteredPlot	Provides a reference to the scattered plots of box plots. [ILNumerics Drawing2 Toolbox]
	SynchedVersion	The version of the sync source from the last synchronization. [ILNumerics Visualization Engine] (Inherited from Node.)
	Tag	Object tag used to identify the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	Target	If set, determines the target for rendering: world (3D) or screen (2D) on top. Default: not set (derive from parent) [ILNumerics Visualization Engine] (Inherited from Group.)
	TimeoutAware	Sets if this group and all children are sensible for timeouts during rendering or gets that flag. Default: null -> derive from parent [ILNumerics Visualization Engine] (Inherited from Group.)
	Transform	[4x4] matrix with the affine transforms which this node applies to all children [ILNumerics Visualization Engine] (Inherited from Group.)
	Version	Modification version of this node, gets incremented at every change [ILNumerics Visualization Engine] (Inherited from Node.)
	Visible	Determines, if this node is visible or sets the visible state [ILNumerics Visualization Engine] (Inherited from Node.)
	WhiskerHLine	Provides a reference to the horizontal whisker lines of box plots. [ILNumerics Drawing2 Toolbox]
	WhiskerVLine	Provides a reference to the vertical whisker lines of box plots [ILNumerics Drawing2 Toolbox]

Top

Methods

	Name	Description
	Add(Node)	Add a node to the end of this groups child collection [ILNumerics Visualization Engine] (Inherited from Group.)
	AddT(T, Object, Boolean)	Add a node to the end of this groups child collection [ILNumerics Visualization Engine] (Inherited from Group.)
	BeginVisit	pushes the transform, alpha and color overrides of this node to the render parameter stack [ILNumerics Visualization Engine] (Inherited from Group.)
	Configure	Configure the subtree after changes to any buffer [ILNumerics Visualization Engine] (Inherited from Group.)
	Copy	Deep copy of this surface object to a new object, sharing buffers. [ILNumerics Drawing2 Toolbox] (Overrides GroupCopy.)
	CreateSynchedCopy	Creates a synchronized copy. [ILNumerics Drawing2 Toolbox] (Overrides GroupCreateSynchedCopy(Node).)
	Detach	Detach all shapes from this subtree for individual configurations [ILNumerics Visualization Engine] (Inherited from Group.)
	Dispose	Dispose the complete subtree (this is rarely needed) [ILNumerics Visualization Engine] (Inherited from Group.)
	EndVisit	pops the render parameter from render parameter stack [ILNumerics Visualization Engine] (Inherited from Group.)
	Find(Object, NullablePrimitives)	Searches the subtree for nodes with matching tag and (optional) primitive type [ILNumerics Visualization Engine] (Inherited from Group.)
	FindT(Object, PredicateT)	Searches the subtree for all nodes with matching criteria [ILNumerics Visualization Engine] (Inherited from Group.)
	FindByIdT	Finds a typed node in this subtree, filter by ID [ILNumerics Visualization Engine] (Inherited from Group.)
	FirstT	Gets first node with matching criteria from subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	FirstUpT	Finds a group node on the path up to root [ILNumerics Visualization Engine] (Inherited from Group.)
	GetEnumerator	(Inherited from Group.)
	GetLimits	Compute the 3D limits (extent) of this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	getLimitsInternal	Computes new limits for BoxPlot. [ILNumerics Drawing2 Toolbox] (Overrides GroupgetLimitsInternal(StackMatrix4, Limits, Boolean, NullableVector3).)
	InsertT	Insert a node into the child collection at predefined index [ILNumerics Visualization Engine] (Inherited from Group.)
	OnDisposing	(Inherited from Node.)
	OnMouseClick	(Inherited from Node.)
	OnMouseDoubleClick	(Inherited from Node.)
	OnMouseDown	(Inherited from Node.)
	OnMouseEnter	(Inherited from Node.)
	OnMouseLeave	(Inherited from Node.)
	OnMouseMove	(Inherited from Node.)
	OnMouseUp	(Inherited from Node.)
	OnMouseWheel	(Inherited from Node.)
	OnPropertyChanged	(Inherited from Node.)
	RaiseMouseClick	(Inherited from Node.)
	RaiseMouseDoubleClick	(Inherited from Node.)
	RaiseMouseDown	(Inherited from Node.)
	RaiseMouseEnter	(Inherited from Node.)
	RaiseMouseLeave	(Inherited from Node.)
	RaiseMouseMove	(Inherited from Node.)
	RaiseMouseUp	(Inherited from Node.)
	RaiseMouseWheel	(Inherited from Node.)
	Remove	Remove a node from this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Rotate(Quaternion)	Rotate this subtree by quaternion [ILNumerics Visualization Engine] (Inherited from Group.)
	Rotate(Vector3, Double)	Rotate this subtree by rotation axis and angle [ILNumerics Visualization Engine] (Inherited from Group.)
	Rotate(Double, Double, Double, Double)	Rotate this subtree by rotation axis and angle [ILNumerics Visualization Engine] (Inherited from Group.)
	Scale(Vector3)	Scales this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Scale(Double, Double, Double)	Scales this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Synchronize	[Internal use] Synchronize this object with the rendering scene tree. [ILNumerics Drawing2 Toolbox] (Overrides GroupSynchronize(Node, SyncParams).)
	SynchronizeChildren	(Inherited from Group.)
	ToString	String representation of the group node [ILNumerics Visualization Engine] (Inherited from Group.)
	Translate(Vector3)	Translates this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Translate(Double, Double, Double)	Translates this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Update	Call this method to update horizontal or vertical position of the box plots X and the underlying data Data. [ILNumerics Drawing2 Toolbox]
	VisitInternal	(Inherited from Group.)

Top

Events

	Name	Description
	Disposing	Fires, before the node is getting disposed [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseClick	Fires when the object is clicked [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseDoubleClick	Fires when the object was double clicked [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseDown	Fires when a mouse button was pressed over the object [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseEnter	Fires when the mouse enters the object region [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseLeave	Fires when the mouse leaves the object region [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseMove	Fires when the mouse was moved over the object [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseUp	Fires when a mouse button was released over the object [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseWheel	Fires when the mouse wheel was moved over the object [ILNumerics Visualization Engine] (Inherited from Node.)
	PropertyChanged	Fires on any property state changes [ILNumerics Visualization Engine] (Inherited from Node.)

Top

Fields

	Name	Description
	DefaultTag	Default tag used to identify box plots objects in the scene: "BoxPlot".
	FillAreaTag	Default tag used to identify fill areas of box plots in the scene: "FillArea".
	FrameTag	Default tag used to identify frames of box plots in the scene: "Frame".
	m_animations	(Inherited from Group.)
	m_children	(Inherited from Group.)
	m_timeoutAware	(Inherited from Group.)
	MedianTag	Default tag used to identify medians of box plots in the scene: "Median".
	ScatteredPlotTag	Default tag used to identify scattered plots of box plots in the scene: "ScatteredPlot".
	WhiskerHLineTag	Default tag used to identify horizontal whisker lines of box plots in the scene: "WhiskerHLines".
	WhiskerVLineTag	Default tag used to identify vertical whisker lines of box plots in the scene: "WhiskerVLines".

Top

Remarks

[ILNumerics Drawing2 Toolbox]

Reference

ILNumerics.Drawing.Plotting Namespace