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

Class: Image_Canvas_SVG

Source Location: /Image_Canvas-0.3.5/Image/Canvas/SVG.php

Class Overview

Image_Canvas
   |
   --Image_Canvas_SVG

SVG Canvas class.


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2003-2009 The PHP Group

Methods


Inherited Variables

Inherited Methods

Class: Image_Canvas

Image_Canvas::Image_Canvas()
Create the canvas.
Image_Canvas::addSpline()
Adds "splined" vertex to a polygon
Image_Canvas::addText()
Writes text
Image_Canvas::addVertex()
Adds vertex to a polygon
Image_Canvas::drawEnd()
Draw a line end
Image_Canvas::ellipse()
Draw an ellipse
Image_Canvas::endGroup()
End the "current" group.
Image_Canvas::factory()
Canvas factory method.
Image_Canvas::getHeight()
Get the height of the canvas
Image_Canvas::getWidth()
Get the width of the canvas
Image_Canvas::image()
Overlay image
Image_Canvas::line()
Draw a line
Image_Canvas::pieslice()
Draw a pie slice
Image_Canvas::polygon()
Draws a polygon
Image_Canvas::rectangle()
Draw a rectangle
Image_Canvas::reset()
Reset the canvas.
Image_Canvas::save()
Save the result of the canvas to a file
Image_Canvas::setClipping()
Set clipping to occur
Image_Canvas::setDefaultFont()
Sets the default font options.
Image_Canvas::setFill()
Sets the style of the filling of drawn objects.
Image_Canvas::setFillColor()
Sets the color of the filling of drawn objects
Image_Canvas::setFillImage()
Sets an image that should be used for filling
Image_Canvas::setFont()
Sets the font options.
Image_Canvas::setGradientFill()
Sets a gradient fill
Image_Canvas::setLineColor()
Sets the color of the line(s) to be drawn
Image_Canvas::setLineThickness()
Sets the thickness of the line(s) to be drawn
Image_Canvas::show()
Output the result of the canvas to the browser
Image_Canvas::startGroup()
Start a group.
Image_Canvas::textHeight()
Get the height of a text,
Image_Canvas::textWidth()
Get the width of a text,
Image_Canvas::toHtml()
Get a canvas specific HTML tag.

Class Details

[line 50]
SVG Canvas class.


[ Top ]


Method Detail

Image_Canvas_SVG (Constructor)   [line 110]

void Image_Canvas_SVG( array $params)

Create the SVG canvas.

Parameters available:

'width' The width of the graph

'height' The height of the graph

'encoding' The encoding of the SVG document


Parameters:

array   $params     Parameter array

[ Top ]

addText   [line 763]

void addText( array $params)

Writes text

Parameter array: 'x': int X-point of text 'y': int Y-point of text 'text': string The text to add 'alignment': array [optional] Alignment 'color': mixed [optional] The color of the text


Overrides Image_Canvas::addText() (Writes text)

Parameters:

array   $params     Parameter array

[ Top ]

ellipse   [line 627]

void ellipse( array $params)

Draw an ellipse

Parameter array: 'x': int X center point 'y': int Y center point 'rx': int X radius 'ry': int Y radius 'fill': mixed [optional] The fill color 'line': mixed [optional] The line color


Overrides Image_Canvas::ellipse() (Draw an ellipse)

Parameters:

array   $params     Parameter array

[ Top ]

endGroup   [line 921]

void endGroup( )

End the "current" group.

What this does, depends on the canvas/format.


Overrides Image_Canvas::endGroup() (End the "current" group.)
[ Top ]

getData   [line 973]

string getData( [array $param = false])

Get SVG data

Parameters:

array   $param     Parameter array

[ Top ]

image   [line 863]

void image( array $params)

Overlay image

Parameter array: 'x': int X-point of overlayed image 'y': int Y-point of overlayed image 'filename': string The filename of the image to overlay 'width': int [optional] The width of the overlayed image (resizing if possible) 'height': int [optional] The height of the overlayed image (resizing if possible) 'alignment': array [optional] Alignment


Overrides Image_Canvas::image() (Overlay image)

Parameters:

array   $params     Parameter array

[ Top ]

line   [line 473]

void line( array $params)

Parameter array:

'x0': int X start point 'y0': int Y start point 'x1': int X end point 'y1': int Y end point 'color': mixed [optional] The line color


Overrides Image_Canvas::line() (Draw a line)

Parameters:

array   $params     Parameter array

[ Top ]

pieslice   [line 674]

void pieslice( array $params)

Draw a pie slice

Parameter array: 'x': int X center point 'y': int Y center point 'rx': int X radius 'ry': int Y radius 'v1': int The starting angle (in degrees) 'v2': int The end angle (in degrees) 'srx': int [optional] Starting X-radius of the pie slice (i.e. for a doughnut) 'sry': int [optional] Starting Y-radius of the pie slice (i.e. for a doughnut) 'fill': mixed [optional] The fill color 'line': mixed [optional] The line color


Overrides Image_Canvas::pieslice() (Draw a pie slice)

Parameters:

array   $params     Parameter array

[ Top ]

polygon   [line 511]

void polygon( [array $params = array()])

Parameter array:

'connect': bool [optional] Specifies whether the start point should be connected to the endpoint (closed polygon) or not (connected line) 'fill': mixed [optional] The fill color 'line': mixed [optional] The line color


Overrides Image_Canvas::polygon() (Draws a polygon)

Parameters:

array   $params     Parameter array

[ Top ]

rectangle   [line 584]

void rectangle( array $params)

Draw a rectangle

Parameter array: 'x0': int X start point 'y0': int Y start point 'x1': int X end point 'y1': int Y end point 'fill': mixed [optional] The fill color 'line': mixed [optional] The line color


Overrides Image_Canvas::rectangle() (Draw a rectangle)

Parameters:

array   $params     Parameter array

[ Top ]

save   [line 954]

void save( [array $param = false])

Output the result of the canvas

Overrides Image_Canvas::save() (Save the result of the canvas to a file)

Parameters:

array   $param     Parameter array

[ Top ]

setClipping   [line 1008]

void setClipping( [array $params = false])

Set clipping to occur

Parameter array:

'x0': int X point of Upper-left corner 'y0': int X point of Upper-left corner 'x1': int X point of lower-right corner 'y1': int Y point of lower-right corner


Overrides Image_Canvas::setClipping() (Set clipping to occur)

Parameters:

array   $params     Parameter array (x0, y0, x1, y1)

[ Top ]

setFillImage   [line 422]

void setFillImage( string $filename)

Sets an image that should be used for filling

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

Parameters:

string   $filename     The filename of the image to fill with

[ Top ]

setFont   [line 453]

void setFont( array $fontOptions)

Sets the font options.

The $font array may have the following entries: 'type' = 'ttf' (TrueType) or omitted for default
If 'type' = 'ttf' then the following can be specified
'size' = size in pixels
'angle' = the angle with which to write the text 'file' = the .ttf file (either the basename, filename or full path)


Overrides Image_Canvas::setFont() (Sets the font options.)

Parameters:

array   $fontOptions     The font options.

[ Top ]

setGradientFill   [line 433]

void setGradientFill( array $gradient)

Sets a gradient fill

Overrides Image_Canvas::setGradientFill() (Sets a gradient fill)

Parameters:

array   $gradient     Gradient fill options

[ Top ]

show   [line 934]

void show( [array $param = false])

Output the result of the canvas

Overrides Image_Canvas::show() (Output the result of the canvas to the browser)

Parameters:

array   $param     Parameter array

[ Top ]

startGroup   [line 902]

void startGroup( [string $name = false])

Start a group.

What this does, depends on the canvas/format.


Overrides Image_Canvas::startGroup() (Start a group.)

Parameters:

string   $name     The name of the group

[ Top ]

textHeight   [line 740]

int textHeight( string $text)

Get the height of a text,
  • Return: The height of the text

Overrides Image_Canvas::textHeight() (Get the height of a text,)

Parameters:

string   $text     The text to get the height of

[ Top ]

textWidth   [line 724]

int textWidth( string $text)

Get the width of a text,
  • Return: The width of the text

Overrides Image_Canvas::textWidth() (Get the width of a text,)

Parameters:

string   $text     The text to get the width of

[ Top ]

toHtml   [line 1047]

string toHtml( array $params)

Get a canvas specific HTML tag.

This method implicitly saves the canvas to the filename in the filesystem path specified and parses it as URL specified by URL path

Parameter array: 'filename': string 'filepath': string Path to the file on the file system. Remember the final slash 'urlpath': string Path to the file available through an URL. Remember the final slash 'width': int The width in pixels 'height': int The height in pixels

  • Return: HTML code

Overrides Image_Canvas::toHtml() (Get a canvas specific HTML tag.)

Parameters:

array   $params     Parameter array

[ Top ]


Documentation generated on Fri, 27 Jul 2012 07:30:14 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.