linea21-externals
[ class tree: linea21-externals ] [ index: linea21-externals ] [ all elements ]

Class: awAxis

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

Class Overview


Handle axis


Variables

Methods



Class Details

[line 18]
Handle axis



[ Top ]


Class Variables

$auto =  TRUE

[line 95]

Auto-scaling mode



Tags:

access:  protected

Type:   bool


[ Top ]

$color =

[line 67]

Axis and ticks color



Tags:

access:  protected

Type:   Color


[ Top ]

$hide =  FALSE

[line 88]

Hide axis



Tags:

access:  protected

Type:   bool


[ Top ]

$label =

[line 32]

Axis labels



Tags:

access:  public

Type:   Label


[ Top ]

$labelNumber =

[line 53]

Labels number



Tags:

access:  protected

Type:   int


[ Top ]

$line =

[line 25]

Axis line



Tags:

access:  public

Type:   Line


[ Top ]

$padding =

[line 74]

Axis left and right padding



Tags:

access:  protected

Type:   Side


[ Top ]

$range =

[line 81]

Axis range



Tags:

access:  protected

Type:   array


[ Top ]

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

[line 102]

Axis range callback function



Tags:

access:  protected

Type:   array


[ Top ]

$ticks = array()

[line 60]

Axis ticks



Tags:

access:  protected

Type:   array


[ Top ]

$title =

[line 39]

Axis title



Tags:

access:  public

Type:   Label


[ Top ]

$titlePosition =  0.5

[line 46]

Title position



Tags:

access:  protected

Type:   float


[ Top ]



Class Methods


static method toPosition [line 377]

static Point toPosition( awAxis $xAxis, awAxis $yAxis, awPoint $p)

Get the position of a point



Tags:

return:  Position on the axis
access:  public


Parameters:

awAxis   $xAxis   X axis
awAxis   $yAxis   Y axis
awPoint   $p   Position of the point

[ Top ]

constructor __construct [line 113]

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

Build the axis



Tags:

access:  public


Parameters:

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

[ Top ]

method addTick [line 199]

void addTick( string $name, awTick $tick)

Add a tick object



Tags:

access:  public


Parameters:

string   $name   Tick object name
awTick   $tick   Tick object

[ Top ]

method auto [line 143]

void auto( bool $auto)

Enable/disable auto-scaling mode



Tags:

access:  public


Parameters:

bool   $auto  

[ Top ]

method autoScale [line 622]

void autoScale( )



Tags:

access:  public


[ Top ]

method deleteTick [line 213]

void deleteTick( string $name)

Delete a tick object



Tags:

access:  public


Parameters:

string   $name   Tick object name

[ Top ]

method draw [line 599]

void draw( awDriver $driver)

Draw axis



Tags:

access:  public


Parameters:

awDriver   $driver   A driver

[ Top ]

method drawLabels [line 731]

void drawLabels( $driver)



Tags:

access:  protected


Parameters:

   $driver  

[ Top ]

method drawTicks [line 722]

void drawTicks( awDriver $driver, awVector $vector)



Tags:

access:  protected


Parameters:

awDriver   $driver  
awVector   $vector  

[ Top ]

method getDistance [line 548]

Point getDistance( float $from, float $to)

Get the distance between to values on the axis



Tags:

access:  public


Parameters:

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

[ Top ]

method getLabelNumber [line 334]

int getLabelNumber( )

Get number of labels



Tags:

access:  public


[ Top ]

method getPadding [line 456]

Side getPadding( )

Get axis padding



Tags:

access:  public


[ Top ]

method getPointFromPosition [line 580]

Point getPointFromPosition( float $position)

Get a point on the axis from a position



Tags:

access:  protected


Parameters:

float   $position   A position between 0 and 1

[ Top ]

method getPointFromValue [line 563]

Point getPointFromValue( float $value)

Get a point on the axis from a value



Tags:

access:  protected


Parameters:

float   $value  

[ Top ]

method getRange [line 480]

array getRange( )

Get axis range



Tags:

access:  public


[ Top ]

method getVector [line 758]

void getVector( )



Tags:

access:  protected


[ Top ]

method hide [line 161]

void hide( [bool $hide = TRUE])

Hide axis



Tags:

access:  public


Parameters:

bool   $hide  

[ Top ]

method hideTicks [line 224]

void hideTicks( [bool $hide = TRUE])

Hide all ticks



Tags:

access:  public


Parameters:

bool   $hide   Hide or not ?

[ Top ]

method isAuto [line 152]

bool isAuto( )

Get auto-scaling mode status



Tags:

access:  public


[ Top ]

method line [line 713]

void line( awDriver $driver)



Tags:

access:  protected


Parameters:

awDriver   $driver  

[ Top ]

method reverseTickStyle [line 287]

void reverseTickStyle( )

Reverse ticks style



Tags:

access:  public


[ Top ]

method setColor [line 436]

void setColor( awColor $color)

Change axis and axis title color



Tags:

access:  public


Parameters:

awColor   $color  

[ Top ]

method setLabelInterval [line 313]

void setLabelInterval( int $interval)

Change interval of labels



Tags:

access:  public


Parameters:

int   $interval   Interval

[ Top ]

method setLabelNumber [line 324]

void setLabelNumber( int $number)

Change number of labels



Tags:

access:  public


Parameters:

int   $number   Number of labels to display (can be NULL)

[ Top ]

method setLabelPrecision [line 343]

void setLabelPrecision( int $precision)

Change precision of labels



Tags:

access:  public


Parameters:

int   $precision   Precision

[ Top ]

method setLabelText [line 357]

void setLabelText( array $texts)

Change text of labels



Tags:

access:  public


Parameters:

array   $texts   Some texts

[ Top ]

method setNumberByTick [line 280]

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

Change number of ticks relative to others ticks



Tags:

access:  public


Parameters:

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

[ Top ]

method setPadding [line 447]

void setPadding( int $left, int $right)

Change axis padding



Tags:

access:  public


Parameters:

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

[ Top ]

method setRange [line 466]

void setRange( float $min, float $max)

Change axis range



Tags:

access:  public


Parameters:

float   $min  
float   $max  

[ Top ]

method setRangeCallback [line 490]

void setRangeCallback( string $toValue, string $toPosition)

Change axis range callback function



Tags:

access:  public


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

void setTickInterval( int $interval)

Change ticks interval



Tags:

access:  public


Parameters:

int   $interval   Ticks interval

[ Top ]

method setTickStyle [line 242]

void setTickStyle( int $style)

Change ticks style



Tags:

access:  public


Parameters:

int   $style   Ticks style

[ Top ]

method setTitleAlignment [line 394]

void setTitleAlignment( int $alignment)

Change title alignment



Tags:

access:  public


Parameters:

int   $alignment   New Alignment

[ Top ]

method setTitlePosition [line 427]

void setTitlePosition( float $position)

Change title position on the axis



Tags:

access:  public


Parameters:

float   $position   A new awposition between 0 and 1

[ Top ]

method setXCenter [line 503]

void setXCenter( awAxis $axis, float $value)

Center X values of the axis



Tags:

access:  public


Parameters:

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

[ Top ]

method setYCenter [line 525]

void setYCenter( awAxis $axis, float $value)

Center Y values of the axis



Tags:

access:  public


Parameters:

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

[ Top ]

method show [line 170]

void show( [bool $show = TRUE])

Show axis



Tags:

access:  public


Parameters:

bool   $show  

[ Top ]

method tick [line 180]

Tick tick( string $name)

Return a tick object from its name



Tags:

access:  public


Parameters:

string   $name   Tick object name

[ Top ]

method __clone [line 778]

void __clone( )



Tags:

access:  public


[ Top ]


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