ILNumerics Ultimate VS

LinePlot Class

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
A class used to visualize 1-,2- and 3 dimensional data as line plots with markers.

[ILNumerics Visualization Engine]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.Drawing.PlottingLinePlot
        ILNumerics.Drawing.PlottingSplinePlot

Namespace:  ILNumerics.Drawing.Plotting
Assembly:  ILNumerics.Drawing (in ILNumerics.Drawing.dll) Version: ILNumerics Ultimate VS 4
Syntax

[SerializableAttribute]
public class LinePlot : Group, IPositionProvider, 
	ILegendItemDataProvider

The LinePlot type exposes the following members.

Constructors

  NameDescription
Protected methodLinePlot
Default constructor.

[ILNumerics Visualization Engine]

Protected methodLinePlot(LinePlot)
Copy constructor.

[ILNumerics Visualization Engine]

Public methodLinePlot(InArraySingle, Object, NullableColor, DashStyle, Int32, NullableColor, MarkerStyle)
Creates a new line plot

[ILNumerics Visualization Engine]

Public methodLinePlot(InArrayDouble, InArrayDouble, Object, NullableColor, DashStyle, Int32, NullableColor, MarkerStyle)
Create a new line plot based on individually provided X and Y values.

[ILNumerics Visualization Engine]

Public methodLinePlot(InArraySingle, InArraySingle, Object, NullableColor, DashStyle, Int32, NullableColor, MarkerStyle)
Create a new line plot based on individually provided X and Y values.

[ILNumerics Visualization Engine]

Public methodLinePlot(InArrayDouble, InArrayDouble, InArrayDouble, Object, NullableColor, DashStyle, Int32, NullableColor, MarkerStyle)
Create a new line plot based on individually provided X and Y values.

[ILNumerics Visualization Engine]

Public methodLinePlot(InArraySingle, InArraySingle, InArraySingle, Object, NullableColor, DashStyle, Int32, NullableColor, MarkerStyle)
Create a new line plot based on individually provided X and Y values.

[ILNumerics Visualization Engine]

Top
Properties

  NameDescription
Public propertyAlpha
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.)
Public propertyAnimations (Inherited from Group.)
Public propertyChildren
Collection of child for this group

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyClipping
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.)
Public propertyColorOverride
If set, this color will override all individual colors in this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyID
Unique ID for the node within the scene

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyIndices
Provides indices of line vertices

[ILNumerics Visualization Engine]

Protected propertyIsSynchedNode (Inherited from Node.)
Public propertyLine
Gets access to the line of the line plot

[ILNumerics Visualization Engine]

Public propertyMarkable
Determines, if this node can be marked by the user

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyMarked
Marked state for the node

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyMarker
Gets access to the marker of the line plot

[ILNumerics Visualization Engine]

Public propertyOriginalDimensions
Number of dimensions of the data this line plot was created from.

[ILNumerics Visualization Engine]

Public propertyParent
Get the parent of this node or null, if this node is a root node

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyPickingID
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.)
Public propertyPositions
Provides positions of line vertices

[ILNumerics Visualization Engine]

Protected propertySynchedVersion
The version of the sync source from the last synchronization.

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyTag
Object tag used to identify the node within the scene

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyTarget
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.)
Public propertyTimeoutAware
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.)
Public propertyTransform
[4x4] matrix with the affine transforms which this node applies to all children

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyVersion
Modification version of this node, gets incremented at every change

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyVisible
Determines, if this node is visible or sets the visible state

[ILNumerics Visualization Engine]

(Inherited from Node.)
Top
Methods

  NameDescription
Public methodAdd(Node)
Add a node to the end of this groups child collection

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodAddT(T, Object, Boolean)
Add a node to the end of this groups child collection

[ILNumerics Visualization Engine]

(Inherited from Group.)
Protected methodBeginVisit
pushes the transform, alpha and color overrides of this node to the render parameter stack

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodConfigure
Configure the subtree after changes to any buffer

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodConfigureLegendLabel
Creates textual / label representation for the line

[ILNumerics Visualization Engine]

Public methodConfigureLegendVisual
Creates visual representation for the line

[ILNumerics Visualization Engine]

Public methodCopy
Creates a copy of LinePlot.

[ILNumerics Visualization Engine]

(Overrides GroupCopy.)
Protected methodCreateSynchedCopy
Creates a synchronized copy of LinePlot.

[ILNumerics Visualization Engine]

(Overrides GroupCreateSynchedCopy(Node).)
Public methodStatic memberCreateXPlots
Creates a new X-line plot for every row in A

[ILNumerics Visualization Engine]

Public methodDetach
Detach all shapes from this subtree for individual configurations

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodDispose
Dispose the complete subtree (this is rarely needed)

[ILNumerics Visualization Engine]

(Inherited from Group.)
Protected methodEndVisit
pops the render parameter from render parameter stack

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodFind(Object, NullablePrimitives)
Searches the subtree for nodes with matching tag and (optional) primitive type

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodFindT(Object, PredicateT)
Searches the subtree for all nodes with matching criteria

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodFindByIdT
Finds a typed node in this subtree, filter by ID

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodFirstT
Gets first node with matching criteria from subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodFirstUpT
Finds a group node on the path up to root

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodGetEnumerator (Inherited from Group.)
Public methodGetID
Gets the Id of the line plot

[ILNumerics Visualization Engine]

Public methodGetItemCount
Gets the number of items this plot displays. This returns 1.

[ILNumerics Visualization Engine]

Public methodGetLimits
Compute the 3D limits (extent) of this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Protected methodgetLimitsInternal (Inherited from Group.)
Public methodGetVersion
Gets the modification version of the line plot

[ILNumerics Visualization Engine]

Public methodInsertT
Insert a node into the child collection at predefined index

[ILNumerics Visualization Engine]

(Inherited from Group.)
Protected methodOnDisposing (Inherited from Node.)
Protected methodOnMouseClick (Inherited from Node.)
Protected methodOnMouseDoubleClick (Inherited from Node.)
Protected methodOnMouseDown (Inherited from Node.)
Protected methodOnMouseEnter (Inherited from Node.)
Protected methodOnMouseLeave (Inherited from Node.)
Protected methodOnMouseMove (Inherited from Node.)
Protected methodOnMouseUp (Inherited from Node.)
Protected methodOnMouseWheel (Inherited from Node.)
Protected methodOnPropertyChanged (Inherited from Node.)
Protected methodprovideMarkerPositions
Provides the positions of markers and adjusts axes of the plot cube.

[ILNumerics Visualization Engine]

Protected methodRaiseMouseClick (Inherited from Node.)
Protected methodRaiseMouseDoubleClick (Inherited from Node.)
Protected methodRaiseMouseDown (Inherited from Node.)
Protected methodRaiseMouseEnter (Inherited from Node.)
Protected methodRaiseMouseLeave (Inherited from Node.)
Protected methodRaiseMouseMove (Inherited from Node.)
Protected methodRaiseMouseUp (Inherited from Node.)
Protected methodRaiseMouseWheel (Inherited from Node.)
Public methodRemove
Remove a node from this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodRotate(Quaternion)
Rotate this subtree by quaternion

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodRotate(Vector3, Double)
Rotate this subtree by rotation axis and angle

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodRotate(Double, Double, Double, Double)
Rotate this subtree by rotation axis and angle

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodScale(Vector3)
Scales this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodScale(Double, Double, Double)
Scales this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodSynchronize
Synchronizes LinePlot

[ILNumerics Visualization Engine]

(Overrides GroupSynchronize(Node, SyncParams).)
Protected methodSynchronizeChildren (Inherited from Group.)
Public methodToString
String representation of the group node

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodTranslate(Vector3)
Translates this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodTranslate(Double, Double, Double)
Translates this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodUpdate
Update key positions of this line plot

[ILNumerics Visualization Engine]

Protected methodVisitInternal (Inherited from Group.)
Top
Events

  NameDescription
Public eventDisposing
Fires, before the node is getting disposed

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseClick
Fires when the object is clicked

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseDoubleClick
Fires when the object was double clicked

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseDown
Fires when a mouse button was pressed over the object

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseEnter
Fires when the mouse enters the object region

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseLeave
Fires when the mouse leaves the object region

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseMove
Fires when the mouse was moved over the object

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseUp
Fires when a mouse button was released over the object

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseWheel
Fires when the mouse wheel was moved over the object

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventPropertyChanged
Fires on any property state changes

[ILNumerics Visualization Engine]

(Inherited from Node.)
Top
Fields

  NameDescription
Public fieldStatic memberLinePlotTag
Tag identifying line plots within the scene graph
Public fieldStatic memberLineTag
Tag identifying individual lines within the line plot
Protected fieldm_animations (Inherited from Group.)
Protected fieldm_children (Inherited from Group.)
Protected fieldm_timeoutAware (Inherited from Group.)
Public fieldStatic memberMarkerTag
Tag identifying markers for line plots within the scene graph
Public fieldStatic memberNextColors
Color enumerator used to color subsequent lines
Top
Remarks

[ILNumerics Visualization Engine]

See Also

Reference