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

ReaderViewAnnotationOptions

data class ReaderViewAnnotationOptions(val containerClassName: String? = null, val containerStyle: Map<String, String>? = null, val positionClassName: String? = null, val positionStyle: Map<String, String>? = null, val rangeClassName: String? = null, val rangeStyle: Map<String, String>? = null)

Options related with the presentation of ReaderViewAnnotations.

Constructors

fun ReaderViewAnnotationOptions(containerClassName: String? = null, containerStyle: Map<String, String>? = null, positionClassName: String? = null, positionStyle: Map<String, String>? = null, rangeClassName: String? = null, rangeStyle: Map<String, String>? = null)

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

Properties

containerClassName

val containerClassName: String? = null

Class name to add to the ReaderViewAnnotation container elements. This element defines the bounding box for all ranges and points created by the ReaderViewAnnotation for a page.

containerStyle

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

CSS style declarations to add to the ReaderViewAnnotation container element. This element defines the bounding box for all ranges and points created by the ReaderViewAnnotation for a page.

positionClassName

val positionClassName: String? = null

Class name to add to each rectangle generated by the ReaderViewAnnotation when it represents a position.

positionStyle

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

An object with css declarations to apply to rectangles when ReaderViewAnnotation represents a position.

rangeClassName

val rangeClassName: String? = null

Class name to add to each rectangle generated by the ReaderViewAnnotation when it represents a range. For example, when an annotation refers to serveral lines of text, one element will be rendered per line.

rangeStyle

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

An object with css declarations to apply to rectangles when ReaderViewAnnotation represents a range. For example, when an annotation refers to serveral lines of text, one element will be rendered per line.