latest

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

Figure

abstract class Figure<T : Node>(val child: T) : SingleChildNestableNode<T> , LocationTrackableNode, CaptionableNode

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

Parameters

child

wrapped child

T

type of the wrapped child node

Inheritors

MermaidDiagramFigure

Constructors

constructor(child: T)

Properties

canTrackLocation

open val canTrackLocation: Boolean

Whether this node should be tracked in the document's hierarchy.

abstract val caption: String?

The optional caption.

open override val child: T

open override val children: List<Node>

A singleton list containing child.

Functions

open override fun <T> accept(visitor: NodeVisitor<T>): T

Accepts a visitor.

flattenedChildren

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.

fun LocationTrackableNode.formatLocation(context: Context, format: (DocumentNumbering) -> NumberingFormat?): String?

fun LocationTrackableNode.getLocation(context: Context): SectionLocation?

fun Node.wrappedAsValue(): NodeValue