Class: TRefElement

Hierarchy

• TextElement

  ↳ TRefElement

Constructors

constructor

• new TRefElement(document, node, captureTextNodes?)

Parameters

Name	Type
document	Document
node	HTMLElement
captureTextNodes?	boolean

Inherited from

TextElement.constructor

Defined in

src/Document/TextElement.ts:26

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

---

type

• type: string = 'tref'

Overrides

TextElement.type

Defined in

src/Document/TRefElement.ts:4

---

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

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

---

getText

▸ getText(): string

Returns

string

Overrides

TextElement.getText

Defined in

src/Document/TRefElement.ts:6

---

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

---

renderChildren

▸ renderChildren(ctx): void

Parameters

Name	Type
ctx	RenderingContext2D

Returns

void

Inherited from

TextElement.renderChildren

Defined in

src/Document/TextElement.ts:172

---

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

---

measureText

▸ Protected measureText(ctx): number

Parameters

Name	Type
ctx	RenderingContext2D

Returns

number

Inherited from

TextElement.measureText

Defined in

src/Document/TextElement.ts:472

---

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