bar_base Class Reference

Inherited by bar, bar, bar_3d, bar_cylinder, bar_cylinder_outline, bar_dome, bar_filled, bar_glass, bar_round, bar_round3d, bar_rounded_glass, bar_sketch, bar_stack, and candle.

Public Member Functions
	bar_base ()
	set_key ($text, $size)
	key ($text, $size)
	set_values ($v)
	append_value ($v)
	set_colour ($colour)
	colour ($colour)
	set_alpha ($alpha)
	set_tooltip ($tip)
	set_on_show ($on_show)
	set_on_click ($text)
	attach_to_right_y_axis ()

---

Member Function Documentation

append_value

(

$

v

)

see set_values

attach_to_right_y_axis

(

)

bar_base

(

)

colour

(

$

colour

)

syntatical sugar

key	(	$	text,
		$	size
	)

syntatical sugar.

set_alpha

(

$

alpha

)

Parameters:

$alpha

as real number (range 0 to 1), e.g. 0.5 is half transparent

set_colour

(

$

colour

)

Parameters:

$colour

as string, a HEX colour, e.g. 'ff0000' red

set_key	(	$	text,
		$	size
	)

Parameters:

	$text	as string the key text
	$size	as integer, size in pixels

set_on_click

(

$

text

)

set_on_show

(

$

on_show

)

Parameters:

$on_show

as line_on_show object

set_tooltip

(

$

tip

)

Parameters:

$tip

as string, the tip to show. May contain various magic variables.

set_values

(

$

v

)

Parameters:

$v

as an array, a mix of: a bar_value class. You can use this to customise the paramters of each bar. integer. This is the Y position of the top of the bar.

---

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

• php-ofc-library/trunk/ofc_bar_base.php