Unit #

new Unit([value], [name]) #

单元可以有以下几种构造方式

const a = new Unit(value, name)
const b = new Unit(null, name)
const c = Unit.parse(str)

示例用法

const a = new Unit(5, 'cm')               // 50 mm
const b = Unit.parse('23 kg')             // 23 kg
const c = math.in(a, new Unit(null, 'm')  // 0.05 m
const d = new Unit(9.81, "m/s^2")         // 9.81 m/s^2
参数 Type Description
[value] number | BigNumber | Fraction | Complex | boolean 例如 5.2 这样的值
[name] string 例如“cm”或“inch”这样的单位名称,或如下形式的派生单位:“u1[^ex1] [u2[^ex2] …] [/ u3[^ex3] [u4[^ex4]]]”,例如“kg m^2/s^2”,其中斜杠后面的每个单位都被视为在分母中。“kg m^2 s^-2”是同义词,也可以接受。任何单位都可以包含前缀。

unit.valueOf ⇒ string #

返回单位的字符串表示。

类型: Unit 的实例属性

unit.clone() ⇒ Unit #

创建此单元的副本

类型: Unit 的实例方法
返回: Unit - 返回一个克隆的单元

unit._isDerived() ⇒ boolean #

返回该单元是否为派生单元(例如 m/s 或 cm^2,但不是 N)

类型: Unit 的实例方法
返回: boolean - 如果单元是派生的,则为 True

unit.hasBase(base) #

检查此单元是否具有给定的基本单位。如果此单元是派生单位,则此项将始终返回 false,因为根据定义,基本单位不是派生的。

类型: Unit 的实例方法

参数 Type
base BASE_UNITS | STRING | undefined

unit.equalBase(other) ⇒ boolean #

检查此单元是否具有与另一个基或基相等的基或基。对于派生单位,每个基上的指数也必须匹配。

类型: Unit 的实例方法
返回: boolean - 如果基本单位相等,则为 true

参数 Type
other 单位

unit.equals(other) ⇒ boolean #

检查此单元是否等于另一个单元

类型: Unit 的实例方法
返回: boolean - 如果两个单元都相等,则为 true

参数 Type
other 单位

unit.multiply(other) ⇒ Unit #

将此单元与另一个单元相乘

类型: Unit 的实例方法
返回: Unit - 此单元与另一个单元的乘积

参数 Type
other 单位

unit.divide(other) ⇒ Unit #

将此单元除以另一个单元

类型: Unit 的实例方法
返回: Unit - 将此单元除以另一个单元的结果

参数 Type
other 单位

unit.pow(p) ⇒ Unit #

计算单元的幂

类型: Unit 的实例方法
返回: Unit - 结果:this^p

参数 Type
p number | Fraction | BigNumber

unit.abs(x) ⇒ Unit #

计算单元的绝对值

类型: Unit 的实例方法
返回: Unit - 结果:|x|,x 的绝对值

参数 Type
x number | Fraction | BigNumber

unit.to(valuelessUnit) ⇒ Unit #

将单元转换为特定的单元名称。

类型: Unit 的实例方法
返回: Unit - 返回一个具有固定前缀和单元的单元副本。

参数 Type Description
valuelessUnit string | Unit 一个没有值的单元。可以有前缀,例如“cm”

unit.toNumber(valuelessUnit) ⇒ number #

返回该单元表示为给定无值单元时的值

类型: Unit 的实例方法
返回: number - 返回单元值作为数字。

参数 Type Description
valuelessUnit string | Unit 例如“cm”或“inch”

unit.toNumeric(valuelessUnit) ⇒ number | BigNumber | Fraction #

以原始数字类型返回单元的值

类型: Unit 的实例方法
返回: number | BigNumber | Fraction - 返回单元值

参数 Type Description
valuelessUnit string | Unit 例如“cm”或“inch”

unit.toString() ⇒ string #

获取单元的字符串表示。

类型: Unit 的实例方法

unit.toJSON() ⇒ Object #

获取单元的 JSON 表示

类型: Unit 的实例方法
返回: Object - 返回一个 JSON 对象,结构如下:{"mathjs": "Unit", "value": 2, "unit": "cm", "fixPrefix": false}

unit.formatUnits() ⇒ string #

获取此单元的单元的字符串表示,不含值。

类型: Unit 的实例方法

unit.format([options]) ⇒ string #

获取单元的字符串表示,包含可选的格式化选项。

类型: Unit 的实例方法

参数 Type Description
[options] Object | number | function 格式化选项。有关可用选项的说明,请参阅 lib/utils/number:format。

unit.toBest(unitList, options) ⇒ Unit #

使用可选的 unitList 和 options 将单位转换为最合适的显示单位。

类型: Unit 的实例方法 返回: Unit

参数 Type Description
unitList 字符串数组 | 单位字符串数组(可选)。
options Object | 目前只有“offset”可用 - 更好的前缀计算

Unit.parse(str) ⇒ Unit #

将字符串解析为单元。单元的值根据 math.js 的配置设置 number 解析为 number、BigNumber 或 Fraction。

如果提供的字符串不包含有效单元或无法解析,则会引发异常。

类型: Unit 的静态方法
返回: Unit - 单元

参数 Type Description
str string 例如“5.2 inch”、“4e2 cm/s^2”这样的字符串

Unit.isValuelessUnit(name) ⇒ boolean #

测试给定的表达式是否为一个单元。该单元可以包含前缀,但不能包含值。

类型: Unit 的静态方法
返回: boolean - 如果给定的字符串是一个单元,则为 true

参数 Type Description
name string 一个用于测试是否为无值单元的字符串。该单元可以包含前缀,例如“cm”

Unit.fromJSON(json) ⇒ Unit #

从 JSON 对象实例化一个 Unit

类型: Unit 的静态方法

参数 Type Description
json Object 一个 JSON 对象,结构如下:{"mathjs": "Unit", "value": 2, "unit": "cm", "fixPrefix": false}
Fork me on GitHub