class GoogleVisualizationAPIHandler in Visualization API 7

@file Library plugin for Visualization implementing support for Google Visualization API.

Hierarchy

• class \GoogleVisualizationAPIHandler implements VisualizationHandlerInterface

File

includes/plugins/google_visualization_api.inc, line 8

Library plugin for Visualization implementing support for Google Visualization API.

class GoogleVisualizationAPIHandler implements VisualizationHandlerInterface {
  protected $addedJavascript = FALSE;

  /**
   * Renders a chart using the Google Visualization API.
   */
  public function render($chart_id, $data, $options) {

    // Chart options.
    $chart_options = array(
      'title' => $options['title'],
      'width' => !empty($options['width']) ? $options['width'] : '100%',
      'height' => !empty($options['height']) ? $options['height'] : '100%',
      'vAxis' => array(
        'title' => !empty($options['yAxis']['title']) ? $options['yAxis']['title'] : '',
      ),
    );
    switch ($options['type']) {
      case 'map':
        $chart_options['dataMode'] = !empty($options['dataMode']) ? $options['dataMode'] : 'regions';
        break;
    }

    // Prepare the table array with the data.
    $table_data = array();

    // Add header row first.
    $header = array();
    if (!empty($options['xAxis']['labelField'])) {
      $header[] = $options['fields'][$options['xAxis']['labelField']]['label'];
    }
    foreach ($options['fields'] as $name => $column) {
      if (!empty($column['enabled'])) {
        $header[] = $column['label'];
      }
    }
    $table_data[] = $header;

    // Then add data, row per row.
    foreach ($data as $row) {
      $table_row = array();
      if (!empty($options['xAxis']['labelField'])) {
        $table_row[] = html_entity_decode((string) $row[$options['xAxis']['labelField']], ENT_QUOTES);
      }
      foreach ($options['fields'] as $name => $column) {
        if (!empty($column['enabled'])) {
          $value = is_null($row[$name]) ? NULL : (double) $row[$name];
          $table_row[] = $value;
        }
      }
      $table_data[] = $table_row;
    }
    $information = array(
      'library' => 'google_visualization',
      'type' => $options['type'],
      'options' => $chart_options,
      'dataArray' => $table_data,
      'chart_id' => $chart_id,
    );

    // Add Drupal.settings for this chart.
    drupal_add_js(array(
      'visualization' => array(
        $chart_id => $information,
      ),
    ), array(
      'type' => 'setting',
    ));
  }

  /**
   * Loads the global Javascript required by the Google Visualization API.
   */
  public function postRender() {
    if (!$this->addedJavascript) {
      drupal_add_js('https://www.google.com/jsapi', 'external');
      drupal_add_js('google.load("visualization", "1", {packages:["corechart", "geomap"]});', array(
        'type' => 'inline',
      ));
      drupal_add_js(drupal_get_path('module', 'visualization') . '/js/gva.js', array(
        'scope' => 'footer',
      ));
      $this->addedJavascript = TRUE;
    }
  }

  /**
   * Returns whether or not the plugin is available.
   */
  public function available() {
    return TRUE;
  }

  /**
   * Returns an array of supported chart types.
   */
  public function supportedTypes() {
    return array(
      'line',
      'column',
      'pie',
      'map',
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GoogleVisualizationAPIHandler::$addedJavascript	protected	property
GoogleVisualizationAPIHandler::available	public	function	Returns whether or not the plugin is available. Overrides VisualizationHandlerInterface::available
GoogleVisualizationAPIHandler::postRender	public	function	Loads the global Javascript required by the Google Visualization API. Overrides VisualizationHandlerInterface::postRender
GoogleVisualizationAPIHandler::render	public	function	Renders a chart using the Google Visualization API. Overrides VisualizationHandlerInterface::render
GoogleVisualizationAPIHandler::supportedTypes	public	function	Returns an array of supported chart types. Overrides VisualizationHandlerInterface::supportedTypes