@pdfa-lab/fontkit / GlyphIterator

Class: GlyphIterator<T>

Defined in: src/open-type/glyph-iterator.ts:16

Type Parameters

Type Parameter
T

Constructors

Constructor

new GlyphIterator<T>(glyphs, options?): GlyphIterator<T>

Defined in: src/open-type/glyph-iterator.ts:22

Parameters

Parameter	Type
glyphs	GlyphInfo<T>[]
options?	GlyphIteratorOptions

Returns

GlyphIterator<T>

Properties

Property	Modifier	Type	Defined in
flags	public	GlyphIteratorFlags	src/open-type/glyph-iterator.ts:18
index	public	number	src/open-type/glyph-iterator.ts:20
options	public	GlyphIteratorOptions	src/open-type/glyph-iterator.ts:17

Accessors

cur

Get Signature

get cur(): GlyphInfo<T> | null

Defined in: src/open-type/glyph-iterator.ts:36

Returns

GlyphInfo<T> | null

Methods

increment()

increment(count?): GlyphInfo<T>

Defined in: src/open-type/glyph-iterator.ts:91

Parameters

Parameter	Type	Default value
count	number	1

Returns

GlyphInfo<T>

---

move()

move(dir): GlyphInfo<T> | null

Defined in: src/open-type/glyph-iterator.ts:51

Parameters

Parameter	Type
dir	-1 | 1

Returns

GlyphInfo<T> | null

---

next()

next(): GlyphInfo<T> | null

Defined in: src/open-type/glyph-iterator.ts:68

Returns

GlyphInfo<T> | null

---

peek()

peek(count?): GlyphInfo<T>

Defined in: src/open-type/glyph-iterator.ts:76

Parameters

Parameter	Type	Default value
count	number	1

Returns

GlyphInfo<T>

---

peekIndex()

peekIndex(count?): number

Defined in: src/open-type/glyph-iterator.ts:83

Parameters

Parameter	Type	Default value
count	number	1

Returns

number

---

prev()

prev(): GlyphInfo<T> | null

Defined in: src/open-type/glyph-iterator.ts:72

Returns

GlyphInfo<T> | null

---

reset()

reset(options?, index?): void

Defined in: src/open-type/glyph-iterator.ts:29

Parameters

Parameter	Type	Default value
options	GlyphIteratorOptions	{}
index	number	0

Returns

void

---

shouldIgnore()

shouldIgnore<T>(glyph): boolean | 0 | undefined

Defined in: src/open-type/glyph-iterator.ts:40

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
glyph	GlyphInfo<T>

Returns

boolean | 0 | undefined