readium-shared/org.readium.r2.shared.publication.services.content/Content/ImageElement

ImageElement

data class ImageElement(val locator: Locator, val embeddedLink: Link, val caption: String?, val attributes: List<Content.Attribute<*>> = emptyList()) : Content.EmbeddedElement, Content.TextualElement

A bitmap image.

Parameters

caption

Short piece of text associated with the image.

Constructors

constructor(locator: Locator, embeddedLink: Link, caption: String?, attributes: List<Content.Attribute<*>> = emptyList())

Properties

accessibilityLabel

open val accessibilityLabel: String?

open override val attributes: List<Content.Attribute<*>>

Associated list of attributes.

val caption: String?

open override val embeddedLink: Link

Referenced resource in the publication.

open val language: Language?

open override val locator: Locator

Locator targeting this element in the Publication.

open override val text: String?

Human-readable text representation for this element.

Functions

open fun <V> attribute(key: Content.AttributeKey<V>): V?

Gets the first attribute with the given key.

open fun <V> attributes(key: Content.AttributeKey<V>): List<V>

Gets all the attributes with the given key.