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

Class: ShapeSeries

Source Location: /styles/ShapeSeries.php

Class Overview

TeeBase
   |
   --Series
      |
      --ShapeSeries

<p>Title: ShapeSeries class</p>


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: 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 15]
<p>Title: ShapeSeries class</p>

Description: Shape Series.

Copyright (c) 2005-2010 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL




Tags:

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


[ Top ]


Class Methods


constructor ShapeSeries [line 38]

ShapeSeries ShapeSeries( [ $c = null])



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method addSampleValues [line 591]

void addSampleValues( $numValues)



Tags:

access:  protected


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

Parameters:

   $numValues  

[ Top ]

method calcZOrder [line 758]

void calcZOrder( )



Tags:

access:  public


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

[ Top ]

method clicked [line 609]

int clicked( x $x, y $y)

Returns the ValueIndex of the "clicked" point in the Series.



Tags:

access:  public


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

Parameters:

x   $x   int
y   $y   int

[ Top ]

method createSubGallery [line 801]

void createSubGallery( $addSubChart)



Tags:

access:  public


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

Parameters:

   $addSubChart  

[ Top ]

method drawLegendShape [line 71]

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



Tags:

access:  protected


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

Parameters:

   $g  
   $valueIndex  
   $rect  

[ Top ]

method drawValue [line 576]

void drawValue( valueIndex $valueIndex)

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



Tags:

access:  public


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

Parameters:

valueIndex   $valueIndex   int

[ Top ]

method getBrush [line 686]

ChartBrush getBrush( )

Defines the brush used to fill shape background.


Example:


 //shape1
 shape[0] = new TeeShape(myChart.getChart());
 tmpShape = shape[0];
 tmpShape.getMarks().setVisible(false);
 tmpShape.setColor(Color.WHITE);
 tmpShape.getBrush().setColor(Color.WHITE);
 tmpShape.getBrush().setImageMode(ImageMode::$TILE);
 tmpShape.getBrush().loadImage(ChartSamplePanel.class.getResource(URL_IMAGE1));

 tmpShape.setStyle(ShapeStyle::$CIRCLE);
 tmpShape.getPen().setColor(Color.RED);
 tmpShape.getPen().setWidth(2);
 tmpShape.setX1(50);
 tmpShape.setY1(50);
 




Tags:

access:  public


[ Top ]

method getDescription [line 874]

String getDescription( )

Gets descriptive text.



Tags:

access:  public


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

[ Top ]

method getFont [line 660]

ChartFont getFont( )

Determines the font attributes used to output ShapeSeries.
No auto font sizing is performed, so you must specify the desired font size to avoid shape text from overlapping the Shape boundaries.



Tags:

access:  public


[ Top ]

method getFormat [line 263]

void getFormat( )



Tags:

access:  public


[ Top ]

method getGradient [line 704]

Gradient getGradient( )

Gets Gradient fill characteristics for the ShapeSeries Shape.



Tags:

access:  public


[ Top ]

method getHorizAlignment [line 297]

ShapeTextHorizAlign getHorizAlignment( )

Horizontally aligns the text.
There are three options; Centre, Left or Right.



Tags:

access:  public


[ Top ]

method getPen [line 695]

ChartPen getPen( )

Defines pen to draw Series Shape.



Tags:

access:  public


[ Top ]

method getStyle [line 247]

ShapeStyle getStyle( )

Defines how a TChartShape component appears on a Chart.
Default value: Circle



Tags:

access:  public


[ Top ]

method getText [line 130]

String[] getText( [ $index = -1])

Displays customized Strings inside Shapes.
You can use the Font and Aligment properties to control Text display.
Note: You may need to change Shape Font size to a different value when creating metafiles or when zooming Charts.



Tags:

access:  public


Parameters:

   $index  

[ Top ]

method getTransparent [line 720]

boolean getTransparent( )

Allows Shape Brush attributes to fill the interior of the Shape.


When false, Shapes do not redraw their background, so charting contents behind Shape Series is seen inside the Shape.
Default value: false




Tags:

access:  public


[ Top ]

method getVertAlignment [line 274]

ShapeTextVertAlign getVertAlignment( )

Sets the vertical alignment of Text within a TChartShape Series shape.


It can be Top, Center, Bottom.




Tags:

access:  public


[ Top ]

method getX0 [line 157]

double getX0( )

Coordinate used to define the englobing ShapeSeries rectangle.


The values should be expressed in Axis coordinates.
You can convert from Screen pixel coordinates to values and vice-versa using several TChart and Series methods like XScreenToValue and YScreenToValue.




Tags:

access:  public


[ Top ]

method getX1 [line 180]

double getX1( )

Coordinate used to define the englobing ShapeSeries rectangle.


The values should be expressed in Axis coordinates.
You can convert from Screen pixel coordinates to values and vice-versa using several TChart and Series methods like XScreenToValue and YScreenToValue.




Tags:

access:  public


[ Top ]

method getXYStyle [line 774]

ShapeXYStyle getXYStyle( )

Can be set to:- Axis, AxisOrigin or Pixels.



Tags:

access:  public


[ Top ]

method getY0 [line 203]

double getY0( )

Coordinate used to define the englobing ShapeSeries rectangle.


The values should be expressed in Axis coordinates.
You can convert from Screen pixel coordinates to values and vice-versa using several TChart and Series methods like XScreenToValue and YScreenToValue.




Tags:

access:  public


[ Top ]

method getY1 [line 226]

double getY1( )

Coordinate used to define the englobing ShapeSeries rectangle.


The values should be expressed in Axis coordinates.
You can convert from Screen pixel coordinates to values and vice-versa using several TChart and Series methods like XScreenToValue and YScreenToValue.




Tags:

access:  public


[ Top ]

method isValidSourceOf [line 797]

boolean isValidSourceOf( s $s)

Returns false if the Value parameter is the same as Self.



Tags:

access:  public


Overrides Series::isValidSourceOf() (Validates Series datasource.
)

Parameters:

s   $s   Series

[ Top ]

method moreSameZOrder [line 764]

void moreSameZOrder( )



Tags:

access:  protected


Overrides Series::moreSameZOrder() (Returns true if there are more series that share the same Z order.
For example Stacked Bars.)

[ Top ]

method prepareForGallery [line 734]

void prepareForGallery( $isEnabled)



Tags:

access:  public


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

Parameters:

   $isEnabled  

[ Top ]

method setChart [line 55]

void setChart( $c)



Tags:

access:  public


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

Parameters:

   $c  

[ Top ]

method setHorizAlignment [line 306]

void setHorizAlignment( value $value)

Horizontally aligns the text.




Tags:

access:  public


Parameters:

value   $value   ShapeTextHorizAlign

[ Top ]

method setStyle [line 258]

void setStyle( value $value)

Defines how a TChartShape component appears on a Chart.
Default value: Circle



Tags:

access:  public


Parameters:

value   $value   ShapeStyle

[ Top ]

method setSubGallery [line 820]

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 setText [line 708]

void setText( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setTransparent [line 730]

void setTransparent( value $value)

Allows Shape Brush attributes to fill the interior of the Shape.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setVertAlignment [line 284]

void setVertAlignment( value $value)

Sets the vertical alignment of Text within a TChartShape Series shape.





Tags:

access:  public


Parameters:

value   $value   ShapeTextVertAlign

[ Top ]

method setX0 [line 166]

void setX0( value $value)

Coordinate used to define the englobing ShapeSeries rectangle.




Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method setX1 [line 189]

void setX1( value $value)

Coordinate used to define the englobing ShapeSeries rectangle.




Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method setXYStyle [line 784]

void setXYStyle( value $value)

Can be set to:- Axis, AxisOrigin or Pixels.



Tags:

access:  public


Parameters:

value   $value   ShapeXYStyle

[ Top ]

method setY0 [line 212]

void setY0( value $value)

Coordinate used to define the englobing ShapeSeries rectangle.




Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method setY1 [line 235]

void setY1( value $value)

Coordinate used to define the englobing ShapeSeries rectangle.




Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method __get [line 24]

void __get( $property)



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

Parameters:

   $property  

[ Top ]

method __set [line 31]

void __set( $property, $value)



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

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:08:15 +0200 by phpDocumentor 1.4.1