HighlightRegistry:delete() 方法

有限可用性

此功能不是基线,因为它在一些最常用的浏览器中无法使用。

delete()HighlightRegistry 接口的方法,用于从 HighlightRegistry 中移除命名 Highlight 对象。

HighlightRegistry 是一个类似 Map 的对象,因此这类似于使用 Map.delete()

语法

js
delete(customHighlightName)

参数

customHighlightName

要从 HighlightRegistry 中移除的 Highlight 对象的名称,以 String 表示。

返回值

如果 HighlightRegistry 中存在提供名称的 Highlight 对象,则返回 true;否则返回 false

示例

以下代码示例在注册表中注册了一个高亮,然后将其删除

js
const myHighlight = new Highlight(range1, range2);

CSS.highlights.set("my-highlight", myHighlight);

CSS.highlights.delete("foo"); // false
CSS.highlights.delete("my-highlight"); // true

规范

规范
ECMAScript 语言规范
# sec-map.prototype.delete

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

另请参阅