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

Class: Custom

Source Location: /styles/Custom.php

Class Overview

TeeBase
   |
   --Series
      |
      --BaseLine
         |
         --CustomPoint
            |
            --Custom

Custom class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Child classes:

Area
Area Class
Bezier
Bezier class
Line
Line class
OHLC
OHLC class
Volume
Volume class

Inherited Variables

Inherited Methods

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 16]
Custom class

Description: Base Series class inherited by a number of TeeChart




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 Variables

$bAreaBrush =

[line 18]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bClickableLine =  true

[line 20]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bDark3D =  true

[line 21]



Tags:

access:  protected

Type:   mixed


[ Top ]

$drawArea =

[line 22]



Tags:

access:  protected

Type:   mixed


[ Top ]

$drawLine =  true

[line 23]



Tags:

access:  protected

Type:   mixed


[ Top ]

$pAreaLines =

[line 19]



Tags:

access:  protected

Type:   mixed


[ Top ]

$shadow =

[line 39]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor Custom [line 60]

Custom Custom( [ $c = null])

The class constructor.



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method calcHorizMargins [line 309]

void calcHorizMargins( $margins)



Tags:

access:  public


Overrides CustomPoint::calcHorizMargins() (parent method not documented)

Parameters:

   $margins  

[ Top ]

method calcVerticalMargins [line 356]

void calcVerticalMargins( $margins)



Tags:

access:  public


Overrides CustomPoint::calcVerticalMargins() (parent method not documented)

Parameters:

   $margins  

[ Top ]

method clicked [line 411]

int clicked( x $x, y $y)

Calculates if any point is at XY position.



Tags:

return:  Point index
access:  public


Overridden in child classes as:

Candle::clicked()
Volume::clicked()
Returns the ValueIndex of the "clicked" point in the Series.

Overrides CustomPoint::clicked() (Returns the ValueIndex of the "clicked" point in the Series.)

Parameters:

x   $x   int
y   $y   int

[ Top ]

method draw [line 467]

void draw( )



Tags:

access:  protected


Overridden in child classes as:

Bezier::draw()

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

[ Top ]

method drawLegendShape [line 927]

void drawLegendShape( $g, $valueIndex, $rect)



Tags:

access:  protected


Overridden in child classes as:

Volume::drawLegendShape()

Overrides CustomPoint::drawLegendShape() (parent method not documented)

Parameters:

   $g  
   $valueIndex  
   $rect  

[ Top ]

method drawValue [line 834]

void drawValue( valueIndex $valueIndex)

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



Tags:

access:  public


Overridden in child classes as:

Candle::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Volume::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.

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

Parameters:

valueIndex   $valueIndex   int

[ Top ]

method getAreaBrushColor [line 541]

void getAreaBrushColor( $c)



Tags:

access:  protected


Parameters:

   $c  

[ Top ]

method getBrush [line 144]

object {@link getBrush( )

Sets Brush characteristics.



Tags:

return:  ChartBrush}
access:  public


[ Top ]

method getClickableLine [line 84]

boolean getClickableLine( )

Allows mouse clicks over the line drawn between points.
Default value: true

Example:


 lineSeries.setClickableLine( false );
 




Tags:

access:  public


[ Top ]

method getColorEachLine [line 233]

boolean getColorEachLine( )

Enables/Disables the coloring of each connecting line of a series.
Default value: true

Example:


 lineSeries.setColorEach(true); lineSeries.setColorEachLine(false);
 




Tags:

access:  public


[ Top ]

method getDark3D [line 154]

boolean getDark3D( )

Darkens parts of 3D Line Series to add depth.
Default value: true



Tags:

access:  public


[ Top ]

method getInvertedStairs [line 253]

boolean getInvertedStairs( )

Changes the direction of the step, when true.
Default value: false



Tags:

access:  public


[ Top ]

method getLineHeight [line 295]

int getLineHeight( )

The vertical thickness of the line in pixels.
Default value: 0



Tags:

access:  public


[ Top ]

method getOpacity [line 103]

integer getOpacity( )

Opacity level from 0 to 100%



Tags:

access:  public


[ Top ]

method getOutLine [line 279]

ChartPen getOutLine( )

Pen for Series Line's outer pen.
Default value: null

Example:


 lineSeries.getOutline().setColor(Color.Yellow);
 




Tags:

access:  public


[ Top ]

method getShadow [line 970]

void getShadow( )



Tags:

access:  public


[ Top ]

method getStairs [line 201]

boolean getStairs( )

Steps line joining adjacent points.


In most normal situations, a series draws a line between each Line point. This makes the Line appear as a "mountain" shape. However, setting Stairs to true will make the Series draw 2 Lines between each pair of points, thus giving a "stair" appearance.
This is most used in some financial Chart representations.
When Stairs is set to true you may set InvertedStairs to true to alter the direction of the step.
Default value: false




Tags:

access:  public


[ Top ]

method getTransparency [line 122]

integer getTransparency( )

Transparency level from 0 to 100% Default value: 0



Tags:

access:  public


[ Top ]

method readResolve [line 67]

void readResolve( )



Tags:

access:  protected


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

[ Top ]

method setChart [line 168]

void setChart( $c)



Tags:

access:  public


Overrides CustomPoint::setChart() (parent method not documented)

Parameters:

   $c  

[ Top ]

method setClickableLine [line 94]

void setClickableLine( boolean $value)

Allows mouse clicks over the line drawn between points.

Default value: true




Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method setColor [line 181]

void setColor( $value)



Tags:

access:  public


Overridden in child classes as:

Bezier::setColor()
Volume::setColor()

Overrides Series::setColor() (Default color for all points.
Default value: Color.Empty)

Parameters:

   $value  

[ Top ]

method setColorEachLine [line 243]

void setColorEachLine( value $value)

Enables/Disables the coloring of each connecting line of a series.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setDark3D [line 164]

void setDark3D( boolean $value)

Darkens parts of 3D Line Series to add depth.
Default value: true



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method setInvertedStairs [line 263]

void setInvertedStairs( value $value)

Changes the direction of the step, when true.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setLineHeight [line 305]

void setLineHeight( value $value)

Sets the vertical thickness of the line in pixels.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setOpacity [line 112]

integer setOpacity( $value)

Sets Opacity level from 0 to 100%



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setShadow [line 974]

void setShadow( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setStairs [line 218]

void setStairs( value $value)

Steps line joining adjacent points.
Default value: false

Example:


 areaSeries1.setStairs(true);
 areaSeries2.setStairs(true);
 




Tags:

see:  #getStairs
access:  public


Parameters:

value   $value   boolean

[ Top ]

method setTransparency [line 135]

void setTransparency( integer $value)

Sets Transparency level from 0 to 100%

Default value: 0 <p>Example:


 Series1.setTransparency(45);
 
</p>




Tags:

access:  public


Parameters:

integer   $value  

[ Top ]

method __get [line 43]

void __get( $property)



Overridden in child classes as:

Area::__get()
HorizArea::__get()
Line::__get()
HorizLine::__get()
OHLC::__get()
Candle::__get()
Volume::__get()

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

Parameters:

   $property  

[ Top ]

method __set [line 50]

void __set( $property, $value)



Overridden in child classes as:

Area::__set()
HorizArea::__set()
Line::__set()
HorizLine::__set()
OHLC::__set()
Candle::__set()
Volume::__set()

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

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:04:45 +0200 by phpDocumentor 1.4.1