Class JapaneseCandleStickItem
Encapsulates a Japanese CandleStick curve type that displays a vertical (or horizontal) line displaying the range of data values at each sample point, plus a filled bar signifying the opening and closing value for the sample.
Inherited Members
Namespace: ZedGraph
Assembly: ZedGraph.dll
Syntax
[Serializable]
public class JapaneseCandleStickItem : CurveItem, ICloneable, ISerializableRemarks
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 JapaneseCandleStick chart, the range between opening and closing values is drawn as a filled bar, with the filled color different (RisingFill) for the case of Close higher than Open, and FallingFill for the reverse. The width of the bar 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
| Improve this Doc View SourceJapaneseCandleStickItem(SerializationInfo, StreamingContext)
Constructor for deserializing objects
Declaration
protected JapaneseCandleStickItem(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 |
JapaneseCandleStickItem(String)
Create a new OHLCBarItem, specifying only the legend label.
Declaration
public JapaneseCandleStickItem(string label)Parameters
| Type | Name | Description |
|---|---|---|
| String | label | The label that will appear in the legend. |
JapaneseCandleStickItem(String, IPointList)
Create a new JapaneseCandleStickItem using the specified properties.
Declaration
public JapaneseCandleStickItem(string label, IPointList points)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. |
JapaneseCandleStickItem(JapaneseCandleStickItem)
The Copy Constructor
Declaration
public JapaneseCandleStickItem(JapaneseCandleStickItem rhs)Parameters
| Type | Name | Description |
|---|---|---|
| JapaneseCandleStickItem | rhs | The JapaneseCandleStickItem object from which to copy |
Fields
| Improve this Doc View Sourceschema2
Current schema value that defines the version of the serialized file
Declaration
public const int schema2 = 10Field Value
| Type | Description |
|---|---|
| Int32 |
Properties
| Improve this Doc View SourceStick
Gets a reference to the JapaneseCandleStick class defined for this JapaneseCandleStickItem.
Declaration
public JapaneseCandleStick Stick { get; }Property Value
| Type | Description |
|---|---|
| JapaneseCandleStick |
Methods
| Improve this Doc View SourceClone()
Typesafe, deep-copy clone method.
Declaration
public JapaneseCandleStickItem Clone()Returns
| Type | Description |
|---|---|
| JapaneseCandleStickItem | 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
| Improve this Doc View SourceDrawLegendKey(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
| Improve this Doc View SourceGetCoords(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
| Improve this Doc View SourceGetObjectData(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
Explicit Interface Implementations
| Improve this Doc View SourceICloneable.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 |