kotlin-browser/web.highlight/HighlightRegistry

HighlightRegistry

sealed class HighlightRegistry : MutableMapLike<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

abstract override val size: Int

Functions

clear

abstract fun clear()

delete

abstract fun delete(key: JsString): Boolean

entries

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

forEach

abstract fun forEach(action: (value: Highlight, key: JsString) -> Unit)

get

abstract fun get(key: JsString): Highlight?

has

abstract override fun has(key: JsString): Boolean

highlightsFromPoint

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

abstract fun keys(): JsIterator<JsString>

set

abstract fun set(key: JsString, value: Highlight)

values

abstract fun values(): JsIterator<Highlight>