Class: awLinePlot

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

Class Overview

awComponent
   |
   --awPlot
      |
      --awLinePlot

LinePlot

Implements interfaces:

awLegendable

Variables

Constants

LINE
MIDDLE

Methods

Inherited Constants

Class: awPlot

awPlot::BOTH
awPlot::BOTTOM
awPlot::LEFT
awPlot::RIGHT
awPlot::TOP

Inherited Variables

Class: awPlot

awPlot::$datax
awPlot::$datay
awPlot::$grid
awPlot::$xAxis
awPlot::$xAxisPosition
awPlot::$xAxisZero
awPlot::$yAxis
awPlot::$yAxisPosition
awPlot::$yAxisZero

Inherited Methods

Class: awPlot

awPlot::__construct(): Build the plot
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::getXCenter(): Return TRUE if labels must be centered on X axis, FALSE otherwise
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.

Class Details

[line 25]
LinePlot

[ Top ]

Class Variables

$areas = array()

[line 46]

Filled areas

Tags:

access:

protected

Type:

bool

[ Top ]

$label =

[line 39]

Labels on your line plot

Tags:

access:

public

Type:

Label

[ Top ]

$lineBackground =

[line 88]

Line background

Tags:

var:	Gradient
access:	protected

Type:

Color,

[ Top ]

$lineColor =

[line 60]

Line color

Tags:

access:

protected

Type:

Color

[ Top ]

$lineHide = FALSE

[line 53]

Is the line hidden

Tags:

access:

protected

Type:

bool

[ Top ]

$lineMode = awLinePlot::LINE

[line 67]

Line mode

Tags:

access:

protected

Type:

int

[ Top ]

$lineStyle = awLine::SOLID

[line 74]

Line type

Tags:

access:

protected

Type:

int

[ Top ]

$lineThickness = 1

[line 81]

Line thickness

Tags:

access:

protected

Type:

int

[ Top ]

$mark =

[line 32]

Add marks to your line plot

Tags:

access:

public

Type:

Mark

[ Top ]

Class Methods

constructor __construct [line 110]

awLinePlot __construct(
array
$values, [int
$mode = awLinePlot::LINE])

Construct a new awLinePlot

Tags:

access:

public

Overrides awPlot::__construct() (Build the plot)

Parameters:

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

[ Top ]

method drawArea [line 334]

void drawArea(
awDriver
$driver, awPolygon
$polygon)

Tags:

access:

protected

Parameters:

awDriver	$driver
awPolygon	$polygon

[ Top ]

method drawComponent [line 239]

void drawComponent(
awDriver
$driver, 
$x1, 
$y1, 
$x2, 
$y2, 
$aliasing)

Tags:

access:

public

Parameters:

awDriver	$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
access:	public

Implementation of:

awLegendable::getLegendBackground(): Get the background color or gradient of an element of the component

[ Top ]

method getLegendLineColor [line 217]

Color getLegendLineColor(
)

Get the color of line

method getLegendLineStyle [line 208]

int getLegendLineStyle(
)

Get the line type

method getLegendLineThickness [line 199]

int getLegendLineThickness(
)

Get the line thickness

method getLegendMark [line 235]

Mark getLegendMark(
)

Get a mark object

method getXAxisNumber [line 373]

void getXAxisNumber(
)

Tags:

access:

public

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

[ Top ]

method getXCenter [line 386]

void getXCenter(
)

Tags:

access:

public

Overrides awPlot::getXCenter() (Return TRUE if labels must be centered on X axis, FALSE otherwise)

[ Top ]

method hideLine [line 128]

void hideLine(
bool
$hide)

Hide line

Tags:

access:

public

Parameters:

bool

$hide

[ Top ]

method setColor [line 154]

void setColor(
awColor
$color)

Change line color

Tags:

access:

public

Parameters:

awColor

$color

[ Top ]

method setFillColor [line 181]

void setFillColor(
awColor
$color)

Change line background color

Tags:

access:

public

Parameters:

awColor

$color

[ Top ]

method setFilledArea [line 139]

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

Add a filled area

Tags:

access:

public

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(
awGradient
$gradient)

Change line background gradient

Tags:

access:

public

Parameters:

awGradient

$gradient

[ Top ]

method setStyle [line 163]

void setStyle(
int
$style)

Change line style

Tags:

access:

public

Parameters:

int

$style

[ Top ]

method setThickness [line 172]

void setThickness(
int
$tickness)

Change line tickness

Tags:

access:

public

Parameters:

int

$tickness

[ Top ]

method xAxisPoint [line 381]

void xAxisPoint(

$position)

Tags:

access:

protected

Parameters:

$position

[ Top ]

Class Constants

LINE = 0

[line 95]

Line mode

[ Top ]

MIDDLE = 1

[line 102]

Line in the middle

[ Top ]

Documentation generated on Thu, 03 May 2012 15:05:53 +0200 by phpDocumentor 1.4.1