Class: TextPathElement

Hierarchy

• TextElement

  ↳ TextPathElement

Constructors

constructor

• new TextPathElement(document, node, captureTextNodes?)

Parameters

Name	Type
document	Document
node	HTMLElement
captureTextNodes?	boolean

Overrides

TextElement.constructor

Defined in

src/Document/TextPathElement.ts:60

Properties

ignoreChildTypes

▪ Static Readonly ignoreChildTypes: string[]

Inherited from

TextElement.ignoreChildTypes

Defined in

src/Document/Element.ts:11

---

attributes

• Readonly attributes: Record<string, Property<unknown>> = {}

Inherited from

TextElement.attributes

Defined in

src/Document/Element.ts:14

---

styles

• Readonly styles: Record<string, Property<unknown>> = {}

Inherited from

TextElement.styles

Defined in

src/Document/Element.ts:15

---

stylesSpecificity

• Readonly stylesSpecificity: Record<string, string> = {}

Inherited from

TextElement.stylesSpecificity

Defined in

src/Document/Element.ts:16

---

animationFrozen

• animationFrozen: boolean = false

Inherited from

TextElement.animationFrozen

Defined in

src/Document/Element.ts:17

---

animationFrozenValue

• animationFrozenValue: string = ''

Inherited from

TextElement.animationFrozenValue

Defined in

src/Document/Element.ts:18

---

parent

• parent: Element = null

Inherited from

TextElement.parent

Defined in

src/Document/Element.ts:19

---

children

• children: Element[] = []

Inherited from

TextElement.children

Defined in

src/Document/Element.ts:20

---

document

• Protected Readonly document: Document

Inherited from

TextElement.document

Defined in

src/Document/Element.ts:23

---

node

• Protected Optional Readonly node: HTMLElement

Inherited from

TextElement.node

Defined in

src/Document/Element.ts:24

---

captureTextNodes

• Protected Readonly captureTextNodes: boolean = false

Inherited from

TextElement.captureTextNodes

Defined in

src/Document/Element.ts:25

---

x

• Protected x: number = 0

Inherited from

TextElement.x

Defined in

src/Document/TextElement.ts:18

---

y

• Protected y: number = 0

Inherited from

TextElement.y

Defined in

src/Document/TextElement.ts:19

---

type

• type: string = 'textPath'

Overrides

TextElement.type

Defined in

src/Document/TextPathElement.ts:49

---

textWidth

• Protected textWidth: number = 0

Defined in

src/Document/TextPathElement.ts:50

---

textHeight

• Protected textHeight: number = 0

Defined in

src/Document/TextPathElement.ts:51

---

pathLength

• Protected pathLength: number = -1

Defined in

src/Document/TextPathElement.ts:52

---

glyphInfo

• Protected glyphInfo: IGlyphInfo[] = null

Defined in

src/Document/TextPathElement.ts:53

---

text

• Protected Readonly text: string

Defined in

src/Document/TextPathElement.ts:54

---

dataArray

• Protected Readonly dataArray: IPathCommand[]

Defined in

src/Document/TextPathElement.ts:55

---

letterSpacingCache

• Private letterSpacingCache: number[] = []

Defined in

src/Document/TextPathElement.ts:56

---

equidistantCache

• Private equidistantCache: IEquidistantCache

Defined in

src/Document/TextPathElement.ts:57

---

measuresCache

• Private Readonly measuresCache: Map<string, number>

Defined in

src/Document/TextPathElement.ts:58

Methods

getAttribute

▸ getAttribute(name, createIfNotExists?): Property<unknown>

Parameters

Name	Type	Default value
name	string	undefined
createIfNotExists	boolean	false

Returns

Property<unknown>

Inherited from

TextElement.getAttribute

Defined in

src/Document/Element.ts:87

---

getHrefAttribute

▸ getHrefAttribute(): Property<unknown>

Returns

Property<unknown>

Inherited from

TextElement.getHrefAttribute

Defined in

src/Document/Element.ts:101

---

getStyle

▸ getStyle(name, createIfNotExists?, skipAncestors?): Property<unknown>

Parameters

Name	Type	Default value
name	string	undefined
createIfNotExists	boolean	false
skipAncestors	boolean	false

Returns

Property<unknown>

Inherited from

TextElement.getStyle

Defined in

src/Document/Element.ts:114

---

render

▸ render(ctx): void

Parameters

Name	Type
ctx	RenderingContext2D

Returns

void

Inherited from

TextElement.render

Defined in

src/Document/Element.ts:151

---

applyEffects

▸ Protected applyEffects(ctx): void

Parameters

Name	Type
ctx	RenderingContext2D

Returns

void

Inherited from

TextElement.applyEffects

Defined in

src/Document/Element.ts:190

---

addChild

▸ Protected addChild(childNode): void

Parameters

Name	Type
childNode	HTMLElement | Element

Returns

void

Inherited from

TextElement.addChild

Defined in

src/Document/Element.ts:220

---

matchesSelector

▸ Protected matchesSelector(selector): boolean

Parameters

Name	Type
selector	string

Returns

boolean

Inherited from

TextElement.matchesSelector

Defined in

src/Document/Element.ts:232

---

addStylesFromStyleDefinition

▸ addStylesFromStyleDefinition(): void

Returns

void

Inherited from

TextElement.addStylesFromStyleDefinition

Defined in

src/Document/Element.ts:248

---

removeStyles

▸ Protected removeStyles(element, ignoreStyles): [string, string][]

Parameters

Name	Type
element	Element
ignoreStyles	string[]

Returns

[string, string][]

Inherited from

TextElement.removeStyles

Defined in

src/Document/Element.ts:283

---

restoreStyles

▸ Protected restoreStyles(element, styles): void

Parameters

Name	Type
element	Element
styles	[string, string][]

Returns

void

Inherited from

TextElement.restoreStyles

Defined in

src/Document/Element.ts:301

---

isFirstChild

▸ isFirstChild(): boolean

Returns

boolean

Inherited from

TextElement.isFirstChild

Defined in

src/Document/Element.ts:307

---

calculateOpacity

▸ Protected calculateOpacity(): number

Returns

number

Inherited from

TextElement.calculateOpacity

Defined in

src/Document/RenderedElement.ts:13

---

clearContext

▸ clearContext(ctx): void

Parameters

Name	Type
ctx	RenderingContext2D

Returns

void

Inherited from

TextElement.clearContext

Defined in

src/Document/RenderedElement.ts:215

---

setContext

▸ setContext(ctx, fromMeasure?): void

Parameters

Name	Type	Default value
ctx	RenderingContext2D	undefined
fromMeasure	boolean	false

Returns

void

Inherited from

TextElement.setContext

Defined in

src/Document/TextElement.ts:40

---

initializeCoordinates

▸ Protected initializeCoordinates(): void

Returns

void

Inherited from

TextElement.initializeCoordinates

Defined in

src/Document/TextElement.ts:51

---

getBoundingBox

▸ getBoundingBox(ctx): BoundingBox

Parameters

Name	Type
ctx	RenderingContext2D

Returns

BoundingBox

Inherited from

TextElement.getBoundingBox

Defined in

src/Document/TextElement.ts:60

---

getFontSize

▸ Protected getFontSize(): number

Returns

number

Inherited from

TextElement.getFontSize

Defined in

src/Document/TextElement.ts:85

---

getTElementBoundingBox

▸ Protected getTElementBoundingBox(ctx): BoundingBox

Parameters

Name	Type
ctx	RenderingContext2D

Returns

BoundingBox

Inherited from

TextElement.getTElementBoundingBox

Defined in

src/Document/TextElement.ts:96

---

getGlyph

▸ getGlyph(font, text, i): GlyphElement

Parameters

Name	Type
font	FontElement
text	string
i	number

Returns

GlyphElement

Inherited from

TextElement.getGlyph

Defined in

src/Document/TextElement.ts:107

---

getTextFromNode

▸ Protected getTextFromNode(node?): string

Parameters

Name	Type
node?	ChildNode

Returns

string

Inherited from

TextElement.getTextFromNode

Defined in

src/Document/TextElement.ts:149

---

renderTElementChildren

▸ Protected renderTElementChildren(ctx): void

Parameters

Name	Type
ctx	RenderingContext2D

Returns

void

Inherited from

TextElement.renderTElementChildren

Defined in

src/Document/TextElement.ts:198

---

applyAnchoring

▸ Protected applyAnchoring(): void

Returns

void

Inherited from

TextElement.applyAnchoring

Defined in

src/Document/TextElement.ts:277

---

adjustChildCoordinatesRecursive

▸ Protected adjustChildCoordinatesRecursive(ctx): void

Parameters

Name	Type
ctx	RenderingContext2D

Returns

void

Inherited from

TextElement.adjustChildCoordinatesRecursive

Defined in

src/Document/TextElement.ts:309

---

adjustChildCoordinatesRecursiveCore

▸ Protected adjustChildCoordinatesRecursiveCore(ctx, textParent, parent, i): void

Parameters

Name	Type
ctx	RenderingContext2D
textParent	TextElement
parent	Element
i	number

Returns

void

Inherited from

TextElement.adjustChildCoordinatesRecursiveCore

Defined in

src/Document/TextElement.ts:316

---

adjustChildCoordinates

▸ Protected adjustChildCoordinates(ctx, textParent, parent, i): TextElement

Parameters

Name	Type
ctx	RenderingContext2D
textParent	TextElement
parent	Element
i	number

Returns

TextElement

Inherited from

TextElement.adjustChildCoordinates

Defined in

src/Document/TextElement.ts:334

---

getChildBoundingBox

▸ Protected getChildBoundingBox(ctx, textParent, parent, i): BoundingBox

Parameters

Name	Type
ctx	RenderingContext2D
textParent	TextElement
parent	Element
i	number

Returns

BoundingBox

Inherited from

TextElement.getChildBoundingBox

Defined in

src/Document/TextElement.ts:432

---

renderChild

▸ Protected renderChild(ctx, textParent, parent, i): void

Parameters

Name	Type
ctx	RenderingContext2D
textParent	TextElement
parent	Element
i	number

Returns

void

Inherited from

TextElement.renderChild

Defined in

src/Document/TextElement.ts:458

---

measureTargetText

▸ Protected measureTargetText(ctx, targetText): number

Parameters

Name	Type
ctx	RenderingContext2D
targetText	string

Returns

number

Inherited from

TextElement.measureTargetText

Defined in

src/Document/TextElement.ts:487

---

getInheritedAttribute

▸ Protected getInheritedAttribute(name): string

Inherits positional attributes from TextElement parent(s). Attributes are only inherited from a parent to its first child.

Parameters

Name	Type	Description
name	string	The attribute name.

Returns

string

The attribute value or null.

Inherited from

TextElement.getInheritedAttribute

Defined in

src/Document/TextElement.ts:544

---

getText

▸ getText(): string

Returns

string

Overrides

TextElement.getText

Defined in

src/Document/TextPathElement.ts:73

---

path

▸ path(ctx): void

Parameters

Name	Type
ctx	RenderingContext2D

Returns

void

Defined in

src/Document/TextPathElement.ts:77

---

renderChildren

▸ renderChildren(ctx): void

Parameters

Name	Type
ctx	RenderingContext2D

Returns

void

Overrides

TextElement.renderChildren

Defined in

src/Document/TextPathElement.ts:174

---

getLetterSpacingAt

▸ Protected getLetterSpacingAt(idx?): number

Parameters

Name	Type	Default value
idx	number	0

Returns

number

Defined in

src/Document/TextPathElement.ts:240

---

findSegmentToFitChar

▸ Protected findSegmentToFitChar(ctx, anchor, textFullWidth, fullPathWidth, spacesNumber, inputOffset, dy, c, charI): Object

Parameters

Name	Type
ctx	RenderingContext2D
anchor	string
textFullWidth	number
fullPathWidth	number
spacesNumber	number
inputOffset	number
dy	number
c	string
charI	number

Returns

Object

Name	Type
offset	number
segment	{ p0: ICachedPoint ; p1: ICachedPoint }
segment.p0	ICachedPoint
segment.p1	ICachedPoint
rotation	number

Defined in

src/Document/TextPathElement.ts:244

---

measureText

▸ Protected measureText(ctx, text?): number

Parameters

Name	Type
ctx	RenderingContext2D
text?	string

Returns

number

Overrides

TextElement.measureText

Defined in

src/Document/TextPathElement.ts:308

---

setTextData

▸ Protected setTextData(ctx): void

Parameters

Name	Type
ctx	RenderingContext2D

Returns

void

Defined in

src/Document/TextPathElement.ts:329

---

parsePathData

▸ Protected parsePathData(path): IPathCommand[]

Parameters

Name	Type
path	PathElement

Returns

IPathCommand[]

Defined in

src/Document/TextPathElement.ts:455

---

pathM

▸ Protected pathM(pathParser, points): void

Parameters

Name	Type
pathParser	PathParser
points	number[]

Returns

void

Defined in

src/Document/TextPathElement.ts:542

---

pathL

▸ Protected pathL(pathParser, points): 16

Parameters

Name	Type
pathParser	PathParser
points	number[]

Returns

16

Defined in

src/Document/TextPathElement.ts:554

---

pathH

▸ Protected pathH(pathParser, points): 16

Parameters

Name	Type
pathParser	PathParser
points	number[]

Returns

16

Defined in

src/Document/TextPathElement.ts:568

---

pathV

▸ Protected pathV(pathParser, points): 16

Parameters

Name	Type
pathParser	PathParser
points	number[]

Returns

16

Defined in

src/Document/TextPathElement.ts:582

---

pathC

▸ Protected pathC(pathParser, points): void

Parameters

Name	Type
pathParser	PathParser
points	number[]

Returns

void

Defined in

src/Document/TextPathElement.ts:596

---

pathS

▸ Protected pathS(pathParser, points): 32

Parameters

Name	Type
pathParser	PathParser
points	number[]

Returns

32

Defined in

src/Document/TextPathElement.ts:616

---

pathQ

▸ Protected pathQ(pathParser, points): void

Parameters

Name	Type
pathParser	PathParser
points	number[]

Returns

void

Defined in

src/Document/TextPathElement.ts:638

---

pathT

▸ Protected pathT(pathParser, points): 128

Parameters

Name	Type
pathParser	PathParser
points	number[]

Returns

128

Defined in

src/Document/TextPathElement.ts:655

---

pathA

▸ Protected pathA(pathParser): number[]

Parameters

Name	Type
pathParser	PathParser

Returns

number[]

Defined in

src/Document/TextPathElement.ts:674

---

calcLength

▸ Protected calcLength(x, y, commandType, points): number

Parameters

Name	Type
x	number
y	number
commandType	1 | 2 | 4 | 16 | 8 | 128 | 256 | 32 | 64 | 512
points	number[]

Returns

number

Defined in

src/Document/TextPathElement.ts:707

---

getPointOnLine

▸ Protected getPointOnLine(dist, p1x, p1y, p2x, p2y, fromX?, fromY?): IPoint

Parameters

Name	Type	Default value
dist	number	undefined
p1x	number	undefined
p1y	number	undefined
p2x	number	undefined
p2y	number	undefined
fromX	number	p1x
fromY	number	p1y

Returns

IPoint

Defined in

src/Document/TextPathElement.ts:862

---

getPointOnPath

▸ Protected getPointOnPath(distance): IPoint

Parameters

Name	Type
distance	number

Returns

IPoint

Defined in

src/Document/TextPathElement.ts:928

---

getLineLength

▸ Protected getLineLength(x1, y1, x2, y2): number

Parameters

Name	Type
x1	number
y1	number
x2	number
y2	number

Returns

number

Defined in

src/Document/TextPathElement.ts:1047

---

getPathLength

▸ Protected getPathLength(): number

Returns

number

Defined in

src/Document/TextPathElement.ts:1059

---

getPointOnCubicBezier

▸ Protected getPointOnCubicBezier(pct, p1x, p1y, p2x, p2y, p3x, p3y, p4x, p4y): IPoint

Parameters

Name	Type
pct	number
p1x	number
p1y	number
p2x	number
p2y	number
p3x	number
p3y	number
p4x	number
p4y	number

Returns

IPoint

Defined in

src/Document/TextPathElement.ts:1074

---

getPointOnQuadraticBezier

▸ Protected getPointOnQuadraticBezier(pct, p1x, p1y, p2x, p2y, p3x, p3y): IPoint

Parameters

Name	Type
pct	number
p1x	number
p1y	number
p2x	number
p2y	number
p3x	number
p3y	number

Returns

IPoint

Defined in

src/Document/TextPathElement.ts:1094

---

getPointOnEllipticalArc

▸ Protected getPointOnEllipticalArc(cx, cy, rx, ry, theta, psi): IPoint

Parameters

Name	Type
cx	number
cy	number
rx	number
ry	number
theta	number
psi	number

Returns

IPoint

Defined in

src/Document/TextPathElement.ts:1112

---

buildEquidistantCache

▸ Protected buildEquidistantCache(inputStep, inputPrecision): void

Parameters

Name	Type
inputStep	number
inputPrecision	number

Returns

void

Defined in

src/Document/TextPathElement.ts:1134

---

getEquidistantPointOnPath

▸ Protected getEquidistantPointOnPath(targetDistance, step?, precision?): ICachedPoint

Parameters

Name	Type
targetDistance	number
step?	number
precision?	number

Returns

ICachedPoint

Defined in

src/Document/TextPathElement.ts:1178