kotlin-browser/web.highlight/HighlightRegistry

HighlightRegistry

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

abstract override val size: Int

Functions

clear

abstract fun clear()

delete

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

entries

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

forEach

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

get

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

has

abstract override 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

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

set

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

values

abstract fun values(): JsIterator<Highlight>