6da2fcc26b5d2bcd85631efc1ffcfd8359ac9783
[moodle.git] / lib / amd / src / chart_base.js
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/>.
16 /**
17  * Chart base.
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(['core/chart_series'], function(Series) {
25     /**
26      * Chart base.
27      */
28     function Base() {
29         this._series = [];
30         this._labels = [];
31     }
32     Base.prototype._series = null;
33     Base.prototype._labels = null;
34     Base.prototype._title = null;
35     Base.prototype.COLORSET = ['red', 'green', 'blue', 'yellow', 'pink', 'orange'];
36     Base.prototype.TYPE = null;
38     Base.prototype.addSeries = function(serie) {
39         this._validateSerie(serie);
40         this._series.push(serie);
42         // Give a default color from the set.
43         if (serie.getColor() === null) {
44             serie.setColor(Base.prototype.COLORSET[this._series.length % Base.prototype.COLORSET.length]);
45         }
46     };
48     Base.prototype.create = function(Klass, data) {
49         // TODO Not convinced about the usage of Klass here but I can't figure out a way
50         // to have a reference to the class in the sub classes, in PHP I'd do new self().
51         var Chart = new Klass();
52         Chart.setLabels(data.labels);
53         Chart.setTitle(data.title);
54         for (var i = 0; i < data.series.length; i++) {
55             Chart.addSeries(Series.prototype.create(data.series[i]));
56         }
57         return Chart;
58     };
60     Base.prototype.getLabels = function() {
61         return this._labels;
62     };
64     Base.prototype.getSeries = function() {
65         return this._series;
66     };
68     Base.prototype.getTitle = function() {
69         return this._title;
70     };
72     Base.prototype.getType = function() {
73         if (!this.TYPE) {
74             throw new Error('The TYPE property has not been set.');
75         }
76         return this.TYPE;
77     };
79     Base.prototype.setLabels = function(labels) {
80         if (labels.length && this._series.length && this._series[0].length != labels.length) {
81             throw new Error('Series must match label values.');
82         }
83         this._labels = labels;
84     };
86     Base.prototype.setTitle = function(title) {
87         this._title = title;
88     };
90     Base.prototype._validateSerie = function(serie) {
91         if (this._series.length && this._series[0].getCount() != serie.getCount()) {
92             throw new Error('Series do not have an equal number of values.');
94         } else if (this._labels.length && this._labels.length != serie.getCount()) {
95             throw new Error('Series must match label values.');
96         }
97     };
99     return Base;
101 });