HighlightRegistry: delete() Methode

Die delete() Methode der HighlightRegistry-Schnittstelle entfernt ein benanntes Highlight-Objekt aus der HighlightRegistry.

HighlightRegistry ist ein Map-ähnliches Objekt, sodass dies dem Einsatz von Map.delete() ähnelt.

Syntax

delete(customHighlightName)

Parameter

customHighlightName

Der Name, als String, des Highlight-Objekts, das aus der HighlightRegistry entfernt werden soll.

Rückgabewert

Gibt true zurück, wenn ein Highlight-Objekt unter dem angegebenen Namen in der HighlightRegistry war; andernfalls false.

Beispiele

Das folgende Codebeispiel registriert ein Highlight in der Registry und löscht es dann:

const myHighlight = new Highlight(range1, range2);
CSS.highlights.set("my-highlight", myHighlight);
CSS.highlights.delete("foo"); // false
CSS.highlights.delete("my-highlight"); // true

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Die CSS Custom Highlight API
• CSS Custom Highlight API: Die Zukunft des Hervorhebens von Textbereichen im Web