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

Class: Image_Canvas_WithMap

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

Class Overview

Image_Canvas
   |
   --Image_Canvas_WithMap

Class for handling different output formats including a HTML image map


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2003-2009 The PHP Group

Methods


Child classes:

Image_Canvas_GD
Canvas class to output using PHP GD support.

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 46]
Class for handling different output formats including a HTML image map


[ Top ]


Method Detail

Image_Canvas_WithMap (Constructor)   [line 75]

Image_Canvas_WithMap Image_Canvas_WithMap( array $params)

Create the canvas.

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

'usemap' Initialize an image map

  • Abstract:

Parameters:

array   $params     Parameter array

[ Top ]

addSpline   [line 147]

void addSpline( array $params)

Adds "splined" vertex to a polygon

Parameter array: 'x': int X point 'y': int Y point 'p1x': X Control point 1 'p1y': Y Control point 1 'p2x': X Control point 2 'p2y': Y Control point 2


Overrides Image_Canvas::addSpline() (Adds "splined" vertex to a polygon)

Parameters:

array   $params     Parameter array

[ Top ]

addText   [line 263]

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


Overridden in child classes as:

Image_Canvas_GD::addText()
Writes text

Overrides Image_Canvas::addText() (Writes text)

Parameters:

array   $params     Parameter array

[ Top ]

addVertex   [line 124]

void addVertex( array $params)

Adds vertex to a polygon

Parameter array: 'x': int X point 'y': int Y point


Overrides Image_Canvas::addVertex() (Adds vertex to a polygon)

Parameters:

array   $params     Parameter array

[ Top ]

ellipse   [line 214]

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


Overridden in child classes as:

Image_Canvas_GD::ellipse()
Draw an ellipse

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

Parameters:

array   $params     Parameter array

[ Top ]

getImageMap   [line 299]

Image_Graph_ImageMap &getImageMap( )

Get the imagemap
  • Return: The image map (or false if none)

[ Top ]

image   [line 286]

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


Overridden in child classes as:

Image_Canvas_GD::image()
Overlay image

Overrides Image_Canvas::image() (Overlay image)

Parameters:

array   $params     Parameter array

[ Top ]

line   [line 105]

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


Overridden in child classes as:

Image_Canvas_GD::line()
Draw a line

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

Parameters:

array   $params     Parameter array

[ Top ]

pieslice   [line 241]

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


Overridden in child classes as:

Image_Canvas_GD::pieslice()
Draw a pie slice

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

Parameters:

array   $params     Parameter array

[ Top ]

polygon   [line 168]

void polygon( array $params)

Draws a polygon

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


Overridden in child classes as:

Image_Canvas_GD::polygon()
Parameter array:

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

Parameters:

array   $params     Parameter array

[ Top ]

rectangle   [line 191]

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


Overridden in child classes as:

Image_Canvas_GD::rectangle()
Draw a rectangle

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

Parameters:

array   $params     Parameter array

[ Top ]


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