readium-shared/org.readium.r2.shared.publication/Locator/Locations

Locations

data class Locations(val fragments: List<String> = emptyList(), val progression: Double? = null, val position: Int? = null, val totalProgression: Double? = null, val otherLocations: Map<String, Any> = emptyMap()) : JSONable, Parcelable

One or more alternative expressions of the location. https://github.com/readium/architecture/tree/master/models/locators#the-location-object

Parameters

fragments

Contains one or more fragment in the resource referenced by the Locator.

progression

Progression in the resource expressed as a percentage (between 0 and 1).

position

An index in the publication (>= 1).

totalProgression

Progression in the publication expressed as a percentage (between 0 and 1).

otherLocations

Additional locations for extensions.

Constructors

Locations

constructor(fragments: List<String> = emptyList(), progression: Double? = null, position: Int? = null, totalProgression: Double? = null, otherLocations: Map<String, Any> = emptyMap())

Types

Companion

object Companion

Properties

cssSelector

val Locator.Locations.cssSelector: String?

A CSS Selector.

domRange

val Locator.Locations.domRange: DomRange?

An HTML DOM range.

fragments

val fragments: List<String>

otherLocations

val otherLocations: Map<String, Any>

partialCfi

val Locator.Locations.partialCfi: String?

partialCfi is an expression conforming to the "right-hand" side of the EPUB CFI syntax, that is to say: without the EPUB-specific OPF spine item reference that precedes the first ! exclamation mark (which denotes the "step indirection" into a publication document). Note that the wrapping epubcfi(***) syntax is not used for the partialCfi string, i.e. the "fragment" part of the CFI grammar is ignored.

position

val position: Int?

progression

val progression: Double?

totalProgression

val totalProgression: Double?

Functions

describeContents

abstract fun describeContents(): Int

get

operator fun get(key: String): Any?

Syntactic sugar to access the otherLocations values by subscripting Locations directly. locations["cssSelector"] == locations.otherLocations["cssSelector"]

toJSON

open override fun toJSON(): JSONObject

Serializes the object to its JSON representation.

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)