Class: awBarPlot

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

Class Overview

awComponent
   |
   --awPlot
      |
      --awBarPlot

BarPlot

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

[ Top ]

Class Variables

$barBackground =

[line 88]

Bars background

Tags:

var:	Gradient
access:	protected

Type:

Color,

[ Top ]

$barBorder =

[line 67]

Bars border

Tags:

access:

public

Type:

Border

[ Top ]

$barPadding =

[line 74]

Bars padding

Tags:

access:

protected

Type:

Side

[ Top ]

$barShadow =

[line 60]

Bars shadow

Tags:

access:

public

Type:

Shadow

[ Top ]

$barSpace = 0

[line 81]

Bars space

Tags:

access:

protected

Type:

int

[ Top ]

$depth =

[line 46]

Bar plot depth

Tags:

access:

protected

Type:

int

[ Top ]

$identifier =

[line 32]

Bar plot identifier

Tags:

access:

protected

Type:

int

[ Top ]

$label =

[line 25]

Labels on your bar plot

Tags:

access:

public

Type:

Label

[ Top ]

$move =

[line 53]

For moving bars

Tags:

access:

protected

Type:

int

[ Top ]

$number =

[line 39]

Bar plot number

Tags:

access:

protected

Type:

int

[ Top ]

Class Methods

constructor __construct [line 98]

awBarPlot __construct(
array
$values, [int
$identifier = 1], [int
$number = 1], [int
$depth = 0])

Construct a new awBarPlot

Tags:

access:

public

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

Parameters:

array	$values	Some numeric values for Y axis
int	$identifier	Plot identifier
int	$number	Bar plot number
int	$depth	Bar plot depth in pixels

[ Top ]

method drawBar [line 326]

void drawBar(
awDriver
$driver, awPoint
$p1, awPoint
$p2)

Tags:

access:

protected

Parameters:

awDriver	$driver
awPoint	$p1
awPoint	$p2

[ Top ]

method drawComponent [line 221]

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

Tags:

access:

public

Parameters:

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

[ Top ]

method getLegendBackground [line 209]

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

Color getLegendLineColor(
)

Get the color of line

method getLegendLineStyle [line 193]

int getLegendLineStyle(
)

Get the line type

method getLegendLineThickness [line 185]

int getLegendLineThickness(
)

Get the line thickness

method getLegendMark [line 218]

Mark getLegendMark(
)

Get a mark object

method getXAxisNumber [line 314]

void getXAxisNumber(
)

Tags:

access:

public

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

[ Top ]

method getXCenter [line 322]

void getXCenter(
)

Tags:

access:

public

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

[ Top ]

method getXMax [line 318]

void getXMax(
)

Tags:

access:

public

Overrides awPlot::getXMax() (Get max value for X axis)

[ Top ]

method move [line 149]

void move(
int
$x, int
$y)

Move bars

Tags:

access:

public

Parameters:

int	$x
int	$y

[ Top ]

method setBarColor [line 167]

void setBarColor(
awColor
$color)

Change line background color

Tags:

access:

public

Parameters:

awColor

$color

[ Top ]

method setBarGradient [line 176]

void setBarGradient(
awGradient
$gradient)

Change line background gradient

Tags:

access:

public

Parameters:

awGradient

$gradient

[ Top ]

method setBarPadding [line 128]

void setBarPadding(
[float
$left = NULL], [float
$right = NULL])

Change bars padding This method is not compatible with awBarPlot::setBarPadding()

Tags:

access:

public

Parameters:

float	$left	Left padding (between 0 and 1)
float	$right	Right padding (between 0 and 1)

[ Top ]

method setBarSize [line 138]

void setBarSize(

$size, int
$width)

Change bars size This method is not compatible with awBarPlot::setBarPadding()

Tags:

access:

public

Parameters:

int	$width	Bars size (between 0 and 1)
	$size

[ Top ]

method setBarSpace [line 158]

void setBarSpace(
int
$space)

Change bars space

Tags:

access:

public

Parameters:

int

$space

Space in pixels

[ Top ]

Documentation generated on Thu, 03 May 2012 15:02:10 +0200 by phpDocumentor 1.4.1