CalendarChart
class CalendarChart extends Chart (View source)
CalendarChart Class
A calendar chart is a visualization used to show activity over the course of a long span of time, such as months or years. They're best used when you want to illustrate how some quantity varies depending on the day of the week, or how it trends over time.
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 chart with the given label.
Overriding getOption function to pull config options from calendar array.
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.
An object that specifies a mapping between color column values and colors or a gradient scale.
The cellColor option lets you customize the border of the calendar day squares
Sets the size of the calendar day squares
Controls the font style of the week labels at the top of the chart.
Sets The distance between the right edge of the week labels and the left edge of the chart day squares.
The single-letter labels to use for Sunday through Saturday.
When the user focuses (say, by hovering) over a day square, calendar charts will highlight the square.
Sets the style for the month labels.
Months with data values are delineated from others using a border in this style.
The number of pixels between the bottom of the month labels and the top of the day squares.
The number of pixels between the bottom-most year label and the bottom of the chart.
Months without data values are delineated from others using a border in this style.
Draws the chart inside an inline frame.
An object that specifies a mapping between color column values and colors or a gradient scale.
Details
at line 106
__construct(
Label $chartLabel,
DataTable $datatable,
array $config = array())
Builds a new chart with the given label.
at line 140
mixed
__get(
string $option)
Overriding getOption function to pull config options from calendar array.
(Thanks google)
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
ColorAxisTrait at line 16
Chart
colorAxis(
array $colorAxisConfig)
An object that specifies a mapping between color column values and colors or a gradient scale.
at line 166
CalendarChart
cellColor(
array $strokeConfig)
The cellColor option lets you customize the border of the calendar day squares
at line 178
CalendarChart
cellSize(
integer $cellSize)
Sets the size of the calendar day squares
at line 196
CalendarChart
dayOfWeekLabel(
TextStyle $labelConfig)
Controls the font style of the week labels at the top of the chart.
at line 209
CalendarChart
dayOfWeekRightSpace(
integer $space)
Sets The distance between the right edge of the week labels and the left edge of the chart day squares.
at line 228
CalendarChart
daysOfWeek(
string $days)
The single-letter labels to use for Sunday through Saturday.
at line 247
CalendarChart
focusedCellColor(
Stroke $strokeConfig)
When the user focuses (say, by hovering) over a day square, calendar charts will highlight the square.
at line 258
CalendarChart
monthLabel(
array $labelConfig)
Sets the style for the month labels.
at line 269
CalendarChart
monthOutlineColor(
array $strokeConfig)
Months with data values are delineated from others using a border in this style.
at line 282
CalendarChart
underMonthSpace(
int $space)
The number of pixels between the bottom of the month labels and the top of the day squares.
at line 302
CalendarChart
underYearSpace(
integer $space)
The number of pixels between the bottom-most year label and the bottom of the chart.
at line 320
CalendarChart
unusedMonthOutlineColor(
array $strokeConfig)
Months without data values are delineated from others using a border in this style.
at line 333
CalendarChart
forceIFrame(
bool $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 351
CalendarChart
noDataPattern(
array $colorConfig)
An object that specifies a mapping between color column values and colors or a gradient scale.