Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FontSettings <TProps >

Index

Constructors

constructor

Methods

getFamily

  • getFamily(): string
  • Returns string

    The list of typeface names / family names.

getSize

  • getSize(): number
  • Returns number

    The size, or height of the font.

getStyle

getVariant

  • getVariant(): boolean
  • Returns boolean

    Small caps or not

getWeight

  • Returns FontWeight

    The weight style, or thickness of the font characters.

setFamily

  • setFamily(family: string): this
  • Parameters

    • family: string

    Returns this

    New FontSettings object.

setSize

  • setSize(size: number): this
  • Parameters

    • size: number

    Returns this

    New FontSettings object.

setStyle

  • Parameters

    Returns this

    New FontSettings object.

setVariant

  • setVariant(smallCaps: boolean): this
  • Parameters

    • smallCaps: boolean

    Returns this

    New FontSettings object.

setWeight

  • Parameters

    Returns this

    New FontSettings object.

Static Factory

  • Factory(values: Partial<TProps> | Iterable<[string, any]>): Record<TProps> & Readonly<TProps>
  • Type parameters

    • TProps: Object

    Parameters

    • Optional values: Partial<TProps> | Iterable<[string, any]>

    Returns Record<TProps> & Readonly<TProps>

Static Record

  • Record(defaultValues: TProps, name: undefined | string): Factory<TProps>
  • Type parameters

    • TProps

    Parameters

    • defaultValues: TProps
    • Optional name: undefined | string

    Returns Factory<TProps>

Static getDescriptiveName

  • getDescriptiveName(record: Record<any>): string
  • Parameters

    • record: Record<any>

    Returns string

Static isRecord

  • isRecord(maybeRecord: any): boolean
  • Parameters

    • maybeRecord: any

    Returns boolean