Chart
class Chart extends JsonConfig (View source)
Chart Class, Parent to all charts.
Has common properties and methods used between all the different charts.
Methods
Builds a new chart with the given label.
Shortcut method to set the value of an option and return $this.
Parses the config array by passing the values through each method to check validity against if the option exists.
Returns the chart type.
Checks if any events have been assigned to the chart.
Retrieves the events if any have been assigned to the chart.
Sets any configuration option, with no checks for type / validity
Returns the DataTable
Returns a JSON string representation of the datatable.
Outputs the chart javascript into the page.
The background color for the main area of the chart.
An object with members to configure the placement and size of the chart area (where the chart itself is drawn, excluding axis and legends).
An object with members to configure various aspects of the legend.
Where to place the chart title, compared to the chart area.
Details
at line 94
__construct(
Label $chartLabel,
DataTable $datatable,
Options $options,
array $config = array())
Builds a new chart with the given label.
in
JsonConfig at line 64
mixed
__get(
string $option)
Get the value of a set option via magic method.
in
JsonConfig at line 75
Options
getOptions()
Gets the Options object for the JsonConfig
in
JsonConfig at line 90
JsonConfig
setOption(
string $option,
mixed $value)
Shortcut method to set the value of an option and return $this.
In order to maintain backwards compatibility, ConfigObjects will be unwrapped.
in
JsonConfig at line 106
setOptions(
array $config)
Parses the config array by passing the values through each method to check validity against if the option exists.
in
JsonConfig at line 275
array
jsonSerialize()
Custom serialization of the JsonConfig object.
at line 111
string
getType()
Returns the chart type.
at line 122
bool
hasEvents()
Checks if any events have been assigned to the chart.
at line 133
EventManager
getEvents()
Retrieves the events if any have been assigned to the chart.
at line 145
Label
getLabel()
Returns the chart label.
at line 164
Chart
events(
array $events)
Register javascript callbacks for specific events.
Set with an associative array where the keys are events and the values are the javascript callback functions.
Valid events are: [ animationfinish | error | onmouseover | onmouseout | ready | select | statechange ]
at line 196
Chart
datatable(
DataTable $datatable)
Assigns a datatable to use for the Chart.
at line 221
Chart
customize(
array $optionArray)
Sets any configuration option, with no checks for type / validity
This is method was added in 2.5 as 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.
at line 234
DataTable
getDataTable()
Returns the DataTable
at line 251
string
getDataTableJson()
Returns a JSON string representation of the datatable.
at line 271
string
render(
string $elemId)
Outputs the chart javascript into the page.
Pass in a string of the html elementID that you want the chart to be rendered into.
at line 290
Chart
animation(
array $animationConfig)
Set the animation options for a chart.
at line 304
Chart
backgroundColor(
array $backgroundColorConfig)
The background color for the main area of the chart.
Can be a simple HTML color string, or hex code, for example: 'red' or '#00cc00'
at line 321
Chart
chartArea(
array $chartAreaConfig)
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.
at line 338
Chart
colors(
array $colorArray)
The colors to use for the chart elements.
An array of strings, where each element is an HTML color string for example:['red','#004411']
at line 362
Chart
fontSize(
integer $fontSize)
The default font size, in pixels, of all text in the chart.
You can override this using properties for specific chart elements.
at line 378
Chart
fontName(
string $fontName)
The default font face for all text in the chart.
You can override this using properties for specific chart elements.
at line 392
Chart
height(
int $height)
Height of the chart, in pixels.
at line 408
Chart
legend(
array $legendConfig)
An object with members to configure various aspects of the legend.
To specify properties of this object, pass in an array of valid options.
at line 422
Chart
title(
string $title)
Text to display above the chart.
at line 441
Chart
titlePosition(
string $titlePosition)
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.
at line 461
Chart
titleTextStyle(
TextStyle $textStyle)
An array of options for defining the title text style.
at line 474
Chart
tooltip(
array $tooltip)
An object with members to configure various tooltip elements.
at line 486
Chart
width(
int $width)
Width of the chart, in pixels.