Class Face

constructor

• new Face(blob: Blob, index?: number): Face

  Parameters

  • blob: Blob

    A Blob containing font data.

  • Optionalindex: number

    The index of the font in the blob. (0 for most files, or a 0-indexed font number if the blob came from a font collection file.)

  Returns Face

• new Face(existingPtr: number): Face
  Internal

  Wrap an existing face pointer.

  Parameters

  • existingPtr: number

  Returns Face

Readonlyptr

Readonlyupem

collectUnicodes

• collectUnicodes(): Uint32Array

  Return unicodes the face supports.

  Returns Uint32Array

  A Uint32Array of supported Unicode code points.

getAxisInfos

• getAxisInfos(): Record<string, AxisInfo>

  Return variation axis infos.

  Returns Record<string, AxisInfo>

  A dictionary mapping axis tags to {min, default, max} values.

getColorPalettes

• getColorPalettes(): ColorPalette[]

  Fetches the color palettes in the face's CPAL table.

  Returns ColorPalette[]

  An array of the face's color palettes.

getFeatureLookups

• getFeatureLookups(table: "GSUB" | "GPOS", featureIndex: number): number[]

  Fetches a list of all lookups enumerated for the specified feature, in the specified face's GSUB table or GPOS table.

  Parameters

  • table: "GSUB" | "GPOS"

    The table to query, either "GSUB" or "GPOS".

  • featureIndex: number

    The index of the requested feature.

  Returns number[]

  An array of lookup indexes.

getFeatureNameIds

• getFeatureNameIds(
      table: "GSUB" | "GPOS",
      featureIndex: number,
  ): FeatureNameIds | undefined

  Get the name IDs of the specified feature.

  Parameters

  • table: "GSUB" | "GPOS"

    The table to query, either "GSUB" or "GPOS".

  • featureIndex: number

    The index of the feature to query.

  Returns FeatureNameIds | undefined

  An object with name IDs, or undefined if not found.

getGlyphClass

• getGlyphClass(glyph: number): GlyphClass

  Get the GDEF class of the requested glyph.

  Parameters

  • glyph: number

    The glyph to get the class of.

  Returns GlyphClass

  The GlyphClass of the glyph.

getGlyphColorLayers

• getGlyphColorLayers(glyph: number): ColorLayer[]

  Fetches a list of all color layers for the specified glyph index in the specified face.

  Parameters

  • glyph: number

    The glyph index to query.

  Returns ColorLayer[]

  An array of the glyph's color layers.

getLanguageFeatureTags

• getLanguageFeatureTags(
      table: "GSUB" | "GPOS",
      scriptIndex: number,
      languageIndex: number,
  ): string[]

  Return all features in the specified face's GSUB table or GPOS table, underneath the specified script and language.

  Parameters

  • table: "GSUB" | "GPOS"

    The table to query, either "GSUB" or "GPOS".

  • scriptIndex: number

    The index of the script to query.

  • languageIndex: number

    The index of the language to query.

  Returns string[]

  An array of 4-character feature tag strings.

getName

• getName(nameId: number, language: string): string

  Get the name of the specified face.

  Parameters

  • nameId: number

    The ID of the name to get.

  • language: string

    The language of the name to get.

  Returns string

  The name string.

getScriptLanguageTags

• getScriptLanguageTags(table: "GSUB" | "GPOS", scriptIndex: number): string[]

  Return language tags in the given face's GSUB or GPOS table, underneath the specified script index.

  Parameters

  • table: "GSUB" | "GPOS"

    The table to query, either "GSUB" or "GPOS".

  • scriptIndex: number

    The index of the script to query.

  Returns string[]

  An array of 4-character language tag strings.

getTableFeatureTags

• getTableFeatureTags(table: "GSUB" | "GPOS"): string[]

  Return all features enumerated in the specified face's GSUB table or GPOS table.

  Parameters

  • table: "GSUB" | "GPOS"

    The table to query, either "GSUB" or "GPOS".

  Returns string[]

  An array of 4-character feature tag strings.

getTableScriptTags

• getTableScriptTags(table: "GSUB" | "GPOS"): string[]

  Return all scripts enumerated in the specified face's GSUB table or GPOS table.

  Parameters

  • table: "GSUB" | "GPOS"

    The table to query, either "GSUB" or "GPOS".

  Returns string[]

  An array of 4-character script tag strings.

glyphHasColorPaint

• glyphHasColorPaint(glyph: number): boolean

  Tests whether a face includes COLRv1 paint data for a glyph.

  Parameters

  • glyph: number

    The glyph index to query.

  Returns boolean

  true if data found, false otherwise.

hasColorLayers

• hasColorLayers(): boolean

  Tests whether a face includes a COLR table with data according to COLRv0.

  Returns boolean

  true if data found, false otherwise.

hasColorPaint

• hasColorPaint(): boolean

  Tests whether a face includes a COLR table with data according to COLRv1.

  Returns boolean

  true if data found, false otherwise.

hasColorPalettes

• hasColorPalettes(): boolean

  Tests whether a face includes a CPAL color-palette table.

  Returns boolean

  true if data found, false otherwise.

hasColorPng

• hasColorPng(): boolean

  Tests whether a face has PNG glyph images (either in CBDT or sbix tables).

  Returns boolean

  true if data found, false otherwise.

listNames

• listNames(): NameEntry[]

  Return all names in the specified face's name table.

  Returns NameEntry[]

  An array of {nameId, language} entries.

referenceTable

• referenceTable(table: string): Uint8Array<ArrayBufferLike> | undefined

  Return the binary contents of an OpenType table.

  Parameters

  • table: string

    Table name

  Returns Uint8Array<ArrayBufferLike> | undefined

  A Uint8Array of the table data, or undefined if the table is not found.