LegendItem Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

This class implements a single item to be displayed in a Legend object.

[ILNumerics Visualization Engine]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.Drawing.PlottingLegendItem

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

Syntax

Copy

[SerializableAttribute]
public class LegendItem : Group, IPositionProvider

<SerializableAttribute>
Public Class LegendItem
	Inherits Group
	Implements IPositionProvider

Dim instance As LegendItem

The LegendItem type exposes the following members.

Constructors

	Name	Description
	LegendItem(Int32, Int32, String, Object)	Create new legend item for manual mode, provide provider reference and [optionally] a label string [ILNumerics Visualization Engine]
	LegendItem(ILegendItemDataProvider, Int32, String, Object)	Create new legend item for manual mode, provide provider reference and [optionally] a label string [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.)
	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.)
	EntryArea	Gets the renderable area displaying a visual associating this legend item with a corresponding data series. [ILNumerics Visualization Engine]
	ID	Unique ID for the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	Indices	This method returns null. [ILNumerics Visualization Engine]
	IsSynchedNode	(Inherited from Node.)
	Label	Gets a reference to the label object used for labeling this item in the LabelArea. [ILNumerics Visualization Engine]
	LabelArea	Gets the renderable label area Group object. Contains the Label object. [ILNumerics Visualization Engine]
	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.)
	MarkerPositions	The position of the marker within the legend entry area; (X,Y,Z) coordinates; default: (.375, .5, 0) [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.)
	Positions	Gets a copy of the marker positions configured for this legend item. [ILNumerics Visualization Engine]
	ProviderID	Gives a reference to the plot object for this legend item or sets it. [ILNumerics Visualization Engine]
	ProviderSubID	Stores the subID of the provider to distinguish provider items for e.g. bar plots, where more than one legend item is created by a single object. [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.)
	Text	Legend item label text override, default: null -> builds label text from source plot properties [ILNumerics Visualization Engine]
	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.)

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	In a derived class this method will be called before the renderer begins visiting this node. [ILNumerics Visualization Engine] (Overrides GroupBeginVisit(RenderParameter).)
	Configure	Configure the subtree after changes to any buffer [ILNumerics Visualization Engine] (Inherited from Group.)
	Copy	This method supports the ILNumerics infrastructure. It should not be used directly. [ILNumerics Visualization Engine] (Overrides GroupCopy.)
	CreateSynchedCopy	This method supports the ILNumerics infrastructure. It should not be used directly. [ILNumerics Visualization Engine] (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	(Inherited from Group.)
	GetProvider	Gets the ILegendItemDataProvider associated with this legend item. [ILNumerics Visualization Engine]
	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.)
	SetStyle
	Synchronize	This method supports the ILNumerics infrastructure. It should not be used directly. [ILNumerics Visualization Engine] (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.)
	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
	EntryAreaTag	Tag used to identiy the entry area within the scene graph
	LabelAreaTag	Tag used to identiy the label area within the scene graph
	LabelTag	Tag used to identiy the label within the scene graph
	LegendItemTag	Tag used to identiy the whole legend item (entry area, label area, label) within 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