class PieChart extends Chart (View source)

Properties

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

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

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
is3D( bool $is3D)

If set to true, displays a three-dimensional chart.

slices( array $slices)

An array of slice objects, each describing the format of the corresponding slice in the pie. To use default values for a slice, specify a null. If a slice or a value is not specified, the global value will be used.

pieSliceBorderColor( string $pieSliceBorderColor)

The color of the slice borders. Only applicable when the chart is two-dimensional; is3D == false || null

pieSliceText( string $pieSliceText)

The content of the text displayed on the slice. Can be one of the following:

pieSliceTextStyle( TextStyle $textStyle)

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

pieStartAngle( int $pieStartAngle)

The angle, in degrees, to rotate the chart by. The default of 0 will orient the leftmost edge of the first slice directly up.

reverseCategories( bool $reverseCategories)

If set to true, will draw slices counterclockwise. The default is to draw clockwise.

sliceVisibilityThreshold( int|float $sliceVizThreshold)

The slice relative part, below which a slice will not show individually.

pieResidueSliceColor( string $pieResidueSliceColor)

Color for the combination slice that holds all slices below sliceVisibilityThreshold.

pieResidueSliceLabel( string $pieResidueSliceLabel)

A label for the combination slice that holds all slices below sliceVisibilityThreshold.

Details

at line 28
__construct( string $chartLabel)

Builds a new chart with a label.

Parameters

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

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 56
PieChart is3D( bool $is3D)

If set to true, displays a three-dimensional chart.

Parameters

bool $is3D

Return Value

PieChart

Exceptions

InvalidConfigValue

at line 91
PieChart slices( array $slices)

An array of slice objects, each describing the format of the corresponding slice in the pie. To use default values for a slice, specify a null. If a slice or a value is not specified, the global value will be used.

The values of the array keys will correspond to each numbered piece of the pie, starting from 0. You can skip slices by assigning the keys of the array as (int)s.

This would apply slice values to the first and fourth slice of the pie Example: array( 0 => new Slice(), 3 => new Slice() );

Parameters

array $slices Array of slice objects

Return Value

PieChart

Exceptions

InvalidConfigValue

at line 131
PieChart pieSliceBorderColor( string $pieSliceBorderColor)

The color of the slice borders. Only applicable when the chart is two-dimensional; is3D == false || null

Parameters

string $pieSliceBorderColor Valid HTML color

Return Value

PieChart

Exceptions

InvalidConfigValue

at line 157
PieChart pieSliceText( string $pieSliceText)

The content of the text displayed on the slice. Can be one of the following:

'percentage' - The percentage of the slice size out of the total. 'value' - The quantitative value of the slice. 'label' - The name of the slice. 'none' - No text is displayed.

Parameters

string $pieSliceText

Return Value

PieChart

Exceptions

InvalidConfigValue

at line 187
PieChart pieSliceTextStyle( TextStyle $textStyle)

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

Parameters

TextStyle $textStyle

Return Value

PieChart

Exceptions

InvalidConfigValue

at line 202
PieChart pieStartAngle( int $pieStartAngle)

The angle, in degrees, to rotate the chart by. The default of 0 will orient the leftmost edge of the first slice directly up.

Parameters

int $pieStartAngle Starting angle

Return Value

PieChart

Exceptions

InvalidConfigValue

at line 224
PieChart reverseCategories( bool $reverseCategories)

If set to true, will draw slices counterclockwise. The default is to draw clockwise.

Parameters

bool $reverseCategories

Return Value

PieChart

Exceptions

InvalidConfigValue

at line 248
PieChart sliceVisibilityThreshold( int|float $sliceVizThreshold)

The slice relative part, below which a slice will not show individually.

All slices that have not passed this threshold will be combined to a single slice, whose size is the sum of all their sizes. Default is not to show individually any slice which is smaller than half a degree.

Parameters

int|float $sliceVizThreshold

Return Value

PieChart

Exceptions

InvalidConfigValue

at line 270
PieChart pieResidueSliceColor( string $pieResidueSliceColor)

Color for the combination slice that holds all slices below sliceVisibilityThreshold.

Parameters

string $pieResidueSliceColor

Return Value

PieChart

Exceptions

InvalidConfigValue

at line 293
PieChart pieResidueSliceLabel( string $pieResidueSliceLabel)

A label for the combination slice that holds all slices below sliceVisibilityThreshold.

Parameters

string $pieResidueSliceLabel

Return Value

PieChart

Exceptions

InvalidConfigValue