Graph: ezcGraphNumericDataSet
[ ]
[ ]
[ ]
[ ]
[ ]
Class: ezcGraphNumericDataSet
|
Dataset for numeric data. [
source]
Uses user defined functions for numeric data creation
Parents
ezcGraphDataSet
|
--ezcGraphNumericDataSet
Properties
|
callback |
read/write
|
$callback
Callback function which represents the mathmatical function to show |
|
float |
read/write
|
$end
End value for x axis values of function |
|
int |
read/write
|
$resolution
Steps used to draw line in graph |
|
float |
read/write
|
$start
Start value for x axis values of function |
Member Variables
|
protected int |
$position
= 0
Position of the data iterator. Depends on the configured resolution. |
|
protected array(string=>mixed) |
$properties
Container to hold the properties |
Method Summary
|
public int |
count(
)
Returns the number of elements in this dataset |
|
public string |
current(
)
Returns the currently selected datapoint. |
|
protected float |
getKey(
$position )
Get the x coordinate for the current position |
|
public string |
key(
)
Returns the key of the currently selected datapoint. |
|
public float |
next(
)
Returns the next datapoint and selects it or false on the last datapoint. |
|
public bool |
offsetExists(
$key )
Returns true if the given datapoint exists Allows isset() using ArrayAccess. |
|
public float |
offsetGet(
$key )
Returns the value for the given datapoint Get an datapoint value by ArrayAccess. |
|
public void |
offsetSet(
$key, $value )
Throws a ezcBasePropertyPermissionException because single datapoints cannot be set in average datasets. |
|
public float |
rewind(
)
Selects the very first datapoint and returns it. |
|
public bool |
valid(
)
Returns if the current datapoint is valid. |
|
public mixed |
__get(
$propertyName )
Property get access. |
|
public mixed |
__set(
$propertyName, $propertyValue )
Options write access |
Methods
count
int count(
)
Returns the number of elements in this dataset
current
string current(
)
Returns the currently selected datapoint.
This method is part of the Iterator interface to allow access to the datapoints of this row by iterating over it like an array (e.g. using foreach).
getKey
float getKey(
int
$position )
Get the x coordinate for the current position
Parameters
| Name |
Type |
Description |
$position |
int |
Position |
key
string key(
)
Returns the key of the currently selected datapoint.
This method is part of the Iterator interface to allow access to the datapoints of this row by iterating over it like an array (e.g. using foreach).
next
float next(
)
Returns the next datapoint and selects it or false on the last datapoint.
This method is part of the Iterator interface to allow access to the datapoints of this row by iterating over it like an array (e.g. using foreach).
offsetExists
bool offsetExists(
string
$key )
Returns true if the given datapoint exists Allows isset() using ArrayAccess.
Parameters
| Name |
Type |
Description |
$key |
string |
The key of the datapoint to get. |
offsetGet
float offsetGet(
string
$key )
Returns the value for the given datapoint Get an datapoint value by ArrayAccess.
Parameters
| Name |
Type |
Description |
$key |
string |
The key of the datapoint to get. |
offsetSet
void offsetSet(
string
$key, float
$value )
Throws a ezcBasePropertyPermissionException because single datapoints cannot be set in average datasets.
Parameters
| Name |
Type |
Description |
$key |
string |
The kex of a datapoint to set. |
$value |
float |
The value for the datapoint. |
Throws
| Class | Description |
|---|
ezcBasePropertyPermissionException |
Always, because access is readonly. |
rewind
float rewind(
)
Selects the very first datapoint and returns it.
This method is part of the Iterator interface to allow access to the datapoints of this row by iterating over it like an array (e.g. using foreach).
valid
bool valid(
)
Returns if the current datapoint is valid.
This method is part of the Iterator interface to allow access to the datapoints of this row by iterating over it like an array (e.g. using foreach).
__get
mixed __get(
string
$propertyName )
Property get access.
Simply returns a given option.
Parameters
| Name |
Type |
Description |
$propertyName |
string |
The name of the option to get. |
Throws
| Class | Description |
|---|
ezcBasePropertyNotFoundException |
If a the value for the property options is not an instance of |
__set
mixed __set(
mixed
$propertyName, mixed
$propertyValue )
Options write access
Parameters
| Name |
Type |
Description |
$propertyName |
mixed |
Option name |
$propertyValue |
mixed |
Option value; |
Throws
| Class | Description |
|---|
ezcBasePropertyNotFoundException |
If Option could not be found |
ezcBaseValueException |
If value is out of range |
Last updated: Wed, 18 Jun 2008
