Docs For Class Image_Graph

Class: Image_Graph_Axis

Class Details

[line 48]
Diplays a normal linear axis (either X- or Y-axis).

Author: Jesper Veggerby <pear.nosey@veggerby.dk>
Version: Release: @package_version@
Copyright: Copyright (C) 2003, 2004 Jesper Veggerby Hansen
Link: http://pear.php.net/package/Image_Graph
License: LGPL License 2.1

Method Detail

Image_Graph_Axis (Constructor) [line 266]

Image_Graph_Axis Image_Graph_Axis(
[int
$type = IMAGE_GRAPH_AXIS_X])

Image_Graph_Axis [Constructor].

Normally a manual creation should not be necessary, axis are created automatically by the Image_Graph_Plotarea constructor unless explicitly defined otherwise

Parameters:

int $type — The type (direction) of the Axis, use IMAGE_GRAPH_AXIS_X for an X-axis (default, may be omitted) and IMAGE_GRAPH_AXIS_Y for Y- axis)

[ Top ]

addMark [line 958]

void addMark(
double
$value, [double
$value2 = false], [
$text = false])

Adds a mark to the axis at the specified value

Parameters:

double	`$value`	—	The value
double	`$value2`	—	The second value (for a ranged mark)
	`$text`	—

[ Top ]

forceMaximum [line 427]

void forceMaximum(
double
$maximum, [bool
$userEnforce = true])

Forces the maximum value of the axis

Overridden in child classes as:

Image_Graph_Axis_Category::forceMaximum(): Forces the maximum value of the axis

Parameters:

double	`$maximum`	—	The maximum value to use on the axis
bool	`$userEnforce`	—	This value should not be set, used internally

[ Top ]

forceMinimum [line 412]

void forceMinimum(
double
$minimum, [bool
$userEnforce = true])

Forces the minimum value of the axis

Overridden in child classes as:

Image_Graph_Axis_Category::forceMinimum(): Forces the minimum value of the axis

Image_Graph_Axis_Logarithmic::forceMinimum(): Forces the minimum value of the axis.

Parameters:

double	`$minimum`	—	The minumum value to use on the axis
bool	`$userEnforce`	—	This value should not be set, used internally

[ Top ]

hideArrow [line 447]

void hideArrow(
)

Do not show an arrow head on the 'end' of the axis (default)

[ Top ]

setAxisIntersection [line 1038]

void setAxisIntersection(
mixed
$intersection, [mixed
$axis = 'default'])

Set axis intersection.

Sets the value at which the axis intersects other axis, fx. at which Y- value the x-axis intersects the y-axis (normally at 0).

Possible values are 'default', 'min', 'max' or a number between axis min and max (the value will automatically be limited to this range).

For a coordinate system with 2 y-axis, the x-axis can either intersect the primary or the secondary y-axis. To make the x-axis intersect the secondary y-axis at a given value pass IMAGE_GRAPH_AXIS_Y_SECONDARY as second parameter.

Since: 0.3.0dev2

Parameters:

mixed	`$intersection`	—	The value at which the axis intersect the 'other' axis
mixed	`$axis`	—	The axis to intersect. Only applies to x-axis with both a primary and secondary y-axis available.

[ Top ]

setDataPreProcessor [line 349]

void setDataPreProcessor(

&$dataPreProcessor, Image_Graph_DataPreprocessor
$dataPreProcessor)

Sets a data preprocessor for formatting the axis labels

See: Image_Graph_DataPreprocessor

Parameters:

Image_Graph_DataPreprocessor	`$dataPreProcessor`	—	The data preprocessor
	`&$dataPreProcessor`	—

[ Top ]

setFixedSize [line 585]

void setFixedSize(
int
$size)

Sets a fixed "size" for the axis.

If the axis is any type of y-axis the size relates to the width of the axis, if an x-axis is concerned the size is the height.

Since: 0.3.0dev5

Parameters:

int $size — The fixed size of the axis

[ Top ]

setInverted [line 1013]

void setInverted(
bool
$invert)

Invert the axis direction

If the minimum values are normally displayed fx. at the bottom setting axis inversion to true, will cause the minimum values to be displayed at the top and maximum at the bottom.

Since: 0.3.0dev3

Parameters:

bool $invert — True if the axis is to be inverted, false if not

[ Top ]

setLabelInterval [line 476]

void setLabelInterval(
[mixed
$labelInterval = 'auto'], [int
$level = 1])

Sets an interval for when labels are shown on the axis.

By default 'auto' is used, forcing the axis to calculate a approximate best label interval to be used. Specify an array to use user-defined values for labels.

Overridden in child classes as:

Image_Graph_Axis_Category::setLabelInterval(): Sets an interval for where labels are shown on the axis.

Parameters:

mixed	`$labelInterval`	—	The interval with which labels are shown
int	`$level`	—	The label level to set the interval on

[ Top ]

setLabelOption [line 520]

void setLabelOption(
string
$option, mixed
$value, [int
$level = 1])

Sets options for the label at a specific level.

Possible options are:

'showtext' true or false whether label text should be shown or not

'showoffset' should the label be shown at an offset, i.e. should the label be shown at a position so that it does not overlap with prior levels. Only applies to multilevel labels with text

'font' The font options as an associated array

'position' The position at which the labels are written ('inside' or 'outside' the axis). NB! This relative position only applies to the default location of the axis, i.e. if an x-axis is inverted then 'outside' still refers to the "left" side of a normal y-axis (since this is normally 'outside') but the actual output will be labels on the "inside"!

'format' To format the label text according to a sprintf statement

'dateformat' To format the label as a date, fx. j. M Y = 29. Jun 2005

Parameters:

string	`$option`	—	The label option name (see detailed description for possible values)
mixed	`$value`	—	The value for the option
int	`$level`	—	The label level to set the interval on

[ Top ]

setLabelOptions [line 538]

void setLabelOptions(
array
$options, [int
$level = 1])

Sets options for the label at a specific level.

The possible options are specified in Image_Graph_Axis::.

Parameters:

array	`$options`	—	An assciated array with label options
int	`$level`	—	The label level to set the interval on

[ Top ]

setTickOptions [line 991]

void setTickOptions(
int
$start, int
$end, [int
$level = 1])

Set the major tick appearance.

The positions are specified in pixels relative to the axis, meaning that a value of -1 for start will draw the major tick 'line' starting at 1 pixel outside (negative) value the axis (i.e. below an x-axis and to the left of a normal y-axis).

Since: 0.3.0dev2

Parameters:

int	`$start`	—	The start position relative to the axis
int	`$end`	—	The end position relative to the axis
int	`$level`	—	The label level to set the tick options for

[ Top ]

setTitle [line 564]

void setTitle(
string
$title, [Image_Graph_Font
$font = false])

Sets the title of this axis.

This is used as an alternative (maybe better) method, than using layout's for axis-title generation.

To use the current propagated font, but just set it vertically, simply pass 'vertical' as second parameter for vertical alignment down-to-up or 'vertical2' for up-to-down alignment.

Since: 0.3.0dev2

Parameters:

string	`$title`	—	The title of this axis
Image_Graph_Font	`$font`	—	The font used for the title

[ Top ]

showArrow [line 439]

void showArrow(
)

Show an arrow head on the 'end' of the axis

[ Top ]

showLabel [line 336]

void showLabel(
int
$value)

Shows a label for the the specified values.

Allowed values are combinations of:

IMAGE_GRAPH_LABEL_MINIMUM
IMAGE_GRAPH_LABEL_ZERO
IMAGE_GRAPH_LABEL_MAXIMUM

By default none of these are shows on the axis

Parameters:

int $value — The values to show labels for

[ Top ]

Class: Image_Graph_Axis

Class Overview

Author(s):

Version:

Copyright:

Methods

Child classes:

Inherited Variables

Inherited Methods

Class: Image_Graph_Element

Class: Image_Graph_Common

Class Details

Method Detail

Image_Graph_Axis (Constructor) [line 266]

Parameters:

addMark [line 958]

Parameters:

forceMaximum [line 427]

Parameters:

forceMinimum [line 412]

Parameters:

hideArrow [line 447]

setAxisIntersection [line 1038]

Parameters:

setDataPreProcessor [line 349]

Parameters:

setFixedSize [line 585]

Parameters:

setInverted [line 1013]

Parameters:

setLabelInterval [line 476]

Parameters:

setLabelOption [line 520]

Parameters:

setLabelOptions [line 538]

Parameters:

setTickOptions [line 991]

Parameters:

setTitle [line 564]

Parameters:

showArrow [line 439]

showLabel [line 336]

Parameters: