dot_base Class Reference

Public Member Functions

dot_base ($type, $value=null)

value ($value)

position ($x, $y)

colour ($colour)

tooltip ($tip)

size ($size)

type ($type)

halo_size ($size)

on_click ($do)

Detailed Description

A private class. All the other line-dots inherit from this. Gives them all some common methods.

colour ( $ colour )

Parameters:

$colour

is a string, HEX colour, e.g. 'FF0000' red

Parameters:

	$type	string
	$value	integer

halo_size ( $ size )

Parameters:

$size

is an integer. The size of the hollow 'halo' around the dot that masks the line.

on_click ( $ do )

Parameters:

$do

as string. One of three options (examples):

"http://example.com" - browse to this URL
"https://example.com" - browse to this URL
"trace:message" - print this message in the FlashDevelop debug pane
all other strings will be called as Javascript functions, so a string "hello_world" will call the JS function "hello_world(index)". It passes in the index of the point.

For scatter charts that require an X and Y position for each point.

Parameters:

	$x	as integer
	$y	as integer

size ( $ size )

Parameters:

$size

is an integer. Size of the dot.

tooltip ( $ tip )

The tooltip for this dot.

type ( $ type )

a private method

value ( $ value )

For line charts that only require a Y position for each point.

Parameters:

$value

as integer, the Y position

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