Highlight: clear() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The clear()
method of the Highlight
interface removes all the Range
objects from a Highlight
object.
Highlight
is a Set
-like object, so this is similar to using Set.clear()
.
Syntax
js
clear()
Return value
None (undefined
).
Examples
The code snippet below shows how to create a new highlight with two ranges, and then clear it:
js
const highlight = new Highlight(range1, range2);
console.log(highlight.size); // 2
highlight.clear();
console.log(highlight.size); // 0
Specifications
Specification |
---|
ECMAScript Language Specification # sec-set.prototype.clear |
Browser compatibility
BCD tables only load in the browser