TeeChartPHP
[ class tree: TeeChartPHP ] [ index: TeeChartPHP ] [ all elements ]

Class: Candle

Source Location: /styles/Candle.php

Class Overview

TeeBase
   |
   --Series
      |
      --BaseLine
         |
         --CustomPoint
            |
            --Custom
               |
               --OHLC
                  |
                  --Candle

Candle class


Author(s):

Version:

  • 1.0

Copyright:

  • (c) 1995-2008 by Steema Software SL. All Rights Reserved. <info@steema.com>

Methods


Inherited Variables

Inherited Methods

Class: OHLC

OHLC::OHLC()
OHLC::addCandle()
Adds new point with specified double index and double open, high, low and close.
OHLC::addCandleDate()
Adds new point with specified DateTime x and double open, high, low and close.
OHLC::addSampleValues()
OHLC::getCloseValues()
All the Stock market Close values.
OHLC::getDateValues()
All the Stock market Date values.
OHLC::getHighValues()
All the Stock market High values.
OHLC::getLowValues()
All the Stock market Low values.
You can access High values in the same way you can access X or Y values.
OHLC::getMaxYValue()
The Maximum Value of the Series Y Values List.
OHLC::getMinYValue()
The Minimum Value of the Series Y Values List.
As some Series have more than one Y Values List, this Minimum Value is the "Minimum of Minimums" of all Series Y Values lists.
OHLC::getOHLCPoint()
Point characteristics
OHLC::getOpenValues()
All the Stock market Open values.
OHLC::isValidSourceOf()
Validates Series datasource.
OHLC::numSampleValues()
OHLC::setCloseValues()
Sets all Stock market Close values.
OHLC::setDateValues()
Sets all Stock market Date values.
OHLC::setHighValues()
Sets all Stock market High values.
You can access High values in the same way you can access X or Y values.
OHLC::setLowValues()
Sets all Stock market Low values.
You can access High values in the same way you can access X or Y values.
OHLC::setOpenValues()
Sets all Stock market Open values.
OHLC::__get()
OHLC::__set()

Class: Custom

Custom::Custom()
The class constructor.
Custom::calcHorizMargins()
Custom::calcVerticalMargins()
Custom::clicked()
Calculates if any point is at XY position.
Custom::draw()
Custom::drawLegendShape()
Custom::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Custom::getAreaBrushColor()
Custom::getBrush()
Sets Brush characteristics.
Custom::getClickableLine()
Allows mouse clicks over the line drawn between points.
Default value: true
Custom::getColorEachLine()
Enables/Disables the coloring of each connecting line of a series.
Default value: true
Custom::getDark3D()
Darkens parts of 3D Line Series to add depth.
Default value: true
Custom::getInvertedStairs()
Changes the direction of the step, when true.
Default value: false
Custom::getLineHeight()
The vertical thickness of the line in pixels.
Default value: 0
Custom::getOpacity()
Opacity level from 0 to 100%
Custom::getOutLine()
Pen for Series Line's outer pen.
Default value: null
Custom::getShadow()
Custom::getStairs()
Steps line joining adjacent points.
Custom::getTransparency()
Transparency level from 0 to 100% Default value: 0
Custom::readResolve()
Custom::setChart()
Custom::setClickableLine()
Allows mouse clicks over the line drawn between points.
Custom::setColor()
Custom::setColorEachLine()
Enables/Disables the coloring of each connecting line of a series.
Default value: true
Custom::setDark3D()
Darkens parts of 3D Line Series to add depth.
Default value: true
Custom::setInvertedStairs()
Changes the direction of the step, when true.
Default value: false
Custom::setLineHeight()
Sets the vertical thickness of the line in pixels.
Default value: 0
Custom::setOpacity()
Sets Opacity level from 0 to 100%
Custom::setShadow()
Custom::setStairs()
Steps line joining adjacent points.
Default value: false
Custom::setTransparency()
Sets Transparency level from 0 to 100%
Custom::__get()
Custom::__set()

Class: CustomPoint

CustomPoint::CustomPoint()
CustomPoint::assign()
CustomPoint::calcHorizMargins()
CustomPoint::calcVerticalMargins()
CustomPoint::calcXPos()
Returns horizontal screen position for a given point.
CustomPoint::calcYPos()
Returns vertical screen position for a given point.
CustomPoint::calcZOrder()
CustomPoint::clicked()
Returns the ValueIndex of the "clicked" point in the Series.
CustomPoint::clickedPointer()
For internal use
CustomPoint::drawLegendShape()
CustomPoint::drawMark()
CustomPoint::drawPointer()
Draws series pointer to the Canvas.
CustomPoint::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
CustomPoint::getMaxXValue()
Returns the Maximum Value of the Series X Values List.
CustomPoint::getMaxYValue()
Returns the Maximum Value of the Series Y Values List.
CustomPoint::getMinXValue()
Returns the Minimum Value of the Series X Values List.
CustomPoint::getMinYValue()
Returns the Minimum Value of the Series Y Values List.
CustomPoint::getOriginPos()
CustomPoint::getPointer()
Defines all necessary properties of the Series Pointer.
CustomPoint::getStacked()
Defines how multiple series will be displayed.

CustomPoint::onGetPointerStyle()
CustomPoint::removePointerStyleResolver()
CustomPoint::setChart()
CustomPoint::setPointerStyleResolver()
CustomPoint::setStacked()
Defines how multiple series will be displayed.
CustomPoint::__get()
CustomPoint::__set()

Class: BaseLine

BaseLine::BaseLine()
BaseLine::assign()
BaseLine::getLinePen()
Determines pen to draw the line connecting all points.
BaseLine::setChart()
BaseLine::__get()
BaseLine::__set()

Class: Series

Series::Series()
Series::add()
Adds a new point with specified value.
Series::addArray()
Adds the array of double values.
Series::addChartValue()
Series::added()
Series::addNull()
Obsolete.&nbsp;Please use add() method without parameters instead.
Series::addNullXY()
Obsolete.&nbsp;Please use add(x,y,Color.<!-- -->Transparent) method instead.
Series::addSampleValues()
Series::addSeriesMouseListener()
Series::addSeriesPaintListener()
Series::addText()
Adds a new null point with specified text.
Series::addValues()
Series::addXY()
Adds a new point with specified x and y values.
Series::addXYColor()
Adds a new point with specified x and y values and color.
Series::addXYText()
Adds a new point with specified x,y values and text.
Series::addXYTextColor()
Adds a new point with specified x,y values, text and color.
Series::addYColor()
Adds a new point with specified value and color.
Series::addYText()
Adds a new point with specified value and text.
Series::addYTextColor()
Adds a new point with specified value, text and color.
Series::assign()
Copies all properties from one Series component to another.
Series::assignDispose()
Series::assignValues()
Adds all Values from Source seriesto the current Series.
Series::associatedToAxis()
Series::beginUpdate()
Recalculates the function just one time, when finished adding points.
Series::calcFirstLastVisibleIndex()
Series::calcHorizMargins()
Returns the number of pixels for horizontal margins
Series::calcPosValue()
Returns "Value" parameter coordinate position in pixels.
Series::calcVerticalMargins()
Returns the number of pixels for vertical margins
Series::calcXPos()
The pixel Screen Horizontal coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Horizontal Axis.
Series::calcXPosValue()
The pixel Screen Horizontal coordinate of the specified Value.
Series::calcXSizeValue()
Returns the size in pixels corresponding to value parameter in horizontal axis scales.
This coordinate is calculated using the Series associated Horizontal Axis.
Series::calcYPos()
The pixel Screen Vertical coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Vertical Axis.
Series::calcYPosValue()
The pixel Screen Vertical coordinate of the specified Value.
This coordinate is calculated using the Series associated Vertical Axis.
Series::calcYSizeValue()
Returns the size in pixels corresponding to value parameter in vertical axis scales.
This coordinate is calculated using the Series associated Vertical Axis.
Series::calcZOrder()
Series::canAddRandomPoints()
Series::changeType()
Replaces ASeries object with a new Series object of another class.
Series::checkDataSource()
Refreshes all Series point values, either from database Tables or Series points.
Series::checkMouse()
Adds the array of integer values.
Series::checkOrder()
Reorders points according to Order property of X,Y,etc value lists.
Refreshes sort order of Series points if Order type of XValues or YValues is not loNone.
Series::checkOtherSeries()
Series::clear()
Removes all points, texts and Colors from the Series.
Dependent Series are notified. If no new points are appended to the Series, nothing will be painted.
Series::clearLists()
Series::clicked()
Series::cloneS()
Series::cloneSeries()
Returns a new Series, copy of this original.
It returns the SeriesIndex of the new Series.
Series::convertArray()
Adds all points in source Series.
Series::createNewSeries()
Creates a new Series object and sets the Name, Chart, Sub-Style and Function methods.
This is an internal method, you should seldomly use it in your applications.
Series::createSubGallery()
Series::dataSourceArray()
Series::delete()
Removes the index th point.
X values remain unchanged.
The Chart will be automatically redrawn.
Dependent Series will be recalculated.
Series::dispose()
Series::doAfterDrawValues()
Series::doBeforeDrawChart()
Series::doBeforeDrawValues()
Series::doClick()
Series::doClickPointer()
Series::doDoubleClick()
Series::draw()
Series::drawLegend()
Series::drawLegendShape()
Series::drawMark()
Series::drawMarks()
Series::drawSeries()
Draws the series to the Chart Canvas.
Series::drawSeriesForward()
Series::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Series::drawValuesForward()
Returns whether Series draws its points in ascending/descending order.
Series::endUpdate()
Recalculates the function just one time, when finished adding points.
Series::fillSampleValues()
Adds the specified NumValues random points.
Series::fireSeriesMouseEvent()
Series::fireSeriesPaint()
Series::galleryChanged3D()
Series::getActive()
Shows or hides this series.
Series::getAllowSinglePoint()
Series::getBitmapEditor()
Returns the URL of the associated bitmap icon for a given Series class.
This icon is used at ChartListBox and Series Editor dialog.
Series::getColor()
Default color for all points.
Series::getColorEach()
Draws points with different preset Colors.
Series::getColorMember()
The the Datasource Color Field.
Default value: ""
Series::getColors()
Accesses the stored Color Array, if created, for the Series.
When attaching new series to any Chart, setting TChart Series.SerieColor to Color.EMPTY will make TeeChart assign a different color to each Series.
Series::getCount()
Returns the number of points in the Series.
Series::getCountLegendItems()
Series::getCursor()
Cursor displayed when mouse is over a series point.
Each Series determines the intersection of points with mouse coordinates each time the mouse moves. There are many different Cursors available.
Series::getCustomHorizAxis()
Specifies the custom horizontal axis for the series.
Series::getCustomVertAxis()
Specifies the custom vertical axis for the series.
Default value: null
Series::getDataSource()
Object to load data from.
Default value: null
Series::getDepth()
The Depth of the series points or interconnecting lines.
Default value: -1
Series::getDescription()
Gets descriptive text.
Series::getEndZ()
For internal use.
Series::getFields()
Series::getFirstVisible()
Returns the index of the Series' first visible point.
Series::getFunction()
Function object to calculate values.
Default value: null
Series::getHasZValues()
Series::getHorizAxis()
Series::getHorizontalAxis()
Horizontal axis associated to this Series.
Default value: HorizontalAxis.Bottom
Series::getLabelMember()
The the Datasource Label Field.
Default value: ""
Series::getLabels()
Accesses a list of series point labels.
Series::getLastVisible()
Returns the index of the Series' last visible point.
Series::getLegendString()
Returns the formatted String corresponding to the LegendIndex point.
Series::getMandatory()
Series::getMarks()
Defines how to draw a mark near to each Series point.
Series::getMarkText()
Returns the String corresponding to the Series Mark text for a given ValueIndex point.
The Mark text depends on the Marks.Style method.
Series::getMarkValue()
Returns corresponding Point value suitable for displaying at Series Marks.
Series::getMaxXValue()
The Maximum Value of the Series X Values List.
Series::getMaxYValue()
The Maximum Value of the Series Y Values List.
Series::getMaxZValue()
The Maximum Z Value. For non-3D series, this is the Z order.
Series::getMiddleZ()
For internal use.
Series::getMinXValue()
The Minimum Value of the Series X Values List.
Series::getMinYValue()
The Minimum Value of the Series Y Values List.
Series::getMinZValue()
The Minimum Z Value. For non-3D series, this is the Z order.
Series::getNotMandatory()
Series::getNumGallerySeries()
For internal use.
Series::getNumSampleValues()
Series::getOriginValue()
Series::getPercentFormat()
The Format to display point values as percentage.
Series::getPoint()
Point characteristics.
Series::getSeriesColor()
Obsolete.&nbsp;Use the Series.Color method instead.
Series::getShowInLegend()
Displays this Series Title in Legend.
It is only meaningful when LegendStyle is Series or LastValues.
Default value: true
Series::getStartZ()
For internal use.
Series::getTitle()
Series description to show in Legend and dialogs.
Series::getUseAxis()
Series::getValueColor()
The colour of the index point.
Series::getValueFormat()
Determines the Format to display point values.
It specifies the desired formatting string to be applied to Axis Labels.
Series::getValueIndexSwapper()
Series::getValueList()
Series::getValueListNum()
Adds the collection of objects that implement the IList interface.
Series::getValueMarkText()
Returns the String representation of a Index point used to draw the Mark.
Series::getValuesLists()
Returns the steema.teechart.styles.ValuesLists object of the series.
Series::getVertAxis()
Series::getVerticalAxis()
Determines Vertical axis associated to this Series.
Default value: VerticalAxis.Left
Series::getVisible()
Returns if this series is Visible.
Series::getXValues()
Values defining horizontal point positions.
Series::getYMandatory()
Returns whether or not this Series has Y values as mandatory.
Series::getYValueList()
Returns the value list that the AListName parameter has.
Series::getYValues()
Values defining vertical point positions.

WARNING:
You CAN NOT Delete, Clear or Add values DIRECTLY. You need to call the Series equivalent methods to do this.
Series::getZOrder()
Determines where on the depth axis the Series is drawn.

Series::hasDataSource()
Series::hasListenersOf()
Series::hasNoMandatoryValues()
Series::isNull()
Returns true if the index th point in the Series is "null" or "empty".
Series::isValidSeriesSource()
Series::isValidSourceOf()
Validates Series datasource.
Series::legendItemColor()
Series::legendToValueIndex()
Series::maxMarkWidth()
Returns the length in pixels of the longest Mark text.
Series::moreSameZOrder()
Returns true if there are more series that share the same Z order.
For example Stacked Bars.
Series::mouseEvent()
Series::newFromType()
Creates a new series from the Class type of an existing series object.
Series::numSampleValues()
Series::onDisposing()
Series::paintLegend()
Draws the Series "Legend" on the specified rectangle and Graphics.
Series::prepareForGallery()
Series::prepareLegendCanvas()
Series::randomBounds()
Removes count number of points starting at index.
When RemoveGap parameter is true, it calls ValueList FillSequence.
The Chart will be automatically redrawn.
Dependent Series will be recalculated.
Series::readResolve()
Series::recalcGetAxis()
Series::refreshSeries()
Recalculates all dependent Series points again.
Series::removeMarkTextResolver()
Series::removeSeriesMouseListener()
Series::removeSeriesPaintListener()
Series::repaint()
Forces the Chart to Repaint.
You don't normally call Repaint directly. It can be used within derived TChartSeries components when changing their properties internally .
Series::sameClass()
Returns True when the tmpSeries parameter is of the same class.
Series::setActive()
Shows or hides this series.
Series::setChart()
Series::setColor()
Default color for all points.
Default value: Color.Empty
Series::setColorEach()
Series::setColorMember()
Sets the Datasource Color Field.
Default value: ""
Series::setColors()
Accesses the stored Color Array, if created, for the Series.
Default value: null
Series::setCursor()
Cursor displayed when mouse is over a series point.
Default value: default
Series::setCustomHorizAxis()
Specifies the custom horizontal axis for the series.
Default value: null
Series::setCustomHorizAxisValue()
Specifies the custom horizontal axis for the series.
Default value: null
Series::setCustomVertAxis()
Specifies the custom vertical axis for the series.
Default value: null
Series::setCustomVertAxisValue()
Specifies the custom vertical axis for the series.
Default value: null
Series::setDataSource()
Object to load data from.
Default value: null
Series::setDepth()
Sets the Depth of the series points or interconnecting lines.
Default value: -1
Series::setEndZ()
Series::setFunction()
Series::setHorizontal()
Series::setHorizontalAxis()
Stes the Horizontal axis associated to this Series.
Default value: HorizontalAxis.Bottom
Series::setLabelMember()
Sets the Datasource Label Field.
Default value: ""
Series::setLabels()
Accesses a list of series point labels.
Series::setMarks()
Series::setMarkTextResolver()
Series::setMiddleZ()
Series::setNull()
Sets the specified series point to a null (transparent) point.
Series::setPercentFormat()
Sets the Format to display point values as percentage.
Default value: Language::getString("DefPercentFormat")
Series::setSeriesColor()
Obsolete.&nbsp;Use the Series.Color method instead.
Series::setShowInLegend()
Displays this Series Title in Legend.
Default value: true
Series::setStartZ()
Series::setSubGallery()
Creates and prepares the index'th Series style to show at sub-gallery dialog.
Series::setTitle()
Series description to show in Legend and dialogs.
Default value: ""
Series::setValueFormat()
Determines the Format to display point values.
Default value: Language::getString("DefValueFormat")
Series::setValueList()
Series::setVerticalAxis()
Determines Vertical axis associated to this Series.
Default value: VerticalAxis.Left
Series::setVisible()
An alias to Active property.
Shows or Hides the component.
Series::setXValues()
Series::setYValues()
Series::setZOrder()
Determines where on the depth axis the Series is drawn.

Default value: AutoZOrder
Series::setZPositions()
Series::swapValueIndex()
Exchanges one point with another. Also the point color and point label.
Series::titleOrName()
Obsolete.&nbsp;Please use ToString() method instead.
Series::toString()
Overridden ToString() method.
Series::valuesListAdd()
Series::xScreenToValue()
Returns the corresponding X value of a Screen position between Axis limits.
The Screen position must be between Axis limits.
Series::yScreenToValue()
Returns the corresponding Y value of a Screen position between Axis limits.
The resulting Value is based on the Series.GetVertAxis.
Series::__get()
Series::__set()

Class: TeeBase

TeeBase::__construct()
TeeBase::getChart()
Chart associated with this object.
TeeBase::invalidate()
Use invalidate when the entire canvas needs to be repainted.
TeeBase::setBooleanProperty()
TeeBase::setChart()
Chart associated with this object.
TeeBase::setColorProperty()
TeeBase::setDoubleProperty()
TeeBase::setIntegerProperty()
TeeBase::setStringProperty()
TeeBase::_setColorProperty()
TeeBase::__get()
TeeBase::__set()

Class Details

[line 20]
Candle class

Description: Candle Series

Example: $candleSeries = Candle($myChart->getChart()); $candleSeries->fillSampleValues(30);




Tags:

author:  
version:  1.0
copyright:  (c) 1995-2008 by Steema Software SL. All Rights Reserved. <info@steema.com>
link:  http://www.steema.com


[ Top ]


Class Methods


constructor Candle [line 46]

Candle Candle( [ $c = null])



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method clicked [line 477]

void clicked( $xint)



Tags:

access:  public


Overrides Custom::clicked() (Calculates if any point is at XY position.)

Parameters:

   $xint  

[ Top ]

method createSubGallery [line 92]

void createSubGallery( $addSubChart)



Tags:

access:  public


Overrides Series::createSubGallery() (parent method not documented)

Parameters:

   $addSubChart  

[ Top ]

method drawValue [line 292]

void drawValue( valueIndex $valueIndex)

Called internally. Draws the "ValueIndex" point of the Series.



Tags:

access:  public


Overrides Custom::drawValue() (Called internally. Draws the "ValueIndex" point of the Series.)

Parameters:

valueIndex   $valueIndex   int

[ Top ]

method getCandleWidth [line 141]

int getCandleWidth( )

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:

access:  public


[ Top ]

method getDescription [line 470]

String getDescription( )

Gets descriptive text.



Tags:

access:  public


Overrides Series::getDescription() (Gets descriptive text.)

[ Top ]

method getDownCloseColor [line 197]

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:

access:  public


[ Top ]

method getPen [line 445]

void getPen( )



Tags:

access:  public


[ Top ]

method getShowClose [line 241]

boolean getShowClose( )

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:

access:  public


[ Top ]

method getShowOpen [line 219]

boolean getShowOpen( )

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:

access:  public


[ Top ]

method getStyle [line 69]

CandleStyle getStyle( )

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:

access:  public


[ Top ]

method getUpCloseColor [line 168]

Color getUpCloseColor( )

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:

access:  public


[ Top ]

method prepareForGallery [line 449]

void prepareForGallery( $isEnabled)



Tags:

access:  public


Overrides Series::prepareForGallery() (parent method not documented)

Parameters:

   $isEnabled  

[ Top ]

method setCandleWidth [line 151]

void setCandleWidth( int $value)

Sets the horizontal Candle Size in pixels.
Default value: 6



Tags:

access:  public


Parameters:

int   $value  

[ Top ]

method setDownCloseColor [line 207]

void setDownCloseColor( value $value)

Candle color fill when Close value is greater than Open value.
Default value: red



Tags:

access:  public


Parameters:

value   $value   Color

[ Top ]

method setShowClose [line 251]

void setShowClose( value $value)

Determines whether Close prices will be displayed.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setShowOpen [line 229]

void setShowOpen( value $value)

Determines whether Open prices will be displayed.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setStyle [line 85]

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:

access:  public


Parameters:

CandleStyles   $value  

[ Top ]

method setSubGallery [line 101]

void setSubGallery( $index)



Tags:

access:  public


Overrides Series::setSubGallery() (Creates and prepares the index'th Series style to show at sub-gallery dialog.)

Parameters:

   $index  

[ Top ]

method setUpCloseColor [line 178]

void setUpCloseColor( value $value)

Candle color fill when Open value is greater than Close value.
Default value: white



Tags:

access:  public


Parameters:

value   $value   Color

[ Top ]

method __get [line 32]

void __get( $property)



Overrides OHLC::__get() (parent method not documented)

Parameters:

   $property  

[ Top ]

method __set [line 39]

void __set( $property, $value)



Overrides OHLC::__set() (parent method not documented)

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:03:42 +0200 by phpDocumentor 1.4.1