HighlightRegistry: forEach() メソッド

Baseline 2025

Newly available

Since ⁨June 2025⁩, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

forEach() は HighlightRegistry インターフェイスのメソッドで、レジストリーのすべての Highlight オブジェクトに対して、挿入順に 1 回ずつ、指定された関数を実行します。

HighlightRegistry は Map 風オブジェクトであるため、これは Map.forEach() を使用するのと似ています。

構文

forEach(callbackFn)
forEach(callbackFn, thisArg)

引数

callback

それぞれの Highlight オブジェクトについて呼び出される関数で、 3 つの引数を取ります。

highlight: 現在のハイライトです。
name: そのハイライトの名前です。
registry: forEach() が呼び出されたレジストリーオブジェクトです。

thisArg

callbackFn の実行時に this として使用される値。

返値

なし (undefined)。

例

以下のコードスニペットは、2 つの範囲を持つ新しいハイライトを作成し、 forEach() メソッドを使用してその範囲をログ出力する方法を示しています。

function logAllHighlights(highlight, name) {
  console.log(`Highlight ${name} exists in the registry`, highlight);
}

const customHighlight1 = new Highlight();
const customHighlight2 = new Highlight();
const customHighlight3 = new Highlight();

CSS.highlights.set("custom-highlight-1", customHighlight1);
CSS.highlights.set("custom-highlight-2", customHighlight2);
CSS.highlights.set("custom-highlight-3", customHighlight3);

CSS.highlights.forEach(logAllHighlights);