tripal.d3js.api.inc

Provides the API for loading d3js onto pages.

File

tripal/api/tripal.d3js.api.inc
View source
  1. <?php

  2. 

  3. /**

  4.  * @file

  5.  *

  6.  * Provides the API for loading d3js onto pages.

  7.  */

  8. 

  9. /**

  10.  * @defgroup tripal_d3js_api d3js

  11.  * @ingroup tripal_api

  12.  * @{

  13.  * D3.js is a JavaScript library for producing dynamic, interactive data 

  14.  * visualizations in web browsers. It makes use of the widely implemented SVG, 

  15.  * HTML5, and CSS standards. For more information on how to use d3js please see

  16.  * https://github.com/d3/d3. 

  17.  * 

  18.  * For an example of d3 usage in Tripal please review 

  19.  * tripal_chado/includes/tripal_chado.phylotree.inc and 

  20.  * tripal_chado/theme/js/d3.phylogram.js

  21.  * 

  22.  * @}

  23.  */

  24. 

  25. 

  26. /**

  27.  * Load D3.js releated javascripts for the current page.

  28.  * 

  29.  * @ingroup tripal_d3js_api

  30.  */

  31. function tripal_add_d3js() {

  32.   $library = array('loaded' => FALSE);

  33. 

  34.   // First try to load d3.js using the libraries API.

  35.   // This will work if the site admin has saved d3.js in their libraries folder.

  36.   if (module_exists('libraries_api')) {

  37.     $library = libraries_load('d3');

  38.   }

  39. 

  40.   // If we were not able to load d3.js using the libraries API

  41.   // then revert to loading the remote files manually.

  42.   if (!isset($library['loaded']) OR !$library['loaded']) {

  43. 

  44.     // If SSL is being used then use a secure CDN for d3.js

  45.     if (isset($_SERVER['HTTPS'])) {

  46.       drupal_add_js('https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js');

  47.     }

  48.     else {

  49.       drupal_add_js('http://d3js.org/d3.v3.min.js');

  50.     }

  51.   }

  52. }