HighlightRegistry:delete() 方法

基准线 2025
新推出

自 2025 年 6 月起,此功能已在最新的设备和浏览器版本中可用。此功能可能不适用于旧设备或浏览器。

HighlightRegistry 接口的 delete() 方法从 HighlightRegistry 中删除指定名称的 Highlight 对象。

HighlightRegistry 是一个 Map-like 对象,因此这类似于使用 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® 2026 语言规范
# sec-map.prototype.delete

浏览器兼容性

另见