This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
khosb/includes/pear/Image/Graph/Marker.php
2008-11-26 14:50:40 -08:00

123 lines
3.5 KiB
PHP

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Image_Graph - PEAR PHP OO Graph Rendering Utility.
*
* PHP versions 4 and 5
*
* LICENSE: This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or (at your
* option) any later version. This library is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
* General Public License for more details. You should have received a copy of
* the GNU Lesser General Public License along with this library; if not, write
* to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
* 02111-1307 USA
*
* @category Images
* @package Image_Graph
* @subpackage Marker
* @author Jesper Veggerby <pear.nosey@veggerby.dk>
* @copyright Copyright (C) 2003, 2004 Jesper Veggerby Hansen
* @license http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
* @version CVS: $Id: Marker.php,v 1.8 2005/02/21 20:49:47 nosey Exp $
* @link http://pear.php.net/package/Image_Graph
*/
/**
* Include file Image/Graph/Plotarea/Element.php
*/
require_once 'Image/Graph/Plotarea/Element.php';
/**
* Data point marker.
*
* The data point marker is used for marking the datapoints on a graph with some
* visual label, fx. a cross, a text box with the value or an icon.
*
* @category Images
* @package Image_Graph
* @subpackage Marker
* @author Jesper Veggerby <pear.nosey@veggerby.dk>
* @copyright Copyright (C) 2003, 2004 Jesper Veggerby Hansen
* @license http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
* @version Release: @package_version@
* @link http://pear.php.net/package/Image_Graph
* @abstract
*/
class Image_Graph_Marker extends Image_Graph_Plotarea_Element
{
/**
* Secondary marker
* @var Marker
* @access private
*/
var $_secondaryMarker = false;
/**
* The 'size' of the marker, the meaning depends on the specific Marker
* implementation
* @var int
* @access private
*/
var $_size = 6;
/**
* Set the 'size' of the marker
*
* @param int $size The 'size' of the marker, the meaning depends on the
* specific Marker implementation
*/
function setSize($size)
{
$this->_size = $size;
}
/**
* Set the secondary marker
*
* @param Marker $secondaryMarker The secondary marker
*/
function setSecondaryMarker(& $secondaryMarker)
{
$this->_secondaryMarker =& $secondaryMarker;
$this->_secondaryMarker->_setParent($this);
}
/**
* Draw the marker on the canvas
*
* @param int $x The X (horizontal) position (in pixels) of the marker on
* the canvas
* @param int $y The Y (vertical) position (in pixels) of the marker on the
* canvas
* @param array $values The values representing the data the marker 'points'
* to
* @access private
*/
function _drawMarker($x, $y, $values = false)
{
if (is_a($this->_secondaryMarker, 'Image_Graph_Marker')) {
$this->_secondaryMarker->_drawMarker($x, $y, $values);
}
}
/**
* Output to the canvas
*
* @return bool Was the output 'good' (true) or 'bad' (false).
* @access private
*/
function _done()
{
return true;
}
}
?>