Firefox Tomorrow

web api instance method

HighlightRegistry: clear() method

View on MDN ↗

The clear() method of the HighlightRegistry interface removes all the Highlight objects registered in the HighlightRegistry.

HighlightRegistry is a Map-like object, so this is similar to using clear().

Syntax

clear()

Parameters

None.

Return value

None (undefined).

Examples

The code snippet below registers two highlight objects in the registry and then clears the registry:

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); // 0

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also