Highlight: values() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("CSS Custom Highlight API")}}
The **values()** method of the {{domxref("Highlight")}} interface returns a new Iterator object that contains the values for each AbstractRange object in the Highlight object in insertion order.
توجه: 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
values()Parameters
None.
Return value
A new iterator object containing each AbstractRange object in the given Highlight, in insertion order.
Examples
The following code snippet shows how to create a new Highlight object with three AbstractRange objects, and use the iterator returned by the values() method to log the three ranges:
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
- {{domxref("css_custom_highlight_api", "The CSS Custom Highlight API", "", "nocode")}}
- CSS Custom Highlight API: The Future of Highlighting Text Ranges on the Web