Class XmlTreeNode`Abstract`

The base class representing a node that can have siblings.

Hierarchy (View Summary)

XmlNode
- XmlTreeNode

Index

Properties

canonicalize

canonicalize: (
handler: XmlOutputBufferHandler,
options?: SubtreeC14NOptions,
) => void

Canonicalize this node and its subtree to a buffer and invoke the handler to process.

Type Declaration

- (handler: XmlOutputBufferHandler, options?: SubtreeC14NOptions): void
- Parameters
  - handler: XmlOutputBufferHandler
    handlers to process the content in the buffer
  - Optionaloptions: SubtreeC14NOptions
    options to adjust the canonicalization behavior
  Returns void

See

canonicalizeToString

canonicalizeToString: (options?: SubtreeC14NOptions) => string

Canonicalize this node and its subtree and return the result as a string.

Type Declaration

- (options?: SubtreeC14NOptions): string
- Parameters
  - Optionaloptions: SubtreeC14NOptions
    options to adjust the canonicalization behavior
  Returns string
  The canonicalized XML string.

See

canonicalize

Accessors

content

get content(): string
The content string of the node.

Returns string
Inherited from XmlNode.content
- Defined in src/nodes.mts:193

doc

get doc(): XmlDocument
The XmlDocument containing this node.

Returns XmlDocument
Inherited from XmlNode.doc
- Defined in src/document.mts:576

line

get line(): number
The line number of the node if the node is parsed from an XML document.

Returns number
Inherited from XmlNode.line
- Defined in src/nodes.mts:200

get next(): XmlTreeNode | null
The node that represents the next sibling.

Returns XmlTreeNode | null
null if this node is the last one.
See
- Defined in src/nodes.mts:506

parent

get parent(): XmlElement | null
The parent node of this node.

For root node, its parent is null.

Returns XmlElement | null
Inherited from XmlNode.parent
- Defined in src/nodes.mts:182

get prev(): XmlTreeNode | null
The node that represents the previous sibling.

Returns XmlTreeNode | null
null if this node is the first one.
See
- Defined in src/nodes.mts:521

Methods

appendCData

appendCData(content: string): XmlCData
Add a CDATA section sibling node after this node.
Parameters
- content: string
  the content of the CDATA section
Returns XmlCData
See
- prependCData
- addCData
- Defined in src/nodes.mts:407

appendComment

appendComment(content: string): XmlComment
Add a comment sibling node after this node.
Parameters
- content: string
  the content of the comment
Returns XmlComment
See
- prependComment
- addComment
- Defined in src/nodes.mts:385

appendElement

appendElement(name: string, prefix?: string): XmlElement
Add an element sibling node after this node.
Parameters
- name: string
  the element name
- Optionalprefix: string
  the prefix of the element for the namespace
Returns XmlElement
See
- prependElement
- addElement
- Defined in src/nodes.mts:430

appendEntityReference

appendEntityReference(name: string): XmlEntityReference
Add an entity reference sibling node after this node.
Parameters
- name: string
  the name of the entity reference
Returns XmlEntityReference
See
- prependEntityReference
- addEntityReference
- Defined in src/nodes.mts:478

appendText

appendText(text: string): XmlText
Add a text sibling node after this node.
Parameters
- text: string
  the content of the text node
Returns XmlText
See
- prependText
- addText
- Defined in src/nodes.mts:457

eval

eval(xpath: XmlXPath): string | number | boolean | XmlNode[]
Evaluate the given XPath selector on this node.
Parameters
- xpath: XmlXPath
  XPath selector
Returns string | number | boolean | XmlNode[]
See
Inherited from XmlNode.eval
- Defined in src/nodes.mts:290
eval(
xpath: string,
namespaces?: NamespaceMap,
): string | number | boolean | XmlNode[]
Evaluate the given XPath selector on this node.
Parameters
- xpath: string
  XPath selector
- Optionalnamespaces: NamespaceMap
Returns string | number | boolean | XmlNode[]
See
- get
- find
Inherited from XmlNode.eval
- Defined in src/nodes.mts:298

find

find(xpath: XmlXPath): XmlNode[]
Find all the descendant nodes matching the given compiled xpath selector.
Parameters
- xpath: XmlXPath
  XPath selector
Returns XmlNode[]
An empty array if no nodes are found.
See
Inherited from XmlNode.find
- Defined in src/nodes.mts:261
find(xpath: string, namespaces?: NamespaceMap): XmlNode[]
Find all the descendant nodes matching the given xpath selector.
Parameters
- xpath: string
  XPath selector
- Optionalnamespaces: NamespaceMap
  mapping between prefix and the namespace URI, used in the XPath
Returns XmlNode[]
An empty array if no nodes are found.
See
- get
- eval
Inherited from XmlNode.find
- Defined in src/nodes.mts:271

get

get(xpath: XmlXPath): XmlNode | null
Find the first descendant node matching the given compiled xpath selector
Parameters
- xpath: XmlXPath
  XPath selector
Returns XmlNode | null
null if not found, otherwise an instance of the subclass of XmlNode.
See
Inherited from XmlNode.get
- Defined in src/nodes.mts:221
get(xpath: string, namespaces?: NamespaceMap): XmlNode | null
Find the first descendant node matching the given xpath selector
Parameters
- xpath: string
  XPath selector
- Optionalnamespaces: NamespaceMap
  mapping between prefix and the namespace URI, used in the XPath
Returns XmlNode | null
null if not found, otherwise an instance of the subclass of XmlNode.
See
- find
- eval
Inherited from XmlNode.get
- Defined in src/nodes.mts:232

isSameNode

isSameNode(other: XmlNode): boolean
Check if this node is the same as another node.
Parameters
- other: XmlNode
Returns boolean
Inherited from XmlNode.isSameNode
- Defined in src/nodes.mts:207

prependCData

prependCData(content: string): XmlCData
Insert a CDATA section sibling node before this node.
Parameters
- content: string
  the content of the CDATA section
Returns XmlCData
See
- appendCData
- addCData
- Defined in src/nodes.mts:418

prependComment

prependComment(content: string): XmlComment
Insert a comment sibling node before this node.
Parameters
- content: string
  the content of the comment
Returns XmlComment
See
- appendComment
- addComment
- Defined in src/nodes.mts:396

prependElement

prependElement(name: string, prefix?: string): XmlElement
Insert an element sibling node before this node.
Parameters
- name: string
  the element name
- Optionalprefix: string
  the prefix of the element for the namespace
Returns XmlElement
See
- appendElement
- addElement
- Defined in src/nodes.mts:444

prependEntityReference

prependEntityReference(name: string): XmlEntityReference
Insert an entity reference sibling node before this node.
Parameters
- name: string
  the name of the entity reference
Returns XmlEntityReference
See
- appendEntityReference
- addEntityReference
- Defined in src/nodes.mts:490

prependText

prependText(text: string): XmlText
Insert a text sibling node before this node.
Parameters
- text: string
  the content of the text node
Returns XmlText
See
- appendText
- addText
- Defined in src/nodes.mts:468

remove

remove(): void
Remove the node from its parent.

Returns void
Inherited from XmlNode.remove
- Defined in src/nodes.mts:168

Class XmlTreeNodeAbstract

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

canonicalize

Type Declaration

Parameters

Returns void

See

canonicalizeToString

Type Declaration

Parameters

Returns string

See

Accessors

content

Returns string

doc

Returns XmlDocument

line

Returns number

next

Returns XmlTreeNode | null

See

parent

Returns XmlElement | null

prev

Returns XmlTreeNode | null

See

Methods

appendCData

Parameters

Returns XmlCData

See

appendComment

Parameters

Returns XmlComment

See

appendElement

Parameters

Returns XmlElement

See

appendEntityReference

Parameters

Returns XmlEntityReference

See

appendText

Parameters

Returns XmlText

See

eval

Parameters

Returns string | number | boolean | XmlNode[]

See

Parameters

Returns string | number | boolean | XmlNode[]

See

find

Parameters

Returns XmlNode[]

See

Parameters

Returns XmlNode[]

See

get

Parameters

Returns XmlNode | null

See

Parameters

Returns XmlNode | null

See

isSameNode

Parameters

Returns boolean

prependCData

Parameters

Returns XmlCData

Class XmlTreeNode`Abstract`