MDL-55015 core: Add support for axis label in charts
[moodle.git] / lib / amd / src / chart_axis.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 axis.
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([], function() {
25     /**
26      * Chart axis.
27      */
28     function Axis() {
29         // Please eslint no-empty-function.
30     }
32     Axis.prototype.POS_DEFAULT = null;
33     Axis.prototype.POS_BOTTOM = 'bottom';
34     Axis.prototype.POS_LEFT = 'left';
35     Axis.prototype.POS_RIGHT = 'right';
36     Axis.prototype.POS_TOP = 'top';
38     Axis.prototype._label = null;
39     Axis.prototype._position = null;
41     Axis.prototype.create = function(obj) {
42         var s = new Axis();
43         s.setPosition(obj.position);
44         s.setLabel(obj.label);
45         return s;
46     };
48     Axis.prototype.getLabel = function() {
49         return this._label;
50     };
52     Axis.prototype.getPosition = function() {
53         return this._position;
54     };
56     Axis.prototype.setLabel = function(label) {
57         this._label = label || null;
58     };
60     Axis.prototype.setPosition = function(position) {
61         if (position != this.POS_DEFAULT
62                 && position != this.POS_BOTTOM
63                 && position != this.POS_LEFT
64                 && position != this.POS_RIGHT
65                 && position != this.POS_TOP) {
66             throw new Error('Invalid axis position.');
67         }
68         this._position = position;
69     };
71     return Axis;
73 });