GaugeChart
class GaugeChart extends Chart (View source)
GaugeChart Class
A gauge with a dial, rendered within the browser using SVG or VML.
Traits
Constants
TYPE |
Javascript chart type.
|
VERSION |
Javascript chart version.
|
VIZ_PACKAGE |
Javascript chart package.
|
VIZ_CLASS |
Google's visualization class name.
|
Methods
Builds a new GaugeChart with the given label, datatable and options.
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.
Sets any configuration option, with no checks for type / validity
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.
The color to use for the green section, in HTML color notation.
The lowest value for a range marked by a green color.
The highest value for a range marked by a green color.
Labels for major tick marks. The number of labels define the number of major ticks in all gauges.
The maximal value of a gauge.
The minimal value of a gauge.
The number of minor tick section in each major tick section.
The color to use for the red section, in HTML color notation.
The lowest value for a range marked by a red color.
The highest value for a range marked by a red color.
The color to use for the yellow section, in HTML color notation.
The lowest value for a range marked by a yellow color.
The highest value for a range marked by a yellow color.
Details
at line 89
__construct(
Label $chartLabel,
DataTable $datatable,
array $config = array())
Builds a new GaugeChart with the given label, datatable and options.
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.
in
Chart at line 111
string
getType()
Returns the chart type.
in
Chart at line 122
bool
hasEvents()
Checks if any events have been assigned to the chart.
in
Chart at line 133
EventManager
getEvents()
Retrieves the events if any have been assigned to the chart.
in
Chart 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 ]
in
Chart at line 196
Chart
datatable(
DataTable $datatable)
Assigns a datatable to use for the Chart.
in
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.
in
Chart at line 251
string
getDataTableJson()
Returns a JSON string representation of the datatable.
in
Chart 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.
in
Chart at line 290
Chart
animation(
array $animationConfig)
Set the animation options for a chart.
in
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'
in
Chart 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.
in
Chart 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']
in
Chart 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.
in
Chart 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.
in
Chart 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.
in
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.
in
Chart at line 461
Chart
titleTextStyle(
TextStyle $textStyle)
An array of options for defining the title text style.
in
Chart at line 474
Chart
tooltip(
array $tooltip)
An object with members to configure various tooltip elements.
in
ForceIFrameTrait at line 16
Chart
forceIFrame(
boolean $iframe)
Draws the chart inside an inline frame.
Note that on IE8, this option is ignored; all IE8 charts are drawn in i-frames.
at line 102
GaugeChart
greenColor(
string $greenColor)
The color to use for the green section, in HTML color notation.
at line 113
GaugeChart
greenFrom(
integer $greenFrom)
The lowest value for a range marked by a green color.
at line 124
GaugeChart
greenTo(
integer $greenTo)
The highest value for a range marked by a green color.
at line 137
GaugeChart
majorTicks(
array $majorTicks)
Labels for major tick marks. The number of labels define the number of major ticks in all gauges.
The default is five major ticks, with the labels of the minimal and maximal gauge value.
at line 155
GaugeChart
max(
integer $max)
The maximal value of a gauge.
at line 166
GaugeChart
min(
integer $min)
The minimal value of a gauge.
at line 177
GaugeChart
minorTicks(
integer $minorTicks)
The number of minor tick section in each major tick section.
at line 188
GaugeChart
redColor(
string $redColor)
The color to use for the red section, in HTML color notation.
at line 199
GaugeChart
redFrom(
integer $redFrom)
The lowest value for a range marked by a red color.
at line 210
GaugeChart
redTo(
integer $redTo)
The highest value for a range marked by a red color.
at line 221
GaugeChart
yellowColor(
string $yellowColor)
The color to use for the yellow section, in HTML color notation.
at line 232
GaugeChart
yellowFrom(
integer $yellowFrom)
The lowest value for a range marked by a yellow color.
at line 243
GaugeChart
yellowTo(
integer $yellowTo)
The highest value for a range marked by a yellow color.