quarkdown-core/com.quarkdown.core.ast.quarkdown.block/ImageFigure

ImageFigure

class ImageFigure(child: Image) : Figure<Image>

An optionally-numbered block which displays a single image, with an optional caption. The caption of the image matches the image title, if any.

Parameters

child

wrapped image

See also

Constructors

Link copied to clipboard
constructor(child: Image)

Properties

Link copied to clipboard
open override val canTrackLocation: Boolean

A figure is numbered if it has either a caption or a referenceId.

Link copied to clipboard
open override val caption: String?
Link copied to clipboard
open override val child: Image
Link copied to clipboard
open override val children: List<Node>

A singleton list containing child.

Link copied to clipboard
open override val kindLocalizationKey: String

Key for localization of the kind of this node, used to look up localized strings in the default com.quarkdown.core.localization.LocalizationTable.

Link copied to clipboard
open override val referenceId: String?

Functions

Link copied to clipboard
open override fun <T> accept(visitor: NodeVisitor<T>): T

Accepts a visitor.

Link copied to clipboard
fun NestableNode.flattenedChildren(): Sequence<Node>

Returns a sequence of all nodes in the tree, where this is the root node. The sequence is generated by traversing the tree in depth-first order. The root node is excluded from the sequence.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Node.getStoredMedia(context: Context): StoredMedia?

Retrieves the stored media associated with this node, if any.

Link copied to clipboard
fun LocationTrackableNode.setLocation(context: MutableContext, location: SectionLocation)

Registers the location of this node within the document handled by context.

Link copied to clipboard
fun LocationTrackableNode.setLocationLabel(context: MutableContext, label: String)

Registers the formatted location of this node within the document handled by context, according to this node's NumberingFormat.

Link copied to clipboard