Class Length

Hierarchy

Length

Implements

Index

Constructors

constructor

Properties

units
value

Methods

Constructors

constructor

new Length(): Length

Returns Length

Properties

Readonly Abstract units

units: LengthUnits

Readonly Abstract value

value: number

Methods

combine

combine(that: AnyLength, scalar?: number, units?: LengthUnits, basis?: number | LengthBasis): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:26
Parameters
- that: AnyLength
- Optional scalar: number
- Optional units: LengthUnits
- Optional basis: number | LengthBasis
Returns Length

Abstract compareTo

compareTo(that: unknown): number

Implementation of Compare.compareTo
- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:41
Parameters
- that: unknown
Returns number

Abstract debug

debug(output: Output<unknown>): void

Implementation of Debug.debug
- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:45
Parameters
- output: Output<unknown>
Returns void

divide

divide(scalar: number, units?: LengthUnits, basis?: number | LengthBasis): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:25
Parameters
- scalar: number
- Optional units: LengthUnits
- Optional basis: number | LengthBasis
Returns Length

em

em(basis?: number | LengthBasis): EmLength

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:32
Parameters
- Optional basis: number | LengthBasis
Returns EmLength

emValue

emValue(basis?: number | LengthBasis): number

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:28
Parameters
- Optional basis: number | LengthBasis
Returns number

Abstract equals

equals(that: unknown): boolean

Implementation of HashCode.equals
- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:43
Parameters
- that: unknown
Returns boolean

Abstract equivalentTo

equivalentTo(that: unknown, epsilon?: number): boolean

Implementation of Equivalent.equivalentTo
- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:42
Parameters
- that: unknown
- Optional epsilon: number
Returns boolean

Abstract hashCode

hashCode(): number

Implementation of HashCode.hashCode
- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:44
Returns number

interpolateTo

interpolateTo(that: Length): Interpolator<Length>
interpolateTo(that: unknown): null | Interpolator<Length>

Implementation of Interpolate.interpolateTo
- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:39
Parameters
- that: Length
Returns Interpolator<Length>
Implementation of Interpolate.interpolateTo
- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:40
Parameters
- that: unknown
Returns null | Interpolator<Length>

isDefined

isDefined(): boolean

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:18
Returns boolean

minus

minus(that: AnyLength, units?: LengthUnits, basis?: number | LengthBasis): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:23
Parameters
- that: AnyLength
- Optional units: LengthUnits
- Optional basis: number | LengthBasis
Returns Length

negative

negative(units?: LengthUnits, basis?: number | LengthBasis): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:22
Parameters
- Optional units: LengthUnits
- Optional basis: number | LengthBasis
Returns Length

pct

pct(basis?: number | LengthBasis): PctLength

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:34
Parameters
- Optional basis: number | LengthBasis
Returns PctLength

pctValue

pctValue(basis?: number | LengthBasis): number

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:30
Parameters
- Optional basis: number | LengthBasis
Returns number

plus

plus(that: AnyLength, units?: LengthUnits, basis?: number | LengthBasis): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:21
Parameters
- that: AnyLength
- Optional units: LengthUnits
- Optional basis: number | LengthBasis
Returns Length

px

px(basis?: number | LengthBasis): PxLength

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:31
Parameters
- Optional basis: number | LengthBasis
Returns PxLength

Abstract pxValue

pxValue(basis?: number | LengthBasis): number

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:27
Parameters
- Optional basis: number | LengthBasis
Returns number

rem

rem(basis?: number | LengthBasis): RemLength

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:33
Parameters
- Optional basis: number | LengthBasis
Returns RemLength

remValue

remValue(basis?: number | LengthBasis): number

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:29
Parameters
- Optional basis: number | LengthBasis
Returns number

times

times(scalar: number, units?: LengthUnits, basis?: number | LengthBasis): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:24
Parameters
- scalar: number
- Optional units: LengthUnits
- Optional basis: number | LengthBasis
Returns Length

to

to(units: LengthUnits, basis?: number | LengthBasis): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:37
Parameters
- units: LengthUnits
- Optional basis: number | LengthBasis
Returns Length

Abstract toCssValue

toCssValue(): null | CSSUnitValue

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:38
Returns null | CSSUnitValue

Abstract toString

toString(): string

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:46
Returns string

toValue

toValue(): Value
toValue(units: LengthUnits, basis?: number | LengthBasis): number

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:35
Returns Value
- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:36
Parameters
- units: LengthUnits
- Optional basis: number | LengthBasis
Returns number

Static create

create(value: number, units?: LengthUnits): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:53
Parameters
- value: number
- Optional units: LengthUnits
Returns Length

Static em

em(value: number): EmLength

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:49
Parameters
- value: number
Returns EmLength

Static emUnit

emUnit(basis?: number | LengthBasis): number

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:60
Parameters
- Optional basis: number | LengthBasis
Returns number

Static form

form(): Form<Length, AnyLength>

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:58
Returns Form<Length, AnyLength>

Static fromAny

fromAny(value: AnyLength, defaultUnits?: LengthUnits): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:55
Parameters
- value: AnyLength
- Optional defaultUnits: LengthUnits
Returns Length

Static fromCssValue

fromCssValue(value: CSSStyleValue): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:54
Parameters
- value: CSSStyleValue
Returns Length

Static fromValue

fromValue(value: Value): null | Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:56
Parameters
- value: Value
Returns null | Length

Static isAny

isAny(value: unknown): value is AnyLength

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:59
Parameters
- value: unknown
Returns value is AnyLength

Static parse

parse(string: string, defaultUnits?: LengthUnits): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:57
Parameters
- string: string
- Optional defaultUnits: LengthUnits
Returns Length

Static pct

pct(value: number): PctLength

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:51
Parameters
- value: number
Returns PctLength

Static pctUnit

pctUnit(basis?: number | LengthBasis): number

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:62
Parameters
- Optional basis: number | LengthBasis
Returns number

Static px

px(value: number): PxLength

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:48
Parameters
- value: number
Returns PxLength

Static rem

rem(value: number): RemLength

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:50
Parameters
- value: number
Returns RemLength

Static remUnit

remUnit(basis?: number | LengthBasis): number

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:61
Parameters
- Optional basis: number | LengthBasis
Returns number

Static unitless

unitless(value: number): UnitlessLength

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:52
Parameters
- value: number
Returns UnitlessLength

Static zero

zero(units?: LengthUnits): Length

- Defined in swim-system-js/swim-core-js/@swim/math/lib/main/length/Length.d.ts:47
Parameters
- Optional units: LengthUnits
Returns Length

Generated using TypeDoc