GeoChart
class GeoChart extends Chart (View source)
Properties
$type | |||
$label | from Chart | ||
$datatable | from Chart | ||
$deferedRender | from Chart |
Methods
Builds a new chart with a label.
Sets any configuration option, with no checks for type / validity
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
An object with members to configure the placement and size of the chart area (where the chart itself is drawn, excluding axis and legends).
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'].
Set up the chart with no datatable to defer rendering via AJAX
The default font size, in pixels, of all text in the chart. You can override this using properties for specific chart elements.
The default font face for all text in the chart. You can override this using properties for specific chart elements.
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.
Where to place the chart title, compared to the chart area. Supported values: 'in' - Draw the title inside the chart area.
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.
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.
An object that specifies a mapping between color column values and colors or a gradient scale.
Color to assign to regions with no associated data.
Which type of map this is. The DataTable format must match the value specified. The following values are supported:
If true, enable region interactivity, including focus and tool-tip elaboration on mouse hover, and region selection and firing of regionClick and select events on mouse click.
If true, the map will be drawn at the largest size that can fit inside the chart area at its natural aspect ratio. If only one of the width and height options is specified, the other one will be calculated according to the aspect ratio.
The area to display on the map. (Surrounding areas will be displayed as well.) Can be one of the following:
Sets up the magnifying glass, so when the user lingers over a cluttered marker, a magnifiying glass will be opened.
The opacity of the markers, where 0.0 is fully transparent and 1.0 is fully opaque.
The resolution of the map borders. Choose one of the following values:
Details
at line 32
__construct(
string $chartLabel)
Builds a new chart with a label.
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.
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.
in
Chart at line 164
array
getOptions()
Gets the current chart options.
in
Chart at line 176
mixed
getOption(
string $o)
Gets a specific option from the array.
in
Chart at line 194
bool
hasEvents()
Checks if any events have been assigned to the chart.
in
Chart at line 204
bool
getEvents()
Checks if any events have been assigned to the chart.
in
Chart at line 215
string
getDataTableJson()
Returns a JSON string representation of the datatable.
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
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.
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'].
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.
in
Chart at line 301
void
deferedRender(
bool $dr)
Set up the chart with no datatable to defer rendering via AJAX
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.
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.
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.
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.
in
Chart at line 442
string
optionsToJson()
Returns a JSON string representation of the chart's properties.
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.
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.
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.
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.
at line 61
GeoChart
colorAxis(
ColorAxis $ca)
An object that specifies a mapping between color column values and colors or a gradient scale.
at line 75
GeoChart
datalessRegionColor(
string $drc)
Color to assign to regions with no associated data.
at line 100
GeoChart
displayMode(
string $dm)
Which type of map this is. The DataTable format must match the value specified. The following values are supported:
'auto' - Choose based on the format of the DataTable. 'regions' - This is a region map 'markers' - This is a marker map
at line 132
GeoChart
enableRegionInteractivity(
bool $eri)
If true, enable region interactivity, including focus and tool-tip elaboration on mouse hover, and region selection and firing of regionClick and select events on mouse click.
The default is true in region mode, and false in marker mode.
at line 159
GeoChart
keepAspectRatio(
bool $kar)
If true, the map will be drawn at the largest size that can fit inside the chart area at its natural aspect ratio. If only one of the width and height options is specified, the other one will be calculated according to the aspect ratio.
If false, the map will be stretched to the exact size of the chart as specified by the width and height options.
at line 186
GeoChart
region(
string $r)
The area to display on the map. (Surrounding areas will be displayed as well.) Can be one of the following:
'world' - A map of the entire world. A continent or a sub-continent, specified by its 3-digit code, e.g., '011' for Western Africa. A country, specified by its ISO 3166-1 alpha-2 code, e.g., 'AU' for Australia. A state in the United States, specified by its ISO 3166-2:US code, e.g., 'US-AL' for Alabama. Note that the resolution option must be set to either 'provinces' or 'metros'.
at line 208
GeoChart
magnifyingGlass(
MagnifyingGlass $mg)
Sets up the magnifying glass, so when the user lingers over a cluttered marker, a magnifiying glass will be opened.
at line 223
GeoChart
markerOpacity(
float|int $mo)
The opacity of the markers, where 0.0 is fully transparent and 1.0 is fully opaque.
at line 253
GeoChart
resolution(
string $r)
The resolution of the map borders. Choose one of the following values:
'countries' - Supported for all regions, except for US state regions. 'provinces' - Supported only for country regions and US state regions. Not supported for all countries; please test a country to see whether this option is supported. 'metros' - Supported for the US country region and US state regions only.
at line 282
GeoChart
sizeAxis(
SizeAxis $sa)
An object with members to configure how values are associated with bubble sizes.