quarkdown-core/com.quarkdown.core.ast.base.inline/Image

Image

class Image(val link: LinkNode, val width: Size?, val height: Size?, val referenceId: String? = null, val usesMediaStorage: Boolean = true) : CrossReferenceableNode, ErrorCapableNode, PrimitiveFunctionBackedNode

An image.

Parameters

link

the link the image points to

width

optional width constraint

height

optional height constraint

referenceId

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

usesMediaStorage

whether this image should be registered in the media storage by com.quarkdown.core.context.hooks.MediaStorerHook, if the media storage is enabled in the context

Constructors

Image

constructor(link: LinkNode, width: Size?, height: Size?, referenceId: String? = null, usesMediaStorage: Boolean = true)

Properties

backingFunctionName

open override val backingFunctionName: String

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

error

open override var error: Pair<Throwable, PipelineErrorHandler>?

Any error associated with the link will be surfaced as an error on the image itself.

height

val height: Size?

isBackingCallBlock

open val isBackingCallBlock: Boolean

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

val link: LinkNode

linkableReferenceId

val CrossReferenceableNode.linkableReferenceId: String?

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

referenceId

open override val referenceId: String?

usesMediaStorage

val usesMediaStorage: Boolean

width

val width: Size?

Functions

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

Accepts a visitor.

acceptOnSuccess

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

Visits this node with the given visitor when no error is present.

getStoredMedia

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

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

setError

fun ErrorCapableNode.setError(throwable: Throwable, context: Context)

Sets the given throwable as the error of this node, paired with the error handler from context.

toFunctionCallArguments

open override fun toFunctionCallArguments(): List<FunctionCallArgument>

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.

withChildren

fun Node.withChildren(newChildren: List<Node>): Node

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

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue