# Class: UnitMeasureFormatter
configurator-core/src/services/configurator-ui-callback.
# Table of contents
# Constructors
# Methods
- formatMMValueToUnitString
- formatMMValueWithReqMaxLength
- formatNumber
- formatSquareMMValueToUnitString
- init
- isParseableNumber
- isParseableUnitString
- parseMMValueFromUnitString
- parseNumber
- parseSquareMMValueFromUnitString
- showExactValues
# Constructors
# constructor
• new UnitMeasureFormatter()
# Methods
# formatMMValueToUnitString
▸ formatMMValueToUnitString(aValue
, aUnit
, aStringType
): string
# Parameters
Name | Type |
---|---|
aValue | number |
aUnit | Unit |
aStringType | UnitStringType |
# Returns
string
# Defined in
packages/typings/configurator-kernel-container.ts:101 (opens new window)
# formatMMValueWithReqMaxLength
▸ formatMMValueWithReqMaxLength(aValue
, aUnit
, reqMaxSize
): string
# Parameters
Name | Type |
---|---|
aValue | number |
aUnit | Unit |
reqMaxSize | number |
# Returns
string
# Defined in
packages/typings/configurator-kernel-container.ts:106 (opens new window)
# formatNumber
▸ formatNumber(aValue
, digit
): string
# Parameters
Name | Type |
---|---|
aValue | number |
digit | number |
# Returns
string
# Defined in
packages/typings/configurator-kernel-container.ts:116 (opens new window)
# formatSquareMMValueToUnitString
▸ formatSquareMMValueToUnitString(aValue
, aUnit
): string
# Parameters
Name | Type |
---|---|
aValue | number |
aUnit | Unit |
# Returns
string
# Defined in
packages/typings/configurator-kernel-container.ts:112 (opens new window)
# init
▸ init(mmLabel
, cmLabel
, ftShortLabel
, ftLongLabel
, inchShortLabel
, inchLongLabel
, sqMLabel
, sqftLabel
, showExactValue
, maxPrecision
, showFractionalUnitString
): void
# Parameters
Name | Type |
---|---|
mmLabel | string |
cmLabel | string |
ftShortLabel | string |
ftLongLabel | string |
inchShortLabel | string |
inchLongLabel | string |
sqMLabel | string |
sqftLabel | string |
showExactValue | boolean |
maxPrecision | number |
showFractionalUnitString | boolean |
# Returns
void
# Defined in
packages/typings/configurator-kernel-container.ts:87 (opens new window)
# isParseableNumber
▸ isParseableNumber(aString
): boolean
# Parameters
Name | Type |
---|---|
aString | string |
# Returns
boolean
# Defined in
packages/typings/configurator-kernel-container.ts:117 (opens new window)
# isParseableUnitString
▸ isParseableUnitString(aString
, aUnit
): boolean
# Parameters
Name | Type |
---|---|
aString | string |
aUnit | Unit |
# Returns
boolean
# Defined in
packages/typings/configurator-kernel-container.ts:114 (opens new window)
# parseMMValueFromUnitString
▸ parseMMValueFromUnitString(aString
, aUnit
): number
# Parameters
Name | Type |
---|---|
aString | string |
aUnit | Unit |
# Returns
number
# Defined in
packages/typings/configurator-kernel-container.ts:111 (opens new window)
# parseNumber
▸ parseNumber(aString
): number
# Parameters
Name | Type |
---|---|
aString | string |
# Returns
number
# Defined in
packages/typings/configurator-kernel-container.ts:115 (opens new window)
# parseSquareMMValueFromUnitString
▸ parseSquareMMValueFromUnitString(aString
, aUnit
): number
# Parameters
Name | Type |
---|---|
aString | string |
aUnit | Unit |
# Returns
number
# Defined in
packages/typings/configurator-kernel-container.ts:113 (opens new window)
# showExactValues
▸ showExactValues(shouldeI
): void
# Parameters
Name | Type |
---|---|
shouldeI | boolean |
# Returns
void
# Defined in
packages/typings/configurator-kernel-container.ts:100 (opens new window)