Class Length

Hierarchy

Length

Implements

Index

Methods

Methods

Abstract debug

debug(output: Output): void

Implementation of Debug.debug
- Defined in swim-ui-js/@swim/length/main/Length.ts:118
Parameters
- output: Output
Returns void

divide

divide(scalar: number, units?: LengthUnits): Length

- Defined in swim-ui-js/@swim/length/main/Length.ts:57
Parameters
- scalar: number
- Default value units: LengthUnits = this.units()
Returns Length

em

em(): EmLength

- Defined in swim-ui-js/@swim/length/main/Length.ts:82
Returns EmLength

emValue

emValue(): number

- Defined in swim-ui-js/@swim/length/main/Length.ts:66
Returns number

Abstract equals

equals(that: unknown): boolean

Implementation of HashCode.equals
- Defined in swim-ui-js/@swim/length/main/Length.ts:114
Parameters
- that: unknown
Returns boolean

Abstract hashCode

hashCode(): number

Implementation of HashCode.hashCode
- Defined in swim-ui-js/@swim/length/main/Length.ts:116
Returns number

isDefined

isDefined(): boolean

- Defined in swim-ui-js/@swim/length/main/Length.ts:31
Returns boolean

minus

minus(that: AnyLength, units?: LengthUnits): Length

- Defined in swim-ui-js/@swim/length/main/Length.ts:49
Parameters
- that: AnyLength
- Default value units: LengthUnits = this.units()
Returns Length

Abstract node

node(): Node | undefined

- Defined in swim-ui-js/@swim/length/main/Length.ts:39
Returns Node | undefined

opposite

opposite(units?: LengthUnits): Length

- Defined in swim-ui-js/@swim/length/main/Length.ts:45
Parameters
- Default value units: LengthUnits = this.units()
Returns Length

pct

pct(): PctLength

- Defined in swim-ui-js/@swim/length/main/Length.ts:90
Returns PctLength

pctValue

pctValue(): number

- Defined in swim-ui-js/@swim/length/main/Length.ts:74
Returns number

plus

plus(that: AnyLength, units?: LengthUnits): Length

- Defined in swim-ui-js/@swim/length/main/Length.ts:41
Parameters
- that: AnyLength
- Default value units: LengthUnits = this.units()
Returns Length

px

px(unitValue?: undefined | number): PxLength

- Defined in swim-ui-js/@swim/length/main/Length.ts:78
Parameters
- Optional unitValue: undefined | number
Returns PxLength

Abstract pxValue

pxValue(unitValue?: undefined | number): number

- Defined in swim-ui-js/@swim/length/main/Length.ts:64
Parameters
- Optional unitValue: undefined | number
Returns number

rem

rem(): RemLength

- Defined in swim-ui-js/@swim/length/main/Length.ts:86
Returns RemLength

remValue

remValue(): number

- Defined in swim-ui-js/@swim/length/main/Length.ts:70
Returns number

times

times(scalar: number, units?: LengthUnits): Length

- Defined in swim-ui-js/@swim/length/main/Length.ts:53
Parameters
- scalar: number
- Default value units: LengthUnits = this.units()
Returns Length

to

to(units: LengthUnits): Length

- Defined in swim-ui-js/@swim/length/main/Length.ts:104
Parameters
- units: LengthUnits
Returns Length

Abstract toString

toString(): string

- Defined in swim-ui-js/@swim/length/main/Length.ts:120
Returns string

toValue

toValue(units: LengthUnits): number

- Defined in swim-ui-js/@swim/length/main/Length.ts:94
Parameters
- units: LengthUnits
Returns number

Abstract unitValue

unitValue(): number

- Defined in swim-ui-js/@swim/length/main/Length.ts:62
Returns the base unit value, in pixels.

Returns number

Abstract units

units(): LengthUnits

- Defined in swim-ui-js/@swim/length/main/Length.ts:37
Returns LengthUnits

Abstract value

value(): number

- Defined in swim-ui-js/@swim/length/main/Length.ts:35
Returns number

Static em

em(value: number, node?: Node): EmLength

- Defined in swim-ui-js/@swim/length/main/Length.ts:132
Parameters
- value: number
- Optional node: Node
Returns EmLength

Static form

form(defaultUnits?: LengthUnits, node?: Node, unit?: AnyLength): Form<Length, AnyLength>

- Defined in swim-ui-js/@swim/length/main/Length.ts:224
Parameters
- Optional defaultUnits: LengthUnits
- Optional node: Node
- Optional unit: AnyLength
Returns Form<Length, AnyLength>

Static from

from(value: number, units?: LengthUnits, node?: Node): Length
from(value: number, node?: Node): Length

- Defined in swim-ui-js/@swim/length/main/Length.ts:148
Parameters
- value: number
- Optional units: LengthUnits
- Optional node: Node
Returns Length
- Defined in swim-ui-js/@swim/length/main/Length.ts:149
Parameters
- value: number
- Optional node: Node
Returns Length

Static fromAny

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

- Defined in swim-ui-js/@swim/length/main/Length.ts:165
Parameters
- value: AnyLength
- Optional defaultUnits: LengthUnits
- Optional node: Node
Returns Length
- Defined in swim-ui-js/@swim/length/main/Length.ts:166
Parameters
- value: AnyLength
- Optional node: Node
Returns Length

Static fromValue

fromValue(value: Value, node?: Node): Length | undefined

- Defined in swim-ui-js/@swim/length/main/Length.ts:183
Parameters
- value: Value
- Optional node: Node
Returns Length | undefined

Static parse

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

- Defined in swim-ui-js/@swim/length/main/Length.ts:200
Parameters
- string: string
- Optional defaultUnits: LengthUnits
- Optional node: Node
Returns Length
- Defined in swim-ui-js/@swim/length/main/Length.ts:201
Parameters
- string: string
- Optional node: Node
Returns Length

Static pct

pct(value: number, node?: Node): PctLength

- Defined in swim-ui-js/@swim/length/main/Length.ts:140
Parameters
- value: number
- Optional node: Node
Returns PctLength

Static px

px(value: number, node?: Node): PxLength

- Defined in swim-ui-js/@swim/length/main/Length.ts:128
Parameters
- value: number
- Optional node: Node
Returns PxLength

Static rem

rem(value: number, node?: Node): RemLength

- Defined in swim-ui-js/@swim/length/main/Length.ts:136
Parameters
- value: number
- Optional node: Node
Returns RemLength

Static unitless

unitless(value: number, node?: Node): UnitlessLength

- Defined in swim-ui-js/@swim/length/main/Length.ts:144
Parameters
- value: number
- Optional node: Node
Returns UnitlessLength

Static zero

zero(units?: LengthUnits, node?: Node): Length
zero(node?: Node): Length

- Defined in swim-ui-js/@swim/length/main/Length.ts:122
Parameters
- Optional units: LengthUnits
- Optional node: Node
Returns Length
- Defined in swim-ui-js/@swim/length/main/Length.ts:123
Parameters
- Optional node: Node
Returns Length