[Summary view] [Print] [Text view]

   1  // This file is part of Moodle - http://moodle.org/
   2  //
   3  // Moodle is free software: you can redistribute it and/or modify
   4  // it under the terms of the GNU General Public License as published by
   5  // the Free Software Foundation, either version 3 of the License, or
   6  // (at your option) any later version.
   7  //
   8  // Moodle is distributed in the hope that it will be useful,
   9  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  // GNU General Public License for more details.
  12  //
  13  // You should have received a copy of the GNU General Public License
  14  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  15  
  16  /**
  17   * Chart builder.
  18   *
  19   * @package    core
  20   * @copyright  2016 Frédéric Massart - FMCorz.net
  21   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22   */
  23  define(['jquery'], function($) {
  24  
  25      /**
  26       * Chart builder.
  27       *
  28       * @exports core/chart_builder
  29       */
  30      var module = {
  31  
  32          /**
  33           * Make a chart instance.
  34           *
  35           * This takes data, most likely generated in PHP, and creates a chart instance from it
  36           * deferring most of the logic to {@link module:core/chart_base.create}.
  37           *
  38           * @param {Object} data The data.
  39           * @return {Promise} A promise resolved with the chart instance.
  40           */
  41          make: function(data) {
  42              var deferred = $.Deferred();
  43              require(['core/chart_' + data.type], function(Klass) {
  44                  var instance = Klass.prototype.create(Klass, data);
  45                  deferred.resolve(instance);
  46              });
  47              return deferred.promise();
  48          }
  49      };
  50  
  51      return module;
  52  
  53  });