W3cubDocs

/Web APIs

Highlight: values() method

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The values() method of the 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 Set-like object, so this is similar to using Set.values().

Syntax

js

values()

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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
values 105 105 preview No 91 No 105 105 No 72 No 20.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Highlight/values