Class: awGraph

Source Location: /class/system/artichow/php4/Graph.class.php

Class Overview

awImage
   |
   --awGraph

A graph

Variables

Methods

Inherited Variables

Class: awImage

awImage::$antiAliasing
awImage::$background
awImage::$border
awImage::$driver
awImage::$driverString
awImage::$format
awImage::$height
awImage::$resource
awImage::$shadow
awImage::$width

Inherited Methods

Class: awImage

awImage::awImage(): Build the image
awImage::create(): Create a new awimage
awImage::drawComponent(): Draw a component on the image
awImage::drawError()
awImage::drawErrorFile()
awImage::drawShadow()
awImage::get(): Return the image content as binary data
awImage::getAntiAliasing(): Return the antialiasing setting
awImage::getBackground(): Return image background, whether a Color or a Gradient
awImage::getDriver(): Get driver of the image
awImage::getFormat(): Returns the image format as an integer
awImage::getFormatString(): Returns the image format as a string
awImage::selectDriver(): Select the correct driver
awImage::send(): Send the image into a file or to the user browser
awImage::sendHeaders(): Send the correct HTTP header according to the image type
awImage::setAntiAliasing(): Turn antialiasing on or off
awImage::setBackground(): Change image background
awImage::setBackgroundColor(): Change image background color
awImage::setBackgroundGradient(): Change image background gradient
awImage::setDriver(): Sets the driver that will be used to draw the graph
awImage::setFormat(): Change image format
awImage::setSize(): Change the image size

Class Details

[line 25]
A graph

[ Top ]

Class Variables

$components = array()

[line 53]

Components

Type:

array

[ Top ]

$fileCache =

[line 74]

File cache location

Type:

string

[ Top ]

$fileCacheTime =

[line 81]

Time file cache location

Type:

string

[ Top ]

$labels = array()

[line 60]

Some labels to add to the component

Type:

array

[ Top ]

$name =

[line 32]

Graph name

Type:

string

[ Top ]

$timeout = 0

[line 39]

Cache timeout

Type:

int

[ Top ]

$timing =

[line 46]

Graph timing ?

Type:

bool

[ Top ]

$title =

[line 67]

Graph title

Type:

Label

[ Top ]

Class Methods

constructor awGraph [line 105]

awGraph awGraph(
[int
$width = NULL], [int
$height = NULL], [string
$name = NULL], [int
$timeout = 0])

Construct a new graph

Parameters:

int	$width	Graph width
int	$height	Graph height
string	$name	Graph name for the cache (must be unique). Let it null to not use the cache.
int	$timeout	Cache timeout (unix timestamp)

[ Top ]

method add [line 231]

void add(
&$component
&$component)

Add a component to the graph

Parameters:

&$component

&$component

[ Top ]

method addAbsLabel [line 258]

void addAbsLabel(
&$label
&$label, $point
$point)

Add a label to the component with absolute position

Parameters:

&$label	&$label
$point	$point	Text position

[ Top ]

method addLabel [line 244]

void addLabel(
&$label
&$label, int
$x, int
$y)

Add a label to the component

Parameters:

int	$x	Position on X axis of the center of the text
int	$y	Position on Y axis of the center of the text
&$label	&$label

[ Top ]

method cache [line 377]

void cache(

$data)

Parameters:

$data

[ Top ]

method cleanCache [line 196]

void cleanCache(
)

Clean cache

[ Top ]

method cleanGraphCache [line 390]

void cleanGraphCache(

$file)

Parameters:

$file

[ Top ]

method deleteAllCache [line 177]

void deleteAllCache(
)

Delete all graphs from the cache

[ Top ]

method deleteFromCache [line 161]

bool deleteFromCache(
string
$name)

Delete a graph from the cache

Tags:

return:

TRUE on success, FALSE on failure

Parameters:

string

$name

Graph name

[ Top ]

method draw [line 271]

void draw(
[string
$mode = GRAPH_DRAW_DISPLAY])

Build the graph and draw component on it

Parameters:

string

$mode

Display mode (can be a file name)

[ Top ]

method drawLabels [line 320]

void drawLabels(
)

[ Top ]

method drawTiming [line 362]

void drawTiming(

$time)

Parameters:

$time

[ Top ]

method drawTitle [line 349]

void drawTitle(
)

[ Top ]

method setTiming [line 222]

void setTiming(
bool
$timing)

Enable/Disable Graph timing

Parameters:

bool

$timing

[ Top ]

Documentation generated on Sat, 08 Nov 2008 14:52:26 +0100 by phpDocumentor 1.4.1