1.10.0

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

Math

class Math(val expression: String, val referenceId: String? = null) : LocationTrackableNode, CrossReferenceableNode

A math (TeX) block.

A math block can be cross-referenced and can be numbered, as long as it has a referenceId.

Parameters

expression

expression content

referenceId

optional reference id for cross-referencing via a com.quarkdown.core.ast.quarkdown.reference.CrossReference

Constructors

constructor(expression: String, referenceId: String? = null)

Properties

canTrackLocation

open val canTrackLocation: Boolean

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

val expression: String

open override val referenceId: String? = null

Functions

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

Accepts a visitor.

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

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

getLocationLabel

fun LocationTrackableNode.getLocationLabel(context: Context): String?

fun Node.getStoredMedia(context: Context): StoredMedia?

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

fun LocationTrackableNode.setLocation(context: MutableContext, location: SectionLocation)

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

setLocationLabel

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.

fun Node.wrappedAsValue(): NodeValue