vyaz-monorepo / core/src / ParagraphLayoutEngine
Class: ParagraphLayoutEngine
Defined in: core/src/layout/ParagraphLayoutEngine.ts:181
Constructors
Constructor
new ParagraphLayoutEngine(
cacheMax?):ParagraphLayoutEngine
Defined in: core/src/layout/ParagraphLayoutEngine.ts:186
Parameters
cacheMax?
number = DEFAULT_PREPARED_CACHE_MAX
Returns
ParagraphLayoutEngine
Methods
clearCache()
clearCache():
void
Defined in: core/src/layout/ParagraphLayoutEngine.ts:191
Drop all cached prepared-line data (e.g. on document close).
Returns
void
layout()
layout(
paragraph,maxWidth,yOffset?,fontProvider?,listStyle?,listIndex?,listMarkerWidth?,wantGlyphAdvances?,mode?,onMissingFont?,markMissingGlyphs?,extras?):ParagraphLayoutResult
Defined in: core/src/layout/ParagraphLayoutEngine.ts:203
Layout a single paragraph — basic variant.
Parameters
paragraph
— input paragraph
maxWidth
number
— available container width (px)
yOffset?
number = 0
fontProvider?
— optional metrics provider (default: fontMetricsProvider)
listStyle?
listIndex?
number
listMarkerWidth?
number
wantGlyphAdvances?
boolean = false
mode?
"browser" | "office"
onMissingFont?
OnMissingFont = 'throw'
markMissingGlyphs?
boolean = false
extras?
ParagraphLayoutExtras = {}
Returns
ParagraphLayoutResult with Line[]
layoutGlyph()
layoutGlyph(
paragraph,maxWidth,yOffset?):ParagraphLayoutResult
Defined in: core/src/layout/ParagraphLayoutEngine.ts:434
Layout with per-glyph advance widths filled on every text span (SVG "glyph" preset, caret hit-testing).
Parameters
paragraph
maxWidth
number
yOffset?
number = 0