MDL-55015 core: Add support for axis label 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 = [];
33     }
34     Base.prototype._series = null;
35     Base.prototype._labels = null;
36     Base.prototype._title = null;
37     Base.prototype._xaxes = null;
38     Base.prototype._yaxes = null;
40     Base.prototype.COLORSET = ['red', 'green', 'blue', 'yellow', 'pink', 'orange'];
41     Base.prototype.TYPE = null;
43     Base.prototype.addSeries = function(serie) {
44         this._validateSerie(serie);
45         this._series.push(serie);
47         // Give a default color from the set.
48         if (serie.getColor() === null) {
49             serie.setColor(Base.prototype.COLORSET[this._series.length % Base.prototype.COLORSET.length]);
50         }
51     };
53     Base.prototype.create = function(Klass, data) {
54         // TODO Not convinced about the usage of Klass here but I can't figure out a way
55         // to have a reference to the class in the sub classes, in PHP I'd do new self().
56         var Chart = new Klass();
58         Chart.setLabels(data.labels);
59         Chart.setTitle(data.title);
60         data.series.forEach(function(seriesData) {
61             Chart.addSeries(Series.prototype.create(seriesData));
62         });
63         data.axes.x.forEach(function(axisData, i) {
64             Chart.setXAxis(Axis.prototype.create(axisData), i);
65         });
66         data.axes.y.forEach(function(axisData, i) {
67             Chart.setYAxis(Axis.prototype.create(axisData), i);
68         });
69         return Chart;
70     };
72     Base.prototype.__getAxis = function(xy, index, createIfNotExists) {
73         var axes = xy === 'x' ? this._xaxes : this._yaxes,
74             axis;
76         index = typeof index === 'undefined' ? 0 : index;
77         createIfNotExists = typeof createIfNotExists === 'undefined' ? false : createIfNotExists;
78         axis = axes[index];
80         if (typeof axis === 'undefined') {
81             if (!createIfNotExists) {
82                 throw new Error('Unknown axis.');
83             }
84             axis = new Axis();
85             axes[index] = axis;
86         }
88         return axis;
89     };
91     Base.prototype.getLabels = function() {
92         return this._labels;
93     };
95     Base.prototype.getSeries = function() {
96         return this._series;
97     };
99     Base.prototype.getTitle = function() {
100         return this._title;
101     };
103     Base.prototype.getType = function() {
104         if (!this.TYPE) {
105             throw new Error('The TYPE property has not been set.');
106         }
107         return this.TYPE;
108     };
110     Base.prototype.getXAxes = function() {
111         return this._xaxes;
112     };
114     Base.prototype.getXAxis = function(index, createIfNotExists) {
115         return this.__getAxis('x', index, createIfNotExists);
116     };
118     Base.prototype.getYAxes = function() {
119         return this._yaxes;
120     };
122     Base.prototype.getYAxis = function(index, createIfNotExists) {
123         return this.__getAxis('y', index, createIfNotExists);
124     };
126     Base.prototype.setLabels = function(labels) {
127         if (labels.length && this._series.length && this._series[0].length != labels.length) {
128             throw new Error('Series must match label values.');
129         }
130         this._labels = labels;
131     };
133     Base.prototype.setTitle = function(title) {
134         this._title = title;
135     };
137     Base.prototype.setXAxis = function(axis, index) {
138         index = typeof index === 'undefined' ? 0 : index;
139         this._xaxes[index] = axis;
140     };
142     Base.prototype.setYAxis = function(axis, index) {
143         index = typeof index === 'undefined' ? 0 : index;
144         this._yaxes[index] = axis;
145     };
147     Base.prototype._validateSerie = function(serie) {
148         if (this._series.length && this._series[0].getCount() != serie.getCount()) {
149             throw new Error('Series do not have an equal number of values.');
151         } else if (this._labels.length && this._labels.length != serie.getCount()) {
152             throw new Error('Series must match label values.');
153         }
154     };
156     return Base;
158 });