From 6ab71fa30571ce135f052bb3b39922a18c6fdc9b Mon Sep 17 00:00:00 2001 From: Jae Sung Park Date: Wed, 4 Dec 2024 15:51:02 +0900 Subject: [PATCH] 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 --- src/config/Options/shape/gauge.ts | 5 +++-- types/options.shape.d.ts | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/config/Options/shape/gauge.ts b/src/config/Options/shape/gauge.ts index 801d5c896..af84e5dff 100644 --- a/src/config/Options/shape/gauge.ts +++ b/src/config/Options/shape/gauge.ts @@ -27,8 +27,9 @@ export default { * @property {number} [gauge.expand.rate=0.98] Set expand rate. * @property {number} [gauge.expand.duration=50] Set the expand transition time in milliseconds. * @property {boolean} [gauge.enforceMinMax=false] Enforce to given min/max value. - * - When `gauge.min=50` and given value is `30`, gauge will render as empty value. - * - When `gauge.max=100` and given value is `120`, gauge will render till 100, not surpassing max value. + * - **Note:** Only works for single data series. + * - When `gauge.min=50` and given value is `30`, gauge will render as empty value. + * - When `gauge.max=100` and given value is `120`, gauge will render till 100, not surpassing max value. * @property {number} [gauge.min=0] Set min value of the gauge. * @property {number} [gauge.max=100] Set max value of the gauge. * @property {number} [gauge.startingAngle=-1 * Math.PI / 2] Set starting angle where data draws. diff --git a/types/options.shape.d.ts b/types/options.shape.d.ts index 9e7232ac8..90844a351 100644 --- a/types/options.shape.d.ts +++ b/types/options.shape.d.ts @@ -440,8 +440,9 @@ export interface GaugeOptions { /** * Enforce to given min/max value. - * - When `gauge.min=50` and given value is `30`, gauge will render as empty value. - * - When `gauge.max=100` and given value is `120`, gauge will render till 100, not surpassing max value. + * **Note:** Only works for single data series. + * - When `gauge.min=50` and given value is `30`, gauge will render as empty value. + * - When `gauge.max=100` and given value is `120`, gauge will render till 100, not surpassing max value. */ enforceMinMax?: boolean;