HighlightRegistry: clear() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("CSS Custom Highlight API")}}
The **clear()** method of the {{domxref("HighlightRegistry")}} interface removes all the {{domxref("Highlight")}} objects registered in the HighlightRegistry.
HighlightRegistry is a {{jsxref("Map")}}-like object, so this is similar to using {{jsxref("Map.clear()")}}.
Syntax
js-nolint
clear()Parameters
None.
Return value
None ({{jsxref("undefined")}}).
Examples
The code snippet below registers two highlight objects in the registry and then clears the registry:
js
const customHighlight1 = new Highlight(range1, range2);
const customHighlight2 = new Highlight(range3, range4, range5);
CSS.highlights.set("custom-highlight-1", customHighlight1);
CSS.highlights.set("custom-highlight-2", customHighlight2);
console.log(CSS.highlights.size); // 2
CSS.highlights.clear();
console.log(CSS.highlights.size); // 0Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- {{domxref("css_custom_highlight_api", "The CSS Custom Highlight API", "", "nocode")}}
- CSS Custom Highlight API: The Future of Highlighting Text Ranges on the Web