Class: Image_Graph_Axis_Category

Source Location: /Image_Graph-0.8.0/Graph/Axis/Category.php

Class Overview

Image_Graph_Common
   |
   --Image_Graph_Element
      |
      --Image_Graph_Plotarea_Element
         |
         --Image_Graph_Axis
            |
            --Image_Graph_Axis_Category

A normal axis thats displays labels with a 'interval' of 1.

Author(s):

Stefan Neufeind <pear.neufeind at speedpartner.de>
Jesper Veggerby <pear.nosey at veggerby.dk>

Version:

Release: 0.8.0

Copyright:

2003-2009 The PHP Group

Child classes:

Image_Graph_Axis_Radar: Displays an 'X'-axis in a radar plot chart.

Inherited Variables

Inherited Methods

Class: Image_Graph_Axis

Image_Graph_Axis::Image_Graph_Axis(): Image_Graph_Axis [Constructor].
Image_Graph_Axis::addMark(): Adds a mark to the axis at the specified value
Image_Graph_Axis::forceMaximum(): Forces the maximum value of the axis
Image_Graph_Axis::forceMinimum(): Forces the minimum value of the axis
Image_Graph_Axis::hideArrow(): Do not show an arrow head on the 'end' of the axis (default)
Image_Graph_Axis::setAxisIntersection(): Set axis intersection.
Image_Graph_Axis::setDataPreProcessor(): Sets a data preprocessor for formatting the axis labels
Image_Graph_Axis::setFixedSize(): Sets a fixed "size" for the axis.
Image_Graph_Axis::setInverted(): Invert the axis direction
Image_Graph_Axis::setLabelInterval(): Sets an interval for when labels are shown on the axis.
Image_Graph_Axis::setLabelOption(): Sets options for the label at a specific level.
Image_Graph_Axis::setLabelOptions(): Sets options for the label at a specific level.
Image_Graph_Axis::setTickOptions(): Set the major tick appearance.
Image_Graph_Axis::setTitle(): Sets the title of this axis.
Image_Graph_Axis::showArrow(): Show an arrow head on the 'end' of the axis
Image_Graph_Axis::showLabel(): Shows a label for the the specified values.

Class: Image_Graph_Element

Image_Graph_Element::height(): The height of the element on the canvas
Image_Graph_Element::setBackground(): Sets the background fill style of the element
Image_Graph_Element::setBackgroundColor(): Sets the background color of the element.
Image_Graph_Element::setBorderColor(): Sets the border color of the element.
Image_Graph_Element::setBorderStyle(): Sets the border line style of the element
Image_Graph_Element::setFillColor(): Sets the fill color of the element.
Image_Graph_Element::setFillStyle(): Sets the fill style of the element
Image_Graph_Element::setFont(): Sets the font of the element
Image_Graph_Element::setFontAngle(): Sets the font angle
Image_Graph_Element::setFontColor(): Sets the font color
Image_Graph_Element::setFontSize(): Sets the font size
Image_Graph_Element::setLineColor(): Sets the line color of the element.
Image_Graph_Element::setLineStyle(): Sets the line style of the element
Image_Graph_Element::setPadding(): Sets padding of the element
Image_Graph_Element::showShadow(): Shows shadow on the element
Image_Graph_Element::width(): The width of the element on the canvas
Image_Graph_Element::write(): Writes text to the canvas.
Image_Graph_Element::_clip(): Clip the canvas to the coordinates of the element

Class: Image_Graph_Common

Image_Graph_Common::Image_Graph_Common(): Constructor [Image_Graph_Common]
Image_Graph_Common::add(): Adds an element to the objects element list.
Image_Graph_Common::addNew(): Creates an object from the class and adds it to the objects element list.
Image_Graph_Common::hide(): Hide the element

Class Details

[line 53]
A normal axis thats displays labels with a 'interval' of 1.

This is basically a normal axis where the range is the number of labels defined, that is the range is explicitly defined when constructing the axis.

Author: Stefan Neufeind <pear.neufeind@speedpartner.de>
Author: Jesper Veggerby <pear.nosey@veggerby.dk>
Version: Release: 0.8.0
Copyright: 2003-2009 The PHP Group
Link: http://pear.php.net/package/Image_Graph
License: LGPL License 2.1

[ Top ]

Method Detail

Image_Graph_Axis_Category (Constructor) [line 68]

Image_Graph_Axis_Category Image_Graph_Axis_Category(
[int
$type = IMAGE_GRAPH_AXIS_X])

Image_Graph_Axis_Category [Constructor].

Parameters:

int $type — The type (direction) of the Axis

[ Top ]

forceMaximum [line 164]

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

Forces the maximum value of the axis

A maximum cannot be set on this type of axis

To modify the labels which are displayed on the axis, instead use setLabelInterval($labels) where $labels is an array containing the values/labels the axis should display. Note! Only values in this array will then be displayed on the graph!

Overrides Image_Graph_Axis::forceMaximum() (Forces the maximum value of the axis)

Parameters:

double	`$maximum`	—	A maximum cannot be set on this type of axis
bool	`$userEnforce`	—	???

[ Top ]

forceMinimum [line 145]

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

Forces the minimum value of the axis

A minimum cannot be set on this type of axis

Overrides Image_Graph_Axis::forceMinimum() (Forces the minimum value of the axis)

Parameters:

double	`$minimum`	—	A minimum cannot be set on this type of axis
bool	`$userEnforce`	—	???

[ Top ]

setLabelInterval [line 178]

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

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

The label interval is rounded to nearest integer value.

Overrides Image_Graph_Axis::setLabelInterval() (Sets an interval for when labels are shown on the axis.)

Parameters:

double	`$labelInterval`	—	The interval with which labels are shown
int	`$level`	—	Label level

[ Top ]