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

Class: Image_Graph_Plotarea

Source Location: /Graph/Plotarea.php

Class Overview

Image_Graph_Common
   |
   --Image_Graph_Element
      |
      --Image_Graph_Layout
         |
         --Image_Graph_Plotarea

Plot area used for drawing plots.


Methods


Child classes:

Image_Graph_Plotarea_Map
Plot area used for map plots.
Image_Graph_Plotarea_Radar
Plot area used for radar plots.

Inherited Methods

Class: Image_Graph_Element

Image_Graph_Element::height()
The height of the element on the canvas
Image_Graph_Element::setBackground()
Sets the background fill style of the element
Image_Graph_Element::setBackgroundColor()
Sets the background color of the element
Image_Graph_Element::setBorderColor()
Sets the border color of the element
Image_Graph_Element::setBorderStyle()
Sets the border line style of the element
Image_Graph_Element::setFillColor()
Sets the fill color of the element
Image_Graph_Element::setFillStyle()
Sets the fill style of the element
Image_Graph_Element::setFont()
Sets the font of the element
Image_Graph_Element::setLineColor()
Sets the line color of the element
Image_Graph_Element::setLineStyle()
Sets the line style of the element
Image_Graph_Element::setPadding()
Sets padding of the element
Image_Graph_Element::showShadow()
Shows shadow on the element
Image_Graph_Element::width()
The width of the element on the canvas

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 45]
Plot area used for drawing plots.

The plotarea consists of an x-axis and an y-axis, the plotarea can plot multiple charts within one plotares, by simply adding them (the axis' will scale to the plots automatically). A graph can consist of more plotareas




[ Top ]


Class Methods


constructor Image_Graph_Plotarea [line 102]

Image_Graph_Plotarea &Image_Graph_Plotarea( [Image_Graph_Axis $axisX = false], [Image_Graph_Axis $axisY = false])

Image_Graph_Plotarea [Constructor]



Parameters:

Image_Graph_Axis   $axisX   The X axis (if false or omitted a std. axis is created)
Image_Graph_Axis   $axisY   The Y axis (if false or omitted a std. axis is created)

[ Top ]

method addGridX [line 162]

void &addGridX( Grid &$grid)

Add a X-axis grid to the plotarea



Tags:



Overridden in child classes as:

Image_Graph_Plotarea_Map::addGridX()
Add a X-axis grid to the plotarea
Image_Graph_Plotarea_Radar::addGridX()
Add a X-axis grid to the plotarea

Parameters:

Grid   $grid   The grid to add

[ Top ]

method addGridY [line 180]

void &addGridY( Grid &$grid)

Add a Y-axis grid to the plotarea



Tags:



Overridden in child classes as:

Image_Graph_Plotarea_Map::addGridY()
Add a Y-axis grid to the plotarea

Parameters:

Grid   $grid   The grid to add

[ Top ]

method addPlot [line 150]

Image_Graph_Plot &addPlot( Image_Graph_Plot &$plotType)

Add a plot to the plotarea



Tags:

return:  The addded plottype
see:  Image_Graph_Common::add()


Parameters:

Image_Graph_Plot   $plotType   The plot to add

[ Top ]

method getAxis [line 319]

Image_Graph_Axis &getAxis( [int $Axis = IMAGE_GRAPH_AXIS_X])

Get axis



Tags:

return:  The axis


Parameters:

int   $Axis   The axis to return

[ Top ]

method hideAxis [line 309]

void hideAxis( )

Hides the axis



Overridden in child classes as:

Image_Graph_Plotarea_Map::hideAxis()
Hides the axis

[ Top ]

method setPlotBorderStyle [line 138]

void setPlotBorderStyle( mixed &$plotBorderStyle, Image_Graph_Line $lineStyle)

Sets the plot border line style of the element



Parameters:

Image_Graph_Line   $lineStyle   The line style of the border

[ Top ]


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