@pdfa-lab/fontkit / LayoutEngine

Class: LayoutEngine

Defined in: src/layout/layout-engine.ts:12

Constructors

Constructor

new LayoutEngine(font): LayoutEngine

Defined in: src/layout/layout-engine.ts:17

Parameters

Parameter	Type
font	TrueTypeFont

Returns

LayoutEngine

Properties

Property	Modifier	Type	Defined in
engine?	readonly	AATLayoutEngine | OpenTypeLayoutEngine<null>	src/layout/layout-engine.ts:15

Methods

getAvailableFeatures()

getAvailableFeatures(script?, language?): keyof Features[]

Defined in: src/layout/layout-engine.ts:208

Parameters

Parameter	Type
script?	"Caucasian_Albanian" | "Arabic" | "Imperial_Aramaic" | "Armenian" | "Avestan" | "Balinese" | "Bamum" | "Bassa_Vah" | "Batak" | "Bengali" | "Bopomofo" | "Brahmi" | "Braille" | "Buginese" | "Buhid" | "Chakma" | "Canadian_Aboriginal" | "Carian" | "Cham" | "Cherokee" | "Coptic" | "Cypriot" | "Cyrillic" | "Devanagari" | "Deseret" | "Duployan" | "Egyptian_Hieroglyphs" | "Elbasan" | "Ethiopic" | "Georgian" | "Glagolitic" | "Gothic" | "Grantha" | "Greek" | "Gujarati" | "Gurmukhi" | "Hangul" | "Han" | "Hanunoo" | "Hebrew" | "Hiragana" | "Pahawh_Hmong" | "Katakana_Or_Hiragana" | "Old_Italic" | "Javanese" | "Kayah_Li" | "Katakana" | "Kharoshthi" | "Khmer" | "Khojki" | "Kannada" | "Kaithi" | "Tai_Tham" | "Lao" | "Latin" | "Lepcha" | "Limbu" | "Linear_A" | "Linear_B" | "Lisu" | "Lycian" | "Lydian" | "Mahajani" | "Mandaic" | "Manichaean" | "Mende_Kikakui" | "Meroitic_Cursive" | "Meroitic_Hieroglyphs" | "Malayalam" | "Modi" | "Mongolian" | "Mro" | "Meetei_Mayek" | "Myanmar" | "Old_North_Arabian" | "Nabataean" | "Nko" | "Ogham" | "Ol_Chiki" | "Old_Turkic" | "Oriya" | "Osmanya" | "Palmyrene" | "Pau_Cin_Hau" | "Old_Permic" | "Phags_Pa" | "Inscriptional_Pahlavi" | "Psalter_Pahlavi" | "Phoenician" | "Miao" | "Inscriptional_Parthian" | "Rejang" | "Runic" | "Samaritan" | "Old_South_Arabian" | "Saurashtra" | "Shavian" | "Sharada" | "Siddham" | "Khudawadi" | "Sinhala" | "Sora_Sompeng" | "Sundanese" | "Syloti_Nagri" | "Syriac" | "Tagbanwa" | "Takri" | "Tai_Le" | "New_Tai_Lue" | "Tamil" | "Tai_Viet" | "Telugu" | "Tifinagh" | "Tagalog" | "Thaana" | "Thai" | "Tibetan" | "Tirhuta" | "Ugaritic" | "Vai" | "Warang_Citi" | "Old_Persian" | "Cuneiform" | "Yi" | "Inherited" | "Common" | "Unknown"
language?	string

Returns

keyof Features[]

---

layout()

layout(str, features?, script?, language?, direction?): GlyphRun

Defined in: src/layout/layout-engine.ts:31

Parameters

Parameter	Type	Default value
str	string | Glyph[]	undefined
features	Features | keyof Features[]	[]
script?	OpenTypeTag	undefined
language?	string	undefined
direction?	BidiDirection	undefined

Returns

GlyphRun

---

stringsForGlyph()

stringsForGlyph(gid): string[]

Defined in: src/layout/layout-engine.ts:225

Parameters

Parameter	Type
gid	number

Returns

string[]