api/org.jetbrains.kotlinx.jupyter.api.outputs

Package-level declarations

Types

DisplayHandler

interface DisplayHandler

The DisplayHandler interface defines methods for handling the display and update of values within the notebook.

ExpandedJsonMarker

object ExpandedJsonMarker : MetadataModifier

Frame

class Frame<out T>(val delayBefore: Duration, val content: T)

The Frame class represents a single frame in an animation.

IsolatedHtmlMarker

object IsolatedHtmlMarker : MetadataModifier

MetadataModifier

fun interface MetadataModifier

MetadataModifierIsSet

class MetadataModifierIsSet(modifier: MetadataModifier)

Properties

isExpandedJson

var MimeTypedResultEx.isExpandedJson: Boolean

isIsolatedHtml

var MimeTypedResultEx.isIsolatedHtml: Boolean

Functions

animate

fun Notebook.animate(nextFrame: () -> Frame<*>?)

Triggers the animation sequence consisting of frames that are produced by the nextFrame function.

fun Notebook.animate(iterable: Iterable<Frame<*>>)

Displays all the frames in this iterable, with respect to the delays.

fun Notebook.animate(frames: Iterator<Frame<*>>)

Displays all the frames left in this frames iterator, with respect to the delays.

fun Notebook.animate(sequence: Sequence<Frame<*>>)

Displays all the frames in this sequence, with respect to the delays.

fun Notebook.animate(framesCount: Int, frameByIndex: (index: Int) -> Frame<*>)

Animates a sequence of frames by displaying them with respect to their delays.

fun Notebook.animate(delay: Duration, nextValue: () -> Any?)

fun Notebook.animate(delay: Duration, sequence: Sequence<*>)

fun <T : Any> Notebook.animate(delay: Duration, firstValue: T?, nextValue: (T) -> T?)

fun Notebook.animate(delay: Duration, framesCount: Int, valueByIndex: (index: Int) -> Any?)

Animates a sequence of values with a specified delay between each frame. The first value is displayed without a delay.

fun Notebook.animate(delay: Duration, iterable: Iterable<*>)

Animates an iterable sequence of values, each one (except first) appearing after a specified delay.

fun Notebook.animate(delay: Duration, iterator: Iterator<*>)

Animates a sequence of values by displaying them with specified delay. The first value is displayed without a delay.

fun <T> Notebook.animate(firstFrame: Frame<T>, nextFrame: (Frame<T>) -> Frame<T>?)

Triggers the animation using a chain of frames, beginning with firstFrame and subsequently obtained through the nextFrame function.

display

fun Notebook.display(value: Any, id: String? = null)

Displays the given value in the notebook.

hasModifier

fun hasModifier(modifier: MetadataModifier): MetadataModifierIsSet

standardMetadataModifiers

fun standardMetadataModifiers(isolatedHtml: Boolean = false, expandedJson: Boolean = false): List<MetadataModifier>

updateDisplay

fun Notebook.updateDisplay(value: Any, id: String? = null)

Updates the display with the given value.