Class Font

Hierarchy

Font

Implements

Equals
Debug

Index

Constructors

constructor

Methods

Constructors

constructor

new Font(style: FontStyle | null, variant: FontVariant | null, weight: FontWeight | null, stretch: FontStretch | null, size: FontSize | null, height: LineHeight | null, family: FontFamily | ReadonlyArray<FontFamily>): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:54
Parameters
- style: FontStyle | null
- variant: FontVariant | null
- weight: FontWeight | null
- stretch: FontStretch | null
- size: FontSize | null
- height: LineHeight | null
- family: FontFamily | ReadonlyArray<FontFamily>
Returns Font

Methods

debug

debug(output: Output): void

Implementation of Debug.debug
- Defined in swim-ui-js/@swim/font/main/Font.ts:204
Parameters
- output: Output
Returns void

equals

equals(that: unknown): boolean

Implementation of Equals.equals
- Defined in swim-ui-js/@swim/font/main/Font.ts:191
Parameters
- that: unknown
Returns boolean

family

family(): FontFamily | FontFamily[]
family(family: FontFamily | ReadonlyArray<FontFamily>): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:161
Returns FontFamily | FontFamily[]
- Defined in swim-ui-js/@swim/font/main/Font.ts:162
Parameters
- family: FontFamily | ReadonlyArray<FontFamily>
Returns Font

height

height(): LineHeight | null
height(height: AnyLineHeight | null): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:145
Returns LineHeight | null
- Defined in swim-ui-js/@swim/font/main/Font.ts:146
Parameters
- height: AnyLineHeight | null
Returns Font

size

size(): FontSize | null
size(size: AnyFontSize | null): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:129
Returns FontSize | null
- Defined in swim-ui-js/@swim/font/main/Font.ts:130
Parameters
- size: AnyFontSize | null
Returns Font

stretch

stretch(): FontStretch | null
stretch(stretch: FontStretch | null): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:114
Returns FontStretch | null
- Defined in swim-ui-js/@swim/font/main/Font.ts:115
Parameters
- stretch: FontStretch | null
Returns Font

style

style(): FontStyle | null
style(style: FontStyle | null): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:69
Returns FontStyle | null
- Defined in swim-ui-js/@swim/font/main/Font.ts:70
Parameters
- style: FontStyle | null
Returns Font

toAny

toAny(): FontInit

- Defined in swim-ui-js/@swim/font/main/Font.ts:179
Returns FontInit

toString

toString(): string

- Defined in swim-ui-js/@swim/font/main/Font.ts:235
Returns string

variant

variant(): FontVariant | null
variant(variant: FontVariant | null): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:84
Returns FontVariant | null
- Defined in swim-ui-js/@swim/font/main/Font.ts:85
Parameters
- variant: FontVariant | null
Returns Font

weight

weight(): FontWeight | null
weight(weight: FontWeight | null): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:99
Returns FontWeight | null
- Defined in swim-ui-js/@swim/font/main/Font.ts:100
Parameters
- weight: FontWeight | null
Returns Font

Static family

family(family: FontFamily | ReadonlyArray<FontFamily>): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:322
Parameters
- family: FontFamily | ReadonlyArray<FontFamily>
Returns Font

Static form

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

- Defined in swim-ui-js/@swim/font/main/Font.ts:398
Parameters
- Optional unit: Font
Returns Form<Font, AnyFont>

Static from

from(style?: FontStyle | null, variant?: FontVariant | null, weight?: FontWeight | null, stretch?: FontStretch | null, size?: AnyFontSize | null, height?: AnyLineHeight | null, family: FontFamily | ReadonlyArray<FontFamily>): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:329
Parameters
- Default value style: FontStyle | null = null
- Default value variant: FontVariant | null = null
- Default value weight: FontWeight | null = null
- Default value stretch: FontStretch | null = null
- Default value size: AnyFontSize | null = null
- Default value height: AnyLineHeight | null = null
- family: FontFamily | ReadonlyArray<FontFamily>
Returns Font

Static fromAny

fromAny(value: AnyFont): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:342
Parameters
- value: AnyFont
Returns Font

Static fromValue

fromValue(value: Value): Font | undefined

- Defined in swim-ui-js/@swim/font/main/Font.ts:354
Parameters
- value: Value
Returns Font | undefined

Static parse

parse(string: string): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:371
Parameters
- string: string
Returns Font

Static size

size(size: AnyFontSize | null, family: FontFamily | ReadonlyArray<FontFamily>): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:314
Parameters
- size: AnyFontSize | null
- family: FontFamily | ReadonlyArray<FontFamily>
Returns Font

Static stretch

stretch(stretch: FontStretch | null, family: FontFamily | ReadonlyArray<FontFamily>): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:307
Parameters
- stretch: FontStretch | null
- family: FontFamily | ReadonlyArray<FontFamily>
Returns Font

Static style

style(style: FontStyle | null, family: FontFamily | ReadonlyArray<FontFamily>): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:286
Parameters
- style: FontStyle | null
- family: FontFamily | ReadonlyArray<FontFamily>
Returns Font

Static variant

variant(variant: FontVariant | null, family: FontFamily | ReadonlyArray<FontFamily>): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:293
Parameters
- variant: FontVariant | null
- family: FontFamily | ReadonlyArray<FontFamily>
Returns Font

Static weight

weight(weight: FontWeight | null, family: FontFamily | ReadonlyArray<FontFamily>): Font

- Defined in swim-ui-js/@swim/font/main/Font.ts:300
Parameters
- weight: FontWeight | null
- family: FontFamily | ReadonlyArray<FontFamily>
Returns Font