Figure

A block which displays a single child, with an optional caption. If a caption is provided or referenceId is set, the block is numbered.

Parameters

child

wrapped child

caption

optional inline caption of the figure block

referenceId

optional ID that can be cross-referenced via a com.quarkdown.core.ast.quarkdown.reference.CrossReference

Type Parameters

T

type of the wrapped child node

Inheritors

Constructors

Link copied to clipboard
constructor(child: T, caption: InlineContent? = null, referenceId: String? = null)

Properties

Link copied to clipboard
open override val backingFunctionName: String

The name of the function that backs this node, from a loaded library.

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: InlineContent?
Link copied to clipboard
open override val child: T
Link copied to clipboard
open override val children: List<Node>

A singleton list containing child.

Link copied to clipboard

Whether the synthesized backing call should be treated as a block call. Defaults to true; inline primitive nodes should override to false so the inline output mapper is used during expansion.

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

The CrossReferenceableNode.referenceId of this node, if it is a real linkable ID (i.e. not the placeholder).

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

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

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Materializes this node's properties into the arguments of the backing function call. Argument names must match the parameter names of the function identified by backingFunctionName.

Link copied to clipboard
fun Node.withChildren(newChildren: List<Node>): Node

Returns a copy of this node with its children replaced by newChildren.

Link copied to clipboard