HighlightRegistry: delete() method
The delete()
method of the HighlightRegistry
interface removes a the named Highlight
object from the HighlightRegistry
.
HighlightRegistry
is a Map
-like object, so this is similar to using Map.delete()
.
Syntax
delete(customHighlightName)
Parameters
-
customHighlightName
-
The name, as a String
, of the Highlight
object to remove from the HighlightRegistry
.
Return value
Returns true
if a Highlight
object under the provided name was in the HighlightRegistry
; otherwise false
.
Examples
The following code sample registers a highlight in the registry, and then deletes it:
const myHighlight = new Highlight(range1, range2);
CSS.highlights.set("my-highlight", myHighlight);
CSS.highlights.delete("foo");
CSS.highlights.delete("my-highlight");
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
delete |
105 |
105 |
preview |
No |
91 |
No |
105 |
105 |
No |
72 |
No |
20.0 |
See also