Skip to content

Commit 6ab71fa

Browse files
netilnetil
authored andcommitted
docs(gauge): Clarify enforceMinMax option (#3923)
Currently enforceMinMax option works for single data series only. Make sure clarifying the use of this option Ref #3918
1 parent ab35355 commit 6ab71fa

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

src/config/Options/shape/gauge.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ export default {
2727
* @property {number} [gauge.expand.rate=0.98] Set expand rate.
2828
* @property {number} [gauge.expand.duration=50] Set the expand transition time in milliseconds.
2929
* @property {boolean} [gauge.enforceMinMax=false] Enforce to given min/max value.
30-
* - When `gauge.min=50` and given value is `30`, gauge will render as empty value.
31-
* - When `gauge.max=100` and given value is `120`, gauge will render till 100, not surpassing max value.
30+
* - **Note:** Only works for single data series.
31+
* - When `gauge.min=50` and given value is `30`, gauge will render as empty value.
32+
* - When `gauge.max=100` and given value is `120`, gauge will render till 100, not surpassing max value.
3233
* @property {number} [gauge.min=0] Set min value of the gauge.
3334
* @property {number} [gauge.max=100] Set max value of the gauge.
3435
* @property {number} [gauge.startingAngle=-1 * Math.PI / 2] Set starting angle where data draws.

types/options.shape.d.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -440,8 +440,9 @@ export interface GaugeOptions {
440440

441441
/**
442442
* Enforce to given min/max value.
443-
* - When `gauge.min=50` and given value is `30`, gauge will render as empty value.
444-
* - When `gauge.max=100` and given value is `120`, gauge will render till 100, not surpassing max value.
443+
* **Note:** Only works for single data series.
444+
* - When `gauge.min=50` and given value is `30`, gauge will render as empty value.
445+
* - When `gauge.max=100` and given value is `120`, gauge will render till 100, not surpassing max value.
445446
*/
446447
enforceMinMax?: boolean;
447448

0 commit comments

Comments
 (0)