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

瀏覽器相容性

另見