All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jclass.chart.JCCandleChartFormat

java.lang.Object
   |
   +----jclass.chart.JCCandleChartFormat

public class JCCandleChartFormat
extends Object
implements JCSerializable, HTMLHandler
Manages properties and convenience methods specific to candle charts.

Candle charts take the Y values of 4 data series to construct each "logical" candle series. The number of data points defines the number of candles in each row.

Note: The methods in this class use the logical candle series index instead of the actual series index, to make programming candle styles more convenient.

Properties

Name Description
IsComplex The IsComplex property determines whether candle charts use the simple or the complex display style. When false, Chart only uses the style referenced by getHiLoStyle() for the candle appearance. When set to true, all four styles are used. Default value is false.


Constructor Index

 o JCCandleChartFormat()
 o JCCandleChartFormat(ChartDataView)

Method Index

 o getCandleOutlineStyle(int)
Gets the JCChartStyle that controls the candle outline style of the complex candle chart.
 o getFallingCandleStyle(int)
Gets the JCChartStyle that controls the falling candle style of the complex candle chart.
 o getHiloStyle(int)
Gets the JCChartStyle that controls the candle style of the simple candle or the HiLo line of the complex candle chart.
 o getIsComplex()
Gets the IsComplex property of the candle chart.
 o getRisingCandleStyle(int)
Gets the JCChartStyle that controls the rising candle style of the complex candle chart.
 o loadParams(String, JCChart)
Load JCChart parameters from HTML file
 o saveParams(String, JCChart)
Save JCChart parameters as HTML tags
 o setCandleOutlineStyle(int, JCChartStyle)
Sets the candle style of the candle outline style of the complex candle chart.
 o setFallingCandleStyle(int, JCChartStyle)
Sets the candle style of the falling candle style of the complex candle chart.
 o setHiloStyle(int, JCChartStyle)
Sets the candle style of the simple candle or the HiLo line of the complex candle chart.
 o setIsComplex(boolean)
Sets the IsComplex property of the candle chart.
 o setRisingCandleStyle(int, JCChartStyle)
Sets the candle style of the rising candle style of the complex candle chart.

Constructors

 o JCCandleChartFormat
 public JCCandleChartFormat()
 o JCCandleChartFormat
 public JCCandleChartFormat(ChartDataView p)

Methods

 o getIsComplex
 public boolean getIsComplex()
Gets the IsComplex property of the candle chart. This property determines whether the candle is a simple or complex candle.

Returns:
true if complex
 o setIsComplex
 public void setIsComplex(boolean b)
Sets the IsComplex property of the candle chart. This property determines whether the candle is a simple or complex candle.

Parameters:
b - if true, chart is complex candle else chart is simple candle.
 o getHiloStyle
 public JCChartStyle getHiloStyle(int index)
Gets the JCChartStyle that controls the candle style of the simple candle or the HiLo line of the complex candle chart.

Parameters:
index - logical candle series (not the actual data series)
Returns:
JCChartStyle object
 o setHiloStyle
 public void setHiloStyle(int index,
                          JCChartStyle value)
Sets the candle style of the simple candle or the HiLo line of the complex candle chart.

Parameters:
index - logical candle series (not the actual data series)
value - JCChartStyle object containing the desired style
 o getRisingCandleStyle
 public JCChartStyle getRisingCandleStyle(int index)
Gets the JCChartStyle that controls the rising candle style of the complex candle chart.

Parameters:
index - logical candle series (not the actual data series)
Returns:
JCChartStyle object
 o setRisingCandleStyle
 public void setRisingCandleStyle(int index,
                                  JCChartStyle value)
Sets the candle style of the rising candle style of the complex candle chart.

Parameters:
index - logical candle series (not the actual data series)
value - JCChartStyle object containing the desired style
 o getFallingCandleStyle
 public JCChartStyle getFallingCandleStyle(int index)
Gets the JCChartStyle that controls the falling candle style of the complex candle chart.

Parameters:
index - logical candle series (not the actual data series)
Returns:
JCChartStyle object
 o setFallingCandleStyle
 public void setFallingCandleStyle(int index,
                                   JCChartStyle value)
Sets the candle style of the falling candle style of the complex candle chart.

Parameters:
index - logical candle series (not the actual data series)
value - JCChartStyle object containing the desired style
 o getCandleOutlineStyle
 public JCChartStyle getCandleOutlineStyle(int index)
Gets the JCChartStyle that controls the candle outline style of the complex candle chart.

Parameters:
index - logical candle series (not the actual data series)
Returns:
JCChartStyle object
 o setCandleOutlineStyle
 public void setCandleOutlineStyle(int index,
                                   JCChartStyle value)
Sets the candle style of the candle outline style of the complex candle chart.

Parameters:
index - logical candle series (not the actual data series)
value - JCChartStyle object containing the desired style
 o saveParams
 public void saveParams(String name,
                        JCChart comp)
Save JCChart parameters as HTML tags

Parameters:
name - the PARAM NAME
chart - the JCChart component
 o loadParams
 public void loadParams(String name,
                        JCChart comp)
Load JCChart parameters from HTML file

Parameters:
name - the PARAM NAME
chart - the JCChart component

All Packages  Class Hierarchy  This Package  Previous  Next  Index