ILNumerics Ultimate VS

Legend Class

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Legend object

[ILNumerics Visualization Engine]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.DrawingScreenObject
        ILNumerics.Drawing.PlottingLegend

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

[SerializableAttribute]
public class Legend : ScreenObject

The Legend type exposes the following members.

Constructors

  NameDescription
Protected methodLegend
Initializes a new instance of the Legend class
Public methodLegend(String)
Create legend object for any suitable plot object in the plot cube; provide label text for all items

[ILNumerics Visualization Engine]

Public methodLegend(IEnumerableLegendItem, Object)
Create a new legend object, provide initial legend items

[ILNumerics Visualization Engine]

Public methodLegend(Group, IEnumerableString, Object, LegendItem, Label)
Create legend object for automatic configuration

[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 propertyAnchor
Gets the reference point for the location of the screen rectangle relative to the rectangles size. Default: center of the rectangle (.5,.5)

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyAnimations (Inherited from Group.)
Public propertyBackground
Background fill area

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyBorder
Border of the screen rectangle

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
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 propertyDefaultItemStyle
Holds an LegendItem template used to style new legend items or null.

[ILNumerics Visualization Engine]

Public propertyDefaultLabelStyle
The default label used to style the labels for newly created LegendItem items or null.

[ILNumerics Visualization Engine]

Public propertyHeight
Height of the screen rectangle in units defined by HeightUnit. Default: Auto (null); determined by content

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyHeightUnit
Units for the height of the screen rectangle

[ILNumerics Visualization Engine]

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

[ILNumerics Visualization Engine]

(Inherited from Node.)
Protected propertyIsSynchedNode (Inherited from Node.)
Public propertyItems
The collection of node items for display in this legend

[ILNumerics Visualization Engine]

Public propertyLegendItemSize
Get or sets the width for the area in pixels where lines & markers are drawn; default: 100px

[ILNumerics Visualization Engine]

Public propertyLocation
Location of the anchor point of the screen rectangle in units defined by LocationXUnit and LocationYUnit. Default: viewport center

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyLocationXUnit
Units for the horizontal location of the anchor point

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyLocationYUnit
Units for the vertical location of the anchor point

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
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 propertyMinimumSize
Minimum size of the screen rect when Size mode is null (auto), in units defined by WidthUnit and HeightUnit

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyMovable
Dis-/allows the user to move the rectangle on screen interactively (if supported by the driver). Default: true

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyPadding
Spacing between outer border of the legend and the legend items measured in pixels

[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 propertyRootID
Gets the root node of the subtree in the scene, which is considered for finding legend items automatically or sets it. Default: the plot cube containing this legend (null)

[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.)
Public propertyWidth
Width of the screen rectangle in units defined by WidthUnit. Default: Auto (null); determined by content

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyWidthUnit
Units for the width of the screen rectangle

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyZCoord
Gets or sets the Z coordinate for this screen object. Childs will take this as base depth value.

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
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 (Inherited from ScreenObject.)
Public methodConfigure
update all existing legend items

[ILNumerics Visualization Engine]

Public methodConfigure(Boolean, Boolean)
Configures the legend initially and after changes to child objects

[ILNumerics Visualization Engine]

(Overrides GroupConfigure(Boolean, Boolean).)
Public methodCopy (Overrides ScreenObjectCopy.)
Protected methodCreateSynchedCopy (Overrides ScreenObjectCreateSynchedCopy(Node).)
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 (Inherited from ScreenObject.)
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 methodGetLimits
Compute the 3D limits (extent) of this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Protected methodgetLimitsInternal (Inherited from ScreenObject.)
Public methodInsertT
Insert a node into the child collection at predefined index

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodMoveByPixels (Inherited from ScreenObject.)
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 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 (Overrides ScreenObjectSynchronize(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.)
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 memberDefaultLabelTag
Tag used to identify the default label object in a scene graph. Note, that using DefaultLabelStyle for rendering is not recommended.
Public fieldStatic memberItemsGroupTag
Tag used to identify legend item area group within the scene graph
Public fieldStatic memberLegendTag
Tag used to identify legends in the scene graph
Protected fieldm_animations (Inherited from Group.)
Protected fieldm_children (Inherited from Group.)
Protected fieldm_timeoutAware (Inherited from Group.)
Top
Remarks

[ILNumerics Visualization Engine]

See Also

Reference