Class Font

constructor

• new Font(): Font

  Returns Font

StaticFILES

StaticHOST_URL

StaticscaleToPxFrom

StaticconvertSizeToPixelValue

• convertSizeToPixelValue(fontSize: string | number): number

  Parameters

  • fontSize: string | number

    a font size to convert. Can be specified as a CSS length string (e.g., '16pt', '1em') or as a number (the unit is assumed to be 'pt'). See Font.scaleToPxFrom for the supported units (e.g., pt, em, %).

  Returns number

  the number of pixels that is equivalent to fontSize

StaticconvertSizeToPointValue

• convertSizeToPointValue(fontSize: string | number): number

  Parameters

  • fontSize: string | number

    a font size to convert. Can be specified as a CSS length string (e.g., '16pt', '1em') or as a number (the unit is assumed to be 'pt'). See Font.scaleToPxFrom for the supported units (e.g., pt, em, %).

  Returns number

  the number of points that is equivalent to fontSize

StaticfromCSSString

• fromCSSString(cssFontShorthand: string): Required<FontInfo>

  Parameters

  • cssFontShorthand: string

    a string formatted as CSS font shorthand (e.g., 'italic bold 15pt Arial').

  Returns Required<FontInfo>

StaticgetURLForFont

• getURLForFont(fontName: string): undefined | string

  Parameters

  • fontName: string

  Returns undefined | string

StaticisBold

• isBold(weight?: string | number): boolean

  Parameters

  • Optionalweight: string | number

    a string (e.g., 'bold') or a number (e.g., 600 / semi-bold in the OpenType spec).

  Returns boolean

  true if the font weight indicates bold.

StaticisItalic

• isItalic(style?: string): boolean

  Parameters

  • Optionalstyle: string

  Returns boolean

  true if the font style indicates 'italic'.

Staticload

• load(
      fontName: string,
      url?: string,
      descriptors?: Record<string, string>,
  ): Promise<FontFace>

  This method is asynchronous, so you should use await or .then() to wait for the fonts to load before proceeding.

  Parameters

  • fontName: string
  • Optionalurl: string

    The absolute or relative URL to the woff2/otf file. It can also be a data URI.
  • Optionaldescriptors: Record<string, string>

    See: https://developer.mozilla.org/en-US/docs/Web/API/FontFace/FontFace#descriptors

  Returns Promise<FontFace>

StaticscaleSize

• scaleSize<T extends string | number>(fontSize: T, scaleFactor: number): T

  Type Parameters

  • T extends string | number

  Parameters

  • fontSize: T

    a number representing a font size, or a string font size with units.
  • scaleFactor: number

    multiply the size by this factor.

  Returns T

  size * scaleFactor (e.g., 16pt * 3 = 48pt, 8px * 0.5 = 4px, 24 * 2 = 48). If the fontSize argument was a number, the return value will be a number. If the fontSize argument was a string, the return value will be a string.

StatictoCSSString

• toCSSString(fontInfo?: FontInfo): string

  Parameters

  • OptionalfontInfo: FontInfo

  Returns string

  a CSS font shorthand string of the form italic bold 16pt Arial.

Staticvalidate

• validate(
      f?: string | FontInfo,
      size?: string | number,
      weight?: string | number,
      style?: string,
  ): Required<FontInfo>

  Parameters

  • Optionalf: string | FontInfo
  • Optionalsize: string | number
  • Optionalweight: string | number
  • Optionalstyle: string

  Returns Required<FontInfo>

  the size field will include the units (e.g., '12pt', '16px').