vyaz-monorepo / core/src / IFontMetricsProvider

Interface: IFontMetricsProvider

Defined in: core/src/types/FontTypes.ts:32

Metrics provider — isomorphic interface

Methods

getMetrics()

getMetrics(fontFamily, fontSize, weight?, style?, mode?): FontMetrics

Defined in: core/src/types/FontTypes.ts:61

Get metrics for a given family and size.

Parameters

fontFamily

string

fontSize

number

weight?

string

style?

string

mode?

"browser" | "office"

Returns

FontMetrics

---

getMode()

getMode(): "browser" | "office"

Defined in: core/src/types/FontTypes.ts:43

Get current mode.

Returns

"browser" | "office"

---

registerFont()

registerFont(family, options, source, sourcePath?): void

Defined in: core/src/types/FontTypes.ts:51

Register a binary font for use with fontkit. In browser — no-op (fonts are registered via CSS @font-face).

Parameters

family

string

options

style?

string

weight?

string

source

any

sourcePath?

string

— path to .ttf/.otf file for optional @napi-rs/canvas.registerFont()

Returns

void

---

setMode()

setMode(mode): void

Defined in: core/src/types/FontTypes.ts:38

Set measurement mode. 'browser' — hhea.ascender/descender (default) 'office' — OS/2.usWinAscent/usWinDescent

Parameters

mode

"browser" | "office"

Returns

void