Class Font

constructor

• new Font(face: Face): Font

  Parameters

  • face: Face

    A Face to create the font from.

  Returns Font

• new Font(existingPtr: number): Font
  Internal

  Wrap an existing font pointer.

  Parameters

  • existingPtr: number

  Returns Font

Readonlyptr

glyph

• glyph(unicode: number, variationSelector?: number): number | undefined

  Fetches the glyph ID for a Unicode code point in the specified font, with an optional variation selector.

  If variationSelector is 0, it is equivalent to Font.nominalGlyph; otherwise it is equivalent to Font.variationGlyph.

  Parameters

  • unicode: number

    The Unicode code point to query.

  • variationSelector: number = 0

    A variation-selector code point.

  Returns number | undefined

  The glyph ID, or undefined if not found.

glyphExtents

• glyphExtents(glyphId: number): GlyphExtents | undefined

  Return glyph extents.

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns GlyphExtents | undefined

  An object with xBearing, yBearing, width, and height, or undefined.

glyphFromName

• glyphFromName(name: string): number | undefined

  Return glyph ID from name.

  Parameters

  • name: string

    Name of the requested glyph in the font.

  Returns number | undefined

  The glyph ID, or undefined if not found.

glyphHAdvance

• glyphHAdvance(glyphId: number): number

  Return glyph horizontal advance.

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns number

  The horizontal advance width.

glyphHOrigin

• glyphHOrigin(glyphId: number): [number, number] | undefined

  Return glyph horizontal origin.

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns [number, number] | undefined

  [x, y] origin coordinates, or undefined if not available.

glyphName

• glyphName(glyphId: number): string

  Return glyph name.

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns string

  The glyph name string.

glyphToJson

• glyphToJson(glyphId: number): SvgPathCommand[]

  Return a glyph as a JSON path string based on format described on https://svgwg.org/specs/paths/#InterfaceSVGPathSegment

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns SvgPathCommand[]

  An array of path segment objects with type and values.

glyphToPath

• glyphToPath(glyphId: number): string

  Return a glyph as an SVG path string.

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns string

  SVG path data string.

glyphVAdvance

• glyphVAdvance(glyphId: number): number

  Return glyph vertical advance.

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns number

  The vertical advance height.

glyphVOrigin

• glyphVOrigin(glyphId: number): [number, number] | undefined

  Return glyph vertical origin.

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns [number, number] | undefined

  [x, y] origin coordinates, or undefined if not available.

hExtents

• hExtents(): FontExtents

  Return font horizontal extents.

  Returns FontExtents

  Object with ascender, descender, and lineGap properties.

nominalGlyph

• nominalGlyph(unicode: number): number | undefined

  Fetches the nominal glyph ID for a Unicode code point in the specified font.

  This version of the function should not be used to fetch glyph IDs for code points modified by variation selectors. For variation-selector support, use Font.variationGlyph or Font.glyph.

  Parameters

  • unicode: number

    The Unicode code point to query.

  Returns number | undefined

  The glyph ID, or undefined if not found.

setFuncs

• setFuncs(fontFuncs: FontFuncs): void

  Set the font's font functions.

  Parameters

  • fontFuncs: FontFuncs

  Returns void

setScale

• setScale(xScale: number, yScale: number): void

  Set the font's scale factor, affecting the position values returned from shaping.

  Parameters

  • xScale: number

    Units to scale in the X dimension.

  • yScale: number

    Units to scale in the Y dimension.

  Returns void

setVariations

• setVariations(variations: Variation[]): void

  Applies a list of font-variation settings to a font.

  Note that this overrides all existing variations set on the font. Axes not included in variations will be effectively set to their default values.

  Parameters

  • variations: Variation[]

    Array of variation settings to apply.

  Returns void

subFont

• subFont(): Font

  Create a sub font that inherits this font's properties.

  Returns Font

  A new Font object representing the sub font.

variationGlyph

• variationGlyph(unicode: number, variationSelector: number): number | undefined

  Fetches the glyph ID for a Unicode code point when followed by by the specified variation-selector code point, in the specified font.

  Parameters

  • unicode: number

    The Unicode code point to query.

  • variationSelector: number

    The variation-selector code point to query.

  Returns number | undefined

  The glyph ID, or undefined if not found.

vExtents

• vExtents(): FontExtents

  Return font vertical extents.

  Returns FontExtents

  Object with ascender, descender, and lineGap properties.