Class: Image_Canvas_ImageMap

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

Class Overview

Image_Canvas
   |
   --Image_Canvas_ImageMap

Class for handling output as a HTML imagemap

Author(s):

Stefan Neufeind <pear.neufeind at speedpartner.de>
Jesper Veggerby <pear.nosey at veggerby.dk>

Version:

Release: @package_version@

Copyright:

2003-2009 The PHP Group

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 45]
Class for handling output as a HTML imagemap

Author: Stefan Neufeind <pear.neufeind@speedpartner.de>
Author: Jesper Veggerby <pear.nosey@veggerby.dk>
Version: Release: @package_version@
Copyright: 2003-2009 The PHP Group
Link: http://pear.php.net/package/Image_Canvas
Since: version 0.2.0
License: LGPL License 2.1

[ Top ]

Method Detail

ellipse [line 233]

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 ]

line [line 107]

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 'mapsize': int [optional] The size of the image map (surrounding the line)

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

Parameters:

array $params — Parameter array

[ Top ]

pieslice [line 283]

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

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 'map_vertices': bool [optional] Specifies whether the image map should map the vertices instead of the polygon as a whole 'url': string [optional] URL to link the polygon as a whole to (also used for default in case 'map_vertices' is used) 'alt': string [optional] Alternative text to show in the image map (also used for default in case 'map_vertices' is used) 'target': string [optional] The link target on the image map (also used for default in case 'map_vertices' is used)

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

Parameters:

array $params — Parameter array

[ Top ]

rectangle [line 203]

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

void save(
[array
$params = false])

Save the result of the canvas to a file

Parameter array: 'filename': string The file to output to

Abstract:

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

Parameters:

array $params — Parameter array, the contents and meaning depends on the actual Canvas

[ Top ]

show [line 332]

void show(
[array
$params = false])

Output the result of the canvas to the browser

Abstract:

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

Parameters:

array $params — Parameter array, the contents and meaning depends on the actual Canvas

[ Top ]

toHtml [line 369]

void toHtml(
array
$params)

Get a canvas specific HTML tag.

Parameter array: 'name': string The name of the image map

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

Parameters:

array $params — Parameter array

[ Top ]