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
Specification |
---|
ECMAScript Language Specification # sec-set.prototype.values |
Browser compatibility
BCD tables only load in the browser