Click or drag to resize
HeatmapLegend Class
A legend for use with a Heatmap.
Inheritance Hierarchy

Namespace: Imsl.Chart2D
Assembly: ImslCS (in ImslCS.dll) Version: 6.5.2.0
Syntax
[SerializableAttribute]
public class Legend : AxisXY

The HeatmapLegend type exposes the following members.

Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFirePickListeners
Invokes the pick delegates defined at this node and at all of its ancestors, if the event "hits" the node.
(Inherited from ChartNode.)
Public methodGetAttribute
Gets the value of an attribute.
(Inherited from AbstractChartNode.)
Public methodGetBooleanAttribute
Convenience routine to get a Boolean-valued attribute.
(Inherited from AbstractChartNode.)
Public methodGetChildren
Gets the list of child nodes.
(Inherited from ChartNode.)
Public methodGetColorAttribute
Convenience routine to get a Color-valued attribute.
(Inherited from AbstractChartNode.)
Public methodGetComponent
Gets the "Component" attribute value.
(Inherited from ChartNode.)
Public methodGetConcatenatedViewport
Returns the value of the "Viewport" attribute concatenated with the "Viewport" attributes set in its ancestor nodes.
(Inherited from ChartNode.)
Public methodGetCross
Returns the "Cross" attribute value.
(Inherited from AxisXY.)
Public methodGetDoubleAttribute
Convenience routine to get a Double-valued attribute.
(Inherited from AbstractChartNode.)
Public methodGetFillPaint
Returns the "FillPaint" attribute value.
(Inherited from ChartNode.)
Public methodGetGradient
Returns the value of the "Gradient" attribute.
(Inherited from ChartNode.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIntegerAttribute
Convenience routine to get an Integer-valued attribute.
(Inherited from AbstractChartNode.)
Public methodGetLineDashPattern
Returns the "LineDashPattern" attribute value.
(Inherited from ChartNode.)
Public methodGetMarkerDashPattern
Returns the "MarkerDashPattern" attribute value.
(Inherited from ChartNode.)
Public methodGetScreenViewport
Returns the value of the "Viewport" attribute scaled by the screen size.
(Inherited from ChartNode.)
Public methodGetStringAttribute
Convenience routine to get a String-valued attribute.
(Inherited from AbstractChartNode.)
Public methodGetTitle
Returns the value of the "Title" attribute.
(Inherited from ChartNode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetViewport
Returns the value of the "Viewport" attribute.
(Inherited from ChartNode.)
Public methodGetWebComponent
Gets the "Component" attribute value.
(Inherited from ChartNode.)
Public methodGetX
Returns the "X" attribute value.
(Inherited from AbstractChartNode.)
Public methodGetY
Returns the "Y" attribute value.
(Inherited from AbstractChartNode.)
Public methodIsAncestorOf
Determines if this node is an ancestor of the argument node.
(Inherited from AbstractChartNode.)
Public methodIsAttributeSet
Determines if an attribute is defined (may have been inherited).
(Inherited from AbstractChartNode.)
Public methodIsAttributeSetAtThisNode
Determines if an attribute is defined in this node (not inherited).
(Inherited from AbstractChartNode.)
Public methodMapDeviceToUser
Maps the device coordinates to user coordinates.
(Inherited from AxisXY.)
Public methodMapUserToDevice
Maps the user coordinates (userX, userY) to the device coordinates devXY.
(Inherited from AxisXY.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnPick
Invokes delegates registered with the Pick event.
(Inherited from ChartNode.)
Public methodPaint
Paints this node and all of its children.
(Overrides AxisXYPaint(Draw).)
Public methodPrePaint
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.)
Public methodRemove
Removes the node from its parents list of children.
(Inherited from AbstractChartNode.)
Public methodSetAttribute
Sets an attribute.
(Inherited from AbstractChartNode.)
Public methodSetCross(Double)
Sets the "Cross" attribute value.
(Inherited from AxisXY.)
Public methodSetCross(Double, Double)
Sets the "Cross" attribute value.
(Inherited from AxisXY.)
Public methodSetFillPaint(Brush)
Sets the value of the "FillPaint" attribute.
(Inherited from ChartNode.)
Public methodSetFillPaint(Image)
Sets the "FillPaint" attribute value.
(Inherited from ChartNode.)
Public methodSetFillPaint(Uri)
Sets the "FillPaint" attribute value.
(Inherited from ChartNode.)
Public methodSetGradient(Color)
Sets the value of the "Gradient" attribute.
(Inherited from ChartNode.)
Public methodSetGradient(Color, Color, Color, Color)
Sets the value of the "Gradient" attribute.
(Inherited from ChartNode.)
Public methodSetLineDashPattern
Sets the "LineDashPattern" attribute value.
(Inherited from ChartNode.)
Public methodSetMarkerDashPattern
Sets the "MarkerDashPattern" attribute value.
(Inherited from ChartNode.)
Public methodSetTitle(String)
Sets the value of the "Title" attribute.
(Inherited from ChartNode.)
Public methodSetTitle(Text)
Sets the value of the "Title" attribute.
(Inherited from ChartNode.)
Public methodSetUpMapping
Initializes the mappings between user and coordinate space.
(Inherited from AxisXY.)
Public methodSetViewport(Double)
Used to specify the viewport location.
(Inherited from ChartNode.)
Public methodSetViewport(Double, Double, Double, Double)
Used to specify the viewport location.
(Inherited from ChartNode.)
Public methodSetWindow
Sets the window for an AxisXY.
(Inherited from AxisXY.)
Public methodSetX
Sets the "X" attribute value.
(Inherited from AbstractChartNode.)
Public methodSetY
Sets the "Y" attribute value.
(Inherited from AbstractChartNode.)
Public methodToString
Returns the name of this chart node.
(Inherited from AbstractChartNode.)
Top
Fields
  NameDescription
Protected fieldWebCtrl
A bool indicating if this ChartNode is a WebControl.
(Inherited from ChartNode.)
Top
Properties
  NameDescription
Public propertyAbstractParent
Indicates the parent of this AbstractChartNode.
(Inherited from AbstractChartNode.)
Public propertyALT
Used to construct an "alt" attribute value in client side image maps.
(Inherited from ChartNode.)
Public propertyAutoscaleInput
Indicates what inputs are used for autoscaling.
(Inherited from AbstractChartNode.)
Public propertyAutoscaleMinimumTimeInterval
Specifies the minimum tick mark interval for autoscaled time axes.
(Inherited from AbstractChartNode.)
Public propertyAutoscaleOutput
Specifies what attributes to change as a result of autoscaling.
(Inherited from AbstractChartNode.)
Public propertyAxis
Typically provides a mapping for children from the user coordinate space to the device (screen) space.
(Inherited from ChartNode.)
Public propertyAxisX
The X axis associated with this node.
(Inherited from AxisXY.)
Public propertyAxisY
The Y axis associated with this node.
(Inherited from AxisXY.)
Public propertyBackground
The base graphic layer displayed behind other ChartNode objects in the tree.
(Inherited from ChartNode.)
Public propertyBarGap
Specifies the gap between bars in a group.
(Inherited from ChartNode.)
Public propertyBarType
Specifies the orientation of the BarChart.
(Inherited from ChartNode.)
Public propertyBarWidth
The width of all of the groups of bars at each index.
(Inherited from ChartNode.)
Public propertyChart
This is the root node of the chart tree.
(Inherited from ChartNode.)
Public propertyChartTitle
Specifies a title for the chart.
(Inherited from ChartNode.)
Public propertyClipData
Specifies whether the data elements are to be clipped to the current window.
(Inherited from ChartNode.)
Public propertyCultureInfo
Adds support for Windows supported locales.
(Inherited from AbstractChartNode.)
Public propertyCustomTransform
Allows for the specification of a custom transform.
(Inherited from AbstractChartNode.)
Public propertyDataType
Specifies how the data is to be rendered.
(Inherited from ChartNode.)
Public propertyDensity
Specifies the number of minor tick marks in the interval between major tick marks.
(Inherited from AbstractChartNode.)
Public propertyDoubleBuffering
Specifies whether double is active.
(Inherited from ChartNode.)
Public propertyExplode
Specifies how far from the center pie slices are drawn.
(Inherited from ChartNode.)
Public propertyFillColor
Specifies a color that will be used to fill an area.
(Inherited from AbstractChartNode.)
Public propertyFillOutlineColor
Specifies a color that will be used to outline this node.
(Inherited from ChartNode.)
Public propertyFillOutlineType
Specifies a fill pattern type for the outline of this node.
(Inherited from ChartNode.)
Public propertyFillType
Specifies a fill pattern type for this node.
(Inherited from ChartNode.)
Public propertyFont
Defines a particular format for text, including font name, size, and style attributes.
(Inherited from AbstractChartNode.)
Public propertyFontName
Specifies the font to be used by name.
(Inherited from AbstractChartNode.)
Public propertyFontSize
Specifies the font size.
(Inherited from AbstractChartNode.)
Public propertyFontStyle
Specifies the font style to be used.
(Inherited from AbstractChartNode.)
Public propertyHREF
Used to specify an "activated" object in an image map.
(Inherited from ChartNode.)
Public propertyImageAttr
An image that is to rendered when this ChartNode is displayed.
(Inherited from ChartNode.)
Public propertyIsVisible
Specifies if this node and its children will be drawn.
(Inherited from AbstractChartNode.)
Public propertyIsWebControl
Indicates whether this is a web control.
(Inherited from ChartNode.)
Public propertyLabelType
Specifies the type of label to display.
(Inherited from AbstractChartNode.)
Public propertyLegend
Legend information associated with this ChartNode.
(Inherited from ChartNode.)
Public propertyLineColor
Specifies the line color for this node.
(Inherited from AbstractChartNode.)
Public propertyLineWidth
Specifies the line width for this node.
(Inherited from AbstractChartNode.)
Public propertyMarkerColor
Specifies what color will be used when rendering marker.
(Inherited from AbstractChartNode.)
Public propertyMarkerSize
Specifies the size of markers.
(Inherited from AbstractChartNode.)
Public propertyMarkerThickness
Specifies the line thickness to be used when rendering the markers.
(Inherited from ChartNode.)
Public propertyMarkerType
Specifies the type of data marker to be drawn.
(Inherited from ChartNode.)
Public propertyName
Specifies the name of this node.
(Inherited from AbstractChartNode.)
Public propertyNumber
Specifies the number of tick marks along an axis.
(Inherited from AbstractChartNode.)
Public propertyParent
Indicates the parent of this ChartNode.
(Inherited from ChartNode.)
Public propertyReference
Indicates the baseline in drawing area charts.
(Inherited from ChartNode.)
Public propertyScreenAxis
Provides a default mapping from the user coordinates [0,1] by [0,1] to the screen.
(Inherited from ChartNode.)
Public propertyScreenSize
Indicates the size of this ChartNode.
(Inherited from ChartNode.)
Public propertySize
Specifies the drawing size.
(Inherited from ChartNode.)
Public propertySkipWeekends
Specifies whether to skip weekends.
(Inherited from AbstractChartNode.)
Public propertySmoothingMode
Specifies the SmoothingMode for this node.
(Inherited from AbstractChartNode.)
Public propertyTextAngle
An angle, in degrees, at which text is to be drawn.
(Inherited from ChartNode.)
Public propertyTextColor
Specifies the text color.
(Inherited from AbstractChartNode.)
Public propertyTextFormat
Specifies the "TextFormat" attribute value.
(Inherited from AbstractChartNode.)
Public propertyTextFormatProvider
Specifies the "TextFormatProvider" attribute value.
(Inherited from AbstractChartNode.)
Public propertyTickLength
This scales the length of the tick mark lines.
(Inherited from AbstractChartNode.)
Public propertyToolTip
Text that can be displayed in the case where tool tips are used.
(Inherited from ChartNode.)
Public propertyTransform
Specifies whether the axis is linear, logarithmic or a custom transform.
(Inherited from AbstractChartNode.)
Top
Events
  NameDescription
Public eventPickPerformed
Occurs when the mouse pointer is over a chart node and a mouse button is pressed.
(Inherited from ChartNode.)
Top
Remarks

This Legend should be used with Heatmaps, rather than the usual Chart legend. The "Viewport" attribute for this node is set to [0.83,0.98] by [0.1,0.6].

See Also