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

Class: Image_Graph_Plotarea

Source Location: /Image_Graph-0.3.0dev1/Graph/Plotarea.php

Class Overview

Image_Graph_Common
   |
   --Image_Graph_Element
      |
      --Image_Graph_Plotarea_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 Variables

Inherited Methods

Class: Image_Graph_Layout

Image_Graph_Layout::Image_Graph_Layout()
Image_Graph_Layout [Constructor]

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
Image_Graph_Element::write()
Writes text to the canvas.

Class: Image_Graph_Common

Image_Graph_Common::Image_Graph_Common()
Constructor
Image_Graph_Common::add()
Adds an element to the objects element list, the new Image_Graph_elements parent is automatically set
Image_Graph_Common::addNew()
Creates an object from the class specified and adds it to the objects element list.

Class Details

[line 47]
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 ]


Method Detail

Image_Graph_Plotarea (Constructor)   [line 111]

Image_Graph_Plotarea &Image_Graph_Plotarea( [string $axisX = 'Image_Graph_Axis_Category'], [string $axisY = 'Image_Graph_Axis'])

Image_Graph_Plotarea [Constructor]

Parameters:

string   $axisX   —  The class of the X axis (if omitted a std. axis is created)
string   $axisY   —  The class of the Y axis (if omitted a std. axis is created)

[ Top ]

add   [line 149]

Image_Graph_Element &add( &$element, [int $axis = IMAGE_GRAPH_AXIS_Y], Image_Graph_Element $element)

Adds an element to the plotarea
  • Return: The added element
  • See: Image_Graph_Common::add()

Overrides Image_Graph_Common::add() (Adds an element to the objects element list, the new Image_Graph_elements parent is automatically set)

Parameters:

Image_Graph_Element   $element   —  The element to add
int   $axis   —  The axis to associate the element with, either IMAGE_GRAPH_AXIS_X, IMAGE_GRAPH_AXIS_Y or IMAGE_GRAPH_AXIS_Y_SECONDARY (defaults to IMAGE_GRAPH_AXIS_Y)
   &$element   — 

[ Top ]

getAxis   [line 357]

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

Get axis
  • Return: The axis

Parameters:

int   $Axis   —  The axis to return

[ Top ]

hideAxis   [line 347]

void hideAxis( )

Hides the axis

Overridden in child classes as:

Image_Graph_Plotarea_Map::hideAxis()
Hides the axis

[ Top ]

setPlotBorderStyle   [line 136]

void setPlotBorderStyle( &$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
   &$plotBorderStyle   — 

[ Top ]


Documentation generated on Mon, 11 Mar 2019 13:57:46 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.