Class: awPlotGroup

Source Location: /class/system/artichow/php5/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::__construct(): Build the component group
awComponentGroup::add(): Add a component to the group

Class: awComponent

awComponent::__construct(): Build the component
awComponent::auto(): Adjust automatically the component ?
awComponent::drawComponent(): Draw the component on the graph Component should be drawed into specified coords
awComponent::drawEnvelope(): Draw the grid around your 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 809]
A graph with axis can contain some groups of components

[ Top ]

Class Variables

$axis =

[line 823]

Left, right, top and bottom axis

Tags:

access:

public

Type:

PlotAxis

[ Top ]

$grid =

[line 816]

Grid properties

Tags:

access:

public

Type:

Grid

[ Top ]

$xAxisZero = TRUE

[line 830]

Set the X axis on zero

Tags:

access:

protected

Type:

bool

[ Top ]

$yAxisZero = FALSE

[line 837]

Set the Y axis on zero

Tags:

access:

protected

Type:

bool

[ Top ]

Class Methods

constructor __construct [line 885]

awPlotGroup __construct(
)

Build the PlotGroup

Tags:

access:

public

Overrides awComponentGroup::__construct() (Build the component group)

[ Top ]

method createGrid [line 1409]

void createGrid(
)

Tags:

access:

protected

[ Top ]

method drawComponent [line 1280]

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

Tags:

access:

public

Overrides awComponent::drawComponent() (Draw the component on the graph Component should be drawed into specified coords)

Parameters:

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

[ Top ]

method drawEnvelope [line 1332]

void drawEnvelope(
awDriver
$driver)

Tags:

access:

public

Overrides awComponent::drawEnvelope() (Draw the grid around your component)

Parameters:

awDriver

$driver

[ Top ]

method getRealYMax [line 1044]

float getRealYMax(
[string
$axis = NULL])

Get max value with spaces for Y axis

Tags:

access:

public

Parameters:

string

$axis

Axis name

[ Top ]

method getRealYMin [line 1020]

float getRealYMin(
[string
$axis = NULL])

Get min value with spaces for Y axis

Tags:

access:

public

Parameters:

string

$axis

Axis name

[ Top ]

method getXAxisNumber [line 1478]

void getXAxisNumber(
)

Tags:

access:

protected

[ Top ]

method getXMax [line 974]

float getXMax(
)

Get max value for X axis

Tags:

access:

public

[ Top ]

method getXMin [line 963]

float getXMin(
)

Get min value for X axis

Tags:

access:

public

[ Top ]

method init [line 1114]

void init(
awDriver
$driver)

Tags:

access:

public

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

Parameters:

awDriver

$driver

[ Top ]

method isAxisUsed [line 1379]

bool isAxisUsed(
string
$axis)

Is the specified axis used ?

Tags:

access:

protected

Parameters:

string

$axis

Axis name

[ Top ]

method selectXAxis [line 1465]

void selectXAxis(
)

Tags:

access:

protected

[ Top ]

method selectYAxis [line 1452]

void selectYAxis(
)

Tags:

access:

protected

[ Top ]

method setXAxisZero [line 901]

void setXAxisZero(
bool
$zero)

Set the X axis on zero or not

Tags:

access:

public

Parameters:

bool

$zero

[ Top ]

method setXMax [line 954]

void setXMax(
float
$value)

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

Tags:

access:

public

Parameters:

float

$value

[ Top ]

method setXMin [line 944]

void setXMin(
float
$value)

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

Tags:

access:

public

Parameters:

float

$value

[ Top ]

method setYAxisZero [line 910]

void setYAxisZero(
bool
$zero)

Set the Y axis on zero or not

Tags:

access:

public

Parameters:

bool

$zero

[ Top ]

method setYMax [line 932]

void setYMax(
float
$value)

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

Tags:

access:

public

Parameters:

float

$value

[ Top ]

method setYMin [line 920]

void setYMin(
float
$value)

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

Tags:

access:

public

Parameters:

float

$value

[ Top ]

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