Class HTMLAdaptor<N, T, D>

Abstract HTMLAdaptor class for manipulating HTML elements (subclass of AbstractDOMAdaptor)

N = HTMLElement node class T = Text node class D = Document class

Type Parameters

N extends MinHTMLElement<N, T>
The HTMLElement node class
T extends MinText<N, T>
The Text node class
D extends MinDocument<N, T>
The Document class

Hierarchy (View Summary)

AbstractDOMAdaptor<N, T, D>
- HTMLAdaptor
  - JsdomAdaptor
  - LinkedomAdaptor

Implements

MinHTMLAdaptor<N, T, D>

Constructors

constructor

new HTMLAdaptor<
    N extends MinHTMLElement<N, T>,
    T extends MinText<N, T>,
    D extends MinDocument<N, T>,
>(
    window: MinWindow<N, D>,
): HTMLAdaptor<N, T, D>
Type Parameters
- N extends MinHTMLElement<N, T>
- T extends MinText<N, T>
- D extends MinDocument<N, T>
Parameters
- window: MinWindow<N, D>
Returns HTMLAdaptor<N, T, D>
Overrides AbstractDOMAdaptor.constructor
- Defined in ts/adaptors/HTMLAdaptor.ts:221

Properties

canMeasureNodes

canMeasureNodes: boolean = true

The HTML adaptor can measure DOM node sizes

document

document: D

The document in which the HTML nodes will be created

parser

parser: MinDOMParser<D>

The DOMParser used to parse a string into a DOM tree

window

window: MinWindow<N, D>

The window object for this adaptor

Methods

addClass

addClass(node: N, name: string): void
Parameters
- node: N
- name: string
Returns void
Implementation of MinHTMLAdaptor.addClass
Overrides AbstractDOMAdaptor.addClass
- Defined in ts/adaptors/HTMLAdaptor.ts:505

allAttributes

allAttributes(node: N): AttributeData[]
Parameters
- node: N
Returns AttributeData[]
Implementation of MinHTMLAdaptor.allAttributes
Overrides AbstractDOMAdaptor.allAttributes
- Defined in ts/adaptors/HTMLAdaptor.ts:496

allClasses

allClasses(node: N): string[]
Parameters
- node: N
Returns string[]
Implementation of MinHTMLAdaptor.allClasses
Inherited from AbstractDOMAdaptor.allClasses
- Defined in ts/core/DOMAdaptor.ts:720

allStyles

allStyles(node: N): any
Parameters
- node: N
Returns any
Implementation of MinHTMLAdaptor.allStyles
Overrides AbstractDOMAdaptor.allStyles
- Defined in ts/adaptors/HTMLAdaptor.ts:554

append

append(node: N, child: N | T): N | T
Parameters
- node: N
- child: N | T
Returns N | T
Implementation of MinHTMLAdaptor.append
Overrides AbstractDOMAdaptor.append
- Defined in ts/adaptors/HTMLAdaptor.ts:336

body

body(doc?: D): N
Parameters
- doc: D = ...
Returns N
Implementation of MinHTMLAdaptor.body
Overrides AbstractDOMAdaptor.body
- Defined in ts/adaptors/HTMLAdaptor.ts:260

childNode

childNode(node: N, i: number): N | T
Parameters
- node: N
- i: number
Returns N | T
Implementation of MinHTMLAdaptor.childNode
Overrides AbstractDOMAdaptor.childNode
- Defined in ts/adaptors/HTMLAdaptor.ts:413

childNodes

childNodes(node: N): (N | T)[]
Parameters
- node: N
Returns (N | T)[]
Implementation of MinHTMLAdaptor.childNodes
Overrides AbstractDOMAdaptor.childNodes
- Defined in ts/adaptors/HTMLAdaptor.ts:406

clone

clone(node: N, deep?: boolean): N
Parameters
- node: N
- deep: boolean = true
Returns N
Implementation of MinHTMLAdaptor.clone
Overrides AbstractDOMAdaptor.clone
- Defined in ts/adaptors/HTMLAdaptor.ts:364

contains

contains(container: N, node: N | T): boolean
Parameters
- container: N
- node: N | T
Returns boolean
Implementation of MinHTMLAdaptor.contains
Overrides AbstractDOMAdaptor.contains
- Defined in ts/adaptors/HTMLAdaptor.ts:322

`Protected`create

create(kind: string, ns?: string): N
Parameters
- kind: string
- Optionalns: string
Returns N
Overrides AbstractDOMAdaptor.create
- Defined in ts/adaptors/HTMLAdaptor.ts:237

createWorker

createWorker(
listener: (event: any) => void,
options: OptionList,
): Promise<Worker>
Parameters
- listener: (event: any) => void
- options: OptionList
Returns Promise<Worker>
Implementation of MinHTMLAdaptor.createWorker
Overrides AbstractDOMAdaptor.createWorker
- Defined in ts/adaptors/HTMLAdaptor.ts:622

cssText

cssText(node: N): string
Parameters
- node: N
Returns string
Implementation of MinHTMLAdaptor.cssText
Overrides AbstractDOMAdaptor.cssText
- Defined in ts/adaptors/HTMLAdaptor.ts:574

doctype

doctype(doc?: D): string
Parameters
- doc: D = ...
Returns string
Implementation of MinHTMLAdaptor.doctype
Overrides AbstractDOMAdaptor.doctype
- Defined in ts/adaptors/HTMLAdaptor.ts:274

firstChild

firstChild(node: N): N | T
Parameters
- node: N
Returns N | T
Implementation of MinHTMLAdaptor.firstChild
Overrides AbstractDOMAdaptor.firstChild
- Defined in ts/adaptors/HTMLAdaptor.ts:392

fontFamily

fontFamily(node: N): any
Parameters
- node: N
Returns any
Implementation of MinHTMLAdaptor.fontFamily
Overrides AbstractDOMAdaptor.fontFamily
- Defined in ts/adaptors/HTMLAdaptor.ts:594

getAttribute

getAttribute(node: N, name: string): string
Parameters
- node: N
- name: string
Returns string
Implementation of MinHTMLAdaptor.getAttribute
Overrides AbstractDOMAdaptor.getAttribute
- Defined in ts/adaptors/HTMLAdaptor.ts:475

getElement

getElement(selector: string, node?: N | D): N
Parameters
- selector: string
- node: N | D = ...
Returns N
Implementation of MinHTMLAdaptor.getElement
Overrides AbstractDOMAdaptor.getElement
- Defined in ts/adaptors/HTMLAdaptor.ts:315

getElements

getElements(nodes: (string | N | N[])[], _document: D): N[]
Parameters
- nodes: (string | N | N[])[]
- _document: D
Returns N[]
Implementation of MinHTMLAdaptor.getElements
Overrides AbstractDOMAdaptor.getElements
- Defined in ts/adaptors/HTMLAdaptor.ts:291

getProperty

getProperty(node: N, name: string): any
Parameters
- node: N
- name: string
Returns any
Implementation of MinHTMLAdaptor.getProperty
Inherited from AbstractDOMAdaptor.getProperty
- Defined in ts/core/DOMAdaptor.ts:498

getStyle

getStyle(node: N, name: string): any
Parameters
- node: N
- name: string
Returns any
Implementation of MinHTMLAdaptor.getStyle
Overrides AbstractDOMAdaptor.getStyle
- Defined in ts/adaptors/HTMLAdaptor.ts:547

hasAttribute

hasAttribute(node: N, name: string): boolean
Parameters
- node: N
- name: string
Returns boolean
Implementation of MinHTMLAdaptor.hasAttribute
Overrides AbstractDOMAdaptor.hasAttribute
- Defined in ts/adaptors/HTMLAdaptor.ts:489

hasClass

hasClass(node: N, name: string): boolean
Parameters
- node: N
- name: string
Returns boolean
Implementation of MinHTMLAdaptor.hasClass
Overrides AbstractDOMAdaptor.hasClass
- Defined in ts/adaptors/HTMLAdaptor.ts:530

head

head(doc?: D): N
Parameters
- doc: D = ...
Returns N
Implementation of MinHTMLAdaptor.head
Overrides AbstractDOMAdaptor.head
- Defined in ts/adaptors/HTMLAdaptor.ts:253

innerHTML

innerHTML(node: N): string
Parameters
- node: N
Returns string
Implementation of MinHTMLAdaptor.innerHTML
Overrides AbstractDOMAdaptor.innerHTML
- Defined in ts/adaptors/HTMLAdaptor.ts:442

insert

insert(nchild: N | T, ochild: N | T): void
Parameters
- nchild: N | T
- ochild: N | T
Returns void
Implementation of MinHTMLAdaptor.insert
Overrides AbstractDOMAdaptor.insert
- Defined in ts/adaptors/HTMLAdaptor.ts:343

insertRules

insertRules(node: N, rules: string[]): void
Parameters
- node: N
- rules: string[]
Returns void
Implementation of MinHTMLAdaptor.insertRules
Overrides AbstractDOMAdaptor.insertRules
- Defined in ts/adaptors/HTMLAdaptor.ts:561

kind

kind(node: N | T): string
Parameters
- node: N | T
Returns string
Implementation of MinHTMLAdaptor.kind
Overrides AbstractDOMAdaptor.kind
- Defined in ts/adaptors/HTMLAdaptor.ts:420

lastChild

lastChild(node: N): N | T
Parameters
- node: N
Returns N | T
Implementation of MinHTMLAdaptor.lastChild
Overrides AbstractDOMAdaptor.lastChild
- Defined in ts/adaptors/HTMLAdaptor.ts:399

next(node: N | T): N | T
Parameters
- node: N | T
Returns N | T
Implementation of MinHTMLAdaptor.next
Overrides AbstractDOMAdaptor.next
- Defined in ts/adaptors/HTMLAdaptor.ts:378

node

node(kind: string, def?: OptionList, children?: (N | T)[], ns?: string): N
Parameters
- kind: string
- def: OptionList = {}
- children: (N | T)[] = []
- Optionalns: string
Returns N
Implementation of MinHTMLAdaptor.node
Inherited from AbstractDOMAdaptor.node
- Defined in ts/core/DOMAdaptor.ts:462

nodeBBox

nodeBBox(node: N): { bottom: number; left: number; right: number; top: number }
Parameters
- node: N
Returns { bottom: number; left: number; right: number; top: number }
Implementation of MinHTMLAdaptor.nodeBBox
Overrides AbstractDOMAdaptor.nodeBBox
- Defined in ts/adaptors/HTMLAdaptor.ts:613

nodeSize

nodeSize(node: N, em?: number, local?: boolean): [number, number]
Parameters
- node: N
- em: number = 1
- local: boolean = false
Returns [number, number]
Implementation of MinHTMLAdaptor.nodeSize
Overrides AbstractDOMAdaptor.nodeSize
- Defined in ts/adaptors/HTMLAdaptor.ts:602

outerHTML

outerHTML(node: N): string
Parameters
- node: N
Returns string
Implementation of MinHTMLAdaptor.outerHTML
Overrides AbstractDOMAdaptor.outerHTML
- Defined in ts/adaptors/HTMLAdaptor.ts:449

parent

parent(node: N | T): N
Parameters
- node: N | T
Returns N
Implementation of MinHTMLAdaptor.parent
Overrides AbstractDOMAdaptor.parent
- Defined in ts/adaptors/HTMLAdaptor.ts:329

parse

parse(text: string, format?: string): D
Parameters
- text: string
- format: string = 'text/html'
Returns D
Implementation of MinHTMLAdaptor.parse
Overrides AbstractDOMAdaptor.parse
- Defined in ts/adaptors/HTMLAdaptor.ts:230

previous(node: N | T): N | T
Parameters
- node: N | T
Returns N | T
Implementation of MinHTMLAdaptor.previous
Overrides AbstractDOMAdaptor.previous
- Defined in ts/adaptors/HTMLAdaptor.ts:385

remove

remove(child: N | T): N | T
Parameters
- child: N | T
Returns N | T
Implementation of MinHTMLAdaptor.remove
Overrides AbstractDOMAdaptor.remove
- Defined in ts/adaptors/HTMLAdaptor.ts:350

removeAttribute

removeAttribute(node: N, name: string): void
Parameters
- node: N
- name: string
Returns void
Implementation of MinHTMLAdaptor.removeAttribute
Overrides AbstractDOMAdaptor.removeAttribute
- Defined in ts/adaptors/HTMLAdaptor.ts:482

removeClass

removeClass(node: N, name: string): void
Parameters
- node: N
- name: string
Returns void
Implementation of MinHTMLAdaptor.removeClass
Overrides AbstractDOMAdaptor.removeClass
- Defined in ts/adaptors/HTMLAdaptor.ts:516

replace

replace(nnode: N | T, onode: N | T): N | T
Parameters
- nnode: N | T
- onode: N | T
Returns N | T
Implementation of MinHTMLAdaptor.replace
Overrides AbstractDOMAdaptor.replace
- Defined in ts/adaptors/HTMLAdaptor.ts:357

root

root(doc?: D): N
Parameters
- doc: D = ...
Returns N
Implementation of MinHTMLAdaptor.root
Overrides AbstractDOMAdaptor.root
- Defined in ts/adaptors/HTMLAdaptor.ts:267

serializeXML

serializeXML(node: N): string
Parameters
- node: N
Returns string
Implementation of MinHTMLAdaptor.serializeXML
Overrides AbstractDOMAdaptor.serializeXML
- Defined in ts/adaptors/HTMLAdaptor.ts:456

setAttribute

setAttribute(node: N, name: string, value: string, ns?: string): void
Parameters
- node: N
- name: string
- value: string
- ns: string = null
Returns void
Implementation of MinHTMLAdaptor.setAttribute
Overrides AbstractDOMAdaptor.setAttribute
- Defined in ts/adaptors/HTMLAdaptor.ts:464

setAttributes

setAttributes(node: N, def: OptionList): void
Parameters
- node: N
  The HTML element whose attributes are to be set
- def: OptionList
  The attributes to set on that node
Returns void
Implementation of MinHTMLAdaptor.setAttributes
Inherited from AbstractDOMAdaptor.setAttributes
- Defined in ts/core/DOMAdaptor.ts:506

setProperty

setProperty(node: N, name: string, value: any): void
Parameters
- node: N
- name: string
- value: any
Returns void
Implementation of MinHTMLAdaptor.setProperty
Inherited from AbstractDOMAdaptor.setProperty
- Defined in ts/core/DOMAdaptor.ts:491

setStyle

setStyle(node: N, name: string, value: string): void
Parameters
- node: N
- name: string
- value: string
Returns void
Implementation of MinHTMLAdaptor.setStyle
Overrides AbstractDOMAdaptor.setStyle
- Defined in ts/adaptors/HTMLAdaptor.ts:540

split

split(node: T, n: number): T
Parameters
- node: T
- n: number
Returns T
Implementation of MinHTMLAdaptor.split
Overrides AbstractDOMAdaptor.split
- Defined in ts/adaptors/HTMLAdaptor.ts:371

text

text(text: string): T
Parameters
- text: string
Returns T
Implementation of MinHTMLAdaptor.text
Overrides AbstractDOMAdaptor.text
- Defined in ts/adaptors/HTMLAdaptor.ts:246

textContent

textContent(node: N): string
Parameters
- node: N
Returns string
Implementation of MinHTMLAdaptor.textContent
Overrides AbstractDOMAdaptor.textContent
- Defined in ts/adaptors/HTMLAdaptor.ts:435

value

value(node: N | T): string
Parameters
- node: N | T
Returns string
Implementation of MinHTMLAdaptor.value
Overrides AbstractDOMAdaptor.value
- Defined in ts/adaptors/HTMLAdaptor.ts:428

Class HTMLAdaptor<N, T, D>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HTMLAdaptor<N, T, D>

Properties

canMeasureNodes

document

parser

window

Methods

addClass

Parameters

Returns void

allAttributes

Parameters

Returns AttributeData[]

allClasses

Parameters

Returns string[]

allStyles

Parameters

Returns any

append

Parameters

Returns N | T

body

Parameters

Returns N

childNode

Parameters

Returns N | T

childNodes

Parameters

Returns (N | T)[]

clone

Parameters

Returns N

contains

Parameters

Returns boolean

Protectedcreate

Parameters

Returns N

createWorker

Parameters

Returns Promise<Worker>

cssText

Parameters

Returns string

doctype

Parameters

Returns string

firstChild

Parameters

Returns N | T

fontFamily

Parameters

Returns any

fontSize

Parameters

Returns number

getAttribute

Parameters

Returns string

getElement

Parameters

Returns N

getElements

Parameters

Returns N[]

getProperty

`Protected`create