Class XMLElement

Hierarchy

XMLNode
- XMLElement

Methods

addChild

addChild(node: XMLElement): XMLElement
Append node after the last node child

Returns
the appended child
Parameters
- node: XMLElement
  
  the XMLElement to append
Returns XMLElement
Inherited from XMLNode.addChild
- Defined in lib/node.ts:337

addNextSibling

addNextSibling(node: XMLElement): null | XMLElement
Insert a node directly after the current node

Returns
the inserted sibling
Parameters
- node: XMLElement
  
  the node to be inserted
Returns null | XMLElement
Inherited from XMLNode.addNextSibling
- Defined in lib/node.ts:370

addPrevSibling

addPrevSibling(node: XMLElement): XMLElement
Insert a node directly before the current node

Returns
the inserted sibling
Parameters
- node: XMLElement
  
  the node to be inserted
Returns XMLElement
Inherited from XMLNode.addPrevSibling
- Defined in lib/node.ts:401

attr

attr(attributes: XMLAttributeMap): XMLElement
set multiple attributes BREAKING CHANGE: no longer overloaded for setting single attr

Returns
Parameters
- attributes: XMLAttributeMap
Returns XMLElement
- Defined in lib/node.ts:666

attrs

attrs(): XMLAttribute[]
Returns XMLAttribute[]
- Defined in lib/node.ts:678

cdata

cdata(content: string): XMLElement
Parameters
- content: string
Returns XMLElement
- Defined in lib/node.ts:693

child

child(index: number): null | XMLElement
Return the child at the given index

Returns
the child to return
Parameters
- index: number
  
  the index of the child
Returns null | XMLElement
Inherited from XMLNode.child
- Defined in lib/node.ts:531

childNodes

childNodes(): XMLElement[]
Get an array of child nodes

Returns
array of child nodes

Returns XMLElement[]
Inherited from XMLNode.childNodes
- Defined in lib/node.ts:418

clone

clone(): null | XMLNode | XMLAttribute | XMLElement | XMLDocument
Returns null | XMLNode | XMLAttribute | XMLElement | XMLDocument
Inherited from XMLNode.clone
- Defined in lib/node.ts:625

createElement

createElement(name: string, content?: string): XMLElement
Create a new element with the given name and content

Returns
the created element
Parameters
- name: string
- Optional content: string
Returns XMLElement
Inherited from XMLNode.createElement
- Defined in lib/node.ts:241

defineNamespace

defineNamespace(prefix: null | string, href?: null | string): XMLNamespace
Parameters
- prefix: null | string
- Optional href: null | string
Returns XMLNamespace
Inherited from XMLNode.defineNamespace
- Defined in lib/node.ts:254

doc

doc(): null | XMLDocument
Get the associated XMLDocument for the current node

Returns

Returns null | XMLDocument
Inherited from XMLNode.doc
- Defined in lib/node.ts:557

evaluateXPath

evaluateXPath(xpath: string, namespace?: XPathNamespace): xmlXPathObjectPtr
Parameters
- xpath: string
- Optional namespace: XPathNamespace
Returns xmlXPathObjectPtr
Inherited from XMLNode.evaluateXPath
- Defined in lib/node.ts:440

find

find(xpath: string, namespace?: XPathNamespace): XMLXPathNode[]
Find decendant nodes matching the given xpath selector

Returns
array of matching decendant nodes
Parameters
- xpath: string
  
  XPath selector
- Optional namespace: XPathNamespace
  
  optional namespace
Returns XMLXPathNode[]
Inherited from XMLNode.find
- Defined in lib/node.ts:473

get

get(xpath: string, namespace?: XPathNamespace): null | string | number | boolean | XMLXPathNode
Find the first decendant node matching the given xpath selector

Returns
first matching decendant node
Parameters
- xpath: string
  
  XPath selector
- Optional namespace: XPathNamespace
  
  optional namespace
Returns null | string | number | boolean | XMLXPathNode
Inherited from XMLNode.get
- Defined in lib/node.ts:498

getAttribute

getAttribute(key: string): null | XMLAttribute
Parameters
- key: string
Returns null | XMLAttribute
- Defined in lib/node.ts:648

`Protected` importNode

importNode(node: xmlNodePtr): XMLNode
Parameters
- node: xmlNodePtr
Returns XMLNode
Inherited from XMLNode.importNode
- Defined in lib/node.ts:305

line

line(): number
Get the line number that this node starts on in the original parsed document

Returns
line number

Returns number
Inherited from XMLNode.line
- Defined in lib/node.ts:157

name

name(value?: string): string
Get the tag name of current node

Returns
name
Parameters
- Optional value: string
Returns string
Overrides XMLNode.name
- Defined in lib/node.ts:640

namespace

namespace(prefix?: null | string | XMLNamespace, href?: null | string): null | XMLNamespace
Get or set the namespace for the current node

Returns
the current namespace
Parameters
- Optional prefix: null | string | XMLNamespace
  
  namespace prefix
- Optional href: null | string
  
  namespace URL
Returns null | XMLNamespace
Inherited from XMLNode.namespace
- Defined in lib/node.ts:574

namespaces

namespaces(onlyLocal?: boolean): XMLNamespace[]
Get an array of namespaces that appy to the current node

Returns
an array of namespaces for the current node
Parameters
- onlyLocal: boolean = false
  
  whether to include inherited namespaces
Returns XMLNamespace[]
Inherited from XMLNode.namespaces
- Defined in lib/node.ts:603

nextElement

nextElement(): null | XMLNode
Get the next sibling relative to the current node

Returns
next element

Returns null | XMLNode
Inherited from XMLNode.nextElement
- Defined in lib/node.ts:295

nextSibling

nextSibling(): null | XMLNode
Returns null | XMLNode
Inherited from XMLNode.nextSibling
- Defined in lib/node.ts:436

node

node(name: string, content?: string): XMLElement
Create a new element with the given name and content, then append it as a child of the current node

See
XMLNode.createElement

Returns
the appended element
Parameters
- name: string
- Optional content: string
Returns XMLElement
Inherited from XMLNode.node
- Defined in lib/node.ts:230

parent

parent(): null | XMLNode | XMLAttribute | XMLElement | XMLDocument
Get the parent node for the current

Returns
parent node

Returns null | XMLNode | XMLAttribute | XMLElement | XMLDocument
Inherited from XMLNode.parent
- Defined in lib/node.ts:111

path

path(): string
Returns string
- Defined in lib/node.ts:725

prevElement

prevElement(): null | XMLNode
Get the previous sibling relative to the current node

Returns
previous element

Returns null | XMLNode
Inherited from XMLNode.prevElement
- Defined in lib/node.ts:280

prevSibling

prevSibling(): null | XMLNode
Returns null | XMLNode
Inherited from XMLNode.prevSibling
- Defined in lib/node.ts:432

remove

remove(): void
Returns void
Inherited from XMLNode.remove
- Defined in lib/node.ts:548

replace

replace(value: string | XMLElement): void
Parameters
- value: string | XMLElement
Returns void
- Defined in lib/node.ts:729

setAttribute

setAttribute(key: string, value: string | number): null | XMLAttribute
Parameters
- key: string
- value: string | number
Returns null | XMLAttribute
- Defined in lib/node.ts:654

text

text(content?: string): string
Parameters
- Optional content: string
Returns string
- Defined in lib/node.ts:703

toString

toString(options?: boolean | XMLSaveOptions): string
Parameters
- options: boolean | XMLSaveOptions = {}
Returns string
Inherited from XMLNode.toString
- Defined in lib/node.ts:563

type

type(): "text" | "document" | "node" | "element" | "attribute" | "cdata" | "entity_ref" | "entity" | "pi" | "comment" | "document_type" | "document_frag" | "notation" | "html_document" | "dtd" | "element_decl" | "attribute_decl" | "entity_decl" | "namespace_decl" | "xinclude_start" | "xinclude_end" | "docb_document"
Get the type of element (XMLElementType)

"text" | "cdata" | "comment" | "element" | "node"

Returns
the node type

Returns "text" | "document" | "node" | "element" | "attribute" | "cdata" | "entity_ref" | "entity" | "pi" | "comment" | "document_type" | "document_frag" | "notation" | "html_document" | "dtd" | "element_decl" | "attribute_decl" | "entity_decl" | "namespace_decl" | "xinclude_start" | "xinclude_end" | "docb_document"
Inherited from XMLNode.type
- Defined in lib/node.ts:170

Class XMLElement

Hierarchy

Index

Methods

Methods

addChild

Returns

Parameters

node: XMLElement

Returns XMLElement

addNextSibling

Returns

Parameters

node: XMLElement

Returns null | XMLElement

addPrevSibling

Returns

Parameters

node: XMLElement

Returns XMLElement

attr

Returns

Parameters

attributes: XMLAttributeMap

Returns XMLElement

attrs

Returns XMLAttribute[]

cdata

Parameters

content: string

Returns XMLElement

child

Returns

Parameters

index: number

Returns null | XMLElement

childNodes

Returns

Returns XMLElement[]

clone

Returns null | XMLNode | XMLAttribute | XMLElement | XMLDocument

createElement

Returns

Parameters

name: string

Optional content: string

Returns XMLElement

defineNamespace

Parameters

prefix: null | string

Optional href: null | string

Returns XMLNamespace

doc

Returns

Returns null | XMLDocument

evaluateXPath

Parameters

xpath: string

Optional namespace: XPathNamespace

Returns xmlXPathObjectPtr

find

Returns

Parameters

xpath: string

Optional namespace: XPathNamespace

Returns XMLXPathNode[]

get

Returns

Parameters

xpath: string

Optional namespace: XPathNamespace

Returns null | string | number | boolean | XMLXPathNode

getAttribute

Parameters

key: string

Returns null | XMLAttribute

Protected importNode

Parameters

node: xmlNodePtr

Returns XMLNode

`Optional` content: string

`Optional` href: null | string

`Optional` namespace: XPathNamespace

`Optional` namespace: XPathNamespace

`Optional` namespace: XPathNamespace

`Protected` importNode

`Optional` value: string

`Optional` prefix: null | string | XMLNamespace

`Optional` href: null | string

`Optional` content: string

`Optional` content: string