API Reference › Globals › UnitMeasureFormatter
# Class: UnitMeasureFormatter
# Hierarchy
- UnitMeasureFormatter
# Index
# Methods
- formatMMValueToUnitString
- formatMMValueWithReqMaxLength
- formatNumber
- formatSquareMMValueToUnitString
- init
- isParseableNumber
- isParseableUnitString
- parseMMValueFromUnitString
- parseNumber
- parseSquareMMValueFromUnitString
- showExactValues
# Methods
# formatMMValueToUnitString
▸ formatMMValueToUnitString(aValue: number, aUnit: Unit, aStringType: UnitStringType): string
Defined in packages/typings/planner-kernel-container.ts:371
Parameters:
| Name | Type |
|---|---|
aValue | number |
aUnit | Unit |
aStringType | UnitStringType |
Returns: string
▸ formatMMValueToUnitString(aValue: number, aUnit: Unit, aStringType: UnitStringType): string
Defined in packages/typings/configurator-kernel-container.ts:86
Parameters:
| Name | Type |
|---|---|
aValue | number |
aUnit | Unit |
aStringType | UnitStringType |
Returns: string
# formatMMValueWithReqMaxLength
▸ formatMMValueWithReqMaxLength(aValue: number, aUnit: Unit, reqMaxSize: number): string
Defined in packages/typings/planner-kernel-container.ts:372
Parameters:
| Name | Type |
|---|---|
aValue | number |
aUnit | Unit |
reqMaxSize | number |
Returns: string
▸ formatMMValueWithReqMaxLength(aValue: number, aUnit: Unit, reqMaxSize: number): string
Defined in packages/typings/configurator-kernel-container.ts:87
Parameters:
| Name | Type |
|---|---|
aValue | number |
aUnit | Unit |
reqMaxSize | number |
Returns: string
# formatNumber
▸ formatNumber(aValue: number, digit: number): string
Defined in packages/typings/planner-kernel-container.ts:378
Parameters:
| Name | Type |
|---|---|
aValue | number |
digit | number |
Returns: string
▸ formatNumber(aValue: number, digit: number): string
Defined in packages/typings/configurator-kernel-container.ts:93
Parameters:
| Name | Type |
|---|---|
aValue | number |
digit | number |
Returns: string
# formatSquareMMValueToUnitString
▸ formatSquareMMValueToUnitString(aValue: number, aUnit: Unit): string
Defined in packages/typings/planner-kernel-container.ts:374
Parameters:
| Name | Type |
|---|---|
aValue | number |
aUnit | Unit |
Returns: string
▸ formatSquareMMValueToUnitString(aValue: number, aUnit: Unit): string
Defined in packages/typings/configurator-kernel-container.ts:89
Parameters:
| Name | Type |
|---|---|
aValue | number |
aUnit | Unit |
Returns: string
# init
▸ init(mmLabel: string, cmLabel: string, ftShortLabel: string, ftLongLabel: string, inchShortLabel: string, inchLongLabel: string, sqMLabel: string, sqftLabel: string, showExactValue: boolean, maxPrecision: number): void
Defined in packages/typings/planner-kernel-container.ts:369
Parameters:
| Name | Type |
|---|---|
mmLabel | string |
cmLabel | string |
ftShortLabel | string |
ftLongLabel | string |
inchShortLabel | string |
inchLongLabel | string |
sqMLabel | string |
sqftLabel | string |
showExactValue | boolean |
maxPrecision | number |
Returns: void
▸ init(mmLabel: string, cmLabel: string, ftShortLabel: string, ftLongLabel: string, inchShortLabel: string, inchLongLabel: string, sqMLabel: string, sqftLabel: string, showExactValue: boolean, maxPrecision: number): void
Defined in packages/typings/configurator-kernel-container.ts:84
Parameters:
| Name | Type |
|---|---|
mmLabel | string |
cmLabel | string |
ftShortLabel | string |
ftLongLabel | string |
inchShortLabel | string |
inchLongLabel | string |
sqMLabel | string |
sqftLabel | string |
showExactValue | boolean |
maxPrecision | number |
Returns: void
# isParseableNumber
▸ isParseableNumber(aString: string): boolean
Defined in packages/typings/planner-kernel-container.ts:379
Parameters:
| Name | Type |
|---|---|
aString | string |
Returns: boolean
▸ isParseableNumber(aString: string): boolean
Defined in packages/typings/configurator-kernel-container.ts:94
Parameters:
| Name | Type |
|---|---|
aString | string |
Returns: boolean
# isParseableUnitString
▸ isParseableUnitString(aString: string, aUnit: Unit): boolean
Defined in packages/typings/planner-kernel-container.ts:376
Parameters:
| Name | Type |
|---|---|
aString | string |
aUnit | Unit |
Returns: boolean
▸ isParseableUnitString(aString: string, aUnit: Unit): boolean
Defined in packages/typings/configurator-kernel-container.ts:91
Parameters:
| Name | Type |
|---|---|
aString | string |
aUnit | Unit |
Returns: boolean
# parseMMValueFromUnitString
▸ parseMMValueFromUnitString(aString: string, aUnit: Unit): number
Defined in packages/typings/planner-kernel-container.ts:373
Parameters:
| Name | Type |
|---|---|
aString | string |
aUnit | Unit |
Returns: number
▸ parseMMValueFromUnitString(aString: string, aUnit: Unit): number
Defined in packages/typings/configurator-kernel-container.ts:88
Parameters:
| Name | Type |
|---|---|
aString | string |
aUnit | Unit |
Returns: number
# parseNumber
▸ parseNumber(aString: string): number
Defined in packages/typings/planner-kernel-container.ts:377
Parameters:
| Name | Type |
|---|---|
aString | string |
Returns: number
▸ parseNumber(aString: string): number
Defined in packages/typings/configurator-kernel-container.ts:92
Parameters:
| Name | Type |
|---|---|
aString | string |
Returns: number
# parseSquareMMValueFromUnitString
▸ parseSquareMMValueFromUnitString(aString: string, aUnit: Unit): number
Defined in packages/typings/planner-kernel-container.ts:375
Parameters:
| Name | Type |
|---|---|
aString | string |
aUnit | Unit |
Returns: number
▸ parseSquareMMValueFromUnitString(aString: string, aUnit: Unit): number
Defined in packages/typings/configurator-kernel-container.ts:90
Parameters:
| Name | Type |
|---|---|
aString | string |
aUnit | Unit |
Returns: number
# showExactValues
▸ showExactValues(shouldeI: boolean): void
Defined in packages/typings/planner-kernel-container.ts:370
Parameters:
| Name | Type |
|---|---|
shouldeI | boolean |
Returns: void
▸ showExactValues(shouldeI: boolean): void
Defined in packages/typings/configurator-kernel-container.ts:85
Parameters:
| Name | Type |
|---|---|
shouldeI | boolean |
Returns: void