Legend Class

SystemObject
  Imsl.Chart2DAbstractChartNode
    Imsl.Chart2DChartNode
      Imsl.Chart2DAxis
        Imsl.Chart2DAxisXY
          Imsl.Chart2DLegend

[SerializableAttribute]
public class Legend : AxisXY

<SerializableAttribute>
Public Class Legend
	Inherits AxisXY

[SerializableAttribute]
public ref class Legend : public AxisXY

[<SerializableAttribute>]
type Legend =  
    class
        inherit AxisXY
    end

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FirePickListeners	Invokes the pick delegates defined at this node and at all of its ancestors, if the event "hits" the node. (Inherited from ChartNode.)
	GetAttribute	Gets the value of an attribute. (Inherited from AbstractChartNode.)
	GetBooleanAttribute	Convenience routine to get a Boolean-valued attribute. (Inherited from AbstractChartNode.)
	GetChildren	Gets the list of child nodes. (Inherited from ChartNode.)
	GetColorAttribute	Convenience routine to get a Color-valued attribute. (Inherited from AbstractChartNode.)
	GetComponent	Gets the "Component" attribute value. (Inherited from ChartNode.)
	GetConcatenatedViewport	Returns the value of the "Viewport" attribute concatenated with the "Viewport" attributes set in its ancestor nodes. (Inherited from ChartNode.)
	GetCross	Returns the "Cross" attribute value. (Inherited from AxisXY.)
	GetDoubleAttribute	Convenience routine to get a Double-valued attribute. (Inherited from AbstractChartNode.)
	GetFillPaint	Returns the "FillPaint" attribute value. (Inherited from ChartNode.)
	GetGradient	Returns the value of the "Gradient" attribute. (Inherited from ChartNode.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIntegerAttribute	Convenience routine to get an Integer-valued attribute. (Inherited from AbstractChartNode.)
	GetLineDashPattern	Returns the "LineDashPattern" attribute value. (Inherited from ChartNode.)
	GetMarkerDashPattern	Returns the "MarkerDashPattern" attribute value. (Inherited from ChartNode.)
	GetScreenViewport	Returns the value of the "Viewport" attribute scaled by the screen size. (Inherited from ChartNode.)
	GetStringAttribute	Convenience routine to get a String-valued attribute. (Inherited from AbstractChartNode.)
	GetTitle	Returns the value of the "Title" attribute. (Inherited from ChartNode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetViewport	Returns the value of the "Viewport" attribute. (Inherited from ChartNode.)
	GetWebComponent	Gets the "Component" attribute value. (Inherited from ChartNode.)
	GetX	Returns the "X" attribute value. (Inherited from AbstractChartNode.)
	GetY	Returns the "Y" attribute value. (Inherited from AbstractChartNode.)
	IsAncestorOf	Determines if this node is an ancestor of the argument node. (Inherited from AbstractChartNode.)
	IsAttributeSet	Determines if an attribute is defined (may have been inherited). (Inherited from AbstractChartNode.)
	IsAttributeSetAtThisNode	Determines if an attribute is defined in this node (not inherited). (Inherited from AbstractChartNode.)
	MapDeviceToUser	Maps the device coordinates to user coordinates. (Inherited from AxisXY.)
	MapUserToDevice	Maps the user coordinates (userX, userY) to the device coordinates devXY. (Inherited from AxisXY.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnPick	Invokes delegates registered with the Pick event. (Inherited from ChartNode.)
	Paint	Paints this node and all of its children. (Overrides AxisXYPaint(Draw).)
	PrePaint	The PrePaint method is called in all nodes in a chart just before the chart is painted. The default implementation does nothing. Override this method to do computations just before painting in a chart node. (Inherited from ChartNode.)
	Remove	Removes the node from its parents list of children. (Inherited from AbstractChartNode.)
	SetAttribute	Sets an attribute. (Inherited from AbstractChartNode.)
	SetCross(Double)	Sets the "Cross" attribute value. (Inherited from AxisXY.)
	SetCross(Double, Double)	Sets the "Cross" attribute value. (Inherited from AxisXY.)
	SetFillPaint(Brush)	Sets the value of the "FillPaint" attribute. (Inherited from ChartNode.)
	SetFillPaint(Image)	Sets the "FillPaint" attribute value. (Inherited from ChartNode.)
	SetFillPaint(Uri)	Sets the "FillPaint" attribute value. (Inherited from ChartNode.)
	SetGradient(Color)	Sets the value of the "Gradient" attribute. (Inherited from ChartNode.)
	SetGradient(Color, Color, Color, Color)	Sets the value of the "Gradient" attribute. (Inherited from ChartNode.)
	SetLineDashPattern	Sets the "LineDashPattern" attribute value. (Inherited from ChartNode.)
	SetMarkerDashPattern	Sets the "MarkerDashPattern" attribute value. (Inherited from ChartNode.)
	SetTitle(String)	Sets the value of the "Title" attribute. (Inherited from ChartNode.)
	SetTitle(Text)	Sets the value of the "Title" attribute. (Inherited from ChartNode.)
	SetUpMapping	Initializes the mappings between user and coordinate space. (Inherited from AxisXY.)
	SetViewport(Double)	Used to specify the viewport location. (Inherited from ChartNode.)
	SetViewport(Double, Double, Double, Double)	Used to specify the viewport location. (Inherited from ChartNode.)
	SetWindow	Sets the window for an AxisXY. (Inherited from AxisXY.)
	SetX	Sets the "X" attribute value. (Inherited from AbstractChartNode.)
	SetY	Sets the "Y" attribute value. (Inherited from AbstractChartNode.)
	ToString	Returns the name of this chart node. (Inherited from AbstractChartNode.)

Top

	Name	Description
	WebCtrl	A bool indicating if this ChartNode is a WebControl. (Inherited from ChartNode.)

Top

	Name	Description
	AbstractParent	Indicates the parent of this AbstractChartNode. (Inherited from AbstractChartNode.)
	ALT	Used to construct an "alt" attribute value in client side image maps. (Inherited from ChartNode.)
	AutoscaleInput	Indicates what inputs are used for autoscaling. (Inherited from AbstractChartNode.)
	AutoscaleMinimumTimeInterval	Specifies the minimum tick mark interval for autoscaled time axes. (Inherited from AbstractChartNode.)
	AutoscaleOutput	Specifies what attributes to change as a result of autoscaling. (Inherited from AbstractChartNode.)
	Axis	Typically provides a mapping for children from the user coordinate space to the device (screen) space. (Inherited from ChartNode.)
	AxisX	The X axis associated with this node. (Inherited from AxisXY.)
	AxisY	The Y axis associated with this node. (Inherited from AxisXY.)
	Background	The base graphic layer displayed behind other ChartNode objects in the tree. (Inherited from ChartNode.)
	BarGap	Specifies the gap between bars in a group. (Inherited from ChartNode.)
	BarType	Specifies the orientation of the BarChart. (Inherited from ChartNode.)
	BarWidth	The width of all of the groups of bars at each index. (Inherited from ChartNode.)
	Chart	This is the root node of the chart tree. (Inherited from ChartNode.)
	ChartTitle	Specifies a title for the chart. (Inherited from ChartNode.)
	ClipData	Specifies whether the data elements are to be clipped to the current window. (Inherited from ChartNode.)
	CultureInfo	Adds support for Windows supported locales. (Inherited from AbstractChartNode.)
	CustomTransform	Allows for the specification of a custom transform. (Inherited from AbstractChartNode.)
	DataType	Specifies how the data is to be rendered. (Inherited from ChartNode.)
	Density	Specifies the number of minor tick marks in the interval between major tick marks. (Inherited from AbstractChartNode.)
	DoubleBuffering	Specifies whether double is active. (Inherited from ChartNode.)
	Explode	Specifies how far from the center pie slices are drawn. (Inherited from ChartNode.)
	FillColor	Specifies a color that will be used to fill an area. (Inherited from AbstractChartNode.)
	FillOutlineColor	Specifies a color that will be used to outline this node. (Inherited from ChartNode.)
	FillOutlineType	Specifies a fill pattern type for the outline of this node. (Inherited from ChartNode.)
	FillType	Specifies a fill pattern type for this node. (Inherited from ChartNode.)
	Font	Defines a particular format for text, including font name, size, and style attributes. (Inherited from AbstractChartNode.)
	FontName	Specifies the font to be used by name. (Inherited from AbstractChartNode.)
	FontSize	Specifies the font size. (Inherited from AbstractChartNode.)
	FontStyle	Specifies the font style to be used. (Inherited from AbstractChartNode.)
	HREF	Used to specify an "activated" object in an image map. (Inherited from ChartNode.)
	ImageAttr	An image that is to rendered when this ChartNode is displayed. (Inherited from ChartNode.)
	IsVisible	Specifies if this node and its children will be drawn. (Inherited from AbstractChartNode.)
	IsWebControl	Indicates whether this is a web control. (Inherited from ChartNode.)
	LabelType	Specifies the type of label to display. (Inherited from AbstractChartNode.)
	Legend	Legend information associated with this ChartNode. (Inherited from ChartNode.)
	LineColor	Specifies the line color for this node. (Inherited from AbstractChartNode.)
	LineWidth	Specifies the line width for this node. (Inherited from AbstractChartNode.)
	MarkerColor	Specifies what color will be used when rendering marker. (Inherited from AbstractChartNode.)
	MarkerSize	Specifies the size of markers. (Inherited from AbstractChartNode.)
	MarkerThickness	Specifies the line thickness to be used when rendering the markers. (Inherited from ChartNode.)
	MarkerType	Specifies the type of data marker to be drawn. (Inherited from ChartNode.)
	Name	Specifies the name of this node. (Inherited from AbstractChartNode.)
	Number	Specifies the number of tick marks along an axis. (Inherited from AbstractChartNode.)
	Parent	Indicates the parent of this ChartNode. (Inherited from ChartNode.)
	Reference	Indicates the baseline in drawing area charts. (Inherited from ChartNode.)
	ScreenAxis	Provides a default mapping from the user coordinates [0,1] by [0,1] to the screen. (Inherited from ChartNode.)
	ScreenSize	Indicates the size of this ChartNode. (Inherited from ChartNode.)
	Size	Specifies the drawing size. (Inherited from ChartNode.)
	SkipWeekends	Specifies whether to skip weekends. (Inherited from AbstractChartNode.)
	SmoothingMode	Specifies the SmoothingMode for this node. (Inherited from AbstractChartNode.)
	TextAngle	An angle, in degrees, at which text is to be drawn. (Inherited from ChartNode.)
	TextColor	Specifies the text color. (Inherited from AbstractChartNode.)
	TextFormat	Specifies the "TextFormat" attribute value. (Inherited from AbstractChartNode.)
	TextFormatProvider	Specifies the "TextFormatProvider" attribute value. (Inherited from AbstractChartNode.)
	TickLength	This scales the length of the tick mark lines. (Inherited from AbstractChartNode.)
	ToolTip	Text that can be displayed in the case where tool tips are used. (Inherited from ChartNode.)
	Transform	Specifies whether the axis is linear, logarithmic or a custom transform. (Inherited from AbstractChartNode.)

Top

	Name	Description
	PickPerformed	Occurs when the mouse pointer is over a chart node and a mouse button is pressed. (Inherited from ChartNode.)

Top

Legend is created by Chart as its child. It can be retrieved using the Legend property.

By default the legend is not drawn. To have it drawn, set chart.IsVisisble = true;

Data objects that have their "Title" attribute defined are automatically entered into the legend.

The "Viewport" attribute for this node is set to [0.83,0.98] by [0.1,0.6].

The drawing of the background of the legend box is controlled by the Fill attributes (specified with FillType) in this node. Text attributes (specified with CultureInfo, NumberFormatInfo.CurrentInfo and DateTimeFormatInfo.CurrentInfo members) in this node control the drawing of the text strings in the box.

Reference

Imsl.Chart2D Namespace