Class JapaneseCandleStick

This class handles the drawing of the curve JapaneseCandleStick objects.

Inheritance

Object

LineBase

OHLCBar

JapaneseCandleStick

Implements

ICloneable

ISerializable

Inherited Members

OHLCBar._isOpenCloseVisible

OHLCBar._size

OHLCBar._isAutoSize

OHLCBar.IsOpenCloseVisible

OHLCBar.Size

OHLCBar.IsAutoSize

OHLCBar.schema

OHLCBar.Draw(Graphics, GraphPane, Boolean, Single, Single, Single, Single, Single, Single, Pen)

OHLCBar.Draw(Graphics, GraphPane, OHLCBarItem, Axis, Axis, Single)

OHLCBar.GetBarWidth(GraphPane, Axis, Single)

LineBase.Color

LineBase.Style

LineBase.DashOn

LineBase.DashOff

LineBase.Width

LineBase.IsVisible

LineBase.IsAntiAlias

LineBase.GradientFill

LineBase.schema0

LineBase.GetPen(PaneBase, Single)

LineBase.GetPen(PaneBase, Single, PointPair)

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 JapaneseCandleStick : OHLCBar, ICloneable, ISerializable

Constructors

JapaneseCandleStick()

Default constructor that sets all JapaneseCandleStick properties to default values as defined in the JapaneseCandleStick.Default class.

Declaration

public JapaneseCandleStick()

JapaneseCandleStick(SerializationInfo, StreamingContext)

Constructor for deserializing objects

Declaration

protected JapaneseCandleStick(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

JapaneseCandleStick(JapaneseCandleStick)

The Copy Constructor

Declaration

public JapaneseCandleStick(JapaneseCandleStick rhs)

Parameters

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

Fields

_fallingColor

Private field that stores the CandleStick color when the Close value is less than the Open value. Use the public property FallingColor to access this value.

Declaration

[CLSCompliant(false)]
protected Color _fallingColor

Field Value

Type	Description
Color

schema2

Current schema value that defines the version of the serialized file

Declaration

public const int schema2 = 11

Field Value

Type	Description
Int32

Properties

FallingBorder

The Border instance to be used for drawing the border frame of the candlestick "bars" when the Close value is less than the Open value.

Declaration

public Border FallingBorder { get; set; }

Property Value

Type	Description
Border

FallingColor

Gets or sets the Color data for this JapaneseCandleStick when the value of the candlestick is falling.

Declaration

public Color FallingColor { get; set; }

Property Value

Type	Description
Color

Remarks

This property only controls the color of the vertical line when the value is falling. The rising color is controlled by the Color property.

FallingFill

Gets or sets the Fill class that is used to fill the candlestick "bars" when the Close value is less than the Open value.

Declaration

public Fill FallingFill { get; set; }

Property Value

Type	Description
Fill

RisingBorder

The Border instance to be used for drawing the border frame of the candlestick "bars" when the Close value is greater than the Open value.

Declaration

public Border RisingBorder { get; set; }

Property Value

Type	Description
Border

RisingFill

Gets or sets the Fill class that is used to fill the candlestick "bars" when the Close value is greater than the Open value.

Declaration

public Fill RisingFill { get; set; }

Property Value

Type	Description
Fill

Methods

Clone()

Typesafe, deep-copy clone method.

Declaration

public JapaneseCandleStick Clone()

Returns

Type	Description
JapaneseCandleStick	A new, independent copy of this class

Draw(Graphics, GraphPane, Boolean, Single, Single, Single, Single, Single, Single, Single, Pen, Fill, Border, PointPair)

Draw the JapaneseCandleStick to the specified Graphics device at the specified location.

Declaration

public void Draw(Graphics g, GraphPane pane, bool isXBase, float pixBase, float pixHigh, float pixLow, float pixOpen, float pixClose, float halfSize, float scaleFactor, Pen pen, Fill fill, Border border, PointPair pt)

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.
Boolean	isXBase	boolean value that indicates if the "base" axis for this JapaneseCandleStick is the X axis. True for an XAxis base, false for a YAxis or Y2Axis base.
Single	pixBase	The independent axis position of the center of the candlestick in pixel units
Single	pixHigh	The high value position of the candlestick in pixel units
Single	pixLow	The low value position of the candlestick in pixel units
Single	pixOpen	The opening value position of the candlestick in pixel units
Single	pixClose	The closing value position of the candlestick in pixel units
Single	halfSize	The scaled width of one-half of a bar, in pixels
Single	scaleFactor	The scaling factor for the features of the graph based on the BaseDimension. This scaling factor is calculated by the CalcScaleFactor() method. The scale factor represents a linear multiple to be applied to font sizes, symbol sizes, etc.
Pen	pen	A pen with the Color attribute for this JapaneseCandleStick
Fill	fill	The Fill instance to be used for filling this JapaneseCandleStick
Border	border	The Border instance to be used for drawing the border around the JapaneseCandleStick filled box
PointPair	pt	The PointPair to be used for determining the Fill, just in case it's a GradientByX, GradientByY, or GradientByZ FillType

Draw(Graphics, GraphPane, JapaneseCandleStickItem, Axis, Axis, Single)

Draw all the JapaneseCandleStick's to the specified Graphics device as a candlestick at each defined point.

Declaration

public void Draw(Graphics g, GraphPane pane, JapaneseCandleStickItem curve, Axis baseAxis, Axis valueAxis, 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.
JapaneseCandleStickItem	curve	A JapaneseCandleStickItem object representing the JapaneseCandleStick's to be drawn.
Axis	baseAxis	The Axis class instance that defines the base (independent) axis for the JapaneseCandleStick
Axis	valueAxis	The Axis class instance that defines the value (dependent) axis for the JapaneseCandleStick
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.

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

OHLCBar.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