@@ -28,10 +28,58 @@ four new types: `boxplot`, `horizontalBoxplot`, `violin`, and `horizontalViolin`
28
28
## Config
29
29
30
30
``` typescript
31
+ interface IChartJSOptions {
31
32
/**
32
33
* Limit decimal digits by an optional config option
33
34
**/
34
35
tooltipDecimals? : number ;
36
+
37
+ boxplot: {
38
+ /**
39
+ * statistic measure that should be used for computing the minimal data limit
40
+ * @default ' min'
41
+ */
42
+ minStats: ' min' | ' q1' | ' whiskerMin' ;
43
+
44
+ /**
45
+ * statistic measure that should be used for computing the maximal data limit
46
+ * @default ' max'
47
+ */
48
+ maxStats: ' max' | ' q3' | ' whiskerMax' ;
49
+
50
+ /**
51
+ * from the R doc: this determines how far the plot ‘whiskers’ extend out from
52
+ * the box. If coef is positive, the whiskers extend to the most extreme data
53
+ * point which is no more than coef times the length of the box away from the
54
+ * box. A value of zero causes the whiskers to extend to the data extremes
55
+ * @default 1.5
56
+ */
57
+ coef: number ;
58
+
59
+ /**
60
+ * the method to compute the quantiles.
61
+ *
62
+ * 7, 'quantiles': the type-7 method as used by R 'quantiles' method.
63
+ * 'hinges' and 'fivenum': the method used by R 'boxplot.stats' method.
64
+ * 'linear': the interpolation method 'linear' as used by 'numpy.percentile' function
65
+ * 'lower': the interpolation method 'lower' as used by 'numpy.percentile' function
66
+ * 'higher': the interpolation method 'higher' as used by 'numpy.percentile' function
67
+ * 'nearest': the interpolation method 'nearest' as used by 'numpy.percentile' function
68
+ * 'midpoint': the interpolation method 'midpoint' as used by 'numpy.percentile' function
69
+ * @default 7
70
+ */
71
+ quantiles:
72
+ | 7
73
+ | ' quantiles'
74
+ | ' hinges'
75
+ | ' fivenum'
76
+ | ' linear'
77
+ | ' lower'
78
+ | ' higher'
79
+ | ' nearest'
80
+ | ' midpoint'
81
+ | ((sortedArr : number []) => { min: number ; q1: number ; median: number ; q3: number ; max: number });
82
+ }
35
83
` ` `
36
84
37
85
## Styling
@@ -169,51 +217,7 @@ Both `arrayLinear` and `arrayLogarithmic` support the two additional options to
169
217
170
218
` ` ` typescript
171
219
interface IArrayLinearScale {
172
- ticks: {
173
- /**
174
- * statistic measure that should be used for computing the minimal data limit
175
- * @default ' min'
176
- */
177
- minStats: ' min' | ' q1' | ' whiskerMin' ;
178
-
179
- /**
180
- * statistic measure that should be used for computing the maximal data limit
181
- * @default ' max'
182
- */
183
- maxStats: ' max' | ' q3' | ' whiskerMax' ;
184
220
185
- /**
186
- * from the R doc: this determines how far the plot ‘whiskers’ extend out from
187
- * the box. If coef is positive, the whiskers extend to the most extreme data
188
- * point which is no more than coef times the length of the box away from the
189
- * box. A value of zero causes the whiskers to extend to the data extremes
190
- * @default 1.5
191
- */
192
- coef: number ;
193
-
194
- /**
195
- * the method to compute the quantiles.
196
- *
197
- * 7, 'quantiles': the type-7 method as used by R 'quantiles' method.
198
- * 'hinges' and 'fivenum': the method used by R 'boxplot.stats' method.
199
- * 'linear': the interpolation method 'linear' as used by 'numpy.percentile' function
200
- * 'lower': the interpolation method 'lower' as used by 'numpy.percentile' function
201
- * 'higher': the interpolation method 'higher' as used by 'numpy.percentile' function
202
- * 'nearest': the interpolation method 'nearest' as used by 'numpy.percentile' function
203
- * 'midpoint': the interpolation method 'midpoint' as used by 'numpy.percentile' function
204
- * @default 7
205
- */
206
- quantiles:
207
- | 7
208
- | ' quantiles'
209
- | ' hinges'
210
- | ' fivenum'
211
- | ' linear'
212
- | ' lower'
213
- | ' higher'
214
- | ' nearest'
215
- | ' midpoint'
216
- | ((sortedArr : number []) => { min: number ; q1: number ; median: number ; q3: number ; max: number });
217
221
};
218
222
}
219
223
```
0 commit comments