kotlin-browser/web.highlight/HighlightRegistry

HighlightRegistry

open class HighlightRegistry : MutableMapLike.Mixin<JsString, Highlight> (source)

The HighlightRegistry interface of the CSS Custom Highlight API is used to register Highlight objects to be styled using the API. It is accessed via CSS.highlights.

MDN Reference

Properties

size

open external val size: Int

Functions

clear

open external override fun clear()

delete

open external override fun delete(key: JsString): Boolean

entries

open external fun entries(): JsIterator<Tuple2<JsString, Highlight>>

forEach

open external fun forEach(action: (value: Highlight, JsString) -> Unit)

get

open external fun get(key: JsString): Highlight?

has

open external fun has(key: JsString): Boolean

highlightsFromPoint

external fun highlightsFromPoint(x: Float, y: Float, options: HighlightsFromPointOptions = definedExternally): ReadonlyArray<HighlightHitResult>

The highlightsFromPoint() method of the HighlightRegistry interface returns an array of objects representing the custom highlights applied at a specific point within the viewport.

keys

open external fun keys(): JsIterator<JsString>

set

open external override fun set(key: JsString, value: Highlight)

values

open external fun values(): JsIterator<Highlight>