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

Class: Series

Source Location: /styles/Series.php

Class Overview

TeeBase
   |
   --Series

Series class


Author(s):

  • Steema Software SL.

Version:

  • 1.0

Copyright:

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

Implements interfaces:

Variables

Methods


Child classes:

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

Inherited Variables

Inherited Methods


Class Details

[line 25]
Series class

Description: The base class for all TeeChart Series styles




Tags:

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


[ Top ]


Class Variables

static $AUTODEPTH =  -1

[line 91]

Constant field for internal use.



Tags:

access:  public

Type:   mixed


[ Top ]

static $AUTOZORDER =  -1

[line 95]

Constant field for internal use.



Tags:

access:  public

Type:   mixed


[ Top ]

$allowSinglePoint =  true

[line 78]



Tags:

access:  public

Type:   mixed


[ Top ]

$bActive = true

[line 56]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bBrush =

[line 55]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bColorEach =

[line 52]



Tags:

access:  protected

Type:   mixed


[ Top ]

$calcVisiblePoints = true

[line 64]



Tags:

access:  protected

Type:   mixed


[ Top ]

$colorMember = ""

[line 66]



Tags:

access:  protected

Type:   mixed


[ Top ]

$customMarkText =

[line 54]



Tags:

access:  protected

Type:   mixed


[ Top ]

$drawBetweenPoints = true

[line 61]



Tags:

access:  protected

Type:   mixed


[ Top ]

$endZ =

[line 60]



Tags:

access:  protected

Type:   mixed


[ Top ]

$firstVisible =

[line 70]



Tags:

access:  protected

Type:   mixed


[ Top ]

$hasZValues =

[line 87]

Returns true if the series has ZValues.



Tags:

access:  public

Type:   mixed


[ Top ]

$iColors =

[line 51]



Tags:

access:  protected

Type:   mixed


[ Top ]

$InternalUse =

[line 75]



Tags:

access:  public

Type:   mixed


[ Top ]

$iNumSampleValues =

[line 72]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iZOrder =

[line 76]



Tags:

access:  public

Type:   mixed


[ Top ]

$labelMember = ""

[line 65]



Tags:

access:  protected

Type:   mixed


[ Top ]

$lastVisible =

[line 71]



Tags:

access:  protected

Type:   mixed


[ Top ]

$listenerList =

[line 53]



Tags:

access:  protected

Type:   mixed


[ Top ]

$mandatory =

[line 46]



Tags:

access:  protected

Type:   mixed


[ Top ]

$manualData =  true

[line 77]



Tags:

access:  public

Type:   mixed


[ Top ]

$marks = null

[line 57]



Tags:

access:  protected

Type:   mixed


[ Top ]

$middleZ =

[line 59]



Tags:

access:  protected

Type:   mixed


[ Top ]

$notMandatory =

[line 47]



Tags:

access:  protected

Type:   mixed


[ Top ]

$percentDecimal =

[line 69]



Tags:

access:  protected

Type:   mixed


[ Top ]

$percentFormat =

[line 68]



Tags:

access:  protected

Type:   mixed


[ Top ]

$sLabels =

[line 50]



Tags:

access:  protected

Type:   mixed


[ Top ]

$startZ =

[line 58]



Tags:

access:  protected

Type:   mixed


[ Top ]

$useAxis =  true

[line 83]

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 63]



Tags:

access:  protected

Type:   mixed


[ Top ]

$valueFormat =

[line 67]



Tags:

access:  protected

Type:   mixed


[ Top ]

$vxValues =

[line 48]



Tags:

access:  protected

Type:   mixed


[ Top ]

$vyValues =

[line 49]



Tags:

access:  protected

Type:   mixed


[ Top ]

$yMandatory = true

[line 62]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor Series [line 269]

Series Series( [ $c = null])



Tags:

access:  protected


Parameters:

   $c  

[ Top ]

destructor __destruct [line 113]


method add [line 2854]

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 3127]

void addArray( values $values)

Adds the array of double values.



Tags:

access:  public


Parameters:

values   $values   double[]

[ Top ]

method addChartValue [line 893]

void addChartValue( $source, $valueIndex)



Tags:

access:  protected


Parameters:

   $source  
   $valueIndex  

[ Top ]

method added [line 2552]

void added( )



Tags:

access:  protected


[ Top ]

method addNull [line 2843]

int addNull( )

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



Tags:

access:  public


[ Top ]

method addNullXY [line 2832]

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 3468]


method addSeriesMouseListener [line 212]

void addSeriesMouseListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method addSeriesPaintListener [line 184]

void addSeriesPaintListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method addText [line 3068]

int addText( text $text)

Adds a new null point with specified text.



Tags:

access:  public


Parameters:

text   $text   String

[ Top ]

method addValues [line 1078]

void addValues( $source)



Tags:

access:  protected


Parameters:

   $source  

[ Top ]

method addXY [line 2918]

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 3018]

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 2957]

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 2972]

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 3050]

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 2901]

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 3031]

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 508]

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 529]

void assignDispose( $s, $newSeries)



Tags:

access:  public


Parameters:

   $s  
   $newSeries  

[ Top ]

method assignValues [line 887]

void assignValues( source $source)

Adds all Values from Source seriesto the current Series.



Tags:

access:  public


Parameters:

source   $source   Series

[ Top ]

method associatedToAxis [line 834]

void associatedToAxis( $a)



Tags:

access:  public


Overridden in child classes as:

Circular::associatedToAxis()


Implementation of:
ISeries::associatedToAxis()

Parameters:

   $a  

[ Top ]

method beginUpdate [line 1059]

void beginUpdate( )

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



Tags:

access:  public


[ Top ]

method calcFirstLastVisibleIndex [line 1418]

void calcFirstLastVisibleIndex( )



Tags:

access:  public



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

method calcHorizMargins [line 779]

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 1905]

int calcPosValue( value $value)

Returns "Value" parameter coordinate position in pixels.



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method calcVerticalMargins [line 789]

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 1918]

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.
CustomPolar::calcXPos()
Returns the pixel Screen Horizontal coordinate of the ValueIndex Series
Pie::calcXPos()
Returns the pixel Screen Horizontal coordinate of the ValueIndex Series value.
Smith::calcXPos()
The pixel Screen Horizontal coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Horizontal Axis.
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 1931]

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 3819]

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 1943]

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.
CustomPolar::calcYPos()
Returns the pixel Screen Vertical coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Vertical Axis.
Smith::calcYPos()
The pixel Screen Vertical coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Vertical Axis.
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 1954]

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 3832]

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 388]

void calcZOrder( )



Tags:

access:  public


Overridden in child classes as:

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

[ Top ]

method canAddRandomPoints [line 2313]

void canAddRandomPoints( )



Tags:

access:  protected


[ Top ]

method changeType [line 548]

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 2482]

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 3155]

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 3200]

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 2414]

void checkOtherSeries( $dest)



Tags:

access:  public


Parameters:

   $dest  

[ Top ]

method clear [line 3217]

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 3224]

void clearLists( )



Tags:

access:  protected


Overridden in child classes as:

Pie::clearLists()

[ Top ]

method clicked [line 3256]

int clicked( x $x, y $y)

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



Tags:

access:  public


Overridden in child classes as:

Custom::clicked()
Calculates if any point is at XY position.
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
CustomPolar::clicked()
The ValueIndex of the "clicked" point in the Series.
Pie::clicked()
Smith::clicked()
The ValueIndex of the "clicked" point in the Series.
Funnel::clicked()
The ValueIndex of the "clicked" point in the Series.
ShapeSeries::clicked()
Returns the ValueIndex of the "clicked" point in the Series.

Parameters:

x   $x   int
y   $y   int

[ Top ]

method cloneS [line 858]

void cloneS( )



Tags:

access:  public


[ Top ]

method cloneSeries [line 853]

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 3084]

void convertArray( source $a, $numPoints)

Adds all points in source Series.



Tags:

access:  protected


Parameters:

source   $a   Series
   $numPoints  

[ Top ]

method createNewSeries [line 363]

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 3790]


method dataSourceArray [line 1132]

void dataSourceArray( )



Tags:

access:  public



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

method delete [line 3277]

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 302]

void dispose( )



Tags:

access:  public



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

method doAfterDrawValues [line 382]

void doAfterDrawValues( )



Tags:

access:  protected


Overridden in child classes as:

CustomPolar::doAfterDrawValues()

[ Top ]

method doBeforeDrawChart [line 2216]

void doBeforeDrawChart( )



Tags:

access:  public


Overridden in child classes as:

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

[ Top ]

method doBeforeDrawValues [line 376]

void doBeforeDrawValues( )



Tags:

access:  protected


Overridden in child classes as:

Circular::doBeforeDrawValues()
CustomPolar::doBeforeDrawValues()
Smith::doBeforeDrawValues()

[ Top ]

method doClick [line 1207]

void doClick( $valueIndex, $e)



Tags:

access:  public


Parameters:

   $valueIndex  
   $e  

[ Top ]

method doClickPointer [line 244]

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



Tags:

access:  protected


Parameters:

   $valueIndex  
   $x  
   $y  

[ Top ]

method doDoubleClick [line 1201]

void doDoubleClick( $valueIndex, $e)



Tags:

access:  public


Parameters:

   $valueIndex  
   $e  

[ Top ]

method draw [line 2203]

void draw( )



Tags:

access:  protected


Overridden in child classes as:

Custom::draw()
Bezier::draw()
FastLine::draw()
CustomPolar::draw()
Pie::draw()
Smith::draw()
Funnel::draw()

[ Top ]

method drawLegend [line 1372]

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



Tags:

access:  public



Implementation of:
ISeries::drawLegend()

Parameters:

   $g  
   $valueIndex  
   $rect  

[ Top ]

method drawLegendShape [line 1350]

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



Tags:

access:  protected


Overridden in child classes as:

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

Parameters:

   $g  
   $valueIndex  
   $rect  

[ Top ]

method drawMark [line 1963]

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



Tags:

access:  protected


Overridden in child classes as:

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

Parameters:

   $valueIndex  
   $st  
   $aPosition  

[ Top ]

method drawMarks [line 1996]

void drawMarks( )



Tags:

access:  public



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

method drawSeries [line 2222]

void drawSeries( )

Draws the series to the Chart Canvas.



Tags:

access:  public


[ Top ]

method drawSeriesForward [line 2123]

void drawSeriesForward( $valueIndex)



Tags:

access:  protected


Overridden in child classes as:

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

Parameters:

   $valueIndex  

[ Top ]

method drawValue [line 3765]

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.
CustomPolar::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Pie::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Smith::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.
Funnel::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
HighLow::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 3740]

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 1067]

void endUpdate( )

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



Tags:

access:  public


[ Top ]

method fillSampleValues [line 3500]

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 220]

void fireSeriesMouseEvent( $se)



Tags:

access:  protected


Parameters:

   $se  

[ Top ]

method fireSeriesPaint [line 192]

void fireSeriesPaint( $e)



Tags:

access:  protected


Parameters:

   $e  

[ Top ]

method galleryChanged3D [line 794]

void galleryChanged3D( $is3D)



Tags:

access:  public


Overridden in child classes as:

Pie::galleryChanged3D()
Donut::galleryChanged3D()

Parameters:

   $is3D  

[ Top ]

method getActive [line 2625]

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 525]

void getAllowSinglePoint( )



Tags:

access:  public



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

method getBitmapEditor [line 604]

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 2594]

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 1225]

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 757]

String getColorMember( )

The the Datasource Color Field.
Default value: ""



Tags:

access:  public


[ Top ]

method getColors [line 422]

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 3265]

int getCount( )

Returns the number of points in the Series.



Tags:

access:  public



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

method getCountLegendItems [line 1230]

void getCountLegendItems( )



Tags:

access:  public


Overridden in child classes as:

Pie::getCountLegendItems()
Funnel::getCountLegendItems()


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

method getCursor [line 3697]

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 639]

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 676]

Axis getCustomVertAxis( )

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



Tags:

access:  public


[ Top ]

method getDataSource [line 2326]

Object getDataSource( )

Object to load data from.
Default value: null



Tags:

access:  public



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

method getDepth [line 3593]

int getDepth( )

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



Tags:

access:  public


[ Top ]

method getDescription [line 1250]

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.
Polar::getDescription()
Gets descriptive text.
Pie::getDescription()
Gets descriptive text.
Donut::getDescription()
Gets descriptive text.
Smith::getDescription()
Gets descriptive text.
Bar::getDescription()
Gets descriptive text.
Bar3D::getDescription()
Gets descriptive text.
HorizBar::getDescription()
Gets descriptive text.
Funnel::getDescription()
Gets descriptive text.
HighLow::getDescription()
Gets descriptive text.
Pyramid::getDescription()
Gets descriptive text.
ShapeSeries::getDescription()
Gets descriptive text.

[ Top ]

method getEndZ [line 1786]

int getEndZ( )

For internal use.



Tags:

access:  public



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

method getFields [line 2393]

void getFields( $otherList)



Tags:

access:  protected


Parameters:

   $otherList  

[ Top ]

method getFirstVisible [line 3672]

int getFirstVisible( )

Returns the index of the Series' first visible point.



Tags:

access:  public



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

method getFunction [line 3565]

Function getFunction( )

Function object to calculate values.
Default value: null



Tags:

access:  public


[ Top ]

method getHasZValues [line 2176]

void getHasZValues( )



Tags:

access:  public



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

method getHorizAxis [line 260]

void getHorizAxis( )



Tags:

access:  public



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

method getHorizontalAxis [line 1851]

HorizontalAxis getHorizontalAxis( )

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



Tags:

access:  public


[ Top ]

method getLabelMember [line 734]

String getLabelMember( )

The the Datasource Label Field.
Default value: ""



Tags:

access:  public


[ Top ]

method getLabels [line 712]

StringList getLabels( )

Accesses a list of series point labels.



Tags:

access:  public



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

method getLastVisible [line 3682]

int getLastVisible( )

Returns the index of the Series' last visible point.



Tags:

access:  public



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

method getLegendString [line 3930]

String getLegendString( legendIndex $legendIndex, legendTextStyle $legendTextStyle)

Returns the formatted String corresponding to the LegendIndex point.



Tags:

access:  public


Overridden in child classes as:

Funnel::getLegendString()
Returns LegendString for LegendIndex'th item.


Implementation of:
ISeries::getLegendString()

Parameters:

legendIndex   $legendIndex   int
legendTextStyle   $legendTextStyle   LegendTextStyle

[ Top ]

method getMandatory [line 298]

void getMandatory( )



Tags:

access:  public



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

method getMarks [line 3721]

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 1611]

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


Overridden in child classes as:

Funnel::getMarkText()


Implementation of:
ISeries::getMarkText()

Parameters:

valueIndex   $valueIndex   int

[ Top ]

method getMarkValue [line 1522]

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 4016]

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.
Funnel::getMaxXValue()
Returns the Maximum Value of the Series X Values List.
Pyramid::getMaxXValue()
The Maximum Value of the Series X Values List.

[ Top ]

method getMaxYValue [line 4026]

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.
HighLow::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 4056]

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 1751]

int getMiddleZ( )

For internal use.



Tags:

access:  public



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

method getMinXValue [line 4036]

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.
Funnel::getMinXValue()
Returns the Minimum Value of the Series X 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.
Pyramid::getMinXValue()
The Minimum Value of the Series X Values List.

[ Top ]

method getMinYValue [line 4046]

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.
Funnel::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.
HighLow::getMinYValue()
The Minimum Value of the Series Y Values List.
Pyramid::getMinYValue()
The Minimum Value of the Series Y Values List.

[ Top ]

method getMinZValue [line 4066]

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 294]

void getNotMandatory( )



Tags:

access:  public



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

method getNumGallerySeries [line 1240]

int getNumGallerySeries( )

For internal use.



Tags:

access:  public


[ Top ]

method getNumSampleValues [line 3458]

void getNumSampleValues( )



Tags:

access:  public


[ Top ]

method getOriginValue [line 1958]

void getOriginValue( $valueIndex)



Tags:

access:  public


Overridden in child classes as:

Bar3D::getOriginValue()


Implementation of:
ISeries::getOriginValue()

Parameters:

   $valueIndex  

[ Top ]

method getPercentFormat [line 1830]

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 448]

SeriesXYPoint getPoint( index $index)

Point characteristics.



Tags:

access:  public


Parameters:

index   $index   int

[ Top ]

method getSeriesColor [line 2572]

Color getSeriesColor( )

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



Tags:

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


[ Top ]

method getShowInLegend [line 3651]

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 1738]

int getStartZ( )

For internal use.



Tags:

access:  public



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

method getTitle [line 2691]

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 830]

void getUseAxis( )



Tags:

access:  public



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

method getValueColor [line 1985]

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 1807]

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 getValueList [line 2381]

void getValueList( $name)



Tags:

access:  public



Implementation of:
ISeries::getValueList()

Parameters:

   $name  

[ Top ]

method getValueListNum [line 2376]

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 1675]

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 570]

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 264]

void getVertAxis( )



Tags:

access:  public



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

method getVerticalAxis [line 1878]

VerticalAxis getVerticalAxis( )

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



Tags:

access:  public


[ Top ]

method getVisible [line 1275]

boolean getVisible( )

Returns if this series is Visible.




Tags:

access:  public


[ Top ]

method getXValues [line 465]

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 4076]

boolean getYMandatory( )

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



Tags:

access:  public



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

method getYValueList [line 616]

ValueList getYValueList( aListName $aListName)

Returns the value list that the AListName parameter has.



Tags:

access:  public


Parameters:

aListName   $aListName   String

[ Top ]

method getYValues [line 482]

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 3625]

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 1176]

void hasDataSource( $source)



Tags:

access:  public



Implementation of:
ISeries::hasDataSource()

Parameters:

   $source  

[ Top ]

method hasListenersOf [line 250]

void hasListenersOf( $listener)



Tags:

access:  protected


Parameters:

   $listener  

[ Top ]

method hasNoMandatoryValues [line 580]

void hasNoMandatoryValues( )



Tags:

access:  public


[ Top ]

method isNull [line 3533]

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 3554]

void isValidSeriesSource( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method isValidSourceOf [line 3549]

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.
HighLow::isValidSourceOf()
True if Series source is HighLow.
Returns false if the Value parameter is the same as Self.
It's used to validate the DataSource method 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 1367]

void legendItemColor( $index)



Tags:

access:  public


Overridden in child classes as:

Funnel::legendItemColor()


Implementation of:
ISeries::legendItemColor()

Parameters:

   $index  

[ Top ]

method legendToValueIndex [line 3767]

void legendToValueIndex( $legendIndex)



Tags:

access:  public


Overridden in child classes as:

Pie::legendToValueIndex()


Implementation of:
ISeries::legendToValueIndex()

Parameters:

   $legendIndex  

[ Top ]

method maxMarkWidth [line 1504]

int maxMarkWidth( )

Returns the length in pixels of the longest Mark text.



Tags:

access:  public


[ Top ]

method moreSameZOrder [line 2186]

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 962]

void mouseEvent( $e, $c)



Tags:

access:  public


Parameters:

   $e  
   $c  

[ Top ]

method newFromType [line 318]

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 3463]

void numSampleValues( )



Tags:

access:  protected


Overridden in child classes as:

HorizArea::numSampleValues()
OHLC::numSampleValues()
Volume::numSampleValues()
Bubble::numSampleValues()
Pie::numSampleValues()
CustomBar::numSampleValues()
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

[ Top ]

method onDisposing [line 2713]

void onDisposing( )



Tags:

access:  public


Overridden in child classes as:

Circular::onDisposing()


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

method paintLegend [line 804]

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 1317]


method prepareLegendCanvas [line 1346]

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 3346]

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 333]

void readResolve( )



Tags:

access:  protected


Overridden in child classes as:

Custom::readResolve()
Funnel::readResolve()

[ Top ]

method recalcGetAxis [line 2511]

void recalcGetAxis( )



Tags:

access:  protected


[ Top ]

method refreshSeries [line 1041]

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 180]

void removeMarkTextResolver( )



Tags:

access:  public


[ Top ]

method removeSeriesMouseListener [line 216]

void removeSeriesMouseListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method removeSeriesPaintListener [line 188]

void removeSeriesPaintListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method repaint [line 1684]

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 1694]

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 2639]

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 2715]


method setColor [line 2606]

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()
CustomPolar::setColor()

Parameters:

value   $value   Color

[ Top ]

method setColorEach [line 1114]

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 767]

void setColorMember( value $value)

Sets the Datasource Color Field.
Default value: ""



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method setColors [line 438]

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 3708]

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 649]

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 663]

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 699]

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 686]

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 2337]

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 3604]

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 1790]

void setEndZ( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setFunction [line 3570]

void setFunction( $value)



Tags:

access:  public



Implementation of:
ISeries::setFunction()

Parameters:

   $value  

[ Top ]

method setHorizontal [line 2760]

void setHorizontal( )



Tags:

access:  protected


[ Top ]

method setHorizontalAxis [line 1861]

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 744]

void setLabelMember( value $value)

Sets the Datasource Label Field.
Default value: ""



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method setLabels [line 724]

void setLabels( value $value)

Accesses a list of series point labels.



Tags:

access:  public


Parameters:

value   $value   StringList

[ Top ]

method setMarks [line 1755]

void setMarks( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setMarkTextResolver [line 171]

void setMarkTextResolver( $resolver)



Tags:

access:  public


Parameters:

   $resolver  

[ Top ]

method setMiddleZ [line 1759]

void setMiddleZ( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setNull [line 3784]

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 1840]

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 2308]

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 3662]

void setShowInLegend( value $value)

Displays this Series Title in Legend.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setStartZ [line 1742]

void setStartZ( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setSubGallery [line 3801]

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 2702]

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 1817]

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 3803]

void setValueList( $l, $value)



Tags:

access:  protected


Parameters:

   $l  
   $value  

[ Top ]

method setVerticalAxis [line 1888]

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 1286]

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 470]

void setXValues( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setYValues [line 487]

void setYValues( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setZOrder [line 3637]

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 1763]

void setZPositions( )



Tags:

access:  public


Overridden in child classes as:

CustomBar::setZPositions()

[ Top ]

method swap [line 2677]

void swap( $a, $b)



Tags:

access:  public


Parameters:

   $a  
   $b  

[ Top ]

method swapValueIndex [line 2655]

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 3888]

String titleOrName( )

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



Tags:

access:  public


[ Top ]

method toString [line 3856]

String toString( )

Overridden ToString() method.



Tags:

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


[ Top ]

method valuesListAdd [line 574]

void valuesListAdd( $value)



Tags:

access:  public



Implementation of:
ISeries::valuesListAdd()

Parameters:

   $value  

[ Top ]

method xScreenToValue [line 1299]

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 1312]

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 99]


method __set [line 106]



Documentation generated on Mon, 19 Aug 2013 13:43:00 +0200 by phpDocumentor 1.4.3