Highlight: delete() method

The delete() method of the Highlight interface removes a specified AbstractRange object from a Highlight object.

Highlight is a Set-like object, so this is similar to using Set.delete().

Syntax

js
delete(range)

Parameters

range

The AbstractRange object to remove from the Highlight.

Return value

Returns true if range was already in Highlight; otherwise false.

Examples

The code snippet below shows how to create a new highlight with two ranges, and then delete one of them:

js
const range1 = new Range();
const range2 = new Range();

const highlight = new Highlight(range1, range2);
console.log(highlight.size); // 2

highlight.delete(range1);
console.log(highlight.size); // 1

Specifications

See also