Class: awPlotGroup

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

Class Overview

awComponent
   |
   --awComponentGroup
      |
      --awPlotGroup

A graph with axis can contain some groups of components

Variables

Methods

Inherited Variables

Class: awComponentGroup

awComponentGroup::$components

Class: awComponent

awComponent::$auto
awComponent::$background
awComponent::$driver
awComponent::$h
awComponent::$height
awComponent::$left
awComponent::$legend
awComponent::$padding
awComponent::$space
awComponent::$title
awComponent::$top
awComponent::$w
awComponent::$width
awComponent::$x
awComponent::$y

Inherited Methods

Class: awComponentGroup

awComponentGroup::awComponentGroup(): Build the component group
awComponentGroup::add(): Add a component to the group

Class: awComponent

awComponent::awComponent(): Build the component
awComponent::auto(): Adjust automatically the component ?
awComponent::finalize(): Finalize the drawing of the component
awComponent::getBackground(): Return the component background
awComponent::getPosition(): Get component coords with its padding
awComponent::getSpace(): Get space width in pixels
awComponent::init(): Init the drawing of the component
awComponent::setAbsPosition(): Change the absolute position of the component on the graph
awComponent::setAbsSize(): Change the absolute size of the component
awComponent::setBackgroundColor(): Change component background color
awComponent::setBackgroundGradient(): Change component background gradient
awComponent::setBackgroundImage(): Change component background image
awComponent::setCenter(): Set the center of the component
awComponent::setPadding(): Change component padding
awComponent::setSize(): Change the size of the component
awComponent::setSpace(): Change component space

Class Details

[line 805]
A graph with axis can contain some groups of components

[ Top ]

Class Variables

$axis =

[line 819]

Left, right, top and bottom axis

Type:

PlotAxis

[ Top ]

$grid =

[line 812]

Grid properties

Type:

Grid

[ Top ]

$xAxisZero = TRUE

[line 826]

Set the X axis on zero

Type:

bool

[ Top ]

$xMax = NULL

[line 875]

Change max value for X axis

Type:

mixed

[ Top ]

$xMin = NULL

[line 868]

Change min value for X axis

Type:

mixed

[ Top ]

$xRealAxis = PLOT_BOTTOM

[line 847]

Real axis used for X axis

Type:

string

[ Top ]

$yAxisZero = FALSE

[line 833]

Set the Y axis on zero

Type:

bool

[ Top ]

$yMax = NULL

[line 861]

Change max value for Y axis

Type:

mixed

[ Top ]

$yMin = NULL

[line 854]

Change min value for Y axis

Type:

mixed

[ Top ]

$yRealAxis = PLOT_LEFT

[line 840]

Real axis used for Y axis

Type:

string

[ Top ]

Class Methods

constructor awPlotGroup [line 881]

awPlotGroup awPlotGroup(
)

Build the PlotGroup

[ Top ]

method createGrid [line 1393]

void createGrid(
)

[ Top ]

method drawComponent [line 1264]

void drawComponent(

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

Parameters:

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

[ Top ]

method drawEnvelope [line 1316]

void drawEnvelope(

$driver)

Parameters:

$driver

[ Top ]

method getRealY [line 1058]

void getRealY(

$type, 
$axis)

Parameters:

	$type
	$axis

[ Top ]

method getRealYMax [line 1040]

float getRealYMax(
[string
$axis = NULL])

Get max value with spaces for Y axis

Parameters:

string

$axis

Axis name

[ Top ]

method getRealYMin [line 1016]

float getRealYMin(
[string
$axis = NULL])

Get min value with spaces for Y axis

Parameters:

string

$axis

Axis name

[ Top ]

method getX [line 976]

void getX(

$type)

Parameters:

$type

[ Top ]

method getXAxisNumber [line 1462]

void getXAxisNumber(
)

[ Top ]

method getXMax [line 970]

float getXMax(
)

Get max value for X axis

[ Top ]

method getXMin [line 959]

float getXMin(
)

Get min value for X axis

[ Top ]

method init [line 1110]

void init(

$driver)

Overrides awComponent::init() (Init the drawing of the component)

Parameters:

$driver

[ Top ]

method isAxisUsed [line 1363]

bool isAxisUsed(
string
$axis)

Is the specified axis used ?

Parameters:

string

$axis

Axis name

[ Top ]

method selectXAxis [line 1449]

void selectXAxis(
)

[ Top ]

method selectYAxis [line 1436]

void selectYAxis(
)

[ Top ]

method setXAxisZero [line 897]

void setXAxisZero(
bool
$zero)

Set the X axis on zero or not

Parameters:

bool

$zero

[ Top ]

method setXMax [line 950]

void setXMax(
float
$value)

Change max value for X axis Set NULL for auto selection.

Parameters:

float

$value

[ Top ]

method setXMin [line 940]

void setXMin(
float
$value)

Change min value for X axis Set NULL for auto selection.

Parameters:

float

$value

[ Top ]

method setYAxisZero [line 906]

void setYAxisZero(
bool
$zero)

Set the Y axis on zero or not

Parameters:

bool

$zero

[ Top ]

method setYMax [line 928]

void setYMax(
float
$value)

Change max value for Y axis Set NULL for auto selection.

Parameters:

float

$value

[ Top ]

method setYMin [line 916]

void setYMin(
float
$value)

Change min value for Y axis Set NULL for auto selection.

Parameters:

float

$value

[ Top ]

Documentation generated on Sat, 08 Nov 2008 14:54:07 +0100 by phpDocumentor 1.4.1