Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Font

Describes a Font to visualize text with. Depending on the platform a font that matches the settings most closely is chosen. The settings may be ignored entirely if the platform can't support different fonts such as in a terminal for example.

Hierarchy

  • Font

Index

Properties

family

family: string

The family name of the font to use. This corresponds with the Typographic Family Name (Name ID 16) in the name table of the font. If no such entry exists, the Font Family Name (Name ID 1) is to be used instead. If there are multiple entries for the name, the english entry is the one to choose. The subfamily is not specified at all and instead a suitable subfamily is chosen based on the style, weight and stretch values. https://docs.microsoft.com/en-us/typography/opentype/spec/name

This is to ensure the highest portability across various platforms. Platforms often select fonts very differently, so if necessary it is also fine to store a different font identifier here at the cost of sacrificing portability.

stretch

stretch: FontStretch

The stretch of the font to prefer selecting.

style

style: FontStyle

The style of the font to prefer selecting.

weight

weight: FontWeight

The weight of the font to prefer selecting.

Generated using TypeDoc