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

Class: Image_Graph_Element

Source Location: /Graph/Element.php

Class Overview

Image_Graph_Common
   |
   --Image_Graph_Element

Representation of a element in GraPHPite.


Author(s):

Methods


Child classes:

Image_Graph
The Graph Object - the 1st (or last) object.
Image_Graph_Axis
Diplays a normal linear axis (either X- or Y-axis).
Image_Graph_Figure_Ellipse
Ellipse to draw on the canvas
Image_Graph_Figure_Polygon
Polygon to draw on the canvas
Image_Graph_Figure_Rectangle
Rectangle to draw on the canvas
Image_Graph_Fill
Style used for filling elements.
Image_Graph_Grid
A grid displayed on the plotarea.
Image_Graph_Layout
Defines an area of the graph that can be layout'ed.
Image_Graph_Logo
Displays a logo on the canvas.
Image_Graph_Marker
Data point marker.
Image_Graph_Plot
Framework for a chart
Image_Graph_Plotarea_Element
Representation of a element on a plotarea.
Image_Graph_Text
Textual element.

Inherited Methods

Class: Image_Graph_Common

Image_Graph_Common::Image_Graph_Common()
Creates an a instance of Image_Graph_Common.
Image_Graph_Common::add()
Adds an element to the objects element list, the new Image_Graph_elements parent is automatically set
Image_Graph_Common::addColor()
Add a color. Ultimately it should call addColor() from the Image_Graph object
Image_Graph_Common::newColor()
Create a new Image_Graph_color.
Image_Graph_Common::setName()
Sets the name

Class Details

[line 46]
Representation of a element in GraPHPite.

The Image_Graph_Element can be drawn on the canvas, ie it has coordinates, {@see Image_Graph_Line}, {@see Image_Graph_Fill}, border and background - although not all of these may apply to all children.




Tags:

abstract:  


[ Top ]


Class Methods


method height [line 489]

int height( )

The height of the element on the canvas



Tags:

return:  Number of pixels representing the height of the element


Overridden in child classes as:

Image_Graph::height()
The height of the graph
Image_Graph_Text::height()
The height of the text on the canvas

[ Top ]

method setBackground [line 141]

void setBackground( Image_Graph_Fill &$background)

Sets the background fill style of the element



Tags:



Overridden in child classes as:

Image_Graph_Marker_Value::setBackground()
Sets the background fill style of the element

Parameters:

Image_Graph_Fill   $background   The background

[ Top ]

method setBackgroundColor [line 162]

void setBackgroundColor( int $red, [int $green = false], [int $blue = false])

Sets the background color of the element



Overridden in child classes as:

Image_Graph_Marker_Value::setBackgroundColor()
Sets the background color of the element

Parameters:

int   $red   The red part (or the whole)
int   $green   The green part (if omitted the $red part must contain the whole 24-bit color)
int   $blue   The blue part (if omitted the $red part must contain the whole 24-bit color)

[ Top ]

method setBorderColor [line 213]

void setBorderColor( int $red, [int $green = false], [int $blue = false])

Sets the border color of the element



Parameters:

int   $red   The red part (or the whole)
int   $green   The green part (if omitted the $red part must contain the whole 24-bit color)
int   $blue   The blue part (if omitted the $red part must contain the whole 24-bit color)

[ Top ]

method setBorderStyle [line 200]

void setBorderStyle( Image_Graph_Line &$borderStyle)

Sets the border line style of the element



Tags:

see:  Image_Graph_Line


Parameters:

Image_Graph_Line   $borderStyle   The line style of the border

[ Top ]

method setFillColor [line 328]

void setFillColor( int $red, [int $green = false], [int $blue = false])

Sets the fill color of the element



Parameters:

int   $red   The red part (or the whole)
int   $green   The green part (if omitted the $red part must contain the whole 24-bit color)
int   $blue   The blue part (if omitted the $red part must contain the whole 24-bit color)

[ Top ]

method setFillStyle [line 315]

void setFillStyle( Image_Graph_Fill &$fillStyle)

Sets the fill style of the element



Tags:



Parameters:

Image_Graph_Fill   $fillStyle   The fill style of the element

[ Top ]

method setFont [line 367]

void setFont( Font &$font)

Sets the font of the element



Tags:



Parameters:

Font   $font   The font of the element

[ Top ]

method setLineColor [line 270]

void setLineColor( int $red, [int $green = false], [int $blue = false])

Sets the line color of the element



Parameters:

int   $red   The red part (or the whole)
int   $green   The green part (if omitted the $red part must contain the whole 24-bit color)
int   $blue   The blue part (if omitted the $red part must contain the whole 24-bit color)

[ Top ]

method setLineStyle [line 257]

void setLineStyle( Image_Graph_Line &$lineStyle)

Sets the line style of the element



Tags:

see:  Image_Graph_Line


Parameters:

Image_Graph_Line   $lineStyle   The line style of the element

[ Top ]

method setPadding [line 432]

void setPadding( int $padding)

Sets padding of the element



Parameters:

int   $padding   Number of pixels the element should be padded with

[ Top ]

method showShadow [line 151]

void showShadow( )

Shows shadow on the element



[ Top ]

method width [line 479]

int width( )

The width of the element on the canvas



Tags:

return:  Number of pixels representing the width of the element


Overridden in child classes as:

Image_Graph::width()
The width of the graph
Image_Graph_Text::width()
The width of the text on the canvas

[ Top ]


Documentation generated on Fri, 12 Nov 2004 08:25:17 +0100 by phpDocumentor 1.3.0RC3