Flow

data class Flow(val chapter: Int, val charOffset: Int = 0, val fragment: String? = null) : KiteBookmark(source)

A place inside one reflowable chapter.

Parameters

chapter

the spine item, zero-based.

charOffset

how far into the chapter's text the position is, in characters (code points) of reading order, not glyphs. Re-flowing moves the words to another page, but not to another offset: a new font, a ligature or an added hyphen does not change it. It resolves to the page that holds that character, so it is a reading position, not a pointer.

fragment

an element id (<h2 id="part-two">), when the position came from a link or a table-of-contents entry. It wins over charOffset when it resolves.

Constructors

Link copied to clipboard
constructor(chapter: Int, charOffset: Int = 0, fragment: String? = null)

Properties

Link copied to clipboard
open override val chapter: Int
Link copied to clipboard
Link copied to clipboard