Class AreaUnit
Extends
Measurement.
Create a new area measurement instance.
Defined in: ilib-full-dyn.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
AreaUnit(options)
|
| Method Attributes | Method Name and Description |
|---|---|
|
convert(to)
Return a new measurement instance that is converted to a new
measurement unit.
|
|
| <static> |
AreaUnit.convert(to, from, area)
Convert a Area to another measure.
|
|
Return the type of this measurement.
|
|
|
localize(locale)
Localize the measurement to the commonly used measurement in that locale.
|
|
|
scale(measurementsystem)
Scale the measurement unit to an acceptable level.
|
Class Detail
AreaUnit(options)
- Parameters:
- options
- {{unit:string,amount:number|string|undefined}} Options controlling the construction of this instance
Method Detail
{Measurement|undefined}
convert(to)
Return a new measurement instance that is converted to a new
measurement unit. Measurements can only be converted
to measurements of the same type.
- Parameters:
- {string} to
- The name of the units to convert to
- Returns:
- {Measurement|undefined} the converted measurement or undefined if the requested units are for a different measurement type
<static>
{number|undefined}
AreaUnit.convert(to, from, area)
Convert a Area to another measure.
- Parameters:
- to
- {string} unit to convert to
- from
- {string} unit to convert from
- area
- {number} amount to be convert
- Returns:
- {number|undefined} the converted amount
{string}
getMeasure()
Return the type of this measurement. Examples are "mass",
"length", "speed", etc. Measurements can only be converted
to measurements of the same type.
The type of the units is determined automatically from the units. For example, the unit "grams" is type "mass". Use the static call Measurement.getAvailableUnits to find out what units this version of ilib supports.
- Returns:
- {string} the name of the type of this measurement
{Measurement}
localize(locale)
Localize the measurement to the commonly used measurement in that locale. For example
If a user's locale is "en-US" and the measurement is given as "60 kmh",
the formatted number should be automatically converted to the most appropriate
measure in the other system, in this case, mph. The formatted result should
appear as "37.3 mph".
- Parameters:
- {string} locale
- current locale string
- Returns:
- {Measurement} a new instance that is converted to locale
{Measurement}
scale(measurementsystem)
Scale the measurement unit to an acceptable level. The scaling
happens so that the integer part of the amount is as small as
possible without being below zero. This will result in the
largest units that can represent this measurement without
fractions. Measurements can only be scaled to other measurements
of the same type.
- Parameters:
- {string=} measurementsystem
- system to use (uscustomary|imperial|metric), or undefined if the system can be inferred from the current measure
- Returns:
- {Measurement} a new instance that is scaled to the right level