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

Class: Circular

Source Location: /styles/Circular.php

Class Overview

TeeBase
   |
   --Series
      |
      --Circular

Circular class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Child classes:

Pie
Pie class

Inherited Variables

Inherited Methods

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]
Circular class

Description: Circled Series




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

static $PIDEGREE =

[line 21]



Tags:

access:  public

Type:   mixed


[ Top ]

$iCircleXCenter =

[line 36]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iCircleYCenter =

[line 37]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iXRadius =

[line 29]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iYRadius =

[line 30]



Tags:

access:  protected

Type:   mixed


[ Top ]

$rCircleRect =

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]

$rotDegree =

[line 39]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor Circular [line 58]

Circular Circular( [ $c = null])



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method adjustCircleRect [line 70]

void adjustCircleRect( )



Tags:

access:  protected


[ Top ]

method angleToPos [line 312]

Point angleToPos( angle $angle, aXRadius $aXRadius, aYRadius $aYRadius)

Returns the exact Screen position for a given pair of Angle and Radius values.



Tags:

access:  public


Parameters:

angle   $angle   double
aXRadius   $aXRadius   double
aYRadius   $aYRadius   double

[ Top ]

method associatedToAxis [line 319]

void associatedToAxis( $a)



Tags:

access:  public


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

Parameters:

   $a  

[ Top ]

method calcCircleBackColor [line 92]

void calcCircleBackColor( )



Tags:

access:  protected


[ Top ]

method calcCircleGradient [line 111]

void calcCircleGradient( )



Tags:

access:  protected


[ Top ]

method calcRadius [line 116]

void calcRadius( )



Tags:

access:  protected


[ Top ]

method doBeforeDrawValues [line 197]

void doBeforeDrawValues( )



Tags:

access:  protected


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

[ Top ]

method getCircleBackColor [line 483]

Color getCircleBackColor( )

Determines the color to fill the ellipse.
Setting it to Color.EMPTY indicates the CircledSeries to use to tChart.getPanel().getColor() color.



Tags:

access:  public


[ Top ]

method getCircled [line 536]

boolean getCircled( )

The CirleSeries as elliptical or circular.
Default value: false



Tags:

access:  public


[ Top ]

method getCircleGradient [line 523]

Gradient getCircleGradient( )

Determines the Gradient which fills the ellipse.
Default value: null

Example:


 series = new com.steema.teechart.styles.Polar(myChart.getChart());
 series.fillSampleValues(20);
 series.setCircled(true);
 series.getCircleGradient().setDirection(GradientDirection.RADIAL);
 series.getCircleGradient().setStartColor(Color.WHITE);
 series.getCircleGradient().setEndColor(Color.DARK_GRAY);
 series.getCircleGradient().setRadialX(100);
 series.getCircleGradient().setRadialY(-100);
 series.getCircleGradient().setVisible(true);
 series.getCirclePen().setColor(Color.NAVY);
 series.getCirclePen().setStyle(DashStyle::$DOT);
 series.getCirclePen().setWidth(2);
 




Tags:

access:  public


[ Top ]

method getCircleHeight [line 457]

int getCircleHeight( )

Returns the height of the bounding Circle.



Tags:

access:  public


[ Top ]

method getCircleRect [line 468]

Rectangle getCircleRect( )

Returns the rectangle that bounds the circle.
eg. Pie Series, in its default position displacement of elevevation, rotation ,etc not applied.



Tags:

access:  public


[ Top ]

method getCircleWidth [line 448]

int getCircleWidth( )

Returns the width of the bounding Circle.



Tags:

access:  public


[ Top ]

method getCircleXCenter [line 425]

int getCircleXCenter( )

Returns the exact horizontal position of ellipse's center in pixels.
Run-time and read only.

The ellipse's radius is determined by Circled series.XRadius and YRadius. The AngleToPoint function converts from angles to X and Y Screen coordinates. The PointToAngle function converts from XY Screen positions to angles.




Tags:

access:  public


[ Top ]

method getCircleYCenter [line 439]

int getCircleYCenter( )

Returns the exact vertical position of the ellipse's center in pixels.


The ellipse's radius is determined by Circled series.XRadius and YRadius. The AngleToPoint function converts from angles to X and Y Screen coordinates. The PointToAngle function converts from XY Screen positions to angles.




Tags:

access:  public


[ Top ]

method getCustomXRadius [line 556]

int getCustomXRadius( )

The ellipse's horizontal radius in pixels.
Default value: 0



Tags:

access:  public


[ Top ]

method getCustomYRadius [line 576]

int getCustomYRadius( )

The ellipse's vertical radius in pixels.
Default value: 0



Tags:

access:  public


[ Top ]

method getRotationAngle [line 278]

int getRotationAngle( )

The angle of Chart rotation.


The RotationAngle can be a valid integer number between 0 and 359.
This angle can be changed by code to rotate the Pie (or Polar).
Default value: 0




Tags:

access:  public


[ Top ]

method getXRadius [line 399]

int getXRadius( )

Returns the exact horizontal size of the ellipse's radius in pixels.
The ellipse XRadius can be set to a fixed number of pixels by using this method. Circled series.Circled controls whether both radii must be proportional to the Screen X/Y ratio.



Tags:

access:  public


[ Top ]

method getYRadius [line 411]

int getYRadius( )

Returns the exact vertical size of the ellipse's radius in pixels.
The ellipse YRadius can be set to a fixed number of pixels by using this method. Circled series .Circled controls whether both radii must be proportional to the Screen X/Y ratio.



Tags:

access:  public


[ Top ]

method onDisposing [line 222]

void onDisposing( )



Tags:

access:  public


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

[ Top ]

method pointToAngle [line 330]

double pointToAngle( x $x, y $y)

Returns the angle from the XY point parameter to the circle center.



Tags:

access:  public


Parameters:

x   $x   int
y   $y   int

[ Top ]

method pointToRadius [line 364]

double pointToRadius( x $x, y $y)

Returns the radius from XY point to the circle center.



Tags:

access:  public


Parameters:

x   $x   int
y   $y   int

[ Top ]

method prepareLegendCanvas [line 212]

void prepareLegendCanvas( $g, $valueIndex, $backColor, $aBrush)



Tags:

access:  protected


Overridden in child classes as:

Pie::prepareLegendCanvas()

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

Parameters:

   $g  
   $valueIndex  
   $backColor  
   $aBrush  

[ Top ]

method rotate [line 387]

void rotate( angle $angle)

Returns the angle by which the Chart is rotated.



Tags:

access:  public


Parameters:

angle   $angle   int

[ Top ]

method setActive [line 216]

void setActive( $value)



Tags:

access:  public


Overrides Series::setActive() (Shows or hides this series.
)

Parameters:

   $value  

[ Top ]

method setChart [line 226]

void setChart( $value)



Tags:

access:  public


Overridden in child classes as:

Pie::setChart()

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

Parameters:

   $value  

[ Top ]

method setCircleBackColor [line 492]

void setCircleBackColor( value $value)

Determines the color to fill the ellipse.




Tags:

access:  public


Parameters:

value   $value   Color

[ Top ]

method setCircled [line 546]

void setCircled( value $value)

Sets CirleSeries as elliptical or circular.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setCustomXRadius [line 566]

void setCustomXRadius( value $value)

Sets ellipse's horizontal radius in pixels.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setCustomYRadius [line 586]

void setCustomYRadius( value $value)

Sets ellipse's vertical radius in pixels.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setParentProperties [line 238]

void setParentProperties( $enableParentProps)



Tags:

access:  protected


Parameters:

   $enableParentProps  

[ Top ]

method setRotationAngle [line 298]

void setRotationAngle( value $value)

Sets angle of Chart rotation.
Default value: 0


Example:


 pieSeries = new com.steema.teechart.styles.Pie(myChart.getChart());
 pieSeries.getMarks().setVisible(true);
 pieSeries.getMarks().setStyle(MarksStyle.LABELPERCENT);
 pieSeries.fillSampleValues(5);
 pieSeries.setAngleSize(180);
 pieSeries.setRotationAngle(90);
 




Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method shouldSerializeCircleBackColor [line 472]

void shouldSerializeCircleBackColor( )



Tags:

access:  protected


[ Top ]

method __get [line 44]

void __get( $property)



Overridden in child classes as:

Pie::__get()

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

Parameters:

   $property  

[ Top ]

method __set [line 51]

void __set( $property, $value)



Overridden in child classes as:

Pie::__set()

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

Parameters:

   $property  
   $value  

[ Top ]


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