Author: kn
Date: Fri Aug 10 11:24:49 2007
New Revision: 5867
Log:
- Enhanced documentation
- Added examples to most of the classes
- Fixed class descriptions
- Refence options classes which may be used to configure the current chart.
Modified:
trunk/Graph/src/charts/bar.php
trunk/Graph/src/charts/line.php
trunk/Graph/src/charts/pie.php
trunk/Graph/src/charts/radar.php
trunk/Graph/src/driver/flash.php
trunk/Graph/src/driver/gd.php
trunk/Graph/src/driver/svg.php
trunk/Graph/src/driver/verbose.php
trunk/Graph/src/options/chart.php
trunk/Graph/src/options/driver.php
trunk/Graph/src/options/flash_driver.php
trunk/Graph/src/options/font.php
trunk/Graph/src/options/gd_driver.php
trunk/Graph/src/options/line_chart.php
trunk/Graph/src/options/pie_chart.php
trunk/Graph/src/options/radar_chart.php
trunk/Graph/src/options/renderer.php
trunk/Graph/src/options/renderer_2d.php
trunk/Graph/src/options/renderer_3d.php
trunk/Graph/src/options/svg_driver.php
trunk/Graph/src/renderer/2d.php
trunk/Graph/src/renderer/3d.php
trunk/Graph/src/renderer/axis_label_boxed.php
trunk/Graph/src/renderer/axis_label_centered.php
trunk/Graph/src/renderer/axis_label_exact.php
trunk/Graph/src/renderer/axis_label_none.php
trunk/Graph/src/renderer/axis_label_radar.php
trunk/Graph/src/renderer/axis_label_rotated.php
Modified: trunk/Graph/src/charts/bar.php
==============================================================================
--- trunk/Graph/src/charts/bar.php [iso-8859-1] (original)
+++ trunk/Graph/src/charts/bar.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -52,6 +52,10 @@
* $chart->legend->position = ezcGraph::RIGHT;
* </code>
*
+ * The chart itself also offers several options to configure the appearance. As
+ * bar charts extend line charts the the extended configure options are
+ * available in ezcGraphLineChartOptions extending the ezcGraphChartOptions.
+ *
* @version //autogentag//
* @package Graph
* @mainclass
Modified: trunk/Graph/src/charts/line.php
==============================================================================
--- trunk/Graph/src/charts/line.php [iso-8859-1] (original)
+++ trunk/Graph/src/charts/line.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -51,6 +51,10 @@
* <code>
* $chart->legend->position = ezcGraph::RIGHT;
* </code>
+ *
+ * The chart itself also offers several options to configure the appearance.
+ * The extended configure options are available in ezcGraphLineChartOptions
+ * extending the ezcGraphChartOptions.
*
* @version //autogentag//
* @package Graph
Modified: trunk/Graph/src/charts/pie.php
==============================================================================
--- trunk/Graph/src/charts/pie.php [iso-8859-1] (original)
+++ trunk/Graph/src/charts/pie.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -42,6 +42,10 @@
* <code>
* $chart->legend->position = ezcGraph::RIGHT;
* </code>
+ *
+ * The chart itself also offers several options to configure the appearance.
+ * The extended configure options are available in ezcGraphPieChartOptions
+ * extending the ezcGraphChartOptions.
*
* @version //autogentag//
* @package Graph
Modified: trunk/Graph/src/charts/radar.php
==============================================================================
--- trunk/Graph/src/charts/radar.php [iso-8859-1] (original)
+++ trunk/Graph/src/charts/radar.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -49,6 +49,10 @@
* The type of the axis may be changed and all elements can be configured by
* accessing them as properties of the chart:
*
+ * The chart itself also offers several options to configure the appearance.
+ * The extended configure options are available in ezcGraphRadarChartOptions
+ * extending the ezcGraphChartOptions.
+ *
* <code>
* $chart->legend->position = ezcGraph::RIGHT;
* </code>
Modified: trunk/Graph/src/driver/flash.php
==============================================================================
--- trunk/Graph/src/driver/flash.php [iso-8859-1] (original)
+++ trunk/Graph/src/driver/flash.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -8,7 +8,31 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Driver to create Flash4 (SWF) files as graph output.
+ * Driver to create Flash4 (SWF) files as graph output. The options of this
+ * class are defined in The options of this class are defined in the option
+ * class ezcGraphFlashDriverOptions extending the basic ezcGraphDriverOptions.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->title = 'Access statistics';
+ * $graph->legend = false;
+ *
+ * $graph->driver = new ezcGraphFlashDriver();
+ * $graph->options->font = 'tutorial_font.fdb';
+ *
+ * $graph->driver->options->compression = 7;
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ *
+ * $graph->render( 400, 200, 'tutorial_driver_flash.swf' );
+ * </code>
+ *
*
* @version //autogentag//
* @package Graph
Modified: trunk/Graph/src/driver/gd.php
==============================================================================
--- trunk/Graph/src/driver/gd.php [iso-8859-1] (original)
+++ trunk/Graph/src/driver/gd.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -15,6 +15,35 @@
* The driver can make use of the different font extensions available with
* ext/gd. It is possible to use Free Type 2, native TTF and PostScript Type 1
* fonts.
+ *
+ * The options of this driver are configured in ezcGraphGdDriverOptions
+ * extending the basic driver options class ezcGraphDriverOptions.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->palette = new ezcGraphPaletteEzGreen();
+ * $graph->title = 'Access statistics';
+ * $graph->legend = false;
+ *
+ * $graph->driver = new ezcGraphGdDriver();
+ * $graph->options->font = 'tutorial_font.ttf';
+ *
+ * // Generate a Jpeg with lower quality. The default settings result in a
+ * // better quality image
+ * $graph->driver->options->supersampling = 1;
+ * $graph->driver->options->jpegQuality = 100;
+ * $graph->driver->options->imageFormat = IMG_JPEG;
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ *
+ * $graph->render( 400, 200, 'tutorial_dirver_gd.jpg' );
+ * </code>
*
* @version //autogentag//
* @package Graph
Modified: trunk/Graph/src/driver/svg.php
==============================================================================
--- trunk/Graph/src/driver/svg.php [iso-8859-1] (original)
+++ trunk/Graph/src/driver/svg.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -9,6 +9,41 @@
*/
/**
* Extension of the basic Driver package to utilize the SVGlib.
+ *
+ * This drivers options are defined in the class ezcGraphSvgDriverOptions
+ * extending the basic driver options class ezcGraphDriverOptions.
+ *
+ * As this is the default driver you do not need to explicitely set anything to
+ * use it, but may use some of its advanced features.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->background->color = '#FFFFFFFF';
+ * $graph->title = 'Access statistics';
+ * $graph->legend = false;
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ *
+ * $graph->renderer = new ezcGraphRenderer3d();
+ * $graph->renderer->options->pieChartShadowSize = 10;
+ * $graph->renderer->options->pieChartGleam = .5;
+ * $graph->renderer->options->dataBorder = false;
+ * $graph->renderer->options->pieChartHeight = 16;
+ * $graph->renderer->options->legendSymbolGleam = .5;
+ *
+ * // SVG driver options
+ * $graph->driver->options->templateDocument = dirname( __FILE__ ) .
'/template.svg';
+ * $graph->driver->options->graphOffset = new ezcGraphCoordinate( 25, 40 );
+ * $graph->driver->options->insertIntoGroup = 'ezcGraph';
+ *
+ * $graph->render( 400, 200, 'tutorial_driver_svg.svg' );
+ * </code>
*
* @version //autogentag//
* @package Graph
Modified: trunk/Graph/src/driver/verbose.php
==============================================================================
--- trunk/Graph/src/driver/verbose.php [iso-8859-1] (original)
+++ trunk/Graph/src/driver/verbose.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -9,7 +9,8 @@
* @access private
*/
/**
- * Extension of the basic Driver package to utilize the SVGlib.
+ * Simple output driver for debuggin purposes. Just outputs shapes as text on
+ * CLI.
*
* @version //autogentag//
* @package Graph
Modified: trunk/Graph/src/options/chart.php
==============================================================================
--- trunk/Graph/src/options/chart.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/chart.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -8,7 +8,32 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for charts
+ * Class containing the basic options for charts.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->palette = new ezcGraphPaletteEzBlue();
+ * $graph->title = 'Access statistics';
+ *
+ * // Global font options
+ * $graph->options->font->name = 'serif';
+ *
+ * // Special font options for sub elements
+ * $graph->title->background = '#EEEEEC';
+ * $graph->title->font->name = 'sans-serif';
+ *
+ * $graph->options->font->maxFontSize = 8;
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ *
+ * $graph->render( 400, 150, 'tutorial_chart_title.svg' );
+ * </code>
*
* @property int $width
* Width of the chart.
Modified: trunk/Graph/src/options/driver.php
==============================================================================
--- trunk/Graph/src/options/driver.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/driver.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -8,7 +8,27 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for charts
+ * Class containing the basic driver options.
+ *
+ * <code>
+ * require_once 'tutorial_autoload.php';
+ *
+ * $graph = new ezcGraphPieChart();
+ * $graph->palette = new ezcGraphPaletteEzBlue();
+ * $graph->title = 'Access statistics';
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ *
+ * $graph->driver->options->autoShortenString = false;
+ *
+ * $graph->render( 400, 150, 'tutorial_chart_title.svg' );
+ * </code>
*
* @property int $width
* Width of the chart.
Modified: trunk/Graph/src/options/flash_driver.php
==============================================================================
--- trunk/Graph/src/options/flash_driver.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/flash_driver.php [iso-8859-1] Fri Aug 10 11:24:49
2007
@@ -8,7 +8,30 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for charts
+ * Class containing the extended configuration options for the flash driver.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->title = 'Access statistics';
+ * $graph->legend = false;
+ *
+ * $graph->driver = new ezcGraphFlashDriver();
+ * $graph->driver->options->compresion = 0;
+ *
+ * $graph->options->font = 'tutorial_font.fdb';
+ *
+ * $graph->driver->options->compression = 7;
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ *
+ * $graph->render( 400, 200, 'tutorial_driver_flash.swf' );
+ * </code>
*
* @property int $compression
* Compression level used for generated flash file
Modified: trunk/Graph/src/options/font.php
==============================================================================
--- trunk/Graph/src/options/font.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/font.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -8,13 +8,41 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for charts
+ * Class containing the options for font configuration.
+ *
+ * Global font settings will only affect the font settings of chart elements
+ * until they were modified once. Form then on the font configuration of one
+ * chart element has been copied and can only be configured independently.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->palette = new ezcGraphPaletteEzBlue();
+ * $graph->title = 'Access statistics';
+ *
+ * $graph->options->font->name = 'serif';
+ * $graph->options->font->maxFontSize = 12;
+ *
+ * $graph->title->background = '#EEEEEC';
+ * $graph->title->font->name = 'sans-serif';
+ *
+ * $graph->options->font->maxFontSize = 8;
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ *
+ * $graph->render( 400, 150, 'tutorial_chart_title.svg' );
+ * </code>
*
* @property string $name
* Name of font.
* @property string $path
* Path to font file.
- * @property string $type
+ * @property int $type
* Type of used font. May be one of the following:
* - TTF_FONT Native TTF fonts
* - PS_FONT PostScript Type1 fonts
Modified: trunk/Graph/src/options/gd_driver.php
==============================================================================
--- trunk/Graph/src/options/gd_driver.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/gd_driver.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -8,7 +8,33 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for charts
+ * Class containing the extended driver options for the gd driver.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->palette = new ezcGraphPaletteEzGreen();
+ * $graph->title = 'Access statistics';
+ * $graph->legend = false;
+ *
+ * $graph->driver = new ezcGraphGdDriver();
+ * $graph->options->font = 'tutorial_font.ttf';
+ *
+ * // Generate a Jpeg with lower quality. The default settings result in a
better
+ * // quality image
+ * $graph->driver->options->supersampling = 1;
+ * $graph->driver->options->jpegQuality = 100;
+ * $graph->driver->options->imageFormat = IMG_JPEG;
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ *
+ * $graph->render( 400, 200, 'tutorial_dirver_gd.jpg' );
+ * </code>
*
* @property int $imageFormat
* Type of generated image.
Modified: trunk/Graph/src/options/line_chart.php
==============================================================================
--- trunk/Graph/src/options/line_chart.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/line_chart.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -8,7 +8,23 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for line charts
+ * Class containing the basic options for line charts.
+ *
+ * <code>
+ * $graph = new ezcGraphLineChart();
+ * $graph->title = 'Wikipedia articles';
+ *
+ * $graph->options->fillLines = 220;
+ * $graph->options->lineThickness = 3;
+ *
+ * // Add data
+ * foreach ( $wikidata as $language => $data )
+ * {
+ * $graph->data[$language] = new ezcGraphArrayDataSet( $data );
+ * }
+ *
+ * $graph->render( 400, 150, 'tutorial_line_chart.svg' );
+ * </code>
*
* @property float $lineThickness
* Theickness of chart lines
Modified: trunk/Graph/src/options/pie_chart.php
==============================================================================
--- trunk/Graph/src/options/pie_chart.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/pie_chart.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -8,7 +8,28 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for pie charts
+ * Class containing the basic options for pie charts.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->palette = new ezcGraphPaletteEzRed();
+ * $graph->title = 'Access statistics';
+ * $graph->legend = false;
+ *
+ * $graph->options->label = '%1$s (%3$.1f)';
+ * $graph->options->percentThreshold = .05;
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ * $graph->data['Access statistics']->highlight['Explorer'] = true;
+ *
+ * $graph->render( 400, 150, 'tutorial_pie_chart_options.svg' );
+ * </code>
*
* @property string $label
* String used to label pies
Modified: trunk/Graph/src/options/radar_chart.php
==============================================================================
--- trunk/Graph/src/options/radar_chart.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/radar_chart.php [iso-8859-1] Fri Aug 10 11:24:49
2007
@@ -8,7 +8,25 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for line charts
+ * Class containing the basic options for radar charts.
+ *
+ * <code>
+ * $wikidata = include 'tutorial_wikipedia_data.php';
+ *
+ * $graph = new ezcGraphRadarChart();
+ * $graph->title = 'Wikipedia articles';
+ *
+ * $graph->options->fillLines = 220;
+ *
+ * // Add data
+ * foreach ( $wikidata as $language => $data )
+ * {
+ * $graph->data[$language] = new ezcGraphArrayDataSet( $data );
+ * $graph->data[$language][] = reset( $data );
+ * }
+ *
+ * $graph->render( 400, 150, 'tutorial_radar_chart.svg' );
+ * </code>
*
* @property float $lineThickness
* Theickness of chart lines
Modified: trunk/Graph/src/options/renderer.php
==============================================================================
--- trunk/Graph/src/options/renderer.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/renderer.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -8,7 +8,29 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for pie charts
+ * Class containing the basic options for renderers.
+ *
+ * <code>
+ * $wikidata = include 'tutorial_wikipedia_data.php';
+ *
+ * $graph = new ezcGraphBarChart();
+ * $graph->title = 'Wikipedia articles';
+ *
+ * // Add data
+ * foreach ( $wikidata as $language => $data )
+ * {
+ * $graph->data[$language] = new ezcGraphArrayDataSet( $data );
+ * }
+ *
+ * // $graph->renderer = new ezcGraphRenderer2d();
+ *
+ * $graph->renderer->options->barMargin = .2;
+ * $graph->renderer->options->barPadding = .2;
+ *
+ * $graph->renderer->options->dataBorder = 0;
+ *
+ * $graph->render( 400, 150, 'tutorial_bar_chart_options.svg' );
+ * </code>
*
* @property float $maxLabelHeight
* Percent of chart height used as maximum height for pie chart
Modified: trunk/Graph/src/options/renderer_2d.php
==============================================================================
--- trunk/Graph/src/options/renderer_2d.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/renderer_2d.php [iso-8859-1] Fri Aug 10 11:24:49
2007
@@ -8,7 +8,44 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for pie charts
+ * Class containing the extended options available in 2d renderer.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->palette = new ezcGraphPaletteBlack();
+ * $graph->title = 'Access statistics';
+ * $graph->options->label = '%2$d (%3$.1f%%)';
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ * $graph->data['Access statistics']->highlight['Explorer'] = true;
+ *
+ * // $graph->renderer = new ezcGraphRenderer2d();
+ *
+ * $graph->renderer->options->moveOut = .2;
+ *
+ * $graph->renderer->options->pieChartOffset = 63;
+ *
+ * $graph->renderer->options->pieChartGleam = .3;
+ * $graph->renderer->options->pieChartGleamColor = '#FFFFFF';
+ * $graph->renderer->options->pieChartGleamBorder = 2;
+ *
+ * $graph->renderer->options->pieChartShadowSize = 3;
+ * $graph->renderer->options->pieChartShadowColor = '#000000';
+ *
+ * $graph->renderer->options->legendSymbolGleam = .5;
+ * $graph->renderer->options->legendSymbolGleamSize = .9;
+ * $graph->renderer->options->legendSymbolGleamColor = '#FFFFFF';
+ *
+ * $graph->renderer->options->pieChartSymbolColor = '#BABDB688';
+ *
+ * $graph->render( 400, 150, 'tutorial_pie_chart_pimped.svg' );
+ * </code>
*
* @property int $pieChartShadowSize
* Size of shadows.
Modified: trunk/Graph/src/options/renderer_3d.php
==============================================================================
--- trunk/Graph/src/options/renderer_3d.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/renderer_3d.php [iso-8859-1] Fri Aug 10 11:24:49
2007
@@ -8,7 +8,46 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for pie charts
+ * Class containing the extended options for the three dimensional renderer.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->palette = new ezcGraphPaletteEzRed();
+ * $graph->title = 'Access statistics';
+ * $graph->options->label = '%2$d (%3$.1f%%)';
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ * $graph->data['Access statistics']->highlight['Explorer'] = true;
+ *
+ * $graph->renderer = new ezcGraphRenderer3d();
+ *
+ * $graph->renderer->options->moveOut = .2;
+ *
+ * $graph->renderer->options->pieChartOffset = 63;
+ *
+ * $graph->renderer->options->pieChartGleam = .3;
+ * $graph->renderer->options->pieChartGleamColor = '#FFFFFF';
+ *
+ * $graph->renderer->options->pieChartShadowSize = 5;
+ * $graph->renderer->options->pieChartShadowColor = '#000000';
+ *
+ * $graph->renderer->options->legendSymbolGleam = .5;
+ * $graph->renderer->options->legendSymbolGleamSize = .9;
+ * $graph->renderer->options->legendSymbolGleamColor = '#FFFFFF';
+ *
+ * $graph->renderer->options->pieChartSymbolColor = '#55575388';
+ *
+ * $graph->renderer->options->pieChartHeight = 5;
+ * $graph->renderer->options->pieChartRotation = .8;
+ *
+ * $graph->render( 400, 150, 'tutorial_pie_chart_3d.svg' );
+ * </code>
*
* @property bool $seperateLines
* Indicates wheather the full depth should be used for each line in
Modified: trunk/Graph/src/options/svg_driver.php
==============================================================================
--- trunk/Graph/src/options/svg_driver.php [iso-8859-1] (original)
+++ trunk/Graph/src/options/svg_driver.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -8,7 +8,28 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class containing the basic options for charts
+ * Class containing the extended options for the SVG driver.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->background->color = '#FFFFFFFF';
+ * $graph->title = 'Access statistics';
+ * $graph->legend = false;
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ *
+ * $graph->driver->options->templateDocument = dirname( __FILE__ ) .
'/template.svg';
+ * $graph->driver->options->graphOffset = new ezcGraphCoordinate( 25, 40 );
+ * $graph->driver->options->insertIntoGroup = 'ezcGraph';
+ *
+ * $graph->render( 400, 200, 'tutorial_driver_svg.svg' );
+ * </code>
*
* @property string $encoding
* Encoding of the SVG XML document
Modified: trunk/Graph/src/renderer/2d.php
==============================================================================
--- trunk/Graph/src/renderer/2d.php [iso-8859-1] (original)
+++ trunk/Graph/src/renderer/2d.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -9,7 +9,48 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class to transform chart primitives into image primitives
+ * Class to transform chart primitives into image primitives. Renders charts in
+ * a two dimensional view.
+ *
+ * The class options are defined in the class ezcGraphRenderer2dOptions
+ * extending the basic renderer options in ezcGraphRendererOptions.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->palette = new ezcGraphPaletteBlack();
+ * $graph->title = 'Access statistics';
+ * $graph->options->label = '%2$d (%3$.1f%%)';
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ * $graph->data['Access statistics']->highlight['Explorer'] = true;
+ *
+ * // $graph->renderer = new ezcGraphRenderer2d();
+ *
+ * $graph->renderer->options->moveOut = .2;
+ *
+ * $graph->renderer->options->pieChartOffset = 63;
+ *
+ * $graph->renderer->options->pieChartGleam = .3;
+ * $graph->renderer->options->pieChartGleamColor = '#FFFFFF';
+ * $graph->renderer->options->pieChartGleamBorder = 2;
+ *
+ * $graph->renderer->options->pieChartShadowSize = 3;
+ * $graph->renderer->options->pieChartShadowColor = '#000000';
+ *
+ * $graph->renderer->options->legendSymbolGleam = .5;
+ * $graph->renderer->options->legendSymbolGleamSize = .9;
+ * $graph->renderer->options->legendSymbolGleamColor = '#FFFFFF';
+ *
+ * $graph->renderer->options->pieChartSymbolColor = '#BABDB688';
+ *
+ * $graph->render( 400, 150, 'tutorial_pie_chart_pimped.svg' );
+ * </code>
*
* @version //autogentag//
* @package Graph
Modified: trunk/Graph/src/renderer/3d.php
==============================================================================
--- trunk/Graph/src/renderer/3d.php [iso-8859-1] (original)
+++ trunk/Graph/src/renderer/3d.php [iso-8859-1] Fri Aug 10 11:24:49 2007
@@ -9,7 +9,50 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Class to transform chart primitives into image primitives
+ * Class to transform chart primitives into image primitives. This renderer
+ * renders the charts in a isometric three dimensional view.
+ *
+ * The class options are defined in the class ezcGraphRenderer3dOptions
+ * extending the basic renderer options in ezcGraphRendererOptions.
+ *
+ * <code>
+ * $graph = new ezcGraphPieChart();
+ * $graph->palette = new ezcGraphPaletteEzRed();
+ * $graph->title = 'Access statistics';
+ * $graph->options->label = '%2$d (%3$.1f%%)';
+ *
+ * $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
+ * 'Mozilla' => 19113,
+ * 'Explorer' => 10917,
+ * 'Opera' => 1464,
+ * 'Safari' => 652,
+ * 'Konqueror' => 474,
+ * ) );
+ * $graph->data['Access statistics']->highlight['Explorer'] = true;
+ *
+ * $graph->renderer = new ezcGraphRenderer3d();
+ *
+ * $graph->renderer->options->moveOut = .2;
+ *
+ * $graph->renderer->options->pieChartOffset = 63;
+ *
+ * $graph->renderer->options->pieChartGleam = .3;
+ * $graph->renderer->options->pieChartGleamColor = '#FFFFFF';
+ *
+ * $graph->renderer->options->pieChartShadowSize = 5;
+ * $graph->renderer->options->pieChartShadowColor = '#000000';
+ *
+ * $graph->renderer->options->legendSymbolGleam = .5;
+ * $graph->renderer->options->legendSymbolGleamSize = .9;
+ * $graph->renderer->options->legendSymbolGleamColor = '#FFFFFF';
+ *
+ * $graph->renderer->options->pieChartSymbolColor = '#55575388';
+ *
+ * $graph->renderer->options->pieChartHeight = 5;
+ * $graph->renderer->options->pieChartRotation = .8;
+ *
+ * $graph->render( 400, 150, 'tutorial_pie_chart_3d.svg' );
+ * </code>
*
* @version //autogentag//
* @package Graph
Modified: trunk/Graph/src/renderer/axis_label_boxed.php
==============================================================================
--- trunk/Graph/src/renderer/axis_label_boxed.php [iso-8859-1] (original)
+++ trunk/Graph/src/renderer/axis_label_boxed.php [iso-8859-1] Fri Aug 10
11:24:49 2007
@@ -9,8 +9,14 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Renders axis labels centered between two axis steps like normally used for
- * bar charts.
+ * Renders axis labels centered between two axis steps like normally used for
+ * bar charts. Used with other chart types this axis label renderer may cause
+ * unexpected results. You may use this renderer by assigning it to one of the
+ * charts axis.
+ *
+ * <code>
+ * $chart->xAxis->axisLabelRenderer = new ezcGraphAxisBoxedLabelRenderer();
+ * </code>
*
* @version //autogentag//
* @package Graph
Modified: trunk/Graph/src/renderer/axis_label_centered.php
==============================================================================
--- trunk/Graph/src/renderer/axis_label_centered.php [iso-8859-1] (original)
+++ trunk/Graph/src/renderer/axis_label_centered.php [iso-8859-1] Fri Aug 10
11:24:49 2007
@@ -10,6 +10,10 @@
*/
/**
* Renders axis labels centered below the axis steps.
+ *
+ * <code>
+ * $chart->xAxis->axisLabelRenderer = new
ezcGraphAxisCenteredLabelRenderer();
+ * </code>
*
* @property bool $showZeroValue
* Show the value at the zero point of an axis. This value might be
Modified: trunk/Graph/src/renderer/axis_label_exact.php
==============================================================================
--- trunk/Graph/src/renderer/axis_label_exact.php [iso-8859-1] (original)
+++ trunk/Graph/src/renderer/axis_label_exact.php [iso-8859-1] Fri Aug 10
11:24:49 2007
@@ -10,6 +10,10 @@
*/
/**
* Renders axis labels like known from charts drawn in analysis
+ *
+ * <code>
+ * $chart->xAxis->axisLabelRenderer = new ezcGraphAxisExactLabelRenderer();
+ * </code>
*
* @property bool $showLastValue
* Show the last value on the axis, which will be aligned different
Modified: trunk/Graph/src/renderer/axis_label_none.php
==============================================================================
--- trunk/Graph/src/renderer/axis_label_none.php [iso-8859-1] (original)
+++ trunk/Graph/src/renderer/axis_label_none.php [iso-8859-1] Fri Aug 10
11:24:49 2007
@@ -9,7 +9,11 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Renders axis labels like known from charts drawn in analysis
+ * Omits axis labels, steps and grid.
+ *
+ * <code>
+ * $chart->xAxis->axisLabelRenderer = new ezcGraphAxisNoLabelRenderer();
+ * </code>
*
* @version //autogentag//
* @package Graph
Modified: trunk/Graph/src/renderer/axis_label_radar.php
==============================================================================
--- trunk/Graph/src/renderer/axis_label_radar.php [iso-8859-1] (original)
+++ trunk/Graph/src/renderer/axis_label_radar.php [iso-8859-1] Fri Aug 10
11:24:49 2007
@@ -8,7 +8,12 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Renders axis labels centered below the axis steps.
+ * Renders axis labels and grid optimized for radar charts. May cause
+ * unexpected results when used with other chart types.
+ *
+ * <code>
+ * $chart->xAxis->axisLabelRenderer = new ezcGraphAxisRadarLabelRenderer();
+ * </code>
*
* @property float $lastStep
* Position of last step on the axis to calculate the grid.
Modified: trunk/Graph/src/renderer/axis_label_rotated.php
==============================================================================
--- trunk/Graph/src/renderer/axis_label_rotated.php [iso-8859-1] (original)
+++ trunk/Graph/src/renderer/axis_label_rotated.php [iso-8859-1] Fri Aug 10
11:24:49 2007
@@ -9,8 +9,19 @@
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
- * Renders axis labels centered between two axis steps like normally used for
- * bar charts.
+ * Can render axis labels rotated, so that more axis labels fir on one axis.
+ * Produces best results if the axis space was increased, so that more spcae is
+ * available below the axis.
+ *
+ * <code>
+ * $chart->xAxis->axisLabelRenderer = new ezcGraphAxisRotatedLabelRenderer();
+ *
+ * // Define angle manually in degree
+ * $chart->xAxis->axisLabelRenderer->angle = 45;
+ *
+ * // Increase axis space
+ * $chart->xAxis->axisSpace = .2;
+ * </code>
*
* @property float $angle
* Angle of labels on axis in degrees.
--
svn-components mailing list
[email protected]
http://lists.ez.no/mailman/listinfo/svn-components
