classes_lib_google_googlevisualization.class

Classes in file lib/google/googlevisualization.class.php

abstract class GoogleVisualization

Base class for google visualization controls.

Implements: ICallable

Extends: GoogleControl » Control » Renderable

Subclasses: gvAreaChart, gvBarChart, gvColumnChart, gvGauge, gvGeoChart, gvLineChart, gvOrgChart, gvPieChart, gvSteppedAreaChart, gvTable, gvWordTree

addColumn

Manually adds a column specification to the visualization.

Definition: public function addColumn($name, $label=false, $type=false, $style=false)

Returns: static

Parameters:

• string $name Column name

• string $label Column label

• string $type Type of values

• string $style Style of values

addColumnRole

Adds a role to the last added column. A role consists of a name and a callback that will be polled for each column in each data row. The callback must return the value for the column role. Note that this is only implementend for role 'annotation'.

See https://developers.google.com/chart/interactive/docs/roles

Definition: public function addColumnRole($role, $callback=false)

Returns: static

Parameters:

• string $role Role specifier

• \Closure $callback Callback function

addDataRow

Adds a data row. If you did not yet specify a header this row will be used as it. Calling this will set this into inline mdoe thus removing all database related settings (GoogleVisualization::setDbQuery).

Definition: public function addDataRow($args)

Returns: static

Parameters:

• mixed $args Data values

addRowCallback

Adds a callback method that will be called for each added data row.

Definition: public function addRowCallback($callback)

Returns: static

Parameters:

• \Closure $callback Method to be called

EntityFromTable

Creates a google query entity from a database table. See https://developers.google.com/chart/interactive/docs/reference#queryobjects

Definition: public function EntityFromTable($table_name, $alias=false)

Returns: static

Parameters:

• string $table_name Table name

• string $alias Alias name this can be referenced as

linkSelect

Interconnects two visualizations 'select' events.

Definition: public function linkSelect($other_vis)

Returns: static

Parameters:

• GoogleVisualization $other_vis The other visualization

Make

Static creator function.

Definition: public static function Make($args)

Returns: GoogleVisualization Created control

Parameters:

• mixed $args Only one argument allowed: Title

makeContinousDateAxis

Ensures a continous axis of type Date.

Definition: public function makeContinousDateAxis($format)

Returns: $this

Parameters:

• string $format Optional format

makeContinousIntAxis

Ensures a continous axis of type Integer.

Definition: public function makeContinousIntAxis()

Returns: $this

opt

Sets an option. Valid options vary for the different visualizations.

Definition: public function opt($name, $value=null)

Returns: static|null

Parameters:

• string $name Option name

• mixed $value OPtion value

PreRender

OVERRIDE GoogleControl::PreRender

Query

INTERNAL AJAX callback for google queries. See https://developers.google.com/chart/interactive/docs/reference#queryobjects

setDataHeader

Sets the data header. Calling this will set this into inline mode thus removing all database related settings (GoogleVisualization::setDbQuery).

Definition: public function setDataHeader($args)

Returns: static

Parameters:

• mixed $args Header-values

setDataRows

Sets all data rows. If you did not yet specify a header first row will be used as it. Calling this will set this into inline mdoe thus removing all database related settings (GoogleVisualization::setDbQuery).

Definition: public function setDataRows($rows)

Returns: static

Parameters:

• array $rows Two-dimensional array containing all the rows data

setDataSource

Sets the DataSource to be used

Definition: public function setDataSource($datasource)

Returns: static

Parameters:

• mixed $datasource Optional DataSource to use. This may also be the name of the DataSource to use as string.

setDbQuery

Sets up a google query from a database table. See https://developers.google.com/chart/interactive/docs/reference#queryobjects Calling this will set the GoogleVisualization in database mode thus clearing all inline data set with GoogleVisualization::setDataHeader and GoogleVisualization::addDataRow

Definition: public function setDbQuery($table_name, $query, $datasource=false)

Returns: static

Parameters:

• string $table_name Table name

• mixed $query The goolge query

• DataSource $datasource Optional DataSource to use. This may also be the name of the DataSource to use as string.

setMultiSeriesResultSet

Sets up a ResultSet as source of multiple data series.

Definition: public function setMultiSeriesResultSet($rs, $xAxisCol, $newColSpecifier, $newColValue, $newcolformat)

Returns: $this

Parameters:

• \ScavixWDF\Model\ResultSet $rs The resultset containing the series data

• string $xAxisCol Name of column containing the xAxis data

• string $newColSpecifier Name of column containing the series identifiers

• string $newColValue Name of column containing the real series data

• string $newcolformat Optional format of the data values

setResultSet

Adds a ResultSet as data for this visualization. The set may contain any column but it must contain all columns defined thru GoogleVisualization::addColumn or GoogleVisualization::addColumnRole.

Definition: public function setResultSet($rs)

Returns: static

Parameters:

• \ScavixWDF\Model\ResultSet $rs ResultSet with data.

setSize

SHORTCUT GoogleVisualization::opt('width',$width)->GoogleVisualization::opt('height',$height)

setSqlQuery

Sets up an SQL query (optionally with arguments) as data for this visualization.

Definition: public function setSqlQuery($sql, $args, $datasource=false)

Returns: static

Parameters:

• string $sql The SQL statement

• array $args Optional arguments

• mixed $datasource Optional DataSource to be used

setTitle

SHORTCUT GoogleVisualization::opt('title',$title);

__construct

Definition: public function __construct($type=false, $options, $query=false, $ds=false)

Returns: NOT DOCUMENTED

Parameters:

• string $type Type of google visualization

• array $options Options. Depends on $type

• string $query A valid google query string. See queryobjects

• DataSource $ds DataSource to use, will fall back to GoogleVisualization::$DefaultDatasource or (if that is not set) to model_datasource('internal')