MDL-55030 core: Support min and max in axes
[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._max = null;
40     Axis.prototype._min = null;
41     Axis.prototype._position = null;
42     Axis.prototype._stepSize = null;
44     Axis.prototype.create = function(obj) {
45         var s = new Axis();
46         s.setPosition(obj.position);
47         s.setLabel(obj.label);
48         s.setStepSize(obj.stepSize);
49         s.setMax(obj.max);
50         s.setMin(obj.min);
51         return s;
52     };
54     Axis.prototype.getLabel = function() {
55         return this._label;
56     };
58     Axis.prototype.getMax = function() {
59         return this._max;
60     };
62     Axis.prototype.getMin = function() {
63         return this._min;
64     };
66     Axis.prototype.getPosition = function() {
67         return this._position;
68     };
70     Axis.prototype.getStepSize = function() {
71         return this._stepSize;
72     };
74     Axis.prototype.setLabel = function(label) {
75         this._label = label || null;
76     };
78     Axis.prototype.setMax = function(max) {
79         this._max = typeof max !== 'undefined' ? max : null;
80     };
82     Axis.prototype.setMin = function(min) {
83         this._min = typeof min !== 'undefined' ? min : null;
84     };
86     Axis.prototype.setPosition = function(position) {
87         if (position != this.POS_DEFAULT
88                 && position != this.POS_BOTTOM
89                 && position != this.POS_LEFT
90                 && position != this.POS_RIGHT
91                 && position != this.POS_TOP) {
92             throw new Error('Invalid axis position.');
93         }
94         this._position = position;
95     };
97     Axis.prototype.setStepSize = function(stepSize) {
98         if (typeof stepSize === 'undefined' || stepSize === null) {
99             stepSize = null;
100         } else if (isNaN(Number(stepSize))) {
101             throw new Error('Value for stepSize is not a number.');
102         } else {
103             stepSize = Number(stepSize);
104         }
106         this._stepSize = stepSize;
107     };
109     return Axis;
111 });