Class Font

Hierarchy

Font

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Font(style: undefined | FontStyle, variant: undefined | FontVariant, weight: undefined | FontWeight, stretch: undefined | FontStretch, size: null | FontSize, height: null | LineHeight, family: string | readonly string[]): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:22
Parameters
- style: undefined | FontStyle
- variant: undefined | FontVariant
- weight: undefined | FontWeight
- stretch: undefined | FontStretch
- size: null | FontSize
- height: null | LineHeight
- family: string | readonly string[]
Returns Font

Properties

Readonly family

family: string | readonly string[]

Readonly height

height: null | LineHeight

Readonly size

size: null | FontSize

Readonly stretch

stretch: undefined | FontStretch

Readonly stringValue

stringValue: undefined | string

Readonly style

style: undefined | FontStyle

Readonly variant

variant: undefined | FontVariant

Readonly weight

weight: undefined | FontWeight

Methods

debug

debug(output: Output<unknown>): void

Implementation of Debug.debug
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:43
Parameters
- output: Output<unknown>
Returns void

equals

equals(that: unknown): boolean

Implementation of Equals.equals
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:42
Parameters
- that: unknown
Returns boolean

equivalentTo

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

Implementation of Equivalent.equivalentTo
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:41
Parameters
- that: unknown
- Optional epsilon: number
Returns boolean

interpolateTo

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

Implementation of Interpolate.interpolateTo
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:39
Parameters
- that: Font
Returns Interpolator<Font>
Implementation of Interpolate.interpolateTo
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:40
Parameters
- that: unknown
Returns null | Interpolator<Font>

toAny

toAny(): FontInit

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:38
Returns FontInit

toString

toString(): string

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:45
Returns string

withFamily

withFamily(family: string | readonly string[]): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:37
Parameters
- family: string | readonly string[]
Returns Font

withHeight

withHeight(height: null | AnyLineHeight): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:35
Parameters
- height: null | AnyLineHeight
Returns Font

withSize

withSize(size: null | AnyFontSize): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:33
Parameters
- size: null | AnyFontSize
Returns Font

withStretch

withStretch(stretch: undefined | FontStretch): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:31
Parameters
- stretch: undefined | FontStretch
Returns Font

withStyle

withStyle(style: undefined | FontStyle): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:25
Parameters
- style: undefined | FontStyle
Returns Font

withVariant

withVariant(variant: undefined | FontVariant): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:27
Parameters
- variant: undefined | FontVariant
Returns Font

withWeight

withWeight(weight: undefined | FontWeight): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:29
Parameters
- weight: undefined | FontWeight
Returns Font

Static create

create(style: undefined | FontStyle, variant: undefined | FontVariant, weight: undefined | FontWeight, stretch: undefined | FontStretch, size: undefined | null | AnyFontSize, height: undefined | null | AnyLineHeight, family: string | readonly string[]): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:52
Parameters
- style: undefined | FontStyle
- variant: undefined | FontVariant
- weight: undefined | FontWeight
- stretch: undefined | FontStretch
- size: undefined | null | AnyFontSize
- height: undefined | null | AnyLineHeight
- family: string | readonly string[]
Returns Font

Static family

family(family: string | readonly string[]): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:51
Parameters
- family: string | readonly string[]
Returns Font

Static form

form(unit?: Font): Form<Font, AnyFont>

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:59
Parameters
- Optional unit: Font
Returns Form<Font, AnyFont>

Static fromAny

fromAny(value: AnyFont): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:55
Parameters
- value: AnyFont
Returns Font

Static fromInit

fromInit(init: FontInit): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:53
Parameters
- init: FontInit
Returns Font

Static fromValue

fromValue(value: Value): null | Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:54
Parameters
- value: Value
Returns null | Font

Static isAny

isAny(value: unknown): value is AnyFont

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:58
Parameters
- value: unknown
Returns value is AnyFont

Static isInit

isInit(value: unknown): value is FontInit

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:57
Parameters
- value: unknown
Returns value is FontInit

Static parse

parse(string: string): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:56
Parameters
- string: string
Returns Font

Static size

size(size: null | AnyFontSize, family: string | readonly string[]): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:50
Parameters
- size: null | AnyFontSize
- family: string | readonly string[]
Returns Font

Static stretch

stretch(stretch: undefined | FontStretch, family: string | readonly string[]): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:49
Parameters
- stretch: undefined | FontStretch
- family: string | readonly string[]
Returns Font

Static style

style(style: undefined | FontStyle, family: string | readonly string[]): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:46
Parameters
- style: undefined | FontStyle
- family: string | readonly string[]
Returns Font

Static variant

variant(variant: undefined | FontVariant, family: string | readonly string[]): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:47
Parameters
- variant: undefined | FontVariant
- family: string | readonly string[]
Returns Font

Static weight

weight(weight: undefined | FontWeight, family: string | readonly string[]): Font

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/Font.d.ts:48
Parameters
- weight: undefined | FontWeight
- family: string | readonly string[]
Returns Font

Generated using TypeDoc