Class OHLCBarItem

Encapsulates a CandleStick curve type that displays a vertical (or horizontal) line displaying the range of data values at each sample point, plus an starting mark and an ending mark signifying the opening and closing value for the sample.

Inheritance

Object

CurveItem

OHLCBarItem

Implements

ICloneable

ISerializable

Inherited Members

CurveItem._isX2Axis

CurveItem._isY2Axis

CurveItem._yAxisIndex

CurveItem._isVisible

CurveItem._isSelected

CurveItem._isSelectable

CurveItem._isOverrideOrdinal

CurveItem._points

CurveItem.Tag

CurveItem.schema

CurveItem.Label

CurveItem.Color

CurveItem.IsVisible

CurveItem.IsSelected

CurveItem.IsSelectable

CurveItem.IsOverrideOrdinal

CurveItem.IsX2Axis

CurveItem.IsY2Axis

CurveItem.YAxisIndex

CurveItem.IsBar

CurveItem.IsPie

CurveItem.IsLine

CurveItem.NPts

CurveItem.Points

CurveItem.Item[Int32]

CurveItem.Link

CurveItem.AddPoint(Double, Double)

CurveItem.AddPoint(PointPair)

CurveItem.Clear()

CurveItem.RemovePoint(Int32)

CurveItem.GetXAxis(GraphPane)

CurveItem.GetYAxis(GraphPane)

CurveItem.GetYAxisIndex(GraphPane)

CurveItem.MakeUnique()

CurveItem.MakeUnique(ColorSymbolRotator)

CurveItem.GetRange(Double, Double, Double, Double, Boolean, Boolean, GraphPane)

CurveItem.BaseAxis(GraphPane)

CurveItem.ValueAxis(GraphPane)

CurveItem.GetBarWidth(GraphPane)

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: ZedGraph

Assembly: ZedGraph.dll

Syntax

[Serializable]
public class OHLCBarItem : CurveItem, ICloneable, ISerializable

Remarks

For this type to work properly, your IPointList must contain StockPt objects, rather than ordinary PointPair types. This is because the OHLCBarItem type actually displays 5 data values but the PointPair only stores 3 data values. The StockPt stores Date, Close, Open, High, and Low members. For a vertical CandleStick chart, the opening value is drawn as a horizontal line segment to the left of the vertical range bar, and the closing value is a horizontal line segment to the right. The total length of these two line segments is controlled by the Size property, which is specified in points (1/72nd inch), and scaled according to CalcScaleFactor(). The candlesticks are drawn horizontally or vertically depending on the value of Base, which is a BarBase enum type.

Constructors

OHLCBarItem(SerializationInfo, StreamingContext)

Constructor for deserializing objects

Declaration

protected OHLCBarItem(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
SerializationInfo	info	A SerializationInfo instance that defines the serialized data
StreamingContext	context	A StreamingContext instance that contains the serialized data

OHLCBarItem(String)

Create a new OHLCBarItem, specifying only the legend label.

Declaration

public OHLCBarItem(string label)

Parameters

Type	Name	Description
String	label	The label that will appear in the legend.

OHLCBarItem(String, IPointList, Color)

Create a new OHLCBarItem using the specified properties.

Declaration

public OHLCBarItem(string label, IPointList points, Color color)

Parameters

Type	Name	Description
String	label	The _label that will appear in the legend.
IPointList	points	An IPointList of double precision values that define the Date, Close, Open, High, and Low values for the curve. Note that this IPointList should contain StockPt items rather than PointPair items.
Color	color	The Color to use for drawing the candlesticks.

OHLCBarItem(OHLCBarItem)

The Copy Constructor

Declaration

public OHLCBarItem(OHLCBarItem rhs)

Parameters

Type	Name	Description
OHLCBarItem	rhs	The OHLCBarItem object from which to copy

Fields

_bar

Private field that stores a reference to the OHLCBar class defined for this OHLCBarItem. Use the public property OHLCBar to access this value.

Declaration

[CLSCompliant(false)]
protected OHLCBar _bar

Field Value

Type	Description
OHLCBar

schema2

Current schema value that defines the version of the serialized file

Declaration

public const int schema2 = 10

Field Value

Type	Description
Int32

Properties

Bar

Gets a reference to the OHLCBar class defined for this OHLCBarItem.

Declaration

public OHLCBar Bar { get; }

Property Value

Type	Description
OHLCBar

Methods

Clone()

Typesafe, deep-copy clone method.

Declaration

public OHLCBarItem Clone()

Returns

Type	Description
OHLCBarItem	A new, independent copy of this class

Draw(Graphics, GraphPane, Int32, Single)

Do all rendering associated with this OHLCBarItem to the specified Graphics device. This method is normally only called by the Draw method of the parent CurveList collection object.

Declaration

public override void Draw(Graphics g, GraphPane pane, int pos, float scaleFactor)

Parameters

Type	Name	Description
Graphics	g	A graphic device object to be drawn into. This is normally e.Graphics from the PaintEventArgs argument to the Paint() method.
GraphPane	pane	A reference to the GraphPane object that is the parent or owner of this object.
Int32	pos	The ordinal position of the current OHLCBarItem curve.
Single	scaleFactor	The scaling factor to be used for rendering objects. This is calculated and passed down by the parent GraphPane object using the CalcScaleFactor() method, and is used to proportionally adjust font sizes, etc. according to the actual size of the graph.

Overrides

CurveItem.Draw(Graphics, GraphPane, Int32, Single)

DrawLegendKey(Graphics, GraphPane, RectangleF, Single)

Draw a legend key entry for this OHLCBarItem at the specified location

Declaration

public override void DrawLegendKey(Graphics g, GraphPane pane, RectangleF rect, float scaleFactor)

Parameters

Type	Name	Description
Graphics	g	A graphic device object to be drawn into. This is normally e.Graphics from the PaintEventArgs argument to the Paint() method.
GraphPane	pane	A reference to the GraphPane object that is the parent or owner of this object.
RectangleF	rect	The RectangleF struct that specifies the location for the legend key
Single	scaleFactor	The scaling factor to be used for rendering objects. This is calculated and passed down by the parent GraphPane object using the CalcScaleFactor() method, and is used to proportionally adjust font sizes, etc. according to the actual size of the graph.

Overrides

CurveItem.DrawLegendKey(Graphics, GraphPane, RectangleF, Single)

GetCoords(GraphPane, Int32, out String)

Determine the coords for the rectangle associated with a specified point for this CurveItem

Declaration

public override bool GetCoords(GraphPane pane, int i, out string coords)

Parameters

Type	Name	Description
GraphPane	pane	The GraphPane to which this curve belongs
Int32	i	The index of the point of interest
String	coords	A list of coordinates that represents the "rect" for this point (used in an html AREA tag)

Returns

Type	Description
Boolean	true if it's a valid point, false otherwise

Overrides

CurveItem.GetCoords(GraphPane, Int32, out String)

GetObjectData(SerializationInfo, StreamingContext)

Populates a SerializationInfo instance with the data needed to serialize the target object

Declaration

[SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
public override void GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
SerializationInfo	info	A SerializationInfo instance that defines the serialized data
StreamingContext	context	A StreamingContext instance that contains the serialized data

Overrides

CurveItem.GetObjectData(SerializationInfo, StreamingContext)

Explicit Interface Implementations

ICloneable.Clone()

Implement the ICloneable interface in a typesafe manner by just calling the typed version of Clone()

Declaration

object ICloneable.Clone()

Returns

Type	Description
Object	A deep copy of this object

Implements

System.ICloneable

System.Runtime.Serialization.ISerializable