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

Copy

[SerializableAttribute]
public class Legend : ScreenObject

<SerializableAttribute>
Public Class Legend
	Inherits ScreenObject

Dim instance As Legend

The Legend type exposes the following members.

Constructors

	Name	Description
	Legend	Initializes a new instance of the Legend class
	Legend(String)	Create legend object for any suitable plot object in the plot cube; provide label text for all items [ILNumerics Visualization Engine]
	Legend(IEnumerableLegendItem, Object)	Create a new legend object, provide initial legend items [ILNumerics Visualization Engine]
	Legend(Group, IEnumerableString, Object, LegendItem, Label)	Create legend object for automatic configuration [ILNumerics Visualization Engine]

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.)
	Anchor	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.)
	Animations	(Inherited from Group.)
	Background	Background fill area [ILNumerics Visualization Engine] (Inherited from ScreenObject.)
	Border	Border of the screen rectangle [ILNumerics Visualization Engine] (Inherited from ScreenObject.)
	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.)
	DefaultItemStyle	Holds an LegendItem template used to style new legend items or null. [ILNumerics Visualization Engine]
	DefaultLabelStyle	The default label used to style the labels for newly created LegendItem items or null. [ILNumerics Visualization Engine]
	Height	Height of the screen rectangle in units defined by HeightUnit. Default: Auto (null); determined by content [ILNumerics Visualization Engine] (Inherited from ScreenObject.)
	HeightUnit	Units for the height of the screen rectangle [ILNumerics Visualization Engine] (Inherited from ScreenObject.)
	ID	Unique ID for the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	IsSynchedNode	(Inherited from Node.)
	Items	The collection of node items for display in this legend [ILNumerics Visualization Engine]
	LegendItemSize	Get or sets the width for the area in pixels where lines & markers are drawn; default: 100px [ILNumerics Visualization Engine]
	Location	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.)
	LocationXUnit	Units for the horizontal location of the anchor point [ILNumerics Visualization Engine] (Inherited from ScreenObject.)
	LocationYUnit	Units for the vertical location of the anchor point [ILNumerics Visualization Engine] (Inherited from ScreenObject.)
	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.)
	MinimumSize	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.)
	Movable	Dis-/allows the user to move the rectangle on screen interactively (if supported by the driver). Default: true [ILNumerics Visualization Engine] (Inherited from ScreenObject.)
	Padding	Spacing between outer border of the legend and the legend items measured in pixels [ILNumerics Visualization Engine]
	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.)
	RootID	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]
	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.)
	Width	Width of the screen rectangle in units defined by WidthUnit. Default: Auto (null); determined by content [ILNumerics Visualization Engine] (Inherited from ScreenObject.)
	WidthUnit	Units for the width of the screen rectangle [ILNumerics Visualization Engine] (Inherited from ScreenObject.)
	ZCoord	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

	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	(Inherited from ScreenObject.)
	Configure	update all existing legend items [ILNumerics Visualization Engine]
	Configure(Boolean, Boolean)	Configures the legend initially and after changes to child objects [ILNumerics Visualization Engine] (Overrides GroupConfigure(Boolean, Boolean).)
	Copy	(Overrides ScreenObjectCopy.)
	CreateSynchedCopy	(Overrides ScreenObjectCreateSynchedCopy(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	(Inherited from ScreenObject.)
	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	(Inherited from ScreenObject.)
	InsertT	Insert a node into the child collection at predefined index [ILNumerics Visualization Engine] (Inherited from Group.)
	MoveByPixels	(Inherited from ScreenObject.)
	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	(Overrides ScreenObjectSynchronize(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.)
	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
	DefaultLabelTag	Tag used to identify the default label object in a scene graph. Note, that using DefaultLabelStyle for rendering is not recommended.
	ItemsGroupTag	Tag used to identify legend item area group within the scene graph
	LegendTag	Tag used to identify legends in the scene graph
	m_animations	(Inherited from Group.)
	m_children	(Inherited from Group.)
	m_timeoutAware	(Inherited from Group.)

Top

Remarks

[ILNumerics Visualization Engine]

Reference

ILNumerics.Drawing.Plotting Namespace