ContextQMD
Back to Content

Highlight: values() method

files/en-us/web/api/highlight/values/index.md

latest1.4 KB
Original Source

{{APIRef("CSS Custom Highlight API")}}

The values() method of the {{domxref("Highlight")}} interface returns a new Iterator object that contains the values for each Range object in the Highlight object in insertion order.

[!NOTE] The keys() method is an alias for this method. It behaves exactly the same and returns values of Highlight elements.

Highlight is a {{jsxref("Set")}}-like object, so this is similar to using {{jsxref("Set.values()")}}.

Syntax

js-nolint
values()

Parameters

None.

Return value

A new iterator object containing each Range object in the given Highlight, in insertion order.

Examples

The following code snippet shows how to create a new Highlight object with three Range objects, and use the iterator returned by the values() method to log the three ranges:

js
const myHighlight = new Highlight();
myHighlight.add(new Range());
myHighlight.add(new Range());
myHighlight.add(new Range());

const iter = myHighlight.values();

for (value of iter) {
  console.log(value); // Range
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also