diff options
author | Kore Nordmann <github@kore-nordmann.de> | 2008-08-20 11:10:02 +0000 |
---|---|---|
committer | Kore Nordmann <github@kore-nordmann.de> | 2008-08-20 11:10:02 +0000 |
commit | cc24ba1a3e2bb75ce751a7ec72d140a6582ecf2c (patch) | |
tree | 7eae31b768d5ec8c6f90c7fe76ba02a1155d3729 /src/structs | |
parent | 59e15d56899406f7cff4fd3eae3a370410e0c898 (diff) | |
download | zetacomponents-graph-cc24ba1a3e2bb75ce751a7ec72d140a6582ecf2c.zip zetacomponents-graph-cc24ba1a3e2bb75ce751a7ec72d140a6582ecf2c.tar.gz |
- More documentation improvements
# There is still some way to go...
Diffstat (limited to 'src/structs')
-rw-r--r-- | src/structs/context.php | 16 | ||||
-rw-r--r-- | src/structs/coordinate.php | 6 | ||||
-rw-r--r-- | src/structs/step.php | 7 |
3 files changed, 29 insertions, 0 deletions
diff --git a/src/structs/context.php b/src/structs/context.php index 370d583..60eefa7 100644 --- a/src/structs/context.php +++ b/src/structs/context.php @@ -7,9 +7,25 @@ * @copyright Copyright (C) 2005-2008 eZ systems as. All rights reserved. * @license http://ez.no/licenses/new_bsd New BSD License */ + /** * Struct to represent the context of a renderer operation * + * Objects of this class are passed to the renderer, so the renderer is able to + * maintain the associations between image primitives and the datpoints. With + * this information the renderer build the array returned by the + * getElementReferences() method of the ezcGraphRenderer classes. In the + * returned array the datapoints are then associated with the identifiers for + * the image primitives returned by the respective driver. + * + * The ezcGraphTools class offers convience methods to handle this data and + * enrich your charts with hyperlinks, so you don't need to handle this + * yourself. + * + * The struct contains information about the $dataset and $datapoint the + * image primitive is associated with. If the dataset or datapoint has an + * URL associated, this URL is also available in the context struct. + * * @version //autogentag// * @package Graph */ diff --git a/src/structs/coordinate.php b/src/structs/coordinate.php index 172320e..9040b21 100644 --- a/src/structs/coordinate.php +++ b/src/structs/coordinate.php @@ -10,6 +10,12 @@ /** * Represents coordinates in two dimensional catesian coordinate system. * + * Coordinates are used to represent the location of objects on the drawing + * plane. They are simple structs conatining the two coordinate values required + * in a two dimensional cartesian coordinate system. The class ezcGraphVector + * extends the Coordinate class and provides additional methods like rotations, + * simple arithmetic operations etc. + * * @version //autogentag// * @package Graph */ diff --git a/src/structs/step.php b/src/structs/step.php index 8cfd73f..50bc6d3 100644 --- a/src/structs/step.php +++ b/src/structs/step.php @@ -10,6 +10,13 @@ /** * Represents a single step on the axis * + * Struct class containg information for single steps in the axis. A step may + * have child steps, which are commonly known as major (bigger) and minor + * (smaller) steps on axis. + * + * The positions of multiple steps in an array generated by the + * ezcGraphChartElementAxis classes is not always distributed evenly. + * * @version //autogentag// * @package Graph */ |