class ComboChart extends Chart (View source)

Properties

$type
$label from  Chart
$datatable from  Chart
$deferedRender from  Chart

Methods

__construct($c)

Builds a new chart with a label.

this
customize( array $optionArray)

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

from  Chart
setOptions( array $o)

Sets configuration options from array of values

from  Chart
array
getOptions()

Gets the current chart options.

from  Chart
mixed
getOption( string $o)

Gets a specific option from the array.

from  Chart
bool
hasEvents()

Checks if any events have been assigned to the chart.

from  Chart
bool
getEvents()

Checks if any events have been assigned to the chart.

from  Chart
string
getDataTableJson()

Returns a JSON string representation of the datatable.

from  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

from  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).

from  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'].

from  Chart
datatable( DataTable $d)

Assigns wich Datatable will be used for this Chart.

from  Chart
void
deferedRender( bool $dr)

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

from  Chart
events( array $e)

Register javascript callbacks for specific events.

from  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.

from  Chart
fontName( string $fn)

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

from  Chart
height( int $h)

Height of the chart, in pixels.

from  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.

from  Chart
string
optionsToJson()

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

from  Chart
string
render( string $ei)

Outputs the chart javascript into the page

from  Chart
title( string $t)

Text to display above the chart.

from  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.

from  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.

from  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.

from  Chart
width( int $w)

Width of the chart, in pixels.

from  Chart
annotations( Annotation $a)

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

areaOpacity( float $o)

The default opacity of the colored area under an area chart series, where 0.0 is fully transparent and 1.0 is fully opaque. To specify opacity for an individual series, set the areaOpacity value in the series property.

axisTitlesPosition( string $p)

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

barGroupWidth( int|string $b)

The width of a group of bars, specified in either of these formats: - Pixels (e.g. 50).

hAxis( HorizontalAxis $h)

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

isStacked( bool $i)

If set to true, series elements are stacked.

series( array $a)

An array of objects, each describing the format of the corresponding series in the chart. To use default values for a series, specify an null in the array.

seriesType( string $t)

The default line type for any series not specified in the series property.

vAxes( array $a)

Specifies properties for individual vertical axes

vAxis( VerticalAxis $v)

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

Details

at line 35
__construct($c)

Builds a new chart with a label.

Parameters

$c

in Chart 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

in Chart 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

in Chart at line 164
array getOptions()

Gets the current chart options.

Return Value

array

in Chart 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

in Chart at line 194
bool hasEvents()

Checks if any events have been assigned to the chart.

Return Value

bool

in Chart at line 204
bool getEvents()

Checks if any events have been assigned to the chart.

Return Value

bool

in Chart at line 215
string getDataTableJson()

Returns a JSON string representation of the datatable.

Return Value

string

in Chart 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

in 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

in 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

in Chart 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

in 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

in Chart 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

in Chart 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

in Chart 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

in Chart at line 409
Chart height( int $h)

Height of the chart, in pixels.

Parameters

int $h

Return Value

Chart

Exceptions

InvalidConfigValue

in Chart 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

in Chart at line 442
string optionsToJson()

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

Return Value

string

in Chart 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

in Chart at line 474
Chart title( string $t)

Text to display above the chart.

Parameters

string $t

Return Value

Chart

Exceptions

InvalidConfigValue

in Chart 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

in Chart 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

in Chart 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

in Chart at line 555
Chart width( int $w)

Width of the chart, in pixels.

Parameters

int $w

Return Value

Chart

Exceptions

InvalidConfigValue

at line 65
ComboChart annotations( Annotation $a)

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

out - Draw the axis titles outside the chart area. none - Omit the axis titles.

Parameters

Annotation $a

Return Value

ComboChart

Exceptions

InvalidConfigValue

at line 79
ComboChart areaOpacity( float $o)

The default opacity of the colored area under an area chart series, where 0.0 is fully transparent and 1.0 is fully opaque. To specify opacity for an individual series, set the areaOpacity value in the series property.

Parameters

float $o

Return Value

ComboChart

Exceptions

InvalidConfigValue

at line 102
ComboChart axisTitlesPosition( string $p)

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

out - Draw the axis titles outside the chart area. none - Omit the axis titles.

Parameters

string $p

Return Value

ComboChart

Exceptions

InvalidConfigValue

at line 131
ComboChart barGroupWidth( int|string $b)

The width of a group of bars, specified in either of these formats: - Pixels (e.g. 50).

  • Percentage of the available width for each group (e.g. '20%'), where '100%' means that groups have no space between them.

Parameters

int|string $b

Return Value

ComboChart

Exceptions

InvalidConfigValue

at line 154
ComboChart hAxis( HorizontalAxis $h)

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

Parameters

HorizontalAxis $h

Return Value

ComboChart

Exceptions

InvalidConfigValue

at line 166
ComboChart isStacked( bool $i)

If set to true, series elements are stacked.

Parameters

bool $i

Return Value

ComboChart

Exceptions

InvalidConfigValue

at line 187
ComboChart series( array $a)

An array of objects, each describing the format of the corresponding series in the chart. To use default values for a series, specify an null in the array.

If a series or a value is not specified, the global value will be used.

Parameters

array $a

Return Value

ComboChart

Exceptions

InvalidConfigValue

at line 209
ComboChart seriesType( string $t)

The default line type for any series not specified in the series property.

Available values are: 'line', 'area', 'bars', 'candlesticks' and 'steppedArea'

Parameters

string $t

Return Value

ComboChart

Exceptions

InvalidConfigValue

at line 245
ComboChart vAxes( array $a)

Specifies properties for individual vertical axes

If the chart has multiple vertical axes. Each child object is a vAxis object, and can contain all the properties supported by vAxis. These property values override any global settings for the same property.

To specify a chart with multiple vertical axes, first define a new axis using series.targetAxisIndex, then configure the axis using vAxes.

Parameters

array $a Array of VerticalAxis objects

Return Value

ComboChart

Exceptions

InvalidConfigValue

at line 268
ComboChart vAxis( VerticalAxis $v)

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

Parameters

VerticalAxis $v

Return Value

ComboChart

Exceptions

InvalidConfigValue