phpDocumentor nChart
[ class tree: nChart ] [ index: nChart ] [ all elements ]

Class: Series

Source Location: /dataset.php

Class Series

Class Overview

Stores a series of information.

Located in /dataset.php [line 168]



		
		
		
		

Methods

[ Top ]
Method Summary
Series   Series()   Creates a new Series object.
void   AddPt()   Adds a DataPt to the Series.
void   AddValue()   Adds a Value to the Series.
string   GetName()   Returns the name of the Series.
array   GetPts()   Returns an array of the stored DataPts.
Range   GetValRange()   Returns the Range of the Values.
array   GetValues()   Returns an array of the stored Values.
Range   GetXRange()   Returns the Range of the X axis.
Range   GetYRange()   Returns the Range of the Y axis.
bool   IsValues()   Returns if this series is full of Value objects.
void   Process()   Calculates the ranges of the stored data.

[ Top ]
Methods
Constructor Series  [line 185]

  Series Series( string $name, [Value $val = null]  )

Creates a new Series object.

Parameters:
string   $name:  The name of the series.
Value   $val:  A value to add to the series.


[ Top ]
AddPt  [line 206]

  void AddPt( DataPt $pt  )

Adds a DataPt to the Series.

Parameters:
DataPt   $pt:  The point to add.


[ Top ]
AddValue  [line 217]

  void AddValue( Value $val  )

Adds a Value to the Series.

Parameters:
Value   $val:  The value to add.


[ Top ]
GetName  [line 246]

  string GetName( )

Returns the name of the Series.



[ Top ]
GetPts  [line 228]

  array GetPts( )

Returns an array of the stored DataPts.



[ Top ]
GetValRange  [line 288]

  Range GetValRange( )

Returns the Range of the Values.



[ Top ]
GetValues  [line 237]

  array GetValues( )

Returns an array of the stored Values.



[ Top ]
GetXRange  [line 279]

  Range GetXRange( )

Returns the Range of the X axis.



[ Top ]
GetYRange  [line 297]

  Range GetYRange( )

Returns the Range of the Y axis.



[ Top ]
IsValues  [line 255]

  bool IsValues( )

Returns if this series is full of Value objects.



[ Top ]
Process  [line 263]

  void Process( )

Calculates the ranges of the stored data.



[ Top ]

Documentation generated on Thu, 27 Mar 2008 22:29:47 +0000 by phpDocumentor 1.4.1