y_axis_base Class Reference

Inherited by y_axis, and y_axis_right.

Public Member Functions
	y_axis_base ()
	set_stroke ($s)
	set_tick_length ($val)
	set_colours ($colour, $grid_colour)
	set_colour ($colour)
	set_grid_colour ($colour)
	set_range ($min, $max, $steps=1)
	range ($min, $max, $steps=1)
	set_offset ($off)
	set_labels ($labels)
	set_label_text ($text)
	set_steps ($steps)
	set_vertical ()

---

Member Function Documentation

range	(	$	min,
		$	max,
		$	steps = 1
	)

Sugar for set_range

set_colour

(

$

colour

)

set_colours	(	$	colour,
		$	grid_colour
	)

set_grid_colour

(

$

colour

)

Reimplemented in y_axis.

set_label_text

(

$

text

)

Pass in some text for each label. This can contain magic variables "#val#" which will get replaced with the value for that Y axis label. Useful for:

• "£#val#"
• "#val#%"
• "#val# million"

Parameters:

$text

as string.

set_labels

(

$

labels

)

Parameters:

$labels

as an array of string values.

By default the Y axis will show from min to max, but you can override this by passing in your own labels. Remember the Y axis min is at the bottom, so the labels will go from bottom to top.

set_offset

(

$

off

)

Parameters:

$off

as Boolean. If true the Y axis is nudged up half a step.

set_range	(	$	min,
		$	max,
		$	steps = 1
	)

Set min and max values, also (optionally) set the steps value. You can reverse the chart by setting min larger than max, e.g. min = 10 and max = 0.

Parameters:

	$min	as integer
	$max	as integer
	$steps	as integer.

set_steps

(

$

steps

)

Parameters:

$steps

as integer.

Only show every $steps label, e.g. every 10th

set_stroke

(

$

s

)

Parameters:

$s

as integer, thickness of the Y axis line

set_tick_length

(

$

val

)

Parameters:

$val

as integer. The length of the ticks in pixels

set_vertical

(

)

Make the labels show vertical

y_axis_base

(

)

---

The documentation for this class was generated from the following file:

• php-ofc-library/ofc_y_axis_base.php