kitepdf-core/io.github.yuroyami.kitepdf.core/KiteLink

KiteLink

class KiteLink(val rect: KiteRectangle, val uri: String? = null, val target: KiteBookmark? = null, targetY: () -> Double?? = null)(source)

A link on a page: the area that a tap follows, and where the link leads (#433).

XPS and SVG pages give their links as KitePage.hyperlinks. A PDF link carries an action and an EPUB link carries a kind, so those formats give their links as PdfPage.annotations and EpubPage.links.

Constructors

KiteLink

constructor(rect: KiteRectangle, uri: String? = null, target: KiteBookmark? = null, targetY: () -> Double?? = null)

Properties

rect

val rect: KiteRectangle

the area, in display space: points from the top-left corner of the page, y down, with the smaller y in KiteRectangle.bottom.

target

val target: KiteBookmark?

the place inside the document, or null for a link that leads out of it.

targetY

val targetY: Double?

The height on the target page, in display space, that the link brings to the top of the view, or null for the top of the page. The format finds it on first use, because that can mean reading the target page.

uri

val uri: String?

the address outside the document, such as https://example.com, or null for a link inside the document.

Functions

toString

open override fun toString(): String