Class DerivedUnit<T>

Derived units build on the primitive units through multiplication (integration) and division (differentiation).

Type parameters

T: UnitTerms

Hierarchy

UnitBase<T>
- DerivedUnit

Implements

IUnitBase<T>
Unit<T>
SI

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new DerivedUnit(key: T, attributes?: UnitAttributes): DerivedUnit

Overrides UnitBase.constructor
- Defined in src/units.ts:254
Parameters
- key: T
- Default value attributes: UnitAttributes = {}
Returns DerivedUnit

Properties

Readonly attributes

attributes: UnitAttributes

Readonly key

key: T

Readonly name

name: string

Readonly names

names: string[] = []

Optional Readonly symbol

symbol: undefined | string

Optional Readonly varName

varName: undefined | string

Accessors

html

get html(): Element & ViewOf<this>

Inherited from DerivedUnit.html
- Defined in src/primitive-units.ts:210
Returns Element & ViewOf<this>

id

get id(): string

Inherited from DerivedUnit.id
- Defined in src/primitive-units.ts:205
Returns string

si

get si(): Unit<T> & SI

- Defined in src/units.ts:288
Returns Unit<T> & SI

tex

get tex(): string

Inherited from DerivedUnit.tex
- Defined in src/primitive-units.ts:199
Returns string

Methods

add

add(u: Unit<T>): Unit<T>

Implementation of Unit.add
- Defined in src/units.ts:294
Parameters
- u: Unit<T>
Returns Unit<T>

Private combine

combine<X>(u: IUnitBase<X>, dir?: number): Unit

- Defined in src/units.ts:302
Type parameters
- X: PUnitTerms
Parameters
- u: IUnitBase<X>
- Default value dir: number = 1 | -1
Returns Unit

divide

divide<X>(u: Unit<X>): Unit<DivideTerms<T, X>>

Implementation of Unit.divide
- Defined in src/units.ts:318
Type parameters
- X: UnitTerms
Parameters
- u: Unit<X>
Returns Unit<DivideTerms<T, X>>

fromSI

fromSI(v: number, unit: Unit): [number, this]

Implementation of Unit.fromSI
- Defined in src/units.ts:322
Parameters
- v: number
- unit: Unit
Returns [number, this]

multiply

multiply<X>(u: Unit<X>): Unit<MultiplyTerms<T, X>>

Implementation of Unit.multiply
- Defined in src/units.ts:314
Type parameters
- X: UnitTerms
Parameters
- u: Unit<X>
Returns Unit<MultiplyTerms<T, X>>

toHtml

toHtml(block?: undefined | false | true, ctx?: StyleContext): Element & ViewOf<this>

Implementation of IUnitBase.toHtml

Inherited from DerivedUnit.toHtml
- Defined in src/primitive-units.ts:214
Parameters
- Optional block: undefined | false | true
- Default value ctx: StyleContext = DEFAULT_STYLE.context
Returns Element & ViewOf<this>

toSI

toSI(v: number): [number, Unit]

Implementation of Unit.toSI
- Defined in src/units.ts:326
Parameters
- v: number
Returns [number, Unit]

toString

toString(): string

Inherited from DerivedUnit.toString
- Defined in src/primitive-units.ts:224
Returns string

toTex

toTex(ctx?: StyleContext): string

Implementation of IUnitBase.toTex

Inherited from DerivedUnit.toTex
- Defined in src/primitive-units.ts:175
Parameters
- Default value ctx: StyleContext = DEFAULT_STYLE.context
Returns string

Generated using TypeDoc