Class: Candle
Source Location: /styles/Candle.php
Inherited Variables
|
Inherited Methods
|
Class Details
Class Methods
constructor Candle [line 55]
Candle Candle(
[
$c = null])
|
|
Tags:
Parameters:
destructor __destruct [line 67]
method createSubGallery [line 114]
method drawValue [line 314]
void drawValue(
valueIndex
$valueIndex)
|
|
Called internally. Draws the "ValueIndex" point of the Series.
Tags:
Overrides Custom::drawValue() (Called internally. Draws the "ValueIndex" point of the Series.)
Parameters:
method getCandleWidth [line 163]
The horizontal Candle Size in pixels. It is based on pixels for Screen charts. When printing, this number is multiplied by the ratio between the Printer width and the Screen width. Default value: 6
Tags:
method getDescription [line 492]
method getDownCloseColor [line 219]
Color getDownCloseColor(
)
|
|
Candle color fill when Close value is greater than Open value. By default, UpCloseColor is WHITE and DownCloseColor is RED. Each Candle will be filled with a different color depending on its Open and Close values. If Open value is greater than Close value, then the selected color will be the UpCloseColor color. If Close value is greater or equal than Open value, then the selected color will be the DownCloseColor color. Default value: red
Tags:
method getPen [line 467]
method getShowClose [line 263]
Determines whether Close prices will be displayed. It only has effect when Candle series.CandleStyle is set to csCandleBar. CandleWidth determines the length in pixels of Open and Close ticks. Default value: true
Tags:
method getShowOpen [line 241]
Determines whether Open prices will be displayed. It only has effect when Candle series.CandleStyle is set to csCandleBar. CandleWidth determines the length in pixels of Open and Close ticks. Default value: true
Tags:
method getStyle [line 91]
Determines how the Candle points will be drawn. When it is CandleStick, a vertical rectangle represents each candle point. When it is CandleBar, a vertical line is drawn, among Open and Close horizontal tick marks. You can control both the candle colors and width. Default value: CandleStick
Tags:
method getUpCloseColor [line 190]
Candle color fill when Open value is greater than Close value. By default, UpCloseColor is WHITE and DownCloseColor is RED. Each Candle will be filled with a different color depending on its Open and Close values. If Open value is greater than Close value, then the selected color will be the UpCloseColor color. If Close value is greater or equal than Open value, then the selected color will be the DownCloseColor color. Default value: white
Tags:
method prepareForGallery [line 471]
method setCandleWidth [line 173]
void setCandleWidth(
int
$value)
|
|
Sets the horizontal Candle Size in pixels. Default value: 6
Tags:
Parameters:
method setDownCloseColor [line 229]
void setDownCloseColor(
value
$value)
|
|
Candle color fill when Close value is greater than Open value. Default value: red
Tags:
Parameters:
method setShowClose [line 273]
void setShowClose(
value
$value)
|
|
Determines whether Close prices will be displayed. Default value: true
Tags:
Parameters:
method setShowOpen [line 251]
void setShowOpen(
value
$value)
|
|
Determines whether Open prices will be displayed. Default value: true
Tags:
Parameters:
method setStyle [line 107]
void setStyle(
CandleStyles
$value)
|
|
Determines how the Candle points will be drawn. Default value: CandleStick Example: $candleSeries = new Candle($myChart->getChart()); $candleSeries->fillSampleValues(30); $candleSeries->setStyle(CandleStyles::$OpenClose);
Tags:
Parameters:
method setSubGallery [line 123]
void setSubGallery(
$index)
|
|
Tags:
Overrides Series::setSubGallery() (Creates and prepares the index'th Series style to show at sub-gallery dialog.)
Parameters:
method setUpCloseColor [line 200]
void setUpCloseColor(
value
$value)
|
|
Candle color fill when Open value is greater than Close value. Default value: white
Tags:
Parameters:
method __get [line 41]
Overrides OHLC::__get() (parent method not documented)
Parameters:
method __set [line 48]
void __set(
$property,
$value)
|
|
Overrides OHLC::__set() (parent method not documented)
Parameters:
|
|