Docs For Class Image_Graph

Image_Graph_Driver &Image_Graph_Driver(
array
$param)

Create the driver.

Parameters available:

'width' The width of the graph on the canvas

'height' The height of the graph on the canvas

'left' The left offset of the graph on the canvas

'top' The top offset of the graph on the canvas

Abstract:

Parameters:

array $param — Parameter array

[ Top ]

void done(
[array
$param = false])

Output the result of the driver

Abstract:

Overridden in child classes as:

Image_Graph_Driver_GD_GIF::done(): Output the result of the driver

Image_Graph_Driver_GD_JPG::done(): Output the result of the driver

Image_Graph_Driver_GD_PNG::done(): Output the result of the driver

Image_Graph_Driver_GD_WBMP::done(): Output the result of the driver

Image_Graph_Driver_SWF::done(): Output the result of the driver

Image_Graph_Driver_SVG::done(): Output the result of the driver

Image_Graph_Driver_PDFlib::done(): Output the result of the driver

Parameters:

array $param — Parameter array

[ Top ]

void ellipse(
int
$x, int
$y, int
$rx, int
$ry, [mixed
$fillColor = false], [mixed
$lineColor = false])

Draw an ellipse

Overridden in child classes as:

Image_Graph_Driver_GD::ellipse(): Draw an ellipse

Image_Graph_Driver_SWF::ellipse(): Draw an ellipse

Image_Graph_Driver_SVG::ellipse(): Draw an ellipse

Image_Graph_Driver_PDFlib::ellipse(): Draw an ellipse

Parameters:

int	`$x`	—	Center point x-value
int	`$y`	—	Center point y-value
int	`$rx`	—	X-radius of ellipse
int	`$ry`	—	Y-radius of ellipse
mixed	`$fillColor`	—	The fill color, can be omitted
mixed	`$lineColor`	—	The line color, can be omitted

[ Top ]

Image_Graph_Driver &factory(
string
$driver, array
$param)

Driver factory method.

Supported drivers are:

'png': output in PNG format (using GD)

'jpg': output in JPEG format (using GD)

'svg': Scalable Vector Graphics

'xmlsvg': Scalable Vector Graphics, requires PEAR::XML_SVG (not implemented)

'pdf': PDF Output, requires PEAR::File_PDF (not implemented)

'pdflib': PDF Output, requires PDFlib (not implemented)

'swf': SWF Output, requires MING (not implemented)

'libswf': SWF Output, requires libswf (not implemented)

Return: The newly created driver

Parameters:

string	`$driver`	—	The driver
array	`$param`	—	The parameters for the driver constructor

[ Top ]

int getHeight(
)

Get the height of the canvas

Return: The height

[ Top ]

int getWidth(
)

Get the width of the canvas

Return: The width

[ Top ]

void line(
int
$x0, int
$y0, int
$x1, int
$y1, [mixed
$color = false])

Draw a line

Overridden in child classes as:

Image_Graph_Driver_GD::line(): Draw a line

Image_Graph_Driver_SWF::line(): Draw a line

Image_Graph_Driver_SVG::line(): Draw a line

Image_Graph_Driver_PDFlib::line(): Draw a line

Parameters:

int	`$x0`	—	X start point
int	`$y0`	—	X start point
int	`$x1`	—	X end point
int	`$y1`	—	Y end point
mixed	`$color`	—	The line color, can be omitted

[ Top ]

void overlayImage(
int
$x, int
$y, string
$filename, [int
$width = false], [int
$height = false])

Overlay image

Overridden in child classes as:

Image_Graph_Driver_GD::overlayImage(): Overlay image

Image_Graph_Driver_SWF::overlayImage(): Overlay image

Image_Graph_Driver_SVG::overlayImage(): Overlay image

Image_Graph_Driver_PDFlib::overlayImage(): Overlay image

Parameters:

int	`$x`	—	X-point of overlayed image
int	`$y`	—	Y-point of overlayed image
string	`$filename`	—	The filename of the image to overlay
int	`$width`	—	The width of the overlayed image (resizing if possible)
int	`$height`	—	The height of the overlayed image (resizing if possible)

[ Top ]

void pieSlice(
int
$x, int
$y, int
$rx, int
$ry, int
$v1, int
$v2, [int
$srx = false], [int
$sry = false], [mixed
$fillColor = false], [mixed
$lineColor = false])

Draw a pie slice

Overridden in child classes as:

Image_Graph_Driver_GD::pieSlice(): Draw a pie slice

Image_Graph_Driver_SWF::pieSlice(): Draw a pie slice

Image_Graph_Driver_SVG::pieSlice(): Draw a pie slice

Image_Graph_Driver_PDFlib::pieSlice(): Draw a pie slice

Parameters:

int	`$x`	—	Center point x-value
int	`$y`	—	Center point y-value
int	`$rx`	—	X-radius of pie slice
int	`$ry`	—	Y-radius of pie slice
int	`$v1`	—	The starting angle
int	`$v2`	—	The end angle
int	`$srx`	—	Starting X-radius of the pie slice i.e. for a doughnut)
int	`$sry`	—	Starting Y-radius of the pie slice (i.e. for a doughnut)
mixed	`$fillColor`	—	The fill color, can be omitted
mixed	`$lineColor`	—	The line color, can be omitted

[ Top ]

void polygonAdd(
int
$x, int
$y)

Adds vertex to a polygon

Parameters:

int	`$x`	—	X point
int	`$y`	—	Y point

[ Top ]

void polygonEnd(
[bool
$connectEnds = true], [mixed
$fillColor = false], [mixed
$lineColor = false])

Draws a polygon

Overridden in child classes as:

Image_Graph_Driver_GD::polygonEnd(): Draws a polygon

Image_Graph_Driver_SWF::polygonEnd(): Draws a polygon

Image_Graph_Driver_SVG::polygonEnd(): Draws a polygon

Image_Graph_Driver_PDFlib::polygonEnd(): Draws a polygon

Parameters:

bool	`$connectEnds`	—	Specifies whether the start point should be connected to the endpoint (closed polygon) or not (connected line)
mixed	`$fillColor`	—	The fill color, can be omitted
mixed	`$lineColor`	—	The line color, can be omitted

[ Top ]

void rectangle(
int
$x0, int
$y0, int
$x1, int
$y1, [mixed
$fillColor = false], [mixed
$lineColor = false])

Draw a rectangle

Overridden in child classes as:

Image_Graph_Driver_GD::rectangle(): Draw a rectangle

Image_Graph_Driver_SWF::rectangle(): Draw a rectangle

Image_Graph_Driver_SVG::rectangle(): Draw a rectangle

Image_Graph_Driver_PDFlib::rectangle(): Draw a rectangle

Parameters:

int	`$x0`	—	X start point
int	`$y0`	—	X start point
int	`$x1`	—	X end point
int	`$y1`	—	Y end point
mixed	`$fillColor`	—	The fill color, can be omitted
mixed	`$lineColor`	—	The line color, can be omitted

[ Top ]

void setDefaultFont(
array
$fontOptions)

Sets the default font options.

The $font array may have the following entries:

'ttf' = the .ttf file (either the basename, filename or full path) If 'ttf' is specified, then the following can be specified

'size' = size in pixels

'angle' = the angle with which to write the text

Parameters:

array $fontOptions — The font options.

[ Top ]

void setFill(
mixed
$fill)

Sets the style of the filling of drawn objects.

This method gives simple access to setFillColor(), setFillImage() and setGradientFill()

Parameters:

mixed $fill — The fill style

[ Top ]

void setFillColor(
mixed
$color)

Sets the color of the filling of drawn objects

Parameters:

mixed $color — The fill color

[ Top ]

void setFillImage(
string
$filename)

Sets an image that should be used for filling

Overridden in child classes as:

Image_Graph_Driver_GD::setFillImage(): Sets an image that should be used for filling

Image_Graph_Driver_SWF::setFillImage(): Sets an image that should be used for filling

Image_Graph_Driver_SVG::setFillImage(): Sets an image that should be used for filling

Image_Graph_Driver_PDFlib::setFillImage(): Sets an image that should be used for filling.

Parameters:

string $filename — The filename of the image to fill with

[ Top ]

void setFont(
array
$fontOptions)

Sets the font options.

The $font array may have the following entries:

'ttf' = the .ttf file (either the basename, filename or full path) If 'ttf' is specified, then the following can be specified

'size' = size in pixels

'angle' = the angle with which to write the text

Overridden in child classes as:

Image_Graph_Driver_GD::setFont(): Sets the font options.

Image_Graph_Driver_SWF::setFont(): Sets the font options.

Image_Graph_Driver_SVG::setFont(): Sets the font options.

Image_Graph_Driver_PDFlib::setFont(): Sets the font options.

Parameters:

array $fontOptions — The font options.

[ Top ]

void setGradientFill(
array
$gradient)

Sets a gradient fill

Overridden in child classes as:

Image_Graph_Driver_SVG::setGradientFill(): Sets a gradient fill

Image_Graph_Driver_PDFlib::setGradientFill(): Sets a gradient fill

Parameters:

array $gradient — Gradient fill options

[ Top ]

void setLineColor(
mixed
$color)

Sets the color of the line(s) to be drawn

Parameters:

mixed $color — The color of the line

[ Top ]

void setLineThickness(
int
$thickness)

Sets the thickness of the line(s) to be drawn

Parameters:

int $thickness — The actual thickness (in pixels)

[ Top ]

void splineAdd(
int
$x, int
$y, 
$p1x, 
$p1y, 
$p2x, 
$p2y)

Adds vertex to a polygon

Parameters:

int	`$x`	—	X point
int	`$y`	—	Y point
	`$p1x`	—
	`$p1y`	—
	`$p2x`	—
	`$p2y`	—

[ Top ]

void splineEnd(
[bool
$connectEnds = true], [mixed
$fillColor = false], [mixed
$lineColor = false])

Draws a polygon

Overridden in child classes as:

Image_Graph_Driver_GD::splineEnd(): Ends a spline

Image_Graph_Driver_SWF::splineEnd(): Draws a polygon

Image_Graph_Driver_SVG::splineEnd(): Ends a spline

Image_Graph_Driver_PDFlib::splineEnd(): Draws a polygon

Parameters:

bool	`$connectEnds`	—	Specifies whether the start point should be connected to the endpoint (closed polygon) or not (connected line)
mixed	`$fillColor`	—	The fill color, can be omitted
mixed	`$lineColor`	—	The line color, can be omitted

[ Top ]

int textHeight(
string
$text)

Get the height of a text,

Return: The height of the text

Overridden in child classes as:

Image_Graph_Driver_GD::textHeight(): Get the height of a text,

Image_Graph_Driver_SWF::textHeight(): Get the height of a text,

Image_Graph_Driver_SVG::textHeight(): Get the height of a text,

Image_Graph_Driver_PDFlib::textHeight(): Get the height of a text,

Parameters:

string $text — The text to get the height of

[ Top ]

int textWidth(
string
$text)

Get the width of a text,

Return: The width of the text

Overridden in child classes as:

Image_Graph_Driver_GD::textWidth(): Get the width of a text,

Image_Graph_Driver_SWF::textWidth(): Get the width of a text,

Image_Graph_Driver_SVG::textWidth(): Get the width of a text,

Image_Graph_Driver_PDFlib::textWidth(): Get the width of a text,

Parameters:

string $text — The text to get the width of

[ Top ]

void write(
int
$x, int
$y, string
$text, int
$alignment, [mixed
$color = false])

Writes text

Overridden in child classes as:

Image_Graph_Driver_GD::write(): Writes text

Image_Graph_Driver_SWF::write(): Writes text

Image_Graph_Driver_SVG::write(): Writes text

Image_Graph_Driver_PDFlib::write(): Writes text.

Parameters:

int	`$x`	—	X-point of text
int	`$y`	—	Y-point of text
string	`$text`	—	The text to write
int	`$alignment`	—	The alignment of the text
mixed	`$color`	—	The color of the text

[ Top ]

Class: Image_Graph_Driver

Class Overview

Author(s):

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

Image_Graph_Driver (Constructor) [line 138]

Parameters:

done [line 501]

Parameters:

ellipse [line 423]

Parameters:

factory [line 537]

Parameters:

getHeight [line 196]

getWidth [line 186]

line [line 333]

Parameters:

overlayImage [line 491]

Parameters:

pieSlice [line 442]

Parameters:

polygonAdd [line 344]

Parameters:

polygonEnd [line 380]

Parameters:

rectangle [line 408]

Parameters:

setDefaultFont [line 302]

Parameters:

setFill [line 229]

Parameters:

setFillColor [line 245]

Parameters:

setFillImage [line 255]

Parameters:

setFont [line 283]

Parameters:

setGradientFill [line 264]

Parameters:

setLineColor [line 216]

Parameters:

setLineThickness [line 206]

Parameters:

splineAdd [line 359]

Parameters:

splineEnd [line 393]

Parameters:

textHeight [line 463]

Parameters:

textWidth [line 453]

Parameters:

write [line 476]

Parameters: