[ class tree: phpchartPlus ] [ index: phpchartPlus ] [ all elements ]

Class: Polygon

Source Location: /Polygon.php

Class Overview

Shape
   |
   --Polygon

Wrapper around gd's Image(Filled)Polygon functions


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 24]
Wrapper around gd's Image(Filled)Polygon functions

Class used to draw polygons in the chart image Utilized by AreaChart




Tags:

license:  GNU Public License
author:  Tsiavos Chris <jaames@freemail.gr>


[ Top ]


Class Variables

$Caption = array()

[line 45]

Array holding the caption of each of the polygon's vertices



Tags:

access:  private

Type:   private


[ Top ]

$CaptionColor =

[line 52]

the font color used to draw the caption of the polygon's vertices



Tags:

access:  private

Type:   private


[ Top ]

$Font =

[line 38]

reference to the font instance used by Polygon::draw_Caption()



Tags:

access:  private

Type:   Font


[ Top ]

$Vertices = array()

[line 31]

the polygon's vertices



Tags:

access:  private

Type:   integer


[ Top ]



Class Methods


constructor __construct [line 62]

Polygon __construct( mixed &$Canvas, ColorAllocator &$ColorAllocator, string $UseAntialias)

Constructor



Overrides Shape::__construct() (parent method not documented)

Parameters:

mixed   &$Canvas   Reference to the image handler the font will be used in
ColorAllocator   &$ColorAllocator   Reference to the ColorAllocator the class will use for allocating the font color
string   $UseAntialias   ("Yes","No") Specifies if antialias functions should be used or not when drawing the polygon

[ Top ]

method add_Vertex [line 71]

void add_Vertex( mixed $Vertex)

Adds a vertex to the polygon



Tags:

access:  public


[ Top ]

method draw [line 139]

void draw( string $BorderColor, integer $Alpha)

Draws the border of the polygon



Tags:

access:  public


Parameters:

string   $BorderColor  
integer   $Alpha   0-127 $Alpha

[ Top ]

method draw_Caption [line 110]

void draw_Caption( )

Draws the caption for each vertex of the polygon



Tags:

access:  private


[ Top ]

method draw_Filled [line 167]

void draw_Filled( string $StartColor, string $FinishColor, integer $Alpha)

Draws a filled polygon



Tags:

access:  public


Parameters:

string   $StartColor   specifies the starting color of the filled polygon
string   $FinishColor   specifies the finishing color of the filled polygon. If the $StartColor is different from $FinishColor then the polygon will be filled with gradient color
integer   $Alpha   0-127 $Alpha the alpha value of the polygon's color

[ Top ]

method draw_GradientPolygon [line 205]

void draw_GradientPolygon( $ColorHandler $ColorHandler)

Draws a gradient color filled polygon



Tags:

access:  private


Parameters:

$ColorHandler   $ColorHandler  

[ Top ]

method draw_NormalPolygon [line 186]

void draw_NormalPolygon( $ColorHandler $ColorHandler)

Draws a uniform color filled polygon



Tags:

access:  private


Parameters:

$ColorHandler   $ColorHandler  

[ Top ]

method get_Vertices [line 80]

string[] get_Vertices( )

Returns the polygon's vertices



Tags:

access:  public


[ Top ]

method set_CaptionProperties [line 91]

void set_CaptionProperties( Font &$Font, string $CaptionColor)

Specifies the font properties used to draw the captions of the polygon's vertices



Tags:

access:  public


Parameters:

Font   &$Font  
string   $CaptionColor  

[ Top ]

method set_CaptionVertex [line 101]

void set_CaptionVertex( mixed $Caption)

Sets the caption for a vertex



Tags:

access:  public


[ Top ]


Documentation generated on Sun, 3 Oct 2004 14:59:30 +0300 by phpDocumentor 1.3.0RC3