API ReferenceGlobalsUnitMeasureFormatter

# Class: UnitMeasureFormatter

# Hierarchy

  • UnitMeasureFormatter

# Index

# Methods

# Methods

# formatMMValueToUnitString

formatMMValueToUnitString(aValue: number, aUnit: Unit, aStringType: UnitStringType): string

Defined in packages/typings/planner-kernel-container.ts:435

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:437

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:449

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:441

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:431

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:451

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:445

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:439

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:447

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:443

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:433

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