kotlin-browser/web.highlight/HighlightRegistry

HighlightRegistry

open class HighlightRegistry : MutableMapLike.Mixin<ERROR CLASS: Symbol not found for 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 val size: Int

Functions

clear

open override fun clear()

delete

open override fun delete(key: ERROR CLASS: Symbol not found for JsString): Boolean

entries

open fun entries(): JsIterator<Tuple2<ERROR CLASS: Symbol not found for JsString, Highlight>>

forEach

open fun forEach(action: (value: Highlight, @R|kotlin/ParameterName|(name = String(key)) ERROR CLASS: Symbol not found for JsString) -> Unit)

get

open fun get(key: ERROR CLASS: Symbol not found for JsString): Highlight?

has

open fun has(key: ERROR CLASS: Symbol not found for 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

open fun keys(): JsIterator<ERROR CLASS: Symbol not found for JsString>

set

open override fun set(key: ERROR CLASS: Symbol not found for JsString, value: Highlight)

values

open fun values(): JsIterator<Highlight>