@itwin/core-quantity 5.6.0-dev.13 → 5.6.0-dev.14

package/lib/esm/Formatter/FormatterSpec.js

@@ -5,6 +5,7 @@
 /** @packageDocumentation
  * @module Quantity
  */
+import { FormatType } from "./FormatEnums";
 import { Formatter } from "./Formatter";
 // cSpell:ignore ZERONORMALIZED, nosign, onlynegative, signalways, negativeparentheses
 // cSpell:ignore trailzeroes, keepsinglezero, zeroempty, keepdecimalpoint, applyrounding, fractiondash, showunitlabel, prependunitlabel, exponentonlynegative
@@ -52,6 +53,49 @@ export class FormatterSpec {
     get persistenceUnit() { return this._persistenceUnit; }
     get azimuthBaseConversion() { return this._azimuthBaseConversion; }
     get revolutionConversion() { return this._revolutionConversion; }
+    /** Build conversion specs for ratio format with 2 composite units (numerator/denominator). */
+    static async getRatioUnitConversions(units, unitsProvider, persistenceUnit) {
+        const conversions = [];
+        const [numeratorUnit, numeratorLabel] = units[0];
+        const [denominatorUnit, denominatorLabel] = units[1];
+        // Compute ratio scale: how many numerator units per denominator unit (e.g., IN:FT = 12)
+        const denominatorToNumerator = await unitsProvider.getConversion(denominatorUnit, numeratorUnit);
+        const displayRatioScale = denominatorToNumerator.factor;
+        // Avoid double-scaling: if persistence unit already encodes the display ratio, use factor 1.
+        // Check by name heuristic (e.g., IN_PER_FT with ratioUnits [IN, FT] → no scaling needed)
+        const persistenceName = persistenceUnit.name.toUpperCase();
+        const numName = numeratorUnit.name.toUpperCase().split(".").pop() ?? "";
+        const denName = denominatorUnit.name.toUpperCase().split(".").pop() ?? "";
+        // Split by word boundaries (underscores, dots) and check for exact token matches
+        const persistenceTokens = persistenceName.split(/[._]/);
+        const isPersistenceMatchingRatio = persistenceTokens.includes(numName) && persistenceTokens.includes(denName);
+        const ratioScaleFactor = isPersistenceMatchingRatio ? 1.0 : displayRatioScale;
+        // First conversion spec: effective ratio unit conversion
+        const ratioConversionSpec = {
+            name: `${numeratorUnit.name}_per_${denominatorUnit.name}`,
+            label: "",
+            system: numeratorUnit.system,
+            conversion: { factor: ratioScaleFactor, offset: 0.0 },
+        };
+        conversions.push(ratioConversionSpec);
+        // Numerator unit for label lookup
+        const numeratorSpec = {
+            name: numeratorUnit.name,
+            label: numeratorLabel?.length ? numeratorLabel : numeratorUnit.label,
+            system: numeratorUnit.system,
+            conversion: { factor: 1.0, offset: 0.0 },
+        };
+        conversions.push(numeratorSpec);
+        // Denominator unit for label lookup
+        const denominatorSpec = {
+            name: denominatorUnit.name,
+            label: denominatorLabel?.length ? denominatorLabel : denominatorUnit.label,
+            system: denominatorUnit.system,
+            conversion: { factor: 1.0, offset: 0.0 },
+        };
+        conversions.push(denominatorSpec);
+        return conversions;
+    }
     /** Get an array of UnitConversionSpecs, one for each unit that is to be shown in the formatted quantity string. */
     static async getUnitConversions(format, unitsProvider, inputUnit) {
         const conversions = [];
@@ -65,6 +109,10 @@ export class FormatterSpec {
                 throw new Error("Formatter Spec needs persistence unit to be specified");
             }
         }
+        // Handle 2-unit composite for ratio formats (scale factors)
+        if (format.type === FormatType.Ratio && format.units && format.units.length === 2) {
+            return FormatterSpec.getRatioUnitConversions(format.units, unitsProvider, persistenceUnit);
+        }
         if (format.units) {
             let convertFromUnit = inputUnit;
             for (const unit of format.units) {

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

@@ -1 +1 @@
-{"version":3,"file":"FormatterSpec.js","sourceRoot":"","sources":["../../../src/Formatter/FormatterSpec.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,sFAAsF;AACtF,6JAA6J;AAE7J;;;GAGG;AACH,MAAM,OAAO,aAAa;IACd,KAAK,CAAS;IACd,YAAY,GAAyB,EAAE,CAAC,CAAE,mBAAmB;IAC7D,OAAO,CAAS;IAChB,gBAAgB,CAAY;IAC5B,sBAAsB,CAAuB,CAAC,iDAAiD;IAC/F,qBAAqB,CAAuB,CAAC,+CAA+C;IAEtG;;;;;;;OAOG;IACH,YAAY,IAAY,EAAE,MAAc,EAAE,WAAkC,EAAE,eAA2B,EAAE,qBAA2C,EAAE,oBAA0C;QAChM,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,eAAe,GAAG,KAAK,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,WAAW;YACb,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAClC,IAAI,CAAC,sBAAsB,GAAG,qBAAqB,CAAC;QACpD,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAC;IACpD,CAAC;IAED,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,uHAAuH;IACvH,IAAW,eAAe,KAA2B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,IAAW,eAAe,KAAgB,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACzE,IAAW,qBAAqB,KAAsC,OAAO,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC3G,IAAW,oBAAoB,KAAsC,OAAO,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAEzG,mHAAmH;IAC5G,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAc,EAAE,aAA4B,EAAE,SAAqB;QACxG,MAAM,WAAW,GAAyB,EAAE,CAAC;QAC7C,IAAI,eAAe,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,eAAe,GAAG,KAAK,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,IAAI,eAAe,GAAG,SAAS,CAAC;YAChC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAChC,IAAI,cAAmC,CAAC;gBACxC,IAAI,eAAe,EAAE,CAAC;oBACpB,cAAc,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC/E,CAAC;qBAAM,CAAC;oBACN,cAAc,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;gBAChD,CAAC;gBACD,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;gBAC5E,MAAM,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAuB,CAAC;gBAElI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvB,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,0GAA0G;YAC1G,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,IAAI,GAAuB,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;gBACtJ,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,MAAc,EAAE,aAA4B,EAAE,SAAqB;QAC1G,MAAM,WAAW,GAAyB,MAAM,aAAa,CAAC,kBAAkB,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;QACnH,IAAI,qBAAsD,CAAC;QAC3D,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,qBAAqB,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;YAC/F,CAAC;iBAAM,CAAC;gBACN,qBAAqB,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;YACvD,CAAC;QACH,CAAC;QACD,IAAI,oBAAqD,CAAC;QAC1D,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACxC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,oBAAoB,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;YAC7F,CAAC;iBAAM,CAAC;gBACN,oBAAoB,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;YACtD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,qBAAqB,EAAE,oBAAoB,CAAC,CAAC;IAC9G,CAAC;IAED,+BAA+B;IACxB,eAAe,CAAC,SAAiB;QACtC,OAAO,SAAS,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;CACF","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 { UnitConversionProps, UnitConversionSpec, UnitProps, UnitsProvider } from \"../Interfaces\";\r\nimport { Format } from \"./Format\";\r\nimport { Formatter } from \"./Formatter\";\r\n\r\n// cSpell:ignore ZERONORMALIZED, nosign, onlynegative, signalways, negativeparentheses\r\n// cSpell:ignore trailzeroes, keepsinglezero, zeroempty, keepdecimalpoint, applyrounding, fractiondash, showunitlabel, prependunitlabel, exponentonlynegative\r\n\r\n/** A class that contains both formatting information and the conversion factors necessary to convert from an input unit to the units specified in the format.\r\n * Once created the FormatterSpec will be able to format quantity values with synchronous calls.\r\n * @beta\r\n */\r\nexport class FormatterSpec {\r\n  protected _name: string;\r\n  protected _conversions: UnitConversionSpec[] = [];  // max four entries\r\n  protected _format: Format;\r\n  protected _persistenceUnit: UnitProps;\r\n  protected _azimuthBaseConversion?: UnitConversionProps; // converts azimuth base unit to persistence unit\r\n  protected _revolutionConversion?: UnitConversionProps; // converts revolution unit to persistence unit\r\n\r\n  /** Constructor\r\n   *  @param name     The name of a format specification.\r\n   *  @param format   Defines the output format for the quantity value.\r\n   *  @param conversions An array of conversion factors necessary to convert from an input unit to the units specified in the format.\r\n   *  @param persistenceUnit The unit the magnitude value is input.\r\n   *  @param azimuthBaseConversion The conversion used to interpret azimuth base values.\r\n   *  @param revolutionConversion The conversion used to determine a revolution value (used for bearing and azimuth).\r\n   */\r\n  constructor(name: string, format: Format, conversions?: UnitConversionSpec[], persistenceUnit?: UnitProps, azimuthBaseConversion?: UnitConversionProps, revolutionConversion?: UnitConversionProps) {\r\n    if (!persistenceUnit) {\r\n      if (format.units) {\r\n        const [props] = format.units[0];\r\n        persistenceUnit = props;\r\n      } else {\r\n        throw new Error(\"Formatter Spec needs persistence unit to be specified\");\r\n      }\r\n    }\r\n\r\n    this._name = name;\r\n    this._format = format;\r\n    this._persistenceUnit = persistenceUnit;\r\n    if (conversions)\r\n      this._conversions = conversions;\r\n    this._azimuthBaseConversion = azimuthBaseConversion;\r\n    this._revolutionConversion = revolutionConversion;\r\n  }\r\n\r\n  public get name(): string { return this._name; }\r\n  /** Returns an array of UnitConversionSpecs, one for each unit that is to be shown in the formatted quantity string. */\r\n  public get unitConversions(): UnitConversionSpec[] { return this._conversions; }\r\n  public get format(): Format { return this._format; }\r\n  public get persistenceUnit(): UnitProps { return this._persistenceUnit; }\r\n  public get azimuthBaseConversion(): UnitConversionProps | undefined { return this._azimuthBaseConversion; }\r\n  public get revolutionConversion(): UnitConversionProps | undefined { return this._revolutionConversion; }\r\n\r\n  /** Get an array of UnitConversionSpecs, one for each unit that is to be shown in the formatted quantity string. */\r\n  public static async getUnitConversions(format: Format, unitsProvider: UnitsProvider, inputUnit?: UnitProps): Promise<UnitConversionSpec[]> {\r\n    const conversions: UnitConversionSpec[] = [];\r\n    let persistenceUnit = inputUnit;\r\n    if (!persistenceUnit) {\r\n      if (format.units) {\r\n        const [props] = format.units[0];\r\n        persistenceUnit = props;\r\n      } else {\r\n        throw new Error(\"Formatter Spec needs persistence unit to be specified\");\r\n      }\r\n    }\r\n\r\n    if (format.units) {\r\n      let convertFromUnit = inputUnit;\r\n      for (const unit of format.units) {\r\n        let unitConversion: UnitConversionProps;\r\n        if (convertFromUnit) {\r\n          unitConversion = await unitsProvider.getConversion(convertFromUnit, unit[0]);\r\n        } else {\r\n          unitConversion = { factor: 1.0, offset: 0.0 };\r\n        }\r\n        const unitLabel = (unit[1] && unit[1].length > 0) ? unit[1] : unit[0].label;\r\n        const spec = ({ name: unit[0].name, label: unitLabel, conversion: unitConversion, system: unit[0].system }) as UnitConversionSpec;\r\n\r\n        conversions.push(spec);\r\n        convertFromUnit = unit[0];\r\n      }\r\n    } else {\r\n      // if format is only numeric and a input unit is defined set spec to use the input unit as the format unit\r\n      if (inputUnit) {\r\n        const spec: UnitConversionSpec = { name: inputUnit.name, label: inputUnit.label, system: inputUnit.system, conversion: { factor: 1.0, offset: 0.0 } };\r\n        conversions.push(spec);\r\n      }\r\n    }\r\n\r\n    return conversions;\r\n  }\r\n\r\n  /** Static async method to create a FormatSpec given the format and unit of the quantity that will be passed to the Formatter. The input unit will\r\n   * be used to generate conversion information for each unit specified in the Format. This method is async due to the fact that the units provider must make\r\n   * async calls to lookup unit definitions.\r\n   *  @param name     The name of a format specification.\r\n   *  @param unitsProvider The units provider is used to look up unit definitions and provide conversion information for converting between units.\r\n   *  @param inputUnit The unit the value to be formatted. This unit is often referred to as persistence unit.\r\n   */\r\n  public static async create(name: string, format: Format, unitsProvider: UnitsProvider, inputUnit?: UnitProps): Promise<FormatterSpec> {\r\n    const conversions: UnitConversionSpec[] = await FormatterSpec.getUnitConversions(format, unitsProvider, inputUnit);\r\n    let azimuthBaseConversion: UnitConversionProps | undefined;\r\n    if (format.azimuthBaseUnit !== undefined) {\r\n      if (inputUnit !== undefined) {\r\n        azimuthBaseConversion = await unitsProvider.getConversion(format.azimuthBaseUnit, inputUnit);\r\n      } else {\r\n        azimuthBaseConversion = { factor: 1.0, offset: 0.0 };\r\n      }\r\n    }\r\n    let revolutionConversion: UnitConversionProps | undefined;\r\n    if (format.revolutionUnit !== undefined) {\r\n      if (inputUnit !== undefined) {\r\n        revolutionConversion = await unitsProvider.getConversion(format.revolutionUnit, inputUnit);\r\n      } else {\r\n        revolutionConversion = { factor: 1.0, offset: 0.0 };\r\n      }\r\n    }\r\n\r\n    return new FormatterSpec(name, format, conversions, inputUnit, azimuthBaseConversion, revolutionConversion);\r\n  }\r\n\r\n  /** Format a quantity value. */\r\n  public applyFormatting(magnitude: number): string {\r\n    return Formatter.formatQuantity(magnitude, this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"FormatterSpec.js","sourceRoot":"","sources":["../../../src/Formatter/FormatterSpec.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,sFAAsF;AACtF,6JAA6J;AAE7J;;;GAGG;AACH,MAAM,OAAO,aAAa;IACd,KAAK,CAAS;IACd,YAAY,GAAyB,EAAE,CAAC,CAAE,mBAAmB;IAC7D,OAAO,CAAS;IAChB,gBAAgB,CAAY;IAC5B,sBAAsB,CAAuB,CAAC,iDAAiD;IAC/F,qBAAqB,CAAuB,CAAC,+CAA+C;IAEtG;;;;;;;OAOG;IACH,YAAY,IAAY,EAAE,MAAc,EAAE,WAAkC,EAAE,eAA2B,EAAE,qBAA2C,EAAE,oBAA0C;QAChM,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,eAAe,GAAG,KAAK,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,WAAW;YACb,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAClC,IAAI,CAAC,sBAAsB,GAAG,qBAAqB,CAAC;QACpD,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAC;IACpD,CAAC;IAED,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,uHAAuH;IACvH,IAAW,eAAe,KAA2B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,IAAW,eAAe,KAAgB,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACzE,IAAW,qBAAqB,KAAsC,OAAO,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC3G,IAAW,oBAAoB,KAAsC,OAAO,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAEzG,8FAA8F;IACtF,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,KAAqD,EAAE,aAA4B,EAAE,eAA0B;QAC1J,MAAM,WAAW,GAAyB,EAAE,CAAC;QAE7C,MAAM,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACjD,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAErD,wFAAwF;QACxF,MAAM,sBAAsB,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QACjG,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,MAAM,CAAC;QAExD,6FAA6F;QAC7F,yFAAyF;QACzF,MAAM,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAC3D,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;QACxE,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;QAC1E,iFAAiF;QACjF,MAAM,iBAAiB,GAAG,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACxD,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC9G,MAAM,gBAAgB,GAAG,0BAA0B,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,iBAAiB,CAAC;QAE9E,yDAAyD;QACzD,MAAM,mBAAmB,GAAuB;YAC9C,IAAI,EAAE,GAAG,aAAa,CAAC,IAAI,QAAQ,eAAe,CAAC,IAAI,EAAE;YACzD,KAAK,EAAE,EAAE;YACT,MAAM,EAAE,aAAa,CAAC,MAAM;YAC5B,UAAU,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,GAAG,EAAE;SACtD,CAAC;QACF,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAEtC,kCAAkC;QAClC,MAAM,aAAa,GAAuB;YACxC,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,KAAK,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK;YACpE,MAAM,EAAE,aAAa,CAAC,MAAM;YAC5B,UAAU,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE;SACzC,CAAC;QACF,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEhC,oCAAoC;QACpC,MAAM,eAAe,GAAuB;YAC1C,IAAI,EAAE,eAAe,CAAC,IAAI;YAC1B,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK;YAC1E,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,UAAU,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE;SACzC,CAAC;QACF,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAElC,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,mHAAmH;IAC5G,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAc,EAAE,aAA4B,EAAE,SAAqB;QACxG,MAAM,WAAW,GAAyB,EAAE,CAAC;QAC7C,IAAI,eAAe,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,eAAe,GAAG,KAAK,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,4DAA4D;QAC5D,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClF,OAAO,aAAa,CAAC,uBAAuB,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;QAC7F,CAAC;QAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,IAAI,eAAe,GAAG,SAAS,CAAC;YAChC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAChC,IAAI,cAAmC,CAAC;gBACxC,IAAI,eAAe,EAAE,CAAC;oBACpB,cAAc,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC/E,CAAC;qBAAM,CAAC;oBACN,cAAc,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;gBAChD,CAAC;gBACD,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;gBAC5E,MAAM,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAuB,CAAC;gBAElI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvB,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,0GAA0G;YAC1G,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,IAAI,GAAuB,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;gBACtJ,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,MAAc,EAAE,aAA4B,EAAE,SAAqB;QAC1G,MAAM,WAAW,GAAyB,MAAM,aAAa,CAAC,kBAAkB,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;QACnH,IAAI,qBAAsD,CAAC;QAC3D,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,qBAAqB,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;YAC/F,CAAC;iBAAM,CAAC;gBACN,qBAAqB,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;YACvD,CAAC;QACH,CAAC;QACD,IAAI,oBAAqD,CAAC;QAC1D,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACxC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,oBAAoB,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;YAC7F,CAAC;iBAAM,CAAC;gBACN,oBAAoB,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;YACtD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,qBAAqB,EAAE,oBAAoB,CAAC,CAAC;IAC9G,CAAC;IAED,+BAA+B;IACxB,eAAe,CAAC,SAAiB;QACtC,OAAO,SAAS,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;CACF","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 { UnitConversionProps, UnitConversionSpec, UnitProps, UnitsProvider } from \"../Interfaces\";\r\nimport { Format } from \"./Format\";\r\nimport { FormatType } from \"./FormatEnums\";\r\nimport { Formatter } from \"./Formatter\";\r\n\r\n// cSpell:ignore ZERONORMALIZED, nosign, onlynegative, signalways, negativeparentheses\r\n// cSpell:ignore trailzeroes, keepsinglezero, zeroempty, keepdecimalpoint, applyrounding, fractiondash, showunitlabel, prependunitlabel, exponentonlynegative\r\n\r\n/** A class that contains both formatting information and the conversion factors necessary to convert from an input unit to the units specified in the format.\r\n * Once created the FormatterSpec will be able to format quantity values with synchronous calls.\r\n * @beta\r\n */\r\nexport class FormatterSpec {\r\n  protected _name: string;\r\n  protected _conversions: UnitConversionSpec[] = [];  // max four entries\r\n  protected _format: Format;\r\n  protected _persistenceUnit: UnitProps;\r\n  protected _azimuthBaseConversion?: UnitConversionProps; // converts azimuth base unit to persistence unit\r\n  protected _revolutionConversion?: UnitConversionProps; // converts revolution unit to persistence unit\r\n\r\n  /** Constructor\r\n   *  @param name     The name of a format specification.\r\n   *  @param format   Defines the output format for the quantity value.\r\n   *  @param conversions An array of conversion factors necessary to convert from an input unit to the units specified in the format.\r\n   *  @param persistenceUnit The unit the magnitude value is input.\r\n   *  @param azimuthBaseConversion The conversion used to interpret azimuth base values.\r\n   *  @param revolutionConversion The conversion used to determine a revolution value (used for bearing and azimuth).\r\n   */\r\n  constructor(name: string, format: Format, conversions?: UnitConversionSpec[], persistenceUnit?: UnitProps, azimuthBaseConversion?: UnitConversionProps, revolutionConversion?: UnitConversionProps) {\r\n    if (!persistenceUnit) {\r\n      if (format.units) {\r\n        const [props] = format.units[0];\r\n        persistenceUnit = props;\r\n      } else {\r\n        throw new Error(\"Formatter Spec needs persistence unit to be specified\");\r\n      }\r\n    }\r\n\r\n    this._name = name;\r\n    this._format = format;\r\n    this._persistenceUnit = persistenceUnit;\r\n    if (conversions)\r\n      this._conversions = conversions;\r\n    this._azimuthBaseConversion = azimuthBaseConversion;\r\n    this._revolutionConversion = revolutionConversion;\r\n  }\r\n\r\n  public get name(): string { return this._name; }\r\n  /** Returns an array of UnitConversionSpecs, one for each unit that is to be shown in the formatted quantity string. */\r\n  public get unitConversions(): UnitConversionSpec[] { return this._conversions; }\r\n  public get format(): Format { return this._format; }\r\n  public get persistenceUnit(): UnitProps { return this._persistenceUnit; }\r\n  public get azimuthBaseConversion(): UnitConversionProps | undefined { return this._azimuthBaseConversion; }\r\n  public get revolutionConversion(): UnitConversionProps | undefined { return this._revolutionConversion; }\r\n\r\n  /** Build conversion specs for ratio format with 2 composite units (numerator/denominator). */\r\n  private static async getRatioUnitConversions(units: ReadonlyArray<[UnitProps, string | undefined]>, unitsProvider: UnitsProvider, persistenceUnit: UnitProps): Promise<UnitConversionSpec[]> {\r\n    const conversions: UnitConversionSpec[] = [];\r\n\r\n    const [numeratorUnit, numeratorLabel] = units[0];\r\n    const [denominatorUnit, denominatorLabel] = units[1];\r\n\r\n    // Compute ratio scale: how many numerator units per denominator unit (e.g., IN:FT = 12)\r\n    const denominatorToNumerator = await unitsProvider.getConversion(denominatorUnit, numeratorUnit);\r\n    const displayRatioScale = denominatorToNumerator.factor;\r\n\r\n    // Avoid double-scaling: if persistence unit already encodes the display ratio, use factor 1.\r\n    // Check by name heuristic (e.g., IN_PER_FT with ratioUnits [IN, FT] → no scaling needed)\r\n    const persistenceName = persistenceUnit.name.toUpperCase();\r\n    const numName = numeratorUnit.name.toUpperCase().split(\".\").pop() ?? \"\";\r\n    const denName = denominatorUnit.name.toUpperCase().split(\".\").pop() ?? \"\";\r\n    // Split by word boundaries (underscores, dots) and check for exact token matches\r\n    const persistenceTokens = persistenceName.split(/[._]/);\r\n    const isPersistenceMatchingRatio = persistenceTokens.includes(numName) && persistenceTokens.includes(denName);\r\n    const ratioScaleFactor = isPersistenceMatchingRatio ? 1.0 : displayRatioScale;\r\n\r\n    // First conversion spec: effective ratio unit conversion\r\n    const ratioConversionSpec: UnitConversionSpec = {\r\n      name: `${numeratorUnit.name}_per_${denominatorUnit.name}`,\r\n      label: \"\",\r\n      system: numeratorUnit.system,\r\n      conversion: { factor: ratioScaleFactor, offset: 0.0 },\r\n    };\r\n    conversions.push(ratioConversionSpec);\r\n\r\n    // Numerator unit for label lookup\r\n    const numeratorSpec: UnitConversionSpec = {\r\n      name: numeratorUnit.name,\r\n      label: numeratorLabel?.length ? numeratorLabel : numeratorUnit.label,\r\n      system: numeratorUnit.system,\r\n      conversion: { factor: 1.0, offset: 0.0 },\r\n    };\r\n    conversions.push(numeratorSpec);\r\n\r\n    // Denominator unit for label lookup\r\n    const denominatorSpec: UnitConversionSpec = {\r\n      name: denominatorUnit.name,\r\n      label: denominatorLabel?.length ? denominatorLabel : denominatorUnit.label,\r\n      system: denominatorUnit.system,\r\n      conversion: { factor: 1.0, offset: 0.0 },\r\n    };\r\n    conversions.push(denominatorSpec);\r\n\r\n    return conversions;\r\n  }\r\n\r\n  /** Get an array of UnitConversionSpecs, one for each unit that is to be shown in the formatted quantity string. */\r\n  public static async getUnitConversions(format: Format, unitsProvider: UnitsProvider, inputUnit?: UnitProps): Promise<UnitConversionSpec[]> {\r\n    const conversions: UnitConversionSpec[] = [];\r\n    let persistenceUnit = inputUnit;\r\n    if (!persistenceUnit) {\r\n      if (format.units) {\r\n        const [props] = format.units[0];\r\n        persistenceUnit = props;\r\n      } else {\r\n        throw new Error(\"Formatter Spec needs persistence unit to be specified\");\r\n      }\r\n    }\r\n\r\n    // Handle 2-unit composite for ratio formats (scale factors)\r\n    if (format.type === FormatType.Ratio && format.units && format.units.length === 2) {\r\n      return FormatterSpec.getRatioUnitConversions(format.units, unitsProvider, persistenceUnit);\r\n    }\r\n\r\n    if (format.units) {\r\n      let convertFromUnit = inputUnit;\r\n      for (const unit of format.units) {\r\n        let unitConversion: UnitConversionProps;\r\n        if (convertFromUnit) {\r\n          unitConversion = await unitsProvider.getConversion(convertFromUnit, unit[0]);\r\n        } else {\r\n          unitConversion = { factor: 1.0, offset: 0.0 };\r\n        }\r\n        const unitLabel = (unit[1] && unit[1].length > 0) ? unit[1] : unit[0].label;\r\n        const spec = ({ name: unit[0].name, label: unitLabel, conversion: unitConversion, system: unit[0].system }) as UnitConversionSpec;\r\n\r\n        conversions.push(spec);\r\n        convertFromUnit = unit[0];\r\n      }\r\n    } else {\r\n      // if format is only numeric and a input unit is defined set spec to use the input unit as the format unit\r\n      if (inputUnit) {\r\n        const spec: UnitConversionSpec = { name: inputUnit.name, label: inputUnit.label, system: inputUnit.system, conversion: { factor: 1.0, offset: 0.0 } };\r\n        conversions.push(spec);\r\n      }\r\n    }\r\n\r\n    return conversions;\r\n  }\r\n\r\n  /** Static async method to create a FormatSpec given the format and unit of the quantity that will be passed to the Formatter. The input unit will\r\n   * be used to generate conversion information for each unit specified in the Format. This method is async due to the fact that the units provider must make\r\n   * async calls to lookup unit definitions.\r\n   *  @param name     The name of a format specification.\r\n   *  @param unitsProvider The units provider is used to look up unit definitions and provide conversion information for converting between units.\r\n   *  @param inputUnit The unit the value to be formatted. This unit is often referred to as persistence unit.\r\n   */\r\n  public static async create(name: string, format: Format, unitsProvider: UnitsProvider, inputUnit?: UnitProps): Promise<FormatterSpec> {\r\n    const conversions: UnitConversionSpec[] = await FormatterSpec.getUnitConversions(format, unitsProvider, inputUnit);\r\n    let azimuthBaseConversion: UnitConversionProps | undefined;\r\n    if (format.azimuthBaseUnit !== undefined) {\r\n      if (inputUnit !== undefined) {\r\n        azimuthBaseConversion = await unitsProvider.getConversion(format.azimuthBaseUnit, inputUnit);\r\n      } else {\r\n        azimuthBaseConversion = { factor: 1.0, offset: 0.0 };\r\n      }\r\n    }\r\n    let revolutionConversion: UnitConversionProps | undefined;\r\n    if (format.revolutionUnit !== undefined) {\r\n      if (inputUnit !== undefined) {\r\n        revolutionConversion = await unitsProvider.getConversion(format.revolutionUnit, inputUnit);\r\n      } else {\r\n        revolutionConversion = { factor: 1.0, offset: 0.0 };\r\n      }\r\n    }\r\n\r\n    return new FormatterSpec(name, format, conversions, inputUnit, azimuthBaseConversion, revolutionConversion);\r\n  }\r\n\r\n  /** Format a quantity value. */\r\n  public applyFormatting(magnitude: number): string {\r\n    return Formatter.formatQuantity(magnitude, this);\r\n  }\r\n}\r\n"]}

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

@@ -4,6 +4,25 @@
 import { BeEvent } from "@itwin/core-bentley";
 import { UnitProps } from "../Interfaces";
 import { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision } from "./FormatEnums";
+/** Defines a unit specification with a name and optional label override.
+ * Used in composite formats and ratio unit specifications.
+ * @beta
+ */
+export interface FormatUnitSpec {
+    /** The name of the unit (e.g., "Units.FT", "Units.IN") */
+    readonly name: string;
+    /** Optional custom label that overrides the unit's default label (e.g., '"' for inches, "'" for feet) */
+    readonly label?: string;
+}
+/** A resolved [[FormatUnitSpec]] with the unit name replaced with the resolved UnitProps.
+ * @beta
+ */
+export interface ResolvedFormatUnitSpec {
+    /** The resolved unit */
+    readonly unit: UnitProps;
+    /** Optional custom label that overrides the unit's default label */
+    readonly label?: string;
+}
 /** Defines the units that make up a composite format and their display properties.
  * A composite format allows displaying a single quantity value across multiple units,
  * such as displaying length as "5 feet 6 inches" or angle as "45° 30' 15"".
@@ -15,12 +34,7 @@ export interface FormatCompositeProps {
     readonly includeZero?: boolean;
     /** Array of units this format is comprised of. Each unit specifies the unit name and
      * an optional custom label that will override the unit's default label when displaying values. */
-    readonly units: Array<{
-        /** The name of the unit (e.g., "Units.FT", "Units.IN") */
-        readonly name: string;
-        /** Optional custom label that overrides the unit's default label (e.g., "ft" for feet, 'in' for inches) */
-        readonly label?: string;
-    }>;
+    readonly units: FormatUnitSpec[];
 }
 /** This interface defines the persistence format for describing the formatting of quantity values.
  * @beta
@@ -39,6 +53,10 @@ export interface FormatProps {
     readonly scientificType?: string;
     /** conditionally required. */
     readonly ratioType?: string;
+    /** The separator character for ratio formatting. Defaults to ':' if not specified. */
+    readonly ratioSeparator?: string;
+    /** The format type for the numbers within a ratio. Defaults to "Decimal". */
+    readonly ratioFormatType?: string;
     /** conditionally required. */
     readonly stationOffsetSize?: number;
     readonly stationSeparator?: string;
@@ -69,10 +87,7 @@ export declare const isCustomFormatProps: (item: FormatProps) => item is CustomF
  * @beta
  */
 export type ResolvedFormatCompositeProps = Omit<FormatCompositeProps, "units"> & {
-    readonly units: Array<{
-        readonly unit: UnitProps;
-        readonly label?: string;
-    }>;
+    readonly units: ResolvedFormatUnitSpec[];
 };
 /** A [[FormatProps]] with all the references to units replaced with JSON representations of those units.
  * @beta

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

@@ -1 +1 @@
-{"version":3,"file":"Interfaces.d.ts","sourceRoot":"","sources":["../../../src/Formatter/Interfaces.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEhG;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,yDAAyD;IACzD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B;sGACkG;IAClG,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;QACpB,0DAA0D;QAC1D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,2GAA2G;QAC3G,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1C,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B,8BAA8B;IAC9B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAEjC,8BAA8B;IAC9B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B,8BAA8B;IAC9B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAEnC,sFAAsF;IACtF,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAEpC,yEAAyE;IACzE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B,uDAAuD;IACvD,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAElC,mFAAmF;IACnF,QAAQ,CAAC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAE3C,wGAAwG;IACxG,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAEjC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAC7C,QAAQ,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;CACtB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,SAAU,WAAW,KAAG,IAAI,IAAI,iBAE/D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,oBAAoB,EAAE,OAAO,CAAC,GAAG;IAC/E,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;QACpB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;QACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC,CAAC;CACJ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,EAAE,iBAAiB,GAAG,gBAAgB,GAAG,WAAW,CAAC,GAAG;IAC7G,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,CAAC;IACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,CAAC;IACpC,QAAQ,CAAC,SAAS,CAAC,EAAE,4BAA4B,CAAC;IAClD,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,yEAAyE;IACzE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,oCAAoC;IACpC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,uFAAuF;IACvF,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;IACnD,oDAAoD;IACpD,WAAW,CAAC,EAAE,SAAS,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,EAAE,KAAK,GAAG,MAAM,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAC;IAE/D;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAC,CAAC;CAC/D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C"}
+{"version":3,"file":"Interfaces.d.ts","sourceRoot":"","sources":["../../../src/Formatter/Interfaces.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEhG;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,yGAAyG;IACzG,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,wBAAwB;IACxB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,oEAAoE;IACpE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,yDAAyD;IACzD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B;sGACkG;IAClG,QAAQ,CAAC,KAAK,EAAE,cAAc,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1C,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B,8BAA8B;IAC9B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAEjC,8BAA8B;IAC9B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,sFAAsF;IACtF,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAChC,6EAA6E;IAC9E,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAElC,8BAA8B;IAC9B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAEnC,sFAAsF;IACtF,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAEpC,yEAAyE;IACzE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B,uDAAuD;IACvD,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAElC,mFAAmF;IACnF,QAAQ,CAAC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAE3C,wGAAwG;IACxG,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAEjC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAC7C,QAAQ,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;CACtB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,SAAU,WAAW,KAAG,IAAI,IAAI,iBAE/D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,oBAAoB,EAAE,OAAO,CAAC,GAAG;IAC/E,QAAQ,CAAC,KAAK,EAAE,sBAAsB,EAAE,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,EAAE,iBAAiB,GAAG,gBAAgB,GAAG,WAAW,CAAC,GAAG;IAC7G,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,CAAC;IACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,CAAC;IACpC,QAAQ,CAAC,SAAS,CAAC,EAAE,4BAA4B,CAAC;IAClD,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,yEAAyE;IACzE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,oCAAoC;IACpC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,uFAAuF;IACvF,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;IACnD,oDAAoD;IACpD,WAAW,CAAC,EAAE,SAAS,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,EAAE,KAAK,GAAG,MAAM,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAC;IAE/D;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAC,CAAC;CAC/D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C"}

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

@@ -1 +1 @@
-{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../../src/Formatter/Interfaces.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA2EH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAiB,EAA6B,EAAE;IAClF,OAAQ,IAA0B,CAAC,MAAM,KAAK,SAAS,CAAC;AAC1D,CAAC,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 { BeEvent } from \"@itwin/core-bentley\";\r\nimport { UnitProps } from \"../Interfaces\";\r\nimport { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision } from \"./FormatEnums\";\r\n\r\n/** Defines the units that make up a composite format and their display properties.\r\n * A composite format allows displaying a single quantity value across multiple units,\r\n * such as displaying length as \"5 feet 6 inches\" or angle as \"45° 30' 15\"\".\r\n * @beta\r\n */\r\nexport interface FormatCompositeProps {\r\n  /** separates values when formatting composite strings */\r\n  readonly spacer?: string;\r\n  readonly includeZero?: boolean;\r\n  /** Array of units this format is comprised of. Each unit specifies the unit name and\r\n   * an optional custom label that will override the unit's default label when displaying values. */\r\n  readonly units: Array<{\r\n    /** The name of the unit (e.g., \"Units.FT\", \"Units.IN\") */\r\n    readonly name: string;\r\n    /** Optional custom label that overrides the unit's default label (e.g., \"ft\" for feet, 'in' for inches) */\r\n    readonly label?: string;\r\n  }>;\r\n}\r\n\r\n/** This interface defines the persistence format for describing the formatting of quantity values.\r\n * @beta\r\n */\r\nexport interface FormatProps {\r\n  readonly type: string;\r\n  readonly precision?: number;\r\n  readonly roundFactor?: number;\r\n  readonly minWidth?: number;\r\n  readonly showSignOption?: string;\r\n  readonly formatTraits?: string | string[];\r\n  readonly decimalSeparator?: string;\r\n  readonly thousandSeparator?: string;\r\n  readonly uomSeparator?: string;\r\n\r\n  /** conditionally required. */\r\n  readonly scientificType?: string;\r\n\r\n  /** conditionally required. */\r\n  readonly ratioType?: string;\r\n\r\n  /** conditionally required. */\r\n  readonly stationOffsetSize?: number;\r\n  readonly stationSeparator?: string;\r\n\r\n  /** Optional base factor for station formatting. A positive integer, defaults to 1. */\r\n  readonly stationBaseFactor?: number;\r\n\r\n  /** The base value for azimuth, specified from east counter-clockwise. */\r\n  readonly azimuthBase?: number;\r\n\r\n  /** The name of the unit for the azimuth base value. */\r\n  readonly azimuthBaseUnit?: string;\r\n\r\n  /** If set to true, azimuth values are returned counter-clockwise from the base. */\r\n  readonly azimuthCounterClockwise?: boolean;\r\n\r\n  /** The name of the unit that represents a revolution/perigon. Required for bearing or azimuth types. */\r\n  readonly revolutionUnit?: string;\r\n\r\n  readonly allowMathematicOperations?: boolean;\r\n  readonly composite?: FormatCompositeProps;\r\n}\r\n\r\n/** This interface is used when supporting Custom Formatters that need more than the standard set of properties.\r\n * @beta\r\n */\r\nexport interface CustomFormatProps extends FormatProps {\r\n  readonly custom: any;\r\n}\r\n\r\n/** CustomFormatProps type guard.\r\n * @beta\r\n */\r\nexport const isCustomFormatProps = (item: FormatProps): item is CustomFormatProps => {\r\n  return (item as CustomFormatProps).custom !== undefined;\r\n};\r\n\r\n/** A [[FormatCompositeProps]] with unit names replaced with JSON representations of those units.\r\n * @beta\r\n */\r\nexport type ResolvedFormatCompositeProps = Omit<FormatCompositeProps, \"units\"> & {\r\n  readonly units: Array<{\r\n    readonly unit: UnitProps;\r\n    readonly label?: string;\r\n  }>;\r\n};\r\n\r\n/** A [[FormatProps]] with all the references to units replaced with JSON representations of those units.\r\n * @beta\r\n */\r\nexport type ResolvedFormatProps = Omit<FormatDefinition, \"azimuthBaseUnit\" | \"revolutionUnit\" | \"composite\"> & {\r\n  readonly azimuthBaseUnit?: UnitProps;\r\n  readonly revolutionUnit?: UnitProps;\r\n  readonly composite?: ResolvedFormatCompositeProps;\r\n  readonly custom?: any;\r\n};\r\n\r\n/** CloneFormat defines unit and label specification if primary unit is to be set during clone.\r\n * @beta\r\n */\r\nexport interface CloneUnit {\r\n  unit?: UnitProps;\r\n  label?: string;\r\n}\r\n\r\n/** CloneOptions that define modifications that can be made during the cloning of a Format.\r\n * @beta\r\n */\r\nexport interface CloneOptions {\r\n  /** allows composite formats to be converted to only show primary unit */\r\n  showOnlyPrimaryUnit?: boolean;\r\n  /** allow format traits to be set */\r\n  traits?: FormatTraits;\r\n  /** allows new FormatType to be specified */\r\n  type?: FormatType;\r\n  /** allows precision to be set, this will throw if value is not valid for FormatType */\r\n  precision?: DecimalPrecision | FractionalPrecision;\r\n  /** allows primary unit and label to be specified */\r\n  primaryUnit?: CloneUnit;\r\n}\r\n\r\n/** An extension of FormatProps to help identify formats.\r\n * @beta\r\n */\r\nexport interface FormatDefinition extends FormatProps {\r\n  readonly name?: string;\r\n  readonly label?: string;\r\n  readonly description?: string;\r\n}\r\n\r\n/** Argument for [[FormatsProvider.onFormatsChanged]]\r\n * @beta\r\n */\r\nexport interface FormatsChangedArgs {\r\n  /**\r\n   * If `all` - all formats within the `FormatsProvider` have changed.\r\n   * If array, the array items list the names of formats that were changed or removed.\r\n   */\r\n  formatsChanged: \"all\" | string[];\r\n}\r\n\r\n/** This interface is implemented by a class that would provide formats for use in formatting quantities.\r\n * @beta\r\n */\r\nexport interface FormatsProvider {\r\n  /**\r\n   * @param name The full name of the Format or KindOfQuantity.\r\n   */\r\n  getFormat(name: string): Promise<FormatDefinition | undefined>;\r\n\r\n  /**\r\n   * Fired when formats are added, removed, or changed.\r\n   * If all formats are changed, a single string \"all\" is emitted. Else, an array of changed format names is emitted.\r\n   */\r\n  onFormatsChanged: BeEvent<(args: FormatsChangedArgs) => void>;\r\n}\r\n\r\n/** This interface is implemented by a class that would provide and allow creating formats for use in formatting quantities.\r\n * @beta\r\n */\r\nexport interface MutableFormatsProvider extends FormatsProvider {\r\n  /**\r\n   * Adds a new format or updates an existing format associated with the specified name.\r\n   */\r\n  addFormat(name: string, format: FormatDefinition): Promise<void>;\r\n  /**\r\n   * Removes the format associated with the specified name.\r\n   * @param name The name of the format to remove.\r\n   */\r\n  removeFormat(name: string): Promise<void>;\r\n}\r\n"]}
+{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../../src/Formatter/Interfaces.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA+FH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAiB,EAA6B,EAAE;IAClF,OAAQ,IAA0B,CAAC,MAAM,KAAK,SAAS,CAAC;AAC1D,CAAC,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 { BeEvent } from \"@itwin/core-bentley\";\r\nimport { UnitProps } from \"../Interfaces\";\r\nimport { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision } from \"./FormatEnums\";\r\n\r\n/** Defines a unit specification with a name and optional label override.\r\n * Used in composite formats and ratio unit specifications.\r\n * @beta\r\n */\r\nexport interface FormatUnitSpec {\r\n  /** The name of the unit (e.g., \"Units.FT\", \"Units.IN\") */\r\n  readonly name: string;\r\n  /** Optional custom label that overrides the unit's default label (e.g., '\"' for inches, \"'\" for feet) */\r\n  readonly label?: string;\r\n}\r\n\r\n/** A resolved [[FormatUnitSpec]] with the unit name replaced with the resolved UnitProps.\r\n * @beta\r\n */\r\nexport interface ResolvedFormatUnitSpec {\r\n  /** The resolved unit */\r\n  readonly unit: UnitProps;\r\n  /** Optional custom label that overrides the unit's default label */\r\n  readonly label?: string;\r\n}\r\n\r\n/** Defines the units that make up a composite format and their display properties.\r\n * A composite format allows displaying a single quantity value across multiple units,\r\n * such as displaying length as \"5 feet 6 inches\" or angle as \"45° 30' 15\"\".\r\n * @beta\r\n */\r\nexport interface FormatCompositeProps {\r\n  /** separates values when formatting composite strings */\r\n  readonly spacer?: string;\r\n  readonly includeZero?: boolean;\r\n  /** Array of units this format is comprised of. Each unit specifies the unit name and\r\n   * an optional custom label that will override the unit's default label when displaying values. */\r\n  readonly units: FormatUnitSpec[];\r\n}\r\n\r\n/** This interface defines the persistence format for describing the formatting of quantity values.\r\n * @beta\r\n */\r\nexport interface FormatProps {\r\n  readonly type: string;\r\n  readonly precision?: number;\r\n  readonly roundFactor?: number;\r\n  readonly minWidth?: number;\r\n  readonly showSignOption?: string;\r\n  readonly formatTraits?: string | string[];\r\n  readonly decimalSeparator?: string;\r\n  readonly thousandSeparator?: string;\r\n  readonly uomSeparator?: string;\r\n\r\n  /** conditionally required. */\r\n  readonly scientificType?: string;\r\n\r\n  /** conditionally required. */\r\n  readonly ratioType?: string;\r\n  /** The separator character for ratio formatting. Defaults to ':' if not specified. */\r\n  readonly ratioSeparator?: string;\r\n   /** The format type for the numbers within a ratio. Defaults to \"Decimal\". */\r\n  readonly ratioFormatType?: string;\r\n\r\n  /** conditionally required. */\r\n  readonly stationOffsetSize?: number;\r\n  readonly stationSeparator?: string;\r\n\r\n  /** Optional base factor for station formatting. A positive integer, defaults to 1. */\r\n  readonly stationBaseFactor?: number;\r\n\r\n  /** The base value for azimuth, specified from east counter-clockwise. */\r\n  readonly azimuthBase?: number;\r\n\r\n  /** The name of the unit for the azimuth base value. */\r\n  readonly azimuthBaseUnit?: string;\r\n\r\n  /** If set to true, azimuth values are returned counter-clockwise from the base. */\r\n  readonly azimuthCounterClockwise?: boolean;\r\n\r\n  /** The name of the unit that represents a revolution/perigon. Required for bearing or azimuth types. */\r\n  readonly revolutionUnit?: string;\r\n\r\n  readonly allowMathematicOperations?: boolean;\r\n  readonly composite?: FormatCompositeProps;\r\n}\r\n\r\n/** This interface is used when supporting Custom Formatters that need more than the standard set of properties.\r\n * @beta\r\n */\r\nexport interface CustomFormatProps extends FormatProps {\r\n  readonly custom: any;\r\n}\r\n\r\n/** CustomFormatProps type guard.\r\n * @beta\r\n */\r\nexport const isCustomFormatProps = (item: FormatProps): item is CustomFormatProps => {\r\n  return (item as CustomFormatProps).custom !== undefined;\r\n};\r\n\r\n/** A [[FormatCompositeProps]] with unit names replaced with JSON representations of those units.\r\n * @beta\r\n */\r\nexport type ResolvedFormatCompositeProps = Omit<FormatCompositeProps, \"units\"> & {\r\n  readonly units: ResolvedFormatUnitSpec[];\r\n};\r\n\r\n/** A [[FormatProps]] with all the references to units replaced with JSON representations of those units.\r\n * @beta\r\n */\r\nexport type ResolvedFormatProps = Omit<FormatDefinition, \"azimuthBaseUnit\" | \"revolutionUnit\" | \"composite\"> & {\r\n  readonly azimuthBaseUnit?: UnitProps;\r\n  readonly revolutionUnit?: UnitProps;\r\n  readonly composite?: ResolvedFormatCompositeProps;\r\n  readonly custom?: any;\r\n};\r\n\r\n/** CloneFormat defines unit and label specification if primary unit is to be set during clone.\r\n * @beta\r\n */\r\nexport interface CloneUnit {\r\n  unit?: UnitProps;\r\n  label?: string;\r\n}\r\n\r\n/** CloneOptions that define modifications that can be made during the cloning of a Format.\r\n * @beta\r\n */\r\nexport interface CloneOptions {\r\n  /** allows composite formats to be converted to only show primary unit */\r\n  showOnlyPrimaryUnit?: boolean;\r\n  /** allow format traits to be set */\r\n  traits?: FormatTraits;\r\n  /** allows new FormatType to be specified */\r\n  type?: FormatType;\r\n  /** allows precision to be set, this will throw if value is not valid for FormatType */\r\n  precision?: DecimalPrecision | FractionalPrecision;\r\n  /** allows primary unit and label to be specified */\r\n  primaryUnit?: CloneUnit;\r\n}\r\n\r\n/** An extension of FormatProps to help identify formats.\r\n * @beta\r\n */\r\nexport interface FormatDefinition extends FormatProps {\r\n  readonly name?: string;\r\n  readonly label?: string;\r\n  readonly description?: string;\r\n}\r\n\r\n/** Argument for [[FormatsProvider.onFormatsChanged]]\r\n * @beta\r\n */\r\nexport interface FormatsChangedArgs {\r\n  /**\r\n   * If `all` - all formats within the `FormatsProvider` have changed.\r\n   * If array, the array items list the names of formats that were changed or removed.\r\n   */\r\n  formatsChanged: \"all\" | string[];\r\n}\r\n\r\n/** This interface is implemented by a class that would provide formats for use in formatting quantities.\r\n * @beta\r\n */\r\nexport interface FormatsProvider {\r\n  /**\r\n   * @param name The full name of the Format or KindOfQuantity.\r\n   */\r\n  getFormat(name: string): Promise<FormatDefinition | undefined>;\r\n\r\n  /**\r\n   * Fired when formats are added, removed, or changed.\r\n   * If all formats are changed, a single string \"all\" is emitted. Else, an array of changed format names is emitted.\r\n   */\r\n  onFormatsChanged: BeEvent<(args: FormatsChangedArgs) => void>;\r\n}\r\n\r\n/** This interface is implemented by a class that would provide and allow creating formats for use in formatting quantities.\r\n * @beta\r\n */\r\nexport interface MutableFormatsProvider extends FormatsProvider {\r\n  /**\r\n   * Adds a new format or updates an existing format associated with the specified name.\r\n   */\r\n  addFormat(name: string, format: FormatDefinition): Promise<void>;\r\n  /**\r\n   * Removes the format associated with the specified name.\r\n   * @param name The name of the format to remove.\r\n   */\r\n  removeFormat(name: string): Promise<void>;\r\n}\r\n"]}

package/lib/esm/Parser.d.ts

@@ -16,7 +16,8 @@ export declare enum ParseError {
     InvalidParserSpec = 6,
     BearingPrefixOrSuffixMissing = 7,
     MathematicOperationFoundButIsNotAllowed = 8,
-    BearingAngleOutOfRange = 9
+    BearingAngleOutOfRange = 9,
+    InvalidMathResult = 10
 }
 /** Parse error result from [[Parser.parseToQuantityValue]] or [[Parser.parseToQuantityValue]].
  * @beta
@@ -116,6 +117,20 @@ export declare class Parser {
     private static processSpecialBearingDirection;
     private static parseBearingFormat;
     private static parseAzimuthFormat;
+    /**
+     * Parse a ratio part string (numerator or denominator) to extract the numeric value and optional unit label.
+     * This method processes tokens without applying unit conversions, allowing the ratio format
+     * handler to manage conversions at the ratio level.
+     *
+     *
+     * @note Fractions are already handled by parseQuantitySpecification, which converts them to
+     * single numeric tokens (e.g., "1/2" becomes 0.5).
+     *
+     * @param partStr The string to parse, which may contain a number, fraction, or mixed fraction with optional unit label.
+     * @param format The format specification used for token parsing.
+     * @returns An object containing the parsed numeric value and optional unit label. Returns NaN for value if no number is found.
+     */
+    private static parseRatioPart;
     private static parseRatioFormat;
     private static normalizeAngle;
     private static getRevolution;

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

@@ -1 +1 @@
-{"version":3,"file":"Parser.d.ts","sourceRoot":"","sources":["../../src/Parser.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAE,aAAa,EAAuB,kBAAkB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACjK,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;GAEG;AACH,oBAAY,UAAU;IACpB,2BAA2B,IAAI;IAC/B,0BAA0B,IAAA;IAC1B,8BAA8B,IAAA;IAC9B,WAAW,IAAA;IACX,oCAAoC,IAAA;IACpC,iBAAiB,IAAA;IACjB,4BAA4B,IAAA;IAC5B,uCAAuC,IAAA;IACvC,sBAAsB,IAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,EAAE,EAAE,KAAK,CAAC;IACV,uDAAuD;IACvD,KAAK,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,uDAAuD;IACvD,EAAE,EAAE,IAAI,CAAC;IACT,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;CACf;AAED,aAAK,QAAQ;IACX,QAAQ,MAAM;IACd,WAAW,MAAM;IACjB,cAAc,MAAM,CAAE,iDAAiD;IACvE,QAAQ,MAAM;CACf;AAUD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAEtE;;GAEG;AACH,cAAM,UAAU;IACP,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;IAClC,UAAU,EAAE,OAAO,CAAS;gBAEvB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ;IAS7C,IAAW,QAAQ,IAAI,OAAO,CAA+D;IAC7F,IAAW,QAAQ,IAAI,OAAO,CAA2C;IACzE,IAAW,kBAAkB,IAAI,OAAO,CAGvC;CACF;AA+BD;;GAEG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAS;WAEd,gBAAgB,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,IAAI,cAAc;WAInE,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,IAAI,kBAAkB;IAIjF,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAoBzC,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAyChC,OAAO,CAAC,MAAM,CAAC,OAAO;IAItB,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC;;OAEG;WACW,0BAA0B,CAAC,qBAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE;IAyLrG,OAAO,CAAC,MAAM,CAAC,qBAAqB;mBAYf,iBAAiB;IA6BtC;;OAEG;mBACkB,wCAAwC;IAqC7D;;OAEG;mBACkB,6BAA6B;IAYlD;;;;OAIG;WACiB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,aAAa,CAAC;IAMlL,2DAA2D;IAC3D,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAyCpC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAiBvC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAkC/B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAwG9C;;;OAGG;WACW,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,mBAAmB;IA4BhG;;;;;OAKG;WACW,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,mBAAmB;IAyBjI,qGAAqG;IACrG,OAAO,CAAC,MAAM,CAAC,8BAA8B;IAU7C,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAkFjC,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAuCjC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IA0D/B,OAAO,CAAC,MAAM,CAAC,cAAc;IAS7B,OAAO,CAAC,MAAM,CAAC,aAAa;IAc5B,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAepC,+HAA+H;WAC3G,gCAAgC,CAAC,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IA4B1L,+HAA+H;WAC3G,yBAAyB,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;CAgDhO"}
+{"version":3,"file":"Parser.d.ts","sourceRoot":"","sources":["../../src/Parser.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAE,aAAa,EAAuB,kBAAkB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACjK,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;GAEG;AACH,oBAAY,UAAU;IACpB,2BAA2B,IAAI;IAC/B,0BAA0B,IAAA;IAC1B,8BAA8B,IAAA;IAC9B,WAAW,IAAA;IACX,oCAAoC,IAAA;IACpC,iBAAiB,IAAA;IACjB,4BAA4B,IAAA;IAC5B,uCAAuC,IAAA;IACvC,sBAAsB,IAAA;IACtB,iBAAiB,KAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,EAAE,EAAE,KAAK,CAAC;IACV,uDAAuD;IACvD,KAAK,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,uDAAuD;IACvD,EAAE,EAAE,IAAI,CAAC;IACT,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;CACf;AAED,aAAK,QAAQ;IACX,QAAQ,MAAM;IACd,WAAW,MAAM;IACjB,cAAc,MAAM,CAAE,iDAAiD;IACvE,QAAQ,MAAM;CACf;AAUD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAEtE;;GAEG;AACH,cAAM,UAAU;IACP,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;IAClC,UAAU,EAAE,OAAO,CAAS;gBAEvB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ;IAS7C,IAAW,QAAQ,IAAI,OAAO,CAA+D;IAC7F,IAAW,QAAQ,IAAI,OAAO,CAA2C;IACzE,IAAW,kBAAkB,IAAI,OAAO,CAGvC;CACF;AA+BD;;GAEG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAS;WAEd,gBAAgB,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,IAAI,cAAc;WAInE,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,IAAI,kBAAkB;IAIjF,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAoBzC,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAyChC,OAAO,CAAC,MAAM,CAAC,OAAO;IAItB,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC;;OAEG;WACW,0BAA0B,CAAC,qBAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE;IAyLrG,OAAO,CAAC,MAAM,CAAC,qBAAqB;mBAYf,iBAAiB;IA6BtC;;OAEG;mBACkB,wCAAwC;IAqC7D;;OAEG;mBACkB,6BAA6B;IAYlD;;;;OAIG;WACiB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,aAAa,CAAC;IAMlL,2DAA2D;IAC3D,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAyCpC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAiBvC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAkC/B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAwG9C;;;OAGG;WACW,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,mBAAmB;IA4BhG;;;;;OAKG;WACW,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,mBAAmB;IAyBjI,qGAAqG;IACrG,OAAO,CAAC,MAAM,CAAC,8BAA8B;IAU7C,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAkFjC,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAuCjC;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAoC7B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAqF/B,OAAO,CAAC,MAAM,CAAC,cAAc;IAS7B,OAAO,CAAC,MAAM,CAAC,aAAa;IAc5B,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAepC,+HAA+H;WAC3G,gCAAgC,CAAC,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IA4B1L,+HAA+H;WAC3G,yBAAyB,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;CAgDhO"}

package/lib/esm/Parser.js

@@ -23,13 +23,14 @@ export var ParseError;
     ParseError[ParseError["BearingPrefixOrSuffixMissing"] = 7] = "BearingPrefixOrSuffixMissing";
     ParseError[ParseError["MathematicOperationFoundButIsNotAllowed"] = 8] = "MathematicOperationFoundButIsNotAllowed";
     ParseError[ParseError["BearingAngleOutOfRange"] = 9] = "BearingAngleOutOfRange";
+    ParseError[ParseError["InvalidMathResult"] = 10] = "InvalidMathResult";
 })(ParseError || (ParseError = {}));
 var Operator;
 (function (Operator) {
     Operator["addition"] = "+";
     Operator["subtraction"] = "-";
     Operator["multiplication"] = "*";
-    Operator["division"] = "/"; // unsupported but we recognize it during parsing
+    Operator["division"] = "/";
 })(Operator || (Operator = {}));
 function isOperator(char) {
     if (typeof char === "number") {
@@ -784,36 +785,107 @@ export class Parser {
         magnitude = this.normalizeAngle(magnitude, revolution);
         return { ok: true, value: magnitude };
     }
+    /**
+     * Parse a ratio part string (numerator or denominator) to extract the numeric value and optional unit label.
+     * This method processes tokens without applying unit conversions, allowing the ratio format
+     * handler to manage conversions at the ratio level.
+     *
+     *
+     * @note Fractions are already handled by parseQuantitySpecification, which converts them to
+     * single numeric tokens (e.g., "1/2" becomes 0.5).
+     *
+     * @param partStr The string to parse, which may contain a number, fraction, or mixed fraction with optional unit label.
+     * @param format The format specification used for token parsing.
+     * @returns An object containing the parsed numeric value and optional unit label. Returns NaN for value if no number is found.
+     */
+    static parseRatioPart(partStr, format) {
+        partStr = partStr.trim();
+        // Parse tokens - fractions are automatically converted to decimal values by parseQuantitySpecification
+        const tempFormat = format.clone({ type: FormatType.Decimal });
+        const tokens = Parser.parseQuantitySpecification(partStr, tempFormat);
+        let value = NaN;
+        let unitLabel;
+        // Pre-process: merge negative operators with following numbers
+        const processedTokens = [];
+        for (let i = 0; i < tokens.length; i++) {
+            const token = tokens[i];
+            if (token.isOperator && i === 0 && token.value === "-" &&
+                i + 1 < tokens.length && tokens[i + 1].isNumber) {
+                // Merge negative sign with number
+                processedTokens.push(new ParseToken(-tokens[i + 1].value));
+                i++; // Skip the number token since we consumed it
+            }
+            else {
+                processedTokens.push(token);
+            }
+        }
+        // Extract numeric value and unit label from processed tokens
+        for (const token of processedTokens) {
+            if (token.isNumber && isNaN(value)) {
+                value = token.value;
+            }
+            else if (token.isString && !token.isOperator) {
+                // String token that's not an operator - treat as unit label
+                unitLabel = token.value;
+            }
+        }
+        return { value, unitLabel };
+    }
     static parseRatioFormat(inString, spec) {
         if (!inString)
             return { ok: false, error: ParseError.NoValueOrUnitFoundInString };
-        const parts = inString.split(":");
+        const separator = spec.format.ratioSeparator ?? ":";
+        const parts = inString.split(separator);
         if (parts.length > 2)
             return { ok: false, error: ParseError.UnableToConvertParseTokensToQuantity };
-        const numerator = parseFloat(parts[0]);
-        let denominator;
-        if (parts.length === 1) {
-            denominator = 1.0;
-        }
-        else {
-            denominator = parseFloat(parts[1]);
+        // If the string doesn't contain the expected separator but contains other ratio-like separators,
+        // return an error since the wrong separator was used
+        if (parts.length === 1 && !inString.includes(separator)) {
+            // Check if the string contains other common ratio separators
+            const otherSeparators = [":", "=", "/"];
+            for (const otherSep of otherSeparators) {
+                if (otherSep !== separator && inString.includes(otherSep)) {
+                    // The string looks like a ratio but uses the wrong separator
+                    return { ok: false, error: ParseError.UnableToConvertParseTokensToQuantity };
+                }
+            }
+            // Parse as a regular quantity value (numerator only, denominator = 1)
+            const result = this.parseAndProcessTokens(inString, spec.format, spec.unitConversions);
+            return result;
         }
-        if (isNaN(numerator) || isNaN(denominator))
+        // Parse numerator and denominator parts which may include unit labels
+        const numeratorPart = this.parseRatioPart(parts[0], spec.format);
+        const denominatorPart = parts.length === 1 ? { value: 1.0 } : this.parseRatioPart(parts[1], spec.format);
+        if (isNaN(numeratorPart.value) || isNaN(denominatorPart.value))
             return { ok: false, error: ParseError.NoValueOrUnitFoundInString };
+        // Handle 2-unit composite case - simpler conversion using the pre-computed scale factor
+        if (spec.format.units && spec.format.units.length === 2 && spec.unitConversions.length >= 3) {
+            const ratioConvSpec = spec.unitConversions[0];
+            const scaleFactor = ratioConvSpec.conversion.factor;
+            if (denominatorPart.value === 0) {
+                return { ok: false, error: ParseError.InvalidMathResult };
+            }
+            // The ratio value is numerator/denominator in the display units (e.g., 12 for 12"=1')
+            // Divide by scale factor to get persistence unit value (e.g., 12/12 = 1.0)
+            const ratioValue = numeratorPart.value / denominatorPart.value;
+            const convertedValue = ratioValue / scaleFactor;
+            return { ok: true, value: convertedValue };
+        }
+        // Original flow for 1-unit composite - use Quantity.convertTo for proper unit conversion
         const defaultUnit = spec.format.units && spec.format.units.length > 0 ? spec.format.units[0][0] : undefined;
         const unitConversion = defaultUnit ? Parser.tryFindUnitConversion(defaultUnit.label, spec.unitConversions, defaultUnit) : undefined;
         if (!unitConversion) {
             throw new QuantityError(QuantityStatus.MissingRequiredProperty, `Missing input unit or unit conversion for interpreting ${spec.format.name}.`);
         }
-        if (denominator === 0) {
-            if (unitConversion.inversion && numerator === 1)
+        if (denominatorPart.value === 0) {
+            if (unitConversion.inversion && numeratorPart.value === 1)
                 return { ok: true, value: 0.0 };
             else
-                return { ok: false, error: ParseError.MathematicOperationFoundButIsNotAllowed };
+                return { ok: false, error: ParseError.InvalidMathResult };
         }
         let quantity;
         if (spec.format.units && spec.outUnit) {
-            quantity = new Quantity(spec.format.units[0][0], numerator / denominator);
+            quantity = new Quantity(spec.format.units[0][0], numeratorPart.value / denominatorPart.value);
         }
         else {
             throw new QuantityError(QuantityStatus.MissingRequiredProperty, "Missing presentation unit or persistence unit for ratio format.");
@@ -825,7 +897,7 @@ export class Parser {
         catch (err) {
             // for input of "0:N" with reversed unit
             if (err instanceof QuantityError && err.errorNumber === QuantityStatus.InvertingZero) {
-                return { ok: false, error: ParseError.MathematicOperationFoundButIsNotAllowed };
+                return { ok: false, error: ParseError.InvalidMathResult };
             }
         }
         if (converted === undefined || !converted.isValid) {