HighlightRegistry: set()-Methode

Limited availability

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

Die set()-Methode der HighlightRegistry-Schnittstelle fügt ein Highlight-Objekt mit dem angegebenen Namen in das Register ein oder aktualisiert es.

HighlightRegistry ist ein Map-ähnliches Objekt, daher ist dies ähnlich wie die Verwendung von Map.set().

Syntax

set(name, highlight)

Parameter

name: Der Name des Highlight-Objekts, das hinzugefügt oder aktualisiert werden soll. Der Name muss ein String sein.
highlight: Das Highlight-Objekt, das hinzugefügt oder aktualisiert werden soll. Dies muss eine Instanz der Highlight-Schnittstelle sein.

Rückgabewert

Das HighlightRegistry-Objekt.

Beispiele

Verwendung von set()

const fooHighlight = new Highlight();
CSS.highlights.set("foo", fooHighlight);

Verwendung von set() mit Verkettung

Da die set()-Methode das Register zurückgibt, können Sie den Methodenaufruf wie unten gezeigt verketten:

const fooHighlight = new Highlight();
const barHighlight = new Highlight();
const bazHighlight = new Highlight();

CSS.highlights
  .set("foo", fooHighlight)
  .set("bar", barHighlight)
  .set("baz", bazHighlight);

Spezifikationen

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

Browser-Kompatibilität

BCD tables only load in the browser