Web/API/XSLTProcessor

From Get docs

Non-standard This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.


This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.


An XSLTProcessor applies an XSLT stylesheet transformation to an XML document to produce a new XML document as output. It has methods to load the XSLT stylesheet, to manipulate <xsl:param> parameter values, and to apply the transformation to documents.

Syntax

The constructor has no parameters.

new XSLTProcessor()

Methods

[Throws] void XSLTProcessor.importStylesheet(Node styleSheet)
Imports the XSLT stylesheet. If the given node is a document node, you can pass in a full XSL Transform or a literal result element transform; otherwise, it must be an <xsl:stylesheet> or <xsl:transform> element.
[Throws] DocumentFragment XSLTProcessor.transformToFragment(Node source, Document owner)
Transforms the node source by applying the stylesheet imported using the XSLTProcessor.importStylesheet() function. The owner document of the resulting document fragment is the owner node.
[Throws] Document XSLTProcessor.transformToDocument(Node source)

Transforms the node source applying the stylesheet given importing using the XSLTProcessor.importStylesheet() function.

The resultant object depends on the output method of the stylesheet:

Output method Result type
html HTMLDocument
xml XMLDocument
text XMLDocument with a single root element <transformiix:result> with the text as a child
[Throws] void XSLTProcessor.setParameter(String namespaceURI, String localName, any value)
Sets a parameter in the XSLT stylesheet that was imported. (Sets the value of an <xsl:param>.) A null value for namespaceURI is treated the same as an empty string.
[Throws] any XSLTProcessor.getParameter(String namespaceURI, String localName)
Gets the value of a parameter from the XSLT stylesheet. A null value for namespaceURI is treated the same as an empty string.
[Throws] void XSLTProcessor.removeParameter(String namespaceURI, String localName)
Removes the parameter if it was previously set. This will make the XSLTProcessor use the default value for the parameter as specified in the stylesheet. A null value for namespaceURI is treated the same as an empty string.
void XSLTProcessor.clearParameters()
Removes all set parameters from the XSLTProcessor. The XSLTProcessor will then use the defaults specified in the XSLT stylesheet.
void XSLTProcessor.reset()
Removes all parameters and stylesheets from the XSLTProcessor.

Properties

Non-Web-exposed properties

The following properties are [ChromeOnly] and not exposed to Web content:

[ChromeOnly] attribute unsigned long XSLTProcessor.flags

Flags that tweak the behavior of the processor. Not reset by calling XSLTProcessor.reset(). Default value: 0

Possible values are:

Name Value Effect
(None) 0 None
DISABLE_ALL_LOADS 1 Disable loading external documents (via e.g. <xsl:import> and document())

Examples

  1. Basic example
  2. Advanced example
  3. Additional example

Specifications

Not part of any specification. This is a proprietary interface that originated in Gecko.

Gecko IDL

  • XSLTProcessor.webidl
  • nsIXSLTProcessor.idl

Browser compatibility

Update compatibility data on GitHub

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet

XSLTProcessor

Experimental'Non-standard'

Chrome

Full support Yes

Edge

Full support 12

Firefox

Full support Yes

IE

No support No

Opera

Full support Yes

Safari

Full support Yes

WebView Android

Full support Yes

Chrome Android

Full support Yes

Firefox Android

Full support Yes

Opera Android

Full support Yes

Safari iOS

Full support Yes

Samsung Internet Android

Full support Yes

clearParameters

Experimental'Non-standard'

Chrome

Full support Yes

Edge

Full support 12

Firefox

Full support Yes

IE

No support No

Opera

Full support Yes

Safari

Full support Yes

WebView Android

Full support Yes

Chrome Android

Full support Yes

Firefox Android

Full support Yes

Opera Android

Full support Yes

Safari iOS

Full support Yes

Samsung Internet Android

Full support Yes

getParameter

Experimental'Non-standard'

Chrome Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome only supports string values.

Edge

Full support 12

Firefox

Full support Yes

IE

No support No

Opera Full support Yes

Notes'

Full support Yes

Notes'

Notes' Opera only supports string values.

Safari

Full support Yes

WebView Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome only supports string values.

Chrome Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome only supports string values.

Firefox Android

Full support Yes

Opera Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Opera only supports string values.

Safari iOS

Full support Yes

Samsung Internet Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Samsung Internet only supports string values.

importStylesheet

Experimental'Non-standard'

Chrome

Full support Yes

Edge

Full support 12

Firefox

Full support Yes

IE

No support No

Opera

Full support Yes

Safari

Full support Yes

WebView Android

Full support Yes

Chrome Android

Full support Yes

Firefox Android

Full support Yes

Opera Android

Full support Yes

Safari iOS

Full support Yes

Samsung Internet Android

Full support Yes

removeParameter

Experimental'Non-standard'

Chrome

Full support Yes

Edge

Full support 12

Firefox

Full support Yes

IE

No support No

Opera

Full support Yes

Safari

Full support Yes

WebView Android

Full support Yes

Chrome Android

Full support Yes

Firefox Android

Full support Yes

Opera Android

Full support Yes

Safari iOS

Full support Yes

Samsung Internet Android

Full support Yes

reset

Experimental'Non-standard'

Chrome

Full support Yes

Edge

Full support 12

Firefox

Full support Yes

IE

No support No

Opera

Full support Yes

Safari

Full support Yes

WebView Android

Full support Yes

Chrome Android

Full support Yes

Firefox Android

Full support Yes

Opera Android

Full support Yes

Safari iOS

Full support Yes

Samsung Internet Android

Full support Yes

setParameter

Experimental'Non-standard'

Chrome Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome only supports string values.

Edge

Full support 12

Firefox

Full support Yes

IE

No support No

Opera Full support Yes

Notes'

Full support Yes

Notes'

Notes' Opera only supports string values.

Safari

Full support Yes

WebView Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome only supports string values.

Chrome Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome only supports string values.

Firefox Android

Full support Yes

Opera Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Opera only supports string values.

Safari iOS

Full support Yes

Samsung Internet Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Samsung Internet only supports string values.

transformToDocument

Experimental'Non-standard'

Chrome Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome returns nullif an error occurs.

Edge

Full support 12

Firefox Full support Yes

Notes'

Full support Yes

Notes'

Notes' Firefox throws an exception if an error occurs.

IE

No support No

Opera Full support Yes

Notes'

Full support Yes

Notes'

Notes' Opera returns nullif an error occurs.

Safari

Full support Yes

WebView Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome returns nullif an error occurs.

Chrome Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome returns nullif an error occurs.

Firefox Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Firefox throws an exception if an error occurs.

Opera Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Opera returns nullif an error occurs.

Safari iOS

Full support Yes

Samsung Internet Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Samsung Internet returns nullif an error occurs.

transformToFragment

Experimental'Non-standard'

Chrome Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome returns nullif an error occurs.

Edge

Full support 12

Firefox Full support Yes

Notes'

Full support Yes

Notes'

Notes' Firefox throws an exception if an error occurs.

IE

No support No

Opera Full support Yes

Notes'

Full support Yes

Notes'

Notes' Opera returns nullif an error occurs.

Safari

Full support Yes

WebView Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome returns nullif an error occurs.

Chrome Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Chrome returns nullif an error occurs.

Firefox Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Firefox throws an exception if an error occurs.

Opera Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Opera returns nullif an error occurs.

Safari iOS

Full support Yes

Samsung Internet Android Full support Yes

Notes'

Full support Yes

Notes'

Notes' Samsung Internet returns nullif an error occurs.

Legend

Full support  
Full support
No support  
No support
Experimental. Expect behavior to change in the future.'
Experimental. Expect behavior to change in the future.
Non-standard. Expect poor cross-browser support.'
Non-standard. Expect poor cross-browser support.
See implementation notes.'
See implementation notes.


See also