Docs For Class awAxis

$auto = TRUE

[line 95]

Auto-scaling mode

Type:

bool

[ Top ]

$color =

[line 67]

Axis and ticks color

Type:

Color

[ Top ]

$hide = FALSE

[line 88]

Hide axis

Type:

bool

[ Top ]

$label =

[line 32]

Axis labels

Type:

Label

[ Top ]

$labelNumber =

[line 53]

Labels number

Type:

int

[ Top ]

$line =

[line 25]

Axis line

Type:

Line

[ Top ]

$padding =

[line 74]

Axis left and right padding

Type:

Side

[ Top ]

$range =

[line 81]

Axis range

Type:

array

[ Top ]

$rangeCallback = array(
      'toValue' => 'toProportionalValue',
      'toPosition' => 'toProportionalPosition'
   )

[line 102]

Axis range callback function

Type:

array

[ Top ]

$ticks = array()

[line 60]

Axis ticks

Type:

array

[ Top ]

$title =

[line 39]

Axis title

Type:

Label

[ Top ]

$titlePosition = 0.5

[line 46]

Title position

Type:

float

[ Top ]

constructor awAxis [line 113]

awAxis awAxis(
[float
$min = NULL], [float
$max = NULL])

Build the axis

Parameters:

float	$min	Begin of the range of the axis
float	$max	End of the range of the axis

[ Top ]

method addTick [line 196]

void addTick(
string
$name, &$tick
&$tick)

Add a tick object

Parameters:

string	$name	Tick object name
&$tick	&$tick	Tick object

[ Top ]

method auto [line 143]

void auto(
bool
$auto)

Enable/disable auto-scaling mode

Parameters:

bool

$auto

[ Top ]

method autoScale [line 592]

void autoScale(
)

[ Top ]

method deleteTick [line 207]

void deleteTick(
string
$name)

Delete a tick object

Parameters:

string

$name

Tick object name

[ Top ]

method draw [line 569]

void draw(
$driver
$driver)

Draw axis

Parameters:

$driver

$driver

A driver

[ Top ]

method drawLabels [line 701]

void drawLabels(

$driver)

Parameters:

$driver

[ Top ]

method drawTicks [line 692]

void drawTicks(

$driver, 
&$vector)

Parameters:

	$driver
	&$vector

[ Top ]

method getDistance [line 518]

Point getDistance(
float
$from, float
$to)

Get the distance between to values on the axis

Parameters:

float	$from	The first value
float	$to	The last value

[ Top ]

method getLabelNumber [line 304]

int getLabelNumber(
)

Get number of labels

[ Top ]

method getPadding [line 426]

Side getPadding(
)

Get axis padding

[ Top ]

method getPointFromPosition [line 550]

Point getPointFromPosition(
float
$position)

Get a point on the axis from a position

Parameters:

float

$position

A position between 0 and 1

[ Top ]

method getPointFromValue [line 533]

Point getPointFromValue(
float
$value)

Get a point on the axis from a value

Parameters:

float

$value

[ Top ]

method getRange [line 450]

array getRange(
)

Get axis range

[ Top ]

method getVector [line 728]

void getVector(
)

[ Top ]

method hide [line 161]

void hide(
[bool
$hide = TRUE])

Hide axis

Parameters:

bool

$hide

[ Top ]

method hideTicks [line 218]

void hideTicks(
[bool
$hide = TRUE])

Hide all ticks

Parameters:

bool

$hide

Hide or not ?

[ Top ]

method isAuto [line 152]

bool isAuto(
)

Get auto-scaling mode status

[ Top ]

method line [line 683]

void line(

$driver)

Parameters:

$driver

[ Top ]

method reverseTickStyle [line 266]

void reverseTickStyle(
)

Reverse ticks style

[ Top ]

method setColor [line 406]

void setColor(
$color
$color)

Change axis and axis title color

Parameters:

$color

$color

[ Top ]

method setLabelInterval [line 283]

void setLabelInterval(
int
$interval)

Change interval of labels

Parameters:

int

$interval

Interval

[ Top ]

method setLabelNumber [line 294]

void setLabelNumber(
int
$number)

Change number of labels

Parameters:

int

$number

Number of labels to display (can be NULL)

[ Top ]

method setLabelPrecision [line 313]

void setLabelPrecision(
int
$precision)

Change precision of labels

Parameters:

int

$precision

Precision

[ Top ]

method setLabelText [line 327]

void setLabelText(
array
$texts)

Change text of labels

Parameters:

array

$texts

Some texts

[ Top ]

method setNumberByTick [line 259]

void setNumberByTick(
&$to
$to, &$from
$from, float
$number)

Change number of ticks relative to others ticks

Parameters:

float	$number	Number of ticks by the reference
&$to	$to	Change number of theses ticks
&$from	$from	Ticks reference

[ Top ]

method setPadding [line 417]

void setPadding(
int
$left, int
$right)

Change axis padding

Parameters:

int	$left	Left padding in pixels
int	$right	Right padding in pixels

[ Top ]

method setRange [line 436]

void setRange(
float
$min, float
$max)

Change axis range

Parameters:

float	$min
float	$max

[ Top ]

method setRangeCallback [line 460]

void setRangeCallback(
string
$toValue, string
$toPosition)

Change axis range callback function

Parameters:

string	$toValue	Transform a position between 0 and 1 to a value
string	$toPosition	Transform a value to a position between 0 and 1 on the axis

[ Top ]

method setTickInterval [line 244]

void setTickInterval(
int
$interval)

Change ticks interval

Parameters:

int

$interval

Ticks interval

[ Top ]

method setTickStyle [line 231]

void setTickStyle(
int
$style)

Change ticks style

Parameters:

int

$style

Ticks style

[ Top ]

method setTitleAlignment [line 364]

void setTitleAlignment(
int
$alignment)

Change title alignment

Parameters:

int

$alignment

New Alignment

[ Top ]

method setTitlePosition [line 397]

void setTitlePosition(
float
$position)

Change title position on the axis

Parameters:

float

$position

A new awposition between 0 and 1

[ Top ]

method setXCenter [line 473]

void setXCenter(
&$axis
&$axis, float
$value)

Center X values of the axis

Parameters:

float	$value	The reference value on the axis
&$axis	&$axis	An axis

[ Top ]

method setYCenter [line 495]

void setYCenter(
&$axis
&$axis, float
$value)

Center Y values of the axis

Parameters:

float	$value	The reference value on the axis
&$axis	&$axis	An axis

[ Top ]

method show [line 170]

void show(
[bool
$show = TRUE])

Show axis

Parameters:

bool

$show

[ Top ]

method tick [line 180]

Tick tick(
string
$name)

Return a tick object from its name

Parameters:

string

$name

Tick object name

[ Top ]

method toPosition [line 347]

Point toPosition(
&$xAxis
&$xAxis, &$yAxis
&$yAxis, $p
$p)

Get the position of a point

Tags:

return:

Position on the axis

Parameters:

&$xAxis	&$xAxis	X axis
&$yAxis	&$yAxis	Y axis
$p	$p	Position of the point

[ Top ]

method __clone [line 748]

void __clone(
)

[ Top ]

Class: awAxis

Class Overview

Variables

Methods

Class Details

Class Variables

$auto = TRUE

$color =

$hide = FALSE

$label =

$labelNumber =

$line =

$padding =

$range =

$rangeCallback = array( 'toValue' => 'toProportionalValue', 'toPosition' => 'toProportionalPosition' )

$ticks = array()

$title =

$titlePosition = 0.5

Class Methods

constructor awAxis [line 113]

Parameters:

method addTick [line 196]

Parameters:

method auto [line 143]

Parameters:

method autoScale [line 592]

method deleteTick [line 207]

Parameters:

method draw [line 569]

Parameters:

method drawLabels [line 701]

Parameters:

method drawTicks [line 692]

Parameters:

method getDistance [line 518]

Parameters:

method getLabelNumber [line 304]

method getPadding [line 426]

method getPointFromPosition [line 550]

Parameters:

method getPointFromValue [line 533]

Parameters:

method getRange [line 450]

method getVector [line 728]

method hide [line 161]

Parameters:

method hideTicks [line 218]

Parameters:

method isAuto [line 152]

method line [line 683]

Parameters:

method reverseTickStyle [line 266]

method setColor [line 406]

Parameters:

method setLabelInterval [line 283]

Parameters:

method setLabelNumber [line 294]

Parameters:

method setLabelPrecision [line 313]

Parameters:

method setLabelText [line 327]

Parameters:

method setNumberByTick [line 259]

Parameters:

method setPadding [line 417]

Parameters:

method setRange [line 436]

Parameters:

method setRangeCallback [line 460]

Parameters:

method setTickInterval [line 244]

Parameters:

method setTickStyle [line 231]

Parameters:

method setTitleAlignment [line 364]

Parameters:

method setTitlePosition [line 397]

Parameters:

method setXCenter [line 473]

Parameters:

$rangeCallback = array(
'toValue' => 'toProportionalValue',
'toPosition' => 'toProportionalPosition'
)