MDL-55030 core: Support setting defaults in charts
[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', 'core/chart_axis'], function(Series, Axis) {
25     /**
26      * Chart base.
27      */
28     function Base() {
29         this._series = [];
30         this._labels = [];
31         this._xaxes = [];
32         this._yaxes = [];
34         this._setDefaults();
35     }
36     Base.prototype._series = null;
37     Base.prototype._labels = null;
38     Base.prototype._title = null;
39     Base.prototype._xaxes = null;
40     Base.prototype._yaxes = null;
42     Base.prototype.COLORSET = ['red', 'green', 'blue', 'yellow', 'pink', 'orange'];
43     Base.prototype.TYPE = null;
45     Base.prototype.addSeries = function(serie) {
46         this._validateSerie(serie);
47         this._series.push(serie);
49         // Give a default color from the set.
50         if (serie.getColor() === null) {
51             serie.setColor(Base.prototype.COLORSET[this._series.length % Base.prototype.COLORSET.length]);
52         }
53     };
55     Base.prototype.create = function(Klass, data) {
56         // TODO Not convinced about the usage of Klass here but I can't figure out a way
57         // to have a reference to the class in the sub classes, in PHP I'd do new self().
58         var Chart = new Klass();
60         Chart.setLabels(data.labels);
61         Chart.setTitle(data.title);
62         data.series.forEach(function(seriesData) {
63             Chart.addSeries(Series.prototype.create(seriesData));
64         });
65         data.axes.x.forEach(function(axisData, i) {
66             Chart.setXAxis(Axis.prototype.create(axisData), i);
67         });
68         data.axes.y.forEach(function(axisData, i) {
69             Chart.setYAxis(Axis.prototype.create(axisData), i);
70         });
71         return Chart;
72     };
74     Base.prototype.__getAxis = function(xy, index, createIfNotExists) {
75         var axes = xy === 'x' ? this._xaxes : this._yaxes,
76             axis;
78         index = typeof index === 'undefined' ? 0 : index;
79         createIfNotExists = typeof createIfNotExists === 'undefined' ? false : createIfNotExists;
80         axis = axes[index];
82         if (typeof axis === 'undefined') {
83             if (!createIfNotExists) {
84                 throw new Error('Unknown axis.');
85             }
86             axis = new Axis();
87             axes[index] = axis;
88         }
90         return axis;
91     };
93     Base.prototype.getLabels = function() {
94         return this._labels;
95     };
97     Base.prototype.getSeries = function() {
98         return this._series;
99     };
101     Base.prototype.getTitle = function() {
102         return this._title;
103     };
105     Base.prototype.getType = function() {
106         if (!this.TYPE) {
107             throw new Error('The TYPE property has not been set.');
108         }
109         return this.TYPE;
110     };
112     Base.prototype.getXAxes = function() {
113         return this._xaxes;
114     };
116     Base.prototype.getXAxis = function(index, createIfNotExists) {
117         return this.__getAxis('x', index, createIfNotExists);
118     };
120     Base.prototype.getYAxes = function() {
121         return this._yaxes;
122     };
124     Base.prototype.getYAxis = function(index, createIfNotExists) {
125         return this.__getAxis('y', index, createIfNotExists);
126     };
128     Base.prototype._setDefaults = function() {
129         // For the children to extend.
130     };
132     Base.prototype.setLabels = function(labels) {
133         if (labels.length && this._series.length && this._series[0].length != labels.length) {
134             throw new Error('Series must match label values.');
135         }
136         this._labels = labels;
137     };
139     Base.prototype.setTitle = function(title) {
140         this._title = title;
141     };
143     Base.prototype.setXAxis = function(axis, index) {
144         index = typeof index === 'undefined' ? 0 : index;
145         this._xaxes[index] = axis;
146     };
148     Base.prototype.setYAxis = function(axis, index) {
149         index = typeof index === 'undefined' ? 0 : index;
150         this._yaxes[index] = axis;
151     };
153     Base.prototype._validateSerie = function(serie) {
154         if (this._series.length && this._series[0].getCount() != serie.getCount()) {
155             throw new Error('Series do not have an equal number of values.');
157         } else if (this._labels.length && this._labels.length != serie.getCount()) {
158             throw new Error('Series must match label values.');
159         }
160     };
162     return Base;
164 });