colibrio-reader-framework/com.colibrio.core.locator/SimpleLocatorData

SimpleLocatorData

data class SimpleLocatorData(val sourceUrl: String, val selectors: List<String>)

Used for referencing specific locations (including ranges) in publications.

Can be transformed into a valid URL by:

let url: string;
if (selectors.length 0) {
     url = sourceUrl + '#' + selectors[0];
} else {
     url = sourceUrl;
}

Constructors

SimpleLocatorData

fun SimpleLocatorData(sourceUrl: String, selectors: List<String>)

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

Properties

selectors

val selectors: List<String>

The selectors for this locator. Multiple selectors should select the same content, however some selectors will not have the same precision as others. The first selector in the array has the highest precision.

sourceUrl

val sourceUrl: String

Returns the URL of the locator without the hash fragment part if any.