Class: awLinePlot

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

Class Overview

awComponent
   |
   --awPlot
      |
      --awLinePlot

LinePlot

Variables

Methods

Inherited Variables

Class: awPlot

awPlot::$datax
awPlot::$datay
awPlot::$grid
awPlot::$xAxis
awPlot::$xAxisPosition
awPlot::$xAxisZero
awPlot::$xMax
awPlot::$xMin
awPlot::$yAxis
awPlot::$yAxisPosition
awPlot::$yAxisZero
awPlot::$yMax
awPlot::$yMin

Inherited Methods

Class: awPlot

awPlot::awPlot(): Build the plot
awPlot::checkArray()
awPlot::createGrid()
awPlot::drawEnvelope()
awPlot::getLimit(): Return begin and end values
awPlot::getRealYMax(): Get max value with spaces for Y axis
awPlot::getRealYMin(): Get min value with spaces for Y axis
awPlot::getValues(): Get plot values
awPlot::getXAxis(): Get X axis
awPlot::getXAxisNumber(): Count values in the plot
awPlot::getXMax(): Get max value for X axis
awPlot::getXMin(): Get min value for X axis
awPlot::getYAxis(): Get Y axis
awPlot::getYMax(): Get max value for Y axis
awPlot::getYMin(): Get min value for Y axis
awPlot::init()
awPlot::reduce(): Reduce number of values in the plot
awPlot::setValues(): Change values of Y axis This method ignores not numeric values
awPlot::setXAxis(): Change X axis
awPlot::setXAxisZero(): Set X axis on zero
awPlot::setXMax(): Change max value for X axis Set NULL for auto selection.
awPlot::setXMin(): Change min value for X axis Set NULL for auto selection.
awPlot::setYAxis(): Change Y axis
awPlot::setYAxisZero(): Set Y axis on zero
awPlot::setYMax(): Change max value for Y axis Set NULL for auto selection.
awPlot::setYMin(): Change min value for Y axis Set NULL for auto selection.
awPlot::updateAxis(): Return TRUE if labels must be centered on X axis, FALSE otherwise

Class Details

[line 25]
LinePlot

[ Top ]

Class Variables

$areas = array()

[line 46]

Filled areas

Type:

bool

[ Top ]

$label =

[line 39]

Labels on your line plot

Type:

Label

[ Top ]

$lineBackground =

[line 88]

Line background

Tags:

var:

Gradient

Type:

Color,

[ Top ]

$lineColor =

[line 60]

Line color

Type:

Color

[ Top ]

$lineHide = FALSE

[line 53]

Is the line hidden

Type:

bool

[ Top ]

$lineMode = LINEPLOT_LINE

[line 67]

Line mode

Type:

int

[ Top ]

$lineStyle = LINE_SOLID

[line 74]

Line type

Type:

int

[ Top ]

$lineThickness = 1

[line 81]

Line thickness

Type:

int

[ Top ]

$mark =

[line 32]

Add marks to your line plot

Type:

Mark

[ Top ]

Class Methods

constructor awLinePlot [line 110]

awLinePlot awLinePlot(
array
$values, [int
$mode = LINEPLOT_LINE])

Construct a new awLinePlot

Parameters:

array	$values	Some numeric values for Y axis
int	$mode

[ Top ]

method drawArea [line 334]

void drawArea(

$driver, 
&$polygon)

Parameters:

	$driver
	&$polygon

[ Top ]

method drawComponent [line 239]

void drawComponent(

$driver, 
$x1, 
$y1, 
$x2, 
$y2, 
$aliasing)

Parameters:

	$driver
	$x1
	$y1
	$x2
	$y2
	$aliasing

[ Top ]

method getLegendBackground [line 226]

Color, getLegendBackground(
)

Get the background color or gradient of an element of the component

Tags:

return:

Gradient

[ Top ]

method getLegendLineColor [line 217]

Color getLegendLineColor(
)

Get the color of line

[ Top ]

method getLegendLineStyle [line 208]

int getLegendLineStyle(
)

Get the line type

[ Top ]

method getLegendLineThickness [line 199]

int getLegendLineThickness(
)

Get the line thickness

[ Top ]

method getLegendMark [line 235]

Mark getLegendMark(
)

Get a mark object

[ Top ]

method getXAxisNumber [line 373]

void getXAxisNumber(
)

Overrides awPlot::getXAxisNumber() (Count values in the plot)

[ Top ]

method getXCenter [line 386]

void getXCenter(
)

[ Top ]

method hideLine [line 128]

void hideLine(
bool
$hide)

Hide line

Parameters:

bool

$hide

[ Top ]

method setColor [line 154]

void setColor(
$color
$color)

Change line color

Parameters:

$color

$color

[ Top ]

method setFillColor [line 181]

void setFillColor(
$color
$color)

Change line background color

Parameters:

$color

$color

[ Top ]

method setFilledArea [line 139]

void setFilledArea(
int
$start, 
$stop, mixed
$background, int
$end)

Add a filled area

Parameters:

int	$start	Begining of the area
int	$end	End of the area
mixed	$background	Background color or gradient of the area
	$stop

[ Top ]

method setFillGradient [line 190]

void setFillGradient(
$gradient
$gradient)

Change line background gradient

Parameters:

$gradient

$gradient

[ Top ]

method setStyle [line 163]

void setStyle(
int
$style)

Change line style

Parameters:

int

$style

[ Top ]

method setThickness [line 172]

void setThickness(
int
$tickness)

Change line tickness

Parameters:

int

$tickness

[ Top ]

method xAxisPoint [line 381]

void xAxisPoint(

$position)

Parameters:

$position

[ Top ]

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