Class AliasUnit<T>

internal

Type parameters

T: UnitTerms

Hierarchy

UnitBase<T>
- AliasUnit

Implements

Alias
Unit<T>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AliasUnit<T>(name: string, symbol: undefined | string, attributes: AliasAttributes, si: Unit<T> & SI, scale: number, offset?: number): AliasUnit<T>

Inherited from UnitBase.constructor
- Defined in src/units.ts:419
Type parameters
- T: UnitTerms
Parameters
- name: string
- symbol: undefined | string
- attributes: AliasAttributes
- si: Unit<T> & SI
- scale: number
- offset: number = 0
Returns AliasUnit<T>

Properties

Readonly attributes

attributes: UnitAttributes

Readonly key

key: T

Readonly name

name: string

Readonly names

names: string[] = ...

Readonly offset

offset: number

Readonly scale

scale: number

Readonly si

si: Unit<T>

Optional Readonly symbol

symbol: undefined | string

Accessors

html

get html(): Element & ViewOf<this>

- Defined in src/primitive-units.ts:215
Returns Element & ViewOf<this>

id

get id(): string

- Defined in src/primitive-units.ts:210
Returns string

tex

get tex(): string

- Defined in src/primitive-units.ts:204
Returns string

Methods

add

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

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

divide

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

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

fromSI

fromSI<R>(v: R, unit: Unit<UnitTerms>): [R, AliasUnit<T>]

- Defined in src/units.ts:438
Type parameters
- R: number
Parameters
- v: R
- unit: Unit<UnitTerms>
Returns [R, AliasUnit<T>]

multiply

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

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

toHtml

toHtml(block?: boolean, ctx?: StyleContext): Element & ViewOf<AliasUnit<T>>

Implementation of Unit.toHtml

Inherited from UnitBase.toHtml
- Defined in src/primitive-units.ts:219
Parameters
- Optional block: boolean
- ctx: StyleContext = ...
Returns Element & ViewOf<AliasUnit<T>>

toSI

toSI<R>(v: R): [R, Unit<UnitTerms>]

- Defined in src/units.ts:432
Type parameters
- R: number
Parameters
- v: R
Returns [R, Unit<UnitTerms>]

toString

toString(): string

Inherited from UnitBase.toString
- Defined in src/primitive-units.ts:229
Returns string

toTex

toTex(ctx?: StyleContext): string

Implementation of Unit.toTex

Inherited from UnitBase.toTex
- Defined in src/primitive-units.ts:178
Parameters
- ctx: StyleContext = ...
Returns string

Generated using TypeDoc