Class TextFormatter

Static DEBUG

fontSizeInPixels

• get fontSizeInPixels(): number

• this.size is specified in points. Convert to pixels.

  Returns number

localHeightCache

• get localHeightCache(): Record<string, undefined | yExtent>

• Returns Record<string, undefined | yExtent>

maxHeight

• get maxHeight(): number

• Returns number

getGlyphMetrics

• getGlyphMetrics(character): FontGlyph

• The glyphs table is indexed by the character (e.g., 'C', '@'). See: robotoslab_glyphs.ts & petalumascript_glyphs.ts.

  Parameters

  • character: string

  Returns FontGlyph

getResolution

• getResolution(): number

• Returns number

getWidthForCharacterInEm

• getWidthForCharacterInEm(c): number

• Retrieve the character's advanceWidth as a fraction of an em unit. For the space character ' ' as defined in the: petalumascript_glyphs.ts: 250 advanceWidth in the 1000 unitsPerEm font returns 0.25. robotoslab_glyphs.ts: 509 advanceWidth in the 2048 unitsPerEm font returns 0.2485.

  Parameters

  • c: string

  Returns number

getWidthForTextInEm

• getWidthForTextInEm(text): number

• Retrieve the total width of text in em units.

  Parameters

  • text: string

  Returns number

getWidthForTextInPx

• getWidthForTextInPx(text): number

• The width of the text (in em) is scaled by the font size (in px).

  Parameters

  • text: string

  Returns number

getYForCharacterInPx

• getYForCharacterInPx(c): yExtent

• Retrieve the character's y bounds (ymin, ymax) and height.

  Parameters

  • c: string

  Returns yExtent

getYForStringInPx

• getYForStringInPx(str): yExtent

• Parameters

  • str: string

  Returns yExtent

setFontSize

• setFontSize(size): TextFormatter

• Parameters

  • size: number

    in pt.

  Returns TextFormatter

updateCacheKey

• updateCacheKey(): void

• Create a hash with the current font data, so we can cache computed widths.

  Returns void

updateParams

• updateParams(params): void

• Parameters

  • params: TextFormatterInfo

  Returns void

Static create

• create(requestedFont?): TextFormatter

• Call TextFormatter.registerInfo(info) to register font information before using this method.

  This method creates a formatter for the font that most closely matches the requested font. We compare font family, bold, and italic attributes. This method will return a fallback formatter if there are no matches.

  Parameters

  • requestedFont: FontInfo = {}

  Returns TextFormatter

Static getFontFamilies

• getFontFamilies(): TextFormatterInfo[]

• Return all registered font families.

  Returns TextFormatterInfo[]

Static getInfo

• getInfo(fontFamily): undefined | TextFormatterInfo
• Parameters

  • fontFamily: string

    used as a key to the font registry.

  Returns undefined | TextFormatterInfo

  the same info object that was passed in via TextFormatter.registerInfo(info)

Static registerInfo

• registerInfo(info, overwrite?): void

• Apps may register their own fonts and metrics, and those metrics will be available to the app for formatting.

  Metrics can be generated from a font file using fontgen_text.js in the tools/fonts directory.

  Parameters

  • info: TextFormatterInfo

  • overwrite: boolean = false

  Returns void