Skip to content

vyaz-monorepo / core/src / ParagraphLayoutEngine

Class: ParagraphLayoutEngine

Defined in: core/src/layout/ParagraphLayoutEngine.ts:136

Constructors

Constructor

new ParagraphLayoutEngine(cacheMax?): ParagraphLayoutEngine

Defined in: core/src/layout/ParagraphLayoutEngine.ts:141

Parameters

cacheMax?

number = DEFAULT_PREPARED_CACHE_MAX

Returns

ParagraphLayoutEngine

Methods

clearCache()

clearCache(): void

Defined in: core/src/layout/ParagraphLayoutEngine.ts:146

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?): ParagraphLayoutResult

Defined in: core/src/layout/ParagraphLayoutEngine.ts:158

Layout a single paragraph — basic variant.

Parameters

paragraph

Paragraph

— input paragraph

maxWidth

number

— available container width (px)

yOffset?

number = 0

fontProvider?

IFontMetricsProvider

— optional metrics provider (default: fontMetricsProvider)

listStyle?

ListStyle

listIndex?

number

listMarkerWidth?

number

wantGlyphAdvances?

boolean = false

mode?

"browser" | "office"

onMissingFont?

OnMissingFont = 'throw'

markMissingGlyphs?

boolean = false

Returns

ParagraphLayoutResult

ParagraphLayoutResult with Line[]


layoutGlyph()

layoutGlyph(paragraph, maxWidth, yOffset?): ParagraphLayoutResult

Defined in: core/src/layout/ParagraphLayoutEngine.ts:362

Layout with per-glyph advance widths filled on every text span (SVG "glyph" preset, caret hit-testing).

Parameters

paragraph

Paragraph

maxWidth

number

yOffset?

number = 0

Returns

ParagraphLayoutResult

Released under the MIT License.