Class AcApFontUtil

Font helpers for MTEXT and UI (character map, ribbon): wraps the shared FontManager cache, SHX parsing (ShxParserFont), and drawing font catalog (AcApDocManager).

Remarks

Keeps UI packages off direct @mlightcad/mtext-renderer imports while using the same global font pipeline as rendering.

Index

Constructors

constructor

Methods

cacheFont createShxParserFont ensureDrawingFontLoaded findFontInfoByName getCatalogFontType getFontType getLoadedShxFontData getReplacementFontName getShxCodePoints isFontLoaded

Constructors

constructor

new AcApFontUtil(): AcApFontUtil
Returns AcApFontUtil

Methods

`Static`cacheFont

cacheFont(
    data: File | ArrayBuffer,
    fileName?: string,
    aliases?: string[],
    encoding?: string,
): Promise<FontLoadStatus>
Parses a user-uploaded font file, registers it for rendering, and stores it in IndexedDB when font caching is enabled.

Supported formats: .shx, .ttf, .otf, .woff.
Parameters
- data: File | ArrayBuffer
  Font file contents or a browser File selected by the user
- OptionalfileName: string
  Font file name when data is an ArrayBuffer
- Optionalaliases: string[]
  Optional alias names (e.g. missed drawing font names)
- Optionalencoding: string
  Optional character encoding for SHX bigfonts
Returns Promise<FontLoadStatus>
- Defined in packages/cad-simple-viewer/src/util/AcApFontUtil.ts:149

`Static`createShxParserFont

createShxParserFont(data: ShxFontData): ShxParserFont
Creates a SHX parser for inline SVG glyph previews.
Parameters
- data: ShxFontData
  Parsed SHX payload from getLoadedShxFontData.
Returns ShxParserFont
- Defined in packages/cad-simple-viewer/src/util/AcApFontUtil.ts:91

`Static`ensureDrawingFontLoaded

ensureDrawingFontLoaded(fontName: string): Promise<void>
Loads a font through the same pipeline as MTEXT rendering so binaries are cached and SHX glyph tables are available.
Parameters
- fontName: string
Returns Promise<void>
Remarks
No-ops when there is no AcApDocManager.instance or the font is already loaded. Delegates to AcApDocManager.loadFonts.
- Defined in packages/cad-simple-viewer/src/util/AcApFontUtil.ts:131

`Static`findFontInfoByName

findFontInfoByName(fontName: string): FontInfo | undefined
Looks up FontInfo for a display name against the drawing’s available-font catalog (AcApDocManager.instance.avaiableFonts).
Parameters
- fontName: string
Returns FontInfo | undefined
Remarks
Matching is case-insensitive; the first catalog entry whose name array contains a trimmed, case-insensitive match wins.
- Defined in packages/cad-simple-viewer/src/util/AcApFontUtil.ts:103

`Static`getCatalogFontType

getCatalogFontType(fontName: string): "mesh" | "shx" | undefined
Declared font engine kind from the CAD font catalog only (before or after load).
Parameters
- fontName: string
Returns "mesh" | "shx" | undefined
Remarks
Use when AcApFontUtil has not yet loaded the font: the catalog still knows shx vs mesh. After load, getFontType is authoritative.
- Defined in packages/cad-simple-viewer/src/util/AcApFontUtil.ts:119

`Static`getFontType

getFontType(fontName: string): FontType | undefined
Parameters
- fontName: string
Returns FontType | undefined
Inherit Doc: FontManager.getFontType
- Defined in packages/cad-simple-viewer/src/util/AcApFontUtil.ts:40

`Static`getLoadedShxFontData

getLoadedShxFontData(fontName: string): ShxFontData | undefined
Raw SHX font data for UI previews (e.g. character map SVG).
Parameters
- fontName: string
  Name as registered in FontManager.
Returns ShxFontData | undefined
Parsed SHX payload, or undefined if unavailable or not SHX.
- Defined in packages/cad-simple-viewer/src/util/AcApFontUtil.ts:80

`Static`getReplacementFontName

getReplacementFontName(fontName: string): string
Font name used at render time when the requested font is missing.

Checks user FontManager.setFontMapping | font mapping first, then falls back to FontManager.defaultFonts.
Parameters
- fontName: string
  Original font name referenced by the drawing.
Returns string
The loaded font name if available; otherwise the mapped or default replacement.
- Defined in packages/cad-simple-viewer/src/util/AcApFontUtil.ts:53

`Static`getShxCodePoints

getShxCodePoints(fontName: string): number[]
Sorted SHX glyph indices present in the loaded font payload.
Parameters
- fontName: string
  Name as registered in the font manager after load.
Returns number[]
Code list, or empty when the font is missing or not SHX.
- Defined in packages/cad-simple-viewer/src/util/AcApFontUtil.ts:63

`Static`isFontLoaded

isFontLoaded(fontName: string): boolean
Parameters
- fontName: string
Returns boolean
Inherit Doc: FontManager.isFontLoaded
- Defined in packages/cad-simple-viewer/src/util/AcApFontUtil.ts:33

Class AcApFontUtil

Remarks

Index

Constructors

Methods

Constructors

constructor

Returns AcApFontUtil

Methods

StaticcacheFont

Parameters

Returns Promise<FontLoadStatus>

StaticcreateShxParserFont

Parameters

Returns ShxParserFont

StaticensureDrawingFontLoaded

Parameters

Returns Promise<void>

Remarks

StaticfindFontInfoByName

Parameters

Returns FontInfo | undefined

Remarks

StaticgetCatalogFontType

Parameters

Returns "mesh" | "shx" | undefined

Remarks

StaticgetFontType

Parameters

Returns FontType | undefined

Inherit Doc: FontManager.getFontType

StaticgetLoadedShxFontData

Parameters

Returns ShxFontData | undefined

StaticgetReplacementFontName

Parameters

Returns string

StaticgetShxCodePoints

Parameters

Returns number[]

StaticisFontLoaded

Parameters

Returns boolean

Inherit Doc: FontManager.isFontLoaded

Settings

On This Page

`Static`cacheFont

`Static`createShxParserFont

`Static`ensureDrawingFontLoaded

`Static`findFontInfoByName

`Static`getCatalogFontType

`Static`getFontType

`Static`getLoadedShxFontData

`Static`getReplacementFontName

`Static`getShxCodePoints

`Static`isFontLoaded