File Source for SvgGrapher.php

<?php
/**
* $Source: /cvsroot/svggrapher/svggrapher/SvgGrapher.php,v $
*
*
*
* @version $Id: SvgGrapher.php,v 1.20 2007/10/23 09:22:51 geelweb Exp $
* @author Guillaume L. <guillaume@geelweb.org>
* @copyright Copyright © 2006, Guillaume Luchet.
* @license http://opensource.org/licenses/bsd-license.php BSD License
* @package SvgGrapher
*/
/**
* Define the library base path.
* Be carefull if you redefine this!
* @var string
*/
if(!defined('SVGGRAPHER_CLASS_PATH')) {
define('SVGGRAPHER_CLASS_PATH', dirname(__FILE__));
}
// dependances {{{
/**
* Include the library config file
*/
require_once SVGGRAPHER_CLASS_PATH . '/SvgGrapher.config.php';
/**#@+
* Include the objects helper
*/
require_once SVGGRAPHER_CLASS_PATH . '/mains/PluginManager.php';
require_once SVGGRAPHER_CLASS_PATH . '/mains/Box.php';
require_once SVGGRAPHER_CLASS_PATH . '/mains/Curve.php';
require_once SVGGRAPHER_CLASS_PATH . '/mains/SvgDocumentRenderer.php';
require_once SVGGRAPHER_CLASS_PATH . '/XMLDocument.php';
/**#@-*/
/**#@+
* Include the mains svg elements objects
*/
require_once SVGGRAPHER_ELEMENTS_PATH . '/GElement.php';
require_once SVGGRAPHER_ELEMENTS_PATH . '/DefsElement.php';
require_once SVGGRAPHER_ELEMENTS_PATH . '/LineElement.php';
/**#@-*/
// }}}
// doc {{{
/**
* SvgGrapher.
*
* Build a svg document.
*
* The most of plugin functionality are plugin defined. The plugin types are :
* - dataprovider for get the datas from various sources.
* - defs for the various svg definition.
* - filter for the curves filters.
* - internal for the internal functions (must already be in the internal
* directory).
* - marker for the curves makers
* - script for the svg scripts.
* - visual for the visual representation of the curves.
*
* For each plugin the file must be named svgGrapher.type.keyword.php and
* must contain a function named svgGrapher_type_keyword. eg: to the
* visual plugin who defined the line representation of curve the file name is
* svgGrapher.visual.line.php and the function is named
* svgGrapher_visual_line.
*
* All plugins are call using the PluginManager class, the plugins can
* access to the SvgGrapher class using the SvgGrapher::singleton() method.
*
* The plugins paths are define in the PluginManager class file.
*
* You can redefine most of constant using by the library, they are listed in
* the SvgGrapher.constants.php, you must redefined them before include
* SvgGrapher.php
*
* @author Guillaume L. <guillaume@geelweb.org>
* @link http://www.geelweb.org
* @license http://opensource.org/licenses/bsd-license.php BSD License
* @copyright Copyright © 2006, Guillaume Luchet.
* @version CVS: $Id: SvgGrapher.php,v 1.20 2007/10/23 09:22:51 geelweb Exp $
* @package SvgGrapher
* @tutorial SvgGrapher.pkg
*/ // }}}
class SvgGrapher
{
// properties {{{
/**
* Instance (singleton) of the class
* @var SvgGrapher
*/
static $instance = false;
/**
* svgDom
*
* @var mixed
* @access public
*/
public $svgDom;
// svg elements {{{
/**
* Main svg document
* @var SvgElement
*/
public $svgDocument = NULL;
/**
* Titles of the svg document
* @var GElement
*/
public $svgTitles = NULL;
/**
* Document's legend
* @var GElement
*/
public $svgLegend = NULL;
/**
* Defs elements of the svg document
* @var DefsElement
*/
public $svgDefs = NULL;
/**
* CDATA section of the svg document
* @var FragmentElement
*/
public $svgEcma = NULL;
/**
* Graph section of the svg document
* @var GElement
*/
public $svgGraphPane = NULL;
/**
* Group element to curve tooltips
* @var GElement
*/
public $svgToolTips = NULL;
// }}}
// boxes {{{
/**
* boxDoc
*
* @var Box
* @access public
*/
public $boxDoc;
/**
* boxTitle
*
* @var Box
* @access public
*/
public $boxTitle;
/**
* boxTagsX
*
* @var Box
* @access public
*/
public $boxTagsX;
/**
* boxTagsY
*
* @var Box
* @access public
*/
public $boxTagsY;
/**
* boxLabelX
*
* @var Box
* @access public
*/
public $boxLabelX;
/**
* boxLabelY
*
* @var Box
* @access public
*/
public $boxLabelY;
/**
* boxGraphPane
*
* @var Box
* @access public
*/
public $boxGraphPane;
/**
* boxLegend
*
* @var Box
* @access public
*/
public $boxLegend;
// }}}
/**
* Detailled curves datas
* @var Curve array
*/
public $curves = array();
/**
* Abscisse indications.
* var array
*/
public $tagsX = array();
/**
* tagsY
*
* @var array
* @access public
*/
public $tagsY = array();
/**
* Round level.
* @var integer
*/
public $resolution = RESOLUTION_ENDING_ONE_ZERO;
/**
* Number of decimals.
* @var integer
*/
public $decimal = DECIMAL_NUMBER;
/**
* Screen resolution.
* @var integer
*/
public $dpiResolution = DEFAULT_DPI_RESOLUTION;
/**
* Space between graph and abscisse tags.
* default: 5% of the width, limit to 15.
* @var float
*/
public $nicerLookXOffset = NICER_LOOK_X_OFFSET;
/**
* Space between graph and ordinate tags.
* default: 5% of the width, limit to 15.
* @var float
*/
public $nicerLookYOffset = NICER_LOOK_Y_OFFSET;
/**
* Number of pixel between each line of the abscisse grid.
* @var integer
*/
public $gridLineXDelta = GRID_LINES_X_DELTA;
/**
* Number of pixel between each line of the ordinate grid.
* @var integer
*/
public $gridLineYDelta = GRID_LINES_Y_DELTA;
/**
* Padding of the first point from the abscisse.
* @var float
*/
public $plotOffsetX = PLOT_OFFSET_X;
/**
* Padding of the first point from the ordinate.
* @var float
*/
public $plotOffsetY = PLOT_OFFSET_Y;
/**
* Min value to calculate the scale.
*
* This value is not calculated, you must fixe
* it if the min value is not the "real" min value passed in the curve data.
*
* @var integer
*/
public $min = 0;
/**
* Max value to calculate the scale.
*
* This value is not calculated, you must fixe it if the max value is not
* the "real" max value passed in the curve data.
*
* @var integer
*/
public $max = 0;
/**
* Coefficient pixel/data to the ordinate axe.
* @var float
*/
public $factorY = 0;
/**
* Label X value.
* @var string
*/
public $labelX = DEFAULT_LABEL_X;
/**
* Y label value.
* @var string
*/
public $labelY = DEFAULT_LABEL_Y;
/**
* Graph title.
* @var string
*/
public $title = DEFAULT_TITLE;
/**
* minorStepYDelta
*
* @var mixed
* @access public
*/
public $minorStepYDelta = MINOR_STEP_Y_DELTA;
/**
* Rotation angle (degree) for the abscisse tags
* @var integer
*/
public $tagXRotation = -30;
/**
* Number of lines to the abscisses grid
* @var int
*/
public $gridLineX = 0;
/**
* Frequency of the abscisses tags
*/
public $tagXGapFrequency = 1;
/**
* Y label rotation
* @var int
*/
public $labelYRotation = -90;
/**
* Y minor step
* @var integer
*/
public $minorStepY = 8;
/**
* Rotation of the Y tags
* @var integer
*/
public $tagYRotation = 0;
/**
* Number of line to the grid of the Y axe
* @var int
*/
public $gridLineY = GRID_LINES_Y;
/**
* display
*
* You can't access directly this variable using
* <code>$object->display['box'] = false;</code>
* see SvgGrapher::setDisplay() for more details.
*
* @var array
* @access protected
*/
protected $display = array(
'box' => true,
'tagsX' => true,
'tagsY' => true,
'stepX' => true,
'stepY' => true,
'minorStepY' => true,
'legend' => true,
'labelX' => true,
'labelY' => true,
'title' => true,
'gridX' => true,
'gridY' => true,
'limits' => true,
'w3link' => true);
/**
* limitsLines
*
* @var array
* @access public
*/
public $limitsLines = array(
'low' => array('value' => 0, 'color'=>'#FF0000'),
'median' => array('value' => 0, 'color'=>'#00FF00'),
'high' => array('value' => 0, 'color'=>'#FF0000'),
);
/**
* Limits of the data. (calculed with the internal findrange plugin)
* @var array
*/
public $range = array('min' => 0, 'max' => 0, 'delta' => 0);
/**
* _needUpdate
*
* true if boxes position and scale need to be recalulated
*
* @var bool
* @access private
*/
private $_needUpdate = true;
/**
* boxesPositions
*
* Boxes positions array, acceptables values are:
* - title : top or bottom
* - legend : left or right
*
* @var array
* @access public
*/
public $boxesPositions = array(
'title' => 'top',
'legend' => 'right');
/**
* rendererCallBacks
*
* Call back functions used in SvgDocumentRenderer to do operations on tags.
*
* @var array
* @access public
*/
public $rendererCallBacks = array(
'tagsX' => NULL,
'tagsY' => NULL);
// }}}
// SvgGrapher::__construct() {{{
/**
* Constructor.
*
* @param float $width width width
* @param float $height document height
* @param bool $setEHOn true to set exception handler on
* @return void
*/
public function __construct($width=400, $height=300, $setEHOn=false)
{
if(!self::$instance) {
self::$instance = $this;
}
if($setEHOn) {
set_exception_handler(array('SvgGrapher', 'exceptionHandler'));
}
$this->_importCoreFunctions();
// init boxes
$this->boxDoc = new Box(array('width'=>$width, 'height'=>$height));
$this->boxGraphPane = new Box();
$this->boxTitle = new Box();
$this->boxLegend = new Box();
$this->boxLabelX = new Box();
$this->boxLabelY = new Box();
$this->boxTagsX = new Box();
$this->boxTagsY = new Box();
// init svgElements
$this->svgDom = new XMLDocument('1.0', 'iso-8859-1');
$this->svgDom->createDocumentType(
'svg', '-//W3C//DTD SVG 1.1//EN',
'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd');
$this->svgDocument = $this->svgDom->createRootelement('svg');
$this->svgDocument->setAttribute('xmlns', 'http://www.w3.org/2000/svg');
$this->svgDocument->setAttribute('xmlns:xlink', 'http://www.w3.org/1999/xlink');
$this->svgDocument->setAttribute('version', '1.1');
$this->svgDocument->setAttribute('width', $this->boxDoc->width);
$this->svgDocument->setAttribute('height', $this->boxDoc->height);
$this->svgGraphPane = new GElement(array('id'=>'graphPane'));
$this->svgTitles = new GElement();
$this->svgLegend = new GElement(array('id'=>'legend'));
$this->svgDefs = new DefsElement();
$this->svgEcma = array();
$this->svgToolTips = new GElement();
}
// }}}
// SvgGrapher::singleton() {{{
/**
* Get the current instance (singleton) of the class, or make a new
* instance.
*
* @param float $width document width (only for new instance)
* @param float $height document height (only for new instance)
* @return SvgGrapher
*/
static function singleton($width=0, $height=0)
{
if(!self::$instance) {
self::$instance = new SvgGrapher($width, $height);
}
return self::$instance;
}
// }}}
// svgGrapher::exceptionHandler() {{{
/**
* Exception handler.
*
* @param object $exception objet Exception
* @return void
*/
static function exceptionHandler($exception)
{
echo 'SvgGrapher error : ' . $exception->getMessage();
exit($exception->getCode());
}
// }}}
// SvgGrapher::__set() {{{
/**
* __set
*
* @param mixed $property
* @param mixed $value
* @access public
* @return void
*/
public function __set($property, $value)
{
$method = 'set' . $property;
if(method_exists($this, $method)) {
return $this->$method($value);
}
return $this->$property = $value;
}
// }}}
// SvgGrapher::__get() {{{
/**
* __get
*
* @param mixed $property
* @access public
* @return void
*/
public function __get($property)
{
$method = 'get' . $property;
if(method_exists($this, $method)) {
return $this->$method();
}
return $this->$property;
}
// }}}
// SvgGrapher::_importCoreFunctions() {{{
/**
* Import the core functions founded in internal directory.
*
* @return boolean
*/
private function _importCoreFunctions()
{
$corePath = SVGGRAPHER_CLASS_PATH . '/internal/';
$coreName = 'svgGrapher.internal.';
$coreDir = dir($corePath);
while(false !== ($f = $coreDir->read()) ) {
if(stristr($f, $coreName)) {
include_once $corePath . $f;
}
}
$coreDir->close();
return true;
}
// }}}
// SvgGrapher::_calculateBoxProperties() {{{
/**
* _calculateBoxProperties
*
* boxes positions:
* - title on the document's top
* - legend on the document's right and on the title's bottom
* - graph pane under the title on the legend's left
* - X tags on the left of the graph pane
* - Y tags on the bottom of the graph pane
* - X label on the left of the X tags
* - Y label on the bottom of the X tags
*
* @access public
* @return void
*/
private function _calculateBoxProperties()
{
if(!$this->_needUpdate) {
return true;
}
// calculate the nicer look offsets
if($this->nicerLookXOffset <= 0) {
$offsetX = $this->boxDoc->width * 5 / 100;
$this->nicerLookXOffset = ($offsetX < 15) ? $offsetX : 15;
}
if($this->nicerLookYOffset <= 0) {
$offsetY = $this->boxDoc->height * 5 / 100;
$this->nicerLookYOffset = ($offsetY < 15) ? $offsetY : 15;
}
// Calculate the data scale to display in the Y axe.
$values = array();
if(!empty($this->curves)) {
foreach($this->curves as $curve) {
$values = array_merge($values, $curve->values);
}
$this->range = svgGrapher_internal_findRange($values, $this->min, $this->max, $this->resolution);
if ($this->range['delta'] == 0) {
throw new Exception('No range to plot. Check data');
exit(-1);
}
// Number of lines on the X axe
$this->gridLineX = sizeof($this->tagsX);
// Build the Y axe tags
$deltaTagsY = $this->range['delta'] / ($this->gridLineY - 1 + (2 * $this->plotOffsetY));
for ($i = 0; $i < $this->gridLineY; $i++) {
$text = $this->range['min'] + $deltaTagsY * ($i + $this->plotOffsetY);
$this->tagsY[$i] = number_format($text, $this->decimal, DECIMAL_SEPARATOR, THOUSANDS_SEPERATOR);
}
$this->tagsY = array_reverse($this->tagsY);
}
// graph pane box
$this->boxGraphPane->width = $this->boxDoc->width - ($this->nicerLookXOffset << 1);
$this->boxGraphPane->height = $this->boxDoc->height - ($this->nicerLookYOffset << 1);
$this->boxGraphPane->x = $this->nicerLookXOffset;
$this->boxGraphPane->y = $this->nicerLookYOffset;
// calculate the properties of the title box
if($this->display['title']) {
$h = svgGrapher_internal_fontSizeEquiv(TITLE_STYLE) + $this->nicerLookYOffset;
$this->boxTitle->height = $h;
$this->boxTitle->width = $this->boxDoc->width;
$this->boxTitle->padding = array(
'left' => $this->boxTitle->width >> 1,
'top' => 3 * $this->boxTitle->height >> 2);
if($this->boxesPositions['title'] == 'top') {
$this->boxTitle->x = 0;
$this->boxTitle->y = 0;
// update graph pane box
$this->boxGraphPane->y += $h;
} elseif($this->boxesPositions['title'] == 'bottom') {
$this->boxTitle->x = 0;
$this->boxTitle->y = $this->boxDoc->height - $h;
}
// update graph pane box
$this->boxGraphPane->height -= $h;
}
// Calculate the properties of the legend box
if($this->display['legend']) {
$legends = array();
foreach($this->curves as $curve) {
if(is_array($curve->legend)) {
$legends = array_merge($legends, $curve->legend);
} else {
$legends[] = $curve->legend;
}
}
$longestLegendStr = svgGrapher_internal_longestTag($legends);
$box = svgGrapher_internal_getComputedTextLength($longestLegendStr, LEGEND_TEXT_STYLE);
$this->legendTextHeight = $box['height'];
$w = $box['width'] + ($this->nicerLookYOffset << 2);
$this->boxLegend->width = $w;
$this->boxLegend->height = $this->boxGraphPane->height;
$this->boxLegend->y = $this->boxGraphPane->y;
if($this->boxesPositions['legend'] == 'right') {
$this->boxLegend->x = $this->boxDoc->width - $w;
} elseif($this->boxesPositions['legend'] == 'left') {
$this->boxLegend->x = $this->boxGraphPane->x;
// update graph pane box
$this->boxGraphPane->x += $w;
}
// update graph pane box
$this->boxGraphPane->width -= $w;
}
// calculate the properties of the label y box
if($this->display['labelY']) {
$w = svgGrapher_internal_fontSizeEquiv(LABEL_Y_STYLE) + $this->nicerLookXOffset;
$this->boxLabelY->width = $w;
$this->boxLabelY->height = $this->boxGraphPane->height;
$this->boxLabelY->x = $this->boxGraphPane->x + $w - $this->nicerLookXOffset;
$this->boxLabelY->y = $this->boxLabelY->height >> 1;
// update graph pane box
$this->boxGraphPane->width -= $w;
$this->boxGraphPane->x += $w;
}
// calculate the properties of the tag y box
if($this->display['tagsY']) {
$rotation = sprintf('rotate(%s)', $this->tagYRotation);
$longestStr = svgGrapher_internal_longestTag($this->tagsY);
$box = svgGrapher_internal_getComputedTextLength(
$longestStr, TAGS_Y_STYLE, $rotation);
$this->boxTagsY->width = $box['width'];
$this->boxTagsY->height = $box['height'];
$this->boxTagsY->x = $this->boxGraphPane->x;
// update graph pane box
$w = $box['width'] + $this->nicerLookXOffset;
$this->boxGraphPane->width -= $w;
$this->boxGraphPane->x += $w;
}
// calculate the properties of the label x box
if($this->display['labelX']) {
$this->boxLabelX->width = $this->boxGraphPane->width;
$h = svgGrapher_internal_fontSizeEquiv(LABEL_X_STYLE);
$this->boxLabelX->height = $h;
$this->boxLabelX->x = $this->boxDoc->width >> 1;
$this->boxLabelX->y = $this->boxGraphPane->y + $this->boxGraphPane->height;
// update graph pane box
$this->boxGraphPane->height -= $h;
$this->boxLegend->height -= $h;
}
// calculate the properties of the tags x box
if($this->display['tagsX']) {
$rotation = sprintf('rotate(%s)', $this->tagXRotation);
$longestStr = svgGrapher_internal_longestTag($this->tagsX);
$box = svgGrapher_internal_getComputedTextLength(
$longestStr, TAGS_X_STYLE, $rotation);
$h = $box['height'] + $this->nicerLookYOffset;
$this->boxTagsX->width = $box['width'];
$this->boxTagsX->height = $h;
$this->boxTagsX->y = $this->boxGraphPane->y + $this->boxGraphPane->height - $box['height'];
// update graph pane box
$this->boxGraphPane->height -= $h;
$this->boxLegend->height -= $h;
}
if(!empty($values)) {
// Calculate the lines offset of the grid
if($this->gridLineXDelta <= 0) {
$this->gridLineXDelta = $this->boxGraphPane->width /
($this->gridLineX - 1 + (2 * $this->plotOffsetX));
}
if($this->gridLineYDelta <= 0) {
$this->gridLineYDelta = $this->boxGraphPane->height /
($this->gridLineY - 1 + (2 * $this->plotOffsetY));
}
if($this->minorStepYDelta <= 0) {
$this->minorStepYDelta = $this->gridLineYDelta / $this->minorStepY;
}
$this->factorY = $this->boxGraphPane->height / $this->range['delta'];
}
$this->_needUpdate = false;
}
// }}}
// SvgGrapher::addCurve() {{{
/**
* Add a curve to the graph.
*
* @param mixed $name Curve identifier.
* @param array $params params to Curve object
* @param string $color Curve color
* @return boolean
*/
public function addCurve($name, $params=array())
{
$curve = new Curve($params, $name);
$this->curves[$name] = $curve;
if(!sizeof($this->tagsX)) {
$this->tagsX = $params['labels'];
} elseif(isset($params['labels']) && is_array($params['labels'])) {
// On rassemble les deux tableaux de label en un seul et on dedoublonne.
// Essaye de conserver l'ordre naturel des donnees.
$tmpArr = array();
foreach($this->tagsX as $idx => $tag) {
// Le label d'index courant est unique, on prend...
if(isset($params['labels'][$idx]) && !in_array($params['labels'][$idx], $this->tagsX)) {
$tmpArr[] = $params['labels'][$idx];
}
// La tag en cours est unique ou n'a pas deja etait pris...
if(!(in_array($tag, $params['labels']) && in_array($tag, $tmpArr))) {
$tmpArr[] = $tag;
}
}
$this->tagsX = $tmpArr;
}
$this->_needUpdate = true;
}
// }}}
// SvgGrapher::genGraph() {{{
/**
* Build the graph.
*
* @return void
*/
public function genGraph()
{
$this->_calculateBoxProperties();
SvgDocumentRenderer::render();
foreach($this->svgEcma as $js) {
$this->svgDocument->appendChild($js);
}
if(count($this->svgDefs->children)>0) {
$this->svgDocument->appendChild($this->svgDefs);
}
if(count($this->svgTitles->children)>0) {
$this->svgDocument->appendChild($this->svgTitles);
}
if(count($this->svgLegend->children)>0) {
$this->svgDocument->appendChild($this->svgLegend);
}
$this->svgDocument->appendChild($this->svgGraphPane);
if(count($this->svgToolTips->children)>0) {
$this->svgDocument->appendChild($this->svgToolTips);
}
}
// }}}
// SvgGrapher::drawHLine() {{{
/**
* Draw an horizontal line.
*
* @param integer $value ordinate of the line.
* @param string $color line color.
* @return void
*/
public function drawHLine($value, $color = NULL, $id = NULL)
{
$left = 1;
$right = $this->boxGraphPane->width - 2;
if(is_null($color)) {
$color = svgGrapher_internal_randomColor();
}
$style = LIMITS_LINES_STYLE . ' stroke:' . $color . ';';
$y = $this->boxGraphPane->height - ($this->factorY * ($value - $this->range['min']));
$line = new LineElement(array(
'id' => $id,
'x1' => $left, 'y1' => $y,
'x2' => $right, 'y2' => $y,
'style'=>$style));
$this->svgGraphPane->appendChild($line);
}
// }}}
// SvgGrapher::drawVLine() {{{
/**
* Draw a vertical line (run checkChange before draw line).
*
* @param integer $value Tag name where draw the line.
* @param string $color line color.
* @return void
*/
public function drawVLine($value, $color = NULL, $id = NULL)
{
$x = 0;
$xOffset = $value;
$top = 0;
$bottom = $this->boxGraphPane->height - 1;
if(!empty($value)) {
if(is_null($color)) {
$color = svgGrapher_internal_randomColor();
}
$style = LIMITS_LINES_STYLE . ' stroke:' . $color . ';';
foreach($this->tagsX as $idx => $tag) {
if($value == $tag) {
$xOffset = $idx;
break;
}
}
$x = $this->gridLineXDelta * ($xOffset + $this->plotOffsetX);
$line = new LineElement(array('id' => $id,
'x1' => $x, 'y1' => $top,
'x2' => $x, 'y2' => $bottom), $style);
$this->svgGraphPane->appendChild($line);
}
}
// }}}
// SvgGrapher::dumpSVG() {{{
/**
* Write the svg in plain-text (to debug)
*
* @param string href to a CSS file.
* @return void
*/
public function dumpSVG($specifyCSS=NULL, $prettyXML=false)
{
header("Pragma: public");
header("Expires: 0");
header("Cache-Control: private");
header("Content-type: text/plain");
print($this->svgDocument->writeSVGString($specifyCSS, $prettyXML));
}
// }}}
// SvgGrapher::drawSVG() {{{
/**
* Draw the svg or save it in file.
*
* @param string $filename file name to save svg in file.
* @param string href to a CSS file.
* @param boolean $prettyXML true to render pretty xml (unused if filename
* is specified).
* @return void
*/
public function drawSVG($filename=NULL, $specifyCSS=NULL, $prettyXML=false)
{
if(empty($filename)) {
header("Pragma: public");
header("Expires: 0");
header("Cache-Control: private");
header("Content-type: image/svg+xml");
//print($this->svgDocument->WriteSVGString($specifyCSS, $prettyXML));
print($this->svgDom->asPrettyXML());
} else {
$this->svgDocument->WriteSVGFile($filename, $specifyCSS, $prettyXML);
}
}
// }}}
// SvgGrapher::setDisplay() {{{
/**
* setDisplay
*
* set the display property
*
* $value can be:
* - boolean: all the elements of the $display array take the value
* - array of string: the elements listed in the array take the value true
* - array of keys / values: for each element of the array, the elements of
* the $display array with the key take the value
* - string: the elements of the $display$ array take the value true
*
* examples:
* <code>
* $o = new SvgGrapher();
*
* $o->display = false;
* // all the elements in $display take the value false
*
* $o->display = legend;
* // $o->display['legend'] = true
*
* $o->display = array('stepX', 'stepY');
* // $o->display['stepX'] = true;
* // $o->display['stepY'] = true;
*
* $o->display = array('labelX'=>false, 'labelY'=>true, 'title'=>true);
* // $o->display['labelX'] = false;
* // $o->display['labelY'] = true;
* // $o->display['title'] = true;
* </code>
*
* @param mixed $value
* @access public
* @return void
*/
public function setDisplay($value)
{
if(is_array($value)) {
foreach($value as $k=>$v) {
if(isset($this->display[$k])) {
$this->display[$k] = $v;
} elseif(isset($this->display[$v])) {
$this->display[$v] = true;
}
}
} elseif(is_bool($value)) {
foreach($this->display as $k=>$v) {
$this->display[$k] = $value;
}
} elseif(is_string($value)) {
$this->display[$value] = true;
}
$this->_needUpdate = true;
}
// }}}
}
?>

Documentation generated on Tue, 23 Oct 2007 11:32:14 +0200 by phpDocumentor 1.4.0

Source for file SvgGrapher.php