Class: awScatterPlot

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

Class Overview

awComponent
   |
   --awPlot
      |
      --awScatterPlot

ScatterPlot

Implements interfaces:

awLegendable

Variables

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 18]
ScatterPlot

[ Top ]

Class Variables

$impulse = NULL

[line 46]

Display impulses

Tags:

access:

protected

Type:

bool

[ Top ]

$label =

[line 32]

Labels on the plot

Tags:

access:

public

Type:

Label

[ Top ]

$lineColor =

[line 60]

Line color

Tags:

access:

protected

Type:

Color

[ Top ]

$lineStyle = awLine::SOLID

[line 67]

Line type

Tags:

access:

protected

Type:

int

[ Top ]

$lineThickness = 1

[line 74]

Line thickness

Tags:

access:

protected

Type:

int

[ Top ]

$link = FALSE

[line 39]

Link points ?

Tags:

access:

protected

Type:

bool

[ Top ]

$linkNull = FALSE

[line 53]

Link NULL points ?

Tags:

access:

protected

Type:

bool

[ Top ]

$mark =

[line 25]

Add marks to the scatter plot

Tags:

access:

public

Type:

Mark

[ Top ]

Class Methods

constructor __construct [line 83]

awScatterPlot __construct(
array
$datay, [array
$datax = NULL], int
$mode)

Construct a new awScatterPlot

Tags:

access:

public

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

Parameters:

array	$datay	Numeric values for Y axis
array	$datax	Numeric values for X axis
int	$mode

[ Top ]

method drawComponent [line 203]

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

Tags:

access:

public

Parameters:

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

[ Top ]

method getLegendBackground [line 190]

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 181]

Color getLegendLineColor(
)

Get the color of line

method getLegendLineStyle [line 172]

int getLegendLineStyle(
)

Get the line type

method getLegendLineThickness [line 163]

int getLegendLineThickness(
)

Get the line thickness

method getLegendMark [line 199]

Mark getLegendMark(
)

Get a mark object

method getXCenter [line 294]

void getXCenter(
)

Tags:

access:

public

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

[ Top ]

method link [line 115]

void link(
bool
$link, [awColor
$color = NULL])

Link scatter plot points

Tags:

access:

public

Parameters:

bool	$link
awColor	$color	Line color (default to black)

[ Top ]

method linkNull [line 127]

void linkNull(
bool
$link)

Ignore null values for Y data and continue linking

Tags:

access:

public

Parameters:

bool

$link

[ Top ]

method setColor [line 136]

void setColor(
awColor
$color)

Change line color

Tags:

access:

public

Parameters:

awColor

$color

[ Top ]

method setImpulse [line 105]

void setImpulse(

$color, awColor
$impulse)

Display plot as impulses

Tags:

access:

public

Parameters:

awColor	$impulse	Impulses color (or NULL to disable impulses)
	$color

[ Top ]

method setStyle [line 145]

void setStyle(
int
$style)

Change line style

Tags:

access:

public

Parameters:

int

$style

[ Top ]

method setThickness [line 154]

void setThickness(
int
$tickness)

Change line tickness

Tags:

access:

public

Parameters:

int

$tickness

[ Top ]

method xAxisPoint [line 289]

void xAxisPoint(

$position)

Tags:

access:

protected

Parameters:

$position

[ Top ]

Documentation generated on Thu, 03 May 2012 15:07:33 +0200 by phpDocumentor 1.4.1