Highlight: forEach()-Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Die forEach()-Methode der Highlight-Schnittstelle führt eine bereitgestellte Funktion einmal für jedes Range-Objekt im Highlight-Objekt in der Einfügereihenfolge aus.

Highlight ist ein Set-ähnliches Objekt, daher ist dies ähnlich wie die Verwendung von Set.forEach().

Syntax

forEach(callbackFn)
forEach(callbackFn, thisArg)

Parameter

callback

Funktion, die für jedes Range-Objekt ausgeführt wird, mit drei Argumenten:

range, key: Das aktuelle Range-Objekt, das im Highlight verarbeitet wird. Da es keine Schlüssel im Highlight gibt, wird der range sowohl für beide Argumente übergeben.
highlight: Das Highlight-Objekt, auf das forEach() angewendet wurde.

thisArg

Wert, der als this verwendet wird, wenn callbackFn ausgeführt wird.

Rückgabewert

Keiner (undefined).

Beispiele

Im folgenden Codebeispiel wird gezeigt, wie ein neues Highlight mit zwei Bereichen erstellt wird und dann die Bereiche mit der forEach()-Methode protokolliert werden:

function logRanges(range, key, highlight) {
  console.log(`Highlight object ${highlight} contains range ${range}`);
}

const text = new Text("Time is an illusion. Lunchtime doubly so.");

const range1 = document.createRange();
range1.setStart(text, 0);
range1.setEnd(text, 4);

const range2 = document.createRange();
range2.setStart(text, 21);
range2.setEnd(text, 30);

const myHighlight = new Highlight();
myHighlight.add(range1);
myHighlight.add(range2);

myHighlight.forEach(logRanges);

Spezifikationen

Specification
ECMAScript Language Specification # sec-set.prototype.foreach

Browser-Kompatibilität

BCD tables only load in the browser