Class: Image_Graph_Plot

Source Location: /Image_Graph-0.8.0/Graph/Plot.php

Class Overview

Image_Graph_Common
   |
   --Image_Graph_Element
      |
      --Image_Graph_Plotarea_Element
         |
         --Image_Graph_Plot

Framework for a chart

Author(s):

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

Version:

Release: 0.8.0

Copyright:

2003-2009 The PHP Groupn

Methods

Child classes:

Image_Graph_Plot_Odo: 2D Odochart.

Image_Graph_Plot_Band: "Band" (area chart with min AND max) chart.

Image_Graph_Plot_Dot: Dot / scatter chart (only marker).

Image_Graph_Plot_Fit_Line: Fit the graph (to a line using linear regression).

Image_Graph_Plot_Smoothed_Bezier: Bezier smoothed plottype.

Image_Graph_Plot_Area: Area Chart plot.

Image_Graph_Plot_Line: Linechart.

Image_Graph_Plot_CandleStick: Candlestick chart.

Image_Graph_Plot_Pie: 2D Piechart.

Image_Graph_Plot_Impulse: Impulse chart.

Image_Graph_Plot_BoxWhisker: Box & Whisker chart.

Image_Graph_Plot_Radar: Radar chart.

Image_Graph_Plot_Bar: A bar chart.

Image_Graph_Plot_Step: Step chart.

Inherited Variables

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::setFontAngle(): Sets the font angle
Image_Graph_Element::setFontColor(): Sets the font color
Image_Graph_Element::setFontSize(): Sets the font size
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.
Image_Graph_Element::_clip(): Clip the canvas to the coordinates of the element

Class: Image_Graph_Common

Image_Graph_Common::Image_Graph_Common(): Constructor [Image_Graph_Common]
Image_Graph_Common::add(): Adds an element to the objects element list.
Image_Graph_Common::addNew(): Creates an object from the class and adds it to the objects element list.
Image_Graph_Common::hide(): Hide the element

Class Details

[line 51]
Framework for a chart

Author: Stefan Neufeind <pear.neufeind@speedpartner.de>
Author: Jesper Veggerby <pear.nosey@veggerby.dk>
Version: Release: 0.8.0
Copyright: 2003-2009 The PHP Groupn
Link: http://pear.php.net/package/Image_Graph
Abstract:
License: LGPL License 2.1

[ Top ]

Method Detail

Image_Graph_Plot (Constructor) [line 119]

Image_Graph_Plot Image_Graph_Plot(
Image_Graph_Dataset
&$dataset, [string
$multiType = 'normal'], [string
$title = ''])

PlotType [Constructor]

Valid values for multiType are:

'normal' Plot is normal, multiple datasets are displayes next to one another

'stacked' Datasets are stacked on top of each other

'stacked100pct' Datasets are stacked and displayed as percentages of the total sum

I no title is specified a default is used, which is basically the plot type (fx. for a 'Image_Graph_Plot_Smoothed_Area' default title is 'Smoothed Area')

Parameters:

Image_Graph_Dataset	`&$dataset`	—	The data set (value containter) to plot or an array of datasets
string	`$multiType`	—	The type of the plot
string	`$title`	—	The title of the plot (used for legends, Image_Graph_Legend)

[ Top ]

dataset [line 679]

Image_Graph_Dataset &dataset(
)

Get the dataset

Return: The dataset(s)

[ Top ]

setDataSelector [line 248]

void setDataSelector(
DataSelector
&$dataSelector)

Sets the dataselector to specify which data should be displayed on the plot as markers and which are not

Parameters:

DataSelector &$dataSelector — The dataselector

[ Top ]

setMarker [line 233]

Marker &setMarker(
Marker
&$marker)

Sets the marker to 'display' data points on the graph

Parameters:

Marker &$marker — The marker

[ Top ]

setTitle [line 171]

void setTitle(
string
$title)

Sets the title of the plot, used for legend

Parameters:

string $title — The title of the plot

[ Top ]