Interface DOMAdaptor<N, T, D>

The interface for the DOMAdaptor

interface DOMAdaptor<N, T, D> {
    canMeasureNodes: boolean;
    document: D;
    addClass(node: N, name: string): void;
    allAttributes(node: N): AttributeData[];
    allClasses(node: N): string[];
    allStyles(node: N): string;
    append(node: N, child: N | T): N | T;
    body(doc?: D): N;
    childNode(node: N, i: number): N | T;
    childNodes(node: N): (N | T)[];
    clone(node: N, deep?: boolean): N;
    contains(container: N, node: N | T): boolean;
    createWorker(
        listener: (event: any) => void,
        options: OptionList,
    ): Promise<minWorker>;
    cssText(node: N): string;
    doctype(doc?: D): string;
    firstChild(node: N): N | T;
    fontFamily(node: N): string;
    fontSize(node: N): number;
    getAttribute(node: N, name: string): string;
    getElement(selector: string, node?: N | D): N;
    getElements(nodes: (string | N | N[])[], document: D): N[];
    getProperty(node: N, name: string): any;
    getStyle(node: N, name: string): string;
    hasAttribute(node: N, name: string): boolean;
    hasClass(node: N, name: string): boolean;
    head(doc?: D): N;
    innerHTML(node: N): string;
    insert(nchild: N | T, ochild: N | T): void;
    insertRules(node: N, rules: string[]): void;
    kind(node: N | T): string;
    lastChild(node: N): N | T;
    next(node: N | T): N | T;
    node(kind: string, def?: OptionList, children?: (N | T)[], ns?: string): N;
    nodeBBox(node: N): PageBBox;
    nodeSize(node: N, em?: number, local?: boolean): [number, number];
    outerHTML(node: N): string;
    parent(node: N | T): N;
    parse(text: string, format?: string): D;
    previous(node: N | T): N | T;
    remove(child: N | T): N | T;
    removeAttribute(node: N, name: string): void;
    removeClass(node: N, name: string): void;
    replace(nnode: N | T, onode: N | T): N | T;
    root(doc?: D): N;
    serializeXML(node: N): string;
    setAttribute(
        node: N,
        name: string,
        value: string | number,
        ns?: string,
    ): void;
    setAttributes(node: N, def: OptionList): void;
    setProperty(node: N, name: string, value: any): void;
    setStyle(node: N, name: string, value: string): void;
    split(node: T, n: number): T;
    tags(node: N, name: string, ns?: string): N[];
    text(text: string): T;
    textContent(node: N): string;
    value(node: N | T): string;
}

Type Parameters

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

Hierarchy (View Summary)

DOMAdaptor
- MinHTMLAdaptor

Implemented by

AbstractDOMAdaptor

Properties

canMeasureNodes

canMeasureNodes: boolean

True when the adaptor can measure DOM node sizes

document

document: D

Document in which the nodes are to be created

Methods

addClass

addClass(node: N, name: string): void
Parameters
- node: N
  The HTML node whose class is to be augmented
- name: string
  The class to be added
Returns void
- Defined in ts/core/DOMAdaptor.ts:335

allAttributes

allAttributes(node: N): AttributeData[]
Parameters
- node: N
  The HTML node whose attributes are to be returned
Returns AttributeData[]
The list of attributes
- Defined in ts/core/DOMAdaptor.ts:329

allClasses

allClasses(node: N): string[]
Parameters
- node: N
  The HTML node whose class list is needed
Returns string[]
An array of the class names for this node
- Defined in ts/core/DOMAdaptor.ts:354

allStyles

allStyles(node: N): string
Parameters
- node: N
  The HTML node whose styles are to be returned
Returns string
The cssText for the styles
- Defined in ts/core/DOMAdaptor.ts:374

append

append(node: N, child: N | T): N | T
Parameters
- node: N
  The HTML node to be appended to
- child: N | T
  The node or text to be appended
Returns N | T
The appended node
- Defined in ts/core/DOMAdaptor.ts:165

body

body(doc?: D): N
Parameters
- Optionaldoc: D
  The document whose body is to be obtained
Returns N
The document.body element
- Defined in ts/core/DOMAdaptor.ts:104

childNode

childNode(node: N, i: number): N | T
Parameters
- node: N
  The HTML node whose child is to be obtained
- i: number
  The index of the child to return
Returns N | T
The i-th child node of the given node (or null)
- Defined in ts/core/DOMAdaptor.ts:234

childNodes

childNodes(node: N): (N | T)[]
Parameters
- node: N
  The HTML node whose children are to be obtained
Returns (N | T)[]
Array of children for the given node (not a live list)
- Defined in ts/core/DOMAdaptor.ts:227

clone

clone(node: N, deep?: boolean): N
Parameters
- node: N
  The HTML node to be cloned
- Optionaldeep: boolean
  True if children should be cloned
Returns N
The copied node
- Defined in ts/core/DOMAdaptor.ts:191

contains

contains(container: N, node: N | T): boolean
Determine if a container node contains a given node somewhere in its DOM tree
Parameters
- container: N
  The container to search
- node: N | T
  The node to look for
Returns boolean
True if the node is in the container's DOM tree
- Defined in ts/core/DOMAdaptor.ts:152

createWorker

createWorker(
listener: (event: any) => void,
options: OptionList,
): Promise<minWorker>
Parameters
- listener: (event: any) => void
  The event listener for messages from the worker
- options: OptionList
  The worker options (for path and worker name)
Returns Promise<minWorker>
A promise for the worker instance that was created
- Defined in ts/core/DOMAdaptor.ts:419

cssText

cssText(node: N): string
Parameters
- node: N
  The stylesheet node whose rules are to be returned
Returns string
The string version of the stylesheet rules
- Defined in ts/core/DOMAdaptor.ts:386

doctype

doctype(doc?: D): string
Parameters
- Optionaldoc: D
  The document whose doctype is to be obtained
Returns string
The DOCTYPE comment
- Defined in ts/core/DOMAdaptor.ts:116

firstChild

firstChild(node: N): N | T
Parameters
- node: N
  The HTML node whose child is to be obtained
Returns N | T
The first child of the given node (or null)
- Defined in ts/core/DOMAdaptor.ts:215

fontFamily

fontFamily(node: N): string
Parameters
- node: N
  The HTML node whose font family is to be determined
Returns string
The font family
- Defined in ts/core/DOMAdaptor.ts:398

getAttribute

getAttribute(node: N, name: string): string
Parameters
- node: N
  The HTML node whose attribute is to be obtained
- name: string
  The name of the attribute to get
Returns string
The value of the given attribute of the given node
- Defined in ts/core/DOMAdaptor.ts:310

getElement

getElement(selector: string, node?: N | D): N
Get an element specified by CSS selector.
Parameters
- selector: string
  The selector to locate
- Optionalnode: N | D
  The document or element in which to search
Returns N
The first matching element
- Defined in ts/core/DOMAdaptor.ts:143

getElements

getElements(nodes: (string | N | N[])[], document: D): N[]
Get a list of containers (to be searched for math). These can be specified by CSS selector, or as actual DOM elements or arrays of such.
Parameters
- nodes: (string | N | N[])[]
  The array of items to make into a container list
- document: D
  The document in which to search
Returns N[]
The array of containers to search
- Defined in ts/core/DOMAdaptor.ts:134

getProperty

getProperty(node: N, name: string): any
Parameters
- node: N
  The HTML node whose property is to be retrieved
- name: string
  The property to get
Returns any
The property's value
- Defined in ts/core/DOMAdaptor.ts:284

getStyle

getStyle(node: N, name: string): string
Parameters
- node: N
  The HTML node whose style is to be obtained
- name: string
  The style to be obtained
Returns string
The value of the style
- Defined in ts/core/DOMAdaptor.ts:368

hasAttribute

hasAttribute(node: N, name: string): boolean
Parameters
- node: N
  The HTML node whose attribute is to be tested
- name: string
  The name of the attribute to test
Returns boolean
True of the node has the given attribute defined
- Defined in ts/core/DOMAdaptor.ts:323

hasClass

hasClass(node: N, name: string): boolean
Parameters
- node: N
  The HTML node whose class is to be tested
- name: string
  The class to test
Returns boolean
True if the node has the given class
- Defined in ts/core/DOMAdaptor.ts:348

head

head(doc?: D): N
Parameters
- Optionaldoc: D
  The document whose head is to be obtained
Returns N
The document.head element
- Defined in ts/core/DOMAdaptor.ts:98

innerHTML

innerHTML(node: N): string
Parameters
- node: N
  The HTML node whose inner HTML string is to be obtained
Returns string
The serialized content of the node
- Defined in ts/core/DOMAdaptor.ts:258

insert

insert(nchild: N | T, ochild: N | T): void
Parameters
- nchild: N | T
  The node or text to be inserted
- ochild: N | T
  The node or text where the new child is to be added before it
Returns void
- Defined in ts/core/DOMAdaptor.ts:171

insertRules

insertRules(node: N, rules: string[]): void
Parameters
- node: N
  The stylesheet node where the rule will be added
- rules: string[]
  The rule to add at the beginning of the stylesheet
Returns void
- Defined in ts/core/DOMAdaptor.ts:380

kind

kind(node: N | T): string
Parameters
- node: N | T
  The HTML node whose tag or node name is to be obtained
Returns string
The tag or node name of the given node
- Defined in ts/core/DOMAdaptor.ts:240

lastChild

lastChild(node: N): N | T
Parameters
- node: N
  The HTML node whose child is to be obtained
Returns N | T
The last child of the given node (or null)
- Defined in ts/core/DOMAdaptor.ts:221

next(node: N | T): N | T
Parameters
- node: N | T
  The HTML node whose sibling is to be obtained
Returns N | T
The node following the given one (or null)
- Defined in ts/core/DOMAdaptor.ts:203

node

node(kind: string, def?: OptionList, children?: (N | T)[], ns?: string): N
Parameters
- kind: string
  The tag name of the HTML node to be created
- Optionaldef: OptionList
  The properties to set for the created node
- Optionalchildren: (N | T)[]
  The child nodes for the created HTML node
- Optionalns: string
  The namespace in which to create the node
Returns N
The generated HTML tree
- Defined in ts/core/DOMAdaptor.ts:86

nodeBBox

nodeBBox(node: N): PageBBox
Parameters
- node: N
  The HTML node whose BBox is to be determined
Returns PageBBox
BBox as {left, right, top, bottom} position on the page (in pixels)
- Defined in ts/core/DOMAdaptor.ts:412

nodeSize

nodeSize(node: N, em?: number, local?: boolean): [number, number]
Parameters
- node: N
  The HTML node whose dimensions are to be determined
- Optionalem: number
  The number of pixels in an em
- Optionallocal: boolean
  True if local coordinates are to be used in SVG elements
Returns [number, number]
The width and height (in ems) of the element
- Defined in ts/core/DOMAdaptor.ts:406

outerHTML

outerHTML(node: N): string
Parameters
- node: N
  The HTML node whose outer HTML string is to be obtained
Returns string
The serialized node and its content
- Defined in ts/core/DOMAdaptor.ts:264

parent

parent(node: N | T): N
Parameters
- node: N | T
  The HTML node whose parent is to be obtained
Returns N
The parent node of the given one
- Defined in ts/core/DOMAdaptor.ts:158

parse

parse(text: string, format?: string): D
Parameters
- text: string
  The serialized document to be parsed
- Optionalformat: string
  The format (e.g., 'text/html' or 'text/xhtml')
Returns D
The parsed document
- Defined in ts/core/DOMAdaptor.ts:77

previous(node: N | T): N | T
Parameters
- node: N | T
  The HTML node whose sibling is to be obtained
Returns N | T
The node preceding the given one (or null)
- Defined in ts/core/DOMAdaptor.ts:209

remove

remove(child: N | T): N | T
Parameters
- child: N | T
  The node or text to be removed from its parent
Returns N | T
The removed node
- Defined in ts/core/DOMAdaptor.ts:177

removeAttribute

removeAttribute(node: N, name: string): void
Parameters
- node: N
  The HTML node whose attribute is to be removed
- name: string
  The name of the attribute to remove
Returns void
- Defined in ts/core/DOMAdaptor.ts:316

removeClass

removeClass(node: N, name: string): void
Parameters
- node: N
  The HTML node whose class is to be changed
- name: string
  The class to be removed
Returns void
- Defined in ts/core/DOMAdaptor.ts:341

replace

replace(nnode: N | T, onode: N | T): N | T
Parameters
- nnode: N | T
  The node to replace with
- onode: N | T
  The child to be replaced
Returns N | T
The removed node
- Defined in ts/core/DOMAdaptor.ts:184

root

root(doc?: D): N
Parameters
- Optionaldoc: D
  The document whose documentElement is to be obtained
Returns N
The documentElement
- Defined in ts/core/DOMAdaptor.ts:110

serializeXML

serializeXML(node: N): string
Parameters
- node: N
  The HTML node whose serialized string is to be obtained
Returns string
The serialized node and its content
- Defined in ts/core/DOMAdaptor.ts:270

setAttribute

setAttribute(node: N, name: string, value: string | number, ns?: string): void
Parameters
- node: N
  The HTML node whose attribute is to be set
- name: string
  The name of the attribute to set
- value: string | number
  The new value of the attribute
- Optionalns: string
  The namespace to use for the attribute
Returns void
- Defined in ts/core/DOMAdaptor.ts:292

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
- Defined in ts/core/DOMAdaptor.ts:303

setProperty

setProperty(node: N, name: string, value: any): void
Parameters
- node: N
  The HTML node whose property is to be set
- name: string
  The property to set
- value: any
  The property's new value
Returns void
- Defined in ts/core/DOMAdaptor.ts:277

setStyle

setStyle(node: N, name: string, value: string): void
Parameters
- node: N
  The HTML node whose style is to be changed
- name: string
  The style to be set
- value: string
  The new value of the style
Returns void
- Defined in ts/core/DOMAdaptor.ts:361

split

split(node: T, n: number): T
Parameters
- node: T
  The HTML text node to be split
- n: number
  The index of the character where the split will occur
Returns T
- Defined in ts/core/DOMAdaptor.ts:197

text

text(text: string): T
Parameters
- text: string
  The text from which to create an HTML text node
Returns T
The generated text node with the given text
- Defined in ts/core/DOMAdaptor.ts:92

textContent

textContent(node: N): string
Parameters
- node: N
  The HTML node whose text content is to be obtained
Returns string
The text content of the given node
- Defined in ts/core/DOMAdaptor.ts:252

value

value(node: N | T): string
Parameters
- node: N | T
  The HTML node whose value is to be obtained
Returns string
The value of the given node
- Defined in ts/core/DOMAdaptor.ts:246

Interface DOMAdaptor<N, T, D>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

canMeasureNodes

document

Methods

addClass

Parameters

Returns void

allAttributes

Parameters

Returns AttributeData[]

allClasses

Parameters

Returns string[]

allStyles

Parameters

Returns string

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

createWorker

Parameters

Returns Promise<minWorker>

cssText

Parameters

Returns string

doctype

Parameters

Returns string

firstChild

Parameters

Returns N | T

fontFamily

Parameters

Returns string

fontSize

Parameters

Returns number

getAttribute

Parameters

Returns string

getElement

Parameters

Returns N

getElements

Parameters

Returns N[]

getProperty

Parameters

Returns any

getStyle

Parameters

Returns string

hasAttribute

Parameters

Returns boolean

hasClass

Parameters

Returns boolean