class Chart (View source)

Properties

$type
$label
$datatable
$deferedRender

Methods

__construct( string $chartLabel)

Builds a new chart with a label.

this
customize( array $optionArray)

Sets any configuration option, with no checks for type / validity

setOptions( array $o)

Sets configuration options from array of values

array
getOptions()

Gets the current chart options.

mixed
getOption( string $o)

Gets a specific option from the array.

bool
hasEvents()

Checks if any events have been assigned to the chart.

bool
getEvents()

Checks if any events have been assigned to the chart.

string
getDataTableJson()

Returns a JSON string representation of the datatable.

backgroundColor( BackgroundColor $bc)

The background color for the main area of the chart. Can be either a simple HTML color string, for example: 'red' or '#00cc00', or a backgroundColor object

chartArea( ChartArea $ca)

An object with members to configure the placement and size of the chart area (where the chart itself is drawn, excluding axis and legends).

colors( array $cArr)

The colors to use for the chart elements. An array of strings, where each element is an HTML color string, for example: colors:['red','#004411'].

datatable( DataTable $d)

Assigns wich Datatable will be used for this Chart.

void
deferedRender( bool $dr)

Set up the chart with no datatable to defer rendering via AJAX

events( array $e)

Register javascript callbacks for specific events.

fontSize( int $fs)

The default font size, in pixels, of all text in the chart. You can override this using properties for specific chart elements.

fontName( string $fn)

The default font face for all text in the chart. You can override this using properties for specific chart elements.

height( int $h)

Height of the chart, in pixels.

legend( Legend $l)

An object with members to configure various aspects of the legend. To specify properties of this object, create a new legend() object, set the values then pass it to this function or to the constructor.

string
optionsToJson()

Returns a JSON string representation of the chart's properties.

string
render( string $ei)

Outputs the chart javascript into the page

title( string $t)

Text to display above the chart.

titlePosition( string $tp)

Where to place the chart title, compared to the chart area. Supported values: 'in' - Draw the title inside the chart area.

titleTextStyle( TextStyle $ts)

An object that specifies the title text style. create a new textStyle() object, set the values then pass it to this function or to the constructor.

tooltip( Tooltip $t)

An object with members to configure various tooltip elements. To specify properties of this object, create a new tooltip() object, set the values then pass it to this function or to the constructor.

width( int $w)

Width of the chart, in pixels.

Details

at line 46
__construct( string $chartLabel)

Builds a new chart with a label.

Parameters

string $chartLabel Label for the chart accessed via the Volcano.

at line 87
this customize( array $optionArray)

Sets any configuration option, with no checks for type / validity

This is more or less a bandaid to remove the handcuffs from users who want to add options that Google has added, that I have not. I didn't intend to restrict the user to only select options, as the goal was to type check and validate. This method can be used to set any option, just pass in arrays with key value pairs for any setting.

If the setting is an object, per the google docs, then use multi-dimensional arrays and they will be converted upon rendering.

This method will most likely be brought into 3.0 to prevent BC breaks, but I will incorporate the same functionality without the need for the extra customize() method call.

Parameters

array $optionArray

Return Value

this

at line 136
Chart setOptions( array $o)

Sets configuration options from array of values

You can set the options all at once instead of passing them individually or chaining the functions from the chart objects.

Parameters

array $o

Return Value

Chart

Exceptions

InvalidConfigProperty
InvalidConfigValue

at line 164
array getOptions()

Gets the current chart options.

Return Value

array

at line 176
mixed getOption( string $o)

Gets a specific option from the array.

Parameters

string $o Which option to fetch

Return Value

mixed

Exceptions

InvalidConfigValue

at line 194
bool hasEvents()

Checks if any events have been assigned to the chart.

Return Value

bool

at line 204
bool getEvents()

Checks if any events have been assigned to the chart.

Return Value

bool

at line 215
string getDataTableJson()

Returns a JSON string representation of the datatable.

Return Value

string

at line 229
Chart backgroundColor( BackgroundColor $bc)

The background color for the main area of the chart. Can be either a simple HTML color string, for example: 'red' or '#00cc00', or a backgroundColor object

Parameters

BackgroundColor $bc

Return Value

Chart

at line 245
Chart chartArea( ChartArea $ca)

An object with members to configure the placement and size of the chart area (where the chart itself is drawn, excluding axis and legends).

Two formats are supported: a number, or a number followed by %. A simple number is a value in pixels; a number followed by % is a percentage.

Parameters

ChartArea $ca

Return Value

Chart

at line 259
Chart colors( array $cArr)

The colors to use for the chart elements. An array of strings, where each element is an HTML color string, for example: colors:['red','#004411'].

Parameters

array $cArr

Return Value

Chart

Exceptions

InvalidConfigValue

at line 285
Chart datatable( DataTable $d)

Assigns wich Datatable will be used for this Chart.

If a label is provided then the defined Datatable will be used. If called with no argument, or the chart is attempted to be generated without calling this function, the chart will search for a Datatable with the same label as the Chart.

Parameters

DataTable $d

Return Value

Chart

at line 301
void deferedRender( bool $dr)

Set up the chart with no datatable to defer rendering via AJAX

Parameters

bool $dr

Return Value

void

Exceptions

InvalidElementId

at line 327
Chart events( array $e)

Register javascript callbacks for specific events.

Valid values include: [ animationfinish | error | onmouseover | onmouseout | ready | select ] associated to a respective pre-defined javascript function as the callback.

Parameters

array $e Array of events associated to a callback

Return Value

Chart

Exceptions

InvalidConfigValue

at line 368
Chart fontSize( int $fs)

The default font size, in pixels, of all text in the chart. You can override this using properties for specific chart elements.

Parameters

int $fs

Return Value

Chart

Exceptions

InvalidConfigValue

at line 389
Chart fontName( string $fn)

The default font face for all text in the chart. You can override this using properties for specific chart elements.

Parameters

string $fn

Return Value

Chart

Exceptions

InvalidConfigValue

at line 409
Chart height( int $h)

Height of the chart, in pixels.

Parameters

int $h

Return Value

Chart

Exceptions

InvalidConfigValue

at line 432
Chart legend( Legend $l)

An object with members to configure various aspects of the legend. To specify properties of this object, create a new legend() object, set the values then pass it to this function or to the constructor.

Parameters

Legend $l

Return Value

Chart

Exceptions

InvalidConfigValue

at line 442
string optionsToJson()

Returns a JSON string representation of the chart's properties.

Return Value

string

at line 459
string render( string $ei)

Outputs the chart javascript into the page

Pass in a string of the html elementID that you want the chart to be rendered into.

Parameters

string $ei The id of an HTML element to render the chart into.

Return Value

string Javscript code blocks

Exceptions

InvalidElementId

at line 474
Chart title( string $t)

Text to display above the chart.

Parameters

string $t

Return Value

Chart

Exceptions

InvalidConfigValue

at line 497
Chart titlePosition( string $tp)

Where to place the chart title, compared to the chart area. Supported values: 'in' - Draw the title inside the chart area.

'out' - Draw the title outside the chart area. 'none' - Omit the title.

Parameters

string $tp

Return Value

Chart

Exceptions

InvalidConfigValue

at line 526
Chart titleTextStyle( TextStyle $ts)

An object that specifies the title text style. create a new textStyle() object, set the values then pass it to this function or to the constructor.

Parameters

TextStyle $ts

Return Value

Chart

Exceptions

InvalidConfigValue

at line 542
Chart tooltip( Tooltip $t)

An object with members to configure various tooltip elements. To specify properties of this object, create a new tooltip() object, set the values then pass it to this function or to the constructor.

Parameters

Tooltip $t

Return Value

Chart

Exceptions

InvalidConfigValue

at line 555
Chart width( int $w)

Width of the chart, in pixels.

Parameters

int $w

Return Value

Chart

Exceptions

InvalidConfigValue