@itwin/core-quantity 4.10.0-dev.8 → 4.10.0

package/lib/esm/Formatter/FormatEnums.js

@@ -99,42 +99,66 @@ export var DecimalPrecision;
 export var FormatType;
 (function (FormatType) {
     /** Decimal display (ie 2.125) */
-    FormatType[FormatType["Decimal"] = 0] = "Decimal";
+    FormatType["Decimal"] = "Decimal";
     /** Fractional display (ie 2-1/8) */
-    FormatType[FormatType["Fractional"] = 1] = "Fractional";
+    FormatType["Fractional"] = "Fractional";
     /** Scientific Notation (ie 1.04e3) */
-    FormatType[FormatType["Scientific"] = 2] = "Scientific";
+    FormatType["Scientific"] = "Scientific";
     /** Civil Engineering Stationing (ie 1+00). */
-    FormatType[FormatType["Station"] = 3] = "Station";
+    FormatType["Station"] = "Station";
     /** Bearing angle e.g. N05:00:00E. Requires provided quantities to be of the angle phenomenon */
-    FormatType[FormatType["Bearing"] = 4] = "Bearing";
+    FormatType["Bearing"] = "Bearing";
     /** Azimuth angle e.g. 45°30'00". Requires provided quantities to be of the angle phenomenon */
-    FormatType[FormatType["Azimuth"] = 5] = "Azimuth";
+    FormatType["Azimuth"] = "Azimuth";
+    /** Ratio display e,g. 1:2 or 0.3:1.  */
+    FormatType["Ratio"] = "Ratio";
 })(FormatType || (FormatType = {}));
 /** required if type is scientific
  * @beta */
 export var ScientificType;
 (function (ScientificType) {
     /** Non-zero value left of decimal point (ie 1.2345e3) */
-    ScientificType[ScientificType["Normalized"] = 0] = "Normalized";
+    ScientificType["Normalized"] = "Normalized";
     /** Zero value left of decimal point (ie 0.12345e4) */
-    ScientificType[ScientificType["ZeroNormalized"] = 1] = "ZeroNormalized";
+    ScientificType["ZeroNormalized"] = "ZeroNormalized";
 })(ScientificType || (ScientificType = {}));
+/** required if type is ratio
+ * @beta */
+export var RatioType;
+(function (RatioType) {
+    /** One to N ratio (ie 1:N) */
+    RatioType["OneToN"] = "OneToN";
+    /** N to One ratio (ie N:1) */
+    RatioType["NToOne"] = "NToOne";
+    /**  the lesser value scales to 1. e.g. input 0.5 turns into 2:1 | input 2 turns into 1:2 */
+    RatioType["ValueBased"] = "ValueBased";
+    /**  scales the input ratio to its simplest integer form using the greatest common divisor (GCD) of the values. e.g. 0.3 turns into 3:10 */
+    RatioType["UseGreatestCommonDivisor"] = "UseGreatestCommonDivisor";
+})(RatioType || (RatioType = {}));
 /** Determines how the sign of values are displayed
  * @beta */
 export var ShowSignOption;
 (function (ShowSignOption) {
     /** Never show a sign even if the value is negative. */
-    ShowSignOption[ShowSignOption["NoSign"] = 0] = "NoSign";
+    ShowSignOption["NoSign"] = "NoSign";
     /** Only show a sign when the value is negative. */
-    ShowSignOption[ShowSignOption["OnlyNegative"] = 1] = "OnlyNegative";
+    ShowSignOption["OnlyNegative"] = "OnlyNegative";
     /** Always show a sign whether the value is positive or negative. */
-    ShowSignOption[ShowSignOption["SignAlways"] = 2] = "SignAlways";
+    ShowSignOption["SignAlways"] = "SignAlways";
     /** Only show a sign when the value is negative but use parentheses instead of a negative sign. For example, -10 is formatted as `(10)`. */
-    ShowSignOption[ShowSignOption["NegativeParentheses"] = 3] = "NegativeParentheses";
+    ShowSignOption["NegativeParentheses"] = "NegativeParentheses";
 })(ShowSignOption || (ShowSignOption = {}));
 // parse and toString methods
-/**  @beta   */
+/**
+ * @beta
+ * @deprecated in 4.10. ScientificType is now a string enum and doesn't need a serialization method. You can access the enum directly.
+*/
+export function scientificTypeToString(scientificType) {
+    return (scientificType === ScientificType.Normalized) ? "Normalized" : "ZeroNormalized";
+}
+/**
+ * @beta
+*/
 export function parseScientificType(scientificType, formatName) {
     switch (scientificType.toLowerCase()) {
         case "normalized": return ScientificType.Normalized;
@@ -144,8 +168,17 @@ export function parseScientificType(scientificType, formatName) {
     }
 }
 /**  @beta   */
-export function scientificTypeToString(scientificType) {
-    return (scientificType === ScientificType.Normalized) ? "Normalized" : "ZeroNormalized";
+export function parseRatioType(ratioType, formatName) {
+    const normalizedValue = ratioType.toLowerCase();
+    for (const key in RatioType) {
+        if (RatioType.hasOwnProperty(key)) {
+            const enumValue = RatioType[key];
+            if (enumValue.toLowerCase() === normalizedValue) {
+                return enumValue;
+            }
+        }
+    }
+    throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'ratioType' attribute.`);
 }
 /** @beta    */
 export function parseShowSignOption(showSignOption, formatName) {
@@ -158,7 +191,10 @@ export function parseShowSignOption(showSignOption, formatName) {
             throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'showSignOption' attribute.`);
     }
 }
-/**  @beta  */
+/**
+ * @beta
+ * @deprecated in 4.10. ShowSignOption is now a string enum and doesn't need a serialization method. You can access the enum directly.
+*/
 export function showSignOptionToString(showSign) {
     switch (showSign) {
         case ShowSignOption.NegativeParentheses: return "NegativeParentheses";
@@ -244,11 +280,14 @@ export function parseFormatType(jsonObjType, formatName) {
         case "fractional": return FormatType.Fractional;
         case "bearing": return FormatType.Bearing;
         case "azimuth": return FormatType.Azimuth;
+        case "ratio": return FormatType.Ratio;
         default:
             throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'type' attribute.`);
     }
 }
-/** @beta    */
+/** @beta
+ *  @deprecated in 4.10. FormatType is now a string enum and doesn't need a serialization method. You can access the enum directly.
+*/
 export function formatTypeToString(type) {
     switch (type) {
         case FormatType.Decimal: return "Decimal";
@@ -257,6 +296,7 @@ export function formatTypeToString(type) {
         case FormatType.Fractional: return "Fractional";
         case FormatType.Bearing: return "Bearing";
         case FormatType.Azimuth: return "Azimuth";
+        case FormatType.Ratio: return "Ratio";
     }
 }
 /**  @beta    */
@@ -301,6 +341,7 @@ export function parsePrecision(precision, type, formatName) {
         case FormatType.Decimal:
         case FormatType.Scientific:
         case FormatType.Station:
+        case FormatType.Ratio:
         case FormatType.Bearing:
         case FormatType.Azimuth:
             return parseDecimalPrecision(precision, formatName);

package/lib/esm/Formatter/FormatEnums.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormatEnums.js","sourceRoot":"","sources":["../../../src/Formatter/FormatEnums.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE7D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,8JAA8J,CAAC;AAE9L,gBAAgB;AAChB,MAAM,SAAS,CAAC,CAAC,4BAA4B,CAAC,YAAoB;IAChE,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAClD,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB;IAClC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,mCAAmC;QACpE,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS;YAC5B,MAAM,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY;;YAEpC,MAAM;QACR,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;AACH,CAAC;AACD,YAAY;AACZ,MAAM,CAAN,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACtB,iEAAiB,CAAA;IACjB,mDAAmD;IACnD,6DAAoB,CAAA;IACpB,6FAA6F;IAC7F,mEAAuB,CAAA;IACvB,iDAAiD;IACjD,yDAAkB,CAAA;IAClB,iEAAiE;IACjE,uEAAyB,CAAA;IACzB,kDAAkD;IAClD,kEAAsB,CAAA;IACtB,2DAA2D;IAC3D,gEAAqB,CAAA;IACrB,uCAAuC;IACvC,kEAAsB,CAAA;IACtB,4CAA4C;IAC5C,yEAAyB,CAAA;IACzB,6CAA6C;IAC7C,yEAAyB,CAAA;IACzB,8IAA8I;IAC9I,iFAA6B,CAAA;AAC/B,CAAC,EAtBW,YAAY,KAAZ,YAAY,QAsBvB;AAED;WACW;AACX,MAAM,CAAN,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC7B,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,6DAAQ,CAAA;IACR,+DAAS,CAAA;IACT,oEAAY,CAAA;IACZ,wEAAc,CAAA;IACd,wEAAc,CAAA;IACd,iGAA2B,CAAA;IAC3B,2FAAwB,CAAA;AAC1B,CAAC,EAVW,mBAAmB,KAAnB,mBAAmB,QAU9B;AAED;WACW;AACX,MAAM,CAAN,IAAY,gBAcX;AAdD,WAAY,gBAAgB;IAC1B,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,qDAAO,CAAA;IACP,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,yDAAS,CAAA;IACT,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,sDAAQ,CAAA;IACR,4DAAW,CAAA;IACX,4DAAW,CAAA;AACb,CAAC,EAdW,gBAAgB,KAAhB,gBAAgB,QAc3B;AAED;YACY;AACZ,MAAM,CAAN,IAAY,UAaX;AAbD,WAAY,UAAU;IACpB,iCAAiC;IACjC,iDAAO,CAAA;IACP,oCAAoC;IACpC,uDAAU,CAAA;IACV,sCAAsC;IACtC,uDAAU,CAAA;IACV,8CAA8C;IAC9C,iDAAO,CAAA;IACP,gGAAgG;IAChG,iDAAO,CAAA;IACP,+FAA+F;IAC/F,iDAAO,CAAA;AACT,CAAC,EAbW,UAAU,KAAV,UAAU,QAarB;AAED;WACW;AACX,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,yDAAyD;IACzD,+DAAU,CAAA;IACV,sDAAsD;IACtD,uEAAc,CAAA;AAChB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AAED;WACW;AACX,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACxB,uDAAuD;IACvD,uDAAM,CAAA;IACN,mDAAmD;IACnD,mEAAY,CAAA;IACZ,oEAAoE;IACpE,+DAAU,CAAA;IACV,2IAA2I;IAC3I,iFAAmB,CAAA;AACrB,CAAC,EATW,cAAc,KAAd,cAAc,QASzB;AAED,6BAA6B;AAE7B,eAAe;AAEf,MAAM,UAAU,mBAAmB,CAAC,cAAsB,EAAE,UAAkB;IAC5E,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE,CAAC;QACrC,KAAK,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC,UAAU,CAAC;QACpD,KAAK,gBAAgB,CAAC,CAAC,OAAO,cAAc,CAAC,cAAc,CAAC;QAC5D;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,6CAA6C,CAAC,CAAC;IAC/H,CAAC;AACH,CAAC;AAED,eAAe;AACf,MAAM,UAAU,sBAAsB,CAAC,cAA8B;IACnE,OAAO,CAAC,cAAc,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC;AAC1F,CAAC;AAED,eAAe;AACf,MAAM,UAAU,mBAAmB,CAAC,cAAsB,EAAE,UAAkB;IAC5E,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE,CAAC;QACrC,KAAK,QAAQ,CAAC,CAAC,OAAO,cAAc,CAAC,MAAM,CAAC;QAC5C,KAAK,cAAc,CAAC,CAAC,OAAO,cAAc,CAAC,YAAY,CAAC;QACxD,KAAK,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC,UAAU,CAAC;QACpD,KAAK,qBAAqB,CAAC,CAAC,OAAO,cAAc,CAAC,mBAAmB,CAAC;QACtE;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,6CAA6C,CAAC,CAAC;IAC/H,CAAC;AACH,CAAC;AAED,cAAc;AACd,MAAM,UAAU,sBAAsB,CAAC,QAAwB;IAC7D,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,cAAc,CAAC,mBAAmB,CAAC,CAAC,OAAO,qBAAqB,CAAC;QACtE,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,QAAQ,CAAC;QAC5C,KAAK,cAAc,CAAC,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC;QACxD,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;IACtD,CAAC;AACH,CAAC;AAED,cAAc;AACd,MAAM,UAAU,gBAAgB,CAAC,kBAA0B,EAAE,UAAkB;IAC7E,QAAQ,kBAAkB,CAAC,WAAW,EAAE,EAAE,CAAC;QACzC,KAAK,aAAa,CAAC,CAAC,OAAO,YAAY,CAAC,WAAW,CAAC;QACpD,KAAK,gBAAgB,CAAC,CAAC,OAAO,YAAY,CAAC,cAAc,CAAC;QAC1D,KAAK,WAAW,CAAC,CAAC,OAAO,YAAY,CAAC,SAAS,CAAC;QAChD,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,eAAe,CAAC,CAAC,OAAO,YAAY,CAAC,aAAa,CAAC;QACxD,KAAK,cAAc,CAAC,CAAC,OAAO,YAAY,CAAC,YAAY,CAAC;QACtD,KAAK,eAAe,CAAC,CAAC,OAAO,YAAY,CAAC,aAAa,CAAC;QACxD,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,sBAAsB,CAAC,CAAC,OAAO,YAAY,CAAC,oBAAoB,CAAC;QACtE;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,2CAA2C,CAAC,CAAC;IAC7H,CAAC;AACH,CAAC;AAED,YAAY;AACZ,MAAM,UAAU,cAAc,CAAC,KAAmB;IAChD,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,YAAY,CAAC,WAAW;YAC3B,OAAO,aAAa,CAAC;QACvB,KAAK,YAAY,CAAC,cAAc;YAC9B,OAAO,gBAAgB,CAAC;QAC1B,KAAK,YAAY,CAAC,SAAS;YACzB,OAAO,WAAW,CAAC;QACrB,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,aAAa;YAC7B,OAAO,eAAe,CAAC;QACzB,KAAK,YAAY,CAAC,YAAY;YAC5B,OAAO,cAAc,CAAC;QACxB,KAAK,YAAY,CAAC,aAAa;YAC7B,OAAO,eAAe,CAAC;QACzB,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,oBAAoB,CAAC;QACvC;YACE,OAAO,sBAAsB,CAAC;IAClC,CAAC;AACH,CAAC;AAED,cAAc;AACd,MAAM,UAAU,mBAAmB,CAAC,kBAAgC;IAClE,MAAM,eAAe,GAAG,KAAK,EAAU,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,WAAW,CAAC,KAAK,YAAY,CAAC,WAAW;QAC9E,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACtC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,cAAc,CAAC,KAAK,YAAY,CAAC,cAAc;QACpF,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACzC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,SAAS,CAAC,KAAK,YAAY,CAAC,SAAS;QAC1E,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,KAAK,YAAY,CAAC,aAAa;QAClF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,YAAY,CAAC,KAAK,YAAY,CAAC,YAAY;QAChF,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,KAAK,YAAY,CAAC,aAAa;QAClF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,oBAAoB,CAAC,KAAK,YAAY,CAAC,oBAAoB;QAChG,eAAe,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC/C,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,eAAe,CAAC,WAAmB,EAAE,UAAkB;IACrE,QAAQ,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC;QAClC,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;QAChD,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;QAChD,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,mCAAmC,CAAC,CAAC;IACrH,CAAC;AACH,CAAC;AAED,eAAe;AACf,MAAM,UAAU,kBAAkB,CAAC,IAAgB;IACjD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;QAChD,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;QAChD,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;IAC5C,CAAC;AACH,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,qBAAqB,CAAC,gBAAwB,EAAE,UAAkB;IAChF,QAAQ,gBAAgB,EAAE,CAAC;QACzB,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACrC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC;QACxC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC;QACxC;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;IAC1H,CAAC;AACH,CAAC;AAED,4HAA4H;AAC5H,MAAM,UAAU,wBAAwB,CAAC,gBAAwB,EAAE,UAAkB;IACnF,QAAQ,gBAAgB,EAAE,CAAC;QACzB,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,GAAG,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,GAAG,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,IAAI,CAAC;QACxC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC;QACzC,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,OAAO,CAAC;QAC5C,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC;QAC9C,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC;QAC9C,KAAK,GAAG,CAAC,CAAC,OAAO,mBAAmB,CAAC,qBAAqB,CAAC;QAC3D,KAAK,GAAG,CAAC,CAAC,OAAO,mBAAmB,CAAC,kBAAkB,CAAC;QACxD;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;IAC1H,CAAC;AACH,CAAC;AAED,iJAAiJ;AACjJ,MAAM,UAAU,cAAc,CAAC,SAAiB,EAAE,IAAgB,EAAE,UAAkB;IACpF,QAAQ,IAAI,EAAE,CAAC,CAAC,2DAA2D;QACzE,KAAK,UAAU,CAAC,OAAO,CAAC;QACxB,KAAK,UAAU,CAAC,UAAU,CAAC;QAC3B,KAAK,UAAU,CAAC,OAAO,CAAC;QACxB,KAAK,UAAU,CAAC,OAAO,CAAC;QACxB,KAAK,UAAU,CAAC,OAAO;YACrB,OAAO,qBAAqB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACtD,KAAK,UAAU,CAAC,UAAU;YACxB,OAAO,wBAAwB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACzD;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;IAC1H,CAAC;AACH,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Quantity\r\n */\r\n\r\nimport { QuantityError, QuantityStatus } from \"../Exception\";\r\n\r\n/** The regular expression to parse [format strings]($docs/bis/ec/kindofquantity.md#format-string)\r\n * provided in serialized formats as well as the full name of an [[OverrideFormat]].\r\n *\r\n * `formatName(precision)[unitName|unitLabel][unitName|unitLabel][unitName|unitLabel][unitName|unitLabel]`\r\n *\r\n * Explanation of the regex:\r\n * - ([\\w.:]+)\r\n *   - Grabs the format full name\r\n * - (\\(([^\\)]+)\\))?\r\n *   - Grabs the precision part with and without the `()`.\r\n *   - The parentheses are needed to validate the entire string.  (TODO: Need to check if this is true)\r\n * - (\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?\r\n *   - 4 of these make up the rest of the regex, none of them are required so each end in `?`\r\n *   - Grabs the unit name and label including the `[]`\r\n *   - Grabs the unit name, `|` and label separately\r\n * @internal\r\n */\r\nexport const formatStringRgx = /([\\w.:]+)(\\(([^\\)]+)\\))?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?/;\r\n\r\n/** @internal */\r\nexport function* getItemNamesFromFormatString(formatString: string): Iterable<string> {\r\n  const match = formatString.split(formatStringRgx);\r\n  yield match[1]; // the Format Name\r\n  let index = 4;\r\n  while (index < match.length - 1) { // index 0 and 21 are empty strings\r\n    if (match[index] !== undefined)\r\n      yield match[index + 1]; // Unit Name\r\n    else\r\n      break;\r\n    index += 4;\r\n  }\r\n}\r\n/** @beta */\r\nexport enum FormatTraits {\r\n  Uninitialized = 0,\r\n  /** Show trailing zeroes to requested precision. */\r\n  TrailZeroes = 1 << 0,\r\n  /** Indicates that the fractional part of the number is required when the fraction is zero */\r\n  KeepSingleZero = 1 << 1,\r\n  /** Zero magnitude returns blank display value */\r\n  ZeroEmpty = 1 << 2,\r\n  /** Show decimal point when value to right of decimal is empty */\r\n  KeepDecimalPoint = 1 << 3,\r\n  /** Use the rounding factor. Not yet supported  */\r\n  ApplyRounding = 1 << 4,\r\n  /** Show a dash between whole value and fractional value */\r\n  FractionDash = 1 << 5,\r\n  /** Append the quantity's unit label */\r\n  ShowUnitLabel = 1 << 6,\r\n  /** Prepend unit label. Not yet supported */\r\n  PrependUnitLabel = 1 << 7,\r\n  /** show a grouping in each group of 1000. */\r\n  Use1000Separator = 1 << 8,\r\n  /** Indicates that if an exponent value is positive to not include a `+`. By default a sign, `+` or `-`, is always shown. Not yet supported */\r\n  ExponentOnlyNegative = 1 << 9,\r\n}\r\n\r\n/** Precision for Fractional formatted value types. Range from Whole (1/1) through 1/256.\r\n * @beta */\r\nexport enum FractionalPrecision {\r\n  One = 1,\r\n  Two = 2,\r\n  Four = 4,\r\n  Eight = 8,\r\n  Sixteen = 16,\r\n  ThirtyTwo = 32,\r\n  SixtyFour = 64,\r\n  OneHundredTwentyEight = 128,\r\n  TwoHundredFiftySix = 256,\r\n}\r\n\r\n/** Precision for Decimal, Scientific, and Station formatted value types. Range from 1/(10^0) through 1/(10^12).\r\n * @beta */\r\nexport enum DecimalPrecision {\r\n  Zero = 0,\r\n  One = 1,\r\n  Two = 2,\r\n  Three = 3,\r\n  Four = 4,\r\n  Five = 5,\r\n  Six = 6,\r\n  Seven = 7,\r\n  Eight = 8,\r\n  Nine = 9,\r\n  Ten = 10,\r\n  Eleven = 11,\r\n  Twelve = 12,\r\n}\r\n\r\n/** Supported format types\r\n *  @beta */\r\nexport enum FormatType {\r\n  /** Decimal display (ie 2.125) */\r\n  Decimal,\r\n  /** Fractional display (ie 2-1/8) */\r\n  Fractional,\r\n  /** Scientific Notation (ie 1.04e3) */\r\n  Scientific,\r\n  /** Civil Engineering Stationing (ie 1+00). */\r\n  Station,\r\n  /** Bearing angle e.g. N05:00:00E. Requires provided quantities to be of the angle phenomenon */\r\n  Bearing,\r\n  /** Azimuth angle e.g. 45°30'00\". Requires provided quantities to be of the angle phenomenon */\r\n  Azimuth,\r\n}\r\n\r\n/** required if type is scientific\r\n * @beta */\r\nexport enum ScientificType {\r\n  /** Non-zero value left of decimal point (ie 1.2345e3) */\r\n  Normalized,\r\n  /** Zero value left of decimal point (ie 0.12345e4) */\r\n  ZeroNormalized,\r\n}\r\n\r\n/** Determines how the sign of values are displayed\r\n * @beta */\r\nexport enum ShowSignOption {\r\n  /** Never show a sign even if the value is negative. */\r\n  NoSign,\r\n  /** Only show a sign when the value is negative. */\r\n  OnlyNegative,\r\n  /** Always show a sign whether the value is positive or negative. */\r\n  SignAlways,\r\n  /** Only show a sign when the value is negative but use parentheses instead of a negative sign. For example, -10 is formatted as `(10)`. */\r\n  NegativeParentheses,\r\n}\r\n\r\n// parse and toString methods\r\n\r\n/**  @beta   */\r\n\r\nexport function parseScientificType(scientificType: string, formatName: string): ScientificType {\r\n  switch (scientificType.toLowerCase()) {\r\n    case \"normalized\": return ScientificType.Normalized;\r\n    case \"zeronormalized\": return ScientificType.ZeroNormalized;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'scientificType' attribute.`);\r\n  }\r\n}\r\n\r\n/**  @beta   */\r\nexport function scientificTypeToString(scientificType: ScientificType): string {\r\n  return (scientificType === ScientificType.Normalized) ? \"Normalized\" : \"ZeroNormalized\";\r\n}\r\n\r\n/** @beta    */\r\nexport function parseShowSignOption(showSignOption: string, formatName: string): ShowSignOption {\r\n  switch (showSignOption.toLowerCase()) {\r\n    case \"nosign\": return ShowSignOption.NoSign;\r\n    case \"onlynegative\": return ShowSignOption.OnlyNegative;\r\n    case \"signalways\": return ShowSignOption.SignAlways;\r\n    case \"negativeparentheses\": return ShowSignOption.NegativeParentheses;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'showSignOption' attribute.`);\r\n  }\r\n}\r\n\r\n/**  @beta  */\r\nexport function showSignOptionToString(showSign: ShowSignOption): string {\r\n  switch (showSign) {\r\n    case ShowSignOption.NegativeParentheses: return \"NegativeParentheses\";\r\n    case ShowSignOption.NoSign: return \"NoSign\";\r\n    case ShowSignOption.OnlyNegative: return \"OnlyNegative\";\r\n    case ShowSignOption.SignAlways: return \"SignAlways\";\r\n  }\r\n}\r\n\r\n/**  @beta  */\r\nexport function parseFormatTrait(formatTraitsString: string, formatName: string): FormatTraits {\r\n  switch (formatTraitsString.toLowerCase()) {\r\n    case \"trailzeroes\": return FormatTraits.TrailZeroes;\r\n    case \"keepsinglezero\": return FormatTraits.KeepSingleZero;\r\n    case \"zeroempty\": return FormatTraits.ZeroEmpty;\r\n    case \"keepdecimalpoint\": return FormatTraits.KeepDecimalPoint;\r\n    case \"applyrounding\": return FormatTraits.ApplyRounding;\r\n    case \"fractiondash\": return FormatTraits.FractionDash;\r\n    case \"showunitlabel\": return FormatTraits.ShowUnitLabel;\r\n    case \"prependunitlabel\": return FormatTraits.PrependUnitLabel;\r\n    case \"use1000separator\": return FormatTraits.Use1000Separator;\r\n    case \"exponentonlynegative\": return FormatTraits.ExponentOnlyNegative;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'formatTraits' attribute.`);\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport function getTraitString(trait: FormatTraits) {\r\n  switch (trait) {\r\n    case FormatTraits.TrailZeroes:\r\n      return \"trailZeroes\";\r\n    case FormatTraits.KeepSingleZero:\r\n      return \"keepSingleZero\";\r\n    case FormatTraits.ZeroEmpty:\r\n      return \"zeroEmpty\";\r\n    case FormatTraits.KeepDecimalPoint:\r\n      return \"keepDecimalPoint\";\r\n    case FormatTraits.ApplyRounding:\r\n      return \"applyRounding\";\r\n    case FormatTraits.FractionDash:\r\n      return \"fractionDash\";\r\n    case FormatTraits.ShowUnitLabel:\r\n      return \"showUnitLabel\";\r\n    case FormatTraits.PrependUnitLabel:\r\n      return \"prependUnitLabel\";\r\n    case FormatTraits.Use1000Separator:\r\n      return \"use1000Separator\";\r\n    case FormatTraits.ExponentOnlyNegative:\r\n    default:\r\n      return \"exponentOnlyNegative\";\r\n  }\r\n}\r\n\r\n/**  @beta  */\r\nexport function formatTraitsToArray(currentFormatTrait: FormatTraits): string[] {\r\n  const formatTraitsArr = Array<string>();\r\n  if ((currentFormatTrait & FormatTraits.TrailZeroes) === FormatTraits.TrailZeroes)\r\n    formatTraitsArr.push(\"TrailZeroes\");\r\n  if ((currentFormatTrait & FormatTraits.KeepSingleZero) === FormatTraits.KeepSingleZero)\r\n    formatTraitsArr.push(\"KeepSingleZero\");\r\n  if ((currentFormatTrait & FormatTraits.ZeroEmpty) === FormatTraits.ZeroEmpty)\r\n    formatTraitsArr.push(\"ZeroEmpty\");\r\n  if ((currentFormatTrait & FormatTraits.KeepDecimalPoint) === FormatTraits.KeepDecimalPoint)\r\n    formatTraitsArr.push(\"KeepDecimalPoint\");\r\n  if ((currentFormatTrait & FormatTraits.ApplyRounding) === FormatTraits.ApplyRounding)\r\n    formatTraitsArr.push(\"ApplyRounding\");\r\n  if ((currentFormatTrait & FormatTraits.FractionDash) === FormatTraits.FractionDash)\r\n    formatTraitsArr.push(\"FractionDash\");\r\n  if ((currentFormatTrait & FormatTraits.ShowUnitLabel) === FormatTraits.ShowUnitLabel)\r\n    formatTraitsArr.push(\"ShowUnitLabel\");\r\n  if ((currentFormatTrait & FormatTraits.PrependUnitLabel) === FormatTraits.PrependUnitLabel)\r\n    formatTraitsArr.push(\"PrependUnitLabel\");\r\n  if ((currentFormatTrait & FormatTraits.Use1000Separator) === FormatTraits.Use1000Separator)\r\n    formatTraitsArr.push(\"Use1000Separator\");\r\n  if ((currentFormatTrait & FormatTraits.ExponentOnlyNegative) === FormatTraits.ExponentOnlyNegative)\r\n    formatTraitsArr.push(\"ExponentOnlyNegative\");\r\n  return formatTraitsArr;\r\n}\r\n\r\n/**  @beta    */\r\nexport function parseFormatType(jsonObjType: string, formatName: string): FormatType {\r\n  switch (jsonObjType.toLowerCase()) {\r\n    case \"decimal\": return FormatType.Decimal;\r\n    case \"scientific\": return FormatType.Scientific;\r\n    case \"station\": return FormatType.Station;\r\n    case \"fractional\": return FormatType.Fractional;\r\n    case \"bearing\": return FormatType.Bearing;\r\n    case \"azimuth\": return FormatType.Azimuth;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'type' attribute.`);\r\n  }\r\n}\r\n\r\n/** @beta    */\r\nexport function formatTypeToString(type: FormatType): string {\r\n  switch (type) {\r\n    case FormatType.Decimal: return \"Decimal\";\r\n    case FormatType.Scientific: return \"Scientific\";\r\n    case FormatType.Station: return \"Station\";\r\n    case FormatType.Fractional: return \"Fractional\";\r\n    case FormatType.Bearing: return \"Bearing\";\r\n    case FormatType.Azimuth: return \"Azimuth\";\r\n  }\r\n}\r\n\r\n/**  @beta    */\r\nexport function parseDecimalPrecision(jsonObjPrecision: number, formatName: string): DecimalPrecision {\r\n  switch (jsonObjPrecision) {\r\n    case 0: return DecimalPrecision.Zero;\r\n    case 1: return DecimalPrecision.One;\r\n    case 2: return DecimalPrecision.Two;\r\n    case 3: return DecimalPrecision.Three;\r\n    case 4: return DecimalPrecision.Four;\r\n    case 5: return DecimalPrecision.Five;\r\n    case 6: return DecimalPrecision.Six;\r\n    case 7: return DecimalPrecision.Seven;\r\n    case 8: return DecimalPrecision.Eight;\r\n    case 9: return DecimalPrecision.Nine;\r\n    case 10: return DecimalPrecision.Ten;\r\n    case 11: return DecimalPrecision.Eleven;\r\n    case 12: return DecimalPrecision.Twelve;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\r\n  }\r\n}\r\n\r\n/**  @beta validates the input value, that is typically extracted for persisted JSON data, is a valid FractionalPrecision */\r\nexport function parseFractionalPrecision(jsonObjPrecision: number, formatName: string): FractionalPrecision {\r\n  switch (jsonObjPrecision) {\r\n    case 1: return FractionalPrecision.One;\r\n    case 2: return FractionalPrecision.Two;\r\n    case 4: return FractionalPrecision.Four;\r\n    case 8: return FractionalPrecision.Eight;\r\n    case 16: return FractionalPrecision.Sixteen;\r\n    case 32: return FractionalPrecision.ThirtyTwo;\r\n    case 64: return FractionalPrecision.SixtyFour;\r\n    case 128: return FractionalPrecision.OneHundredTwentyEight;\r\n    case 256: return FractionalPrecision.TwoHundredFiftySix;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\r\n  }\r\n}\r\n\r\n/** @beta  validates the input value, that is typically extracted for persisted JSON data, is a valid DecimalPrecision or FractionalPrecision. */\r\nexport function parsePrecision(precision: number, type: FormatType, formatName: string): DecimalPrecision | FractionalPrecision {\r\n  switch (type) { // type must be decimal, fractional, scientific, or station\r\n    case FormatType.Decimal:\r\n    case FormatType.Scientific:\r\n    case FormatType.Station:\r\n    case FormatType.Bearing:\r\n    case FormatType.Azimuth:\r\n      return parseDecimalPrecision(precision, formatName);\r\n    case FormatType.Fractional:\r\n      return parseFractionalPrecision(precision, formatName);\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"FormatEnums.js","sourceRoot":"","sources":["../../../src/Formatter/FormatEnums.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE7D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,8JAA8J,CAAC;AAE9L,gBAAgB;AAChB,MAAM,SAAS,CAAC,CAAC,4BAA4B,CAAC,YAAoB;IAChE,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAClD,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB;IAClC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,mCAAmC;QACpE,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS;YAC5B,MAAM,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY;;YAEpC,MAAM;QACR,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;AACH,CAAC;AACD,YAAY;AACZ,MAAM,CAAN,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACtB,iEAAiB,CAAA;IACjB,mDAAmD;IACnD,6DAAoB,CAAA;IACpB,6FAA6F;IAC7F,mEAAuB,CAAA;IACvB,iDAAiD;IACjD,yDAAkB,CAAA;IAClB,iEAAiE;IACjE,uEAAyB,CAAA;IACzB,kDAAkD;IAClD,kEAAsB,CAAA;IACtB,2DAA2D;IAC3D,gEAAqB,CAAA;IACrB,uCAAuC;IACvC,kEAAsB,CAAA;IACtB,4CAA4C;IAC5C,yEAAyB,CAAA;IACzB,6CAA6C;IAC7C,yEAAyB,CAAA;IACzB,8IAA8I;IAC9I,iFAA6B,CAAA;AAC/B,CAAC,EAtBW,YAAY,KAAZ,YAAY,QAsBvB;AAED;WACW;AACX,MAAM,CAAN,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC7B,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,6DAAQ,CAAA;IACR,+DAAS,CAAA;IACT,oEAAY,CAAA;IACZ,wEAAc,CAAA;IACd,wEAAc,CAAA;IACd,iGAA2B,CAAA;IAC3B,2FAAwB,CAAA;AAC1B,CAAC,EAVW,mBAAmB,KAAnB,mBAAmB,QAU9B;AAED;WACW;AACX,MAAM,CAAN,IAAY,gBAcX;AAdD,WAAY,gBAAgB;IAC1B,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,qDAAO,CAAA;IACP,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,yDAAS,CAAA;IACT,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,sDAAQ,CAAA;IACR,4DAAW,CAAA;IACX,4DAAW,CAAA;AACb,CAAC,EAdW,gBAAgB,KAAhB,gBAAgB,QAc3B;AAED;YACY;AACZ,MAAM,CAAN,IAAY,UAeX;AAfD,WAAY,UAAU;IACpB,iCAAiC;IACjC,iCAAmB,CAAA;IACnB,oCAAoC;IACpC,uCAAyB,CAAA;IACzB,sCAAsC;IACtC,uCAAyB,CAAA;IACzB,8CAA8C;IAC9C,iCAAmB,CAAA;IACnB,gGAAgG;IAChG,iCAAmB,CAAA;IACnB,+FAA+F;IAC/F,iCAAmB,CAAA;IACnB,wCAAwC;IACxC,6BAAe,CAAA;AACjB,CAAC,EAfW,UAAU,KAAV,UAAU,QAerB;AAED;WACW;AACX,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,yDAAyD;IACzD,2CAAyB,CAAA;IACzB,sDAAsD;IACtD,mDAAiC,CAAA;AACnC,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AAED;WACW;AACX,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,8BAA8B;IAC9B,8BAAiB,CAAA;IACjB,8BAA8B;IAC9B,8BAAiB,CAAA;IACjB,4FAA4F;IAC5F,sCAAyB,CAAA;IACzB,2IAA2I;IAC3I,kEAAqD,CAAA;AACvD,CAAC,EATW,SAAS,KAAT,SAAS,QASpB;AAED;WACW;AACX,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACxB,uDAAuD;IACvD,mCAAiB,CAAA;IACjB,mDAAmD;IACnD,+CAA6B,CAAA;IAC7B,oEAAoE;IACpE,2CAAyB,CAAA;IACzB,2IAA2I;IAC3I,6DAA2C,CAAA;AAC7C,CAAC,EATW,cAAc,KAAd,cAAc,QASzB;AAED,6BAA6B;AAE7B;;;EAGE;AACF,MAAM,UAAU,sBAAsB,CAAC,cAA8B;IACnE,OAAO,CAAC,cAAc,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC;AAC1F,CAAC;AAED;;EAEE;AACF,MAAM,UAAU,mBAAmB,CAAC,cAAsB,EAAE,UAAkB;IAC5E,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE,CAAC;QACrC,KAAK,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC,UAAU,CAAC;QACpD,KAAK,gBAAgB,CAAC,CAAC,OAAO,cAAc,CAAC,cAAc,CAAC;QAC5D;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,6CAA6C,CAAC,CAAC;IAC/H,CAAC;AACH,CAAC;AAED,eAAe;AACf,MAAM,UAAU,cAAc,CAAC,SAAiB,EAAE,UAAkB;IAClE,MAAM,eAAe,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAChD,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC5B,IAAI,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,SAAS,GAAG,SAAS,CAAC,GAA6B,CAAC,CAAC;YAC3D,IAAI,SAAS,CAAC,WAAW,EAAE,KAAK,eAAe,EAAE,CAAC;gBAChD,OAAO,SAAsB,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;AACxH,CAAC;AAED,eAAe;AACf,MAAM,UAAU,mBAAmB,CAAC,cAAsB,EAAE,UAAkB;IAC5E,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE,CAAC;QACrC,KAAK,QAAQ,CAAC,CAAC,OAAO,cAAc,CAAC,MAAM,CAAC;QAC5C,KAAK,cAAc,CAAC,CAAC,OAAO,cAAc,CAAC,YAAY,CAAC;QACxD,KAAK,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC,UAAU,CAAC;QACpD,KAAK,qBAAqB,CAAC,CAAC,OAAO,cAAc,CAAC,mBAAmB,CAAC;QACtE;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,6CAA6C,CAAC,CAAC;IAC/H,CAAC;AACH,CAAC;AAED;;;EAGE;AACF,MAAM,UAAU,sBAAsB,CAAC,QAAwB;IAC7D,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,cAAc,CAAC,mBAAmB,CAAC,CAAC,OAAO,qBAAqB,CAAC;QACtE,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,QAAQ,CAAC;QAC5C,KAAK,cAAc,CAAC,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC;QACxD,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;IACtD,CAAC;AACH,CAAC;AAED,cAAc;AACd,MAAM,UAAU,gBAAgB,CAAC,kBAA0B,EAAE,UAAkB;IAC7E,QAAQ,kBAAkB,CAAC,WAAW,EAAE,EAAE,CAAC;QACzC,KAAK,aAAa,CAAC,CAAC,OAAO,YAAY,CAAC,WAAW,CAAC;QACpD,KAAK,gBAAgB,CAAC,CAAC,OAAO,YAAY,CAAC,cAAc,CAAC;QAC1D,KAAK,WAAW,CAAC,CAAC,OAAO,YAAY,CAAC,SAAS,CAAC;QAChD,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,eAAe,CAAC,CAAC,OAAO,YAAY,CAAC,aAAa,CAAC;QACxD,KAAK,cAAc,CAAC,CAAC,OAAO,YAAY,CAAC,YAAY,CAAC;QACtD,KAAK,eAAe,CAAC,CAAC,OAAO,YAAY,CAAC,aAAa,CAAC;QACxD,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,sBAAsB,CAAC,CAAC,OAAO,YAAY,CAAC,oBAAoB,CAAC;QACtE;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,2CAA2C,CAAC,CAAC;IAC7H,CAAC;AACH,CAAC;AAED,YAAY;AACZ,MAAM,UAAU,cAAc,CAAC,KAAmB;IAChD,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,YAAY,CAAC,WAAW;YAC3B,OAAO,aAAa,CAAC;QACvB,KAAK,YAAY,CAAC,cAAc;YAC9B,OAAO,gBAAgB,CAAC;QAC1B,KAAK,YAAY,CAAC,SAAS;YACzB,OAAO,WAAW,CAAC;QACrB,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,aAAa;YAC7B,OAAO,eAAe,CAAC;QACzB,KAAK,YAAY,CAAC,YAAY;YAC5B,OAAO,cAAc,CAAC;QACxB,KAAK,YAAY,CAAC,aAAa;YAC7B,OAAO,eAAe,CAAC;QACzB,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,oBAAoB,CAAC;QACvC;YACE,OAAO,sBAAsB,CAAC;IAClC,CAAC;AACH,CAAC;AAED,cAAc;AACd,MAAM,UAAU,mBAAmB,CAAC,kBAAgC;IAClE,MAAM,eAAe,GAAG,KAAK,EAAU,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,WAAW,CAAC,KAAK,YAAY,CAAC,WAAW;QAC9E,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACtC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,cAAc,CAAC,KAAK,YAAY,CAAC,cAAc;QACpF,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACzC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,SAAS,CAAC,KAAK,YAAY,CAAC,SAAS;QAC1E,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,KAAK,YAAY,CAAC,aAAa;QAClF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,YAAY,CAAC,KAAK,YAAY,CAAC,YAAY;QAChF,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,KAAK,YAAY,CAAC,aAAa;QAClF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,oBAAoB,CAAC,KAAK,YAAY,CAAC,oBAAoB;QAChG,eAAe,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC/C,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,eAAe,CAAC,WAAmB,EAAE,UAAkB;IACrE,QAAQ,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC;QAClC,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;QAChD,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;QAChD,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,OAAO,CAAC,CAAC,OAAO,UAAU,CAAC,KAAK,CAAC;QACtC;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,mCAAmC,CAAC,CAAC;IACrH,CAAC;AACH,CAAC;AAED;;EAEE;AACF,MAAM,UAAU,kBAAkB,CAAC,IAAgB;IACjD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;QAChD,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;QAChD,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,OAAO,CAAC;IACxC,CAAC;AACH,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,qBAAqB,CAAC,gBAAwB,EAAE,UAAkB;IAChF,QAAQ,gBAAgB,EAAE,CAAC;QACzB,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACrC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC;QACxC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC;QACxC;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;IAC1H,CAAC;AACH,CAAC;AAED,4HAA4H;AAC5H,MAAM,UAAU,wBAAwB,CAAC,gBAAwB,EAAE,UAAkB;IACnF,QAAQ,gBAAgB,EAAE,CAAC;QACzB,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,GAAG,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,GAAG,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,IAAI,CAAC;QACxC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC;QACzC,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,OAAO,CAAC;QAC5C,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC;QAC9C,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC;QAC9C,KAAK,GAAG,CAAC,CAAC,OAAO,mBAAmB,CAAC,qBAAqB,CAAC;QAC3D,KAAK,GAAG,CAAC,CAAC,OAAO,mBAAmB,CAAC,kBAAkB,CAAC;QACxD;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;IAC1H,CAAC;AACH,CAAC;AAED,iJAAiJ;AACjJ,MAAM,UAAU,cAAc,CAAC,SAAiB,EAAE,IAAgB,EAAE,UAAkB;IACpF,QAAQ,IAAI,EAAE,CAAC,CAAC,2DAA2D;QACzE,KAAK,UAAU,CAAC,OAAO,CAAC;QACxB,KAAK,UAAU,CAAC,UAAU,CAAC;QAC3B,KAAK,UAAU,CAAC,OAAO,CAAC;QACxB,KAAK,UAAU,CAAC,KAAK,CAAC;QACtB,KAAK,UAAU,CAAC,OAAO,CAAC;QACxB,KAAK,UAAU,CAAC,OAAO;YACrB,OAAO,qBAAqB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACtD,KAAK,UAAU,CAAC,UAAU;YACxB,OAAO,wBAAwB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACzD;YACE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;IAC1H,CAAC;AACH,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Quantity\n */\n\nimport { QuantityError, QuantityStatus } from \"../Exception\";\n\n/** The regular expression to parse [format strings]($docs/bis/ec/kindofquantity.md#format-string)\n * provided in serialized formats as well as the full name of an [[OverrideFormat]].\n *\n * `formatName(precision)[unitName|unitLabel][unitName|unitLabel][unitName|unitLabel][unitName|unitLabel]`\n *\n * Explanation of the regex:\n * - ([\\w.:]+)\n *   - Grabs the format full name\n * - (\\(([^\\)]+)\\))?\n *   - Grabs the precision part with and without the `()`.\n *   - The parentheses are needed to validate the entire string.  (TODO: Need to check if this is true)\n * - (\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?\n *   - 4 of these make up the rest of the regex, none of them are required so each end in `?`\n *   - Grabs the unit name and label including the `[]`\n *   - Grabs the unit name, `|` and label separately\n * @internal\n */\nexport const formatStringRgx = /([\\w.:]+)(\\(([^\\)]+)\\))?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?/;\n\n/** @internal */\nexport function* getItemNamesFromFormatString(formatString: string): Iterable<string> {\n  const match = formatString.split(formatStringRgx);\n  yield match[1]; // the Format Name\n  let index = 4;\n  while (index < match.length - 1) { // index 0 and 21 are empty strings\n    if (match[index] !== undefined)\n      yield match[index + 1]; // Unit Name\n    else\n      break;\n    index += 4;\n  }\n}\n/** @beta */\nexport enum FormatTraits {\n  Uninitialized = 0,\n  /** Show trailing zeroes to requested precision. */\n  TrailZeroes = 1 << 0,\n  /** Indicates that the fractional part of the number is required when the fraction is zero */\n  KeepSingleZero = 1 << 1,\n  /** Zero magnitude returns blank display value */\n  ZeroEmpty = 1 << 2,\n  /** Show decimal point when value to right of decimal is empty */\n  KeepDecimalPoint = 1 << 3,\n  /** Use the rounding factor. Not yet supported  */\n  ApplyRounding = 1 << 4,\n  /** Show a dash between whole value and fractional value */\n  FractionDash = 1 << 5,\n  /** Append the quantity's unit label */\n  ShowUnitLabel = 1 << 6,\n  /** Prepend unit label. Not yet supported */\n  PrependUnitLabel = 1 << 7,\n  /** show a grouping in each group of 1000. */\n  Use1000Separator = 1 << 8,\n  /** Indicates that if an exponent value is positive to not include a `+`. By default a sign, `+` or `-`, is always shown. Not yet supported */\n  ExponentOnlyNegative = 1 << 9,\n}\n\n/** Precision for Fractional formatted value types. Range from Whole (1/1) through 1/256.\n * @beta */\nexport enum FractionalPrecision {\n  One = 1,\n  Two = 2,\n  Four = 4,\n  Eight = 8,\n  Sixteen = 16,\n  ThirtyTwo = 32,\n  SixtyFour = 64,\n  OneHundredTwentyEight = 128,\n  TwoHundredFiftySix = 256,\n}\n\n/** Precision for Decimal, Scientific, and Station formatted value types. Range from 1/(10^0) through 1/(10^12).\n * @beta */\nexport enum DecimalPrecision {\n  Zero = 0,\n  One = 1,\n  Two = 2,\n  Three = 3,\n  Four = 4,\n  Five = 5,\n  Six = 6,\n  Seven = 7,\n  Eight = 8,\n  Nine = 9,\n  Ten = 10,\n  Eleven = 11,\n  Twelve = 12,\n}\n\n/** Supported format types\n *  @beta */\nexport enum FormatType {\n  /** Decimal display (ie 2.125) */\n  Decimal = \"Decimal\",\n  /** Fractional display (ie 2-1/8) */\n  Fractional = \"Fractional\",\n  /** Scientific Notation (ie 1.04e3) */\n  Scientific = \"Scientific\",\n  /** Civil Engineering Stationing (ie 1+00). */\n  Station = \"Station\",\n  /** Bearing angle e.g. N05:00:00E. Requires provided quantities to be of the angle phenomenon */\n  Bearing = \"Bearing\",\n  /** Azimuth angle e.g. 45°30'00\". Requires provided quantities to be of the angle phenomenon */\n  Azimuth = \"Azimuth\",\n  /** Ratio display e,g. 1:2 or 0.3:1.  */\n  Ratio = \"Ratio\",\n}\n\n/** required if type is scientific\n * @beta */\nexport enum ScientificType {\n  /** Non-zero value left of decimal point (ie 1.2345e3) */\n  Normalized = \"Normalized\",\n  /** Zero value left of decimal point (ie 0.12345e4) */\n  ZeroNormalized = \"ZeroNormalized\",\n}\n\n/** required if type is ratio\n * @beta */\nexport enum RatioType {\n  /** One to N ratio (ie 1:N) */\n  OneToN = \"OneToN\",\n  /** N to One ratio (ie N:1) */\n  NToOne = \"NToOne\",\n  /**  the lesser value scales to 1. e.g. input 0.5 turns into 2:1 | input 2 turns into 1:2 */\n  ValueBased = \"ValueBased\",\n  /**  scales the input ratio to its simplest integer form using the greatest common divisor (GCD) of the values. e.g. 0.3 turns into 3:10 */\n  UseGreatestCommonDivisor = \"UseGreatestCommonDivisor\",\n}\n\n/** Determines how the sign of values are displayed\n * @beta */\nexport enum ShowSignOption {\n  /** Never show a sign even if the value is negative. */\n  NoSign = \"NoSign\",\n  /** Only show a sign when the value is negative. */\n  OnlyNegative = \"OnlyNegative\",\n  /** Always show a sign whether the value is positive or negative. */\n  SignAlways = \"SignAlways\",\n  /** Only show a sign when the value is negative but use parentheses instead of a negative sign. For example, -10 is formatted as `(10)`. */\n  NegativeParentheses = \"NegativeParentheses\",\n}\n\n// parse and toString methods\n\n/**\n * @beta\n * @deprecated in 4.10. ScientificType is now a string enum and doesn't need a serialization method. You can access the enum directly.\n*/\nexport function scientificTypeToString(scientificType: ScientificType): string {\n  return (scientificType === ScientificType.Normalized) ? \"Normalized\" : \"ZeroNormalized\";\n}\n\n/**\n * @beta\n*/\nexport function parseScientificType(scientificType: string, formatName: string): ScientificType {\n  switch (scientificType.toLowerCase()) {\n    case \"normalized\": return ScientificType.Normalized;\n    case \"zeronormalized\": return ScientificType.ZeroNormalized;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'scientificType' attribute.`);\n  }\n}\n\n/**  @beta   */\nexport function parseRatioType(ratioType: string, formatName: string): RatioType {\n  const normalizedValue = ratioType.toLowerCase();\n  for (const key in RatioType) {\n    if (RatioType.hasOwnProperty(key)) {\n      const enumValue = RatioType[key as keyof typeof RatioType];\n      if (enumValue.toLowerCase() === normalizedValue) {\n        return enumValue as RatioType;\n      }\n    }\n  }\n  throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'ratioType' attribute.`);\n}\n\n/** @beta    */\nexport function parseShowSignOption(showSignOption: string, formatName: string): ShowSignOption {\n  switch (showSignOption.toLowerCase()) {\n    case \"nosign\": return ShowSignOption.NoSign;\n    case \"onlynegative\": return ShowSignOption.OnlyNegative;\n    case \"signalways\": return ShowSignOption.SignAlways;\n    case \"negativeparentheses\": return ShowSignOption.NegativeParentheses;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'showSignOption' attribute.`);\n  }\n}\n\n/**\n * @beta\n * @deprecated in 4.10. ShowSignOption is now a string enum and doesn't need a serialization method. You can access the enum directly.\n*/\nexport function showSignOptionToString(showSign: ShowSignOption): string {\n  switch (showSign) {\n    case ShowSignOption.NegativeParentheses: return \"NegativeParentheses\";\n    case ShowSignOption.NoSign: return \"NoSign\";\n    case ShowSignOption.OnlyNegative: return \"OnlyNegative\";\n    case ShowSignOption.SignAlways: return \"SignAlways\";\n  }\n}\n\n/**  @beta  */\nexport function parseFormatTrait(formatTraitsString: string, formatName: string): FormatTraits {\n  switch (formatTraitsString.toLowerCase()) {\n    case \"trailzeroes\": return FormatTraits.TrailZeroes;\n    case \"keepsinglezero\": return FormatTraits.KeepSingleZero;\n    case \"zeroempty\": return FormatTraits.ZeroEmpty;\n    case \"keepdecimalpoint\": return FormatTraits.KeepDecimalPoint;\n    case \"applyrounding\": return FormatTraits.ApplyRounding;\n    case \"fractiondash\": return FormatTraits.FractionDash;\n    case \"showunitlabel\": return FormatTraits.ShowUnitLabel;\n    case \"prependunitlabel\": return FormatTraits.PrependUnitLabel;\n    case \"use1000separator\": return FormatTraits.Use1000Separator;\n    case \"exponentonlynegative\": return FormatTraits.ExponentOnlyNegative;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'formatTraits' attribute.`);\n  }\n}\n\n/** @beta */\nexport function getTraitString(trait: FormatTraits) {\n  switch (trait) {\n    case FormatTraits.TrailZeroes:\n      return \"trailZeroes\";\n    case FormatTraits.KeepSingleZero:\n      return \"keepSingleZero\";\n    case FormatTraits.ZeroEmpty:\n      return \"zeroEmpty\";\n    case FormatTraits.KeepDecimalPoint:\n      return \"keepDecimalPoint\";\n    case FormatTraits.ApplyRounding:\n      return \"applyRounding\";\n    case FormatTraits.FractionDash:\n      return \"fractionDash\";\n    case FormatTraits.ShowUnitLabel:\n      return \"showUnitLabel\";\n    case FormatTraits.PrependUnitLabel:\n      return \"prependUnitLabel\";\n    case FormatTraits.Use1000Separator:\n      return \"use1000Separator\";\n    case FormatTraits.ExponentOnlyNegative:\n    default:\n      return \"exponentOnlyNegative\";\n  }\n}\n\n/**  @beta  */\nexport function formatTraitsToArray(currentFormatTrait: FormatTraits): string[] {\n  const formatTraitsArr = Array<string>();\n  if ((currentFormatTrait & FormatTraits.TrailZeroes) === FormatTraits.TrailZeroes)\n    formatTraitsArr.push(\"TrailZeroes\");\n  if ((currentFormatTrait & FormatTraits.KeepSingleZero) === FormatTraits.KeepSingleZero)\n    formatTraitsArr.push(\"KeepSingleZero\");\n  if ((currentFormatTrait & FormatTraits.ZeroEmpty) === FormatTraits.ZeroEmpty)\n    formatTraitsArr.push(\"ZeroEmpty\");\n  if ((currentFormatTrait & FormatTraits.KeepDecimalPoint) === FormatTraits.KeepDecimalPoint)\n    formatTraitsArr.push(\"KeepDecimalPoint\");\n  if ((currentFormatTrait & FormatTraits.ApplyRounding) === FormatTraits.ApplyRounding)\n    formatTraitsArr.push(\"ApplyRounding\");\n  if ((currentFormatTrait & FormatTraits.FractionDash) === FormatTraits.FractionDash)\n    formatTraitsArr.push(\"FractionDash\");\n  if ((currentFormatTrait & FormatTraits.ShowUnitLabel) === FormatTraits.ShowUnitLabel)\n    formatTraitsArr.push(\"ShowUnitLabel\");\n  if ((currentFormatTrait & FormatTraits.PrependUnitLabel) === FormatTraits.PrependUnitLabel)\n    formatTraitsArr.push(\"PrependUnitLabel\");\n  if ((currentFormatTrait & FormatTraits.Use1000Separator) === FormatTraits.Use1000Separator)\n    formatTraitsArr.push(\"Use1000Separator\");\n  if ((currentFormatTrait & FormatTraits.ExponentOnlyNegative) === FormatTraits.ExponentOnlyNegative)\n    formatTraitsArr.push(\"ExponentOnlyNegative\");\n  return formatTraitsArr;\n}\n\n/**  @beta    */\nexport function parseFormatType(jsonObjType: string, formatName: string): FormatType {\n  switch (jsonObjType.toLowerCase()) {\n    case \"decimal\": return FormatType.Decimal;\n    case \"scientific\": return FormatType.Scientific;\n    case \"station\": return FormatType.Station;\n    case \"fractional\": return FormatType.Fractional;\n    case \"bearing\": return FormatType.Bearing;\n    case \"azimuth\": return FormatType.Azimuth;\n    case \"ratio\": return FormatType.Ratio;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'type' attribute.`);\n  }\n}\n\n/** @beta\n *  @deprecated in 4.10. FormatType is now a string enum and doesn't need a serialization method. You can access the enum directly.\n*/\nexport function formatTypeToString(type: FormatType): string {\n  switch (type) {\n    case FormatType.Decimal: return \"Decimal\";\n    case FormatType.Scientific: return \"Scientific\";\n    case FormatType.Station: return \"Station\";\n    case FormatType.Fractional: return \"Fractional\";\n    case FormatType.Bearing: return \"Bearing\";\n    case FormatType.Azimuth: return \"Azimuth\";\n    case FormatType.Ratio: return \"Ratio\";\n  }\n}\n\n/**  @beta    */\nexport function parseDecimalPrecision(jsonObjPrecision: number, formatName: string): DecimalPrecision {\n  switch (jsonObjPrecision) {\n    case 0: return DecimalPrecision.Zero;\n    case 1: return DecimalPrecision.One;\n    case 2: return DecimalPrecision.Two;\n    case 3: return DecimalPrecision.Three;\n    case 4: return DecimalPrecision.Four;\n    case 5: return DecimalPrecision.Five;\n    case 6: return DecimalPrecision.Six;\n    case 7: return DecimalPrecision.Seven;\n    case 8: return DecimalPrecision.Eight;\n    case 9: return DecimalPrecision.Nine;\n    case 10: return DecimalPrecision.Ten;\n    case 11: return DecimalPrecision.Eleven;\n    case 12: return DecimalPrecision.Twelve;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\n  }\n}\n\n/**  @beta validates the input value, that is typically extracted for persisted JSON data, is a valid FractionalPrecision */\nexport function parseFractionalPrecision(jsonObjPrecision: number, formatName: string): FractionalPrecision {\n  switch (jsonObjPrecision) {\n    case 1: return FractionalPrecision.One;\n    case 2: return FractionalPrecision.Two;\n    case 4: return FractionalPrecision.Four;\n    case 8: return FractionalPrecision.Eight;\n    case 16: return FractionalPrecision.Sixteen;\n    case 32: return FractionalPrecision.ThirtyTwo;\n    case 64: return FractionalPrecision.SixtyFour;\n    case 128: return FractionalPrecision.OneHundredTwentyEight;\n    case 256: return FractionalPrecision.TwoHundredFiftySix;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\n  }\n}\n\n/** @beta  validates the input value, that is typically extracted for persisted JSON data, is a valid DecimalPrecision or FractionalPrecision. */\nexport function parsePrecision(precision: number, type: FormatType, formatName: string): DecimalPrecision | FractionalPrecision {\n  switch (type) { // type must be decimal, fractional, scientific, or station\n    case FormatType.Decimal:\n    case FormatType.Scientific:\n    case FormatType.Station:\n    case FormatType.Ratio:\n    case FormatType.Bearing:\n    case FormatType.Azimuth:\n      return parseDecimalPrecision(precision, formatName);\n    case FormatType.Fractional:\n      return parseFractionalPrecision(precision, formatName);\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\n  }\n}\n"]}

package/lib/esm/Formatter/Formatter.d.ts

@@ -45,5 +45,6 @@ export declare class Formatter {
     private static processBearingAndAzimuth;
     private static normalizeAngle;
     private static getRevolution;
+    private static formatRatio;
 }
 //# sourceMappingURL=Formatter.d.ts.map

package/lib/esm/Formatter/Formatter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Formatter.d.ts","sourceRoot":"","sources":["../../../src/Formatter/Formatter.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AA8FhD;;GAEG;AACH,qBAAa,SAAS;IAEpB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAW;IAE1C,OAAO,CAAC,MAAM,CAAC,YAAY;IAE3B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAW1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IA0BhC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAajC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAkBlC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAsC9B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IA6H9B,OAAO,CAAC,MAAM,CAAC,WAAW;IAU1B;;;OAGG;WACW,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,MAAM;IA8D5E,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAoFvC,OAAO,CAAC,MAAM,CAAC,cAAc;IAS7B,OAAO,CAAC,MAAM,CAAC,aAAa;CAa7B"}
+{"version":3,"file":"Formatter.d.ts","sourceRoot":"","sources":["../../../src/Formatter/Formatter.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AA8FhD;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAW;IAE1C,OAAO,CAAC,MAAM,CAAC,YAAY;IAE3B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAW1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IA0BhC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAajC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAkBlC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAyD9B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IA6H9B,OAAO,CAAC,MAAM,CAAC,WAAW;IAU1B;;;OAGG;WACW,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,MAAM;IA8D5E,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAoFvC,OAAO,CAAC,MAAM,CAAC,cAAc;IAS7B,OAAO,CAAC,MAAM,CAAC,aAAa;IAc5B,OAAO,CAAC,MAAM,CAAC,WAAW;CAqC3B"}

package/lib/esm/Formatter/Formatter.js

@@ -7,8 +7,8 @@
  */
 import { QuantityConstants } from "../Constants";
 import { QuantityError, QuantityStatus } from "../Exception";
-import { DecimalPrecision, FormatTraits, FormatType, ScientificType, ShowSignOption } from "./FormatEnums";
-import { Quantity } from "../Quantity";
+import { DecimalPrecision, FormatTraits, FormatType, RatioType, ScientificType, ShowSignOption } from "./FormatEnums";
+import { applyConversion, Quantity } from "../Quantity";
 /**  rounding additive
  * @internal
  */
@@ -37,13 +37,13 @@ class FractionalNumeric {
             this._integral += 1;
         }
         else {
-            this._greatestCommonFactor = this.getGreatestCommonFactor(this._numerator, this._denominator);
+            this._greatestCommonFactor = FractionalNumeric.getGreatestCommonFactor(this._numerator, this._denominator);
         }
     }
     /** Determine the GCD given two values. This value can be used to reduce a fraction.
      * See algorithm description http://en.wikipedia.org/wiki/Euclidean_algorithm
      */
-    getGreatestCommonFactor(numerator, denominator) {
+    static getGreatestCommonFactor(numerator, denominator) {
         let r;
         while (denominator !== 0) {
             r = numerator % denominator;
@@ -168,15 +168,31 @@ export class Formatter {
         const compositeStrings = [];
         // Caller will deal with appending +||-||() value sign as specified by formatting options so just format positive value
         let posMagnitude = Math.abs(magnitude);
-        // eslint-disable-next-line @typescript-eslint/prefer-for-of
         for (let i = 0; i < spec.unitConversions.length; i++) {
             const currentLabel = spec.unitConversions[i].label;
             const unitConversion = spec.unitConversions[i].conversion;
             if (i > 0 && unitConversion.factor < 1.0)
                 throw new QuantityError(QuantityStatus.InvalidCompositeFormat, `The Format ${spec.format.name} has a invalid unit specification..`);
-            if (i > 0 && unitConversion.offset !== 0)
+            if (i > 0 && unitConversion.offset !== 0) // offset should only ever be defined for major unit
                 throw new QuantityError(QuantityStatus.InvalidCompositeFormat, `The Format ${spec.format.name} has a invalid unit specification..`);
-            let unitValue = (posMagnitude * unitConversion.factor) + unitConversion.offset + Formatter.FPV_MINTHRESHOLD; // offset should only ever be defined for major unit
+            let unitValue = 0.0;
+            if (spec.format.type === FormatType.Ratio) {
+                if (1 !== spec.format.units.length)
+                    throw new QuantityError(QuantityStatus.InvalidCompositeFormat, `The Format ${spec.format.name} has an invalid unit specification, we require single presentation unit when using format type 'ratio'`);
+                try {
+                    unitValue = applyConversion(posMagnitude, unitConversion) + this.FPV_MINTHRESHOLD;
+                }
+                catch (e) {
+                    // The "InvertingZero" error is thrown when the value is zero and the conversion factor is inverted.
+                    // For ratio, we actually want to support this corner case and return "1:0" as the formatted value.
+                    if (e instanceof QuantityError && e.errorNumber === QuantityStatus.InvertingZero) {
+                        return "1:0";
+                    }
+                }
+                compositeStrings.push(this.formatRatio(unitValue, spec));
+                continue;
+            }
+            unitValue = applyConversion(posMagnitude, unitConversion) + this.FPV_MINTHRESHOLD;
             if (0 === i) {
                 const precisionScale = Math.pow(10, 8); // use a fixed round off precision of 8 to avoid loss of precision in actual magnitude
                 unitValue = Math.floor(unitValue * precisionScale + FPV_ROUNDFACTOR) / precisionScale;
@@ -206,7 +222,7 @@ export class Formatter {
         if (spec.format.hasFormatTraitSet(FormatTraits.ApplyRounding))
             posMagnitude = Math.abs(Formatter.roundDouble(magnitude, spec.format.roundFactor));
         const isSci = ((posMagnitude > 1.0e12) || spec.format.type === FormatType.Scientific);
-        const isDecimal = (isSci || spec.format.type === FormatType.Decimal || spec.format.type === FormatType.Bearing || spec.format.type === FormatType.Azimuth);
+        const isDecimal = (isSci || spec.format.type === FormatType.Decimal || spec.format.type === FormatType.Bearing || spec.format.type === FormatType.Azimuth) || spec.format.type === FormatType.Ratio;
         const isFractional = (!isDecimal && spec.format.type === FormatType.Fractional);
         /* const usesStops = spec.format.type === FormatType.Station; */
         const isPrecisionZero = spec.format.precision === DecimalPrecision.Zero;
@@ -393,35 +409,35 @@ export class Formatter {
             }
             let prefix, suffix;
             // Quadrants are
-            // 1 0
-            // 2 3
-            // For quadrants 0 and 2 we have to subtract the angle from quarterRevolution degrees because they go clockwise
-            if (quadrant === 0 || quadrant === 2)
+            // 3 0
+            // 2 1
+            // For quadrants 1 and 3 we have to subtract the angle from quarterRevolution degrees because they go counter-clockwise
+            if (quadrant === 1 || quadrant === 3)
                 magnitude = quarterRevolution - magnitude;
             // TODO: at some point we will want to open this for localization, in the first release it's going to be hard coded
-            if (quadrant === 0 || quadrant === 1)
+            if (quadrant === 0 || quadrant === 3)
                 prefix = "N";
-            if (quadrant === 2 || quadrant === 3)
+            if (quadrant === 2 || quadrant === 1)
                 prefix = "S";
-            if (quadrant === 0 || quadrant === 3)
+            if (quadrant === 0 || quadrant === 1)
                 suffix = "E";
-            if (quadrant === 1 || quadrant === 2)
+            if (quadrant === 3 || quadrant === 2)
                 suffix = "W";
-            // special case, if in quadrant 2 and value is very small, turn suffix to E because S00:00:00E is preferred over S00:00:00W
+            // special case, if in quadrant 2 and value is very close to quarter revolution (90°), turn prefix to N because N90:00:00W is preferred over S90:00:00W
             if (quadrant === 2 && spec.unitConversions.length > 0) {
                 // To determine if value is small, we need to convert it to the smallest unit presented and use the provided precision on it
                 const unitConversion = spec.unitConversions[spec.unitConversions.length - 1].conversion;
-                const smallestFormattedValue = (magnitude * unitConversion.factor) + unitConversion.offset + Formatter.FPV_MINTHRESHOLD;
+                const smallestFormattedDelta = applyConversion((quarterRevolution - magnitude), unitConversion) + this.FPV_MINTHRESHOLD;
                 const precisionScale = Math.pow(10.0, spec.format.precision);
-                const floor = Math.floor((smallestFormattedValue) * precisionScale + FPV_ROUNDFACTOR) / precisionScale;
+                const floor = Math.floor((smallestFormattedDelta) * precisionScale + FPV_ROUNDFACTOR) / precisionScale;
                 if (floor === 0) {
-                    suffix = "E";
+                    prefix = "N";
                 }
             }
             return { magnitude, prefix, suffix: suffix };
         }
         if (type === FormatType.Azimuth) {
-            let azimuthBase = quarterRevolution; // default base is North
+            let azimuthBase = 0; // default base is North
             if (spec.format.azimuthBase !== undefined) {
                 if (spec.azimuthBaseConversion === undefined) {
                     throw new QuantityError(QuantityStatus.MissingRequiredProperty, `Missing azimuth base conversion for interpreting ${spec.name}'s azimuth base.`);
@@ -433,13 +449,13 @@ export class Formatter {
                 }
                 azimuthBase = this.normalizeAngle(azBaseConverted.magnitude, revolution);
             }
-            if (azimuthBase === quarterRevolution && spec.format.azimuthCounterClockwiseOrDefault)
-                return { magnitude }; // no conversion necessary, the input is already using the result parameters (east base and counter clockwise)
+            if (azimuthBase === 0.0 && spec.format.azimuthClockwiseOrDefault)
+                return { magnitude }; // no conversion necessary, the input is already using the result parameters (north base and clockwise)
             // subtract the base from the actual value
             magnitude -= azimuthBase;
-            if (spec.format.azimuthCounterClockwiseOrDefault)
+            if (spec.format.azimuthClockwiseOrDefault)
                 return { magnitude: this.normalizeAngle(magnitude, revolution) };
-            // turn it into a clockwise angle
+            // turn it into a counter-clockwise angle
             magnitude = revolution - magnitude;
             // normalize the result as it may have become negative or exceed the revolution
             magnitude = this.normalizeAngle(magnitude, revolution);
@@ -463,7 +479,37 @@ export class Formatter {
         }
         return converted.magnitude;
     }
+    static formatRatio(magnitude, spec) {
+        if (null === spec.format.ratioType)
+            throw new QuantityError(QuantityStatus.InvalidCompositeFormat, `The Format ${spec.format.name} must have a ratio type specified.`);
+        const precisionScale = Math.pow(10.0, spec.format.precision);
+        let reciprocal = 0;
+        if (magnitude === 0.0)
+            return "0:1";
+        else
+            reciprocal = 1.0 / magnitude;
+        switch (spec.format.ratioType) {
+            case RatioType.OneToN:
+                return `1:${this.formatMagnitude(reciprocal, spec)}`;
+            case RatioType.NToOne:
+                return `${this.formatMagnitude(magnitude, spec)}:1`;
+            case RatioType.ValueBased:
+                if (magnitude > 1.0)
+                    return `${this.formatMagnitude(magnitude, spec)}:1`;
+                else
+                    return `1:${this.formatMagnitude(reciprocal, spec)}`;
+            case RatioType.UseGreatestCommonDivisor:
+                magnitude = Math.round(magnitude * precisionScale) / precisionScale;
+                let numerator = magnitude * precisionScale;
+                let denominator = precisionScale;
+                const gcd = FractionalNumeric.getGreatestCommonFactor(numerator, denominator);
+                numerator /= gcd;
+                denominator /= gcd;
+                return `${this.formatMagnitude(numerator, spec)}:${this.formatMagnitude(denominator, spec)}`;
+            default:
+                throw new QuantityError(QuantityStatus.InvalidCompositeFormat, `The Format ${spec.format.name} has an invalid ratio type specified.`);
+        }
+    }
 }
-// eslint-disable-next-line @typescript-eslint/naming-convention
 Formatter.FPV_MINTHRESHOLD = 1.0e-14;
 //# sourceMappingURL=Formatter.js.map