utils

Home > @silence_zhpf/utils > Distance

Distance class

Distance对象, 包含一个值和一个单位。用于距离的表示和计算。

Signature:

export declare class Distance 

Properties

Property Modifiers Type Description
unit readonly Unit  
value readonly number  

Methods

Method Modifiers Description
add(other)   两个距离想加
div(factor)   Distance对象的除法
format({ precision, unit })   显示格式化输出,如果没有指定精度,默认为2,如果没有指定单位,默认为true.
mul(factor)   Distance对象的乘法
multiply(other)   This function multiplies two distance values and returns the resulting area value.
new(value, unit) static new 方法是创建Distance对象的静态方法,返回一个新的Distance对象。其接收两个参数,一个是Distance对象的值,一个是Distance对象的单位。如果没有指定单位,其默认为"m" (meters)。
sub(other)   两个距离相减
toCm()   Distance对象的单位转换为厘米
toDm()   Distance对象的单位转换为分米
toKm()   Distance对象的单位转换为千米
toM()   Distance对象的单位转换为米
toMm()   Distance的单位转换为毫米
toString()   返回Distance对象的字符串表示