421 lines
15 KiB
PHP
421 lines
15 KiB
PHP
<?php
|
|
//=======================================================================
|
|
// File: JPGRAPH_LEGEND.INC.PHP
|
|
// Description: Class to handle the legend box in the graph that gives
|
|
// names on the data series. The number of rows and columns
|
|
// in the legend are user specifyable.
|
|
// Created: 2001-01-08 (Refactored to separate file 2008-08-01)
|
|
// Ver: $Id: jpgraph_legend.inc.php 1859 2009-09-28 14:40:48Z ljp $
|
|
//
|
|
// Copyright (c) Aditus Consulting. All rights reserved.
|
|
//========================================================================
|
|
|
|
DEFINE('_DEFAULT_LPM_SIZE',8); // Default Legend Plot Mark size
|
|
|
|
|
|
//===================================================
|
|
// CLASS Legend
|
|
// Description: Responsible for drawing the box containing
|
|
// all the legend text for the graph
|
|
//===================================================
|
|
|
|
class Legend {
|
|
public $txtcol=array();
|
|
private $color=array(0,0,0); // Default fram color
|
|
private $fill_color=array(235,235,235); // Default fill color
|
|
private $shadow=true; // Shadow around legend "box"
|
|
private $shadow_color='darkgray@0.5';
|
|
private $mark_abs_hsize=_DEFAULT_LPM_SIZE,$mark_abs_vsize=_DEFAULT_LPM_SIZE;
|
|
private $xmargin=10,$ymargin=6,$shadow_width=2;
|
|
private $xlmargin=4, $ylmargin='';
|
|
private $xpos=0.05, $ypos=0.15, $xabspos=-1, $yabspos=-1;
|
|
private $halign="right", $valign="top";
|
|
public $font_family=FF_FONT1,$font_style=FS_NORMAL,$font_size=12;
|
|
private $font_color='black';
|
|
private $hide=false,$layout_n=1;
|
|
private $weight=1,$frameweight=1;
|
|
private $csimareas='';
|
|
private $reverse = false ;
|
|
|
|
//---------------
|
|
// CONSTRUCTOR
|
|
function __construct() {
|
|
// Empty
|
|
}
|
|
//---------------
|
|
// PUBLIC METHODS
|
|
function Hide($aHide=true) {
|
|
$this->hide=$aHide;
|
|
}
|
|
|
|
function SetHColMargin($aXMarg) {
|
|
$this->xmargin = $aXMarg;
|
|
}
|
|
|
|
function SetVColMargin($aSpacing) {
|
|
$this->ymargin = $aSpacing ;
|
|
}
|
|
|
|
function SetLeftMargin($aXMarg) {
|
|
$this->xlmargin = $aXMarg;
|
|
}
|
|
|
|
// Synonym
|
|
function SetLineSpacing($aSpacing) {
|
|
$this->ymargin = $aSpacing ;
|
|
}
|
|
|
|
function SetShadow($aShow='gray',$aWidth=2) {
|
|
if( is_string($aShow) ) {
|
|
$this->shadow_color = $aShow;
|
|
$this->shadow=true;
|
|
}
|
|
else
|
|
$this->shadow=$aShow;
|
|
$this->shadow_width=$aWidth;
|
|
}
|
|
|
|
function SetMarkAbsSize($aSize) {
|
|
$this->mark_abs_vsize = $aSize ;
|
|
$this->mark_abs_hsize = $aSize ;
|
|
}
|
|
|
|
function SetMarkAbsVSize($aSize) {
|
|
$this->mark_abs_vsize = $aSize ;
|
|
}
|
|
|
|
function SetMarkAbsHSize($aSize) {
|
|
$this->mark_abs_hsize = $aSize ;
|
|
}
|
|
|
|
function SetLineWeight($aWeight) {
|
|
$this->weight = $aWeight;
|
|
}
|
|
|
|
function SetFrameWeight($aWeight) {
|
|
$this->frameweight = $aWeight;
|
|
}
|
|
|
|
function SetLayout($aDirection=LEGEND_VERT) {
|
|
$this->layout_n = $aDirection==LEGEND_VERT ? 1 : 99 ;
|
|
}
|
|
|
|
function SetColumns($aCols) {
|
|
$this->layout_n = $aCols ;
|
|
}
|
|
|
|
function SetReverse($f=true) {
|
|
$this->reverse = $f ;
|
|
}
|
|
|
|
// Set color on frame around box
|
|
function SetColor($aFontColor,$aColor='black') {
|
|
$this->font_color=$aFontColor;
|
|
$this->color=$aColor;
|
|
}
|
|
|
|
function SetFont($aFamily,$aStyle=FS_NORMAL,$aSize=10) {
|
|
$this->font_family = $aFamily;
|
|
$this->font_style = $aStyle;
|
|
$this->font_size = $aSize;
|
|
}
|
|
|
|
function SetPos($aX,$aY,$aHAlign='right',$aVAlign='top') {
|
|
$this->Pos($aX,$aY,$aHAlign,$aVAlign);
|
|
}
|
|
|
|
function SetAbsPos($aX,$aY,$aHAlign='right',$aVAlign='top') {
|
|
$this->xabspos=$aX;
|
|
$this->yabspos=$aY;
|
|
$this->halign=$aHAlign;
|
|
$this->valign=$aVAlign;
|
|
}
|
|
|
|
|
|
function Pos($aX,$aY,$aHAlign='right',$aVAlign='top') {
|
|
if( !($aX<1 && $aY<1) )
|
|
JpGraphError::RaiseL(25120);//(" Position for legend must be given as percentage in range 0-1");
|
|
$this->xpos=$aX;
|
|
$this->ypos=$aY;
|
|
$this->halign=$aHAlign;
|
|
$this->valign=$aVAlign;
|
|
}
|
|
|
|
function SetFillColor($aColor) {
|
|
$this->fill_color=$aColor;
|
|
}
|
|
|
|
function Clear() {
|
|
$this->txtcol = array();
|
|
}
|
|
|
|
function Add($aTxt,$aColor,$aPlotmark='',$aLinestyle=0,$csimtarget='',$csimalt='',$csimwintarget='') {
|
|
$this->txtcol[]=array($aTxt,$aColor,$aPlotmark,$aLinestyle,$csimtarget,$csimalt,$csimwintarget);
|
|
}
|
|
|
|
function GetCSIMAreas() {
|
|
return $this->csimareas;
|
|
}
|
|
|
|
function Stroke(&$aImg) {
|
|
// Constant
|
|
$fillBoxFrameWeight=1;
|
|
|
|
if( $this->hide ) return;
|
|
|
|
$aImg->SetFont($this->font_family,$this->font_style,$this->font_size);
|
|
|
|
if( $this->reverse ) {
|
|
$this->txtcol = array_reverse($this->txtcol);
|
|
}
|
|
|
|
$n=count($this->txtcol);
|
|
if( $n == 0 ) return;
|
|
|
|
// Find out the max width and height of each column to be able
|
|
// to size the legend box.
|
|
$numcolumns = ($n > $this->layout_n ? $this->layout_n : $n);
|
|
for( $i=0; $i < $numcolumns; ++$i ) {
|
|
$colwidth[$i] = $aImg->GetTextWidth($this->txtcol[$i][0]) +
|
|
2*$this->xmargin + 2*$this->mark_abs_hsize;
|
|
$colheight[$i] = 0;
|
|
|
|
}
|
|
|
|
// Find our maximum height in each row
|
|
$rows = 0 ; $rowheight[0] = 0;
|
|
for( $i=0; $i < $n; ++$i ) {
|
|
$h = max($this->mark_abs_vsize,$aImg->GetTextHeight($this->txtcol[$i][0]))+$this->ymargin;
|
|
// Makes sure we always have a minimum of 1/4 (1/2 on each side) of the mark as space
|
|
// between two vertical legend entries
|
|
$h = round(max($h,$this->mark_abs_vsize+$this->mark_abs_vsize/2));
|
|
//echo "Textheight:".$aImg->GetTextHeight($this->txtcol[$i][0]).', ';
|
|
//echo "h=$h ({$this->mark_abs_vsize},{$this->ymargin})<br>";
|
|
if( $i % $numcolumns == 0 ) {
|
|
$rows++;
|
|
$rowheight[$rows-1] = 0;
|
|
}
|
|
$rowheight[$rows-1] = max($rowheight[$rows-1],$h);
|
|
}
|
|
|
|
$abs_height = 0;
|
|
for( $i=0; $i < $rows; ++$i ) {
|
|
$abs_height += $rowheight[$i] ;
|
|
}
|
|
|
|
// Make sure that the height is at least as high as mark size + ymargin
|
|
// We add 1.5 y-margin to add some space at the top+bottom part of the
|
|
// legend.
|
|
$abs_height = max($abs_height,$this->mark_abs_vsize);
|
|
$abs_height += 3*$this->ymargin;
|
|
|
|
// Find out the maximum width in each column
|
|
for( $i=$numcolumns; $i < $n; ++$i ) {
|
|
$colwidth[$i % $numcolumns] = max(
|
|
$aImg->GetTextWidth($this->txtcol[$i][0])+2*$this->xmargin+2*$this->mark_abs_hsize,
|
|
$colwidth[$i % $numcolumns]);
|
|
}
|
|
|
|
|
|
// Get the total width
|
|
$mtw = 0;
|
|
for( $i=0; $i < $numcolumns; ++$i ) {
|
|
$mtw += $colwidth[$i] ;
|
|
}
|
|
|
|
// Find out maximum width we need for legend box
|
|
$abs_width = $mtw+$this->xlmargin;
|
|
|
|
if( $this->xabspos === -1 && $this->yabspos === -1 ) {
|
|
$this->xabspos = $this->xpos*$aImg->width ;
|
|
$this->yabspos = $this->ypos*$aImg->height ;
|
|
}
|
|
|
|
// Positioning of the legend box
|
|
if( $this->halign == 'left' ) {
|
|
$xp = $this->xabspos;
|
|
}
|
|
elseif( $this->halign == 'center' ) {
|
|
$xp = $this->xabspos - $abs_width/2;
|
|
}
|
|
else {
|
|
$xp = $aImg->width - $this->xabspos - $abs_width;
|
|
}
|
|
|
|
$yp=$this->yabspos;
|
|
if( $this->valign == 'center' ) {
|
|
$yp-=$abs_height/2;
|
|
}
|
|
elseif( $this->valign == 'bottom' ) {
|
|
$yp-=$abs_height;
|
|
}
|
|
|
|
// Stroke legend box
|
|
$aImg->SetColor($this->color);
|
|
$aImg->SetLineWeight($this->frameweight);
|
|
$aImg->SetLineStyle('solid');
|
|
|
|
if( $this->shadow ) {
|
|
$aImg->ShadowRectangle($xp,$yp,$xp+$abs_width+$this->shadow_width,
|
|
$yp+$abs_height+$this->shadow_width,
|
|
$this->fill_color,$this->shadow_width,$this->shadow_color);
|
|
}
|
|
else {
|
|
$aImg->SetColor($this->fill_color);
|
|
$aImg->FilledRectangle($xp,$yp,$xp+$abs_width,$yp+$abs_height);
|
|
$aImg->SetColor($this->color);
|
|
$aImg->Rectangle($xp,$yp,$xp+$abs_width,$yp+$abs_height);
|
|
}
|
|
|
|
// x1,y1 is the position for the legend mark
|
|
$x1=$xp+round($this->mark_abs_hsize/2)+$this->xlmargin;
|
|
$y1=$yp + $this->ymargin;
|
|
|
|
// Remember 1/2 of the font height since we need that later
|
|
// as a minimum value for correctly position the markers
|
|
$f2 = round($aImg->GetTextHeight('X')/2);
|
|
|
|
$grad = new Gradient($aImg);
|
|
$patternFactory = null;
|
|
|
|
// Now stroke each legend in turn
|
|
// Each plot has added the following information to the legend
|
|
// p[0] = Legend text
|
|
// p[1] = Color,
|
|
// p[2] = For markers a reference to the PlotMark object
|
|
// p[3] = For lines the line style, for gradient the negative gradient style
|
|
// p[4] = CSIM target
|
|
// p[5] = CSIM Alt text
|
|
$i = 1 ; $row = 0;
|
|
foreach($this->txtcol as $p) {
|
|
|
|
// STROKE DEBUG BOX
|
|
if( _JPG_DEBUG ) {
|
|
$aImg->SetLineWeight(1);
|
|
$aImg->SetColor('red');
|
|
$aImg->SetLineStyle('solid');
|
|
$aImg->Rectangle($xp,$y1,$xp+$abs_width,$y1+$rowheight[$row]);
|
|
}
|
|
|
|
$aImg->SetLineWeight($this->weight);
|
|
$x1 = round($x1); $y1=round($y1);
|
|
if ( !empty($p[2]) && $p[2]->GetType() > -1 ) {
|
|
// Make a plot mark legend
|
|
$aImg->SetColor($p[1]);
|
|
if( is_string($p[3]) || $p[3]>0 ) {
|
|
$aImg->SetLineStyle($p[3]);
|
|
$aImg->StyleLine($x1-$this->mark_abs_hsize,$y1+$f2,$x1+$this->mark_abs_hsize,$y1+$f2);
|
|
}
|
|
// Stroke a mark with the standard size
|
|
// (As long as it is not an image mark )
|
|
if( $p[2]->GetType() != MARK_IMG ) {
|
|
|
|
// Clear any user callbacks since we ont want them called for
|
|
// the legend marks
|
|
$p[2]->iFormatCallback = '';
|
|
$p[2]->iFormatCallback2 = '';
|
|
|
|
// Since size for circles is specified as the radius
|
|
// this means that we must half the size to make the total
|
|
// width behave as the other marks
|
|
if( $p[2]->GetType() == MARK_FILLEDCIRCLE || $p[2]->GetType() == MARK_CIRCLE ) {
|
|
$p[2]->SetSize(min($this->mark_abs_vsize,$this->mark_abs_hsize)/2);
|
|
$p[2]->Stroke($aImg,$x1,$y1+$f2);
|
|
}
|
|
else {
|
|
$p[2]->SetSize(min($this->mark_abs_vsize,$this->mark_abs_hsize));
|
|
$p[2]->Stroke($aImg,$x1,$y1+$f2);
|
|
}
|
|
}
|
|
}
|
|
elseif ( !empty($p[2]) && (is_string($p[3]) || $p[3]>0 ) ) {
|
|
// Draw a styled line
|
|
$aImg->SetColor($p[1]);
|
|
$aImg->SetLineStyle($p[3]);
|
|
$aImg->StyleLine($x1-1,$y1+$f2,$x1+$this->mark_abs_hsize,$y1+$f2);
|
|
$aImg->StyleLine($x1-1,$y1+$f2+1,$x1+$this->mark_abs_hsize,$y1+$f2+1);
|
|
}
|
|
else {
|
|
// Draw a colored box
|
|
$color = $p[1] ;
|
|
|
|
// We make boxes slightly larger to better show
|
|
$boxsize = max($this->mark_abs_vsize,$this->mark_abs_hsize) + 2 ;
|
|
|
|
// $y1 is the top border of the "box" we have to draw the marker
|
|
// and legend text in. We position the marker in the vertical center
|
|
// of this box
|
|
$ym = $y1 + round($rowheight[$row]/2)-round($this->mark_abs_vsize/2);
|
|
|
|
// We either need to plot a gradient or a
|
|
// pattern. To differentiate we use a kludge.
|
|
// Patterns have a p[3] value of < -100
|
|
if( $p[3] < -100 ) {
|
|
// p[1][0] == iPattern, p[1][1] == iPatternColor, p[1][2] == iPatternDensity
|
|
if( $patternFactory == null ) {
|
|
$patternFactory = new RectPatternFactory();
|
|
}
|
|
$prect = $patternFactory->Create($p[1][0],$p[1][1],1);
|
|
$prect->SetBackground($p[1][3]);
|
|
$prect->SetDensity($p[1][2]+1);
|
|
$prect->SetPos(new Rectangle($x1,$ym,$boxsize,$boxsize));
|
|
$prect->Stroke($aImg);
|
|
$prect=null;
|
|
}
|
|
else {
|
|
if( is_array($color) && count($color)==2 ) {
|
|
// The client want a gradient color
|
|
$grad->FilledRectangle($x1,$ym,
|
|
$x1+$boxsize,$ym+$boxsize,
|
|
$color[0],$color[1],-$p[3]);
|
|
}
|
|
else {
|
|
$aImg->SetColor($p[1]);
|
|
$aImg->FilledRectangle($x1,$ym,$x1+$boxsize,$ym+$boxsize);
|
|
}
|
|
$aImg->SetColor($this->color);
|
|
$aImg->SetLineWeight($fillBoxFrameWeight);
|
|
$aImg->Rectangle($x1,$ym,$x1+$boxsize,$ym+$boxsize);
|
|
}
|
|
}
|
|
$aImg->SetColor($this->font_color);
|
|
$aImg->SetFont($this->font_family,$this->font_style,$this->font_size);
|
|
$aImg->SetTextAlign('left','center');
|
|
$aImg->StrokeText(round($x1+$this->mark_abs_hsize+$this->xmargin),
|
|
$y1+round($rowheight[$row]/2),$p[0]);
|
|
|
|
// Add CSIM for Legend if defined
|
|
if( !empty($p[4]) ) {
|
|
|
|
$xe = $x1 + $this->xmargin+$this->mark_abs_hsize+$aImg->GetTextWidth($p[0]);
|
|
$ye = $y1 + max($this->mark_abs_vsize,$aImg->GetTextHeight($p[0]));
|
|
$coords = "$x1,$y1,$xe,$y1,$xe,$ye,$x1,$ye";
|
|
if( ! empty($p[4]) ) {
|
|
$this->csimareas .= "<area shape=\"poly\" coords=\"$coords\" href=\"".htmlentities($p[4])."\"";
|
|
|
|
if( !empty($p[6]) ) {
|
|
$this->csimareas .= " target=\"".$p[6]."\"";
|
|
}
|
|
|
|
if( !empty($p[5]) ) {
|
|
$tmp=sprintf($p[5],$p[0]);
|
|
$this->csimareas .= " title=\"$tmp\" alt=\"$tmp\" ";
|
|
}
|
|
$this->csimareas .= " />\n";
|
|
}
|
|
}
|
|
if( $i >= $this->layout_n ) {
|
|
$x1 = $xp+round($this->mark_abs_hsize/2)+$this->xlmargin;
|
|
$y1 += $rowheight[$row++];
|
|
$i = 1;
|
|
}
|
|
else {
|
|
$x1 += $colwidth[($i-1) % $numcolumns] ;
|
|
++$i;
|
|
}
|
|
}
|
|
}
|
|
} // Class
|
|
|
|
?>
|