Class: awLegend

Source Location: /class/system/artichow/php5/inc/Legend.class.php

Class Overview

Some legends

Implements interfaces:

awPositionable

Variables

Constants

Methods

Class Details

[line 37]
Some legends

[ Top ]

Class Variables

$background =

[line 58]

Background color or gradient

Tags:

var:	Gradient
access:	protected

Type:

Color,

[ Top ]

$border =

[line 149]

Legend border

Tags:

access:

public

Type:

Border

[ Top ]

$columns = NULL

[line 86]

Number of columns

Tags:

access:

protected

Type:

int

[ Top ]

$component =

[line 51]

The current component

Tags:

access:

protected

Type:

Component

[ Top ]

$hAlign =

[line 121]

Horizontal alignment

Tags:

access:

protected

Type:

int

[ Top ]

$hide = FALSE

[line 107]

Hide legend ?

Tags:

access:

protected

Type:

bool

[ Top ]

$legends = array()

[line 44]

Legends added

Tags:

access:

protected

Type:

array

[ Top ]

$position =

[line 100]

Legend position

Tags:

access:

protected

Type:

Point

[ Top ]

$rows = NULL

[line 93]

Number of rows

Tags:

access:

protected

Type:

int

[ Top ]

$shadow =

[line 142]

Legend shadow

Tags:

access:

public

Type:

Shadow

[ Top ]

$space = 4

[line 114]

Space between each legend

Tags:

access:

protected

Type:

int

[ Top ]

$textColor =

[line 65]

Text color

Tags:

access:

protected

Type:

Color

[ Top ]

$textFont =

[line 72]

Text font

Tags:

access:

protected

Type:

Font

[ Top ]

$textMargin =

[line 79]

Text margin

Tags:

access:

protected

Type:

Side

[ Top ]

$vAlign =

[line 128]

Vertical alignment

Tags:

access:

protected

Type:

int

[ Top ]

Class Methods

constructor __construct [line 198]

awLegend __construct(
[int
$model = awLegend::MODEL_RIGHT])

Build the legend

Tags:

access:

public

Parameters:

int

$model

Legend model

[ Top ]

method add [line 274]

void add(
awLegendable
$legendable, string
$title, [int
$type = awLegend::LINE])

Add a Legendable object to the legend

Tags:

access:

public

Parameters:

awLegendable	$legendable
string	$title	Legend title
int	$type	Legend type (default to awLegend::LINE)

[ Top ]

method count [line 421]

int count(
)

Count the number of Legendable objects in the legend

Tags:

access:

public

[ Top ]

method draw [line 425]

void draw(
awDriver
$driver)

Tags:

access:

public

Parameters:

awDriver

$driver

[ Top ]

method getPosition [line 357]

Point getPosition(
)

Get legend position

Tags:

access:

public

[ Top ]

method hide [line 253]

void hide(
[bool
$hide = TRUE])

Hide legend ?

Tags:

access:

public

Parameters:

bool

$hide

TRUE to hide legend, FALSE otherwise

[ Top ]

method setAlign [line 309]

void setAlign(
[int
$h = NULL], [int
$v = NULL])

Change alignment

Parameters:

int	$h	Horizontal alignment
int	$v	Vertical alignment

[ Top ]

method setBackground [line 394]

void setBackground(
mixed
$background)

Change background

Tags:

access:

public

Parameters:

mixed

$background

[ Top ]

method setBackgroundColor [line 403]

void setBackgroundColor(
awColor
$color)

Change background color

Tags:

access:

public

Parameters:

awColor

$color

[ Top ]

method setBackgroundGradient [line 412]

void setBackgroundGradient(
awGradient
$gradient)

Change background gradient

Tags:

access:

public

Parameters:

awGradient

$gradient

[ Top ]

method setColumns [line 323]

void setColumns(
int
$columns)

Change number of columns

Tags:

access:

public

Parameters:

int

$columns

[ Top ]

method setModel [line 213]

void setModel(
int
$model)

Set a predefined model for the legend

Tags:

access:

public

Parameters:

int

$model

[ Top ]

method setPadding [line 290]

void setPadding(
int
$left, int
$right, int
$top, int
$bottom)

Change legend padding

Tags:

access:

public

Parameters:

int	$left
int	$right
int	$top
int	$bottom

[ Top ]

method setPosition [line 345]

void setPosition(
[float
$x = NULL], [float
$y = NULL])

Change legend position X and Y positions must be between 0 and 1.

Tags:

access:

public

Parameters:

float	$x
float	$y

[ Top ]

method setRows [line 333]

void setRows(
int
$rows)

Change number of rows

Tags:

access:

public

Parameters:

int

$rows

[ Top ]

method setSpace [line 299]

void setSpace(
int
$space)

Change space between each legend

Tags:

access:

public

Parameters:

int

$space

[ Top ]

method setTextColor [line 385]

void setTextColor(
awColor
$color)

Change text color

Tags:

access:

public

Parameters:

awColor

$color

[ Top ]

method setTextFont [line 366]

void setTextFont(
awFont
$font)

Change text font

Tags:

access:

public

Parameters:

awFont

$font

[ Top ]

method setTextMargin [line 376]

void setTextMargin(
int
$left, int
$right)

Change text margin

Tags:

access:

public

Parameters:

int	$left
int	$right

[ Top ]

method show [line 262]

void show(
[bool
$show = TRUE])

Show legend ?

Tags:

access:

public

Parameters:

bool

$show

[ Top ]

Class Constants

BACKGROUND = 2

[line 163]

Color/Gradient background legend

[ Top ]

LINE = 1

[line 156]

Line legend

[ Top ]

MARK = 3

[line 170]

Use marks and line as legend

[ Top ]

MARKONLY = 4

[line 177]

Use marks as legend

[ Top ]

MODEL_BOTTOM = 2

[line 191]

Bottom side model

[ Top ]

MODEL_RIGHT = 1

[line 184]

Right side model

[ Top ]

Documentation generated on Thu, 03 May 2012 15:05:43 +0200 by phpDocumentor 1.4.1