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

Class: Series

Source Location: /styles/Series.php

Class Overview

TeeBase
   |
   --Series

Series class


Author(s):

Version:

  • 1.0

Copyright:

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

Implements interfaces:

Variables

Methods


Child classes:

BaseLine
<p>Title: BaseLine class</p>
Circular
Circular class
CustomBar
CustomBar Class
Pyramid
Pyramid class
ShapeSeries
<p>Title: ShapeSeries class</p>

Inherited Variables

Inherited Methods


Class Details

[line 16]
Series class

Description: The base class for all TeeChart Series styles




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 $AUTODEPTH =  -1

[line 82]

Constant field for internal use.



Tags:

access:  public

Type:   mixed


[ Top ]

static $AUTOZORDER =  -1

[line 86]

Constant field for internal use.



Tags:

access:  public

Type:   mixed


[ Top ]

$allowSinglePoint =  true

[line 69]



Tags:

access:  public

Type:   mixed


[ Top ]

$bActive = true

[line 47]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bBrush =

[line 46]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bColorEach =

[line 43]



Tags:

access:  protected

Type:   mixed


[ Top ]

$calcVisiblePoints = true

[line 55]



Tags:

access:  protected

Type:   mixed


[ Top ]

$colorMember = ""

[line 57]



Tags:

access:  protected

Type:   mixed


[ Top ]

$customMarkText =

[line 45]



Tags:

access:  protected

Type:   mixed


[ Top ]

$drawBetweenPoints = true

[line 52]



Tags:

access:  protected

Type:   mixed


[ Top ]

$endZ =

[line 51]



Tags:

access:  protected

Type:   mixed


[ Top ]

$firstVisible =

[line 61]



Tags:

access:  protected

Type:   mixed


[ Top ]

$hasZValues =

[line 78]

Returns true if the series has ZValues.



Tags:

access:  public

Type:   mixed


[ Top ]

$iColors =

[line 42]



Tags:

access:  protected

Type:   mixed


[ Top ]

$InternalUse =

[line 66]



Tags:

access:  public

Type:   mixed


[ Top ]

$iNumSampleValues =

[line 63]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iZOrder =

[line 67]



Tags:

access:  public

Type:   mixed


[ Top ]

$labelMember = ""

[line 56]



Tags:

access:  protected

Type:   mixed


[ Top ]

$lastVisible =

[line 62]



Tags:

access:  protected

Type:   mixed


[ Top ]

$listenerList =

[line 44]



Tags:

access:  protected

Type:   mixed


[ Top ]

$mandatory =

[line 37]



Tags:

access:  protected

Type:   mixed


[ Top ]

$manualData =  true

[line 68]



Tags:

access:  public

Type:   mixed


[ Top ]

$marks = null

[line 48]



Tags:

access:  protected

Type:   mixed


[ Top ]

$middleZ =

[line 50]



Tags:

access:  protected

Type:   mixed


[ Top ]

$notMandatory =

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]

$percentDecimal =

[line 60]



Tags:

access:  protected

Type:   mixed


[ Top ]

$percentFormat =

[line 59]



Tags:

access:  protected

Type:   mixed


[ Top ]

$sLabels =

[line 41]



Tags:

access:  protected

Type:   mixed


[ Top ]

$startZ =

[line 49]



Tags:

access:  protected

Type:   mixed


[ Top ]

$useAxis =  true

[line 74]

Returns True when the Series needs axes to display points.

For example, Pie Series returns False (it does not need axes).




Tags:

access:  public

Type:   mixed


[ Top ]

$useSeriesColor = true

[line 54]



Tags:

access:  protected

Type:   mixed


[ Top ]

$valueFormat =

[line 58]



Tags:

access:  protected

Type:   mixed


[ Top ]

$vxValues =

[line 39]



Tags:

access:  protected

Type:   mixed


[ Top ]

$vyValues =

[line 40]



Tags:

access:  protected

Type:   mixed


[ Top ]

$yMandatory = true

[line 53]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor Series [line 215]

Series Series( [ $c = null])



Tags:

access:  protected


Parameters:

   $c  

[ Top ]

method add [line 3034]

int add( [value $value = "null"])

Adds a new point with specified value.



Tags:

access:  public



Implementation of:
ISeries::add()

Parameters:

value   $value   int

[ Top ]

method addArray [line 3307]

void addArray( values $values)

Adds the array of double values.



Tags:

access:  public


Parameters:

values   $values   double[]

[ Top ]

method addChartValue [line 954]

void addChartValue( $source, $valueIndex)



Tags:

access:  protected


Parameters:

   $source  
   $valueIndex  

[ Top ]

method added [line 2727]

void added( )



Tags:

access:  protected


[ Top ]

method addNull [line 3023]

int addNull( )

Obsolete.&nbsp;Please use add() method without parameters instead.



Tags:

access:  public


[ Top ]

method addNullXY [line 3012]

int addNullXY( x $x, y $y)

Obsolete.&nbsp;Please use add(x,y,Color.<!-- -->Transparent) method instead.



Tags:

access:  public


Parameters:

x   $x   double
y   $y   double

[ Top ]

method addSampleValues [line 3657]

void addSampleValues( $numValues)



Tags:

access:  protected


Overridden in child classes as:

OHLC::addSampleValues()
Volume::addSampleValues()
Arrow::addSampleValues()
Bubble::addSampleValues()
Gantt::addSampleValues()
Adds random values to series.
Pie::addSampleValues()
Bar3D::addSampleValues()
ShapeSeries::addSampleValues()

Parameters:

   $numValues  

[ Top ]

method addSeriesMouseListener [line 152]

void addSeriesMouseListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method addSeriesPaintListener [line 121]

void addSeriesPaintListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method addText [line 3248]

int addText( text $text)

Adds a new null point with specified text.



Tags:

access:  public


Parameters:

text   $text   String

[ Top ]

method addValues [line 1143]

void addValues( $source)



Tags:

access:  protected


Parameters:

   $source  

[ Top ]

method addXY [line 3098]

int addXY( x $x, y $y)

Adds a new point with specified x and y values.



Tags:

access:  public



Implementation of:
ISeries::addXY()

Parameters:

x   $x   double
y   $y   double

[ Top ]

method addXYColor [line 3198]

int addXYColor( x $x, y $y, color $color)

Adds a new point with specified x and y values and color.



Tags:

access:  public


Parameters:

x   $x   double
y   $y   double
color   $color   Color

[ Top ]

method addXYText [line 3137]

int addXYText( x $x, y $y, text $text)

Adds a new point with specified x,y values and text.



Tags:

access:  public


Parameters:

x   $x   double
y   $y   double
text   $text   String

[ Top ]

method addXYTextColor [line 3152]

int addXYTextColor( x $x, y $y, [text $text = ""], [color $color = null])

Adds a new point with specified x,y values, text and color.



Tags:

access:  public


Parameters:

x   $x   double
y   $y   double
text   $text   String
color   $color   Color

[ Top ]

method addYColor [line 3230]

int addYColor( value $value, color $color)

Adds a new point with specified value and color.



Tags:

access:  public


Parameters:

value   $value   double
color   $color   Color

[ Top ]

method addYText [line 3081]

int addYText( value $value, text $text)

Adds a new point with specified value and text.



Tags:

access:  public


Parameters:

value   $value   double
text   $text   String

[ Top ]

method addYTextColor [line 3211]

int addYTextColor( value $value, text $text, color $color)

Adds a new point with specified value, text and color.



Tags:

access:  public


Parameters:

value   $value   double
text   $text   String
color   $color   Color

[ Top ]

method assign [line 502]

void assign( source $source)

Copies all properties from one Series component to another.


Only the common properties shared by both source and destination Series are copied.
The following code copies all properties from Series2 into Series1:

Series1.Assign( Series2 ) ;

Some Series types restore method values after assigning them. For example, Points series restores the Pointer.Visible method to true after being assigned to a Line series, which has Pointers invisible by default.
Note: Series events are not assigned. Series DataSource and FunctionType properties are assigned. Assign is used by CloneChartSeries and ChangeSeriesType methods for example.




Tags:

access:  public


Overridden in child classes as:

BaseLine::assign()
CustomPoint::assign()

Parameters:

source   $source   Series

[ Top ]

method assignDispose [line 526]

void assignDispose( $s, $newSeries)



Tags:

access:  public


Parameters:

   $s  
   $newSeries  

[ Top ]

method assignValues [line 947]

void assignValues( source $source)

Adds all Values from Source seriesto the current Series.



Tags:

access:  public


Parameters:

source   $source   Series

[ Top ]

method associatedToAxis [line 889]

void associatedToAxis( $a)



Tags:

access:  public


Overridden in child classes as:

Circular::associatedToAxis()


Implementation of:
ISeries::associatedToAxis()

Parameters:

   $a  

[ Top ]

method beginUpdate [line 1124]

void beginUpdate( )

Recalculates the function just one time, when finished adding points.



Tags:

access:  public


[ Top ]

method calcFirstLastVisibleIndex [line 1483]

void calcFirstLastVisibleIndex( )



Tags:

access:  public



Implementation of:
ISeries::calcFirstLastVisibleIndex()
[ Top ]

method calcHorizMargins [line 822]

void calcHorizMargins( margins $margins)

Returns the number of pixels for horizontal margins



Tags:

access:  public


Overridden in child classes as:

CustomPoint::calcHorizMargins()
Custom::calcHorizMargins()
Histogram::calcHorizMargins()
Bar::calcHorizMargins()
HorizBar::calcHorizMargins()
Pyramid::calcHorizMargins()

Parameters:

margins   $margins   Margins

[ Top ]

method calcPosValue [line 2004]

int calcPosValue( value $value)

Returns "Value" parameter coordinate position in pixels.



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method calcVerticalMargins [line 833]

void calcVerticalMargins( margins $margins)

Returns the number of pixels for vertical margins



Tags:

access:  public


Overridden in child classes as:

CustomPoint::calcVerticalMargins()
Custom::calcVerticalMargins()
Histogram::calcVerticalMargins()
Bar::calcVerticalMargins()
HorizBar::calcVerticalMargins()

Parameters:

margins   $margins   Margins

[ Top ]

method calcXPos [line 2018]

int calcXPos( index $index)

The pixel Screen Horizontal coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Horizontal Axis.



Tags:

access:  public


Overridden in child classes as:

CustomPoint::calcXPos()
Returns horizontal screen position for a given point.
Pie::calcXPos()
Returns the pixel Screen Horizontal coordinate of the ValueIndex Series value.
Bar::calcXPos()
The Screen X pixel coordinate of the ValueIndex Series value.
The horizontal Bar position is the "real" X pos + the BarWidth by our BarSeries order.
HorizBar::calcXPos()
The pixel Screen Horizontal coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Horizontal Axis.

Parameters:

index   $index   int

[ Top ]

method calcXPosValue [line 2032]

int calcXPosValue( value $value)

The pixel Screen Horizontal coordinate of the specified Value.


This coordinate is calculated using the Series associated Horizontal Axis.




Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method calcXSizeValue [line 4008]

int calcXSizeValue( value $value)

Returns the size in pixels corresponding to value parameter in horizontal axis scales.
This coordinate is calculated using the Series associated Horizontal Axis.



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method calcYPos [line 2045]

int calcYPos( index $index)

The pixel Screen Vertical coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Vertical Axis.



Tags:

access:  public


Overridden in child classes as:

CustomPoint::calcYPos()
Returns vertical screen position for a given point.
Bar::calcYPos()
The Screen Y pixel coordinate of the ValueIndex Series value.
HorizBar::calcYPos()
The vertical Bar position is the "real" Y pos plus the Barwidth by our BarSeries order.
This coordinate is calculated using the Series associated Vertical Axis.

Parameters:

index   $index   int

[ Top ]

method calcYPosValue [line 2057]

int calcYPosValue( value $value)

The pixel Screen Vertical coordinate of the specified Value.
This coordinate is calculated using the Series associated Vertical Axis.



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method calcYSizeValue [line 4021]

int calcYSizeValue( value $value)

Returns the size in pixels corresponding to value parameter in vertical axis scales.
This coordinate is calculated using the Series associated Vertical Axis.



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method calcZOrder [line 369]

void calcZOrder( )



Tags:

access:  public


Overridden in child classes as:

CustomPoint::calcZOrder()
CustomBar::calcZOrder()
ShapeSeries::calcZOrder()

[ Top ]

method canAddRandomPoints [line 2488]

void canAddRandomPoints( )



Tags:

access:  protected


[ Top ]

method changeType [line 546]

Series changeType( s $s, newType $newType)

Replaces ASeries object with a new Series object of another class.



Tags:

throws:  IllegalAccessException
throws:  InstantiationException
access:  public


Parameters:

s   $s   Series
newType   $newType   Class

[ Top ]

method checkDataSource [line 2657]

void checkDataSource( )

Refreshes all Series point values, either from database Tables or Series points.


You can call this method regularly if you want new or modified data to appear in realtime in the Series. The parent Chart will be repainted to reflect any changes.




Tags:

access:  public



Implementation of:
ISeries::checkDataSource()
[ Top ]

method checkMouse [line 3335]

void checkMouse( values $c, $x, $y)

Adds the array of integer values.



Tags:

access:  public


Parameters:

values   $c   int[]
   $x  
   $y  

[ Top ]

method checkOrder [line 3380]

void 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.



Tags:

access:  public


[ Top ]

method checkOtherSeries [line 2589]

void checkOtherSeries( $dest)



Tags:

access:  public


Parameters:

   $dest  

[ Top ]

method clear [line 3400]

void 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.



Tags:

access:  public



Implementation of:
ISeries::clear()
[ Top ]

method clearLists [line 3409]

void clearLists( )



Tags:

access:  protected


Overridden in child classes as:

Pie::clearLists()

[ Top ]

method clicked [line 3430]

void clicked( $p)



Tags:

access:  public


Overridden in child classes as:

CustomPoint::clicked()
Returns the ValueIndex of the "clicked" point in the Series.
Custom::clicked()
Calculates if any point is at XY position.
Candle::clicked()
Volume::clicked()
Returns the ValueIndex of the "clicked" point in the Series.
Arrow::clicked()
FastLine::clicked()
Returns the ValueIndex of the "clicked" point in the Series.
Clicked means the X and Y coordinates are in the point screen region bounds. If no point is "touched", Clicked returns -1
Pie::clicked()
CustomBar::clicked()
Returns the ValueIndex of the "clicked" point in the Series.
Clicked means the X and Y coordinates are in the point screen region bounds. If no point is "touched", Clicked returns -1
ShapeSeries::clicked()
Returns the ValueIndex of the "clicked" point in the Series.

Parameters:

   $p  

[ Top ]

method cloneS [line 914]

void cloneS( )



Tags:

access:  public


[ Top ]

method cloneSeries [line 909]

Series cloneSeries( )

Returns a new Series, copy of this original.
It returns the SeriesIndex of the new Series.



Tags:

throws:  IllegalAccessException
throws:  InstantiationException
access:  public


[ Top ]

method convertArray [line 3264]

void convertArray( source $a, $numPoints)

Adds all points in source Series.



Tags:

access:  protected


Parameters:

source   $a   Series
   $numPoints  

[ Top ]

method createNewSeries [line 335]

Series createNewSeries( chart $chart, type $type, aFunction $aFunction, [subIndex $subIndex = 0])

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.



Tags:

throws:  IllegalAccessException
throws:  InstantiationException
access:  public


Parameters:

chart   $chart   IBaseChart
type   $type   Class
aFunction   $aFunction   Class
subIndex   $subIndex   int

[ Top ]

method createSubGallery [line 3979]


method dataSourceArray [line 1197]

void dataSourceArray( )



Tags:

access:  public



Implementation of:
ISeries::dataSourceArray()
[ Top ]

method delete [line 3466]

void delete( index $index)

Removes the index th point.
X values remain unchanged.
The Chart will be automatically redrawn.
Dependent Series will be recalculated.



Tags:

access:  public


Parameters:

index   $index   int

[ Top ]

method dispose [line 260]

void dispose( )



Tags:

access:  public



Implementation of:
ISeries::dispose()
[ Top ]

method doAfterDrawValues [line 362]

void doAfterDrawValues( )



Tags:

access:  protected


[ Top ]

method doBeforeDrawChart [line 2369]

void doBeforeDrawChart( )



Tags:

access:  public


Overridden in child classes as:

Pie::doBeforeDrawChart()
CustomBar::doBeforeDrawChart()

[ Top ]

method doBeforeDrawValues [line 355]

void doBeforeDrawValues( )



Tags:

access:  protected


Overridden in child classes as:

Circular::doBeforeDrawValues()

[ Top ]

method doClick [line 1272]

void doClick( $valueIndex, $e)



Tags:

access:  public


Parameters:

   $valueIndex  
   $e  

[ Top ]

method doClickPointer [line 187]

void doClickPointer( $valueIndex, $x, $y)



Tags:

access:  protected


Parameters:

   $valueIndex  
   $x  
   $y  

[ Top ]

method doDoubleClick [line 1266]

void doDoubleClick( $valueIndex, $e)



Tags:

access:  public


Parameters:

   $valueIndex  
   $e  

[ Top ]

method draw [line 2351]

void draw( )



Tags:

access:  protected


Overridden in child classes as:

Custom::draw()
Bezier::draw()
FastLine::draw()
Pie::draw()

[ Top ]

method drawLegend [line 1437]

void drawLegend( [ $g = null], $valueIndex, $rect)



Tags:

access:  public



Implementation of:
ISeries::drawLegend()

Parameters:

   $g  
   $valueIndex  
   $rect  

[ Top ]

method drawLegendShape [line 1415]

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



Tags:

access:  protected


Overridden in child classes as:

CustomPoint::drawLegendShape()
Custom::drawLegendShape()
Volume::drawLegendShape()
Bubble::drawLegendShape()
FastLine::drawLegendShape()
CustomBar::drawLegendShape()
ShapeSeries::drawLegendShape()

Parameters:

   $g  
   $valueIndex  
   $rect  

[ Top ]

method drawMark [line 2068]

void drawMark( $valueIndex, $st, $aPosition)



Tags:

access:  protected


Overridden in child classes as:

CustomPoint::drawMark()
HorizArea::drawMark()
Gantt::drawMark()
FastLine::drawMark()
Pie::drawMark()
Bar::drawMark()
HorizBar::drawMark()
Pyramid::drawMark()

Parameters:

   $valueIndex  
   $st  
   $aPosition  

[ Top ]

method drawMarks [line 2109]

void drawMarks( )



Tags:

access:  public



Implementation of:
ISeries::drawMarks()
[ Top ]

method drawSeries [line 2375]

void drawSeries( )

Draws the series to the Chart Canvas.



Tags:

access:  public


[ Top ]

method drawSeriesForward [line 2250]

void drawSeriesForward( $valueIndex)



Tags:

access:  protected


Overridden in child classes as:

Bar::drawSeriesForward()
HorizBar::drawSeriesForward()

Parameters:

   $valueIndex  

[ Top ]

method drawValue [line 3954]

void drawValue( index $index)

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



Tags:

access:  public


Overridden in child classes as:

CustomPoint::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Custom::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Candle::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Volume::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Arrow::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Bubble::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Gantt::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
FastLine::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Histogram::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Pie::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Bar::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
HorizBar::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Pyramid::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
ShapeSeries::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.


Implementation of:
ISeries::drawValue()

Parameters:

index   $index   int

[ Top ]

method drawValuesForward [line 3929]

boolean drawValuesForward( )

Returns whether Series draws its points in ascending/descending order.


Some Series need to draw their points in descending order (starting from the last point to the first) depending on certain situations. For example, when the horizontal axis Inverted property is True.




Tags:

return:  true if values in this series are displayed forward, from 0 to Count-1.
access:  public


Overridden in child classes as:

Pyramid::drawValuesForward()
Returns whether the Series needs to draw points in ascending/descending order.
Some Series need to draw their points in descending order (starting from the last point to the first) depending on certain situations.

[ Top ]

method endUpdate [line 1132]

void endUpdate( )

Recalculates the function just one time, when finished adding points.



Tags:

access:  public


[ Top ]

method fillSampleValues [line 3689]

void fillSampleValues( [numValues $numValues = -1])

Adds the specified NumValues random points.



Tags:

access:  public


Parameters:

numValues   $numValues   int the number of sample values to add.

[ Top ]

method fireSeriesMouseEvent [line 162]

void fireSeriesMouseEvent( $se)



Tags:

access:  protected


Parameters:

   $se  

[ Top ]

method fireSeriesPaint [line 131]

void fireSeriesPaint( $e)



Tags:

access:  protected


Parameters:

   $e  

[ Top ]

method galleryChanged3D [line 839]

void galleryChanged3D( $is3D)



Tags:

access:  public


Overridden in child classes as:

Pie::galleryChanged3D()

Parameters:

   $is3D  

[ Top ]

method getActive [line 2800]

boolean getActive( )

Shows or hides this series.


It can be changed both at design time or runtime. When hiding, all point values are preserved, so there's no need to refill the values again when showing them. The Series relatives Chart Axis are rescaled in order to accomodate changes.




Tags:

access:  public



Implementation of:
ISeries::getActive()
[ Top ]

method getAllowSinglePoint [line 521]

void getAllowSinglePoint( )



Tags:

access:  public



Implementation of:
ISeries::getAllowSinglePoint()
[ Top ]

method getBitmapEditor [line 620]

URL getBitmapEditor( )

Returns the URL of the associated bitmap icon for a given Series class.
This icon is used at ChartListBox and Series Editor dialog.



Tags:

access:  public


[ Top ]

method getColor [line 2769]

Color getColor( )

Default color for all points.


The TChart Series SeriesColor method is the default color in which the Series points will be drawn. It could be any valid color. If you add points with Color.EMPTY color, then they will be drawn with the SeriesColor color. This method is the default Color associated to the Series. When you place a new Series component in a Chart, TeeChart will assign a free color to this method (a Color that no other Series in the same Chart uses). Some Series have the ColorEach boolean property. Setting this to true will force the Series to paint each point with a different color, thus without using its SeriesColor.
SeriesColor is also used to paint the small rectangle in Chart Legend.
Default value: Color.Empty




Tags:

see:  getColorEach
access:  public


Overridden in child classes as:

Points::getColor()


Implementation of:
ISeries::getColor()
[ Top ]

method getColorEach [line 1290]

boolean getColorEach( )

Draws points with different preset Colors.


If false, all points will be drawn using the Series Series.Color color method.
If true, each Series point will be "colored" with its corresponding point color. The point colors are stored in the Series.PointColor array. If a point has an Color.Empty color value, then a TeeChart determined, available color value will be used to draw it.
Default value: false




Tags:

access:  public


Overridden in child classes as:

Bubble::getColorEach()
Controls which color will be drawn on the bubbles.
If false, all points will be drawn using Series Series.Color.
Pie::getColorEach()
Draws points with different preset Colors.
Default value: true


Implementation of:
ISeries::getColorEach()
[ Top ]

method getColorMember [line 797]

String getColorMember( )

The the Datasource Color Field.
Default value: ""



Tags:

access:  public


[ Top ]

method getColors [line 408]

ColorList 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.


Some Series types allow Color.EMPTY in their Pen and Brushes properties, thus forcing the use of the actual point color instead of the Pen or Brush assigned color.
Default value: null

<p>Example:


 candleSeries.add( ...., Color.Yellow );
 candleSeries.getColors().setColor( 10, Color.Blue);
 
</p>




Tags:

see:  getColorEach
access:  public


[ Top ]

method getCount [line 3453]

int getCount( )

Returns the number of points in the Series.



Tags:

access:  public



Implementation of:
ISeries::getCount()
[ Top ]

method getCountLegendItems [line 1295]

void getCountLegendItems( )



Tags:

access:  public


Overridden in child classes as:

Pie::getCountLegendItems()


Implementation of:
ISeries::getCountLegendItems()
[ Top ]

method getCursor [line 3886]

Cursor 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.

The Series ZOrder determines the order in which Series will be examined to calculate the clicked Series point.
Default value: default




Tags:

access:  public


[ Top ]

method getCustomHorizAxis [line 661]

Axis getCustomHorizAxis( )

Specifies the custom horizontal axis for the series.


After adding a new horizontal Custom Axis to a Chart, use CustomHorizAxis to associate the Series to the Custom Axis.
Together with the axis PositionPercent and "stretching" methods, it's possible to have unlimited axes floating anywhere on the chart.
Scroll, zoom, and axis hit-detection also apply to custom-created axes.
Creating extra axes is only allowed at run-time, as a few lines of code are necessary.
Default value: null




Tags:

access:  public


[ Top ]

method getCustomVertAxis [line 702]

Axis getCustomVertAxis( )

Specifies the custom vertical axis for the series.
Default value: null



Tags:

access:  public


[ Top ]

method getDataSource [line 2501]

Object getDataSource( )

Object to load data from.
Default value: null



Tags:

access:  public



Implementation of:
ISeries::getDataSource()
[ Top ]

method getDepth [line 3782]

int getDepth( )

The Depth of the series points or interconnecting lines.
Default value: -1



Tags:

access:  public


[ Top ]

method getDescription [line 1315]

String getDescription( )

Gets descriptive text.



Tags:

access:  public


Overridden in child classes as:

Area::getDescription()
Gets descriptive text.
HorizArea::getDescription()
Gets descriptive text.
Bezier::getDescription()
Gets descriptive text.
Line::getDescription()
Gets descriptive text.
HorizLine::getDescription()
Gets descriptive text.
Candle::getDescription()
Gets descriptive text.
Volume::getDescription()
Gets descriptive text.
Points::getDescription()
Gets descriptive text.
Arrow::getDescription()
Gets descriptive text.
Bubble::getDescription()
Gets descriptive text.
Gantt::getDescription()
Gets descriptive text.
FastLine::getDescription()
Gets descriptive text.
Histogram::getDescription()
Gets descriptive text.
Pie::getDescription()
Gets descriptive text.
Bar::getDescription()
Gets descriptive text.
Bar3D::getDescription()
Gets descriptive text.
HorizBar::getDescription()
Gets descriptive text.
Pyramid::getDescription()
Gets descriptive text.
ShapeSeries::getDescription()
Gets descriptive text.

[ Top ]

method getEndZ [line 1871]

int getEndZ( )

For internal use.



Tags:

access:  public



Implementation of:
ISeries::getEndZ()
[ Top ]

method getFields [line 2568]

void getFields( $otherList)



Tags:

access:  protected


Parameters:

   $otherList  

[ Top ]

method getFirstVisible [line 3861]

int getFirstVisible( )

Returns the index of the Series' first visible point.



Tags:

access:  public



Implementation of:
ISeries::getFirstVisible()
[ Top ]

method getFunction [line 3754]

Function getFunction( )

Function object to calculate values.
Default value: null



Tags:

access:  public


[ Top ]

method getHasZValues [line 2319]

void getHasZValues( )



Tags:

access:  public



Implementation of:
ISeries::getHasZValues()
[ Top ]

method getHorizAxis [line 204]

void getHorizAxis( )



Tags:

access:  public



Implementation of:
ISeries::getHorizAxis()
[ Top ]

method getHorizontalAxis [line 1942]

HorizontalAxis getHorizontalAxis( )

Horizontal axis associated to this Series.
Default value: HorizontalAxis.Bottom



Tags:

access:  public


[ Top ]

method getLabelMember [line 771]

String getLabelMember( )

The the Datasource Label Field.
Default value: ""



Tags:

access:  public


[ Top ]

method getLabels [line 742]

StringList getLabels( )

Accesses a list of series point labels.



Tags:

access:  public



Implementation of:
ISeries::getLabels()
[ Top ]

method getLastVisible [line 3871]

int getLastVisible( )

Returns the index of the Series' last visible point.



Tags:

access:  public



Implementation of:
ISeries::getLastVisible()
[ Top ]

method getLegendString [line 4118]

String getLegendString( legendIndex $legendIndex, legendTextStyle $legendTextStyle)

Returns the formatted String corresponding to the LegendIndex point.



Tags:

access:  public



Implementation of:
ISeries::getLegendString()

Parameters:

legendIndex   $legendIndex   int
legendTextStyle   $legendTextStyle   LegendTextStyle

[ Top ]

method getMandatory [line 255]

void getMandatory( )



Tags:

access:  public



Implementation of:
ISeries::getMandatory()
[ Top ]

method getMarks [line 3910]

SeriesMarks getMarks( )

Defines how to draw a mark near to each Series point.


A mark consist of a colored rectangle with a text string on it and a line that indicates which points corresponds to which mark.
Each different Series type draws it's marks differently.




Tags:

access:  public



Implementation of:
ISeries::getMarks()
[ Top ]

method getMarkText [line 1672]

String getMarkText( valueIndex $valueIndex)

Returns the String corresponding to the Series Mark text for a given ValueIndex point.
The Mark text depends on the Marks.Style method.




Tags:

access:  public



Implementation of:
ISeries::getMarkText()

Parameters:

valueIndex   $valueIndex   int

[ Top ]

method getMarkValue [line 1587]

double getMarkValue( valueIndex $valueIndex)

Returns corresponding Point value suitable for displaying at Series Marks.



Tags:

access:  public



Implementation of:
ISeries::getMarkValue()

Parameters:

valueIndex   $valueIndex   int

[ Top ]

method getMaxXValue [line 4204]

double getMaxXValue( )

The Maximum Value of the Series X Values List.



Tags:

access:  public


Overridden in child classes as:

CustomPoint::getMaxXValue()
Returns the Maximum Value of the Series X Values List.
Area::getMaxXValue()
The Maximum Value of the Series X Values List.
Arrow::getMaxXValue()
The Maximum Value of the Series X Values List.
Gantt::getMaxXValue()
Returns the Maximum Value of the Series X Values List.
Bar::getMaxXValue()
The Maximum Value of the Series X Values List.
HorizBar::getMaxXValue()
The Maximum Value of the Series X Values List.
Pyramid::getMaxXValue()
The Maximum Value of the Series X Values List.

[ Top ]

method getMaxYValue [line 4214]

double getMaxYValue( )

The Maximum Value of the Series Y Values List.



Tags:

access:  public


Overridden in child classes as:

CustomPoint::getMaxYValue()
Returns the Maximum Value of the Series Y Values List.
Area::getMaxYValue()
Returns the highest of all the current Series Y point values.
OHLC::getMaxYValue()
The Maximum Value of the Series Y Values List.
Arrow::getMaxYValue()
The Maximum Value of the Series Y Values List.
Bubble::getMaxYValue()
The Maximum Value of the Series Y Values List.
Bar::getMaxYValue()
The Maximum Value of the Series Y Values List.
Bar3D::getMaxYValue()
Returns the Maximum Value of the Series Y Values List.
HorizBar::getMaxYValue()
The Maximum Value of the Series Y Values List.
Pyramid::getMaxYValue()
The Maximum Value of the Series Y Values List.

[ Top ]

method getMaxZValue [line 4244]

double getMaxZValue( )

The Maximum Z Value. For non-3D series, this is the Z order.



Tags:

access:  public


Overridden in child classes as:

Bubble::getMaxZValue()
The maximum Z value.


Implementation of:
ISeries::getMaxZValue()
[ Top ]

method getMiddleZ [line 1829]

int getMiddleZ( )

For internal use.



Tags:

access:  public



Implementation of:
ISeries::getMiddleZ()
[ Top ]

method getMinXValue [line 4224]

double getMinXValue( )

The Minimum Value of the Series X Values List.



Tags:

access:  public


Overridden in child classes as:

CustomPoint::getMinXValue()
Returns the Minimum Value of the Series X Values List.
Area::getMinXValue()
The Minimum Value of the Series X Values List.
Arrow::getMinXValue()
The Minimum Value of the Series X Values List.
Bar::getMinXValue()
The Minimum Value of the Series X Values List.
HorizBar::getMinXValue()
The Minimum Value of the Series X Values List.
Pyramid::getMinXValue()
The Minimum Value of the Series X Values List.

[ Top ]

method getMinYValue [line 4234]

double getMinYValue( )

The Minimum Value of the Series Y Values List.



Tags:

access:  public


Overridden in child classes as:

CustomPoint::getMinYValue()
Returns the Minimum Value of the Series Y Values List.
Area::getMinYValue()
Returns 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::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.
Arrow::getMinYValue()
The Minimum Value of the Series Y Values List.
Bubble::getMinYValue()
The Minimum Value of the Series Y Values List.
Bar::getMinYValue()
The Minimum Value of the Series Y Values List.
Bar3D::getMinYValue()
Returns the Minimum Value of the Series Y Values List.
HorizBar::getMinYValue()
The Minimum Value of the Series Y Values Lists.
As some Series have more than one Y Values List, this Minimum Value is the "Minimum of Minimums" of all Series Y Values lists.
Pyramid::getMinYValue()
The Minimum Value of the Series Y Values List.

[ Top ]

method getMinZValue [line 4254]

double getMinZValue( )

The Minimum Z Value. For non-3D series, this is the Z order.



Tags:

access:  public


Overridden in child classes as:

Bubble::getMinZValue()
The minimum Z value.


Implementation of:
ISeries::getMinZValue()
[ Top ]

method getNotMandatory [line 250]

void getNotMandatory( )



Tags:

access:  public



Implementation of:
ISeries::getNotMandatory()
[ Top ]

method getNumGallerySeries [line 1305]

int getNumGallerySeries( )

For internal use.



Tags:

access:  public


[ Top ]

method getNumSampleValues [line 3647]

void getNumSampleValues( )



Tags:

access:  public


[ Top ]

method getOriginValue [line 2062]

void getOriginValue( $valueIndex)



Tags:

access:  public


Overridden in child classes as:

Bar3D::getOriginValue()


Implementation of:
ISeries::getOriginValue()

Parameters:

   $valueIndex  

[ Top ]

method getPercentFormat [line 1919]

String getPercentFormat( )

The Format to display point values as percentage.


PercentFormat is a standard string specifier. It is used to draw the Series Marks Percent Style figures.
Default value: Language::getString("DefPercentFormat")




Tags:

see:  getValueFormat
access:  public


[ Top ]

method getPoint [line 437]

SeriesXYPoint getPoint( index $index)

Point characteristics.



Tags:

access:  public


Parameters:

index   $index   int

[ Top ]

method getSeriesColor [line 2747]

Color getSeriesColor( )

Obsolete.&nbsp;Use the Series.Color method instead.



Tags:

see:  steema.teechart.styles.Series.Color
access:  protected


[ Top ]

method getShowInLegend [line 3840]

boolean getShowInLegend( )

Displays this Series Title in Legend.
It is only meaningful when LegendStyle is Series or LastValues.
Default value: true



Tags:

access:  public



Implementation of:
ISeries::getShowInLegend()
[ Top ]

method getStartZ [line 1814]

int getStartZ( )

For internal use.



Tags:

access:  public



Implementation of:
ISeries::getStartZ()
[ Top ]

method getTitle [line 2871]

String getTitle( )

Series description to show in Legend and dialogs.


Every Series has a Title method of type String. It is used in TChart.Legend to draw the series descriptions. If Title is empty, then the Series class Name will be used to draw the legend. Setting Title both at design time and runtime will force the Chart to repaint.
Default value: ""




Tags:

access:  public


[ Top ]

method getUseAxis [line 884]

void getUseAxis( )



Tags:

access:  public



Implementation of:
ISeries::getUseAxis()
[ Top ]

method getValueColor [line 2095]

Color getValueColor( valueIndex $valueIndex)

The colour of the index point.



Tags:

access:  public



Implementation of:
ISeries::getValueColor()

Parameters:

valueIndex   $valueIndex   int

[ Top ]

method getValueFormat [line 1894]

String getValueFormat( )

Determines the Format to display point values.
It specifies the desired formatting string to be applied to Axis Labels.

It has effect when Axis associated Series have their XValues.DateTime or YValues.DateTime is set to false.
For DateTime Axis labels use AxisLabels.DateTimeFormat.
ValueFormat is a standard formatting string specifier.
Chart Axis uses it to draw the axis labels.
Chart Series uses it to draw the Marks.
Default value: Language::getString("DefValueFormat")




Tags:

access:  public



Implementation of:
ISeries::getValueFormat()
[ Top ]

method getValueIndexSwapper [line 2852]

void getValueIndexSwapper( )



Tags:

access:  public


[ Top ]

method getValueList [line 2556]

void getValueList( $name)



Tags:

access:  public



Implementation of:
ISeries::getValueList()

Parameters:

   $name  

[ Top ]

method getValueListNum [line 2551]

void getValueListNum( list $index)

Adds the collection of objects that implement the IList interface.



Tags:

access:  public


Parameters:

list   $index   ArrayList

[ Top ]

method getValueMarkText [line 1748]

String getValueMarkText( index $index)

Returns the String representation of a Index point used to draw the Mark.



Tags:

access:  public



Implementation of:
ISeries::getValueMarkText()

Parameters:

index   $index   int

[ Top ]

method getValuesLists [line 572]

ValuesLists getValuesLists( )

Returns the steema.teechart.styles.ValuesLists object of the series.


It permits access to the list of TeeChartValueLists of a Series.
Several standard Series types such as TLineSeries and TBarSeries maintain 2 ValueLists, X and Y values. Other Series such as TCandleSeries maintain more lists, ie. DateValues, OpenValues, HighValues, LowValues and CloseValues.




Tags:

see:  com.steema.teechart.styles.ValuesLists
access:  public


[ Top ]

method getVertAxis [line 209]

void getVertAxis( )



Tags:

access:  public



Implementation of:
ISeries::getVertAxis()
[ Top ]

method getVerticalAxis [line 1973]

VerticalAxis getVerticalAxis( )

Determines Vertical axis associated to this Series.
Default value: VerticalAxis.Left



Tags:

access:  public


[ Top ]

method getVisible [line 1340]

boolean getVisible( )

Returns if this series is Visible.




Tags:

access:  public


[ Top ]

method getXValues [line 455]

ValueList getXValues( )

Values defining horizontal point positions.


By default, any Series has an XValues property. This is the IValueList where the point values will be stored at runtime. Also by default, XValues is a Public method. Some derived Series publish it: Line series, Bar series, Points series, etc. Some others publish it with another, more friendly name: GanttSeries.StartValues, etc.

WARNING:
You CAN NOT Delete, Clear or Add values DIRECTLY. You need to call the Series equivalent methods to do this.




Tags:

access:  public



Implementation of:
ISeries::getXValues()
[ Top ]

method getYMandatory [line 4264]

boolean getYMandatory( )

Returns whether or not this Series has Y values as mandatory.



Tags:

access:  public



Implementation of:
ISeries::getYMandatory()
[ Top ]

method getYValueList [line 633]

ValueList getYValueList( aListName $aListName)

Returns the value list that the AListName parameter has.



Tags:

access:  public


Parameters:

aListName   $aListName   String

[ Top ]

method getYValues [line 474]

ValueList 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.



Tags:

access:  public



Implementation of:
ISeries::getYValues()
[ Top ]

method getZOrder [line 3814]

int getZOrder( )

Determines where on the depth axis the Series is drawn.



Read-only and run time.

It's valid only when TChart.Aspect.View3D is true and when there's more than one Series in the same chart.
You can't alter the ZOrder property directly. If you want a different order, you need to use tChart.SeriesList instead.
The ZOrder property is calculated for each Series just before the Chart is drawn.
TChart.ApplyZOrder controls if Series will be assigned a different Z position or not. When False, all Series are drawn at same Z plane.
TChart.MaxZOrder returns the highest of all Series ZOrder values.
Default value: AutoZOrder




Tags:

access:  public



Implementation of:
ISeries::getZOrder()
[ Top ]

method hasDataSource [line 1241]

void hasDataSource( $source)



Tags:

access:  public



Implementation of:
ISeries::hasDataSource()

Parameters:

   $source  

[ Top ]

method hasListenersOf [line 193]

void hasListenersOf( $listener)



Tags:

access:  protected


Parameters:

   $listener  

[ Top ]

method hasNoMandatoryValues [line 584]

void hasNoMandatoryValues( )



Tags:

access:  public


[ Top ]

method isNull [line 3722]

boolean isNull( index $index)

Returns true if the index th point in the Series is "null" or "empty".


A point is considered "null" when the color of that point is "Transparent".




Tags:

return:  true if the point color is Color.Transparent
access:  public



Implementation of:
ISeries::isNull()

Parameters:

index   $index   int the point index.

[ Top ]

method isValidSeriesSource [line 3743]

void isValidSeriesSource( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method isValidSourceOf [line 3738]

boolean isValidSourceOf( value $value)

Validates Series datasource.


The isValidSourceOf function returns false if the Value parameter is the same as Self.
It's used to validate the DataSource property both at design and run-time.




Tags:

return:  true if value can be a Series data source.
access:  public


Overridden in child classes as:

OHLC::isValidSourceOf()
Validates Series datasource.
Bubble::isValidSourceOf()
It's used to validate the DataSource property both at design and run-time.
It returns false if the Value parameter is the same as Self.
Gantt::isValidSourceOf()
True if Series source is Gantt.
It returns false if the Value parameter is the same as Self.
It's used to validate DataSource both at design and run-time.
ShapeSeries::isValidSourceOf()
Returns false if the Value parameter is the same as Self.

Parameters:

value   $value   Series the series to validate.

[ Top ]

method legendItemColor [line 1432]

void legendItemColor( $index)



Tags:

access:  public



Implementation of:
ISeries::legendItemColor()

Parameters:

   $index  

[ Top ]

method legendToValueIndex [line 3956]

void legendToValueIndex( $legendIndex)



Tags:

access:  public


Overridden in child classes as:

Pie::legendToValueIndex()


Implementation of:
ISeries::legendToValueIndex()

Parameters:

   $legendIndex  

[ Top ]

method maxMarkWidth [line 1569]

int maxMarkWidth( )

Returns the length in pixels of the longest Mark text.



Tags:

access:  public


[ Top ]

method moreSameZOrder [line 2330]

boolean moreSameZOrder( )

Returns true if there are more series that share the same Z order.
For example Stacked Bars.



Tags:

access:  protected


Overridden in child classes as:

Bar::moreSameZOrder()
ShapeSeries::moreSameZOrder()

[ Top ]

method mouseEvent [line 1027]

void mouseEvent( $e, $c)



Tags:

access:  public


Parameters:

   $e  
   $c  

[ Top ]

method newFromType [line 278]

Series newFromType( type $type)

Creates a new series from the Class type of an existing series object.



Tags:

throws:  IllegalAccessException
throws:  InstantiationException
access:  public


Parameters:

type   $type   Class

[ Top ]

method numSampleValues [line 3652]


method onDisposing [line 2893]

void onDisposing( )



Tags:

access:  public


Overridden in child classes as:

Circular::onDisposing()


Implementation of:
ISeries::onDisposing()
[ Top ]

method paintLegend [line 850]

void paintLegend( g $g, r $r)

Draws the Series "Legend" on the specified rectangle and Graphics.



Tags:

access:  protected


Parameters:

g   $g   Graphics
r   $r   Rectangle

[ Top ]

method prepareForGallery [line 1382]

void prepareForGallery( $isEnabled)



Tags:

access:  public


Overridden in child classes as:

Bezier::prepareForGallery()
Internal use.
Candle::prepareForGallery()
Volume::prepareForGallery()
Gantt::prepareForGallery()
Pie::prepareForGallery()
CustomBar::prepareForGallery()
ShapeSeries::prepareForGallery()

Parameters:

   $isEnabled  

[ Top ]

method prepareLegendCanvas [line 1411]

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



Tags:

access:  protected


Overridden in child classes as:

Area::prepareLegendCanvas()
Line::prepareLegendCanvas()
Circular::prepareLegendCanvas()
Pie::prepareLegendCanvas()

Parameters:

   $g  
   $valueIndex  
   $backColor  
   $aBrush  

[ Top ]

method randomBounds [line 3535]

void randomBounds( index $numValues, count 1, removeGap 2)

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.



Tags:

access:  protected


Parameters:

count   1   int
removeGap   2   boolean
index   $numValues   int

[ Top ]

method readResolve [line 298]

void readResolve( )



Tags:

access:  protected


Overridden in child classes as:

Custom::readResolve()

[ Top ]

method recalcGetAxis [line 2686]

void recalcGetAxis( )



Tags:

access:  protected


[ Top ]

method refreshSeries [line 1106]

void refreshSeries( )

Recalculates all dependent Series points again.


Each Series has a DataSource method. When DataSource is a valid Series or DataSet component, Series get all point values from the DataSource and adds them as Series points. The RefreshSeries method forces the Series to Clear and get all points again from the DataSource component. The Refreshing process traverses the Series tree recursively.




Tags:

access:  public


[ Top ]

method removeMarkTextResolver [line 116]

void removeMarkTextResolver( )



Tags:

access:  public


[ Top ]

method removeSeriesMouseListener [line 157]

void removeSeriesMouseListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method removeSeriesPaintListener [line 126]

void removeSeriesPaintListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method repaint [line 1758]

void 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 .



Tags:

access:  public


[ Top ]

method sameClass [line 1769]

boolean sameClass( s $s)

Returns True when the tmpSeries parameter is of the same class.



Tags:

access:  protected


Parameters:

s   $s   ISeries

[ Top ]

method setActive [line 2814]

void setActive( value $value)

Shows or hides this series.


It can be changed both at design time or runtime. When hiding, all point values are preserved, so there's no need to refill the values again when showing them. The Series relatives Chart Axis are rescaled in order to accomodate changes.




Tags:

access:  public


Overridden in child classes as:

Circular::setActive()


Implementation of:
ISeries::setActive()

Parameters:

value   $value   boolean

[ Top ]

method setChart [line 2895]

void setChart( $value)



Tags:

access:  public


Overridden in child classes as:

BaseLine::setChart()
CustomPoint::setChart()
Custom::setChart()
FastLine::setChart()
Histogram::setChart()
Circular::setChart()
Pie::setChart()
CustomBar::setChart()
ShapeSeries::setChart()


Implementation of:
ISeries::setChart()
Overrides TeeBase::setChart() (Chart associated with this object.)

Parameters:

   $value  

[ Top ]

method setColor [line 2781]

void setColor( value $value)

Default color for all points.
Default value: Color.Empty



Tags:

see:  #getColorEach
access:  public


Overridden in child classes as:

Custom::setColor()
Bezier::setColor()
Volume::setColor()
Points::setColor()
FastLine::setColor()

Parameters:

value   $value   Color

[ Top ]

method setColorEach [line 1179]

void setColorEach( $value)



Tags:

access:  public


Overridden in child classes as:

Points::setColorEach()
Pie::setColorEach()
Draws points with different preset Colors.
Default value: true

Parameters:

   $value  

[ Top ]

method setColorMember [line 808]

void setColorMember( value $value)

Sets the Datasource Color Field.
Default value: ""



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method setColors [line 426]

void setColors( value $value)

Accesses the stored Color Array, if created, for the Series.
Default value: null



Tags:

see:  #getColors
access:  public


Parameters:

value   $value   ColorList

[ Top ]

method setCursor [line 3897]

void setCursor( value $value)

Cursor displayed when mouse is over a series point.
Default value: default



Tags:

access:  public


Parameters:

value   $value   Cursor

[ Top ]

method setCustomHorizAxis [line 672]

void setCustomHorizAxis( value $value)

Specifies the custom horizontal axis for the series.
Default value: null



Tags:

access:  public


Parameters:

value   $value   Axis

[ Top ]

method setCustomHorizAxisValue [line 687]

void setCustomHorizAxisValue( value $value)

Specifies the custom horizontal axis for the series.
Default value: null



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setCustomVertAxis [line 728]

void setCustomVertAxis( value $value)

Specifies the custom vertical axis for the series.
Default value: null



Tags:

access:  public


Parameters:

value   $value   Axis

[ Top ]

method setCustomVertAxisValue [line 713]

void setCustomVertAxisValue( value $value)

Specifies the custom vertical axis for the series.
Default value: null



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setDataSource [line 2512]

void setDataSource( value $value)

Object to load data from.
Default value: null



Tags:

access:  public



Implementation of:
ISeries::setDataSource()

Parameters:

value   $value   Object

[ Top ]

method setDepth [line 3793]

void setDepth( value $value)

Sets the Depth of the series points or interconnecting lines.
Default value: -1



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setEndZ [line 1876]

void setEndZ( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setFunction [line 3759]

void setFunction( $value)



Tags:

access:  public



Implementation of:
ISeries::setFunction()

Parameters:

   $value  

[ Top ]

method setHorizontal [line 2940]

void setHorizontal( )



Tags:

access:  protected


[ Top ]

method setHorizontalAxis [line 1953]

void setHorizontalAxis( value $value)

Stes the Horizontal axis associated to this Series.
Default value: HorizontalAxis.Bottom



Tags:

access:  public


Parameters:

value   $value   HorizontalAxis

[ Top ]

method setLabelMember [line 782]

void setLabelMember( value $value)

Sets the Datasource Label Field.
Default value: ""



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method setLabels [line 760]

void setLabels( value $value)

Accesses a list of series point labels.



Tags:

access:  public


Parameters:

value   $value   StringList

[ Top ]

method setMarks [line 1834]

void setMarks( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setMarkTextResolver [line 104]

void setMarkTextResolver( $resolver)



Tags:

access:  public


Parameters:

   $resolver  

[ Top ]

method setMiddleZ [line 1839]

void setMiddleZ( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setNull [line 3973]

void setNull( valueIndex $valueIndex)

Sets the specified series point to a null (transparent) point.


Example:


 lineSeries1.setNull( 123 ); // -- make null (empty) point index 123
 lineSeries1.setIgnoreNulls( false ); // -- allow null points
 lineSeries1.setStairs( true ); // -- set "stairs" mode
 




Tags:

access:  public


Parameters:

valueIndex   $valueIndex   int

[ Top ]

method setPercentFormat [line 1930]

void setPercentFormat( value $value)

Sets the Format to display point values as percentage.
Default value: Language::getString("DefPercentFormat")



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method setSeriesColor [line 2483]

void setSeriesColor( value $value)

Obsolete.&nbsp;Use the Series.Color method instead.



Tags:

see:  getColor
access:  protected


Parameters:

value   $value   Color

[ Top ]

method setShowInLegend [line 3851]

void setShowInLegend( value $value)

Displays this Series Title in Legend.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setStartZ [line 1819]

void setStartZ( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setSubGallery [line 3990]

void setSubGallery( index $index)

Creates and prepares the index'th Series style to show at sub-gallery dialog.



Tags:

access:  public


Overridden in child classes as:

Area::setSubGallery()
Line::setSubGallery()
Candle::setSubGallery()
Volume::setSubGallery()
Points::setSubGallery()
FastLine::setSubGallery()
Histogram::setSubGallery()
Pie::setSubGallery()
ShapeSeries::setSubGallery()


Implementation of:
ISeries::setSubGallery()

Parameters:

index   $index   int

[ Top ]

method setTitle [line 2882]

void setTitle( value $value)

Series description to show in Legend and dialogs.
Default value: ""



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method setValueFormat [line 1905]

void setValueFormat( value $value)

Determines the Format to display point values.
Default value: Language::getString("DefValueFormat")



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method setValueList [line 3992]

void setValueList( $l, $value)



Tags:

access:  protected


Parameters:

   $l  
   $value  

[ Top ]

method setVerticalAxis [line 1984]

void setVerticalAxis( value $value)

Determines Vertical axis associated to this Series.
Default value: VerticalAxis.Left



Tags:

access:  public


Parameters:

value   $value   VerticalAxis

[ Top ]

method setVisible [line 1351]

void setVisible( value $value)

An alias to Active property.
Shows or Hides the component.



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setXValues [line 461]

void setXValues( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setYValues [line 480]

void setYValues( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setZOrder [line 3826]

void setZOrder( value $value)

Determines where on the depth axis the Series is drawn.

Default value: AutoZOrder



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setZPositions [line 1844]

void setZPositions( )



Tags:

access:  public


Overridden in child classes as:

CustomBar::setZPositions()

[ Top ]

method swapValueIndex [line 2830]

void swapValueIndex( a $a, b $b)

Exchanges one point with another. Also the point color and point label.



Tags:

access:  protected


Overridden in child classes as:

Pie::swapValueIndex()

Parameters:

a   $a   int index of first point to exchange.
b   $b   int index of second point to exchange.

[ Top ]

method titleOrName [line 4077]

String titleOrName( )

Obsolete.&nbsp;Please use ToString() method instead.



Tags:

access:  public


[ Top ]

method toString [line 4045]

String toString( )

Overridden ToString() method.



Tags:

return:  the Series Series.Title method.
see:  getTitle
access:  public


[ Top ]

method valuesListAdd [line 577]

void valuesListAdd( $value)



Tags:

access:  public



Implementation of:
ISeries::valuesListAdd()

Parameters:

   $value  

[ Top ]

method xScreenToValue [line 1364]

double xScreenToValue( screenPos $screenPos)

Returns the corresponding X value of a Screen position between Axis limits.
The Screen position must be between Axis limits.



Tags:

access:  public


Parameters:

screenPos   $screenPos   int

[ Top ]

method yScreenToValue [line 1377]

double yScreenToValue( screenPos $screenPos)

Returns the corresponding Y value of a Screen position between Axis limits.
The resulting Value is based on the Series.GetVertAxis.



Tags:

access:  public


Parameters:

screenPos   $screenPos   int

[ Top ]

method __get [line 90]


method __set [line 97]



Documentation generated on Wed, 16 Jun 2010 12:07:49 +0200 by phpDocumentor 1.4.1