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

glyphExtents

• glyphExtents(glyphId: number): GlyphExtents | null

  Return glyph extents.

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns GlyphExtents | null

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

glyphFromName

• glyphFromName(name: string): number | null

  Return glyph ID from name.

  Parameters

  • name: string

    Name of the requested glyph in the font.

  Returns number | null

  The glyph ID, or null 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] | null

  Return glyph horizontal origin.

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns [number, number] | null

  [x, y] origin coordinates, or null 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] | null

  Return glyph vertical origin.

  Parameters

  • glyphId: number

    ID of the requested glyph in the font.

  Returns [number, number] | null

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

hExtents

• hExtents(): FontExtents

  Return font horizontal extents.

  Returns FontExtents

  Object with ascender, descender, and lineGap properties.

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: Record<string, number>): void

  Set the font's variations.

  Parameters

  • variations: Record<string, number>

    Dictionary of variations to set.

  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.

vExtents

• vExtents(): FontExtents

  Return font vertical extents.

  Returns FontExtents

  Object with ascender, descender, and lineGap properties.