Firefox Tomorrow

web api instance method

HighlightRegistry: delete() method

View on MDN ↗

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 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"); // false
CSS.highlights.delete("my-highlight"); // true

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also