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

Class: Image_Canvas_PS

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

Class Overview

Image_Canvas
   |
   --Image_Canvas_PS

PostScript 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 54]
PostScript Canvas class.


[ Top ]


Method Detail

Image_Canvas_PS (Constructor)   [line 147]

Image_Canvas_PS Image_Canvas_PS( array $param)

Create the PostScript canvas.

Parameters available:

'page' Specify the page/paper format for the graph's page, available formats are: A0, A1, A2, A3, A4, A5, A6, B5, letter, legal, ledger, 11x17, cd_front, inlay, inlay_nosides

'align' Alignment of the graph on the page, available options are: topleft, topcenter, topright, leftcenter, center, rightcenter, leftbottom, centerbottom, rightbottom

'orientation' Specifies the paper orientation, default is 'portrait' and 'landscape' is also supported.

'creator' The creator tag of the PostScript/graph

'author' The author tag of the PostScript/graph

'title' The title tag of the PostScript/graph

'width' The width of the graph on the page

'height' The height of the graph on the page

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

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

'filename' The PostScript file to open/add page to, using 'filename' requires 'ps' An existing pslib PostScript document to add the page to

'add_page' (true/false) Used together with 'ps', to specify whether the canvas should add a new graph page (true) or create the graph on the current page (false), default is 'true'

The 'page' and 'width' & 'height' can be mutually omitted, if 'page' is omitted the page is created using dimensions of width x height, and if width and height are omitted the page dimensions are used for the graph.

If 'ps' is specified, 'filename', 'creator', 'author' and 'title' has no effect.

'left' and 'top' are overridden by 'align'

It is required either to specify 'width' & 'height' or 'page'.

The PostScript format/pslib has some limitations on the capabilities, which means some functionality available using other canvass (fx. alpha blending and gradient fills) are not supported with PostScript (see Canvas.txt in the docs/ folder for further details)


Parameters:

array   $param     Parameter array

[ Top ]

addText   [line 833]

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 698]

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 ]

image   [line 896]

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 553]

void line( array $params)

Draw a line

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 770]

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 575]

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 659]

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 987]

void save( [array $param = false])

Output the result of the canvas
  • Abstract:

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

Parameters:

array   $param     Parameter array

[ Top ]

setFillImage   [line 469]

void setFillImage( string $filename)

Sets an image that should be used for filling.

Image filling is not supported with PostScript, filling 'transparent'


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 504]

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


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

Parameters:

array   $fontOptions     The font options.

[ Top ]

setGradientFill   [line 483]

void setGradientFill( array $gradient)

Sets a gradient fill

Gradient filling is not supported with PostScript, end color used as solid fill.


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

Parameters:

array   $gradient     Gradient fill options

[ Top ]

show   [line 962]

void show( [array $param = false])

Output the result of the canvas
  • Abstract:

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

Parameters:

array   $param     Parameter array

[ Top ]

textHeight   [line 810]

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 794]

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 1023]

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 'title': string The url title

  • 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:12 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.