BarPlot Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

The class creates a bar plot object (horizontal, vertical, 2D, 3D).

[ILNumerics Drawing2 Toolbox]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.Drawing.PlottingBarPlot

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 sealed class BarPlot : Group, 
	IPositionProvider, ILegendItemDataProvider

<SerializableAttribute>
Public NotInheritable Class BarPlot
	Inherits Group
	Implements IPositionProvider, ILegendItemDataProvider

Dim instance As BarPlot

The BarPlot type exposes the following members.

Constructors

	Name	Description
	BarPlot(InArrayDouble, InArrayDouble, Object, BarPlotStyle, NullableColor, NullableColor, Int32, DashStyle, Single, Single, Boolean, Boolean)	Creates a new Bar plot based on provided values Y. [ILNumerics Drawing2 Toolbox]
	BarPlot(InArraySingle, InArraySingle, Object, BarPlotStyle, NullableColor, NullableColor, Int32, DashStyle, Single, Single, Boolean, Boolean)	Creates a new Bar plot based on provided values Y. [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.)
	Axis	Gets the axis of BarPlot. [ILNumerics Drawing2 Toolbox]
	BarWidth	Gets or sets the bar width. [ILNumerics Drawing2 Toolbox]
	BaseValue	Get or sets the location for the baseline. [ILNumerics Drawing2 Toolbox]
	Border	Gets access to the border line shape of the bar plot [readonly]. [ILNumerics Drawing2 Toolbox]
	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.)
	Draw3D	Gets or sets whether the bars are rendered as 3D objects. [ILNumerics Drawing2 Toolbox]
	Fill	Gets access to the triangles shape used for rendering the bars fill area [readonly]. [ILNumerics Drawing2 Toolbox]
	Horizontal	Get or sets the rendering style of the bar plot. [ILNumerics Drawing2 Toolbox]
	ID	Unique ID for the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	Indices	Provides indices of line vertices [ILNumerics Drawing2 Toolbox]
	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.)
	Padding	Gets or sets the distance between groups. [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.)
	Positions	Provides positions of line vertices [ILNumerics Drawing2 Toolbox]
	Style	Controls the way the bars of multiple groups are arranged. [ILNumerics Drawing2 Toolbox]
	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.)
	Ticks	Property gets or sets working axis ticks of current BarPlot. [ILNumerics Drawing2 Toolbox]
	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.)
	UseLighting	Determines, if the bar plot utilizes lighting. Default: Auto (null, light for flat bar plots, no light for 3D bar plots) [ILNumerics Drawing2 Toolbox]
	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.)

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.)
	Configure	In any event of changes, this method is called to update BarPlot and its axes. [ILNumerics Drawing2 Toolbox] (Overrides GroupConfigure(Boolean, Boolean).)
	ConfigureLegendLabel	Creates textual / label representation for the line. [ILNumerics Drawing2 Toolbox]
	ConfigureLegendVisual	Creates visual representation for the line. [ILNumerics Drawing2 Toolbox]
	Copy	Creates a copy of BarPlot. [ILNumerics Drawing2 Toolbox] (Overrides GroupCopy.)
	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.)
	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.)
	GetID	Gets the ID of the bar plot. [ILNumerics Drawing2 Toolbox]
	GetItemCount	Gets the bar group count. [ILNumerics Drawing2 Toolbox]
	GetLimits	Compute the 3D limits (extent) of this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	GetVersion	Gets the modification version of the bar plot. [ILNumerics Drawing2 Toolbox]
	InsertT	Insert a node into the child collection at predefined index [ILNumerics Visualization Engine] (Inherited from Group.)
	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.)
	SetBarColor	Method sets custom border and fill color to single Bar by ID. [ILNumerics Drawing2 Toolbox]
	SetGroupColor	Method sets custom border and fill color to group of bars by ID. [ILNumerics Drawing2 Toolbox]
	SetTick	Sets custom tick label by ID. [ILNumerics Drawing2 Toolbox]
	Synchronize	Synchronizes the synchronized copy of BarPlot. [ILNumerics Drawing2 Toolbox] (Overrides GroupSynchronize(Node, SyncParams).)
	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(InArrayDouble, ArrayDouble)	Method updates key values of each bar in bar plot. [ILNumerics Drawing2 Toolbox]
	Update(InArraySingle, InArraySingle)	Method updates key values of each bar in bar plot. [ILNumerics Drawing2 Toolbox]

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
	BarBorderTag	Tag identifying all bar plot's bar's border's lines within the scene graph.
	BarFillTag	Tag identifying all bar plot's bar's fill's triangle shapes within the scene graph.
	BarPlotAxisXTag	Tag identifying this bar plot's X axis, unique for each bar plot.
	BarPlotAxisYTag	Tag identifying this bar plot's Y axis, unique for each bar plot.
	BarPlotAxisZTag	Tag identifying this bar plot's Z axis, unique for each bar plot.
	BarPlotTag	Tag identifying all bar plot objects within the scene graph
	NextColors	Color enumerator used to color subsequent bars.

Top

Remarks

[ILNumerics Drawing2 Toolbox]

Reference

ILNumerics.Drawing.Plotting Namespace