colibrio-reader-framework/com.colibrio.readingsystem.base/ReaderViewAnnotationLayerOptions

ReaderViewAnnotationLayerOptions

data class ReaderViewAnnotationLayerOptions(val layerClassName: String? = null, val layerStyle: Map<String, String>? = null, val annotationInputEngineEventsEnabled: Boolean = false, val zIndex: Int = 0)

Options related with the ReaderViewAnnotationLayer.

Constructors

fun ReaderViewAnnotationLayerOptions(layerClassName: String? = null, layerStyle: Map<String, String>? = null, annotationInputEngineEventsEnabled: Boolean = false, zIndex: Int = 0)

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

Properties

annotationInputEngineEventsEnabled

val annotationInputEngineEventsEnabled: Boolean = false

If engine events related to mouse, pointer and touch input on annotations should be emitted.

layerClassName

val layerClassName: String? = null

Class name to add to annotation layer elements.

layerStyle

val layerStyle: Map<String, String>? = null

An object with css declarations to apply to the annotation layer. Example { "background-blend-mode": "multiply" }

zIndex

val zIndex: Int = 0

The z-index of the annotation layer. Layers are rendered with the lowest z-index in the bottom and highest z-index on top. Must be equal or greater than 0.