Class: awSimpleLinePlot

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

Class Overview

awComponent
   |
   --awPlot
      |
      --awSimpleLinePlot

Simple LinePlot Useful to draw simple horizontal lines

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 402]
Simple LinePlot Useful to draw simple horizontal lines

[ Top ]

Class Variables

$lineColor =

[line 409]

Line color

Tags:

access:

protected

Type:

Color

[ Top ]

$lineMode = awLinePlot::LINE

[line 437]

Line mode

Tags:

access:

protected

Type:

int

[ Top ]

$lineStart =

[line 416]

Line start

Tags:

access:

protected

Type:

int

[ Top ]

$lineStop =

[line 423]

Line stop

Tags:

access:

protected

Type:

int

[ Top ]

$lineStyle = awLine::SOLID

[line 444]

Line type

Tags:

access:

protected

Type:

int

[ Top ]

$lineThickness = 1

[line 451]

Line thickness

Tags:

access:

protected

Type:

int

[ Top ]

$lineValue =

[line 430]

Line value

Tags:

access:

protected

Type:

flaot

[ Top ]

Class Methods

constructor __construct [line 475]

awSimpleLinePlot __construct(
float
$value, int
$start, int
$stop, [int
$mode = awLinePlot::LINE])

Construct a new awLinePlot

Tags:

access:

public

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

Parameters:

float	$value	A Y value
int	$start	Line start index
int	$stop	Line stop index
int	$mode	Line mode

[ Top ]

method drawComponent [line 551]

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

Tags:

access:

public

Parameters:

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

[ Top ]

method getLegendBackground [line 543]

void getLegendBackground(
)

method getLegendLineColor [line 539]

Color getLegendLineColor(
)

Get the color of line

method getLegendLineStyle [line 530]

int getLegendLineStyle(
)

Get the line type

method getLegendLineThickness [line 521]

int getLegendLineThickness(
)

Get the line thickness

method getLegendMark [line 547]

void getLegendMark(
)

method getXAxisNumber [line 573]

void getXAxisNumber(
)

Tags:

access:

public

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

[ Top ]

method getXCenter [line 586]

void getXCenter(
)

Tags:

access:

public

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

[ Top ]

method setColor [line 494]

void setColor(
awColor
$color)

Change line color

Tags:

access:

public

Parameters:

awColor

$color

[ Top ]

method setStyle [line 503]

void setStyle(
int
$style)

Change line style

Tags:

access:

public

Parameters:

int

$style

[ Top ]

method setThickness [line 512]

void setThickness(
int
$tickness)

Change line tickness

Tags:

access:

public

Parameters:

int

$tickness

[ Top ]

method xAxisPoint [line 581]

void xAxisPoint(

$position)

Tags:

access:

protected

Parameters:

$position

[ Top ]

Class Constants

LINE = 0

[line 458]

Line mode

[ Top ]

MIDDLE = 1

[line 465]

Line in the middle

[ Top ]

Documentation generated on Fri, 01 Apr 2011 09:32:31 +0200 by phpDocumentor 1.4.1