summaryrefslogtreecommitdiffstats
path: root/src/options/renderer.php
diff options
context:
space:
mode:
authorKore Nordmann <github@kore-nordmann.de>2008-08-20 11:10:02 +0000
committerKore Nordmann <github@kore-nordmann.de>2008-08-20 11:10:02 +0000
commitcc24ba1a3e2bb75ce751a7ec72d140a6582ecf2c (patch)
tree7eae31b768d5ec8c6f90c7fe76ba02a1155d3729 /src/options/renderer.php
parent59e15d56899406f7cff4fd3eae3a370410e0c898 (diff)
downloadzetacomponents-graph-cc24ba1a3e2bb75ce751a7ec72d140a6582ecf2c.zip
zetacomponents-graph-cc24ba1a3e2bb75ce751a7ec72d140a6582ecf2c.tar.gz
- More documentation improvements
# There is still some way to go...
Diffstat (limited to 'src/options/renderer.php')
-rw-r--r--src/options/renderer.php25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/options/renderer.php b/src/options/renderer.php
index 7245f60..a896767 100644
--- a/src/options/renderer.php
+++ b/src/options/renderer.php
@@ -10,6 +10,16 @@
/**
* Class containing the basic options for renderers.
*
+ * Renderer options are used to define the general appearance of charts beside
+ * the palettes. The renderer transforms chart primitives (like the legend, or
+ * one pie slice) into image primitives, which are then rendered by the
+ * drivers. The way this transformation is done, and which effects are also
+ * rendered is specified by the values in this option class.
+ *
+ * The example below shows some basic bar rendering options, which are
+ * available in all renderers. You mya want to check the tutorial sections
+ * about the renderer, which show example output for more renderer options.
+ *
* <code>
* $wikidata = include 'tutorial_wikipedia_data.php';
*
@@ -32,6 +42,21 @@
* $graph->render( 400, 150, 'tutorial_bar_chart_options.svg' );
* </code>
*
+ * For additional options, which are special to some chart type you may
+ * also want to check the option classes for the repective chart type you
+ * are using and the elements of the chart. The chart type dependant option
+ * classes are:
+ *
+ * - ezcGraphLineChartOptions
+ * - ezcGraphPieChartOptions
+ * - ezcGraphRadarChartOptions
+ *
+ * There may be additional options dependant on the renderer you are using.
+ * You may want to check the extensions of this class:
+ *
+ * - ezcGraphRenderer2dOptions
+ * - ezcGraphRenderer3dOptions
+ *
* @property float $maxLabelHeight
* Percent of chart height used as maximum height for pie chart
* labels.
OpenPOWER on IntegriCloud