Back to Content

XSLTProcessor: removeParameter() method

files/en-us/web/api/xsltprocessor/removeparameter/index.md

latest2.9 KB
Original Source

{{APIRef("DOM")}}

The removeParameter() method of the {{domxref("XSLTProcessor")}} interface removes the parameter (<xsl:param>) and its value from the stylesheet imported in the processor.

Syntax

js-nolint
removeParameter(namespaceURI, localName)

Parameters

  • namespaceURI
    • : The namespace associated with the parameter name. A "null" value is treated the same as the empty string ("").
  • localName
    • : The name of the parameter in the associated namespace.

Return value

None ({{jsxref("undefined")}}).

Examples

Using removeParameter()

First, the showItems parameter is set to "yes", which allows the list items to be displayed in the output.

After that, the showItems parameter is removed using removeParameter(), and the transformation is performed again, resulting in no items being displayed.

HTML

html
<div id="result"></div>

JavaScript

js
const xmlString = `
<items>
  <item>Item 1</item>
  <item>Item 2</item>
</items>
`;

const xsltString = `
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:param name="showItems" select="'yes'"/>
  <xsl:template match="/">
    <!-- If showItems is 'yes', display the list of items -->
    <xsl:if test="$showItems = 'yes'">
      <ul>
        <xsl:for-each select="items/item">
          <li><xsl:value-of select="."/></li>
        </xsl:for-each>
      </ul>
    </xsl:if>
    <!-- If showItems is 'no', display a message -->
    <xsl:if test="$showItems = 'no'">
      <div>No content to show</div>
    </xsl:if>
  </xsl:template>
</xsl:stylesheet>
`;

const parser = new DOMParser();
const xmlDoc = parser.parseFromString(xmlString, "application/xml");
const xsltDoc = parser.parseFromString(xsltString, "application/xml");

const xsltProcessor = new XSLTProcessor();
xsltProcessor.importStylesheet(xsltDoc);

// Set 'showItems' to 'no' and perform the first transformation
xsltProcessor.setParameter(null, "showItems", "no");
const resultContainer = document.getElementById("result");
let resultFragment = xsltProcessor.transformToFragment(xmlDoc, document);
resultContainer.appendChild(resultFragment);

// Add a horizontal rule to separate the results
resultContainer.appendChild(document.createElement("hr"));

// Remove the 'showItems' parameter, reverting it to the default value ('yes')
xsltProcessor.removeParameter(null, "showItems");
resultFragment = xsltProcessor.transformToFragment(xmlDoc, document);
resultContainer.appendChild(resultFragment);

Result

{{EmbedLiveSample("using_removeparameter", "", "200")}}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("XSLTProcessor.getParameter()")}}
  • {{domxref("XSLTProcessor.setParameter()")}}
  • {{domxref("XSLTProcessor.clearParameters()")}}
  • {{domxref("XSLTProcessor.reset()")}}