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

Class: SeriesCollection

Source Location: /styles/SeriesCollection.php

Class Overview

ArrayObject
   |
   --SeriesCollection

SeriesCollection class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Inherited Constants

Class: ArrayObject (Internal Class)

ARRAY_AS_PROPS = 2
STD_PROP_LIST = 1

Inherited Methods

Class: ArrayObject (Internal Class)

constructor __construct ( $array )
append ( $value )
asort ( )
count ( )
exchangeArray ( $array )
getArrayCopy ( )
getFlags ( )
getIterator ( )
getIteratorClass ( )
ksort ( )
natcasesort ( )
natsort ( )
offsetExists ( $index )
offsetGet ( $index )
offsetSet ( $index, $newval )
offsetUnset ( $index )
setFlags ( $flags )
setIteratorClass ( $iteratorClass )
uasort ( $cmp_function )
uksort ( $cmp_function )

Class Details

[line 17]
SeriesCollection class

Description: The SeriesCollection class, a collection of Series objects, is manipulated via the TChart TChart.getSeries() method.




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

$chart =

[line 19]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


constructor SeriesCollection [line 39]

SeriesCollection SeriesCollection( [ $c = null])



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method activeUseAxis [line 233]

void activeUseAxis( )



Tags:

access:  public


[ Top ]

method add [line 65]

Series add( s $s)

Adds a new Series instance to Chart.



Tags:

return:  The same Series.
access:  public


Parameters:

s   $s   Series The Series instance to add.

[ Top ]

method clear [line 198]

void clear( [dispose $dispose = true])

Removes (and optionally disposes) all Series.



Tags:

access:  public


Parameters:

dispose   $dispose   boolean

[ Top ]

method exchange [line 183]

void exchange( series1 $series1, series2 $series2)

Changes the Series order, swapping one Series Z position with another.
The Chart repaints to reflect the new Series order.
It accesses TChart.SeriesList method.



Tags:

access:  public


Parameters:

series1   $series1   int
series2   $series2   int

[ Top ]

method fillSampleValues [line 277]

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

Adds the specified NumValues random points to all series in the collection.



Tags:

access:  public


Parameters:

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

[ Top ]

method getApplyZOrder [line 254]

boolean getApplyZOrder( )

Sets multiple Series on same Chart in different Z spaces when true.


Run-time only.
It's valid only when TChart.View3D is true and when there's more than one Series in the same chart.
When false, all Series are drawn using the full Chart Z space. The Chart output can be confusing if Series overlap.
Default value: true




Tags:

access:  public


[ Top ]

method getChart [line 229]

IBaseChart getChart( )

Defines the Chart component.



Tags:

access:  public


[ Top ]

method getSeries [line 89]

void getSeries( $index)



Tags:

access:  public


Parameters:

   $index  

[ Top ]

method indexOf [line 119]

int indexOf( s $s)

Returns the corresponding point index which has the specified Value.



Tags:

access:  public


Parameters:

s   $s   Series

[ Top ]

method insert [line 97]

void insert( $index, $s)



Tags:

access:  public


Parameters:

   $index  
   $s  

[ Top ]

method internalAdd [line 44]

void internalAdd( $s)



Tags:

access:  public


Parameters:

   $s  

[ Top ]

method moveTo [line 102]

void moveTo( $s, $index)



Tags:

access:  public


Parameters:

   $s  
   $index  

[ Top ]

method remove [line 143]

void remove( s $s)

Deletes the specified Series from the Chart list of series.



Tags:

access:  public


Parameters:

s   $s   Series

[ Top ]

method removeAllSeries [line 169]

void removeAllSeries( )

Removes all Series from the Chart but does not dispose of (destroy) them.



Tags:

access:  public


[ Top ]

method setApplyZOrder [line 265]

void setApplyZOrder( value $value)

Sets multiple Series on same Chart in different Z spaces when true.
Run-time only.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setChart [line 283]

void setChart( $chart)



Tags:

access:  public


Parameters:

   $chart  

[ Top ]

method setSeries [line 93]

void setSeries( $index, $value)



Tags:

access:  public


Parameters:

   $index  
   $value  

[ Top ]

method withTitle [line 128]

void withTitle( $title)



Tags:

access:  public


Parameters:

   $title  

[ Top ]

method __get [line 25]

void __get( $property)



Parameters:

   $property  

[ Top ]

method __set [line 32]

void __set( $property, $value)



Parameters:

   $property  
   $value  

[ Top ]


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